libcoro/coro.h

/*
 * Copyright (c) 2001-2005 Marc Alexander Lehmann <schmorp@schmorp.de>
 * 
 * Redistribution and use in source and binary forms, with or without modifica-
 * tion, are permitted provided that the following conditions are met:
 * 
 *   1.  Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 * 
 *   2.  Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 * 
 *   3.  The name of the author may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO
 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This library is modelled strictly after Ralf S. Engelschalls article at
 * http://www.gnu.org/software/pth/rse-pmt.ps.  So most of the credit must
 * go to Ralf S. Engelschall <rse@engelschall.com>.
 *
 * This coroutine library is very much stripped down. You should either
 * build your own process abstraction using it or - better - just use GNU
 * Portable Threads, http://www.gnu.org/software/pth/.
 *
 */

#ifndef CORO_H
#define CORO_H

#define CORO_VERSION 2

/*
 * Changes since API version 1:
 * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
 */

/*
 * This library consists of only three files
 * coro.h, coro.c and LICENSE (and optionally README)
 *
 * It implements what is known as coroutines, in a hopefully
 * portable way. At the moment you have to define which kind
 * of implementation flavour you want:
 *
 * -DCORO_UCONTEXT
 *
 *    This flavour uses SUSv2's get/set/swap/makecontext functions that
 *    unfortunately only newer unices support.
 *    Use this for GNU/Linux + glibc-2.2.3.
 *
 * -DCORO_SJLJ
 *
 *    This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to
 *    do it's job. Coroutine creation is much slower than UCONTEXT, but
 *    context switching is often a bit cheaper. It should work on almost
 *    all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below
 *    do not work with any sane model (neither sigaltstack nor context
 *    functions are implemented)
 *
 * -DCORO_LINUX
 *
 *    Old GNU/Linux systems (<= glibc-2.1) work with this implementation
 *    (very fast).
 *
 * -DCORO_LOSER
 *
 *    Microsoft's highly proprietary platform doesn't support sigaltstack, and
 *    this automatically selects a suitable workaround for this platform.
 *    (untested)
 *
 * -DCORO_IRIX
 *
 *    SGI's version of Microsoft's NT ;)
 *
 * If you define neither of these symbols, coro.h will try to autodetect
 * the model.  This currently works for CORO_LOSER only. For the other
 * alternatives you should check (e.g. using autoconf) and define the
 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
 */

/*
 * This is the type for the initialization function of a new coroutine.
 */
typedef void (*coro_func)(void *);

/*
 * A coroutine state is saved in the following structure. Treat it as a
 * opaque type. errno and sigmask might be saved, but don't rely on it,
 * implement your own switching primitive.
 */
typedef struct coro_context coro_context;

/*
 * This function creates a new coroutine. Apart from a pointer to an
 * uninitialized coro_context, it expects a pointer to the entry function
 * and the single pointer value that is given to it as argument.
 *
 * Allocating/deallocating the stack is your own responsibility, so there is
 * no coro_destroy function.
 */
void coro_create (coro_context *ctx,
                  coro_func coro, void *arg,
                  void *sptr, long ssize);

/*
 * The following prototype defines the coroutine switching function. It is
 * usually implemented as a macro, so watch out.
 *
void coro_transfer(coro_context *prev, coro_context *next);
 */

/*
 * That was it. No other user-visible functions are implemented here.
 */

/*****************************************************************************/

#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
    && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
    && !defined(CORO_IRIX)
# if defined(WINDOWS)
#  define CORO_LOSER 1 /* you don't win with windoze */
# elif defined(__linux) && defined(__x86)
# elif defined(HAVE_UCONTEXT_H)
#  define CORO_UCONTEXT 1
# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
#  define CORO_SJLJ 1
# else
error unknown or unsupported architecture
# endif
#endif

/*****************************************************************************/

#if CORO_UCONTEXT

#include <ucontext.h>

struct coro_context {
  ucontext_t uc;
};

#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))

#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX

#if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
# define _GNU_SOURCE // for linux libc
#endif

#include <setjmp.h>

struct coro_context {
  jmp_buf env;
};

#define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while(0)

#endif

#endif

