libUPnP 1.14.19
|
#include <sys/param.h>
#include "ThreadPool.h"
#include "FreeList.h"
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
Functions | |
static long | DiffMillis (struct timeval *time1, struct timeval *time2) |
Returns the difference in milliseconds between two timeval structures. | |
static void | StatsInit (ThreadPoolStats *stats) |
Initializes the statistics structure. | |
static void | StatsAccountLQ (ThreadPool *tp, long diffTime) |
static void | StatsAccountMQ (ThreadPool *tp, long diffTime) |
static void | StatsAccountHQ (ThreadPool *tp, long diffTime) |
static void | CalcWaitTime (ThreadPool *tp, ThreadPriority p, ThreadPoolJob *job) |
Calculates the time the job has been waiting at the specified priority. | |
static time_t | StatsTime (time_t *t) |
static int | CmpThreadPoolJob (void *jobA, void *jobB) |
Compares thread pool jobs. | |
static void | FreeThreadPoolJob (ThreadPool *tp, ThreadPoolJob *tpj) |
Deallocates a dynamically allocated ThreadPoolJob. | |
static int | SetPolicyType (PolicyType in) |
Sets the scheduling policy of the current process. | |
static int | SetPriority (ThreadPriority priority) |
Sets the priority of the currently running thread. | |
static void | BumpPriority (ThreadPool *tp) |
Determines whether any jobs need to be bumped to a higher priority Q and bumps them. | |
static void | SetRelTimeout (struct timespec *time, int relMillis) |
Sets the fields of the passed in timespec to be relMillis milliseconds in the future. | |
static void | SetSeed (void) |
Sets seed for random number generator. Each thread sets the seed random number generator. | |
static void * | WorkerThread (void *arg) |
Implements a thread pool worker. Worker waits for a job to become available. Worker picks up persistent jobs first, high priority, med priority, then low priority. | |
static ThreadPoolJob * | CreateThreadPoolJob (ThreadPoolJob *job, int id, ThreadPool *tp) |
Creates a Thread Pool Job. (Dynamically allocated) | |
static int | CreateWorker (ThreadPool *tp) |
Creates a worker thread, if the thread pool does not already have max threads. | |
static void | AddWorker (ThreadPool *tp) |
Determines whether or not a thread should be added based on the jobsPerThread ratio. Adds a thread if appropriate. | |
int | ThreadPoolInit (ThreadPool *tp, ThreadPoolAttr *attr) |
Initializes and starts ThreadPool. Must be called first and only once for ThreadPool. | |
int | ThreadPoolAddPersistent (ThreadPool *tp, ThreadPoolJob *job, int *jobId) |
Adds a persistent job to the thread pool. | |
int | ThreadPoolAdd (ThreadPool *tp, ThreadPoolJob *job, int *jobId) |
Adds a job to the thread pool. Job will be run as soon as possible. | |
int | ThreadPoolRemove (ThreadPool *tp, int jobId, ThreadPoolJob *out) |
Removes a job from the thread pool. Can only remove jobs which are not currently running. | |
int | ThreadPoolGetAttr (ThreadPool *tp, ThreadPoolAttr *out) |
Gets the current set of attributes associated with the thread pool. | |
int | ThreadPoolSetAttr (ThreadPool *tp, ThreadPoolAttr *attr) |
Sets the attributes for the thread pool. Only affects future calculations. | |
int | ThreadPoolShutdown (ThreadPool *tp) |
Shuts the thread pool down. Waits for all threads to finish. May block indefinitely if jobs do not exit. | |
int | TPAttrInit (ThreadPoolAttr *attr) |
Initializes thread pool attributes. Sets values to defaults defined in ThreadPool.h. | |
int | TPJobInit (ThreadPoolJob *job, start_routine func, void *arg) |
Initializes thread pool job. Sets the priority to default defined in ThreadPool.h. Sets the free_routine to default defined in ThreadPool.h. | |
int | TPJobSetPriority (ThreadPoolJob *job, ThreadPriority priority) |
Sets the max threads for the thread pool attributes. | |
int | TPJobSetFreeFunction (ThreadPoolJob *job, free_routine func) |
Sets the max threads for the thread pool attributes. | |
int | TPAttrSetMaxThreads (ThreadPoolAttr *attr, int maxThreads) |
Sets the max threads for the thread pool attributes. | |
int | TPAttrSetMinThreads (ThreadPoolAttr *attr, int minThreads) |
Sets the min threads for the thread pool attributes. | |
int | TPAttrSetStackSize (ThreadPoolAttr *attr, size_t stackSize) |
Sets the stack size for the thread pool attributes. | |
int | TPAttrSetIdleTime (ThreadPoolAttr *attr, int idleTime) |
Sets the idle time for the thread pool attributes. | |
int | TPAttrSetJobsPerThread (ThreadPoolAttr *attr, int jobsPerThread) |
Sets the jobs per thread ratio. | |
int | TPAttrSetStarvationTime (ThreadPoolAttr *attr, int starvationTime) |
Sets the starvation time for the thread pool attributes. | |
int | TPAttrSetSchedPolicy (ThreadPoolAttr *attr, PolicyType schedPolicy) |
Sets the scheduling policy for the thread pool attributes. | |
int | TPAttrSetMaxJobsTotal (ThreadPoolAttr *attr, int maxJobsTotal) |
Sets the maximum number jobs that can be qeued totally. | |
void | ThreadPoolPrintStats (ThreadPoolStats *stats) |
int | ThreadPoolGetStats (ThreadPool *tp, ThreadPoolStats *stats) |
Returns various statistics about the thread pool. | |
|
static |
Determines whether or not a thread should be added based on the jobsPerThread ratio. Adds a thread if appropriate.
tp | A pointer to the ThreadPool object. |
References THREADPOOL::attr, THREADPOOL::busyThreads, CreateWorker(), THREADPOOL::highJobQ, THREADPOOLATTR::jobsPerThread, THREADPOOL::lowJobQ, THREADPOOL::medJobQ, THREADPOOL::persistentThreads, LINKEDLIST::size, and THREADPOOL::totalThreads.
Referenced by ThreadPoolAdd().
|
static |
Determines whether any jobs need to be bumped to a higher priority Q and bumps them.
tp->mutex must be locked.
tp | . |
References THREADPOOL::attr, DiffMillis(), LINKEDLIST::head, THREADPOOL::highJobQ, THREADPOOL::lowJobQ, THREADPOOLATTR::maxIdleTime, THREADPOOL::medJobQ, LINKEDLIST::size, THREADPOOLATTR::starvationTime, StatsAccountLQ(), and StatsAccountMQ().
Referenced by WorkerThread().
|
static |
Calculates the time the job has been waiting at the specified priority.
Adds to the totalTime and totalJobs kept in the thread pool statistics structure.
tp | . |
p | . |
job | . |
References DiffMillis(), StatsAccountHQ(), StatsAccountLQ(), and StatsAccountMQ().
Referenced by WorkerThread().
|
static |
Compares thread pool jobs.
Referenced by ThreadPoolInit().
|
static |
Creates a Thread Pool Job. (Dynamically allocated)
job | job is copied. |
id | id of job. |
tp | . |
References THREADPOOL::jobFreeList.
Referenced by ThreadPoolAdd(), and ThreadPoolAddPersistent().
|
static |
Creates a worker thread, if the thread pool does not already have max threads.
0
on success, < 0 on failure. EMAXTHREADS
if already max threads reached. EAGAIN
if system can not create thread. tp | A pointer to the ThreadPool object. |
References THREADPOOL::attr, THREADPOOLATTR::maxThreads, THREADPOOL::mutex, THREADPOOL::pendingWorkerThreadStart, THREADPOOLATTR::stackSize, THREADPOOL::start_and_shutdown, THREADPOOL::stats, THREADPOOL::totalThreads, and WorkerThread().
Referenced by AddWorker(), ThreadPoolAddPersistent(), ThreadPoolInit(), and ThreadPoolSetAttr().
|
static |
Returns the difference in milliseconds between two timeval structures.
time1 | . |
time2 | . |
Referenced by BumpPriority(), and CalcWaitTime().
|
static |
Deallocates a dynamically allocated ThreadPoolJob.
tp | . |
tpj | Must be allocated with CreateThreadPoolJob. |
References THREADPOOL::jobFreeList.
Referenced by ThreadPoolAdd(), ThreadPoolRemove(), ThreadPoolShutdown(), and WorkerThread().
|
static |
Sets the scheduling policy of the current process.
0
on success. result
of GetLastError() on failure. in | . |
Referenced by ThreadPoolInit(), and ThreadPoolSetAttr().
|
static |
Sets the priority of the currently running thread.
0
on success. EINVAL
invalid priority or the result of GerLastError. priority | . |
Referenced by WorkerThread().
|
static |
Sets the fields of the passed in timespec to be relMillis milliseconds in the future.
time | . |
relMillis | milliseconds in the future. |
Referenced by WorkerThread().
|
static |
Sets seed for random number generator. Each thread sets the seed random number generator.
Referenced by WorkerThread().
|
static |
|
static |
tp | . |
diffTime | . |
References THREADPOOL::stats.
Referenced by BumpPriority(), and CalcWaitTime().
|
static |
tp | . |
diffTime | . |
References THREADPOOL::stats.
Referenced by BumpPriority(), and CalcWaitTime().
|
static |
Initializes the statistics structure.
stats | Must be valid non null stats structure. |
Referenced by ThreadPoolInit().
|
static |
t | . |
Referenced by ThreadPoolPrintStats(), and WorkerThread().
int ThreadPoolAdd | ( | ThreadPool * | tp, |
ThreadPoolJob * | job, | ||
int * | jobId | ||
) |
Adds a job to the thread pool. Job will be run as soon as possible.
0
on success, nonzero on failure. EOUTOFMEM
if not enough memory to add job. tp | valid thread pool pointer. |
job | . |
jobId | id of job. |
References AddWorker(), THREADPOOL::attr, THREADPOOL::condition, CreateThreadPoolJob(), FreeThreadPoolJob(), THREADPOOL::highJobQ, INVALID_JOB_ID, THREADPOOL::lastJobId, THREADPOOL::lowJobQ, THREADPOOLATTR::maxJobsTotal, THREADPOOL::medJobQ, THREADPOOL::mutex, and LINKEDLIST::size.
Referenced by genaNotifyThread(), readFromSSDPSocket(), ssdp_handle_ctrlpt_msg(), TimerThreadWorker(), UpnpGetServiceVarStatusAsync(), UpnpRenewSubscriptionAsync(), UpnpSendActionAsync(), UpnpSendActionExAsync(), UpnpSubscribeAsync(), and UpnpUnSubscribeAsync().
int ThreadPoolAddPersistent | ( | ThreadPool * | tp, |
ThreadPoolJob * | job, | ||
int * | jobId | ||
) |
Adds a persistent job to the thread pool.
Job will be run as soon as possible. Call will block until job is scheduled.
0
on success. EOUTOFMEM
not enough memory to add job. EMAXTHREADS
not enough threads to add persistent job. tp | Valid thread pool pointer. |
job | Valid thread pool job. |
jobId | . |
References THREADPOOL::attr, THREADPOOL::condition, CreateThreadPoolJob(), CreateWorker(), INVALID_JOB_ID, THREADPOOL::lastJobId, THREADPOOLATTR::maxThreads, THREADPOOL::mutex, THREADPOOL::persistentJob, THREADPOOL::persistentThreads, THREADPOOL::start_and_shutdown, and THREADPOOL::totalThreads.
Referenced by StartMiniServer(), TimerThreadInit(), and TimerThreadWorker().
int ThreadPoolGetAttr | ( | ThreadPool * | tp, |
ThreadPoolAttr * | out | ||
) |
Gets the current set of attributes associated with the thread pool.
0
on success, nonzero on failure. tp | valid thread pool pointer. |
out | non null pointer to store attributes. |
References THREADPOOL::attr, THREADPOOL::mutex, and THREADPOOL::shutdown.
int ThreadPoolGetStats | ( | ThreadPool * | tp, |
ThreadPoolStats * | stats | ||
) |
Returns various statistics about the thread pool.
Only valid if STATS has been defined.
tp | Valid initialized threadpool. |
stats | Valid stats, out parameter. |
References THREADPOOL::highJobQ, THREADPOOL::lowJobQ, THREADPOOL::medJobQ, THREADPOOL::mutex, THREADPOOL::persistentThreads, THREADPOOL::shutdown, THREADPOOL::stats, and THREADPOOL::totalThreads.
Referenced by PrintThreadPoolStats().
int ThreadPoolInit | ( | ThreadPool * | tp, |
ThreadPoolAttr * | attr | ||
) |
Initializes and starts ThreadPool. Must be called first and only once for ThreadPool.
0
on success. EAGAIN
if not enough system resources to create minimum threads. INVALID_POLICY
if schedPolicy can't be set. EMAXTHREADS
if minimum threads is greater than maximum threads. tp | Must be valid, non null, pointer to ThreadPool. |
attr | Can be null. if not null then attr contains the following fields:
|
References THREADPOOL::attr, THREADPOOL::busyThreads, CmpThreadPoolJob(), THREADPOOL::condition, CreateWorker(), THREADPOOL::highJobQ, INVALID_POLICY, THREADPOOL::jobFreeList, JOBFREELISTSIZE, THREADPOOL::lastJobId, THREADPOOL::lowJobQ, THREADPOOL::medJobQ, THREADPOOLATTR::minThreads, THREADPOOL::mutex, THREADPOOL::pendingWorkerThreadStart, THREADPOOL::persistentJob, THREADPOOL::persistentThreads, THREADPOOLATTR::schedPolicy, SetPolicyType(), THREADPOOL::shutdown, THREADPOOL::start_and_shutdown, THREADPOOL::stats, StatsInit(), ThreadPoolShutdown(), THREADPOOL::totalThreads, and TPAttrInit().
Referenced by UpnpInitThreadPools().
void ThreadPoolPrintStats | ( | ThreadPoolStats * | stats | ) |
stats | . |
References StatsTime().
int ThreadPoolRemove | ( | ThreadPool * | tp, |
int | jobId, | ||
ThreadPoolJob * | out | ||
) |
Removes a job from the thread pool. Can only remove jobs which are not currently running.
0
on success, nonzero on failure. INVALID_JOB_ID
if job not found. tp | valid thread pool pointer. |
jobId | id of job. |
out | space for removed job. |
References FreeThreadPoolJob(), THREADPOOL::highJobQ, INVALID_JOB_ID, THREADPOOL::lowJobQ, THREADPOOL::medJobQ, THREADPOOL::mutex, and THREADPOOL::persistentJob.
int ThreadPoolSetAttr | ( | ThreadPool * | tp, |
ThreadPoolAttr * | attr | ||
) |
Sets the attributes for the thread pool. Only affects future calculations.
0
on success, nonzero on failure. INVALID_POLICY
if policy can not be set. tp | valid thread pool pointer. |
attr | pointer to attributes, null sets attributes to default. |
References THREADPOOL::attr, THREADPOOL::condition, CreateWorker(), INVALID_POLICY, THREADPOOLATTR::minThreads, THREADPOOL::mutex, THREADPOOLATTR::schedPolicy, SetPolicyType(), ThreadPoolShutdown(), THREADPOOL::totalThreads, and TPAttrInit().
int ThreadPoolShutdown | ( | ThreadPool * | tp | ) |
Shuts the thread pool down. Waits for all threads to finish. May block indefinitely if jobs do not exit.
tp | must be valid tp. |
References THREADPOOL::condition, FreeThreadPoolJob(), THREADPOOL::highJobQ, THREADPOOL::jobFreeList, THREADPOOL::lowJobQ, THREADPOOL::medJobQ, THREADPOOL::mutex, THREADPOOL::persistentJob, THREADPOOL::shutdown, LINKEDLIST::size, THREADPOOL::start_and_shutdown, and THREADPOOL::totalThreads.
Referenced by ThreadPoolInit(), ThreadPoolSetAttr(), and UpnpFinish().
int TPAttrInit | ( | ThreadPoolAttr * | attr | ) |
Initializes thread pool attributes. Sets values to defaults defined in ThreadPool.h.
attr | must be valid thread pool attributes. |
References DEFAULT_IDLE_TIME, DEFAULT_JOBS_PER_THREAD, DEFAULT_MAX_JOBS_TOTAL, DEFAULT_MAX_THREADS, DEFAULT_MIN_THREADS, DEFAULT_STACK_SIZE, DEFAULT_STARVATION_TIME, THREADPOOLATTR::jobsPerThread, THREADPOOLATTR::maxIdleTime, THREADPOOLATTR::maxJobsTotal, THREADPOOLATTR::maxThreads, THREADPOOLATTR::minThreads, THREADPOOLATTR::schedPolicy, THREADPOOLATTR::stackSize, and THREADPOOLATTR::starvationTime.
Referenced by ThreadPoolInit(), ThreadPoolSetAttr(), and UpnpInitThreadPools().
int TPAttrSetIdleTime | ( | ThreadPoolAttr * | attr, |
int | idleTime | ||
) |
Sets the idle time for the thread pool attributes.
attr | must be valid thread pool attributes. |
idleTime | . |
References THREADPOOLATTR::maxIdleTime.
Referenced by UpnpInitThreadPools().
int TPAttrSetJobsPerThread | ( | ThreadPoolAttr * | attr, |
int | jobsPerThread | ||
) |
Sets the jobs per thread ratio.
attr | must be valid thread pool attributes. |
jobsPerThread | number of jobs per thread to maintain. |
References THREADPOOLATTR::jobsPerThread.
Referenced by UpnpInitThreadPools().
int TPAttrSetMaxJobsTotal | ( | ThreadPoolAttr * | attr, |
int | maxJobsTotal | ||
) |
Sets the maximum number jobs that can be qeued totally.
attr | must be valid thread pool attributes. |
maxJobsTotal | maximum number of jobs. |
References THREADPOOLATTR::maxJobsTotal.
Referenced by UpnpInitThreadPools().
int TPAttrSetMaxThreads | ( | ThreadPoolAttr * | attr, |
int | maxThreads | ||
) |
Sets the max threads for the thread pool attributes.
attr | must be valid thread pool attributes. |
maxThreads | value to set. |
References THREADPOOLATTR::maxThreads.
Referenced by UpnpInitThreadPools().
int TPAttrSetMinThreads | ( | ThreadPoolAttr * | attr, |
int | minThreads | ||
) |
Sets the min threads for the thread pool attributes.
attr | must be valid thread pool attributes. |
minThreads | value to set. |
References THREADPOOLATTR::minThreads.
Referenced by UpnpInitThreadPools().
int TPAttrSetSchedPolicy | ( | ThreadPoolAttr * | attr, |
PolicyType | schedPolicy | ||
) |
Sets the scheduling policy for the thread pool attributes.
attr | must be valid thread pool attributes. |
schedPolicy | must be a valid policy type. |
References THREADPOOLATTR::schedPolicy.
int TPAttrSetStackSize | ( | ThreadPoolAttr * | attr, |
size_t | stackSize | ||
) |
Sets the stack size for the thread pool attributes.
attr | must be valid thread pool attributes. |
stackSize | value to set. |
References THREADPOOLATTR::stackSize.
Referenced by UpnpInitThreadPools().
int TPAttrSetStarvationTime | ( | ThreadPoolAttr * | attr, |
int | starvationTime | ||
) |
Sets the starvation time for the thread pool attributes.
attr | must be valid thread pool attributes. |
starvationTime | milliseconds. |
References THREADPOOLATTR::starvationTime.
int TPJobInit | ( | ThreadPoolJob * | job, |
start_routine | func, | ||
void * | arg | ||
) |
Initializes thread pool job. Sets the priority to default defined in ThreadPool.h. Sets the free_routine to default defined in ThreadPool.h.
job | must be valid thread pool attributes. |
func | function to run, must be valid. |
arg | argument to pass to function. |
References DEFAULT_FREE_ROUTINE, and DEFAULT_PRIORITY.
Referenced by readFromSSDPSocket(), ScheduleGenaAutoRenew(), SearchByTarget(), ssdp_handle_ctrlpt_msg(), ssdp_handle_device_request(), StartMiniServer(), TimerThreadInit(), UpnpGetServiceVarStatusAsync(), UpnpRenewSubscriptionAsync(), UpnpSendActionAsync(), UpnpSendActionExAsync(), UpnpSendAdvertisementLowPower(), UpnpSubscribeAsync(), and UpnpUnSubscribeAsync().
int TPJobSetFreeFunction | ( | ThreadPoolJob * | job, |
free_routine | func | ||
) |
Sets the max threads for the thread pool attributes.
job | must be valid thread pool attributes. |
func | value to set. |
Referenced by readFromSSDPSocket(), ScheduleGenaAutoRenew(), SearchByTarget(), ssdp_handle_ctrlpt_msg(), ssdp_handle_device_request(), StartMiniServer(), UpnpGetServiceVarStatusAsync(), UpnpRenewSubscriptionAsync(), UpnpSendActionAsync(), UpnpSendActionExAsync(), UpnpSendAdvertisementLowPower(), UpnpSubscribeAsync(), and UpnpUnSubscribeAsync().
int TPJobSetPriority | ( | ThreadPoolJob * | job, |
ThreadPriority | priority | ||
) |
Sets the max threads for the thread pool attributes.
job | must be valid thread pool attributes. |
priority | value to set. |
Referenced by readFromSSDPSocket(), ScheduleGenaAutoRenew(), SearchByTarget(), ssdp_handle_ctrlpt_msg(), StartMiniServer(), TimerThreadInit(), UpnpGetServiceVarStatusAsync(), UpnpRenewSubscriptionAsync(), UpnpSendActionAsync(), UpnpSendActionExAsync(), UpnpSendAdvertisementLowPower(), UpnpSubscribeAsync(), and UpnpUnSubscribeAsync().
|
static |
Implements a thread pool worker. Worker waits for a job to become available. Worker picks up persistent jobs first, high priority, med priority, then low priority.
If worker remains idle for more than specified max, the worker is released.
arg | arg -> is cast to (ThreadPool *). |
References THREADPOOL::attr, BumpPriority(), THREADPOOL::busyThreads, CalcWaitTime(), THREADPOOL::condition, DEFAULT_PRIORITY, FreeThreadPoolJob(), THREADPOOL::highJobQ, THREADPOOL::lowJobQ, THREADPOOLATTR::maxIdleTime, THREADPOOLATTR::maxThreads, THREADPOOL::medJobQ, THREADPOOLATTR::minThreads, THREADPOOL::mutex, THREADPOOL::pendingWorkerThreadStart, THREADPOOL::persistentJob, THREADPOOL::persistentThreads, SetPriority(), SetRelTimeout(), SetSeed(), THREADPOOL::shutdown, LINKEDLIST::size, THREADPOOL::start_and_shutdown, THREADPOOL::stats, StatsTime(), and THREADPOOL::totalThreads.
Referenced by CreateWorker().