libcoro/coro.h

/*
 * Copyright (c) 2001-2008 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.
 * 
 * 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.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * the GNU General Public License ("GPL") version 2 or any later version,
 * in which case the provisions of the GPL are applicable instead of
 * the above. If you wish to allow the use of your version of this file
 * only under the terms of the GPL and not to allow others to use your
 * version of this file under the BSD license, indicate your decision
 * by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL. If you do not delete the
 * provisions above, a recipient may use your version of this file under
 * either the BSD or the GPL.
 *
 * 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/.
 *
 */

/*
 * 2006-10-26 Include stddef.h on OS X to work around one of its bugs.
 *            Reported by Michael_G_Schwern.
 * 2006-11-26 Use _setjmp instead of setjmp on GNU/Linux.
 * 2007-04-27 Set unwind frame info if gcc 3+ and ELF is detected.
 *            Use _setjmp instead of setjmp on _XOPEN_SOURCE >= 600.
 * 2007-05-02 Add assembly versions for x86 and amd64 (to avoid reliance
 *            on SIGUSR2 and sigaltstack in Crossfire).
 * 2008-01-21 Disable CFI usage on anything but GNU/Linux.
 * 2008-03-02 Switched to 2-clause BSD license with GPL exception.
 * 2008-04-04 New (but highly unrecommended) pthreads backend.
 * 2008-04-24 Reinstate CORO_LOSER (had wrong stack adjustments).
 * 2008-10-30 Support assembly method on x86 with and without frame pointer.
 * 2008-11-03 Use a global asm statement for CORO_ASM, idea by pippijn.
 * 2008-11-05 Hopefully fix misaligned stacks with CORO_ASM/SETJMP.
 * 2008-11-07 rbp wasn't saved in CORO_ASM on x86_64.
 *            introduce coro_destroy, which is a nop except for pthreads.
 *            speed up CORO_PTHREAD. Do no longer leak threads either.
 *            coro_create now allows one to create source coro_contexts.
 *            do not rely on makecontext passing a void * correctly.
 *            try harder to get _setjmp/_longjmp.
 *            major code cleanup/restructuring.
 */

#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.
 *
 * -DCORO_SJLJ
 *
 *    This flavour uses SUSv2's 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.
 *
 * -DCORO_LINUX
 *
 *    Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
 *    (it is very fast and therefore recommended over other methods, but
 *    doesn't work with anything newer).
 *
 * -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 ;)
 *
 * -DCORO_ASM
 *
 *    Handcoded assembly, known to work only on a few architectures/ABI:
 *    ELF Linux x86 && amd64 when gcc is used and optimisation is turned on.
 *
 * -DCORO_PTHREAD
 *
 *    Use the pthread API. You have to provide <pthread.h> and -lpthread.
 *
 * 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 an
 * opaque type. errno and sigmask might be saved, but don't rely on it,
 * implement your own switching primitive if you need that.
 */
typedef struct coro_context coro_context;

/*
 * This function creates a new coroutine. Apart from a pointer to an
 * uninitialised 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.
 *
 * As a special case, if coro, arg, sptr and ssize are all zero,
 * then an "empty" coro_contetx will be created that is suitable
 * as an initial source for coro_transfer.
 *
 * This function is not reentrant, but putting a mutex around it
 * will work.
 */
void coro_create (coro_context *ctx, /* an uninitialised coro_context */
                  coro_func coro,    /* the coroutine code to be executed */
                  void *arg,         /* a single pointer passed to the coro */
                  void *sptr,        /* start of stack area */
                  long ssize);       /* size of stack area */

/*
 * The following prototype defines the coroutine switching function. It is
 * usually implemented as a macro, so watch out.
 *
 * This function is thread-safe and reentrant.
 */
#if 0
void coro_transfer (coro_context *prev, coro_context *next);
#endif

/*
 * The following prototype defines the coroutine destroy function. It is
 * usually implemented as a macro, so watch out. It also serves
 * no purpose unless you want to use the CORO_PTHREAD backend.
 *
 * This function is thread-safe and reentrant.
 */
#if 0
void coro_destroy (coro_context *ctx);
#endif

/*
 * 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) && !defined(CORO_ASM) \
    && !defined(CORO_PTHREAD)
# if defined(WINDOWS)
#  define CORO_LOSER 1 /* you don't win with windoze */
# elif defined(__linux) && (defined(__x86) || defined (__amd64))
#  define CORO_ASM 1
# 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))
# define coro_destroy(ctx) (void *)(ctx)

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

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

