| … | |
… | |
| 35 | */ |
35 | */ |
| 36 | |
36 | |
| 37 | #ifndef CORO_H |
37 | #ifndef CORO_H |
| 38 | #define CORO_H |
38 | #define CORO_H |
| 39 | |
39 | |
|
|
40 | /* |
|
|
41 | * This library consists of only three files |
|
|
42 | * coro.h, coro.c and LICENSE |
|
|
43 | * |
|
|
44 | * It implements what is known as coroutines, in a hopefully |
|
|
45 | * portable way. At the moment you have to define which kind |
|
|
46 | * of implementation flavour you want: |
|
|
47 | * |
|
|
48 | * -DCORO_UCONTEXT |
|
|
49 | * |
|
|
50 | * This flavour uses SUSv2's get/set/swap/makecontext functions that |
|
|
51 | * unfortunately only newer unices support. |
|
|
52 | * Use this for GNU/Linux + glibc-2.2.3. |
|
|
53 | * |
|
|
54 | * -DCORO_SJLJ |
|
|
55 | * |
|
|
56 | * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to |
|
|
57 | * 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 |
|
|
59 | * 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 |
|
|
61 | * are implemented) |
|
|
62 | * |
|
|
63 | * -DCORO_LOOSE |
|
|
64 | * |
|
|
65 | * Microsoft's highly proprietary platform doesn't support sigaltstack, and |
|
|
66 | * this automatically selects a suitable workaround for this platform. |
|
|
67 | * (untested) |
|
|
68 | * |
|
|
69 | * 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 |
|
|
71 | * alternatives you should check (e.g. using autoconf) and define the |
|
|
72 | * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
|
|
73 | */ |
|
|
74 | |
|
|
75 | /* |
|
|
76 | * This is the type for the top function of a new coroutine. |
|
|
77 | */ |
| 40 | typedef void (*coro_func)(void *); |
78 | typedef void (*coro_func)(void *); |
| 41 | |
79 | |
|
|
80 | |
|
|
81 | /* |
|
|
82 | * A coroutine state is saved in the following structure. Treat it as a |
|
|
83 | * opaque type. errno and sigmask might be saved, but don't rely on it, |
|
|
84 | * implement your own switching primitive. |
|
|
85 | */ |
|
|
86 | typedef struct coro_context coro_context; |
|
|
87 | |
|
|
88 | /* |
|
|
89 | * This function creates a new coroutine. Apart from a pointer to an |
|
|
90 | * uninitialized coro_context, it expects a pointer to the entry function |
|
|
91 | * and the single pointer value that is given to it as argument. |
|
|
92 | * |
|
|
93 | * Allocating/deallocating the stack is your own responsibility, so there is |
|
|
94 | * no coro_destroy function. |
|
|
95 | */ |
|
|
96 | void coro_create(coro_context *ctx, |
|
|
97 | coro_func coro, void *arg, |
|
|
98 | void *sptr, long ssize); |
|
|
99 | |
|
|
100 | /* |
|
|
101 | * The following prototype defines the coroutine switching function. It is |
|
|
102 | * usually implemented as a macro, so watch out. |
|
|
103 | * |
|
|
104 | void coro_transfer(coro_context *prev, coro_context *next); |
|
|
105 | */ |
|
|
106 | |
|
|
107 | /* |
|
|
108 | * That was it. No other user-visible functions are implemented here. |
|
|
109 | */ |
|
|
110 | |
|
|
111 | #if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) && !defined(CORO_SJLJ) |
| 42 | #if defined(WINDOWS) |
112 | # if defined(WINDOWS) |
| 43 | # define CORO_LOOSE 1 /* you don't win with windoze */ |
113 | # define CORO_LOOSE 1 /* you don't win with windoze */ |
| 44 | #elif defined(HAVE_UCONTEXT_H) |
114 | # elif defined(HAVE_UCONTEXT_H) |
| 45 | # define CORO_UCONTEXT 1 |
115 | # define CORO_UCONTEXT 1 |
| 46 | #elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) |
116 | # elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) |
| 47 | # define CORO_SJLJ 1 |
117 | # define CORO_SJLJ 1 |
| 48 | #else |
118 | # else |
| 49 | error unknown or unsupported architecture |
119 | error unknown or unsupported architecture |
|
|
120 | # endif |
| 50 | #endif |
121 | #endif |
| 51 | |
122 | |
| 52 | #if CORO_UCONTEXT |
123 | #if CORO_UCONTEXT |
| 53 | |
124 | |
| 54 | #include <ucontext.h> |
125 | #include <ucontext.h> |
| 55 | |
126 | |
| 56 | typedef struct { |
127 | struct coro_context { |
| 57 | ucontext_t uc; |
128 | ucontext_t uc; |
| 58 | } coro_context; |
129 | }; |
| 59 | |
130 | |
| 60 | #define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) |
131 | #define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) |
| 61 | |
132 | |
| 62 | #elif CORO_SJLJ || CORO_LOOSE |
133 | #elif CORO_SJLJ || CORO_LOOSE |
| 63 | |
134 | |
| 64 | #include <setjmp.h> |
135 | #include <setjmp.h> |
| 65 | |
136 | |
| 66 | typedef struct { |
137 | struct coro_context { |
| 67 | jmp_buf env; |
138 | jmp_buf env; |
| 68 | } coro_context; |
139 | }; |
| 69 | |
140 | |
| 70 | #define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1) |
141 | #define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1) |
| 71 | |
142 | |
| 72 | #endif |
143 | #endif |
| 73 | |
144 | |
| 74 | void coro_create(coro_context *ctx, |
|
|
| 75 | coro_func coro, void *arg, |
|
|
| 76 | void *sptr, long ssize); |
|
|
| 77 | |
|
|
| 78 | #endif |
145 | #endif |
| 79 | |
146 | |
