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

Return to Thread.cpp CVS log

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

Diff for /pegasus/src/Pegasus/Common/Thread.cpp between version 1.1.2.11 and 1.100.2.6

version 1.1.2.11, 2001/10/30 22:42:14

version 1.100.2.6, 2008/10/23 18:59:32

Line 1

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

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

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

#include "Thread.h"

#include <Pegasus/Common/IPC.h>

#include <errno.h>

#include <exception>

#include <Pegasus/Common/Tracer.h>

#include "Time.h"

#if defined(PEGASUS_OS_TYPE_WINDOWS)

PEGASUS_USING_STD;

# include "ThreadWindows.cpp"

#elif defined(PEGASUS_OS_TYPE_UNIX)

# include "ThreadUnix.cpp"

#else

# error "Unsupported platform"

#endif

PEGASUS_NAMESPACE_BEGIN

void thread_data::default_delete(void * data)

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

// POSIX Threads Implementation:

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

#if defined(PEGASUS_HAVE_PTHREADS)

struct StartWrapperArg

{

if( data != NULL)

void *(PEGASUS_THREAD_CDECL * start) (void *);

::operator delete(data);

void *arg;

};

extern "C" void *_start_wrapper(void *arg_)

{

// Clean up dynamic memory now to prevent a leak if the thread is canceled.

StartWrapperArg arg;

arg.start = ((StartWrapperArg *) arg_)->start;

arg.arg = ((StartWrapperArg *) arg_)->arg;

delete (StartWrapperArg *) arg_;

// establish cancelability of the thread

pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);

pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL);

void *return_value = (*arg.start) (arg.arg);

return return_value;

}

Boolean Thread::_signals_blocked = false;

void Thread::cancel()

{

_cancelled = true;

pthread_cancel(_handle.thid.thread);

}

// for non-native implementations

void Thread::test_cancel()

#ifndef PEGASUS_THREAD_CLEANUP_NATIVE

void Thread::cleanup_push( void (*routine)(void *), void *parm) throw(IPCException)

{

cleanup_handler *cu = new cleanup_handler(routine, parm);

#if defined(PEGASUS_PLATFORM_ZOS_ZSERIES_IBM)

try

pthread_testintr();

#else

pthread_testcancel();

#endif

}

Boolean Thread::is_cancelled()

{

_cleanup.insert_first(cu);

return _cancelled;

}

catch(IPCException& e)

void Thread::thread_switch()

{

delete cu;

#if defined(PEGASUS_PLATFORM_ZOS_ZSERIES_IBM)

throw;

pthread_yield(NULL);

#else

sched_yield();

#endif

}

return;

ATTN: why are these missing on other platforms?

#if defined(PEGASUS_PLATFORM_LINUX_GENERIC_GNU)

void Thread::suspend()

{

pthread_kill(_handle.thid.thread, SIGSTOP);

}

void Thread::cleanup_pop(Boolean execute) throw(IPCException)

void Thread::resume()

{

cleanup_handler *cu ;

pthread_kill(_handle.thid.thread, SIGCONT);

try

}

#endif

void Thread::sleep(Uint32 msec)

{

cu = _cleanup.remove_first() ;

Threads::sleep(msec);

}

catch(IPCException& e)

void Thread::join()

{

PEGASUS_ASSERT(0);

if (!_is_detached && !Threads::null(_handle.thid))

pthread_join(_handle.thid.thread, &_exit_code);

Threads::clear(_handle.thid);

}

if(execute == true)

cu->execute();

void Thread::thread_init()

delete cu;

{

#if defined(PEGASUS_PLATFORM_ZOS_ZSERIES_IBM)

pthread_setintr(PTHREAD_INTR_ENABLE);

pthread_setintrtype(PTHREAD_INTR_ASYNCHRONOUS);

#else

pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);

pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL);

#endif

_cancel_enabled = true;

}

void Thread::detach()

