1 /* ****************************************************************
3 * Copyright 2014 Samsung Electronics All Rights Reserved.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
19 ******************************************************************/
24 * This file provides APIs related to thread pool.
30 #include "cathreadpool.h"
32 #include "oic_malloc.h"
33 #include "uarraylist.h"
36 #define TAG PCF("UTHREADPOOL")
39 * empty struct to represent the details. This implementation has no data
40 * that it needs to keep track of, so it only uses NULL for the internal value.
42 typedef struct ca_thread_pool_details_t
44 u_arraylist_t* threads_list;
46 } ca_thread_pool_details_t;
49 * struct to wrap the pthreads callback properly. The function pointer for
50 * pthreads requires a void* return value, however u_thread_func is a void.
52 typedef struct ca_thread_pool_callback_info_t
56 } ca_thread_pool_callback_info_t;
58 // passthrough function to convert the pthreads call to a u_thread_func call
59 void* ca_thread_pool_pthreads_delegate(void* data)
61 ca_thread_pool_callback_info_t* info = (ca_thread_pool_callback_info_t*)data;
62 info->func(info->data);
67 // this implementation doesn't do a thread pool, so this function is essentially
68 // a no-op besides creating a valid ca_thread_pool_t object. It was determined after
69 // reading through the existing implementation that the thread-pooling was unnecessary
70 // for the posix platforms. Behavior shouldn't be changed since previously num_of_threads
71 // was greater than the number of requested threads.
72 CAResult_t ca_thread_pool_init(int32_t num_of_threads, ca_thread_pool_t *thread_pool)
74 OIC_LOG(DEBUG, TAG, "IN");
78 OIC_LOG(ERROR, TAG, "Parameter thread_pool was null!");
79 return CA_STATUS_INVALID_PARAM;
82 if(num_of_threads <= 0)
84 OIC_LOG(ERROR, TAG, "num_of_threads must be positive and non-zero");
85 return CA_STATUS_INVALID_PARAM;
88 *thread_pool = OICMalloc(sizeof(struct ca_thread_pool));
92 OIC_LOG(ERROR, TAG, "Failed to allocate for thread-pool");
93 return CA_MEMORY_ALLOC_FAILED;
96 (*thread_pool)->details = OICMalloc(sizeof(struct ca_thread_pool_details_t));
97 if(!(*thread_pool)->details)
99 OIC_LOG(ERROR, TAG, "Failed to allocate for thread-pool details");
100 OICFree(*thread_pool);
102 return CA_MEMORY_ALLOC_FAILED;
105 (*thread_pool)->details->list_lock = ca_mutex_new();
107 if(!(*thread_pool)->details->list_lock)
109 OIC_LOG(ERROR, TAG, "Failed to create thread-pool mutex");
110 OICFree((*thread_pool)->details);
111 OICFree(*thread_pool);
113 return CA_STATUS_FAILED;
116 (*thread_pool)->details->threads_list = u_arraylist_create();
118 if(!(*thread_pool)->details->threads_list)
120 OIC_LOG(ERROR, TAG, "Failed to create thread-pool list");
121 if(!ca_mutex_free((*thread_pool)->details->list_lock))
123 OIC_LOG(ERROR, TAG, "Failed to free thread-pool mutex");
126 OICFree((*thread_pool)->details);
127 OICFree(*thread_pool);
129 return CA_STATUS_FAILED;
132 OIC_LOG(DEBUG, TAG, "OUT");
136 CAResult_t ca_thread_pool_add_task(ca_thread_pool_t thread_pool, ca_thread_func method,
139 OIC_LOG(DEBUG, TAG, "IN");
141 if(NULL == thread_pool || NULL == method)
143 OIC_LOG(ERROR, TAG, "thread_pool or method was NULL");
144 return CA_STATUS_INVALID_PARAM;
147 ca_thread_pool_callback_info_t* info = OICMalloc(sizeof(ca_thread_pool_callback_info_t));
150 OIC_LOG(ERROR, TAG, "Failed to allocate for memory wrapper");
151 return CA_MEMORY_ALLOC_FAILED;
157 pthread_t threadHandle;
159 int result = pthread_create(&threadHandle, NULL, ca_thread_pool_pthreads_delegate, info);
163 OIC_LOG_V(ERROR, TAG, "Thread start failed with error %d", result);
164 return CA_STATUS_FAILED;
167 ca_mutex_lock(thread_pool->details->list_lock);
168 bool addResult = u_arraylist_add(thread_pool->details->threads_list, (void*)threadHandle);
169 ca_mutex_unlock(thread_pool->details->list_lock);
173 OIC_LOG_V(ERROR, TAG, "Arraylist Add failed, may not be properly joined: %d", addResult);
174 return CA_STATUS_FAILED;
177 OIC_LOG(DEBUG, TAG, "OUT");
181 void ca_thread_pool_free(ca_thread_pool_t thread_pool)
183 OIC_LOG(DEBUG, TAG, "IN");
187 OIC_LOG(ERROR, TAG, "Invalid parameter thread_pool was NULL");
191 ca_mutex_lock(thread_pool->details->list_lock);
193 for(uint32_t i = 0; i<u_arraylist_length(thread_pool->details->threads_list); ++i)
195 pthread_t tid = (pthread_t)u_arraylist_get(thread_pool->details->threads_list, i);
196 int joinres = pthread_join(tid, NULL);
199 OIC_LOG_V(ERROR, TAG, "Failed to join thread at index %u with error %d", i, joinres);
203 u_arraylist_free(&(thread_pool->details->threads_list));
205 ca_mutex_unlock(thread_pool->details->list_lock);
206 ca_mutex_free(thread_pool->details->list_lock);
208 OICFree(thread_pool->details);
209 OICFree(thread_pool);
211 OIC_LOG(DEBUG, TAG, "OUT");