git.pond.sub.org Git - empserver/blob - include/empthread.h

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2005, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                           Ken Stevens, Steve McClure
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  *  ---
  21  *
  22  *  See the "LEGAL", "LICENSE", "CREDITS" and "README" files for all the
  23  *  related information and legal notices. It is expected that any future
  24  *  projects/authors will amend these files as needed.
  25  *
  26  *  ---
  27  *
  28  *  empthread.h: Definitions for Empire threading
  29  *
  30  *  Known contributors to this file:
  31  *     Sasha Mikheev
  32  *     Doug Hay, 1998
  33  *     Steve McClure, 1998
  34  */
  35
  36 /*
  37  * This header defines Empire's abstract thread interface.  There are
  38  * several concrete implementations.
  39  *
  40  * Empire threads are non-preemptive, i.e. they run until they
  41  * voluntarily yield the processor.  The thread scheduler then picks
  42  * one of the runnable threads with the highest priority.  Priorities
  43  * are static.  Empire code relies on these properties heavily.  The
  44  * most common form of yielding the processor is sleeping for some
  45  * event to happen.
  46  */
  47
  48 #ifndef _EMTHREAD_H_
  49 #define _EMTHREAD_H_
  50
  51 #include "misc.h"
  52
  53 #if defined(_WIN32)
  54 #undef _EMPTH_LWP
  55 #undef _EMPTH_POSIX
  56 #define _EMPTH_WIN32
  57 #endif
  58
  59 #ifdef _EMPTH_LWP
  60 #include "lwp.h"
  61
  62 /* Abstract data types */
  63
  64 /* empth_t * represents a thread.  */
  65 typedef struct lwpProc empth_t;
  66
  67 /* empth_sem_t * represents a semaphore */
  68 typedef struct lwpSem empth_sem_t;
  69
  70 /* Flags for empth_select(): whether to sleep on input or output */
  71 #define EMPTH_FD_READ     LWP_FD_READ
  72 #define EMPTH_FD_WRITE    LWP_FD_WRITE
  73
  74 /* Flags for empth_init() and empth_create() */
  75 /* Request debug prints */
  76 #define EMPTH_PRINT       LWP_PRINT
  77 /* Request stack checking */
  78 #define EMPTH_STACKCHECK  LWP_STACKCHECK
  79
  80 #endif /* _EMPTH_LWP */
  81
  82 #ifdef _EMPTH_POSIX
  83 #include <pthread.h>
  84 #define EMPTH_FD_READ   0x1
  85 #define EMPTH_FD_WRITE  0x2
  86
  87 #define EMPTH_PRINT       0x1
  88 #define EMPTH_STACKCHECK  0x2
  89
  90 typedef struct empth_t empth_t;
  91 typedef struct empth_sem_t empth_sem_t;
  92
  93 #endif /* _EMPTH_POSIX */
  94
  95 #if defined(_EMPTH_WIN32)
  96 /* The Windows NT Threads */
  97 #define EMPTH_FD_READ   0x1
  98 #define EMPTH_FD_WRITE  0x2
  99
 100 #define EMPTH_PRINT       0x1
 101 #define EMPTH_STACKCHECK  0x2
 102
 103 typedef struct loc_Thread_t empth_t;
 104 typedef struct loc_Sem_t empth_sem_t;
 105
 106 void empth_request_shutdown(void);
 107 #endif /* _EMPTH_WIN32 */
 108
 109 /*
 110  * Initialize thread package.
 111  * CTX points to a thread context variable; see empth_create().
 112  * FLAGS request optional features.
 113  * Should return 0 on success, -1 on error, but currently always
 114  * returns 0.
 115  */
 116 int empth_init(void **ctx, int flags);
 117
 118 /*
 119  * Create a new thread.
 120  * PRIO is the scheduling priority.
 121  * ENTRY is the entry point.  It will be called with argument UD.
 122  * Thread stack is at least SIZE bytes.
 123  * FLAGS should be the same as were passed to empth_init(), or zero.
 124  * NAME is the threads name, and DESC its description.  These are used
 125  * for logging and debugging.
 126  * UD is the value to pass to ENTRY.  It is also assigned to the
 127  * context variable defined with empth_init() whenever the thread gets
 128  * scheduled.
 129  * Return the thread, or NULL on error.
 130  */
 131 empth_t *empth_create(int prio, void (*entry)(void *),
 132                       int size, int flags, char *name, char *desc, void *ud);
 133
 134 /*
 135  * Return the current thread.
 136  */
 137 empth_t *empth_self(void);
 138
 139 /*
 140  * Terminate the current thread.
 141  * Never returns.
 142  */
 143 void empth_exit(void);
 144
 145 /*
 146  * Yield the processor.
 147  */
 148 void empth_yield(void);
 149
 150 /*
 151  * Terminate THREAD.
 152  * THREAD will not be scheduled again.  Instead, it will terminate as
 153  * if it executed empth_exit().  It is unspecified when exactly that
 154  * happens.
 155  * THREAD must not be the current thread.
 156  */
 157 void empth_terminate(empth_t *thread);
 158
 159 /*
 160  * Put current thread to sleep until file descriptor FD is ready for I/O.
 161  * If FLAGS & EMPTH_FD_READ, wake up if FD is ready for input.
 162  * If FLAGS & EMPTH_FD_WRITE, wake up if FD is ready for output.
 163  * At most one thread may sleep on the same file descriptor.
 164  * Note: Currently, Empire sleeps only on network I/O, i.e. FD is a
 165  * socket.  Implementations should not rely on that.
 166  */
 167 void empth_select(int fd, int flags);
 168
 169 /*
 170  * Awaken THREAD if it is sleeping in empth_select().
 171  * Note: This must not awaken threads sleeping in other functions.
 172  */
 173 void empth_wakeup(empth_t *thread);
 174
 175 /*
 176  * Put current thread to sleep until the time is UNTIL.
 177  * May sleep somehwat longer, but never shorter.
 178  */
 179 void empth_sleep(time_t until);
 180
 181 /*
 182  * Create a semaphore.
 183  * NAME is its name, it is used for debugging.
 184  * COUNT is the initial count value of the semaphore, it must not be
 185  * negative.
 186  * Return the semaphore, or NULL on error.
 187  */
 188 empth_sem_t *empth_sem_create(char *name, int count);
 189
 190 /*
 191  * Signal SEM.
 192  * Increase SEM's count.  If threads are sleeping on it, wake up
 193  * exactly one of them.  If that thread has a higher priority, yield
 194  * the processor.
 195  * This semaphore operation is often called `down' or `V' otherwhere.
 196  */
 197 void empth_sem_signal(empth_sem_t *sem);
 198
 199 /*
 200  * Wait for SEM.
 201  * If SEM has a zero count, put current thread to sleep until
 202  * empth_sem_signal() awakens it.  SEM will have non-zero value then.
 203  * Decrement SEM's count.
 204  * This semaphore operation is often called `up' or `P' otherwhere.
 205  */
 206 void empth_sem_wait(empth_sem_t *sem);
 207
 208 #endif