ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libcoro/coro.h
(Generate patch)

Comparing libcoro/coro.h (file contents):
Revision 1.8 by root, Wed Jan 12 20:35:35 2005 UTC vs.
Revision 1.21 by root, Fri Apr 27 19:35:28 2007 UTC

1/* 1/*
2 * Copyright (c) 2001 Marc Alexander Lehmann <pcg@goof.com> 2 * Copyright (c) 2001-2006 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,
… …
31 * 31 *
32 * This coroutine library is very much stripped down. You should either 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 33 * build your own process abstraction using it or - better - just use GNU
34 * Portable Threads, http://www.gnu.org/software/pth/. 34 * Portable Threads, http://www.gnu.org/software/pth/.
35 * 35 *
36 * VERSION: 0.1 36 */
37
38/*
39 * 2006-10-26 Include stddef.h on OS X to work around one of its bugs.
40 * Reported by Michael_G_Schwern.
41 * 2006-11-26 Use _setjmp instead of setjmp on GNU/Linux.
42 * 2007-04-27 Set unwind frame info if gcc 3+ and ELF is detected.
43 * Use _setjmp instead of setjmp on _XOPEN_SOURCE >= 600.
37 */ 44 */
38 45
39#ifndef CORO_H 46#ifndef CORO_H
40#define CORO_H 47#define CORO_H
41 48
49#define CORO_VERSION 2
50
51/*
52 * Changes since API version 1:
53 * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
54 */
55
42/* 56/*
43 * This library consists of only three files 57 * This library consists of only three files
44 * coro.h, coro.c and LICENSE 58 * coro.h, coro.c and LICENSE (and optionally README)
45 * 59 *
46 * It implements what is known as coroutines, in a hopefully 60 * It implements what is known as coroutines, in a hopefully
47 * portable way. At the moment you have to define which kind 61 * portable way. At the moment you have to define which kind
48 * of implementation flavour you want: 62 * of implementation flavour you want:
49 * 63 *
50 * -DCORO_UCONTEXT 64 * -DCORO_UCONTEXT
51 * 65 *
52 * This flavour uses SUSv2's get/set/swap/makecontext functions that 66 * This flavour uses SUSv2's get/set/swap/makecontext functions that
53 * unfortunately only newer unices support. 67 * unfortunately only newer unices support.
54 * Use this for GNU/Linux + glibc-2.2.3. 68 * Use this for GNU/Linux + glibc-2.2.3 and possibly higher.
55 * 69 *
56 * -DCORO_SJLJ 70 * -DCORO_SJLJ
57 * 71 *
58 * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to 72 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
59 * do it's job. Coroutine creation is much slower than UCONTEXT, but 73 * do it's job. Coroutine creation is much slower than UCONTEXT, but
60 * context switching is often a bit cheaper. It should work on almost 74 * context switching is often a bit cheaper. It should work on almost
61 * all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below 75 * all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below
62 * do not work with any sane model (neither sigaltstack nor context 76 * do not work with any sane model (neither sigaltstack nor context
63 * functions are implemented) 77 * functions are implemented)
64 * 78 *
65 * -DCORO_LINUX 79 * -DCORO_LINUX
66 * 80 *
67 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation 81 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation
68 * (very fast). 82 * (it is very fast and therefore recommended over other methods).
69 * 83 *
70 * -DCORO_LOOSE 84 * -DCORO_LOSER
71 * 85 *
72 * Microsoft's highly proprietary platform doesn't support sigaltstack, and 86 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
73 * this automatically selects a suitable workaround for this platform. 87 * this automatically selects a suitable workaround for this platform.
74 * (untested) 88 * (untested)
75 * 89 *
76 * -DCORO_IRIX 90 * -DCORO_IRIX
77 * 91 *
78 * SGI's version of Microsoft's NT ;) 92 * SGI's version of Microsoft's NT ;)
79 * 93 *
80 * If you define neither of these symbols, coro.h will try to autodetect 94 * If you define neither of these symbols, coro.h will try to autodetect
81 * the model. This currently works for CORO_LOOSE only. For the other 95 * the model. This currently works for CORO_LOSER only. For the other
82 * alternatives you should check (e.g. using autoconf) and define the 96 * alternatives you should check (e.g. using autoconf) and define the
83 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 97 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
84 */ 98 */
85 99
86/* 100/*
87 * This is the type for the initialization function of a new coroutine. 101 * This is the type for the initialization function of a new coroutine.
88 */ 102 */
89typedef void (*coro_func)(void *); 103typedef void (*coro_func)(void *);
90 104
91/* 105/*
92 * A coroutine state is saved in the following structure. Treat it as a 106 * A coroutine state is saved in the following structure. Treat it as an
93 * opaque type. errno and sigmask might be saved, but don't rely on it, 107 * opaque type. errno and sigmask might be saved, but don't rely on it,
94 * implement your own switching primitive. 108 * implement your own switching primitive if you need that.
95 */ 109 */
96typedef struct coro_context coro_context; 110typedef struct coro_context coro_context;
97 111
98/* 112/*
99 * This function creates a new coroutine. Apart from a pointer to an 113 * This function creates a new coroutine. Apart from a pointer to an
100 * uninitialized coro_context, it expects a pointer to the entry function 114 * uninitialised coro_context, it expects a pointer to the entry function
101 * and the single pointer value that is given to it as argument. 115 * and the single pointer value that is given to it as argument.
102 * 116 *
103 * Allocating/deallocating the stack is your own responsibility, so there is 117 * Allocating/deallocating the stack is your own responsibility, so there is
104 * no coro_destroy function. 118 * no coro_destroy function.
105 */ 119 */
106void coro_create (coro_context *ctx, 120void coro_create (coro_context *ctx, /* an uninitialised coro_context */
107 coro_func coro, void *arg, 121 coro_func coro, /* the coroutine code to be executed */
108 void *sptr, long ssize); 122 void *arg, /* a single pointer passed to the coro */
123 void *sptr, /* start of stack area */
124 long ssize); /* size of stack area */
109 125
110/* 126/*
111 * The following prototype defines the coroutine switching function. It is 127 * The following prototype defines the coroutine switching function. It is
112 * usually implemented as a macro, so watch out. 128 * usually implemented as a macro, so watch out.
113 * 129 *
… …
118 * That was it. No other user-visible functions are implemented here. 134 * That was it. No other user-visible functions are implemented here.
119 */ 135 */
120 136
121/*****************************************************************************/ 137/*****************************************************************************/
122 138
123#if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) \ 139#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
124 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ 140 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
125 && !defined(CORO_IRIX) 141 && !defined(CORO_IRIX)
126# if defined(WINDOWS) 142# if defined(WINDOWS)
127# define CORO_LOOSE 1 /* you don't win with windoze */ 143# define CORO_LOSER 1 /* you don't win with windoze */
128# elif defined(__linux) && defined(__x86) 144# elif defined(__linux) && defined(__x86)
129# elif defined(HAVE_UCONTEXT_H) 145# elif defined(HAVE_UCONTEXT_H)
130# define CORO_UCONTEXT 1 146# define CORO_UCONTEXT 1
131# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 147# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
132# define CORO_SJLJ 1 148# define CORO_SJLJ 1
… …
145 ucontext_t uc; 161 ucontext_t uc;
146}; 162};
147 163
148#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) 164#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
149 165
150#elif CORO_SJLJ || CORO_LOOSE || CORO_LINUX || CORO_IRIX 166#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
151 167
152#ifdef CORO_LINUX 168#if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
153# define _GNU_SOURCE // for linux libc 169# define _GNU_SOURCE /* for linux libc */
154#endif 170#endif
155 171
156#include <setjmp.h> 172#include <setjmp.h>
157 173
158struct coro_context { 174struct coro_context {
159 jmp_buf env; 175 jmp_buf env;
160}; 176};
161 177
178#if CORO_LINUX || (_XOPEN_SOURCE >= 600)
162#define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while(0) 179# define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0)
180#else
181# define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0)
182#endif
163 183
164#endif 184#endif
165 185
166#endif 186#endif
167 187

Diff Legend

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