version 1.48, 2005/04/01 17:26:52
|
version 1.65, 2008/11/13 22:15:03
|
|
|
//%2005//////////////////////////////////////////////////////////////////////// |
//%2006//////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development | // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. | // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
|
|
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. | // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; | // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
// EMC Corporation; VERITAS Software Corporation; The Open Group. | // EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; Symantec Corporation; The Open Group. |
// | // |
// Permission is hereby granted, free of charge, to any person obtaining a copy | // Permission is hereby granted, free of charge, to any person obtaining a copy |
// of this software and associated documentation files (the "Software"), to | // of this software and associated documentation files (the "Software"), to |
|
|
// | // |
//============================================================================== | //============================================================================== |
// | // |
// Author: Mike Day (mdday@us.ibm.com) |
|
// |
|
// Modified By: Markus Mueller |
|
// Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com) |
|
// Amit K Arora, IBM (amita@in.ibm.com) for PEP#101 |
|
// David Dillard, VERITAS Software Corp. |
|
// (david.dillard@veritas.com) |
|
// Sean Keenan, Hewlett-Packard Company (sean.keenan@hp.com) |
|
// |
|
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#ifndef Pegasus_Thread_h | #ifndef Pegasus_Thread_h |
|
|
| |
#include <cstring> | #include <cstring> |
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
#include <Pegasus/Common/IPC.h> |
#include <Pegasus/Common/AtomicInt.h> |
#include <Pegasus/Common/InternalException.h> | #include <Pegasus/Common/InternalException.h> |
#include <Pegasus/Common/DQueue.h> |
#include <Pegasus/Common/AcceptLanguageList.h> |
#include <Pegasus/Common/AcceptLanguages.h> // l10n |
|
#include <Pegasus/Common/Linkage.h> | #include <Pegasus/Common/Linkage.h> |
#include <Pegasus/Common/AutoPtr.h> | #include <Pegasus/Common/AutoPtr.h> |
|
#include <Pegasus/Common/List.h> |
|
#include <Pegasus/Common/Mutex.h> |
|
#include <Pegasus/Common/Semaphore.h> |
|
#include <Pegasus/Common/TSDKey.h> |
|
#include <Pegasus/Common/Threads.h> |
|
|
|
#if defined(PEGASUS_HAVE_PTHREADS) |
|
# include <signal.h> |
|
#endif |
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
class PEGASUS_COMMON_LINKAGE cleanup_handler |
class PEGASUS_COMMON_LINKAGE cleanup_handler : public Linkable |
{ | { |
|
|
public: | public: |
cleanup_handler( void (*routine)(void *), void *arg ) : _routine(routine), _arg(arg) {} |
cleanup_handler(void (*routine) (void *), void *arg):_routine(routine), |
~cleanup_handler() {; } |
_arg(arg) |
inline Boolean operator==(const void *key) const |
|
{ | { |
if(key == (void *)_routine) |
|
return true; |
|
return false; |
|
} | } |
inline Boolean operator ==(const cleanup_handler & b) const |
~cleanup_handler() |
{ |
{; |
return(operator==((const void *)b._routine)); |
|
} | } |
|
|
private: | private: |
void execute(void) { _routine(_arg); } |
|
|
void execute() |
|
{ |
|
_routine(_arg); |
|
} |
|
|
cleanup_handler(); | cleanup_handler(); |
void (*_routine)(void *); |
|
| |
|
void (*_routine)(void*); |
void *_arg; | void *_arg; |
PEGASUS_CLEANUP_HANDLE _cleanup_buffer; |
|
friend class DQueue<class cleanup_handler>; |
|
friend class Thread; | friend class Thread; |
}; | }; |
| |
/////////////////////////////////////////////////////////////////////////////// | /////////////////////////////////////////////////////////////////////////////// |
| |
|
enum TSD_Key |
class PEGASUS_COMMON_LINKAGE thread_data |
|
{ | { |
|
TSD_ACCEPT_LANGUAGES, |
|
TSD_SLEEP_SEM, |
|
TSD_LAST_ACTIVITY_TIME, |
|
TSD_WORK_FUNC, |
|
TSD_WORK_PARM, |
|
TSD_BLOCKING_SEM, |
|
TSD_CIMOM_HANDLE_CONTENT_LANGUAGES, |
|
TSD_RESERVED_1, |
|
TSD_RESERVED_2, |
|
TSD_RESERVED_3, |
|
TSD_RESERVED_4, |
|
TSD_RESERVED_5, |
|
TSD_RESERVED_6, |
|
TSD_RESERVED_7, |
|
TSD_RESERVED_8, |
|
// Add new TSD keys before this line. |
|
TSD_COUNT |
|
}; |
| |
|
class thread_data |
|
{ |
|
/** |
|
* This class is NOT build thread-safe. |
|
* The Caller(user) of this class has to ensure there is no collision |
|
* taking place. |
|
* |
|
* There is no mechanism in place to protect threads from manipulating |
|
* the same thread-specific storage at one time. |
|
* Make sure the possibility for a parallel access to the same |
|
* threads-specific data from multiple threads cannot arise. |
|
* |
|
* In OpenPegasus this class is used in the ThreadPool |
|
* - on initialisation and creation of threads owned by ThreadPool |
|
* - on threads that are idle inside the ThreadPool |
|
* - on the ThreadPools main thread (the thread which the ThreadPool |
|
* runs in) |
|
* In OpenPegasus this class is used in the |
|
* ClientCIMOMHandleRep and InternalCIMOMHandleRep |
|
* - on the current active Thread which belongs to that CIMOMHandle |
|
* |
|
*/ |
public: | public: |
static void default_delete(void *data); |
|
| |
thread_data( const char *key ) : _delete_func(NULL) , _data(NULL), _size(0) |
static void default_delete(void *data) |
{ | { |
PEGASUS_ASSERT(key != NULL); |
if (data) |
size_t keysize = strlen(key); |
::operator delete(data); |
_key = new char[keysize + 1]; |
} |
memcpy(_key, key, keysize); |
|
_key[keysize] = 0x00; |
|
| |
|
thread_data(TSD_Key key) : _delete_func(0), _data(0), _size(0), _key(key) |
|
{ |
} | } |
| |
thread_data(const char *key, size_t size) : _delete_func(default_delete), _size(size) |
thread_data(TSD_Key key, size_t size) : |
|
_delete_func(default_delete), _size(size), _key(key) |
{ | { |
PEGASUS_ASSERT(key != NULL); |
|
size_t keysize = strlen(key); |
|
_key = new char[keysize + 1]; |
|
memcpy(_key, key, keysize); |
|
_key[keysize] = 0x00; |
|
_data = ::operator new(_size) ; | _data = ::operator new(_size) ; |
|
|
} | } |
| |
thread_data(const char *key, size_t size, void *data) : _delete_func(default_delete), _size(size) |
thread_data(TSD_Key key, size_t size, void* data) |
|
: _delete_func(default_delete), _size(size), _key(key) |
{ | { |
PEGASUS_ASSERT(key != NULL); |
|
PEGASUS_ASSERT(data != NULL); |
|
size_t keysize = strlen(key); |
|
|
|
_key = new char[keysize + 1]; |
|
memcpy(_key, key, keysize); |
|
_key[keysize] = 0x00; |
|
_data = ::operator new(_size); | _data = ::operator new(_size); |
memcpy(_data, data, size); | memcpy(_data, data, size); |
} | } |
| |
~thread_data() | ~thread_data() |
{ | { |
if( _data != NULL) |
if (_data && _delete_func) |
if(_delete_func != NULL) |
(*_delete_func)(_data); |
{ |
|
_delete_func( _data ); |
|
} |
|
if( _key != NULL ) |
|
delete [] _key; |
|
} | } |
| |
/** | /** |
|
|
* You, the developer has to make sure that there are | * You, the developer has to make sure that there are |
* no situations in which this can arise (ie, have a | * no situations in which this can arise (ie, have a |
* lock for the function which manipulates the TSD. | * lock for the function which manipulates the TSD. |
|
* |
|
* @exception NullPointer |
*/ | */ |
void put_data(void (*del)(void *), size_t size, void *data ) throw(NullPointer) |
void put_data(void (*del)(void *), size_t size, void* data) |
{ | { |
if(_data != NULL) |
if (_data && _delete_func) |
if(_delete_func != NULL) |
(*_delete_func)(_data); |
_delete_func(_data); |
|
| |
_delete_func = del; | _delete_func = del; |
_data = data; | _data = data; |
_size = size; | _size = size; |
return ; |
|
} | } |
| |
size_t get_size(void) { return _size; } |
size_t get_size() |
|
{ |
|
return _size; |
|
} |
|
|
|
void* get_data() |
|
{ |
|
return _data; |
|
} |
| |
/** | /** |
* This function is used to retrieve data from the |
This function is used to retrieve data from the |
* TSD, the thread specific data. |
TSD, the thread specific data. |
* |
|
* Be aware that there is NOTHING in place to stop |
Be aware that there is NOTHING in place to stop |
* other users of the thread to change the data you |
other users of the thread to change the data you |
* get from this function. |
get from this function. |
* |
|
* You, the developer has to make sure that there are |
You, the developer has to make sure that there are |
* no situations in which this can arise (ie, have a |
no situations in which this can arise (ie, have a |
* lock for the function which manipulates the TSD. |
lock for the function which manipulates the TSD. |
*/ | */ |
void get_data(void **data, size_t *size) | void get_data(void **data, size_t *size) |
{ | { |
if(data == NULL || size == NULL) |
if (data == 0 || size == 0) |
throw NullPointer(); | throw NullPointer(); |
| |
*data = _data; | *data = _data; |
*size = _size; | *size = _size; |
return; |
|
|
|
} | } |
| |
void copy_data(void **buf, size_t *size) throw(NullPointer) |
// @exception NullPointer |
|
void copy_data(void** buf, size_t* size) |
{ | { |
if((buf == NULL) || (size == NULL)) |
if ((buf == 0) || (size == 0)) |
throw NullPointer() ; | throw NullPointer() ; |
|
|
*buf = ::operator new(_size); | *buf = ::operator new(_size); |
*size = _size; | *size = _size; |
memcpy(*buf, _data, _size); | memcpy(*buf, _data, _size); |
return; |
|
} |
|
|
|
inline Boolean operator==(const void *key) const |
|
{ |
|
if ( ! strcmp(_key, reinterpret_cast<const char *>(key))) |
|
return(true); |
|
return(false); |
|
} | } |
| |
inline Boolean operator==(const thread_data& b) const |
|
{ |
|
return(operator==(b._key)); |
|
} |
|
| |
private: | private: |
void (*_delete_func) (void *data) ; |
|
thread_data(); | thread_data(); |
|
thread_data(const thread_data& x); |
|
thread_data& operator=(const thread_data& x); |
|
|
|
void (*_delete_func)(void*); |
void *_data; | void *_data; |
size_t _size; | size_t _size; |
char *_key; |
TSD_Key _key; |
|
|
friend class DQueue<thread_data>; |
|
friend class Thread; |
|
}; | }; |
| |
| |
|
enum ThreadStatus |
|
{ |
|
PEGASUS_THREAD_OK = 1, /* No problems */ |
|
PEGASUS_THREAD_INSUFFICIENT_RESOURCES, /* Can't allocate a thread. |
|
Not enough memory. Try |
|
again later */ |
|
PEGASUS_THREAD_SETUP_FAILURE, /* Could not allocate into the thread |
|
specific data storage. */ |
|
PEGASUS_THREAD_UNAVAILABLE /* Service is being destroyed and no new |
|
threads can be provided. */ |
|
}; |
|
|
/////////////////////////////////////////////////////////////////////////// | /////////////////////////////////////////////////////////////////////////// |
| |
class PEGASUS_COMMON_LINKAGE Thread |
class PEGASUS_COMMON_LINKAGE Thread : public Linkable |
{ | { |
|
|
public: | public: |
Thread( PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *start )(void *), |
|
void *parameter, Boolean detached ); |
Thread( |
|
ThreadReturnType(PEGASUS_THREAD_CDECL* start) (void*), |
|
void* parameter, |
|
Boolean detached); |
| |
~Thread(); | ~Thread(); |
| |
/** |
/** Start the thread. |
Start the thread. |
@return PEGASUS_THREAD_OK if the thread is started successfully, |
@return true if the thread is started successfully, false if the |
PEGASUS_THREAD_INSUFFICIENT_RESOURCES if the resources necessary |
resources necessary to start the thread are not currently |
to start the thread are not currently available. |
available. ATTN: The result is undefined for any other |
PEGASUS_THREAD_SETUP_FAILURE if the thread could not |
type of failure. (See Bugzilla 972) |
be create properly - check the 'errno' value for specific operating |
|
system return code. |
*/ | */ |
Boolean run(void); |
ThreadStatus run(); |
| |
// get the user parameter | // get the user parameter |
inline void *get_parm(void) { return _thread_parm; } |
void *get_parm() |
|
{ |
|
return _thread_parm; |
|
} |
| |
// cancellation must be deferred (not asynchronous) | // cancellation must be deferred (not asynchronous) |
// for user-level threads the thread itself can decide | // for user-level threads the thread itself can decide |
// when it should die. | // when it should die. |
void cancel(void); |
void cancel(); |
|
|
// cancel if there is a pending cancellation request |
|
void test_cancel(void); |
|
|
|
Boolean is_cancelled(void); |
|
| |
// for user-level threads - put the calling thread | // for user-level threads - put the calling thread |
// to sleep and jump to the thread scheduler. | // to sleep and jump to the thread scheduler. |
|
|
// or gnu portable threads will have an existing | // or gnu portable threads will have an existing |
// routine that can be mapped to this method | // routine that can be mapped to this method |
| |
void thread_switch(void); |
void thread_switch(); |
|
|
#if defined(PEGASUS_PLATFORM_LINUX_GENERIC_GNU) |
|
// suspend this thread |
|
void suspend(void) ; |
|
|
|
// resume this thread |
|
void resume(void) ; |
|
#endif |
|
| |
static void sleep(Uint32 msec) ; | static void sleep(Uint32 msec) ; |
| |
// block the calling thread until this thread terminates | // block the calling thread until this thread terminates |
void join( void ); |
void join(); |
void thread_init(void); |
|
| |
// thread routine needs to call this function when | // thread routine needs to call this function when |
// it is ready to exit | // it is ready to exit |
void exit_self(PEGASUS_THREAD_RETURN return_code) ; |
void exit_self(ThreadReturnType return_code); |
| |
// stack of functions to be called when thread terminates | // stack of functions to be called when thread terminates |
// will be called last in first out (LIFO) | // will be called last in first out (LIFO) |
void cleanup_push( void (*routine) (void *), void *parm ) throw(IPCException); |
void cleanup_push(void (*routine) (void *), void* parm); |
void cleanup_pop(Boolean execute = true) throw(IPCException); |
|
| |
// create and initialize a tsd |
void cleanup_pop(Boolean execute = true); |
inline void create_tsd(const char *key, int size, void *buffer) throw(IPCException) |
|
{ |
|
AutoPtr<thread_data> tsd(new thread_data(key, size, buffer)); |
|
_tsd.insert_first(tsd.get()); |
|
tsd.release(); |
|
} |
|
| |
// get the buffer associated with the key | // get the buffer associated with the key |
// NOTE: this call leaves the tsd LOCKED !!!! | // NOTE: this call leaves the tsd LOCKED !!!! |
inline void *reference_tsd(const char *key) throw(IPCException) |
void* reference_tsd(TSD_Key key) |
{ | { |
_tsd.lock(); |
if (_tsd[key]) |
thread_data *tsd = _tsd.reference(key); |
return _tsd[key]->get_data(); |
if(tsd != NULL) |
|
return( (void *)(tsd->_data) ); |
|
else | else |
return(NULL); |
return 0; |
} | } |
| |
inline void *try_reference_tsd(const char *key) throw(IPCException) |
|
{ |
|
_tsd.try_lock(); |
|
thread_data *tsd = _tsd.reference(key); |
|
if(tsd != NULL) |
|
return((void *)(tsd->_data) ); |
|
else |
|
return(NULL); |
|
} |
|
|
|
|
|
// release the lock held on the tsd | // release the lock held on the tsd |
// NOTE: assumes a corresponding and prior call to reference_tsd() !!! | // NOTE: assumes a corresponding and prior call to reference_tsd() !!! |
inline void dereference_tsd(void) throw(IPCException) |
void dereference_tsd() |
{ | { |
_tsd.unlock(); |
|
} | } |
| |
// delete the tsd associated with the key | // delete the tsd associated with the key |
inline void delete_tsd(const char *key) throw(IPCException) |
void delete_tsd(TSD_Key key) |
{ | { |
AutoPtr<thread_data> tsd(_tsd.remove(key)); |
thread_data* tsd; |
} |
|
| |
// Note: Caller must delete the thread_data object returned (if not null) |
tsd = _tsd[key]; |
inline void *remove_tsd(const char *key) throw(IPCException) |
_tsd[key] = 0; |
{ |
|
return(_tsd.remove((const void *)key)); |
|
} |
|
| |
inline void empty_tsd(void) throw(IPCException) |
if (tsd) |
{ |
delete tsd; |
try |
|
{ |
|
_tsd.try_lock(); |
|
} | } |
catch(IPCException&) |
|
|
void empty_tsd() |
{ | { |
return; |
thread_data* data[TSD_COUNT]; |
} |
|
|
memcpy(data, _tsd, sizeof(_tsd)); |
|
memset(_tsd, 0, sizeof(_tsd)); |
| |
AutoPtr<thread_data> tsd(_tsd.next(0)); |
for (size_t i = 0; i < TSD_COUNT; i++) |
while(tsd.get()) |
|
{ | { |
_tsd.remove_no_lock(tsd.get()); |
if (data[i]) |
tsd.reset(_tsd.next(0)); |
delete data[i]; |
} | } |
_tsd.unlock(); |
|
} | } |
| |
// create or re-initialize tsd associated with the key | // create or re-initialize tsd associated with the key |
// if the tsd already exists, delete the existing buffer | // if the tsd already exists, delete the existing buffer |
void put_tsd(const char *key, void (*delete_func)(void *), Uint32 size, void *value) |
void put_tsd( |
throw(IPCException) |
TSD_Key key, |
|
void (*delete_func)(void*), |
|
Uint32 size, |
|
void* value) |
{ | { |
PEGASUS_ASSERT(key != NULL); |
thread_data* tsd = new thread_data(key); |
AutoPtr<thread_data> tsd ; |
tsd->put_data(delete_func, size, value); |
tsd.reset(_tsd.remove((const void *)key)); // may throw an IPC exception |
|
tsd.reset(); |
thread_data* old; |
AutoPtr<thread_data> ntsd(new thread_data(key)); |
|
ntsd->put_data(delete_func, size, value); |
old = _tsd[key]; |
try { _tsd.insert_first(ntsd.get()); } |
_tsd[key] = tsd; |
catch(IPCException& e) { e = e; throw; } |
|
ntsd.release(); |
if (old) |
|
delete old; |
} | } |
inline PEGASUS_THREAD_RETURN get_exit(void) { return _exit_code; } |
|
inline PEGASUS_THREAD_TYPE self(void) {return pegasus_thread_self(); } |
|
| |
PEGASUS_THREAD_HANDLE getThreadHandle() {return _handle;} |
ThreadReturnType get_exit() |
|
{ |
|
return _exit_code; |
|
} |
| |
inline Boolean operator==(const void *key) const |
ThreadType self() |
{ | { |
if ( (void *)this == key) |
return Threads::self(); |
return(true); |
|
return(false); |
|
} | } |
inline Boolean operator==(const Thread & b) const |
|
|
ThreadHandle getThreadHandle() |
{ | { |
return(operator==((const void *)&b )); |
return _handle; |
} | } |
| |
void detach(void); |
void detach(); |
| |
// | // |
// Gets the Thread object associated with the caller's thread. | // Gets the Thread object associated with the caller's thread. |
// Note: this may return NULL if no Thread object is associated | // Note: this may return NULL if no Thread object is associated |
// with the caller's thread. | // with the caller's thread. |
// | // |
static Thread * getCurrent(); // l10n |
static Thread *getCurrent(); |
| |
// | // |
// Sets the Thread object associated with the caller's thread. | // Sets the Thread object associated with the caller's thread. |
// Note: the Thread object must be placed on the heap. | // Note: the Thread object must be placed on the heap. |
// | // |
static void setCurrent(Thread * thrd); // l10n |
static void setCurrent(Thread* thrd); |
| |
// | // |
// Gets the AcceptLanguages object associated with the caller's |
// Gets the AcceptLanguageList object associated with the caller's |
// Thread. | // Thread. |
// Note: this may return NULL if no Thread object, or no | // Note: this may return NULL if no Thread object, or no |
// AcceptLanguages object, is associated with the caller's thread. |
// AcceptLanguageList object, is associated with the caller's thread. |
// | // |
static AcceptLanguages * getLanguages(); //l10n |
static AcceptLanguageList* getLanguages(); |
| |
// | // |
// Sets the AcceptLanguages object associated with the caller's |
// Sets the AcceptLanguageList object associated with the caller's |
// Thread. | // Thread. |
// Note: a Thread object must have been previously associated with | // Note: a Thread object must have been previously associated with |
// the caller's thread. | // the caller's thread. |
// Note: the AcceptLanguages object must be placed on the heap. |
|
// | // |
static void setLanguages(AcceptLanguages *langs); //l10n |
static void setLanguages(const AcceptLanguageList& langs); |
| |
// | // |
// Removes the AcceptLanguages object associated with the caller's |
// Removes the AcceptLanguageList object associated with the caller's |
// Thread. | // Thread. |
// | // |
static void clearLanguages(); //l10n |
static void clearLanguages(); |
| |
private: | private: |
Thread(); | Thread(); |
| |
static Sint8 initializeKey(); // l10n |
static Sint8 initializeKey(); |
| |
inline void create_tsd(const char *key ) throw(IPCException) |
ThreadHandle _handle; |
{ |
|
AutoPtr<thread_data> tsd(new thread_data(key)); |
|
_tsd.insert_first(tsd.get()); |
|
tsd.release(); |
|
} |
|
PEGASUS_THREAD_HANDLE _handle; |
|
Boolean _is_detached; | Boolean _is_detached; |
Boolean _cancel_enabled; |
|
Boolean _cancelled; | Boolean _cancelled; |
| |
PEGASUS_SEM_HANDLE _suspend_count; |
|
|
|
// always pass this * as the void * parameter to the thread | // always pass this * as the void * parameter to the thread |
// store the user parameter in _thread_parm | // store the user parameter in _thread_parm |
| |
PEGASUS_THREAD_RETURN ( PEGASUS_THREAD_CDECL *_start)(void *) ; |
ThreadReturnType(PEGASUS_THREAD_CDECL* _start) (void *); |
DQueue<class cleanup_handler> _cleanup; |
List<cleanup_handler, Mutex> _cleanup; |
DQueue<class thread_data> _tsd; |
thread_data* _tsd[TSD_COUNT]; |
| |
void *_thread_parm; | void *_thread_parm; |
PEGASUS_THREAD_RETURN _exit_code; |
ThreadReturnType _exit_code; |
static Boolean _signals_blocked; | static Boolean _signals_blocked; |
static PEGASUS_THREAD_KEY_TYPE _platform_thread_key; //l10n |
static TSDKeyType _platform_thread_key; |
static Boolean _key_initialized; // l10n |
static Boolean _key_initialized; |
static Boolean _key_error; // l10n |
static Boolean _key_error; |
}; | }; |
| |
|
|
class PEGASUS_COMMON_LINKAGE ThreadPool |
|
{ |
|
public: |
|
|
|
/** |
|
Constructs a new ThreadPool object. |
|
@param initialSize The number of threads that are initially added to |
|
the thread pool. |
|
@param key A name for this thread pool that can be used to determine |
|
equality of two thread pool objects. Only the first 16 characters |
|
of this value are used. |
|
@param minThreads The minimum number of threads that should be |
|
contained in this thread pool at any given time. |
|
@param maxThreads The maximum number of threads that should be |
|
contained in this thread pool at any given time. |
|
@param deallocateWait The minimum time that a thread should be idle |
|
before it is removed from the pool and cleaned up. |
|
*/ |
|
ThreadPool( |
|
Sint16 initialSize, |
|
const char* key, |
|
Sint16 minThreads, |
|
Sint16 maxThreads, |
|
struct timeval& deallocateWait); |
|
|
|
/** |
|
Destructs the ThreadPool object. |
|
*/ |
|
~ThreadPool(); |
|
|
|
/** |
|
Allocate and start a thread to do a unit of work. |
|
@param parm A generic parameter to pass to the thread |
|
@param work A pointer to the function that is to be executed by |
|
the thread |
|
@param blocking A pointer to an optional semaphore which, if |
|
specified, is signaled after the thread finishes |
|
executing the work function |
|
@return true if the thread is started successfully, false if the |
|
resources necessary to start the thread are not currently |
|
available. ATTN: The result is undefined for any other |
|
type of thread creation failure. |
|
@exception IPCException |
|
*/ |
|
Boolean allocate_and_awaken( |
|
void* parm, |
|
PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL* work)(void *), |
|
Semaphore* blocking = 0); |
|
|
|
/** |
|
Cleans up idle threads if they have been running longer than the |
|
deallocate_wait configuration and more than the configured |
|
minimum number of threads is running. |
|
@return The number of threads that were cleaned up. |
|
@exception IPCException |
|
*/ |
|
Uint32 cleanupIdleThreads(); |
|
|
|
void get_key(Sint8* buf, int bufsize); |
|
|
|
inline Boolean operator==(const char* key) const |
|
{ |
|
return (!strncmp(key, _key, 16)); |
|
} |
|
|
|
Boolean operator==(const void* p) |
|
{ |
|
return ((void *)this == p); |
|
} |
|
|
|
inline Boolean operator==(const ThreadPool & b) const |
|
{ |
|
return (operator==(b._key)); |
|
} |
|
|
|
Boolean operator==(const ThreadPool & p) |
|
{ |
|
return operator==((const void *)&p); |
|
} |
|
|
|
inline void setMinThreads(Sint16 min) |
|
{ |
|
_minThreads = min; |
|
} |
|
|
|
inline Sint16 getMinThreads() const |
|
{ |
|
return _minThreads; |
|
} |
|
|
|
inline void setMaxThreads(Sint16 max) |
|
{ |
|
_maxThreads = max; |
|
} |
|
|
|
inline Sint16 getMaxThreads() const |
|
{ |
|
return _maxThreads; |
|
} |
|
|
|
inline Uint32 runningCount() |
|
{ |
|
return _runningThreads.count(); |
|
} |
|
|
|
inline Uint32 idleCount() |
|
{ |
|
return _idleThreads.count(); |
|
} |
|
|
|
private: |
|
|
|
ThreadPool(); // Unimplemented |
|
ThreadPool(const ThreadPool&); // Unimplemented |
|
ThreadPool& operator=(const ThreadPool&); // Unimplemented |
|
|
|
static PEGASUS_THREAD_RETURN PEGASUS_THREAD_CDECL _loop(void *); |
|
|
|
static Boolean _timeIntervalExpired( |
|
struct timeval* start, |
|
struct timeval* interval); |
|
|
|
static void _deleteSemaphore(void* p); |
|
|
|
void _cleanupThread(Thread* thread); |
|
Thread* _initializeThread(); |
|
void _addToIdleThreadsQueue(Thread* th); |
|
|
|
Sint16 _maxThreads; |
|
Sint16 _minThreads; |
|
AtomicInt _currentThreads; |
|
struct timeval _deallocateWait; |
|
char _key[17]; |
|
DQueue<Thread> _idleThreads; |
|
DQueue<Thread> _runningThreads; |
|
AtomicInt _dying; |
|
}; |
|
|
|
|
|
#if defined(PEGASUS_OS_TYPE_WINDOWS) |
|
# include "ThreadWindows_inline.h" |
|
#elif defined(PEGASUS_PLATFORM_ZOS_ZSERIES_IBM) |
|
# include "ThreadzOS_inline.h" |
|
#elif defined(PEGASUS_OS_TYPE_UNIX) |
|
# include "ThreadUnix_inline.h" |
|
#elif defined(PEGASUS_OS_VMS) |
|
# include "ThreadVms_inline.h" |
|
#endif |
|
|
|
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |
| |
#endif // Pegasus_Thread_h | #endif // Pegasus_Thread_h |