[ViewVC] Diff of: cvs/libcoro/coro.h

Comparing libcoro/coro.h (file contents):
Revision 1.4 by root, Tue Jul 24 20:18:12 2001 UTC vs.
Revision 1.19 by root, Thu Nov 30 18:21:14 2006 UTC

 /*
- * Copyright (c) 2001 Marc Alexander Lehmann <pcg@goof.com>
+ * Copyright (c) 2001-2006 Marc Alexander Lehmann <schmorp@schmorp.de>
  *
  * Redistribution and use in source and binary forms, with or without modifica-
  * tion, are permitted provided that the following conditions are met:
  *
  *   1.  Redistributions of source code must retain the above copyright notice,
  * This library is modelled strictly after Ralf S. Engelschalls article at
  * http://www.gnu.org/software/pth/rse-pmt.ps.  So most of the credit must
  * go to Ralf S. Engelschall <rse@engelschall.com>.
  *
  * This coroutine library is very much stripped down. You should either
- * build your own process avstraction using it or - better - just use GNU
+ * build your own process abstraction using it or - better - just use GNU
  * Portable Threads, http://www.gnu.org/software/pth/.
  *
- * VERSION: 0.1
+ */
+/*
+ * 2006-10-26 Include stddef.h on OS X to work around one of its bugs.
+ *            Reported by Michael_G_Schwern.
+ * 2006-11-26 Use _setjmp instead of setjmp on GNU/Linux.
  */
 #ifndef CORO_H
 #define CORO_H
+#define CORO_VERSION 2
+/*
+ * Changes since API version 1:
+ * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
+ */
 /*
  * This library consists of only three files
- * coro.h, coro.c and LICENSE
+ * coro.h, coro.c and LICENSE (and optionally README)
  *
  * It implements what is known as coroutines, in a hopefully
  * portable way. At the moment you have to define which kind
  * of implementation flavour you want:
  *
  * -DCORO_UCONTEXT
  *
  *    This flavour uses SUSv2's get/set/swap/makecontext functions that
  *    unfortunately only newer unices support.
- *    Use this for GNU/Linux + glibc-2.2.3.
+ *    Use this for GNU/Linux + glibc-2.2.3 and possibly higher.
  *
  * -DCORO_SJLJ
  *
- *    This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to
+ *    This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
  *    do it's job. Coroutine creation is much slower than UCONTEXT, but
  *    context switching is often a bit cheaper. It should work on almost
  *    all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below
  *    do not work with any sane model (neither sigaltstack nor context
  *    functions are implemented)
  *
  * -DCORO_LINUX
  *
  *    Old GNU/Linux systems (<= glibc-2.1) work with this implementation
- *    (very fast).
+ *    (it is very fast and therefore recommended over other methods).
  *
- * -DCORO_LOOSE
+ * -DCORO_LOSER
  *
  *    Microsoft's highly proprietary platform doesn't support sigaltstack, and
  *    this automatically selects a suitable workaround for this platform.
  *    (untested)
  *
+ * -DCORO_IRIX
+ *
+ *    SGI's version of Microsoft's NT ;)
+ *
  * If you define neither of these symbols, coro.h will try to autodetect
- * the model.  This currently works for CORO_LOOSE only. For the other
+ * the model.  This currently works for CORO_LOSER only. For the other
  * alternatives you should check (e.g. using autoconf) and define the
  * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
  */
 /*
- * This is the type for the top function of a new coroutine.
+ * This is the type for the initialization function of a new coroutine.
  */
 typedef void (*coro_func)(void *);
 /*
- * A coroutine state is saved in the following structure. Treat it as a
+ * A coroutine state is saved in the following structure. Treat it as an
  * opaque type. errno and sigmask might be saved, but don't rely on it,
- * implement your own switching primitive.
+ * implement your own switching primitive if you need that.
  */
 typedef struct coro_context coro_context;
 /*
  * This function creates a new coroutine. Apart from a pointer to an
- * uninitialized coro_context, it expects a pointer to the entry function
+ * uninitialised coro_context, it expects a pointer to the entry function
  * and the single pointer value that is given to it as argument.
  *
  * Allocating/deallocating the stack is your own responsibility, so there is
  * no coro_destroy function.
  */
-void coro_create(coro_context *ctx,
+void coro_create (coro_context *ctx, /* an uninitialised coro_context */
-                 coro_func coro, void *arg,
+                  coro_func coro,    /* the coroutine code to be executed */
-                 void *sptr, long ssize);
+                  void *arg,         /* a single pointer passed to the coro */
+                  void *sptr,        /* start of stack area */
+                  long ssize);       /* size of stack area */
 /*
  * The following prototype defines the coroutine switching function. It is
  * usually implemented as a macro, so watch out.
  *
 /*
  * That was it. No other user-visible functions are implemented here.
  */
+/*****************************************************************************/
-#if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) \
+#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
-    && !defined(CORO_SJLJ) && !defined(CORO_LINUX)
+    && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
+    && !defined(CORO_IRIX)
 # if defined(WINDOWS)
-#  define CORO_LOOSE 1 /* you don't win with windoze */
+#  define CORO_LOSER 1 /* you don't win with windoze */
 # elif defined(__linux) && defined(__x86)
 # elif defined(HAVE_UCONTEXT_H)
 #  define CORO_UCONTEXT 1
 # elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
 #  define CORO_SJLJ 1
 # else
 error unknown or unsupported architecture
 # endif
 #endif
+/*****************************************************************************/
 #if CORO_UCONTEXT
 #include <ucontext.h>
 struct coro_context {
   ucontext_t uc;
 };
-#define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc))
+#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
-#elif CORO_SJLJ || CORO_LOOSE || CORO_LINUX
+#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
+#if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
+# define _GNU_SOURCE /* for linux libc */
+#endif
 #include <setjmp.h>
 struct coro_context {
   jmp_buf env;
 };
+#if CORO_LINUX
-#define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1)
+# define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0)
+#else
+# define coro_transfer(p,n) do { if (!setjmp  ((p)->env)) longjmp  ((n)->env, 1); } while (0)
+#endif
 #endif
 #endif

Diff Legend

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

Comparing libcoro/coro.h (file contents): Revision 1.4 by root, Tue Jul 24 20:18:12 2001 UTC vs. Revision 1.19 by root, Thu Nov 30 18:21:14 2006 UTC

Diff Legend

Comparing libcoro/coro.h (file contents):
Revision 1.4 by root, Tue Jul 24 20:18:12 2001 UTC vs.
Revision 1.19 by root, Thu Nov 30 18:21:14 2006 UTC