# if !CORO_LOSER
#  include <unistd.h>
# endif

# include <setjmp.h>

struct coro_context {
#if _XOPEN_UNIX > 0 || CORO_LOSER
  jmp_buf env;
#else
  sigjmp_buf env;
#endif
};

# if _XOPEN_UNIX > 0
#  define coro_transfer(p,n) do { if (!  _setjmp ((p)->env   ))   _longjmp ((n)->env, 1); } while (0)
# elif CORO_LOSER
#  define coro_transfer(p,n) do { if (!   setjmp ((p)->env   ))    longjmp ((n)->env, 1); } while (0)
# else
#  define coro_transfer(p,n) do { if (!sigsetjmp ((p)->env, 0)) siglongjmp ((n)->env, 1); } while (0)
# endif

# define coro_destroy(ctx) (void *)(ctx)

#elif CORO_ASM

struct coro_context {
  void **sp; /* must be at offset 0 */
};

void __attribute__ ((__noinline__, __regparm__(2)))
coro_transfer (coro_context *prev, coro_context *next);

# define coro_destroy(ctx) (void *)(ctx)

#elif CORO_PTHREAD

# include <pthread.h>

extern pthread_mutex_t coro_mutex;

struct coro_context {
  pthread_cond_t cv;
  pthread_t id;
};

void coro_transfer (coro_context *prev, coro_context *next);
void coro_destroy (coro_context *ctx);

#endif

#endif

