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

Comparing libcoro/coro.h (file contents):
Revision 1.9 by root, Thu Mar 3 17:20:31 2005 UTC vs.
Revision 1.18 by root, Sun Nov 26 03:19:06 2006 UTC

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

Diff Legend

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