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.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
43/*
44 * This library consists of only three files
45 * coro.h, coro.c and LICENSE (and optionally README)
46 *
47 * It implements what is known as coroutines, in a hopefully
48 * portable way. At the moment you have to define which kind
49 * of implementation flavour you want:
50 *
51 * -DCORO_UCONTEXT
52 *
53 * This flavour uses SUSv2's get/set/swap/makecontext functions that
54 * unfortunately only newer unices support.
55 * Use this for GNU/Linux + glibc-2.2.3.
56 *
57 * -DCORO_SJLJ
58 *
59 * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to
60 * 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
62 * 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
64 * functions are implemented)
65 *
66 * -DCORO_LINUX
67 *
68 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation
69 * (very fast).
70 *
71 * -DCORO_LOOSE
72 *
73 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
74 * this automatically selects a suitable workaround for this platform.
75 * (untested)
76 *
77 * -DCORO_IRIX
78 *
79 * SGI's version of Microsoft's NT ;)
80 *
81 * 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
83 * alternatives you should check (e.g. using autoconf) and define the
84 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
85 */
86
87/*
88 * This is the type for the initialization function of a new coroutine.
89 */
40typedef void (*coro_func)(void *); 90typedef void (*coro_func)(void *);
41 91
92/*
93 * 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,
95 * implement your own switching primitive.
96 */
97typedef struct coro_context coro_context;
98
99/*
100 * This function creates a new coroutine. Apart from a pointer to an
101 * uninitialized coro_context, it expects a pointer to the entry function
102 * and the single pointer value that is given to it as argument.
103 *
104 * Allocating/deallocating the stack is your own responsibility, so there is
105 * no coro_destroy function.
106 */
107void coro_create (coro_context *ctx,
108 coro_func coro, void *arg,
109 void *sptr, long ssize);
110
111/*
112 * The following prototype defines the coroutine switching function. It is
113 * usually implemented as a macro, so watch out.
114 *
115void coro_transfer(coro_context *prev, coro_context *next);
116 */
117
118/*
119 * That was it. No other user-visible functions are implemented here.
120 */
121
122/*****************************************************************************/
123
124#if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) \
125 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
126 && !defined(CORO_IRIX)
42#if defined(WINDOWS) 127# if defined(WINDOWS)
43# 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)
44#elif defined(HAVE_UCONTEXT_H) 130# elif defined(HAVE_UCONTEXT_H)
45# define CORO_UCONTEXT 1 131# define CORO_UCONTEXT 1
46#elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 132# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
47# define CORO_SJLJ 1 133# define CORO_SJLJ 1
48#else 134# else
49error unknown or unsupported architecture 135error unknown or unsupported architecture
136# endif
50#endif 137#endif
138
139/*****************************************************************************/
51 140
52#if CORO_UCONTEXT 141#if CORO_UCONTEXT
53 142
54#include <ucontext.h> 143#include <ucontext.h>
55 144
56typedef struct { 145struct coro_context {
57 ucontext_t uc; 146 ucontext_t uc;
58} coro_context; 147};
59 148
60#define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) 149#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
61 150
62#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
63 156
64#include <setjmp.h> 157#include <setjmp.h>
65 158
66typedef struct { 159struct coro_context {
67 jmp_buf env; 160 jmp_buf env;
68} coro_context; 161};
69 162
70#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)
71 164
72#endif 165#endif
73 166
74void coro_create(coro_context *ctx,
75 coro_func coro, void *arg,
76 void *sptr, long ssize);
77
78#endif 167#endif
79 168

Diff Legend

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