1 | /* |
1 | /* |
2 | * Copyright (c) 2001 Marc Alexander Lehmann <pcg@goof.com> |
2 | * Copyright (c) 2001-2005 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 | * |
35 | */ |
36 | */ |
36 | |
37 | |
37 | #ifndef CORO_H |
38 | #ifndef CORO_H |
38 | #define CORO_H |
39 | #define CORO_H |
39 | |
40 | |
|
|
41 | #define CORO_VERSION 1 |
|
|
42 | |
40 | /* |
43 | /* |
41 | * This library consists of only three files |
44 | * This library consists of only three files |
42 | * coro.h, coro.c and LICENSE |
45 | * coro.h, coro.c and LICENSE (and optionally README) |
43 | * |
46 | * |
44 | * It implements what is known as coroutines, in a hopefully |
47 | * It implements what is known as coroutines, in a hopefully |
45 | * portable way. At the moment you have to define which kind |
48 | * portable way. At the moment you have to define which kind |
46 | * of implementation flavour you want: |
49 | * of implementation flavour you want: |
47 | * |
50 | * |
… | |
… | |
69 | * |
72 | * |
70 | * Microsoft's highly proprietary platform doesn't support sigaltstack, and |
73 | * Microsoft's highly proprietary platform doesn't support sigaltstack, and |
71 | * this automatically selects a suitable workaround for this platform. |
74 | * this automatically selects a suitable workaround for this platform. |
72 | * (untested) |
75 | * (untested) |
73 | * |
76 | * |
|
|
77 | * -DCORO_IRIX |
|
|
78 | * |
|
|
79 | * SGI's version of Microsoft's NT ;) |
|
|
80 | * |
74 | * If you define neither of these symbols, coro.h will try to autodetect |
81 | * If you define neither of these symbols, coro.h will try to autodetect |
75 | * the model. This currently works for CORO_LOOSE only. For the other |
82 | * the model. This currently works for CORO_LOOSE only. For the other |
76 | * alternatives you should check (e.g. using autoconf) and define the |
83 | * alternatives you should check (e.g. using autoconf) and define the |
77 | * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
84 | * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
78 | */ |
85 | */ |
79 | |
86 | |
80 | /* |
87 | /* |
81 | * This is the type for the top function of a new coroutine. |
88 | * This is the type for the initialization function of a new coroutine. |
82 | */ |
89 | */ |
83 | typedef void (*coro_func)(void *); |
90 | typedef void (*coro_func)(void *); |
84 | |
|
|
85 | |
91 | |
86 | /* |
92 | /* |
87 | * A coroutine state is saved in the following structure. Treat it as a |
93 | * A coroutine state is saved in the following structure. Treat it as a |
88 | * opaque type. errno and sigmask might be saved, but don't rely on it, |
94 | * opaque type. errno and sigmask might be saved, but don't rely on it, |
89 | * implement your own switching primitive. |
95 | * implement your own switching primitive. |
… | |
… | |
96 | * and the single pointer value that is given to it as argument. |
102 | * and the single pointer value that is given to it as argument. |
97 | * |
103 | * |
98 | * Allocating/deallocating the stack is your own responsibility, so there is |
104 | * Allocating/deallocating the stack is your own responsibility, so there is |
99 | * no coro_destroy function. |
105 | * no coro_destroy function. |
100 | */ |
106 | */ |
101 | void coro_create(coro_context *ctx, |
107 | void coro_create (coro_context *ctx, |
102 | coro_func coro, void *arg, |
108 | coro_func coro, void *arg, |
103 | void *sptr, long ssize); |
109 | void *sptr, long ssize); |
104 | |
110 | |
105 | /* |
111 | /* |
106 | * The following prototype defines the coroutine switching function. It is |
112 | * The following prototype defines the coroutine switching function. It is |
107 | * usually implemented as a macro, so watch out. |
113 | * usually implemented as a macro, so watch out. |
108 | * |
114 | * |
… | |
… | |
111 | |
117 | |
112 | /* |
118 | /* |
113 | * That was it. No other user-visible functions are implemented here. |
119 | * That was it. No other user-visible functions are implemented here. |
114 | */ |
120 | */ |
115 | |
121 | |
|
|
122 | /*****************************************************************************/ |
|
|
123 | |
116 | #if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) \ |
124 | #if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) \ |
117 | && !defined(CORO_SJLJ) && !defined(CORO_LINUX) |
125 | && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ |
|
|
126 | && !defined(CORO_IRIX) |
118 | # if defined(WINDOWS) |
127 | # if defined(WINDOWS) |
119 | # define CORO_LOOSE 1 /* you don't win with windoze */ |
128 | # define CORO_LOOSE 1 /* you don't win with windoze */ |
120 | # elif defined(__linux) && defined(__x86) |
129 | # elif defined(__linux) && defined(__x86) |
121 | # elif defined(HAVE_UCONTEXT_H) |
130 | # elif defined(HAVE_UCONTEXT_H) |
122 | # define CORO_UCONTEXT 1 |
131 | # define CORO_UCONTEXT 1 |
… | |
… | |
125 | # else |
134 | # else |
126 | error unknown or unsupported architecture |
135 | error unknown or unsupported architecture |
127 | # endif |
136 | # endif |
128 | #endif |
137 | #endif |
129 | |
138 | |
|
|
139 | /*****************************************************************************/ |
|
|
140 | |
130 | #if CORO_UCONTEXT |
141 | #if CORO_UCONTEXT |
131 | |
142 | |
132 | #include <ucontext.h> |
143 | #include <ucontext.h> |
133 | |
144 | |
134 | struct coro_context { |
145 | struct coro_context { |
135 | ucontext_t uc; |
146 | ucontext_t uc; |
136 | }; |
147 | }; |
137 | |
148 | |
138 | #define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) |
149 | #define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) |
139 | |
150 | |
140 | #elif CORO_SJLJ || CORO_LOOSE || CORO_LINUX |
151 | #elif CORO_SJLJ || CORO_LOOSE || CORO_LINUX || CORO_IRIX |
|
|
152 | |
|
|
153 | #if defined(CORO_LINUX) && !defined(_GNU_SOURCE) |
|
|
154 | # define _GNU_SOURCE // for linux libc |
|
|
155 | #endif |
141 | |
156 | |
142 | #include <setjmp.h> |
157 | #include <setjmp.h> |
143 | |
158 | |
144 | struct coro_context { |
159 | struct coro_context { |
145 | jmp_buf env; |
160 | jmp_buf env; |
146 | }; |
161 | }; |
147 | |
162 | |
148 | #define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1) |
163 | #define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while(0) |
149 | |
164 | |
150 | #endif |
165 | #endif |
151 | |
166 | |
152 | #endif |
167 | #endif |
153 | |
168 | |