{

_is_detached = true;

#if defined(PEGASUS_PLATFORM_ZOS_ZSERIES_IBM)

pthread_t thread_id=_handle.thid.thread;

pthread_detach(&thread_id);

#else

pthread_detach(_handle.thid.thread);

#endif

}

ThreadStatus Thread::run()

{

StartWrapperArg *arg = new StartWrapperArg;

arg->start = _start;

arg->arg = this;

Threads::Type type =

_is_detached ? Threads::THREADS_DETACHED : Threads::THREADS_JOINABLE;

int rc = Threads::create(_handle.thid, type, _start_wrapper, arg);

// On Linux distributions released prior 2005, the implementation of

// Native POSIX Thread Library returns ENOMEM instead of EAGAIN when

// there

// are no insufficient memory. Hence we are checking for both. See bug

// 386.

if (rc == -1)

rc = errno;

if ((rc == EAGAIN) || (rc == ENOMEM))

{

Threads::clear(_handle.thid);

delete arg;

return PEGASUS_THREAD_INSUFFICIENT_RESOURCES;

}

else if (rc != 0)

{

Threads::clear(_handle.thid);

delete arg;

return PEGASUS_THREAD_SETUP_FAILURE;

}

return PEGASUS_THREAD_OK;

}

static sigset_t *block_signal_mask(sigset_t * sig)

{

sigemptyset(sig);

// should not be used for main()

sigaddset(sig, SIGHUP);

sigaddset(sig, SIGINT);

// maybe useless, since KILL can't be blocked according to POSIX

sigaddset(sig, SIGKILL);

sigaddset(sig, SIGABRT);

sigaddset(sig, SIGALRM);

sigaddset(sig, SIGPIPE);

// Note: older versions of the linux pthreads library use SIGUSR1 and SIGUSR2

// internally to stop and start threads that are blocking, the newer ones

// implement this through the kernel's real time signals

// since SIGSTOP/CONT can handle suspend()/resume() on Linux

// block them

// #if defined(PEGASUS_PLATFORM_LINUX_IX86_GNU)

// sigaddset(sig, SIGUSR1);

// sigaddset(sig, SIGUSR2);

// #endif

#if defined (PEGASUS_PLATFORM_ZOS_ZSERIES_IBM) || defined (PEGASUS_OS_VMS)

sigprocmask(SIG_BLOCK, sig, NULL);

#else

pthread_sigmask(SIG_BLOCK, sig, NULL);

#endif

return sig;

}

//thread_data *Thread::put_tsd(Sint8 *key, void (*delete_func)(void *), Uint32 size, void *value) throw(IPCException)

ATTN: remove this!

#if 1

static Uint32 _num_threads = 0;

static Mutex _num_threads_mutex;

#endif

Thread::Thread(

ThreadReturnType(PEGASUS_THREAD_CDECL* start) (void*),

void* parameter,

Boolean detached)

: _is_detached(detached),

_cancel_enabled(true),

_cancelled(false),

_start(start),

_cleanup(),

_tsd(),

_thread_parm(parameter),

_exit_code(0)

{

ATTN: remove this!

#if 1

Uint32 num_threads;

_num_threads_mutex.lock();

_num_threads++;

num_threads = _num_threads;

printf("Thread::Thread(): num_threads=%u\n", num_threads);

_num_threads_mutex.unlock();

#endif

#ifndef PEGASUS_THREAD_EXIT_NATIVE

Threads::clear(_handle.thid);

void Thread::exit_self(PEGASUS_THREAD_RETURN exit_code)

}

