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