[gcc.git] / gcc / gthr.h

/* Threads compatibily routines for libgcc2.  */
/* Compile this one with gcc.  */
/* Copyright (C) 1997 Free Software Foundation, Inc.

This file is part of GNU CC.

GNU CC 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, or (at your option)
any later version.

GNU CC 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 GNU CC; see the file COPYING.  If not, write to
the Free Software Foundation, 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */

/* As a special exception, if you link this library with other files,
   some of which are compiled with GCC, to produce an executable,
   this library does not by itself cause the resulting executable
   to be covered by the GNU General Public License.
   This exception does not however invalidate any other reasons why
   the executable file might be covered by the GNU General Public License.  */

#ifndef __gthr_h
#define __gthr_h

/* If this file is compiled with threads support, it must
       #define __GTHREADS 1
   to indicate that threads support is present.  Also it has define
   function 
     int __gthread_active_p ()
   that returns 1 if thread system is active, 0 if not.

   The threads interface must define the following types:
     __gthread_key_t
     __gthread_once_t
     __gthread_mutex_t

   The threads interface must define the following macros:

     __GTHREAD_ONCE_INIT
     		to initialize __gthread_once_t
     __GTHREAD_MUTEX_INIT
     		to initialize __gthread_mutex_t to get a fast
		non-recursive mutex.

   The threads interface must define the following static functions:

     int __gthread_once (__gthread_once_t *once, void (*func) ())

     int __gthread_key_create (__gthread_key_t *keyp, void (*dtor) (void *))
     int __gthread_key_delete (__gthread_key_t key)

     int __gthread_key_dtor (__gthread_key_t key, void *ptr)

     void *__gthread_getspecific (__gthread_key_t key)
     int __gthread_setspecific (__gthread_key_t key, const void *ptr)

     int __gthread_mutex_lock (__gthread_mutex_t *mutex);
     int __gthread_mutex_trylock (__gthread_mutex_t *mutex);
     int __gthread_mutex_unlock (__gthread_mutex_t *mutex);

   All functions returning int should return 0 on success, -1 on error.

   Currently supported threads packages are
     POSIX threads with -D_PTHREADS
     DCE threads with -D_DCE_THREADS
     Solaris/UI threads with -D_SOLARIS_THREADS
*/

/* Check first for thread specific defines. */
#if _PTHREADS
#include "gthr-posix.h"
#elif _DCE_THREADS
#include "gthr-dce.h"
#elif _SOLARIS_THREADS
#include "gthr-solaris.h"

/* Include GTHREAD_FILE if one is defined. */
#elif SUPPORTS_WEAK && HAVE_GTHR_DEFAULT
#ifndef GTHREAD_USE_WEAK
#define GTHREAD_USE_WEAK 1
#endif
#include "gthr-default.h"

/* Fallback to single thread definitions. */
#else
#include "gthr-single.h"
#endif

#endif /* not __gthr_h */
Commit	Line	Data
f24af81b TT	1	/* Threads compatibily routines for libgcc2. */
	2	/* Compile this one with gcc. */
	3	/* Copyright (C) 1997 Free Software Foundation, Inc.
	4
	5	This file is part of GNU CC.
	6
	7	GNU CC is free software; you can redistribute it and/or modify
	8	it under the terms of the GNU General Public License as published by
	9	the Free Software Foundation; either version 2, or (at your option)
	10	any later version.
	11
	12	GNU CC is distributed in the hope that it will be useful,
	13	but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	GNU General Public License for more details.
	16
	17	You should have received a copy of the GNU General Public License
	18	along with GNU CC; see the file COPYING. If not, write to
	19	the Free Software Foundation, 59 Temple Place - Suite 330,
	20	Boston, MA 02111-1307, USA. */
	21
	22	/* As a special exception, if you link this library with other files,
	23	some of which are compiled with GCC, to produce an executable,
	24	this library does not by itself cause the resulting executable
	25	to be covered by the GNU General Public License.
	26	This exception does not however invalidate any other reasons why
	27	the executable file might be covered by the GNU General Public License. */
	28
	29	#ifndef __gthr_h
	30	#define __gthr_h
	31
	32	/* If this file is compiled with threads support, it must
	33	#define __GTHREADS 1
	34	to indicate that threads support is present. Also it has define
	35	function
	36	int __gthread_active_p ()
	37	that returns 1 if thread system is active, 0 if not.
	38
	39	The threads interface must define the following types:
	40	__gthread_key_t
	41	__gthread_once_t
	42	__gthread_mutex_t
	43
	44	The threads interface must define the following macros:
	45
	46	__GTHREAD_ONCE_INIT
	47	to initialize __gthread_once_t
	48	__GTHREAD_MUTEX_INIT
	49	to initialize __gthread_mutex_t to get a fast
	50	non-recursive mutex.
	51
	52	The threads interface must define the following static functions:
	53
	54	int __gthread_once (__gthread_once_t once, void (func) ())
	55
	56	int __gthread_key_create (__gthread_key_t keyp, void (dtor) (void *))
	57	int __gthread_key_delete (__gthread_key_t key)
	58
	59	int __gthread_key_dtor (__gthread_key_t key, void *ptr)
	60
	61	void *__gthread_getspecific (__gthread_key_t key)
	62	int __gthread_setspecific (__gthread_key_t key, const void *ptr)
	63
	64	int __gthread_mutex_lock (__gthread_mutex_t *mutex);
65	int __gthread_mutex_trylock (__gthread_mutex_t *mutex);
66	int __gthread_mutex_unlock (__gthread_mutex_t *mutex);
67
68	All functions returning int should return 0 on success, -1 on error.
69
70	Currently supported threads packages are
71	POSIX threads with -D_PTHREADS
72	DCE threads with -D_DCE_THREADS
73	Solaris/UI threads with -D_SOLARIS_THREADS
74	*/
75
76	/* Check first for thread specific defines. */
77	#if _PTHREADS
78	#include "gthr-posix.h"
79	#elif _DCE_THREADS
80	#include "gthr-dce.h"
81	#elif _SOLARIS_THREADS
82	#include "gthr-solaris.h"
83
84	/* Include GTHREAD_FILE if one is defined. */
85	#elif SUPPORTS_WEAK && HAVE_GTHR_DEFAULT
86	#ifndef GTHREAD_USE_WEAK
87	#define GTHREAD_USE_WEAK 1
88	#endif
89	#include "gthr-default.h"
90
91	/* Fallback to single thread definitions. */
92	#else
93	#include "gthr-single.h"
94	#endif
95
96	#endif /* not __gthr_h */