libUPnP 1.14.19
ThreadPool.h
Go to the documentation of this file.
1/*******************************************************************************
2 *
3 * Copyright (c) 2000-2003 Intel Corporation
4 * All rights reserved.
5 * Copyright (c) 2012 France Telecom All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 *
10 * * Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 * * Neither name of Intel Corporation nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
27 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 ******************************************************************************/
32
33#ifndef THREADPOOL_H
34#define THREADPOOL_H
35
40#include "FreeList.h"
41#include "LinkedList.h"
42#include "UpnpGlobal.h" /* for UPNP_INLINE, UPNP_EXPORT_SPEC */
43#include "UpnpInet.h"
44#include "ithread.h"
45
46#include <errno.h>
47
48#ifdef _WIN32
49 #include <time.h>
50
51 #ifndef _TIMEZONE_DEFINED
52struct timezone
53{
54 int tz_minuteswest; /* minutes W of Greenwich */
55 int tz_dsttime; /* type of dst correction */
56};
57 #endif
58int gettimeofday(struct timeval *tv, struct timezone *tz);
59#else /* _WIN32 */
60 #include <sys/param.h>
61 #include <sys/time.h> /* for gettimeofday() */
62 #if defined(__APPLE__) || defined(__NetBSD__)
63 #include <sys/resource.h> /* for setpriority() */
64 #endif
65#endif
66
67#ifdef __cplusplus
68extern "C" {
69#endif
70
72#define JOBFREELISTSIZE 100
73
74#define INFINITE_THREADS -1
75
76#define EMAXTHREADS (-8 & 1 << 29)
77
79#define INVALID_POLICY (-9 & 1 << 29)
80
82#define INVALID_JOB_ID (-2 & 1 << 29)
83
84typedef enum duration
85{
86 SHORT_TERM,
87 PERSISTENT
88} Duration;
89
90typedef enum priority
91{
92 LOW_PRIORITY,
93 MED_PRIORITY,
94 HIGH_PRIORITY
95} ThreadPriority;
96
98#define DEFAULT_PRIORITY MED_PRIORITY
99
101#define DEFAULT_MIN_THREADS 1
102
104#define DEFAULT_MAX_THREADS 10
105
107#define DEFAULT_STACK_SIZE 0u
108
110#define DEFAULT_JOBS_PER_THREAD 10
111
113#define DEFAULT_STARVATION_TIME 500
114
116#define DEFAULT_IDLE_TIME 10 * 1000
117
119#define DEFAULT_FREE_ROUTINE NULL
120
122#define DEFAULT_MAX_JOBS_TOTAL 100
123
129#define STATS 1
130
131#ifdef _DEBUG
132 #define DEBUG 1
133#endif
134
135typedef int PolicyType;
136
137#define DEFAULT_POLICY SCHED_OTHER
138
140typedef void (*free_routine)(void *arg);
141
165
167typedef struct THREADPOOLJOB
168{
169 start_routine func;
170 void *arg;
171 free_routine free_func;
172 struct timeval requestTime;
173 ThreadPriority priority;
174 int jobId;
176
178typedef struct TPOOLSTATS
179{
180 double totalTimeHQ;
181 int totalJobsHQ;
182 double avgWaitHQ;
183 double totalTimeMQ;
184 int totalJobsMQ;
185 double avgWaitMQ;
186 double totalTimeLQ;
187 int totalJobsLQ;
188 double avgWaitLQ;
189 double totalWorkTime;
190 double totalIdleTime;
191 int workerThreads;
192 int idleThreads;
193 int persistentThreads;
194 int totalThreads;
195 int maxThreads;
196 int currentJobsHQ;
197 int currentJobsLQ;
198 int currentJobsMQ;
200
251
264 ThreadPool *tp,
280 ThreadPoolAttr *attr);
281
294 ThreadPool *tp,
296 ThreadPoolJob *job,
298 int *jobId);
299
308 ThreadPool *tp,
310 ThreadPoolAttr *out);
311
322 ThreadPool *tp,
324 ThreadPoolAttr *attr);
325
333int ThreadPoolAdd(
335 ThreadPool *tp,
337 ThreadPoolJob *job,
339 int *jobId);
340
351 ThreadPool *tp,
353 int jobId,
355 ThreadPoolJob *out);
356
365 ThreadPool *tp);
366
373int TPJobInit(
375 ThreadPoolJob *job,
377 start_routine func,
379 void *arg);
380
388 ThreadPoolJob *job,
390 ThreadPriority priority);
391
399 ThreadPoolJob *job,
401 free_routine func);
402
409int TPAttrInit(
411 ThreadPoolAttr *attr);
412
420 ThreadPoolAttr *attr,
422 int maxThreads);
423
431 ThreadPoolAttr *attr,
433 int minThreads);
434
442 ThreadPoolAttr *attr,
444 size_t stackSize);
445
453 ThreadPoolAttr *attr,
455 int idleTime);
456
464 ThreadPoolAttr *attr,
466 int jobsPerThread);
467
475 ThreadPoolAttr *attr,
477 int starvationTime);
478
486 ThreadPoolAttr *attr,
488 PolicyType schedPolicy);
489
497 ThreadPoolAttr *attr,
499 int maxJobsTotal);
500
508#ifdef STATS
511 ThreadPool *tp,
513 ThreadPoolStats *stats);
514#else
517 ThreadPool *tp,
519 ThreadPoolStats *stats)
520{
521}
522#endif
523
527#ifdef STATS
530 ThreadPoolStats *stats);
531#else
534 ThreadPoolStats *stats)
535{
536}
537#endif
538
539#ifdef __cplusplus
540}
541#endif
542
543#endif /* THREADPOOL_H */
int ThreadPoolInit(ThreadPool *tp, ThreadPoolAttr *attr)
Initializes and starts ThreadPool. Must be called first and only once for ThreadPool.
Definition ThreadPool.c:710
int ThreadPoolAdd(ThreadPool *tp, ThreadPoolJob *job, int *jobId)
Adds a job to the thread pool. Job will be run as soon as possible.
Definition ThreadPool.c:826
struct THREADPOOL ThreadPool
A thread pool similar to the thread pool in the UPnP SDK.
int TPJobSetFreeFunction(ThreadPoolJob *job, free_routine func)
Sets the max threads for the thread pool attributes.
Definition ThreadPool.c:1113
int ThreadPoolShutdown(ThreadPool *tp)
Shuts the thread pool down. Waits for all threads to finish. May block indefinitely if jobs do not ex...
Definition ThreadPool.c:990
int ThreadPoolGetAttr(ThreadPool *tp, ThreadPoolAttr *out)
Gets the current set of attributes associated with the thread pool.
Definition ThreadPool.c:936
int TPAttrSetMaxJobsTotal(ThreadPoolAttr *attr, int maxJobsTotal)
Sets the maximum number jobs that can be qeued totally.
Definition ThreadPool.c:1185
int TPJobInit(ThreadPoolJob *job, start_routine func, void *arg)
Initializes thread pool job. Sets the priority to default defined in ThreadPool.h....
Definition ThreadPool.c:1086
UPNP_EXPORT_SPEC void ThreadPoolPrintStats(ThreadPoolStats *stats)
Definition ThreadPool.c:1195
int TPAttrSetStarvationTime(ThreadPoolAttr *attr, int starvationTime)
Sets the starvation time for the thread pool attributes.
Definition ThreadPool.c:1167
int TPAttrSetMaxThreads(ThreadPoolAttr *attr, int maxThreads)
Sets the max threads for the thread pool attributes.
Definition ThreadPool.c:1122
int TPJobSetPriority(ThreadPoolJob *job, ThreadPriority priority)
Sets the max threads for the thread pool attributes.
Definition ThreadPool.c:1098
struct TPOOLSTATS ThreadPoolStats
int ThreadPoolSetAttr(ThreadPool *tp, ThreadPoolAttr *attr)
Sets the attributes for the thread pool. Only affects future calculations.
Definition ThreadPool.c:949
int ThreadPoolRemove(ThreadPool *tp, int jobId, ThreadPoolJob *out)
Removes a job from the thread pool. Can only remove jobs which are not currently running.
Definition ThreadPool.c:879
struct THREADPOOLATTR ThreadPoolAttr
int TPAttrSetJobsPerThread(ThreadPoolAttr *attr, int jobsPerThread)
Sets the jobs per thread ratio.
Definition ThreadPool.c:1158
struct THREADPOOLJOB ThreadPoolJob
int TPAttrInit(ThreadPoolAttr *attr)
Initializes thread pool attributes. Sets values to defaults defined in ThreadPool....
Definition ThreadPool.c:1070
int TPAttrSetIdleTime(ThreadPoolAttr *attr, int idleTime)
Sets the idle time for the thread pool attributes.
Definition ThreadPool.c:1149
int TPAttrSetMinThreads(ThreadPoolAttr *attr, int minThreads)
Sets the min threads for the thread pool attributes.
Definition ThreadPool.c:1131
int TPAttrSetSchedPolicy(ThreadPoolAttr *attr, PolicyType schedPolicy)
Sets the scheduling policy for the thread pool attributes.
Definition ThreadPool.c:1176
void(* free_routine)(void *arg)
Definition ThreadPool.h:140
int TPAttrSetStackSize(ThreadPoolAttr *attr, size_t stackSize)
Sets the stack size for the thread pool attributes.
Definition ThreadPool.c:1140
int ThreadPoolAddPersistent(ThreadPool *tp, ThreadPoolJob *job, int *jobId)
Adds a persistent job to the thread pool.
Definition ThreadPool.c:778
UPNP_EXPORT_SPEC int ThreadPoolGetStats(ThreadPool *tp, ThreadPoolStats *stats)
Returns various statistics about the thread pool.
Definition ThreadPool.c:1231
Defines constants that for some reason are not defined on some systems.
#define UPNP_EXPORT_SPEC
Export functions on WIN32 DLLs.
Definition UpnpGlobal.h:98
#define UPNP_INLINE
Declares an inline function.
Definition UpnpGlobal.h:112
Provides a platform independent way to include TCP/IP types and functions.
Definition FreeList.h:62
Definition LinkedList.h:84
Definition ThreadPool.h:145
int maxJobsTotal
Definition ThreadPool.h:158
PolicyType schedPolicy
Definition ThreadPool.h:163
int maxThreads
Definition ThreadPool.h:149
int jobsPerThread
Definition ThreadPool.h:156
int maxIdleTime
Definition ThreadPool.h:154
int minThreads
Definition ThreadPool.h:147
size_t stackSize
Definition ThreadPool.h:151
int starvationTime
Definition ThreadPool.h:161
Definition ThreadPool.h:168
A thread pool similar to the thread pool in the UPnP SDK.
Definition ThreadPool.h:217
int lastJobId
Definition ThreadPool.h:225
int pendingWorkerThreadStart
Definition ThreadPool.h:231
int busyThreads
Definition ThreadPool.h:233
LinkedList lowJobQ
Definition ThreadPool.h:239
ithread_mutex_t mutex
Definition ThreadPool.h:219
ThreadPoolAttr attr
Definition ThreadPool.h:247
int persistentThreads
Definition ThreadPool.h:235
int totalThreads
Definition ThreadPool.h:229
LinkedList medJobQ
Definition ThreadPool.h:241
int shutdown
Definition ThreadPool.h:227
LinkedList highJobQ
Definition ThreadPool.h:243
ThreadPoolStats stats
Definition ThreadPool.h:249
FreeList jobFreeList
Definition ThreadPool.h:237
ithread_cond_t condition
Definition ThreadPool.h:221
ThreadPoolJob * persistentJob
Definition ThreadPool.h:245
ithread_cond_t start_and_shutdown
Definition ThreadPool.h:223
Definition ThreadPool.h:179