pegasus/src/Pegasus/Common/Thread.h - diff

Return to Thread.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/Thread.h between version 1.1.2.15 and 1.57.2.1

version 1.1.2.15, 2001/10/25 15:41:01

version 1.57.2.1, 2006/07/27 23:11:52

Line 1

//%///////////-*-c++-*-//////////////////////////////////////////////////////

//%2006////////////////////////////////////////////////////////////////////////

// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.

// IBM Corp.; EMC Corporation, The Open Group.

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; Symantec Corporation; The Open Group.

// Permission is hereby granted, free of charge, to any person obtaining a copy

// of this software and associated documentation files (the "Software"), to

Line 23

Line 32

// 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)

// Josephine Eskaline Joyce, IBM (jojustin@in.ibm.com) for Bug#2393

//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_Thread_h

#define Pegasus_Thread_h

#include <Pegasus/Common/IPC.h>

#include <cstring>

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Exception.h>

#include <Pegasus/Common/AtomicInt.h>

#include <Pegasus/Common/DQueue.h>

#include <Pegasus/Common/InternalException.h>

#include <Pegasus/Common/AcceptLanguageList.h>

#include <Pegasus/Common/Linkage.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>

PEGASUS_NAMESPACE_BEGIN

class PEGASUS_COMMON_LINKAGE cleanup_handler

class PEGASUS_COMMON_LINKAGE cleanup_handler : public Linkable

{

public:

Line 44

Line 66

~cleanup_handler() {; }

private:

void execute(void) { _routine(_arg); }

void execute() { _routine(_arg); }

cleanup_handler();

void (*_routine)(void *);

inline Boolean operator==(const void *key) const

{

if(key == (void *)_routine)

return true;

return false;

}

inline Boolean operator ==(const cleanup_handler & b) const

{

return(operator==((const void *)b._routine));

}

void *_arg;

PEGASUS_CLEANUP_HANDLE _cleanup_buffer;

ThreadCleanupType _cleanup_buffer;

friend class DQueue<class cleanup_handler>;

friend class Thread;

};

///////////////////////////////////////////////////////////////////////////////

class PEGASUS_COMMON_LINKAGE SimpleThread

{

public:

SimpleThread( PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *start )(void *),

void *parameter, Boolean detached );

~SimpleThread();

void run(void);

Uint32 threadId(void);

// get the user parameter

void *get_parm(void);

// cancellation must be deferred (not asynchronous)

// for user-level threads the thread itself can decide

// when it should die.

void cancel(void);

void kill(int signum);

// cancel if there is a pending cancellation request

void test_cancel(void);

// for user-level threads - put the calling thread

// to sleep and jump to the thread scheduler.

// platforms with preemptive scheduling and native threads

// can define this to be a no-op.

// platforms without preemptive scheduling like NetWare

// or gnu portable threads will have an existing

// routine that can be mapped to this method

void thread_switch(void);

// suspend this thread

void suspend(void) ;

// resume this thread

void resume(void) ;

void sleep(Uint32 msec) ;

// block the calling thread until this thread terminates

void join( PEGASUS_THREAD_RETURN *ret_val);

// stack of functions to be called when thread terminates

// will be called last in first out (LIFO)

void cleanup_push( void (*routine) (void *), void *parm );

void cleanup_pop(Boolean execute) ;

PEGASUS_THREAD_TYPE self(void) ;

private:

SimpleThread();

PEGASUS_THREAD_HANDLE _handle;

Boolean _is_detached;

Boolean _cancel_enabled;

Boolean _cancelled;

//PEGASUS_SEM_HANDLE _suspend_count;

Semaphore _suspend;

// always pass this * as the void * parameter to the thread

// store the user parameter in _thread_parm

PEGASUS_THREAD_RETURN ( PEGASUS_THREAD_CDECL *_start)(void *) ;

void *_thread_parm;

} ;

///////////////////////////////////////////////////////////////////////////////

class PEGASUS_COMMON_LINKAGE thread_data

class PEGASUS_COMMON_LINKAGE thread_data : public Linkable

