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 "iotivity_config.h"
32 #if defined HAVE_PTHREAD_H
35 #if defined HAVE_WINSOCK2_H
38 #include "cathreadpool.h"
40 #include "oic_malloc.h"
41 #include "uarraylist.h"
43 #include "platform_features.h"
45 #define TAG PCF("UTHREADPOOL")
48 * empty struct to represent the details. This implementation has no data
49 * that it needs to keep track of, so it only uses NULL for the internal value.
51 typedef struct ca_thread_pool_details_t
53 u_arraylist_t* threads_list;
55 } ca_thread_pool_details_t;
58 * struct to wrap the pthreads callback properly. The function pointer for
59 * pthreads requires a void* return value, however u_thread_func is a void.
61 typedef struct ca_thread_pool_callback_info_t
65 } ca_thread_pool_callback_info_t;
67 // passthrough function to convert the pthreads call to a u_thread_func call
68 void* ca_thread_pool_pthreads_delegate(void* data)
70 ca_thread_pool_callback_info_t* info = (ca_thread_pool_callback_info_t*)data;
71 info->func(info->data);
76 // this implementation doesn't do a thread pool, so this function is essentially
77 // a no-op besides creating a valid ca_thread_pool_t object. It was determined after
78 // reading through the existing implementation that the thread-pooling was unnecessary
79 // for the posix platforms. Behavior shouldn't be changed since previously num_of_threads
80 // was greater than the number of requested threads.
81 CAResult_t ca_thread_pool_init(int32_t num_of_threads, ca_thread_pool_t *thread_pool)
83 OIC_LOG(DEBUG, TAG, "IN");
87 OIC_LOG(ERROR, TAG, "Parameter thread_pool was null!");
88 return CA_STATUS_INVALID_PARAM;
91 if(num_of_threads <= 0)
93 OIC_LOG(ERROR, TAG, "num_of_threads must be positive and non-zero");
94 return CA_STATUS_INVALID_PARAM;
97 *thread_pool = OICMalloc(sizeof(struct ca_thread_pool));
101 OIC_LOG(ERROR, TAG, "Failed to allocate for thread-pool");
102 return CA_MEMORY_ALLOC_FAILED;
105 (*thread_pool)->details = OICMalloc(sizeof(struct ca_thread_pool_details_t));
106 if(!(*thread_pool)->details)
108 OIC_LOG(ERROR, TAG, "Failed to allocate for thread-pool details");
109 OICFree(*thread_pool);
111 return CA_MEMORY_ALLOC_FAILED;
114 (*thread_pool)->details->list_lock = ca_mutex_new();
116 if(!(*thread_pool)->details->list_lock)
118 OIC_LOG(ERROR, TAG, "Failed to create thread-pool mutex");
122 (*thread_pool)->details->threads_list = u_arraylist_create();
124 if(!(*thread_pool)->details->threads_list)
126 OIC_LOG(ERROR, TAG, "Failed to create thread-pool list");
127 if(!ca_mutex_free((*thread_pool)->details->list_lock))
129 OIC_LOG(ERROR, TAG, "Failed to free thread-pool mutex");
134 OIC_LOG(DEBUG, TAG, "OUT");
138 OICFree((*thread_pool)->details);
139 OICFree(*thread_pool);
141 return CA_STATUS_FAILED;
144 CAResult_t ca_thread_pool_add_task(ca_thread_pool_t thread_pool, ca_thread_func method,
147 OIC_LOG(DEBUG, TAG, "IN");
149 if(NULL == thread_pool || NULL == method)
151 OIC_LOG(ERROR, TAG, "thread_pool or method was NULL");
152 return CA_STATUS_INVALID_PARAM;
155 ca_thread_pool_callback_info_t* info = OICMalloc(sizeof(ca_thread_pool_callback_info_t));
158 OIC_LOG(ERROR, TAG, "Failed to allocate for memory wrapper");
159 return CA_MEMORY_ALLOC_FAILED;
165 pthread_t threadHandle;
166 int result = pthread_create(&threadHandle, NULL, ca_thread_pool_pthreads_delegate, info);
170 OIC_LOG_V(ERROR, TAG, "Thread start failed with error %d", result);
171 return CA_STATUS_FAILED;
174 ca_mutex_lock(thread_pool->details->list_lock);
175 bool addResult = u_arraylist_add(thread_pool->details->threads_list, (void*)threadHandle);
176 ca_mutex_unlock(thread_pool->details->list_lock);
180 OIC_LOG_V(ERROR, TAG, "Arraylist Add failed, may not be properly joined: %d", addResult);
181 return CA_STATUS_FAILED;
184 OIC_LOG(DEBUG, TAG, "OUT");
188 void ca_thread_pool_free(ca_thread_pool_t thread_pool)
190 OIC_LOG(DEBUG, TAG, "IN");
194 OIC_LOG(ERROR, TAG, "Invalid parameter thread_pool was NULL");
198 ca_mutex_lock(thread_pool->details->list_lock);
200 for(uint32_t i = 0; i<u_arraylist_length(thread_pool->details->threads_list); ++i)
202 pthread_t tid = (pthread_t)u_arraylist_get(thread_pool->details->threads_list, i);
204 DWORD joinres = WaitForSingleObject(tid, INFINITE);
205 if (WAIT_OBJECT_0 != joinres)
207 OIC_LOG_V(ERROR, TAG, "Failed to join thread at index %u with error %d", i, joinres);
211 int joinres = pthread_join(tid, NULL);
214 OIC_LOG_V(ERROR, TAG, "Failed to join thread at index %u with error %d", i, joinres);
219 u_arraylist_free(&(thread_pool->details->threads_list));
221 ca_mutex_unlock(thread_pool->details->list_lock);
222 ca_mutex_free(thread_pool->details->list_lock);
224 OICFree(thread_pool->details);
225 OICFree(thread_pool);
227 OIC_LOG(DEBUG, TAG, "OUT");