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

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

Diff Legend

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