[ViewVC] Diff of: cvs/libcoro/coro.h

Comparing libcoro/coro.h (file contents):
Revision 1.42 by root, Sat Jul 11 14:24:13 2009 UTC vs.
Revision 1.58 by root, Sat Aug 27 12:54:52 2016 UTC

…		…
1	/*	1	/*
2	* Copyright (c) 2001-2009 Marc Alexander Lehmann <schmorp@schmorp.de>	2	* Copyright (c) 2001-2012,2015 Marc Alexander Lehmann <schmorp@schmorp.de>
3	*	3	*
4	* Redistribution and use in source and binary forms, with or without modifica-	4	* Redistribution and use in source and binary forms, with or without modifica-
5	* tion, are permitted provided that the following conditions are met:	5	* tion, are permitted provided that the following conditions are met:
6	*	6	*
7	* 1. Redistributions of source code must retain the above copyright notice,	7	* 1. Redistributions of source code must retain the above copyright notice,
8	* this list of conditions and the following disclaimer.	8	* this list of conditions and the following disclaimer.
9	*	9	*
10	* 2. Redistributions in binary form must reproduce the above copyright	10	* 2. Redistributions in binary form must reproduce the above copyright
11	* notice, this list of conditions and the following disclaimer in the	11	* notice, this list of conditions and the following disclaimer in the
12	* documentation and/or other materials provided with the distribution.	12	* documentation and/or other materials provided with the distribution.
13	*	13	*
14	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED	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-	15	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
16	* CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO	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-	17	* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
18	* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,	18	* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
67	* major code cleanup/restructuring.	67	* major code cleanup/restructuring.
68	* 2008-11-10 the .cfi hacks are no longer needed.	68	* 2008-11-10 the .cfi hacks are no longer needed.
69	* 2008-11-16 work around a freebsd pthread bug.	69	* 2008-11-16 work around a freebsd pthread bug.
70	* 2008-11-19 define coro_*jmp symbols for easier porting.	70	* 2008-11-19 define coro_*jmp symbols for easier porting.
71	* 2009-06-23 tentative win32-backend support for mingw32 (Yasuhiro Matsumoto).	71	* 2009-06-23 tentative win32-backend support for mingw32 (Yasuhiro Matsumoto).
		72	* 2010-12-03 tentative support for uclibc (which lacks all sorts of things).
		73	* 2011-05-30 set initial callee-saved-registers to zero with CORO_ASM.
		74	* use .cfi_undefined rip on linux-amd64 for better backtraces.
		75	* 2011-06-08 maybe properly implement weird windows amd64 calling conventions.
		76	* 2011-07-03 rely on __GCC_HAVE_DWARF2_CFI_ASM for cfi detection.
		77	* 2011-08-08 cygwin trashes stacks, use pthreads with double stack on cygwin.
		78	* 2012-12-04 reduce misprediction penalty for x86/amd64 assembly switcher.
		79	* 2012-12-05 experimental fiber backend (allocates stack twice).
		80	* 2012-12-07 API version 3 - add coro_stack_alloc/coro_stack_free.
		81	* 2012-12-21 valgrind stack registering was broken.
		82	* 2015-12-05 experimental asm be for arm7, based on a patch by Nick Zavaritsky.
		83	* use __name__ for predefined symbols, as in libecb.
		84	* enable guard pages on arm, aarch64 and mips.
		85	* 2016-08-27 try to disable _FORTIFY_SOURCE with CORO_SJLJ, as it
		86	* breaks setjmp/longjmp. Also disable CORO_ASM for asm by default,
		87	* as it was reported to crash.
72	*/	88	*/
73		89
74	#ifndef CORO_H	90	#ifndef CORO_H
75	#define CORO_H	91	#define CORO_H
76		92
77	#define CORO_VERSION 2	93	#if __cplusplus
78		94	extern "C" {
79	/*	95	#endif
80	* Changes since API version 1:
81	* replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
82	*/
83		96
84	/*	97	/*
85	* This library consists of only three files	98	* This library consists of only three files
86	* coro.h, coro.c and LICENSE (and optionally README)	99	* coro.h, coro.c and LICENSE (and optionally README)
87	*	100	*
88	* It implements what is known as coroutines, in a hopefully	101	* It implements what is known as coroutines, in a hopefully
89	* portable way. At the moment you have to define which kind	102	* portable way.
90	* of implementation flavour you want:	103	*
		104	* All compiletime symbols must be defined both when including coro.h
		105	* (using libcoro) as well as when compiling coro.c (the implementation).
		106	*
		107	* You can manually specify which flavour you want. If you don't define
		108	* any of these, libcoro tries to choose a safe and fast default:
91	*	109	*
92	* -DCORO_UCONTEXT	110	* -DCORO_UCONTEXT
93	*	111	*
94	* This flavour uses SUSv2's get/set/swap/makecontext functions that	112	* This flavour uses SUSv2's get/set/swap/makecontext functions that
95	* unfortunately only newer unices support.	113	* unfortunately only some unices support, and is quite slow.
96	*	114	*
97	* -DCORO_SJLJ	115	* -DCORO_SJLJ
98	*	116	*
99	* This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to	117	* This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
100	* do it's job. Coroutine creation is much slower than UCONTEXT, but	118	* do it's job. Coroutine creation is much slower than UCONTEXT, but
101	* context switching is often a bit cheaper. It should work on almost	119	* context switching is a bit cheaper. It should work on almost all unices.
102	* all unices.
103	*	120	*
104	* -DCORO_LINUX	121	* -DCORO_LINUX
105	*	122	*
		123	* CORO_SJLJ variant.
106	* Old GNU/Linux systems (<= glibc-2.1) only work with this implementation	124	* Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
107	* (it is very fast and therefore recommended over other methods, but	125	* (it is very fast and therefore recommended over other methods, but
108	* doesn't work with anything newer).	126	* doesn't work with anything newer).
109	*	127	*
110	* -DCORO_LOSER	128	* -DCORO_LOSER
111	*	129	*
		130	* CORO_SJLJ variant.
112	* Microsoft's highly proprietary platform doesn't support sigaltstack, and	131	* Microsoft's highly proprietary platform doesn't support sigaltstack, and
113	* this automatically selects a suitable workaround for this platform.	132	* this selects a suitable workaround for this platform. It might not work
114	* (untested)	133	* with your compiler though - it has only been tested with MSVC 6.
		134	*
		135	* -DCORO_FIBER
		136	*
		137	* Slower, but probably more portable variant for the Microsoft operating
		138	* system, using fibers. Ignores the passed stack and allocates it internally.
		139	* Also, due to bugs in cygwin, this does not work with cygwin.
115	*	140	*
116	* -DCORO_IRIX	141	* -DCORO_IRIX
117	*	142	*
		143	* CORO_SJLJ variant.
118	* SGI's version of Microsoft's NT ;)	144	* For SGI's version of Microsoft's NT ;)
119	*	145	*
120	* -DCORO_ASM	146	* -DCORO_ASM
121	*	147	*
122	* Handcoded assembly, known to work only on a few architectures/ABI:	148	* Hand coded assembly, known to work only on a few architectures/ABI:
123	* GCC + x86/IA32 and amd64/x86_64 + GNU/Linux and a few BSDs.	149	* GCC + arm7/x86/IA32/amd64/x86_64 + GNU/Linux and a few BSDs. Fastest
		150	* choice, if it works.
124	*	151	*
125	* -DCORO_PTHREAD	152	* -DCORO_PTHREAD
126	*	153	*
127	* Use the pthread API. You have to provide <pthread.h> and -lpthread.	154	* Use the pthread API. You have to provide <pthread.h> and -lpthread.
128	* This is likely the slowest backend, and it also does not support fork(),	155	* This is likely the slowest backend, and it also does not support fork(),
129	* so avoid it at all costs.	156	* so avoid it at all costs.
130	*	157	*
131	* If you define neither of these symbols, coro.h will try to autodetect	158	* If you define neither of these symbols, coro.h will try to autodetect
132	* the model. This currently works for CORO_LOSER only. For the other	159	* the best/safest model. To help with the autodetection, you should check
133	* alternatives you should check (e.g. using autoconf) and define the	160	* (e.g. using autoconf) and define the following symbols: HAVE_UCONTEXT_H
134	* following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.	161	* / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
		162	*/
		163
		164	/*
		165	* Changes when the API changes incompatibly.
		166	* This is ONLY the API version - there is no ABI compatibility between releases.
135	*/	167	*
		168	* Changes in API version 2:
		169	* replaced bogus -DCORO_LOOSE with grammatically more correct -DCORO_LOSER
		170	* Changes in API version 3:
		171	* introduced stack management (CORO_STACKALLOC)
		172	*/
		173	#define CORO_VERSION 3
		174
		175	#include <stddef.h>
136		176
137	/*	177	/*
138	* This is the type for the initialization function of a new coroutine.	178	* This is the type for the initialization function of a new coroutine.
139	*/	179	*/
140	typedef void (coro_func)(void );	180	typedef void (coro_func)(void );
…		…
151	* uninitialised coro_context, it expects a pointer to the entry function	191	* uninitialised coro_context, it expects a pointer to the entry function
152	* and the single pointer value that is given to it as argument.	192	* and the single pointer value that is given to it as argument.
153	*	193	*
154	* Allocating/deallocating the stack is your own responsibility.	194	* Allocating/deallocating the stack is your own responsibility.
155	*	195	*
156	* As a special case, if coro, arg, sptr and ssize are all zero,	196	* As a special case, if coro, arg, sptr and ssze are all zero,
157	* then an "empty" coro_context will be created that is suitable	197	* then an "empty" coro_context will be created that is suitable
158	* as an initial source for coro_transfer.	198	* as an initial source for coro_transfer.
159	*	199	*
160	* This function is not reentrant, but putting a mutex around it	200	* This function is not reentrant, but putting a mutex around it
161	* will work.	201	* will work.
162	*/	202	*/
163	void coro_create (coro_context ctx, / an uninitialised coro_context */	203	void coro_create (coro_context ctx, / an uninitialised coro_context */
164	coro_func coro, /* the coroutine code to be executed */	204	coro_func coro, /* the coroutine code to be executed */
165	void arg, / a single pointer passed to the coro */	205	void arg, / a single pointer passed to the coro */
166	void sptr, / start of stack area */	206	void sptr, / start of stack area */
167	long ssize); /* size of stack area */	207	size_t ssze); /* size of stack area in bytes */
168		208
169	/*	209	/*
170	* The following prototype defines the coroutine switching function. It is	210	* The following prototype defines the coroutine switching function. It is
171	* usually implemented as a macro, so watch out.	211	* sometimes implemented as a macro, so watch out.
172	*	212	*
173	* This function is thread-safe and reentrant.	213	* This function is thread-safe and reentrant.
174	*/	214	*/
175	#if 0	215	#if 0
176	void coro_transfer (coro_context prev, coro_context next);	216	void coro_transfer (coro_context prev, coro_context next);
177	#endif	217	#endif
178		218
179	/*	219	/*
180	* The following prototype defines the coroutine destroy function. It is	220	* The following prototype defines the coroutine destroy function. It
181	* usually implemented as a macro, so watch out. It also serves	221	* is sometimes implemented as a macro, so watch out. It also serves no
182	* no purpose unless you want to use the CORO_PTHREAD backend,	222	* purpose unless you want to use the CORO_PTHREAD backend, where it is
183	* where it is used to clean up the thread. You are responsible	223	* used to clean up the thread. You are responsible for freeing the stack
184	* for freeing the stack and the context itself.	224	* and the context itself.
185	*	225	*
186	* This function is thread-safe and reentrant.	226	* This function is thread-safe and reentrant.
187	*/	227	*/
188	#if 0	228	#if 0
189	void coro_destroy (coro_context *ctx);	229	void coro_destroy (coro_context *ctx);
190	#endif	230	#endif
191		231
192	/*
193	* That was it. No other user-visible functions are implemented here.
194	*/
195
196	/*****************************************************************************/	232	/*****************************************************************************/
		233	/* optional stack management */
		234	/*****************************************************************************/
		235	/*
		236	* You can disable all of the stack management functions by
		237	* defining CORO_STACKALLOC to 0. Otherwise, they are enabled by default.
		238	*
		239	* If stack management is enabled, you can influence the implementation via these
		240	* symbols:
		241	*
		242	* -DCORO_USE_VALGRIND
		243	*
		244	* If defined, then libcoro will include valgrind/valgrind.h and register
		245	* and unregister stacks with valgrind.
		246	*
		247	* -DCORO_GUARDPAGES=n
		248	*
		249	* libcoro will try to use the specified number of guard pages to protect against
		250	* stack overflow. If n is 0, then the feature will be disabled. If it isn't
		251	* defined, then libcoro will choose a suitable default. If guardpages are not
		252	* supported on the platform, then the feature will be silently disabled.
		253	*/
		254	#ifndef CORO_STACKALLOC
		255	# define CORO_STACKALLOC 1
		256	#endif
197		257
		258	#if CORO_STACKALLOC
		259
		260	/*
		261	* The only allowed operations on these struct members is to read the
		262	* "sptr" and "ssze" members to pass it to coro_create, to read the "sptr"
		263	* member to see if it is false, in which case the stack isn't allocated,
		264	* and to set the "sptr" member to 0, to indicate to coro_stack_free to
		265	* not actually do anything.
		266	*/
		267
		268	struct coro_stack
		269	{
		270	void *sptr;
		271	size_t ssze;
		272	#if CORO_USE_VALGRIND
		273	int valgrind_id;
		274	#endif
		275	};
		276
		277	/*
		278	* Try to allocate a stack of at least the given size and return true if
		279	* successful, or false otherwise.
		280	*
		281	* The size is NOT specified in bytes, but in units of sizeof (void *),
		282	* i.e. the stack is typically 4(8) times larger on 32 bit(64 bit) platforms
		283	* then the size passed in.
		284	*
		285	* If size is 0, then a "suitable" stack size is chosen (usually 1-2MB).
		286	*/
		287	int coro_stack_alloc (struct coro_stack *stack, unsigned int size);
		288
		289	/*
		290	* Free the stack allocated by coro_stack_alloc again. It is safe to
		291	* call this function on the coro_stack structure even if coro_stack_alloc
		292	* failed.
		293	*/
		294	void coro_stack_free (struct coro_stack *stack);
		295
		296	#endif
		297
		298	/*
		299	* That was it. No other user-serviceable parts below here.
		300	*/
		301
		302	/*****************************************************************************/
		303
198	#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \	304	#if !defined CORO_LOSER && !defined CORO_UCONTEXT \
199	&& !defined(CORO_SJLJ) && !defined(CORO_LINUX) \	305	&& !defined CORO_SJLJ && !defined CORO_LINUX \
200	&& !defined(CORO_IRIX) && !defined(CORO_ASM) \	306	&& !defined CORO_IRIX && !defined CORO_ASM \
201	&& !defined(CORO_PTHREAD)	307	&& !defined CORO_PTHREAD && !defined CORO_FIBER
202	# if defined(WINDOWS)	308	# if defined WINDOWS && (defined __i386__ \|\| (__x86_64__ \|\| defined _M_IX86 \|\| defined _M_AMD64)
		309	# define CORO_ASM 1
		310	# elif defined WINDOWS \|\| defined _WIN32
203	# define CORO_LOSER 1 /* you don't win with windoze */	311	# define CORO_LOSER 1 /* you don't win with windoze */
204	# elif defined(__linux) && (defined(__x86) \|\| defined (__amd64))	312	# elif __linux && (__i386__ \|\| (__x86_64__ && !__ILP32__) /\|\| (__arm__ && __ARM_ARCH == 7)), not working /
205	# define CORO_ASM 1	313	# define CORO_ASM 1
206	# elif defined(HAVE_UCONTEXT_H)	314	# elif defined HAVE_UCONTEXT_H
207	# define CORO_UCONTEXT 1	315	# define CORO_UCONTEXT 1
208	# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)	316	# elif defined HAVE_SETJMP_H && defined HAVE_SIGALTSTACK
209	# define CORO_SJLJ 1	317	# define CORO_SJLJ 1
210	# else	318	# else
211	error unknown or unsupported architecture	319	error unknown or unsupported architecture
212	# endif	320	# endif
213	#endif	321	#endif
…		…
216		324
217	#if CORO_UCONTEXT	325	#if CORO_UCONTEXT
218		326
219	# include <ucontext.h>	327	# include <ucontext.h>
220		328
221	struct coro_context {	329	struct coro_context
		330	{
222	ucontext_t uc;	331	ucontext_t uc;
223	};	332	};
224		333
225	# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))	334	# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
226	# define coro_destroy(ctx) (void *)(ctx)	335	# define coro_destroy(ctx) (void *)(ctx)
227		336
228	#elif CORO_SJLJ \|\| CORO_LOSER \|\| CORO_LINUX \|\| CORO_IRIX	337	#elif CORO_SJLJ \|\| CORO_LOSER \|\| CORO_LINUX \|\| CORO_IRIX
229		338
230	# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)	339	# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
231	# define _GNU_SOURCE /* for linux libc */	340	# define _GNU_SOURCE /* for glibc */
		341	# endif
		342
		343	/* try to disable well-meant but buggy checks in some libcs */
		344	# ifdef _FORTIFY_SOURCE
		345	# undef _FORTIFY_SOURCE
		346	# undef __USE_FORTIFY_LEVEL /* helps some more when too much has been included already */
232	# endif	347	# endif
233		348
234	# if !CORO_LOSER	349	# if !CORO_LOSER
235	# include <unistd.h>	350	# include <unistd.h>
236	# endif	351	# endif
…		…
255	# define coro_jmp_buf sigjmp_buf	370	# define coro_jmp_buf sigjmp_buf
256	# define coro_setjmp(env) sigsetjmp (env, 0)	371	# define coro_setjmp(env) sigsetjmp (env, 0)
257	# define coro_longjmp(env) siglongjmp ((env), 1)	372	# define coro_longjmp(env) siglongjmp ((env), 1)
258	# endif	373	# endif
259		374
260	struct coro_context {	375	struct coro_context
		376	{
261	coro_jmp_buf env;	377	coro_jmp_buf env;
262	};	378	};
263		379
264	# define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0)	380	# define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0)
265	# define coro_destroy(ctx) (void *)(ctx)	381	# define coro_destroy(ctx) (void *)(ctx)
266		382
267	#elif CORO_ASM	383	#elif CORO_ASM
268		384
269	struct coro_context {	385	struct coro_context
		386	{
270	void *sp; / must be at offset 0 */	387	void *sp; / must be at offset 0 */
271	};	388	};
272		389
		390	#if __i386__ \|\| __x86_64__
273	void __attribute__ ((__noinline__, __regparm__(2)))	391	void __attribute__ ((__noinline__, __regparm__(2)))
		392	#else
		393	void __attribute__ ((__noinline__))
		394	#endif
274	coro_transfer (coro_context prev, coro_context next);	395	coro_transfer (coro_context prev, coro_context next);
275		396
276	# define coro_destroy(ctx) (void *)(ctx)	397	# define coro_destroy(ctx) (void *)(ctx)
277		398
278	#elif CORO_PTHREAD	399	#elif CORO_PTHREAD
279		400
280	# include <pthread.h>	401	# include <pthread.h>
281		402
282	extern pthread_mutex_t coro_mutex;	403	extern pthread_mutex_t coro_mutex;
283		404
284	struct coro_context {	405	struct coro_context
		406	{
285	pthread_cond_t cv;	407	pthread_cond_t cv;
286	pthread_t id;	408	pthread_t id;
287	};	409	};
288		410
289	void coro_transfer (coro_context prev, coro_context next);	411	void coro_transfer (coro_context prev, coro_context next);
290	void coro_destroy (coro_context *ctx);	412	void coro_destroy (coro_context *ctx);
291		413
292	#endif	414	#elif CORO_FIBER
293		415
294	#endif	416	struct coro_context
		417	{
		418	void *fiber;
		419	/* only used for initialisation */
		420	coro_func coro;
		421	void *arg;
		422	};
295		423
		424	void coro_transfer (coro_context prev, coro_context next);
		425	void coro_destroy (coro_context *ctx);
		426
		427	#endif
		428
		429	#if __cplusplus
		430	}
		431	#endif
		432
		433	#endif
		434

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing libcoro/coro.h (file contents): Revision 1.42 by root, Sat Jul 11 14:24:13 2009 UTC vs. Revision 1.58 by root, Sat Aug 27 12:54:52 2016 UTC

Diff Legend

Comparing libcoro/coro.h (file contents):
Revision 1.42 by root, Sat Jul 11 14:24:13 2009 UTC vs.
Revision 1.58 by root, Sat Aug 27 12:54:52 2016 UTC