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

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

Diff Legend

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