[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.56 by root, Fri Aug 26 10:38:04 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.
72	*/	85	*/
73		86
74	#ifndef CORO_H	87	#ifndef CORO_H
75	#define CORO_H	88	#define CORO_H
76		89
77	#define CORO_VERSION 2	90	#if __cplusplus
78		91	extern "C" {
79	/*	92	#endif
80	* Changes since API version 1:
81	* replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
82	*/
83		93
84	/*	94	/*
85	* This library consists of only three files	95	* This library consists of only three files
86	* coro.h, coro.c and LICENSE (and optionally README)	96	* coro.h, coro.c and LICENSE (and optionally README)
87	*	97	*
88	* It implements what is known as coroutines, in a hopefully	98	* It implements what is known as coroutines, in a hopefully
89	* portable way. At the moment you have to define which kind	99	* portable way.
90	* of implementation flavour you want:	100	*
		101	* All compiletime symbols must be defined both when including coro.h
		102	* (using libcoro) as well as when compiling coro.c (the implementation).
		103	*
		104	* You can manually specify which flavour you want. If you don't define
		105	* any of these, libcoro tries to choose a safe and fast default:
91	*	106	*
92	* -DCORO_UCONTEXT	107	* -DCORO_UCONTEXT
93	*	108	*
94	* This flavour uses SUSv2's get/set/swap/makecontext functions that	109	* This flavour uses SUSv2's get/set/swap/makecontext functions that
95	* unfortunately only newer unices support.	110	* unfortunately only some unices support, and is quite slow.
96	*	111	*
97	* -DCORO_SJLJ	112	* -DCORO_SJLJ
98	*	113	*
99	* This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to	114	* This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
100	* do it's job. Coroutine creation is much slower than UCONTEXT, but	115	* 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	116	* context switching is a bit cheaper. It should work on almost all unices.
102	* all unices.
103	*	117	*
104	* -DCORO_LINUX	118	* -DCORO_LINUX
105	*	119	*
		120	* CORO_SJLJ variant.
106	* Old GNU/Linux systems (<= glibc-2.1) only work with this implementation	121	* Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
107	* (it is very fast and therefore recommended over other methods, but	122	* (it is very fast and therefore recommended over other methods, but
108	* doesn't work with anything newer).	123	* doesn't work with anything newer).
109	*	124	*
110	* -DCORO_LOSER	125	* -DCORO_LOSER
111	*	126	*
		127	* CORO_SJLJ variant.
112	* Microsoft's highly proprietary platform doesn't support sigaltstack, and	128	* Microsoft's highly proprietary platform doesn't support sigaltstack, and
113	* this automatically selects a suitable workaround for this platform.	129	* this selects a suitable workaround for this platform. It might not work
114	* (untested)	130	* with your compiler though - it has only been tested with MSVC 6.
		131	*
		132	* -DCORO_FIBER
		133	*
		134	* Slower, but probably more portable variant for the Microsoft operating
		135	* system, using fibers. Ignores the passed stack and allocates it internally.
		136	* Also, due to bugs in cygwin, this does not work with cygwin.
115	*	137	*
116	* -DCORO_IRIX	138	* -DCORO_IRIX
117	*	139	*
		140	* CORO_SJLJ variant.
118	* SGI's version of Microsoft's NT ;)	141	* For SGI's version of Microsoft's NT ;)
119	*	142	*
120	* -DCORO_ASM	143	* -DCORO_ASM
121	*	144	*
122	* Handcoded assembly, known to work only on a few architectures/ABI:	145	* 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.	146	* GCC + arm7/x86/IA32/amd64/x86_64 + GNU/Linux and a few BSDs. Fastest
		147	* choice, if it works.
124	*	148	*
125	* -DCORO_PTHREAD	149	* -DCORO_PTHREAD
126	*	150	*
127	* Use the pthread API. You have to provide <pthread.h> and -lpthread.	151	* 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(),	152	* This is likely the slowest backend, and it also does not support fork(),
129	* so avoid it at all costs.	153	* so avoid it at all costs.
130	*	154	*
131	* If you define neither of these symbols, coro.h will try to autodetect	155	* 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	156	* the best/safest model. To help with the autodetection, you should check
133	* alternatives you should check (e.g. using autoconf) and define the	157	* (e.g. using autoconf) and define the following symbols: HAVE_UCONTEXT_H
134	* following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.	158	* / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
		159	*/
		160
		161	/*
		162	* Changes when the API changes incompatibly.
		163	* This is ONLY the API version - there is no ABI compatibility between releases.
135	*/	164	*
		165	* Changes in API version 2:
		166	* replaced bogus -DCORO_LOOSE with grammatically more correct -DCORO_LOSER
		167	* Changes in API version 3:
		168	* introduced stack management (CORO_STACKALLOC)
		169	*/
		170	#define CORO_VERSION 3
		171
		172	#include <stddef.h>
136		173
137	/*	174	/*
138	* This is the type for the initialization function of a new coroutine.	175	* This is the type for the initialization function of a new coroutine.
139	*/	176	*/
140	typedef void (coro_func)(void );	177	typedef void (coro_func)(void );
…		…
151	* uninitialised coro_context, it expects a pointer to the entry function	188	* uninitialised coro_context, it expects a pointer to the entry function
152	* and the single pointer value that is given to it as argument.	189	* and the single pointer value that is given to it as argument.
153	*	190	*
154	* Allocating/deallocating the stack is your own responsibility.	191	* Allocating/deallocating the stack is your own responsibility.
155	*	192	*
156	* As a special case, if coro, arg, sptr and ssize are all zero,	193	* 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	194	* then an "empty" coro_context will be created that is suitable
158	* as an initial source for coro_transfer.	195	* as an initial source for coro_transfer.
159	*	196	*
160	* This function is not reentrant, but putting a mutex around it	197	* This function is not reentrant, but putting a mutex around it
161	* will work.	198	* will work.
162	*/	199	*/
163	void coro_create (coro_context ctx, / an uninitialised coro_context */	200	void coro_create (coro_context ctx, / an uninitialised coro_context */
164	coro_func coro, /* the coroutine code to be executed */	201	coro_func coro, /* the coroutine code to be executed */
165	void arg, / a single pointer passed to the coro */	202	void arg, / a single pointer passed to the coro */
166	void sptr, / start of stack area */	203	void sptr, / start of stack area */
167	long ssize); /* size of stack area */	204	size_t ssze); /* size of stack area in bytes */
168		205
169	/*	206	/*
170	* The following prototype defines the coroutine switching function. It is	207	* The following prototype defines the coroutine switching function. It is
171	* usually implemented as a macro, so watch out.	208	* sometimes implemented as a macro, so watch out.
172	*	209	*
173	* This function is thread-safe and reentrant.	210	* This function is thread-safe and reentrant.
174	*/	211	*/
175	#if 0	212	#if 0
176	void coro_transfer (coro_context prev, coro_context next);	213	void coro_transfer (coro_context prev, coro_context next);
177	#endif	214	#endif
178		215
179	/*	216	/*
180	* The following prototype defines the coroutine destroy function. It is	217	* The following prototype defines the coroutine destroy function. It
181	* usually implemented as a macro, so watch out. It also serves	218	* 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,	219	* 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	220	* used to clean up the thread. You are responsible for freeing the stack
184	* for freeing the stack and the context itself.	221	* and the context itself.
185	*	222	*
186	* This function is thread-safe and reentrant.	223	* This function is thread-safe and reentrant.
187	*/	224	*/
188	#if 0	225	#if 0
189	void coro_destroy (coro_context *ctx);	226	void coro_destroy (coro_context *ctx);
190	#endif	227	#endif
191		228
192	/*
193	* That was it. No other user-visible functions are implemented here.
194	*/
195
196	/*****************************************************************************/	229	/*****************************************************************************/
		230	/* optional stack management */
		231	/*****************************************************************************/
		232	/*
		233	* You can disable all of the stack management functions by
		234	* defining CORO_STACKALLOC to 0. Otherwise, they are enabled by default.
		235	*
		236	* If stack management is enabled, you can influence the implementation via these
		237	* symbols:
		238	*
		239	* -DCORO_USE_VALGRIND
		240	*
		241	* If defined, then libcoro will include valgrind/valgrind.h and register
		242	* and unregister stacks with valgrind.
		243	*
		244	* -DCORO_GUARDPAGES=n
		245	*
		246	* libcoro will try to use the specified number of guard pages to protect against
		247	* stack overflow. If n is 0, then the feature will be disabled. If it isn't
		248	* defined, then libcoro will choose a suitable default. If guardpages are not
		249	* supported on the platform, then the feature will be silently disabled.
		250	*/
		251	#ifndef CORO_STACKALLOC
		252	# define CORO_STACKALLOC 1
		253	#endif
197		254
		255	#if CORO_STACKALLOC
		256
		257	/*
		258	* The only allowed operations on these struct members is to read the
		259	* "sptr" and "ssze" members to pass it to coro_create, to read the "sptr"
		260	* member to see if it is false, in which case the stack isn't allocated,
		261	* and to set the "sptr" member to 0, to indicate to coro_stack_free to
		262	* not actually do anything.
		263	*/
		264
		265	struct coro_stack
		266	{
		267	void *sptr;
		268	size_t ssze;
		269	#if CORO_USE_VALGRIND
		270	int valgrind_id;
		271	#endif
		272	};
		273
		274	/*
		275	* Try to allocate a stack of at least the given size and return true if
		276	* successful, or false otherwise.
		277	*
		278	* The size is NOT specified in bytes, but in units of sizeof (void *),
		279	* i.e. the stack is typically 4(8) times larger on 32 bit(64 bit) platforms
		280	* then the size passed in.
		281	*
		282	* If size is 0, then a "suitable" stack size is chosen (usually 1-2MB).
		283	*/
		284	int coro_stack_alloc (struct coro_stack *stack, unsigned int size);
		285
		286	/*
		287	* Free the stack allocated by coro_stack_alloc again. It is safe to
		288	* call this function on the coro_stack structure even if coro_stack_alloc
		289	* failed.
		290	*/
		291	void coro_stack_free (struct coro_stack *stack);
		292
		293	#endif
		294
		295	/*
		296	* That was it. No other user-serviceable parts below here.
		297	*/
		298
		299	/*****************************************************************************/
		300
198	#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \	301	#if !defined CORO_LOSER && !defined CORO_UCONTEXT \
199	&& !defined(CORO_SJLJ) && !defined(CORO_LINUX) \	302	&& !defined CORO_SJLJ && !defined CORO_LINUX \
200	&& !defined(CORO_IRIX) && !defined(CORO_ASM) \	303	&& !defined CORO_IRIX && !defined CORO_ASM \
201	&& !defined(CORO_PTHREAD)	304	&& !defined CORO_PTHREAD && !defined CORO_FIBER
202	# if defined(WINDOWS)	305	# if defined WINDOWS && (defined __i386__ \|\| (__x86_64__ \|\| defined _M_IX86 \|\| defined _M_AMD64)
		306	# define CORO_ASM 1
		307	# elif defined WINDOWS \|\| defined _WIN32
203	# define CORO_LOSER 1 /* you don't win with windoze */	308	# define CORO_LOSER 1 /* you don't win with windoze */
204	# elif defined(__linux) && (defined(__x86) \|\| defined (__amd64))	309	# elif __linux && (__i386__ \|\| (__x86_64__ && !__ILP32__) \|\| (__arm__ && __ARM_ARCH == 7))
205	# define CORO_ASM 1	310	# define CORO_ASM 1
206	# elif defined(HAVE_UCONTEXT_H)	311	# elif defined HAVE_UCONTEXT_H
207	# define CORO_UCONTEXT 1	312	# define CORO_UCONTEXT 1
208	# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)	313	# elif defined HAVE_SETJMP_H && defined HAVE_SIGALTSTACK
209	# define CORO_SJLJ 1	314	# define CORO_SJLJ 1
210	# else	315	# else
211	error unknown or unsupported architecture	316	error unknown or unsupported architecture
212	# endif	317	# endif
213	#endif	318	#endif
…		…
216		321
217	#if CORO_UCONTEXT	322	#if CORO_UCONTEXT
218		323
219	# include <ucontext.h>	324	# include <ucontext.h>
220		325
221	struct coro_context {	326	struct coro_context
		327	{
222	ucontext_t uc;	328	ucontext_t uc;
223	};	329	};
224		330
225	# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))	331	# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
226	# define coro_destroy(ctx) (void *)(ctx)	332	# define coro_destroy(ctx) (void *)(ctx)
227		333
228	#elif CORO_SJLJ \|\| CORO_LOSER \|\| CORO_LINUX \|\| CORO_IRIX	334	#elif CORO_SJLJ \|\| CORO_LOSER \|\| CORO_LINUX \|\| CORO_IRIX
229		335
230	# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)	336	# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
231	# define _GNU_SOURCE /* for linux libc */	337	# define _GNU_SOURCE /* for glibc */
232	# endif	338	# endif
233		339
234	# if !CORO_LOSER	340	# if !CORO_LOSER
235	# include <unistd.h>	341	# include <unistd.h>
236	# endif	342	# endif
…		…
255	# define coro_jmp_buf sigjmp_buf	361	# define coro_jmp_buf sigjmp_buf
256	# define coro_setjmp(env) sigsetjmp (env, 0)	362	# define coro_setjmp(env) sigsetjmp (env, 0)
257	# define coro_longjmp(env) siglongjmp ((env), 1)	363	# define coro_longjmp(env) siglongjmp ((env), 1)
258	# endif	364	# endif
259		365
260	struct coro_context {	366	struct coro_context
		367	{
261	coro_jmp_buf env;	368	coro_jmp_buf env;
262	};	369	};
263		370
264	# define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0)	371	# define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0)
265	# define coro_destroy(ctx) (void *)(ctx)	372	# define coro_destroy(ctx) (void *)(ctx)
266		373
267	#elif CORO_ASM	374	#elif CORO_ASM
268		375
269	struct coro_context {	376	struct coro_context
		377	{
270	void *sp; / must be at offset 0 */	378	void *sp; / must be at offset 0 */
271	};	379	};
272		380
		381	#if __i386__ \|\| __x86_64__
273	void __attribute__ ((__noinline__, __regparm__(2)))	382	void __attribute__ ((__noinline__, __regparm__(2)))
		383	#else
		384	void __attribute__ ((__noinline__))
		385	#endif
274	coro_transfer (coro_context prev, coro_context next);	386	coro_transfer (coro_context prev, coro_context next);
275		387
276	# define coro_destroy(ctx) (void *)(ctx)	388	# define coro_destroy(ctx) (void *)(ctx)
277		389
278	#elif CORO_PTHREAD	390	#elif CORO_PTHREAD
279		391
280	# include <pthread.h>	392	# include <pthread.h>
281		393
282	extern pthread_mutex_t coro_mutex;	394	extern pthread_mutex_t coro_mutex;
283		395
284	struct coro_context {	396	struct coro_context
		397	{
285	pthread_cond_t cv;	398	pthread_cond_t cv;
286	pthread_t id;	399	pthread_t id;
287	};	400	};
288		401
289	void coro_transfer (coro_context prev, coro_context next);	402	void coro_transfer (coro_context prev, coro_context next);
290	void coro_destroy (coro_context *ctx);	403	void coro_destroy (coro_context *ctx);
291		404
292	#endif	405	#elif CORO_FIBER
293		406
294	#endif	407	struct coro_context
		408	{
		409	void *fiber;
		410	/* only used for initialisation */
		411	coro_func coro;
		412	void *arg;
		413	};
295		414
		415	void coro_transfer (coro_context prev, coro_context next);
		416	void coro_destroy (coro_context *ctx);
		417
		418	#endif
		419
		420	#if __cplusplus
		421	}
		422	#endif
		423
		424	#endif
		425

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.56 by root, Fri Aug 26 10:38:04 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.56 by root, Fri Aug 26 10:38:04 2016 UTC