source: branches/libc-0.6/src/emx/include/InnoTekLIBC/thread.h@ 3055

/* $Id: thread.h 2254 2005-07-17 12:25:44Z bird $ */
/** @file
 *
 * LIBC Thread Handling.
 *
 * Copyright (c) 2004 knut st. osmundsen <[email protected]>
 *
 *
 * This file is part of InnoTek LIBC.
 *
 * InnoTek LIBC is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * InnoTek LIBC is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with InnoTek LIBC; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef __InnoTekLIBC_thread_h__
#define __InnoTekLIBC_thread_h__

/*******************************************************************************
*   Defined Constants And Macros                                               *
*******************************************************************************/
/** Maximum number of TLS variables supported by LIBC.
 * The current limit (128) is higher than for instance WinNT. But if
 * you think we're wasting space, look at the page padding of the thread
 * structure... */
#define __LIBC_TLS_MAX      128


/*******************************************************************************
*   Header Files                                                               *
*******************************************************************************/
#include <sys/cdefs.h>
#include <time.h>                       /* struct tm; */
#include <signal.h>


/*******************************************************************************
*   Structures and Typedefs                                                    *
*******************************************************************************/
struct _uheap;

/**
 * sigwait,sigwaitinfo, sigtimedwait data.
 */
typedef volatile struct __libc_thread_sigwait
{
    /** Done waitin' indicator.*/
    volatile int    fDone;
    /** The signals we're waiting for. */
    sigset_t        SigSetWait;
    /** The where to return signal info. */
    siginfo_t       SigInfo;
} __LIBC_THREAD_SIGWAIT, *__LIBC_PTHREAD_SIGWAIT;


/**
 * sigsuspend data.
 */
typedef volatile struct __libc_thread_sigsuspend
{
    /** Done waitin' indicator.*/
    volatile int    fDone;
} __LIBC_THREAD_SIGSUSPEND, *__LIBC_PTHREAD_SIGSUSPEND;


/**
 * Signal notification callback function.
 *
 * This is a notification which can be used to correct the state of
 * a system object before any user code is executed.
 *
 * The semaphore lock is hold and signals are all on hold, so be very careful with waitin
 * on other semphores and stuff like that. Crashing is totally forbidden. :-)
 *
 * @param   iSignalNo       The signal number.
 * @param   pvUser          The user argument.
 */
typedef void __LIBC_FNSIGCALLBACK(int iSignalNo, void *pvUser);
/** Pointer to a signal callback function. */
typedef __LIBC_FNSIGCALLBACK *__LIBC_PFNSIGCALLBACK;


/**
 * Per thread structure for LIBC.
 *
 * This structure contains buffers and variables which in a single threaded
 * LIBC would be static.
 *
 * Members most frequently used have been put together at the front.
 */
typedef struct __libc_thread
{
    /** errno value. (Comes first, see errnofun.s.) */
    int             iErrNo;
    /** Default tiled heap. */
    struct _uheap * pTiledHeap;
    /** Default regular heap. */
    struct _uheap * pRegularHeap;
    /** Reference count. */
    volatile unsigned cRefs;
    /** Thread Id. */
    unsigned        tid;
    /** Pointer to next thread in the list. */
    struct __libc_thread   *pNext;
    /** New TLS variable array. */
    void           *apvTLS[__LIBC_TLS_MAX];
    /** Old TLS variable. */
    void           *pvThreadStoreVar;

    /** The nesting depth of the default logger. */
    unsigned        cDefLoggerDepth;
    /** Buffer used by asctime() and indirectly by ctime() . (Adds two 2 bytes for padding). */
    char            szAscTimeAndCTimeBuf[26+2];
    /** Buffer used by gmtime() and localtime(). */
    struct tm       GmTimeAndLocalTimeBuf;
    /** Buffer used by tmpnam(). */
    char            szTmpNamBuf[16];
    /** Current posistion of strtok(). */
    char           *pszStrTokPos;
    /** Buffer used by strerror() to format unknown error values. */
    char            szStrErrorBuf[28];
    /** Buffer used by _getvol(). */
    char            szVolLabelBuf[12];
    /** Buffer used by ttyname(). */
    char            szTTYNameBuf[32];

    /** Pending signals.
     * Protected by the signal semaphore. */
    sigset_t        SigSetPending;
    /** Blocked signals.
     * Protected by the signal semaphore. */
    sigset_t        SigSetBlocked;
    /** Old Blocked signals. Used by sigsuspend().
     * sigsuspend() sets this and fSigSetBlockedOld. When a signal is to be
     * delivered this member will be pushed on the stack for use on an eventual
     * return. fSigSetBlockOld will be clared.
     * Protected by the signal semaphore. */
    sigset_t        SigSetBlockedOld;

    /** Signals queued for delivery on this thread.
     * Protected by the signal semaphore. */
    struct
    {
        struct SignalQueued *pHead;
        struct SignalQueued *pTail;