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

Comparing libcoro/coro.h (file contents):
Revision 1.9 by root, Thu Mar 3 17:20:31 2005 UTC vs.
Revision 1.14 by root, Thu Oct 26 05:20:47 2006 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 */
42
38#ifndef CORO_H 43#ifndef CORO_H
39#define CORO_H 44#define CORO_H
40 45
41#define CORO_VERSION 1 46#define CORO_VERSION 2
47
48/*
49 * Changes since API version 1:
50 * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
51 */
42 52
43/* 53/*
44 * This library consists of only three files 54 * This library consists of only three files
45 * coro.h, coro.c and LICENSE (and optionally README) 55 * coro.h, coro.c and LICENSE (and optionally README)
46 * 56 *
… …
50 * 60 *
51 * -DCORO_UCONTEXT 61 * -DCORO_UCONTEXT
52 * 62 *
53 * This flavour uses SUSv2's get/set/swap/makecontext functions that 63 * This flavour uses SUSv2's get/set/swap/makecontext functions that
54 * unfortunately only newer unices support. 64 * unfortunately only newer unices support.
55 * Use this for GNU/Linux + glibc-2.2.3. 65 * Use this for GNU/Linux + glibc-2.2.3 and possibly higher.
56 * 66 *
57 * -DCORO_SJLJ 67 * -DCORO_SJLJ
58 * 68 *
59 * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to 69 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
60 * do it's job. Coroutine creation is much slower than UCONTEXT, but 70 * 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 71 * 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 72 * 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 73 * do not work with any sane model (neither sigaltstack nor context
64 * functions are implemented) 74 * functions are implemented)
65 * 75 *
66 * -DCORO_LINUX 76 * -DCORO_LINUX
67 * 77 *
68 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation 78 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation
69 * (very fast). 79 * (it is very fast and therefore recommended over other methods).
70 * 80 *
71 * -DCORO_LOOSE 81 * -DCORO_LOSER
72 * 82 *
73 * Microsoft's highly proprietary platform doesn't support sigaltstack, and 83 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
74 * this automatically selects a suitable workaround for this platform. 84 * this automatically selects a suitable workaround for this platform.
75 * (untested) 85 * (untested)
76 * 86 *
77 * -DCORO_IRIX 87 * -DCORO_IRIX
78 * 88 *
79 * SGI's version of Microsoft's NT ;) 89 * SGI's version of Microsoft's NT ;)
80 * 90 *
81 * If you define neither of these symbols, coro.h will try to autodetect 91 * 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 92 * the model. This currently works for CORO_LOSER only. For the other
83 * alternatives you should check (e.g. using autoconf) and define the 93 * alternatives you should check (e.g. using autoconf) and define the
84 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 94 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
85 */ 95 */
86 96
87/* 97/*
… …
96 */ 106 */
97typedef struct coro_context coro_context; 107typedef struct coro_context coro_context;
98 108
99/* 109/*
100 * This function creates a new coroutine. Apart from a pointer to an 110 * This function creates a new coroutine. Apart from a pointer to an
101 * uninitialized coro_context, it expects a pointer to the entry function 111 * uninitialised coro_context, it expects a pointer to the entry function
102 * and the single pointer value that is given to it as argument. 112 * and the single pointer value that is given to it as argument.
103 * 113 *
104 * Allocating/deallocating the stack is your own responsibility, so there is 114 * Allocating/deallocating the stack is your own responsibility, so there is
105 * no coro_destroy function. 115 * no coro_destroy function.
106 */ 116 */
… …
119 * That was it. No other user-visible functions are implemented here. 129 * That was it. No other user-visible functions are implemented here.
120 */ 130 */
121 131
122/*****************************************************************************/ 132/*****************************************************************************/
123 133
124#if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) \ 134#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
125 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ 135 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
126 && !defined(CORO_IRIX) 136 && !defined(CORO_IRIX)
127# if defined(WINDOWS) 137# if defined(WINDOWS)
128# define CORO_LOOSE 1 /* you don't win with windoze */ 138# define CORO_LOSER 1 /* you don't win with windoze */
129# elif defined(__linux) && defined(__x86) 139# elif defined(__linux) && defined(__x86)
130# elif defined(HAVE_UCONTEXT_H) 140# elif defined(HAVE_UCONTEXT_H)
131# define CORO_UCONTEXT 1 141# define CORO_UCONTEXT 1
132# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 142# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
133# define CORO_SJLJ 1 143# define CORO_SJLJ 1
… …
146 ucontext_t uc; 156 ucontext_t uc;
147}; 157};
148 158
149#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) 159#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
150 160
151#elif CORO_SJLJ || CORO_LOOSE || CORO_LINUX || CORO_IRIX 161#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
152 162
153#ifdef CORO_LINUX 163#if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
154# define _GNU_SOURCE // for linux libc 164# define _GNU_SOURCE // for linux libc
155#endif 165#endif
156 166
157#include <setjmp.h> 167#include <setjmp.h>
158 168

Diff Legend

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