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.13 and 1.64

version 1.1.2.13, 2001/10/03 16:55:03

version 1.64, 2008/11/12 22:46:15

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 20

Line 29

//==============================================================================

// Author: Mike Day (mdday@us.ibm.com)

// Modified By: Markus Mueller

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

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

#include <Pegasus/Common/Threads.h>

#if defined(PEGASUS_HAVE_PTHREADS)

# include <signal.h>

#endif

PEGASUS_NAMESPACE_BEGIN

class PEGASUS_EXPORT cleanup_handler

class PEGASUS_COMMON_LINKAGE cleanup_handler : public Linkable

{

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)

private:

void execute(void) { _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

~cleanup_handler()

{

{;

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

}

void *_arg;

PEGASUS_CLEANUP_HANDLE _cleanup_buffer;

friend class DQueue<class cleanup_handler>;

friend class Thread;

};

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

class PEGASUS_EXPORT 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;

void execute()

Boolean _is_detached;

{

Boolean _cancel_enabled;

_routine(_arg);

Boolean _cancelled;

}

//PEGASUS_SEM_HANDLE _suspend_count;

Semaphore _suspend;

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

cleanup_handler();

// store the user parameter in _thread_parm

PEGASUS_THREAD_RETURN ( PEGASUS_THREAD_CDECL *_start)(void *) ;

void (*_routine)(void*);

void *_arg;

void *_thread_parm;

friend class Thread;

} ;

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

enum TSD_Key

class PEGASUS_EXPORT 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:

static void default_delete(void *data);

thread_data( Sint8 *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 Sint8 [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(Sint8 *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 Sint8 [keysize + 1];

memcpy(_key, key, keysize);

_key[keysize] = 0x00;

_data = ::operator new(_size) ;

}

thread_data(Sint8 *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 Sint8[keysize + 1];

memcpy(_key, key, keysize);

_key[keysize] = 0x00;

_data = ::operator new(_size);

memcpy(_data, data, size);

}

~thread_data()

{

if( _data != NULL)

if (_data && _delete_func)

if(_delete_func != NULL)

(*_delete_func)(_data);

_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.

if(_data != NULL)

if(_delete_func != NULL)

* Be aware that there is NOTHING in place to stop

_delete_func(_data);

* 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 && _delete_func)

(*_delete_func)(_data);

_delete_func = del;

_data = data;

_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

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)

if (data == 0 || size == 0)

throw NullPointer();

*data = _data;

*size = _size;

return;

}

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

if ((buf == 0) || (size == 0))

throw NullPointer() ;

*buf = ::operator new(_size);

*size = _size;

memcpy(*buf, _data, _size);

return;

}

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

{

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

return(true);

return(false);

}

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

{

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

}

private:

void (*_delete_func) (void *data) ;

thread_data();

thread_data(const thread_data& x);

thread_data& operator=(const thread_data& x);

void (*_delete_func)(void*);

void *_data;

size_t _size;

Sint8 *_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_EXPORT Thread

class PEGASUS_COMMON_LINKAGE Thread : public Linkable

{

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

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

void *get_parm()

{

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

return _thread_parm;

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

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

// to sleep and jump to the thread scheduler.

Line 284

Line 288

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

static void sleep(Uint32 msec);

// suspend this thread

void suspend(void) ;

// resume this thread

void resume(void) ;

#endif

void sleep(Uint32 msec) ;

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

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

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(Sint8 *key, int size, void *buffer) throw(IPCException)

{

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

try { _tsd.insert_first(tsd); }

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

}

// get the buffer associated with the key

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

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

void* reference_tsd(TSD_Key key)

{

_tsd.lock();

if (_tsd[key])

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

return _tsd[key]->get_data();

if(tsd != NULL)

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

else

return(NULL);

return 0;

}

// release the lock held on the 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

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

void delete_tsd(TSD_Key key)

{

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

thread_data* tsd;

if(tsd != NULL)

tsd = _tsd[key];

_tsd[key] = 0;

if (tsd)

delete tsd;

}

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

void empty_tsd()

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

{

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

thread_data* data[TSD_COUNT];

throw(IPCException)

memcpy(data, _tsd, sizeof(_tsd));

memset(_tsd, 0, sizeof(_tsd));

for (size_t i = 0; i < TSD_COUNT; i++)

{

PEGASUS_ASSERT(key != NULL);

if (data[i])

PEGASUS_ASSERT(delete_func != NULL);

delete data[i];

thread_data *tsd ;

}

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

thread_data *ntsd = new thread_data(key);

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

try { _tsd.insert_first(ntsd); }

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

return(tsd);

}

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

private:

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

Thread();

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

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

void put_tsd(

TSD_Key key,

void (*delete_func)(void*),

Uint32 size,

void* value)

{

thread_data *tsd = new thread_data(key);

try { _tsd.insert_first(tsd); }

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

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

thread_data* old;

old = _tsd[key];

_tsd[key] = tsd;

if (old)

delete old;

}

PEGASUS_THREAD_HANDLE _handle;

Boolean _is_detached;

Boolean _cancel_enabled;

Boolean _cancelled;

PEGASUS_SEM_HANDLE _suspend_count;

ThreadReturnType get_exit()

{

return _exit_code;

}

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

ThreadType self()

// store the user parameter in _thread_parm

{

return Threads::self();

}

PEGASUS_THREAD_RETURN ( PEGASUS_THREAD_CDECL *_start)(void *) ;

ThreadHandle getThreadHandle()

DQueue<class cleanup_handler> _cleanup;

{

DQueue<class thread_data> _tsd;

return _handle;

}

void *_thread_parm;

void detach();

PEGASUS_THREAD_RETURN _exit_code;

static Boolean _signals_blocked;

} ;

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

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

// with the caller's thread.

static Thread *getCurrent();

#if 0

class PEGASUS_EXPORT Aggregator {

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

public:

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

Aggregator();

~Aggregator();

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

// Thread.

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

// the caller's thread.

static void setLanguages(const AcceptLanguageList& langs);

void started(void);

void completed(void);

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

void remaining(int operations);

// Thread.

void put_result(CIMReference *ref);

static void clearLanguages();

private:

int _reference_count;

Thread();

// keep track of the thread running this operation so we can kill

static Sint8 initializeKey();

// it if necessary

Thread _owner;

ThreadHandle _handle;

Boolean _is_detached;

// this is a phased aggregate. when it is complete is will

Boolean _cancelled;

// be streamed to the client regardless of the state of

// siblings

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

Boolean _is_phased;

// store the user parameter in _thread_parm

int _total_values;

ThreadReturnType(PEGASUS_THREAD_CDECL* _start) (void *);

int _completed_values;

List<cleanup_handler, Mutex> _cleanup;

int _total_child_values;

thread_data* _tsd[TSD_COUNT];

int _completed_child_values;

int _completion_state;

void* _thread_parm;

struct timeval _last_update;

ThreadReturnType _exit_code;

time_t lifetime;

static Boolean _signals_blocked;

Aggregator *_parent;

static TSDKeyType _platform_thread_key;

// children may be phased or not phased

static Boolean _key_initialized;

DQueue _children;

static Boolean _key_error;

// empty results that are filled by provider

DQueue _results;

// array of predicates for events and

// stored queries (cursors)

Array _filter;

} ;

#endif

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.1.2.13
changed lines
	Added in v.1.64

No CVS admin address has been configured