{

public:

static void default_delete(void *data);

thread_data( Sint8 *key ) : _delete_func(NULL) , _data(NULL), _size(0)

thread_data( const char *key ) : _delete_func(NULL) , _data(NULL), _size(0)

{

PEGASUS_ASSERT(key != NULL);

size_t keysize = strlen(key);

_key = new Sint8 [keysize + 1];

_key.reset(new char[keysize + 1]);

memcpy(_key, key, keysize);

memcpy(_key.get(), key, keysize);

_key[keysize] = 0x00;

_key.get()[keysize] = 0x00;

}

thread_data(Sint8 *key, size_t size) : _delete_func(default_delete), _size(size)

thread_data(const char *key, size_t size) : _delete_func(default_delete), _size(size)

{

PEGASUS_ASSERT(key != NULL);

size_t keysize = strlen(key);

_key = new Sint8 [keysize + 1];

_key.reset(new char[keysize + 1]);

memcpy(_key, key, keysize);

memcpy(_key.get(), key, keysize);

_key[keysize] = 0x00;

_key.get()[keysize] = 0x00;

_data = ::operator new(_size) ;

}

thread_data(Sint8 *key, size_t size, void *data) : _delete_func(default_delete), _size(size)

thread_data(const char *key, size_t size, void *data) : _delete_func(default_delete), _size(size)

{

PEGASUS_ASSERT(key != NULL);

PEGASUS_ASSERT(data != NULL);

size_t keysize = strlen(key);

_key = new Sint8[keysize + 1];

_key.reset(new char[keysize + 1]);

memcpy(_key, key, keysize);

memcpy(_key.get(), key, keysize);

_key[keysize] = 0x00;

_key.get()[keysize] = 0x00;

_data = ::operator new(_size);

memcpy(_data, data, size);

}

Line 187

Line 122

{

if( _data != NULL)

if(_delete_func != NULL)

{

_delete_func( _data );

if( _key != NULL )

}

delete [] _key;

}

void put_data(void (*del)(void *), size_t size, void *data ) throw(NullPointer)

/**

* This function is used to put data in thread space.

* Be aware that there is NOTHING in place to stop

* other users of the thread to remove this data.

* Or change the data.

* You, the developer has to make sure that there are

* no situations in which this can arise (ie, have a

* lock for the function which manipulates the TSD.

* @exception NullPointer

void put_data(void (*del)(void *), size_t size, void *data )

{

if(_data != NULL)

if(_delete_func != NULL)

Line 204

Line 152

return ;

}

size_t get_size(void) { return _size; }

size_t get_size() { return _size; }

/**

* This function is used to retrieve data from the

* TSD, the thread specific data.

* Be aware that there is NOTHING in place to stop

* other users of the thread to change the data you

* get from this function.

* You, the developer has to make sure that there are

* no situations in which this can arise (ie, have a

* lock for the function which manipulates the TSD.

void get_data(void **data, size_t *size)

{

if(data == NULL || size == NULL)

Line 217

Line 177

}

void copy_data(void **buf, size_t *size) throw(BufferTooSmall, NullPointer)

// @exception NullPointer

void copy_data(void **buf, size_t *size)

{

if((buf == NULL) || (size == NULL))

throw NullPointer() ;

Line 229

Line 190

inline Boolean operator==(const void *key) const

{

if ( ! strcmp(_key, (Sint8 *)key))

if ( ! strcmp(_key.get(), reinterpret_cast<const char *>(key)))

return(true);

return(false);

}

inline Boolean operator==(const thread_data& b) const

{

return(operator==((const void *)b._key));

return(operator==(b._key.get()));

}

static bool equal(const thread_data* node, const void* key)

{

return ((thread_data*)node)->operator==(key);

}

private:

Line 243

Line 210

thread_data();

void *_data;

size_t _size;

Sint8 *_key;

AutoArrayPtr<char> _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 ThreadPool;

///////////////////////////////////////////////////////////////////////////

class PEGASUS_COMMON_LINKAGE Thread

class PEGASUS_COMMON_LINKAGE Thread : public Linkable

{

public:

Thread( PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *start )(void *),

Thread( ThreadReturnType (PEGASUS_THREAD_CDECL *start )(void *),

void *parameter, Boolean detached );

~Thread();

void run(void);

/**

Start the thread.

@return PEGASUS_THREAD_OK if the thread is started successfully,

PEGASUS_THREAD_INSUFFICIENT_RESOURCES if the resources necessary

to start the thread are not currently available.

PEGASUS_THREAD_SETUP_FAILURE if the thread could not

be create properly - check the 'errno' value for specific operating

system return code.

ThreadStatus run();

// get the user parameter

inline void *get_parm(void) { return _thread_parm; }

inline void *get_parm() { return _thread_parm; }

// send the thread a signal -- may not be appropriate due to Windows

// void kill(int signum);

// cancellation must be deferred (not asynchronous)

// for user-level threads the thread itself can decide

// when it should die.

void cancel(void);

void cancel();

// cancel if there is a pending cancellation request

void test_cancel(void);

void test_cancel();

Boolean is_cancelled();

// for user-level threads - put the calling thread

// to sleep and jump to the thread scheduler.

Line 287

Line 269

// or gnu portable threads will have an existing

// routine that can be mapped to this method

void thread_switch(void);

void thread_switch();

#ifdef PEGASUS_PLATFORM_LINUX_IX86_GNU

#if defined(PEGASUS_PLATFORM_LINUX_GENERIC_GNU)

// suspend this thread

void suspend(void) ;

void suspend();

// resume this thread

void resume(void) ;

void resume();

#endif

void sleep(Uint32 msec) ;

static void sleep(Uint32 msec);

// block the calling thread until this thread terminates

void join( void );

void join();

void thread_init(void);

void thread_init();

// thread routine needs to call this function when

// 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

// will be called last in first out (LIFO)

void cleanup_push( void (*routine) (void *), void *parm ) throw(IPCException);

// @exception IPCException

void cleanup_pop(Boolean execute = true) throw(IPCException);

void cleanup_push(void (*routine) (void *), void *parm);

// @exception IPCException

void cleanup_pop(Boolean execute = true);

// create and initialize a tsd

inline void create_tsd(Sint8 *key, int size, void *buffer) throw(IPCException)

// @exception IPCException

inline void create_tsd(const char *key, int size, void *buffer)

{

thread_data *tsd = new thread_data(key, size, buffer);

AutoPtr<thread_data> tsd(new thread_data(key, size, buffer));

try { _tsd.insert_first(tsd); }

_tsd.insert_front(tsd.get());

catch(IPCException& e) { e = e; delete tsd; throw; }

tsd.release();

}

// get the buffer associated with the key

// NOTE: this call leaves the tsd LOCKED !!!!

inline void *reference_tsd(Sint8 *key) throw(IPCException)

// @exception IPCException

inline void *reference_tsd(const char *key)

{

_tsd.lock();

thread_data *tsd = _tsd.reference((void *)key);

thread_data *tsd = _tsd.find(thread_data::equal, key);

if(tsd != NULL)

return( (void *)(tsd->_data) );

else

return(NULL);

}

inline void *try_reference_tsd(Sint8 *key) throw(IPCException)

// @exception IPCException

inline void *try_reference_tsd(const char *key)

{

_tsd.try_lock();

thread_data *tsd = _tsd.reference((void *)key);

thread_data *tsd = _tsd.find(thread_data::equal, key);

if(tsd != NULL)

return((void *)(tsd->_data) );

else

Line 345

Line 333

// release the lock held on the tsd

// NOTE: assumes a corresponding and prior call to reference_tsd() !!!

inline void dereference_tsd(void) throw(IPCException)

// @exception IPCException

inline void dereference_tsd()

{

_tsd.unlock();

}

// delete the tsd associated with the key

inline void delete_tsd(Sint8 *key) throw(IPCException)

// @exception IPCException

{

inline void delete_tsd(const char *key)

thread_data *tsd = _tsd.remove((void *)key);

if(tsd != NULL)

delete tsd;

}

inline void *remove_tsd(Sint8 *key) throw(IPCException)

{

return(_tsd.remove((void *)key));

AutoPtr<thread_data> tsd(_tsd.remove(thread_data::equal, key));

}

inline void empty_tsd(void) throw(IPCException)

// @exception IPCException

inline void empty_tsd()

{

_tsd.empty_list();

_tsd.clear();

}

// create or re-initialize tsd associated with the key

// if the tsd already exists, return the existing buffer

// if the tsd already exists, delete the existing buffer

thread_data *put_tsd(Sint8 *key, void (*delete_func)(void *), Uint32 size, void *value)

// @exception IPCException

throw(IPCException)

void put_tsd(const char *key, void (*delete_func)(void *), Uint32 size, void *value)

{

PEGASUS_ASSERT(key != NULL);

PEGASUS_ASSERT(delete_func != NULL);

AutoPtr<thread_data> tsd;

thread_data *tsd ;

tsd.reset(_tsd.remove(thread_data::equal, key)); // may throw an IPC exception

tsd = _tsd.remove((void *)key); // may throw an IPC exception

tsd.reset();

thread_data *ntsd = new thread_data(key);

AutoPtr<thread_data> ntsd(new thread_data(key));

ntsd->put_data(delete_func, size, value);

try { _tsd.insert_first(ntsd); }

try { _tsd.insert_front(ntsd.get()); }

catch(IPCException& e) { e = e; delete ntsd; throw; }

catch(IPCException& e) { e = e; throw; }

return(tsd);

ntsd.release();

}

inline PEGASUS_THREAD_RETURN get_exit(void) { return _exit_code; }

inline ThreadReturnType get_exit() { return _exit_code; }

inline PEGASUS_THREAD_TYPE self(void) {return pegasus_thread_self(); }

inline ThreadType self() {return Threads::self(); }

PEGASUS_THREAD_HANDLE getThreadHandle() {return _handle;}

ThreadHandle getThreadHandle() {return _handle;}

inline Boolean operator==(const void *key) const

void detach();

{

if ( (void *)this == key)

return(true);

// Gets the Thread object associated with the caller's thread.

return(false);

// Note: this may return NULL if no Thread object is associated

}

// with the caller's thread.

inline Boolean operator==(const Thread & b) const

{

static Thread * getCurrent(); // l10n

return(operator==((const void *)&b ));

}

// Sets the Thread object associated with the caller's thread.

// Note: the Thread object must be placed on the heap.

static void setCurrent(Thread * thrd); // l10n

// Gets the AcceptLanguageList object associated with the caller's

// Thread.

// Note: this may return NULL if no Thread object, or no

// AcceptLanguageList object, is associated with the caller's thread.

static AcceptLanguageList * getLanguages(); //l10n

// Sets the AcceptLanguageList object associated with the caller's

// Thread.

// Note: a Thread object must have been previously associated with

// the caller's thread.

// Note: the AcceptLanguageList object must be placed on the heap.

static void setLanguages(AcceptLanguageList *langs); //l10n

// Removes the AcceptLanguageList object associated with the caller's

// Thread.

static void clearLanguages(); //l10n

private:

Thread();

inline void create_tsd(Sint8 *key ) throw(IPCException)

static Sint8 initializeKey(); // l10n

// @exception IPCException

inline void create_tsd(const char *key )

{

thread_data *tsd = new thread_data(key);

AutoPtr<thread_data> tsd(new thread_data(key));

try { _tsd.insert_first(tsd); }

_tsd.insert_front(tsd.get());

catch(IPCException& e) { e = e; delete tsd; throw; }

tsd.release();

}

PEGASUS_THREAD_HANDLE _handle;

ThreadHandle _handle;

Boolean _is_detached;

Boolean _cancel_enabled;

Boolean _cancelled;

PEGASUS_SEM_HANDLE _suspend_count;

// always pass this * as the void * parameter to the thread

// 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;

List<thread_data, Mutex> _tsd;

void *_thread_parm;

PEGASUS_THREAD_RETURN _exit_code;

ThreadReturnType _exit_code;

static Boolean _signals_blocked;

friend class ThreadPool;

static TSDKeyType _platform_thread_key; //l10n

static Boolean _key_initialized; // l10n

static Boolean _key_error; // l10n

} ;

Line 433

Line 447

{

public:

ThreadPool(Sint16 initial_size,

/**

Sint16 max,

Constructs a new ThreadPool object.

Sint16 min,

@param initialSize The number of threads that are initially added to

Sint8 *key);

the thread pool.

@param key A name for this thread pool that can be used to determine

~ThreadPool(void);

equality of two thread pool objects. Only the first 16 characters

void allocate_and_awaken(void *parm,

of this value are used.

PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *work)(void *))

@param minThreads The minimum number of threads that should be

throw(IPCException);

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 PEGASUS_THREAD_OK if the thread is started successfully,

PEGASUS_THREAD_INSUFFICIENT_RESOURCES if the

resources necessary to start the thread are not currently

available. PEGASUS_THREAD_SETUP_FAILURE if the thread

could not be setup properly. PEGASUS_THREAD_UNAVAILABLE

if this service is shutting down and no more threads can

be allocated.

@exception IPCException

ThreadStatus allocate_and_awaken(

void* parm,

ThreadReturnType (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);

// accessors for min, max, wait

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.size();

}

inline Uint32 idleCount()

{

return _idleThreads.size();

}

private:

ThreadPool(void);

Sint16 _max_threads;

Sint16 _min_threads;

AtomicInt _current_threads;

struct timeval _allocate_wait;

struct timeval _deallocate_wait;

struct timeval _deadlock_detect;

static PEGASUS_THREAD_RETURN PEGASUS_THREAD_CDECL _loop(void *);

Semaphore _waiters;

Sint8 _key[17];

Semaphore _pool_sem;

DQueue<Thread>_pool;

DQueue<Thread>_running;

AtomicInt _dying;

void _kill_dead_threads(DQueue<Thread> *q, Boolean (*check)(struct timeval *))

ThreadPool(); // Unimplemented

throw(IPCException);

ThreadPool(const ThreadPool&); // Unimplemented

static void _sleep_sem_del(void *p);

ThreadPool& operator=(const ThreadPool&); // Unimplemented

static Boolean _check_time(struct timeval *start, struct timeval *interval);

void _check_deadlock(struct timeval *start) throw(Deadlock);

static ThreadReturnType PEGASUS_THREAD_CDECL _loop(void *);

Boolean _check_deadlock_no_throw(struct timeval *start);

Boolean _check_dealloc(struct timeval *start);

static Boolean _timeIntervalExpired(

Thread *_init_thread(void) throw(IPCException);

struct timeval* start,

void _link_pool(Thread *th) throw(IPCException);

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];

List<Thread, Mutex> _idleThreads;

List<Thread, Mutex> _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

#endif // Pegasus_Thread_h

Legend:

Removed from v.1.1.2.15
changed lines
	Added in v.1.57.2.1

No CVS admin address has been configured