libguile/coop-threads.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_COOP_THREADS_H
   4 #define SCM_COOP_THREADS_H
   5
   6 /* Copyright (C) 1996,1997,1998,2000 Free Software Foundation, Inc.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2, or (at your option)
  11  * any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this software; see the file COPYING.  If not, write to
  20  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  21  * Boston, MA 02111-1307 USA
  22  *
  23  * As a special exception, the Free Software Foundation gives permission
  24  * for additional uses of the text contained in its release of GUILE.
  25  *
  26  * The exception is that, if you link the GUILE library with other files
  27  * to produce an executable, this does not by itself cause the
  28  * resulting executable to be covered by the GNU General Public License.
  29  * Your use of that executable is in no way restricted on account of
  30  * linking the GUILE library code into it.
  31  *
  32  * This exception does not however invalidate any other reasons why
  33  * the executable file might be covered by the GNU General Public License.
  34  *
  35  * This exception applies only to the code released by the
  36  * Free Software Foundation under the name GUILE.  If you copy
  37  * code from other Free Software Foundation releases into a copy of
  38  * GUILE, as the General Public License permits, the exception does
  39  * not apply to the code that you add in this way.  To avoid misleading
  40  * anyone as to the status of such modified files, you must delete
  41  * this exception notice from them.
  42  *
  43  * If you write modifications of your own for GUILE, it is your choice
  44  * whether to permit this exception to apply to your modifications.
  45  * If you do not wish that, delete this exception notice.  */
  46
  47 \f
  48
  49 /* This file is only included by coop-threads.c while coop-defs.h is
  50    included by threads.h, which, in turn, is included by
  51    libguile.h. */
  52
  53 /* The coop_t struct is declared in coop-defs.h. */
  54
  55 #include "libguile/__scm.h"
  56
  57 #include <time.h>
  58
  59 #include "libguile/coop-defs.h"
  60 #include "qt/qt.h"
  61
  62 /* This code is based on a sample thread libraru by David Keppel.
  63    Portions of this file fall under the following copyright: */
  64
  65 /*
  66  * QuickThreads -- Threads-building toolkit.
  67  * Copyright (c) 1993 by David Keppel
  68  *
  69  * Permission to use, copy, modify and distribute this software and
  70  * its documentation for any purpose and without fee is hereby
  71  * granted, provided that the above copyright notice and this notice
  72  * appear in all copies.  This software is provided as a
  73  * proof-of-concept and for demonstration purposes; there is no
  74  * representation about the suitability of this software for any
  75  * purpose.
  76  */
  77
  78 /* Each thread starts by calling a user-supplied function of this
  79    type. */
  80
  81 typedef void (coop_userf_t)(void *p0);
  82
  83 /* Call this before any other primitives. */
  84 SCM_API void coop_init (void);
  85
  86 /* When one or more threads are created by the main thread,
  87    the system goes multithread when this is called.  It is done
  88    (no more runable threads) when this returns. */
  89
  90 SCM_API void coop_start (void);
  91
  92 /* Create a thread and make it runable.  When the thread starts
  93    running it will call `f' with arguments `p0' and `p1'. */
  94
  95 SCM_API coop_t *coop_create (coop_userf_t *f, void *p0);
  96
  97 /* The current thread stops running but stays runable.
  98    It is an error to call `coop_yield' before `coop_start'
  99    is called or after `coop_start' returns. */
 100
 101 SCM_API void coop_yield (void);
 102
 103 /* Like `coop_yield' but the thread is discarded.  Any intermediate
 104    state is lost.  The thread can also terminate by simply
 105    returning. */
 106
 107 SCM_API void coop_abort (void);
 108
 109 /* The following are needed in iselect.c */
 110
 111 SCM_API coop_t *coop_qget (coop_q_t *);
 112 SCM_API void coop_qput (coop_q_t *, coop_t *);
 113 SCM_API void *coop_sleephelp (qt_t *, void *, void *);
 114
 115 #ifdef GUILE_ISELECT
 116 SCM_API coop_t *coop_wait_for_runnable_thread ();
 117 #endif
 118
 119 SCM_API coop_q_t coop_global_runq;      /* A queue of runable threads. */
 120 SCM_API coop_q_t coop_global_sleepq;
 121 SCM_API coop_q_t coop_tmp_queue;
 122 SCM_API coop_q_t coop_global_allq;      /* A queue of all threads. */
 123 SCM_API coop_t *coop_global_curr;               /* Currently-executing thread. */
 124
 125 #endif  /* SCM_COOP_THREADS_H */
 126
 127 /*
 128   Local Variables:
 129   c-file-style: "gnu"
 130   End:
 131 */