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

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

version 1.40, 2004/07/28 20:42:34

Line 1

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

//%2003////////////////////////////////////////////////////////////////////////

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

// IBM Corp.; EMC 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 26

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

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

#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/IPC.h>

#include <Pegasus/Common/InternalException.h>

#include <Pegasus/Common/DQueue.h>

#include <Pegasus/Common/AcceptLanguages.h> // l10n

#include <Pegasus/Common/Linkage.h>

#include <Pegasus/Common/AutoPtr.h>

PEGASUS_NAMESPACE_BEGIN

class PEGASUS_EXPORT cleanup_handler

class PEGASUS_COMMON_LINKAGE cleanup_handler

{

public:

cleanup_handler( void (*routine)(void *), void *arg ) : _routine(routine), _arg(arg) {}

~cleanup_handler() {; }

private:

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

cleanup_handler();

void (*_routine)(void *);

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

{

if(key == (void *)_routine)

Line 57

Line 61

{

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

}

private:

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

cleanup_handler();

void (*_routine)(void *);

void *_arg;

PEGASUS_CLEANUP_HANDLE _cleanup_buffer;

friend class DQueue<class cleanup_handler>;

Line 65

Line 74

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

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;

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_EXPORT thread_data

class PEGASUS_COMMON_LINKAGE thread_data

{

public:

static void default_delete(void *data);

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

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

{

PEGASUS_ASSERT(key != NULL);

size_t keysize = strlen(key);

Line 159

Line 91

}

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

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

{

PEGASUS_ASSERT(key != NULL);

size_t keysize = strlen(key);

Line 170

Line 102

}

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

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

{

PEGASUS_ASSERT(key != NULL);

PEGASUS_ASSERT(data != NULL);

Line 187

Line 119

{

if( _data != NULL)

if(_delete_func != NULL)

{

_delete_func( _data );

}

if( _key != NULL )

delete [] _key;

}

/**

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

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

{

if(_data != NULL)

Line 206

Line 151

size_t get_size(void) { 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 174

}

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

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

{

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

throw NullPointer() ;

Line 233

Line 190

return(true);

return(false);

}

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

{

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

Line 244

Line 202

void *_data;

size_t _size;

Sint8 *_key;

friend class DQueue<thread_data>;

friend class Thread;

};

Line 251

Line 210

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

class PEGASUS_EXPORT Thread

class PEGASUS_COMMON_LINKAGE ThreadPool;

class PEGASUS_COMMON_LINKAGE Thread

{

public:

Line 260

Line 221

~Thread();

void run(void);

/**

Start the thread.

@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 failure. (See Bugzilla 972)

Boolean run(void);

// get the user parameter

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

Line 276

Line 244

// cancel if there is a pending cancellation request

void test_cancel(void);

Boolean is_cancelled(void);

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

// to sleep and jump to the thread scheduler.

// platforms with preemptive scheduling and native threads

Line 286

Line 256

void thread_switch(void);

#ifdef PEGASUS_PLATFORM_LINUX_IX86_GNU

#if defined(PEGASUS_PLATFORM_LINUX_GENERIC_GNU)

// suspend this thread

void suspend(void) ;

Line 294

Line 264

void resume(void) ;

#endif

void sleep(Uint32 msec) ;

static void sleep(Uint32 msec) ;

// block the calling thread until this thread terminates

void join( void );

Line 310

Line 280

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

// create and initialize a tsd

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

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

{

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

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

{

_tsd.lock();

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

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

if(tsd != NULL)

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

else

return(NULL);

}

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

{

_tsd.try_lock();

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

if(tsd != NULL)

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

else

return(NULL);

}

// release the lock held on the tsd

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

inline void dereference_tsd(void) throw(IPCException)

Line 337

Line 318

}

// delete the tsd associated with the key

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

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

{

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

AutoPtr<thread_data> tsd(_tsd.remove((const void *)key));

if(tsd != NULL)

}

delete tsd;

// Note: Caller must delete the thread_data object returned (if not null)

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

{

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

}

inline void empty_tsd(void) throw(IPCException)

{

try

{

_tsd.try_lock();

}

catch(IPCException&)

{

return;

}

AutoPtr<thread_data> tsd(_tsd.next(0));

while(tsd.get())

{

_tsd.remove_no_lock(tsd.get());

tsd.reset(_tsd.next(0));

}

_tsd.unlock();

}

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

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

throw(IPCException)

{

PEGASUS_ASSERT(key != NULL);

PEGASUS_ASSERT(delete_func != NULL);

AutoPtr<thread_data> tsd ;

thread_data *tsd ;

tsd.reset(_tsd.remove((const void *)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_first(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 PEGASUS_THREAD_TYPE self(void) {return pegasus_thread_self(); }

PEGASUS_THREAD_HANDLE getThreadHandle() {return _handle;}

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

{

if ( (void *)this == key)

return(true);

return(false);

}

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

{

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

}

void detach(void);

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

// 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 AcceptLanguages object associated with the caller's

// Thread.

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

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

static AcceptLanguages * getLanguages(); //l10n

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

// Thread.

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

// the caller's thread.

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

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

// Removes the AcceptLanguages 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

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

{

thread_data *tsd = new thread_data(key);

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

try { _tsd.insert_first(tsd); }

_tsd.insert_first(tsd.get());

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

tsd.release();

}

PEGASUS_THREAD_HANDLE _handle;

Boolean _is_detached;

Line 390

Line 449

void *_thread_parm;

PEGASUS_THREAD_RETURN _exit_code;

static Boolean _signals_blocked;

static PEGASUS_THREAD_KEY_TYPE _platform_thread_key; //l10n

static Boolean _key_initialized; // l10n

static Boolean _key_error; // l10n

friend class ThreadPool;

} ;

#if 0

class PEGASUS_COMMON_LINKAGE ThreadPool

class PEGASUS_EXPORT Aggregator {

{

public:

Aggregator();

ThreadPool(Sint16 initial_size,

~Aggregator();

const Sint8 *key,

Sint16 min,

Sint16 max,

struct timeval & alloc_wait,

struct timeval & dealloc_wait,

struct timeval & deadlock_detect);

~ThreadPool(void);

/**

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.

Boolean allocate_and_awaken(void *parm,

PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *work)(void *),

Semaphore *blocking = 0)

throw(IPCException);

void started(void);

void completed(void);

void remaining(int operations);

void put_result(CIMReference *ref);

private:

Uint32 kill_dead_threads( void )

int _reference_count;

throw(IPCException);

void get_key(Sint8 *buf, int bufsize);

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

{

if ( ! strncmp( reinterpret_cast<Sint8 *>(const_cast<void *>(key)), _key, 16 ))

return(true);

return(false);

}

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

{

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

}

inline void set_min_threads(Sint16 min)

{

_min_threads = min;

}

inline Sint16 get_min_threads(void) const

{

return _min_threads;

}

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

inline void set_max_threads(Sint16 max)

// it if necessary

{

Thread _owner;

_max_threads = max;

}

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

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

inline Sint16 get_max_threads(void) const

// siblings

{

Boolean _is_phased;

return _max_threads;

}

int _total_values;

int _completed_values;

inline void set_allocate_wait(const struct timeval & alloc_wait)

int _total_child_values;

{

int _completed_child_values;

_allocate_wait.tv_sec = alloc_wait.tv_sec;

int _completion_state;

_allocate_wait.tv_usec = alloc_wait.tv_usec;

struct timeval _last_update;

}

time_t lifetime;

Aggregator *_parent;

inline struct timeval *get_allocate_wait(struct timeval *buffer) const

// children may be phased or not phased

{

DQueue _children;

if(buffer == 0)

// empty results that are filled by provider

throw NullPointer();

DQueue _results;

buffer->tv_sec = _allocate_wait.tv_sec;

// array of predicates for events and

buffer->tv_usec = _allocate_wait.tv_usec;

// stored queries (cursors)

return buffer;

Array _filter;

}

inline void set_deallocate_wait(const struct timeval & dealloc_wait)

{

_deallocate_wait.tv_sec = dealloc_wait.tv_sec;

_deallocate_wait.tv_usec = dealloc_wait.tv_usec;

}

inline struct timeval *get_deallocate_wait(struct timeval *buffer) const

{

if(buffer == 0)

throw NullPointer();

buffer->tv_sec = _deallocate_wait.tv_sec;

buffer->tv_usec = _deallocate_wait.tv_usec;

return buffer;

}

inline void set_deadlock_detect(const struct timeval & deadlock)

{

_deadlock_detect.tv_sec = deadlock.tv_sec;

_deadlock_detect.tv_usec = deadlock.tv_usec;

}

inline struct timeval * get_deadlock_detect(struct timeval *buffer) const

{

if(buffer == 0)

throw NullPointer();

buffer->tv_sec = _deadlock_detect.tv_sec;

buffer->tv_usec = _deadlock_detect.tv_usec;

return buffer;

}

inline Uint32 running_count(void)

{

return _running.count();

}

inline Uint32 pool_count(void)

{

return _pool.count();

}

inline Uint32 dead_count(void)

{

return _dead.count();

}

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

Boolean operator ==(const ThreadPool & p)

{

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

}

Boolean operator ==(const void *p)

{

if((void *)this == p)

return true;

return false;

}

static void kill_idle_threads(void);

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

Sint8 _key[17];

DQueue<Thread> _pool;

DQueue<Thread> _running;

DQueue<Thread> _dead;

AtomicInt _dying;

static void _sleep_sem_del(void *p);

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

Boolean _check_deadlock_no_throw(struct timeval *start);

Boolean _check_dealloc(struct timeval *start);

Thread *_init_thread(void) throw(IPCException);

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

static PEGASUS_THREAD_RETURN _undertaker(void *);

static PEGASUS_THREAD_RETURN _graveyard(Thread *);

static DQueue<ThreadPool> _pools;

} ;

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

#endif

PEGASUS_NAMESPACE_END

Legend:

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

No CVS admin address has been configured