{

// execute the cleanup stack and then return

Thread::~Thread()

while( _cleanup.count() )

{

ATTN: remove this!

#if 1

Uint32 num_threads;

_num_threads_mutex.lock();

_num_threads--;

num_threads = _num_threads;

printf("Thread::~Thread(): num_threads=%u\n", num_threads);

_num_threads_mutex.unlock();

#endif

try

{

cleanup_pop(true);

join();

empty_tsd();

}

catch(IPCException& e)

catch (...)

{

PEGASUS_ASSERT(0);

// Do not allow the destructor to throw an exception

break;

}

_exit_code = exit_code;

exit_thread(exit_code);

}

#endif /* PEGASUS_HAVE_PTHREADS */

#endif

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

// Windows Threads Implementation:

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

#if defined(PEGASUS_HAVE_WINDOWS_THREADS)

ThreadPool::ThreadPool(Sint16 initial_size,

ThreadStatus Thread::run()

Sint16 max,

Sint16 min,

Sint8 *key)

: _max_threads(max), _min_threads(min),

_current_threads(0), _waiters(initial_size),

_pool_sem(0), _pool(true), _running(true),

_dying(0)

{

_allocate_wait.tv_sec = 1;

// Note: A Win32 thread ID is not the same thing as a pthread ID.

_allocate_wait.tv_usec = 0;

// Win32 threads have both a thread ID and a handle. The handle

_deallocate_wait.tv_sec = 30;

// is used in the wait functions, etc.

_deallocate_wait.tv_usec = 0;

// So _handle.thid is actually the thread handle.

_deadlock_detect.tv_sec = 60;

_deadlock_detect.tv_usec = 0;

unsigned threadid = 0;

memset(_key, 0x00, 17);

if(key != 0)

strncpy(_key, key, 16);

if(_max_threads < initial_size)

_max_threads = initial_size;

if(_min_threads > initial_size)

_min_threads = initial_size;

int i;

ThreadType tt;

for(i = 0; i < initial_size; i++)

tt.handle = (HANDLE) _beginthreadex(NULL, 0, _start, this, 0, &threadid);

_handle.thid = tt;

if (Threads::null(_handle.thid))

{

if (errno == EAGAIN)

{

_link_pool(_init_thread());

return PEGASUS_THREAD_INSUFFICIENT_RESOURCES;

}

else

{

return PEGASUS_THREAD_SETUP_FAILURE;

}

return PEGASUS_THREAD_OK;

}

void Thread::cancel()

{

_cancelled = true;

}

ThreadPool::~ThreadPool(void)

void Thread::test_cancel()

{

_dying++;

if (_cancel_enabled && _cancelled)

Thread *th = _pool.remove_first();

while(th != 0)

{

// signal the thread's sleep semaphore

exit_self(0);

th->cancel();

th->join();

th->empty_tsd();

delete th;

th = _pool.remove_first();

}

// make this static to the class

Boolean Thread::is_cancelled()

PEGASUS_THREAD_RETURN PEGASUS_THREAD_CDECL ThreadPool::_loop(void *parm)

{

Thread *myself = (Thread *)parm;

return _cancelled;

if(myself == 0)

}

throw NullPointer();

ThreadPool *pool = (ThreadPool *)myself->get_parm();

if(pool == 0 )

throw NullPointer();

Semaphore *sleep_sem;

struct timeval *deadlock_timer;

try

void Thread::thread_switch()

{

sleep_sem = (Semaphore *)myself->reference_tsd("sleep sem");

Sleep(0);

myself->dereference_tsd();

deadlock_timer = (struct timeval *)myself->reference_tsd("deadlock timer");

myself->dereference_tsd();

}

catch(IPCException & e)

void Thread::sleep(Uint32 milliseconds)

{

myself->exit_self(0);

Sleep(milliseconds);

}

if(sleep_sem == 0 || deadlock_timer == 0)

throw NullPointer();

while(pool->_dying < 1)

void Thread::join()

{

myself->test_cancel();

if (!Threads::null(_handle.thid))

sleep_sem->wait();

{

// when we awaken we reside on the running queue, not the pool queue

if (!_is_detached)

myself->test_cancel();

{

gettimeofday(deadlock_timer, NULL);

if (!_cancelled)

{

// Emulate the unix join api. Caller sleeps until thread is

// done.

WaitForSingleObject(_handle.thid.handle, INFINITE);

}

else

{

// Currently this is the only way to ensure this code does

// not

// hang forever.

if (WaitForSingleObject(_handle.thid.handle, 10000) ==

WAIT_TIMEOUT)

{

TerminateThread(_handle.thid.handle, 0);

}

PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *_work)(void *);

DWORD exit_code = 0;

void *parm;

GetExitCodeThread(_handle.thid.handle, &exit_code);

_exit_code = (ThreadReturnType) exit_code;

}

try

CloseHandle(_handle.thid.handle);

Threads::clear(_handle.thid);

}

void Thread::thread_init()

{

_work = (PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *)(void *)) \

_cancel_enabled = true;

myself->reference_tsd("work func");

myself->dereference_tsd();

parm = myself->reference_tsd("work parm");

myself->dereference_tsd();

}

catch(IPCException & e)

void Thread::detach()

{

myself->exit_self(0);

_is_detached = true;

}

if(_work == 0)

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

throw NullPointer();

void *parameter,

_work(parm);

Boolean detached):_is_detached(detached),

_cancel_enabled(true),

_cancelled(false),

_start(start), _cleanup(), _tsd(), _thread_parm(parameter), _exit_code(0)

{

Threads::clear(_handle.thid);

}

// put myself back onto the available list

Thread::~Thread()

{

try

{

pool->_running.remove((void *)myself);

join();

pool->_link_pool(myself);

empty_tsd();

}

catch(IPCException & e)

catch (...)

{

myself->exit_self(0);

}

myself->exit_self(0);

return((PEGASUS_THREAD_RETURN)0);

}

#endif /* PEGASUS_HAVE_WINDOWS_THREADS */

void ThreadPool::allocate_and_awaken(void *parm,

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

PEGASUS_THREAD_RETURN \

(PEGASUS_THREAD_CDECL *work)(void *))

// Common implementation:

throw(IPCException)

{

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

struct timeval start;

gettimeofday(&start, NULL);

Thread *th = _pool.remove_first();

while (th == 0 && _dying < 1)

void thread_data::default_delete(void *data)

{

try // we couldn't get a free thread from the pool

{

// wait for the right interval and try again

while(th == 0 && _dying < 1)

{

_check_deadlock(&start);

if (data != NULL)

Uint32 interval = _allocate_wait.tv_sec * 1000;

::operator delete(data);

if(_allocate_wait.tv_usec > 0)

interval += (_deallocate_wait.tv_usec / 1000);

// will throw a timeout if no thread comes free

_pool_sem.time_wait(interval);

th = _pool.remove_first();

}

catch(TimeOut & to)

void language_delete(void *data)

{

if(_current_threads < _max_threads)

if (data != NULL)

{

th = _init_thread();

AutoPtr < AcceptLanguageList > al(static_cast <

break;

AcceptLanguageList * >(data));

}

// will throw a Deadlock Exception before falling out of the loop

_check_deadlock(&start);

} // while th == null

if(_dying < 1)

{

// initialize the thread data with the work function and parameters

th->remove_tsd("work func");

th->put_tsd("work func", NULL,

sizeof( PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *)(void *)),

(void *)work);

th->remove_tsd("work parm");

th->put_tsd("work parm", NULL, sizeof(void *), parm);

// put the thread on the running list

_running.insert_first(th);

// signal the thread's sleep semaphore to awaken it

Semaphore *sleep_sem = (Semaphore *)th->reference_tsd("sleep sem");

if(sleep_sem == 0)

throw NullPointer();

sleep_sem->signal();

}

else

_pool.insert_first(th);

}

// caller is responsible for only calling this routine during slack periods

Boolean Thread::_signals_blocked = false;

// but should call it at least once per _deadlock_detect with the running q

#ifndef PEGASUS_OS_ZOS

// and at least once per _deallocate_wait for the pool q

TSDKeyType Thread::_platform_thread_key = TSDKeyType(-1);

#else

TSDKeyType Thread::_platform_thread_key;

#endif

Boolean Thread::_key_initialized = false;

Boolean Thread::_key_error = false;

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

void Thread::cleanup_push(void (*routine) (void *), void *parm)

throw(IPCException)

{

struct timeval now;

AutoPtr < cleanup_handler > cu(new cleanup_handler(routine, parm));

gettimeofday(&now, NULL);

_cleanup.insert_front(cu.get());

cu.release();

DQueue<Thread> dead(true) ;

return;

}

if(q->count() > 0 )

void Thread::cleanup_pop(Boolean execute)

{

AutoPtr < cleanup_handler > cu;

try

{

q->try_lock();

cu.reset(_cleanup.remove_front());

}

catch(AlreadyLocked & a)

catch (IPCException &)

{

return;

PEGASUS_ASSERT(0);

}

if (execute == true)

cu->execute();

}

Thread *context = 0;

struct timeval dt = { 0, 0 };

void Thread::exit_self(ThreadReturnType exit_code)

struct timeval *dtp;

{

Thread *th = q->next(context);

#if !defined(PEGASUS_PLATFORM_AIX_RS_IBMCXX) \

while (th != 0 )

&& !defined(PEGASUS_PLATFORM_PASE_ISERIES_IBMCXX)

Threads::exit(exit_code);

#else

// execute the cleanup stack and then return

while (_cleanup.size())

{

try

{

dtp = (struct timeval *)th->try_reference_tsd("deadlock timer");

cleanup_pop(true);

}

catch(AlreadyLocked & a)

catch (IPCException &)

{

context = th;

PEGASUS_ASSERT(0);

th = q->next(context);

break;

continue;

}

_exit_code = exit_code;

Threads::exit(exit_code);

Threads::clear(_handle.thid);

#endif

}

if(dtp != 0)

Sint8 Thread::initializeKey()

{

memcpy(&dt, dtp, sizeof(struct timeval));

PEG_METHOD_ENTER(TRC_THREAD, "Thread::initializeKey");

if (!Thread::_key_initialized)

}

th->dereference_tsd();

if( true == check(&dt))

{

th = q->remove_no_lock((void *)th);

if (Thread::_key_error)

{

PEG_TRACE_CSTRING(TRC_THREAD, Tracer::LEVEL4,

"Thread: ERROR - thread key error");

return -1;

}

if(th != 0)

if (TSDKey::create(&Thread::_platform_thread_key) == 0)

{

dead.insert_first(th);

PEG_TRACE_CSTRING(TRC_THREAD, Tracer::LEVEL4,

th = 0;

"Thread: able to create a thread key");

Thread::_key_initialized = true;

}

else

{

PEG_TRACE_CSTRING(TRC_THREAD, Tracer::LEVEL4,

"Thread: ERROR - unable to create a thread key");

Thread::_key_error = true;

return -1;

}

context = th;

th = q->next(context);

}

q->unlock();

PEG_METHOD_EXIT();

return 0;

}

if(dead.count())

Thread *Thread::getCurrent()

{

Thread *th = dead.remove_first();

PEG_METHOD_ENTER(TRC_THREAD, "Thread::getCurrent");

while(th != 0)

if (Thread::initializeKey() != 0)

{

th->cancel();

return NULL;

th->join();

delete th;

th = dead.remove_first();

}

PEG_METHOD_EXIT();

return;

return (Thread *) TSDKey::get_thread_specific(_platform_thread_key);

}

Boolean ThreadPool::_check_time(struct timeval *start, struct timeval *interval)

void Thread::setCurrent(Thread * thrd)

{

struct timeval now;

PEG_METHOD_ENTER(TRC_THREAD, "Thread::setCurrent");

gettimeofday(&now, NULL);

if (Thread::initializeKey() == 0)

if( (now.tv_sec - start->tv_sec) > interval->tv_sec ||

{

(((now.tv_sec - start->tv_sec) == interval->tv_sec) &&

if (TSDKey::

((now.tv_usec - start->tv_usec) >= interval->tv_usec ) ) )

set_thread_specific(Thread::_platform_thread_key,

return true;

(void *) thrd) == 0)

else

return false;

}

void ThreadPool::_sleep_sem_del(void *p)

{

if(p != 0)

PEG_TRACE_CSTRING(TRC_THREAD, Tracer::LEVEL4,

"Successful set Thread * into thread specific storage");

}

else

{

delete (Semaphore *)p;

PEG_TRACE_CSTRING(TRC_THREAD, Tracer::LEVEL4,

"ERROR: error setting Thread * into thread specific storage");

}

PEG_METHOD_EXIT();

}

inline void ThreadPool::_check_deadlock(struct timeval *start) throw(Deadlock)

AcceptLanguageList *Thread::getLanguages()

{

if (true == _check_time(start, &_deadlock_detect))

PEG_METHOD_ENTER(TRC_THREAD, "Thread::getLanguages");

throw Deadlock(pegasus_thread_self());

return;

Thread *curThrd = Thread::getCurrent();

if (curThrd == NULL)

return NULL;

AcceptLanguageList *acceptLangs =

(AcceptLanguageList *) curThrd->reference_tsd("acceptLanguages");

curThrd->dereference_tsd();

PEG_METHOD_EXIT();

return acceptLangs;

}

void Thread::setLanguages(AcceptLanguageList * langs)

{

PEG_METHOD_ENTER(TRC_THREAD, "Thread::setLanguages");

inline Boolean ThreadPool::_check_deadlock_no_throw(struct timeval *start)

Thread *currentThrd = Thread::getCurrent();

if (currentThrd != NULL)

{

return(_check_time(start, &_deadlock_detect));

// deletes the old tsd and creates a new one

currentThrd->put_tsd("acceptLanguages",

language_delete,

sizeof (AcceptLanguageList *), langs);

}

inline Boolean ThreadPool::_check_dealloc(struct timeval *start)

PEG_METHOD_EXIT();

{

return(_check_time(start, &_deallocate_wait));

}

inline Thread *ThreadPool::_init_thread(void) throw(IPCException)

void Thread::clearLanguages()

{

Thread *th = (Thread *) new Thread(&_loop, this, false);

PEG_METHOD_ENTER(TRC_THREAD, "Thread::clearLanguages");

// allocate a sleep semaphore and pass it in the thread context

// initial count is zero, loop function will sleep until

// we signal the semaphore

Semaphore *sleep_sem = (Semaphore *) new Semaphore(0);

th->put_tsd("sleep sem", &_sleep_sem_del, sizeof(Semaphore), (void *)sleep_sem);

struct timeval *dldt = (struct timeval *) ::operator new(sizeof(struct timeval));

th->put_tsd("deadlock timer", thread_data::default_delete, sizeof(struct timeval), (void *)dldt);

// thread will enter _loop(void *) and sleep on sleep_sem until we signal it

th->run();

_current_threads++;

return th;

}

inline void ThreadPool::_link_pool(Thread *th) throw(IPCException)

Thread *currentThrd = Thread::getCurrent();

if (currentThrd != NULL)

{

if(th == 0)

// deletes the old tsd

throw NullPointer();

currentThrd->delete_tsd("acceptLanguages");

_pool.insert_first(th);

_pool_sem.signal();

}

PEG_METHOD_EXIT();

}

PEGASUS_NAMESPACE_END

// ATTN: not sure where to put this!

#ifdef PEGASUS_ZOS_SECURITY

bool isEnhancedSecurity = 99;

#endif

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.1.2.11
changed lines
	Added in v.1.100.2.6

No CVS admin address has been configured