Revision:	1.12
Committed:	Sat Aug 20 01:07:45 2005 UTC (20 years, 9 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-1_9, rel-1_2, rel-1_5, rel-1_4, rel-1_7, rel-1_6, rel-1_31
Changes since 1.11:	+1 -1 lines
Log Message:	* empty log message *
#	Content
1	/*
2	* Copyright (c) 2001-2005 Marc Alexander Lehmann <schmorp@schmorp.de>
3	*
4	* Redistribution and use in source and binary forms, with or without modifica-
5	* tion, are permitted provided that the following conditions are met:
6	*
7	* 1. Redistributions of source code must retain the above copyright notice,
8	* this list of conditions and the following disclaimer.
9	*
10	* 2. Redistributions in binary form must reproduce the above copyright
11	* notice, this list of conditions and the following disclaimer in the
12	* documentation and/or other materials provided with the distribution.
13	*
14	* 3. The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.
16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
18	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19	* CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20	* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21	* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22	* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23	* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24	* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
25	* ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26	* OF THE POSSIBILITY OF SUCH DAMAGE.
27	*
28	* This library is modelled strictly after Ralf S. Engelschalls article at
29	* http://www.gnu.org/software/pth/rse-pmt.ps. So most of the credit must
30	* go to Ralf S. Engelschall <rse@engelschall.com>.
31	*
32	* This coroutine library is very much stripped down. You should either
33	* build your own process abstraction using it or - better - just use GNU
34	* Portable Threads, http://www.gnu.org/software/pth/.
35	*
36	*/
37
38	#ifndef CORO_H
39	#define CORO_H
40
41	#define CORO_VERSION 2
42
43	/*
44	* Changes since API version 1:
45	* replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
46	*/
47
48	/*
49	* This library consists of only three files
50	* coro.h, coro.c and LICENSE (and optionally README)
51	*
52	* It implements what is known as coroutines, in a hopefully
53	* portable way. At the moment you have to define which kind
54	* of implementation flavour you want:
55	*
56	* -DCORO_UCONTEXT
57	*
58	* This flavour uses SUSv2's get/set/swap/makecontext functions that
59	* unfortunately only newer unices support.
60	* Use this for GNU/Linux + glibc-2.2.3.
61	*
62	* -DCORO_SJLJ
63	*
64	* This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to
65	* do it's job. Coroutine creation is much slower than UCONTEXT, but
66	* context switching is often a bit cheaper. It should work on almost
67	* all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below
68	* do not work with any sane model (neither sigaltstack nor context
69	* functions are implemented)
70	*
71	* -DCORO_LINUX
72	*
73	* Old GNU/Linux systems (<= glibc-2.1) work with this implementation
74	* (very fast).
75	*
76	* -DCORO_LOSER
77	*
78	* Microsoft's highly proprietary platform doesn't support sigaltstack, and
79	* this automatically selects a suitable workaround for this platform.
80	* (untested)
81	*
82	* -DCORO_IRIX
83	*
84	* SGI's version of Microsoft's NT ;)
85	*
86	* If you define neither of these symbols, coro.h will try to autodetect
87	* the model. This currently works for CORO_LOSER only. For the other
88	* alternatives you should check (e.g. using autoconf) and define the
89	* following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
90	*/
91
92	/*
93	* This is the type for the initialization function of a new coroutine.
94	*/
95	typedef void (coro_func)(void );
96
97	/*
98	* A coroutine state is saved in the following structure. Treat it as a
99	* opaque type. errno and sigmask might be saved, but don't rely on it,
100	* implement your own switching primitive.
101	*/
102	typedef struct coro_context coro_context;
103
104	/*
105	* This function creates a new coroutine. Apart from a pointer to an
106	* uninitialized coro_context, it expects a pointer to the entry function
107	* and the single pointer value that is given to it as argument.
108	*
109	* Allocating/deallocating the stack is your own responsibility, so there is
110	* no coro_destroy function.
111	*/
112	void coro_create (coro_context *ctx,
113	coro_func coro, void *arg,
114	void *sptr, long ssize);
115
116	/*
117	* The following prototype defines the coroutine switching function. It is
118	* usually implemented as a macro, so watch out.
119	*
120	void coro_transfer(coro_context prev, coro_context next);
121	*/
122
123	/*
124	* That was it. No other user-visible functions are implemented here.
125	*/
126
127	/*****************************************************************************/
128
129	#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
130	&& !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
131	&& !defined(CORO_IRIX)
132	# if defined(WINDOWS)
133	# define CORO_LOSER 1 /* you don't win with windoze */
134	# elif defined(__linux) && defined(__x86)
135	# elif defined(HAVE_UCONTEXT_H)
136	# define CORO_UCONTEXT 1
137	# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
138	# define CORO_SJLJ 1
139	# else
140	error unknown or unsupported architecture
141	# endif
142	#endif
143
144	/*****************************************************************************/
145
146	#if CORO_UCONTEXT
147
148	#include <ucontext.h>
149
150	struct coro_context {
151	ucontext_t uc;
152	};
153
154	#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
155
156	#elif CORO_SJLJ \|\| CORO_LOSER \|\| CORO_LINUX \|\| CORO_IRIX
157
158	#if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
159	# define _GNU_SOURCE // for linux libc
160	#endif
161
162	#include <setjmp.h>
163
164	struct coro_context {
165	jmp_buf env;
166	};
167
168	#define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while(0)
169
170	#endif
171
172	#endif
173