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.
32 #include "cathreadpool.h"
34 #include "oic_malloc.h"
35 #include "uarraylist.h"
38 #define TAG PCF("UTHREADPOOL")
41 * empty struct to represent the details. This implementation has no data
42 * that it needs to keep track of, so it only uses NULL for the internal value.
44 typedef struct ca_thread_pool_details_t
46 u_arraylist_t* threads_list;
48 } ca_thread_pool_details_t;
51 * struct to wrap the pthreads callback properly. The function pointer for
52 * pthreads requires a void* return value, however u_thread_func is a void.
54 typedef struct ca_thread_pool_callback_info_t
58 } ca_thread_pool_callback_info_t;
60 // passthrough function to convert the pthreads call to a u_thread_func call
61 void* ca_thread_pool_pthreads_delegate(void* data)
63 ca_thread_pool_callback_info_t* info = (ca_thread_pool_callback_info_t*)data;
64 info->func(info->data);
69 // this implementation doesn't do a thread pool, so this function is essentially
70 // a no-op besides creating a valid ca_thread_pool_t object. It was determined after
71 // reading through the existing implementation that the thread-pooling was unnecessary
72 // for the posix platforms. Behavior shouldn't be changed since previously num_of_threads
73 // was greater than the number of requested threads.
74 CAResult_t ca_thread_pool_init(int32_t num_of_threads, ca_thread_pool_t *thread_pool)
76 OIC_LOG(DEBUG, TAG, "IN");
80 OIC_LOG(ERROR, TAG, "Parameter thread_pool was null!");
81 return CA_STATUS_INVALID_PARAM;
84 if(num_of_threads <= 0)
86 OIC_LOG(ERROR, TAG, "num_of_threads must be positive and non-zero");
87 return CA_STATUS_INVALID_PARAM;
90 *thread_pool = OICMalloc(sizeof(struct ca_thread_pool));
94 OIC_LOG(ERROR, TAG, "Failed to allocate for thread-pool");
95 return CA_MEMORY_ALLOC_FAILED;
98 (*thread_pool)->details = OICMalloc(sizeof(struct ca_thread_pool_details_t));
99 if(!(*thread_pool)->details)
101 OIC_LOG(ERROR, TAG, "Failed to allocate for thread-pool details");
102 OICFree(*thread_pool);
104 return CA_MEMORY_ALLOC_FAILED;
107 (*thread_pool)->details->list_lock = ca_mutex_new();
109 if(!(*thread_pool)->details->list_lock)
111 OIC_LOG(ERROR, TAG, "Failed to create thread-pool mutex");
112 OICFree((*thread_pool)->details);
113 OICFree(*thread_pool);
115 return CA_STATUS_FAILED;
118 (*thread_pool)->details->threads_list = u_arraylist_create();
120 if(!(*thread_pool)->details->threads_list)
122 OIC_LOG(ERROR, TAG, "Failed to create thread-pool list");
123 if(!ca_mutex_free((*thread_pool)->details->list_lock))
125 OIC_LOG(ERROR, TAG, "Failed to free thread-pool mutex");
128 OICFree((*thread_pool)->details);
129 OICFree(*thread_pool);
131 return CA_STATUS_FAILED;
134 OIC_LOG(DEBUG, TAG, "OUT");
138 CAResult_t ca_thread_pool_add_task(ca_thread_pool_t thread_pool, ca_thread_func method,
141 OIC_LOG(DEBUG, TAG, "IN");
143 if(NULL == thread_pool || NULL == method)
145 OIC_LOG(ERROR, TAG, "thread_pool or method was NULL");
146 return CA_STATUS_INVALID_PARAM;
149 ca_thread_pool_callback_info_t* info = OICMalloc(sizeof(ca_thread_pool_callback_info_t));
152 OIC_LOG(ERROR, TAG, "Failed to allocate for memory wrapper");
153 return CA_MEMORY_ALLOC_FAILED;
159 pthread_t threadHandle;
161 int result = pthread_create(&threadHandle, NULL, ca_thread_pool_pthreads_delegate, info);
165 OIC_LOG_V(ERROR, TAG, "Thread start failed with error %d", result);
166 return CA_STATUS_FAILED;
169 ca_mutex_lock(thread_pool->details->list_lock);
170 bool addResult = u_arraylist_add(thread_pool->details->threads_list, (void*)threadHandle);
171 ca_mutex_unlock(thread_pool->details->list_lock);
175 OIC_LOG_V(ERROR, TAG, "Arraylist Add failed, may not be properly joined: %d", addResult);
176 return CA_STATUS_FAILED;
179 OIC_LOG(DEBUG, TAG, "OUT");
183 void ca_thread_pool_free(ca_thread_pool_t thread_pool)
185 OIC_LOG(DEBUG, TAG, "IN");
189 OIC_LOG(ERROR, TAG, "Invalid parameter thread_pool was NULL");
193 ca_mutex_lock(thread_pool->details->list_lock);
195 for(uint32_t i = 0; i<u_arraylist_length(thread_pool->details->threads_list); ++i)
197 pthread_t tid = (pthread_t)u_arraylist_get(thread_pool->details->threads_list, i);
198 int joinres = pthread_join(tid, NULL);
201 OIC_LOG_V(ERROR, TAG, "Failed to join thread at index %u with error %d", i, joinres);
205 u_arraylist_free(&(thread_pool->details->threads_list));
207 ca_mutex_unlock(thread_pool->details->list_lock);
208 ca_mutex_free(thread_pool->details->list_lock);
210 OICFree(thread_pool->details);
211 OICFree(thread_pool);
213 OIC_LOG(DEBUG, TAG, "OUT");