Revision:	1.35
Committed:	Sat Nov 8 13:42:28 2008 UTC (15 years, 6 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.34:	+4 -0 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.1	/*
2	root	1.23	* Copyright (c) 2001-2008 Marc Alexander Lehmann <schmorp@schmorp.de>
3	root	1.1	*
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			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
15			* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
16			* CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
17			* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
18			* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19			* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20			* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21			* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
22			* ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
23			* OF THE POSSIBILITY OF SUCH DAMAGE.
24			*
25	root	1.24	* Alternatively, the contents of this file may be used under the terms of
26			* the GNU General Public License ("GPL") version 2 or any later version,
27			* in which case the provisions of the GPL are applicable instead of
28			* the above. If you wish to allow the use of your version of this file
29			* only under the terms of the GPL and not to allow others to use your
30			* version of this file under the BSD license, indicate your decision
31			* by deleting the provisions above and replace them with the notice
32			* and other provisions required by the GPL. If you do not delete the
33			* provisions above, a recipient may use your version of this file under
34			* either the BSD or the GPL.
35			*
36	root	1.1	* This library is modelled strictly after Ralf S. Engelschalls article at
37	root	1.24	* http://www.gnu.org/software/pth/rse-pmt.ps. So most of the credit must
38	root	1.1	* go to Ralf S. Engelschall <rse@engelschall.com>.
39			*
40			* This coroutine library is very much stripped down. You should either
41	pcg	1.7	* build your own process abstraction using it or - better - just use GNU
42	root	1.1	* Portable Threads, http://www.gnu.org/software/pth/.
43	root	1.4	*
44	root	1.1	*/
45
46	root	1.14	/*
47			* 2006-10-26 Include stddef.h on OS X to work around one of its bugs.
48			* Reported by Michael_G_Schwern.
49	root	1.17	* 2006-11-26 Use _setjmp instead of setjmp on GNU/Linux.
50	root	1.20	* 2007-04-27 Set unwind frame info if gcc 3+ and ELF is detected.
51	root	1.21	* Use _setjmp instead of setjmp on _XOPEN_SOURCE >= 600.
52	root	1.22	* 2007-05-02 Add assembly versions for x86 and amd64 (to avoid reliance
53			* on SIGUSR2 and sigaltstack in Crossfire).
54	root	1.23	* 2008-01-21 Disable CFI usage on anything but GNU/Linux.
55	root	1.24	* 2008-03-02 Switched to 2-clause BSD license with GPL exception.
56	root	1.25	* 2008-04-04 New (but highly unrecommended) pthreads backend.
57	root	1.26	* 2008-04-24 Reinstate CORO_LOSER (had wrong stack adjustments).
58	root	1.28	* 2008-10-30 Support assembly method on x86 with and without frame pointer.
59	root	1.29	* 2008-11-03 Use a global asm statement for CORO_ASM, idea by pippijn.
60	root	1.30	* 2008-11-05 Hopefully fix misaligned stacks with CORO_ASM/SETJMP.
61	root	1.31	* 2008-11-07 rbp wasn't saved in CORO_ASM on x86_64.
62	root	1.32	* introduce coro_destroy, which is a nop except for pthreads.
63			* speed up CORO_PTHREAD. Do no longer leak threads either.
64			* coro_create now allows one to create source coro_contexts.
65	root	1.33	* do not rely on makecontext passing a void * correctly.
66			* try harder to get _setjmp/_longjmp.
67			* major code cleanup/restructuring.
68	root	1.14	*/
69
70	root	1.1	#ifndef CORO_H
71			#define CORO_H
72
73	root	1.11	#define CORO_VERSION 2
74
75			/*
76			* Changes since API version 1:
77	root	1.12	* replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
78	root	1.11	*/
79	root	1.9
80	root	1.2	/*
81			* This library consists of only three files
82	root	1.9	* coro.h, coro.c and LICENSE (and optionally README)
83	root	1.2	*
84			* It implements what is known as coroutines, in a hopefully
85			* portable way. At the moment you have to define which kind
86			* of implementation flavour you want:
87			*
88			* -DCORO_UCONTEXT
89			*
90			* This flavour uses SUSv2's get/set/swap/makecontext functions that
91			* unfortunately only newer unices support.
92			*
93			* -DCORO_SJLJ
94			*
95	root	1.13	* This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
96	root	1.2	* do it's job. Coroutine creation is much slower than UCONTEXT, but
97			* context switching is often a bit cheaper. It should work on almost
98	root	1.24	* all unices.
99	root	1.3	*
100			* -DCORO_LINUX
101			*
102	root	1.24	* Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
103			* (it is very fast and therefore recommended over other methods, but
104			* doesn't work with anything newer).
105	root	1.2	*
106	root	1.11	* -DCORO_LOSER
107	root	1.2	*
108			* Microsoft's highly proprietary platform doesn't support sigaltstack, and
109			* this automatically selects a suitable workaround for this platform.
110			* (untested)
111			*
112	root	1.5	* -DCORO_IRIX
113			*
114			* SGI's version of Microsoft's NT ;)
115			*
116	root	1.22	* -DCORO_ASM
117			*
118			* Handcoded assembly, known to work only on a few architectures/ABI:
119			* ELF Linux x86 && amd64 when gcc is used and optimisation is turned on.
120			*
121	root	1.25	* -DCORO_PTHREAD
122			*
123			* Use the pthread API. You have to provide <pthread.h> and -lpthread.
124			*
125	root	1.2	* If you define neither of these symbols, coro.h will try to autodetect
126	root	1.24	* the model. This currently works for CORO_LOSER only. For the other
127	root	1.2	* alternatives you should check (e.g. using autoconf) and define the
128			* following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
129			*/
130
131			/*
132	root	1.6	* This is the type for the initialization function of a new coroutine.
133	root	1.2	*/
134	root	1.1	typedef void (coro_func)(void );
135	root	1.2
136			/*
137	root	1.19	* A coroutine state is saved in the following structure. Treat it as an
138	root	1.2	* opaque type. errno and sigmask might be saved, but don't rely on it,
139	root	1.19	* implement your own switching primitive if you need that.
140	root	1.2	*/
141			typedef struct coro_context coro_context;
142
143			/*
144			* This function creates a new coroutine. Apart from a pointer to an
145	root	1.13	* uninitialised coro_context, it expects a pointer to the entry function
146	root	1.2	* and the single pointer value that is given to it as argument.
147			*
148	root	1.32	* Allocating/deallocating the stack is your own responsibility.
149			*
150			* As a special case, if coro, arg, sptr and ssize are all zero,
151			* then an "empty" coro_contetx will be created that is suitable
152			* as an initial source for coro_transfer.
153			*
154			* This function is not reentrant, but putting a mutex around it
155			* will work.
156	root	1.2	*/
157	root	1.19	void coro_create (coro_context ctx, / an uninitialised coro_context */
158			coro_func coro, /* the coroutine code to be executed */
159			void arg, / a single pointer passed to the coro */
160			void sptr, / start of stack area */
161			long ssize); /* size of stack area */
162	root	1.2
163			/*
164			* The following prototype defines the coroutine switching function. It is
165			* usually implemented as a macro, so watch out.
166			*
167	root	1.32	* This function is thread-safe and reentrant.
168	root	1.2	*/
169	root	1.32	#if 0
170			void coro_transfer (coro_context prev, coro_context next);
171			#endif
172
173			/*
174			* The following prototype defines the coroutine destroy function. It is
175			* usually implemented as a macro, so watch out. It also serves
176			* no purpose unless you want to use the CORO_PTHREAD backend.
177			*
178			* This function is thread-safe and reentrant.
179			*/
180			#if 0
181			void coro_destroy (coro_context *ctx);
182			#endif
183	root	1.2
184			/*
185			* That was it. No other user-visible functions are implemented here.
186			*/
187
188	root	1.5	/*****************************************************************************/
189
190	root	1.11	#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
191	root	1.5	&& !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
192	root	1.25	&& !defined(CORO_IRIX) && !defined(CORO_ASM) \
193			&& !defined(CORO_PTHREAD)
194	root	1.2	# if defined(WINDOWS)
195	root	1.11	# define CORO_LOSER 1 /* you don't win with windoze */
196	root	1.22	# elif defined(__linux) && (defined(__x86) \|\| defined (__amd64))
197			# define CORO_ASM 1
198	root	1.2	# elif defined(HAVE_UCONTEXT_H)
199			# define CORO_UCONTEXT 1
200			# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
201			# define CORO_SJLJ 1
202			# else
203	root	1.1	error unknown or unsupported architecture
204	root	1.2	# endif
205	root	1.1	#endif
206
207	root	1.5	/*****************************************************************************/
208
209	root	1.1	#if CORO_UCONTEXT
210
211	root	1.22	# include <ucontext.h>
212	root	1.1
213	root	1.2	struct coro_context {
214	root	1.1	ucontext_t uc;
215	root	1.2	};
216	root	1.1
217	root	1.22	# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
218	root	1.32	# define coro_destroy(ctx) (void *)(ctx)
219	root	1.1
220	root	1.11	#elif CORO_SJLJ \|\| CORO_LOSER \|\| CORO_LINUX \|\| CORO_IRIX
221	root	1.1
222	root	1.22	# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
223			# define _GNU_SOURCE /* for linux libc */
224			# endif
225	root	1.8
226	root	1.33	# if !CORO_LOSER
227			# include <unistd.h>
228			# endif
229
230	root	1.22	# include <setjmp.h>
231	root	1.1
232	root	1.2	struct coro_context {
233	root	1.35	#if _XOPEN_UNIX > 0 \|\| CORO_LOSER
234	root	1.1	jmp_buf env;
235	root	1.35	#else
236			sigjmp_buf env;
237			#endif
238	root	1.2	};
239	root	1.1
240	root	1.33	# if _XOPEN_UNIX > 0
241	root	1.34	# define coro_transfer(p,n) do { if (! _setjmp ((p)->env )) _longjmp ((n)->env, 1); } while (0)
242			# elif CORO_LOSER
243			# define coro_transfer(p,n) do { if (! setjmp ((p)->env )) longjmp ((n)->env, 1); } while (0)
244	root	1.22	# else
245	root	1.34	# define coro_transfer(p,n) do { if (!sigsetjmp ((p)->env, 0)) siglongjmp ((n)->env, 1); } while (0)
246	root	1.22	# endif
247
248	root	1.32	# define coro_destroy(ctx) (void *)(ctx)
249
250	root	1.22	#elif CORO_ASM
251
252			struct coro_context {
253	root	1.34	void *sp; / must be at offset 0 */
254	root	1.22	};
255
256	root	1.27	void __attribute__ ((__noinline__, __regparm__(2)))
257	root	1.29	coro_transfer (coro_context prev, coro_context next);
258	root	1.25
259	root	1.32	# define coro_destroy(ctx) (void *)(ctx)
260
261	root	1.25	#elif CORO_PTHREAD
262
263	root	1.32	# include <pthread.h>
264	root	1.25
265			extern pthread_mutex_t coro_mutex;
266
267			struct coro_context {
268	root	1.32	pthread_cond_t cv;
269			pthread_t id;
270	root	1.25	};
271
272			void coro_transfer (coro_context prev, coro_context next);
273	root	1.32	void coro_destroy (coro_context *ctx);
274	root	1.1
275			#endif
276
277			#endif
278