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

Comparing libcoro/coro.h (file contents):
Revision 1.2 by root, Mon Jul 23 18:04:59 2001 UTC vs.
Revision 1.10 by root, Mon Mar 21 14:38:14 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 */
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 *
… …
55 * 58 *
56 * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to 59 * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to
57 * do it's job. Coroutine creation is much slower than UCONTEXT, but 60 * 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 61 * 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 62 * 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 63 * do not work with any sane model (neither sigaltstack nor context
61 * are implemented) 64 * functions are implemented)
65 *
66 * -DCORO_LINUX
67 *
68 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation
69 * (very fast).
62 * 70 *
63 * -DCORO_LOOSE 71 * -DCORO_LOOSE
64 * 72 *
65 * Microsoft's highly proprietary platform doesn't support sigaltstack, and 73 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
66 * this automatically selects a suitable workaround for this platform. 74 * this automatically selects a suitable workaround for this platform.
67 * (untested) 75 * (untested)
76 *
77 * -DCORO_IRIX
78 *
79 * SGI's version of Microsoft's NT ;)
68 * 80 *
69 * 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
70 * 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
71 * alternatives you should check (e.g. using autoconf) and define the 83 * alternatives you should check (e.g. using autoconf) and define the
72 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 84 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
73 */ 85 */
74 86
75/* 87/*
76 * 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.
77 */ 89 */
78typedef void (*coro_func)(void *); 90typedef void (*coro_func)(void *);
79
80 91
81/* 92/*
82 * 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
83 * 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,
84 * implement your own switching primitive. 95 * implement your own switching primitive.
… …
91 * 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.
92 * 103 *
93 * Allocating/deallocating the stack is your own responsibility, so there is 104 * Allocating/deallocating the stack is your own responsibility, so there is
94 * no coro_destroy function. 105 * no coro_destroy function.
95 */ 106 */
96void coro_create(coro_context *ctx, 107void coro_create (coro_context *ctx,
97 coro_func coro, void *arg, 108 coro_func coro, void *arg,
98 void *sptr, long ssize); 109 void *sptr, long ssize);
99 110
100/* 111/*
101 * The following prototype defines the coroutine switching function. It is 112 * The following prototype defines the coroutine switching function. It is
102 * usually implemented as a macro, so watch out. 113 * usually implemented as a macro, so watch out.
103 * 114 *
… …
106 117
107/* 118/*
108 * That was it. No other user-visible functions are implemented here. 119 * That was it. No other user-visible functions are implemented here.
109 */ 120 */
110 121
122/*****************************************************************************/
123
111#if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) && !defined(CORO_SJLJ) 124#if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) \
125 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
126 && !defined(CORO_IRIX)
112# if defined(WINDOWS) 127# if defined(WINDOWS)
113# define CORO_LOOSE 1 /* you don't win with windoze */ 128# define CORO_LOOSE 1 /* you don't win with windoze */
129# elif defined(__linux) && defined(__x86)
114# elif defined(HAVE_UCONTEXT_H) 130# elif defined(HAVE_UCONTEXT_H)
115# define CORO_UCONTEXT 1 131# define CORO_UCONTEXT 1
116# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 132# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
117# define CORO_SJLJ 1 133# define CORO_SJLJ 1
118# else 134# else
119error unknown or unsupported architecture 135error unknown or unsupported architecture
120# endif 136# endif
121#endif 137#endif
122 138
139/*****************************************************************************/
140
123#if CORO_UCONTEXT 141#if CORO_UCONTEXT
124 142
125#include <ucontext.h> 143#include <ucontext.h>
126 144
127struct coro_context { 145struct coro_context {
128 ucontext_t uc; 146 ucontext_t uc;
129}; 147};
130 148
131#define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) 149#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
132 150
133#elif CORO_SJLJ || CORO_LOOSE 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
134 156
135#include <setjmp.h> 157#include <setjmp.h>
136 158
137struct coro_context { 159struct coro_context {
138 jmp_buf env; 160 jmp_buf env;
139}; 161};
140 162
141#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)
142 164
143#endif 165#endif
144 166
145#endif 167#endif
146 168

Diff Legend

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