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

Comparing libcoro/coro.h (file contents):
Revision 1.6 by root, Sun Sep 16 01:34:36 2001 UTC vs.
Revision 1.12 by root, Sat Aug 20 01:07:45 2005 UTC

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 * VERSION: 0.1
37 */ 36 */
38 37
39#ifndef CORO_H 38#ifndef CORO_H
40#define CORO_H 39#define CORO_H
41 40
41#define CORO_VERSION 2
42
43/*
44 * Changes since API version 1:
45 * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
46 */
47
42/* 48/*
43 * This library consists of only three files 49 * This library consists of only three files
44 * coro.h, coro.c and LICENSE 50 * coro.h, coro.c and LICENSE (and optionally README)
45 * 51 *
46 * It implements what is known as coroutines, in a hopefully 52 * It implements what is known as coroutines, in a hopefully
47 * portable way. At the moment you have to define which kind 53 * portable way. At the moment you have to define which kind
48 * of implementation flavour you want: 54 * of implementation flavour you want:
49 * 55 *
… …
65 * -DCORO_LINUX 71 * -DCORO_LINUX
66 * 72 *
67 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation 73 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation
68 * (very fast). 74 * (very fast).
69 * 75 *
70 * -DCORO_LOOSE 76 * -DCORO_LOSER
71 * 77 *
72 * Microsoft's highly proprietary platform doesn't support sigaltstack, and 78 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
73 * this automatically selects a suitable workaround for this platform. 79 * this automatically selects a suitable workaround for this platform.
74 * (untested) 80 * (untested)
75 * 81 *
76 * -DCORO_IRIX 82 * -DCORO_IRIX
77 * 83 *
78 * SGI's version of Microsoft's NT ;) 84 * SGI's version of Microsoft's NT ;)
79 * 85 *
80 * If you define neither of these symbols, coro.h will try to autodetect 86 * 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 87 * the model. This currently works for CORO_LOSER only. For the other
82 * alternatives you should check (e.g. using autoconf) and define the 88 * alternatives you should check (e.g. using autoconf) and define the
83 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 89 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
84 */ 90 */
85 91
86/* 92/*
… …
101 * and the single pointer value that is given to it as argument. 107 * and the single pointer value that is given to it as argument.
102 * 108 *
103 * Allocating/deallocating the stack is your own responsibility, so there is 109 * Allocating/deallocating the stack is your own responsibility, so there is
104 * no coro_destroy function. 110 * no coro_destroy function.
105 */ 111 */
106void coro_create(coro_context *ctx, 112void coro_create (coro_context *ctx,
107 coro_func coro, void *arg, 113 coro_func coro, void *arg,
108 void *sptr, long ssize); 114 void *sptr, long ssize);
109 115
110/* 116/*
111 * The following prototype defines the coroutine switching function. It is 117 * The following prototype defines the coroutine switching function. It is
112 * usually implemented as a macro, so watch out. 118 * usually implemented as a macro, so watch out.
113 * 119 *
… …
118 * That was it. No other user-visible functions are implemented here. 124 * That was it. No other user-visible functions are implemented here.
119 */ 125 */
120 126
121/*****************************************************************************/ 127/*****************************************************************************/
122 128
123#if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) \ 129#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
124 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ 130 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
125 && !defined(CORO_IRIX) 131 && !defined(CORO_IRIX)
126# if defined(WINDOWS) 132# if defined(WINDOWS)
127# define CORO_LOOSE 1 /* you don't win with windoze */ 133# define CORO_LOSER 1 /* you don't win with windoze */
128# elif defined(__linux) && defined(__x86) 134# elif defined(__linux) && defined(__x86)
129# elif defined(HAVE_UCONTEXT_H) 135# elif defined(HAVE_UCONTEXT_H)
130# define CORO_UCONTEXT 1 136# define CORO_UCONTEXT 1
131# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 137# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
132# define CORO_SJLJ 1 138# define CORO_SJLJ 1
… …
143 149
144struct coro_context { 150struct coro_context {
145 ucontext_t uc; 151 ucontext_t uc;
146}; 152};
147 153
148#define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) 154#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
149 155
150#elif CORO_SJLJ || CORO_LOOSE || CORO_LINUX || CORO_IRIX 156#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
157
158#if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
159# define _GNU_SOURCE // for linux libc
160#endif
151 161
152#include <setjmp.h> 162#include <setjmp.h>
153 163
154struct coro_context { 164struct coro_context {
155 jmp_buf env; 165 jmp_buf env;
156}; 166};
157 167
158#define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1) 168#define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while(0)
159 169
160#endif 170#endif
161 171
162#endif 172#endif
163 173

Diff Legend

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