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

Comparing libcoro/coro.h (file contents):
Revision 1.10 by root, Mon Mar 21 14:38:14 2005 UTC vs.
Revision 1.20 by root, Fri Apr 27 19:26:18 2007 UTC

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

Diff Legend

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