2 * Empire - A multi-player, client/server Internet based war game.
3 * Copyright (C) 1986-2006, Dave Pare, Jeff Bailey, Thomas Ruschak,
4 * Ken Stevens, Steve McClure
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.
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.
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
22 * See files README, COPYING and CREDITS in the root of the source
23 * tree for related information and legal notices. It is expected
24 * that future projects/authors will amend these files as needed.
28 * empthread.h: Definitions for Empire threading
30 * Known contributors to this file:
34 * Markus Armbruster, 2005
38 * This header defines Empire's abstract thread interface. There are
39 * several concrete implementations.
41 * Empire threads are non-preemptive, i.e. they run until they
42 * voluntarily yield the processor. The thread scheduler then picks
43 * one of the runnable threads with the highest priority. Priorities
44 * are static. Empire code relies on these properties heavily. The
45 * most common form of yielding the processor is sleeping for some
52 /* thread priorities */
67 /* Abstract data types */
69 /* empth_t * represents a thread. */
70 typedef struct lwpProc empth_t;
72 /* empth_sem_t * represents a semaphore */
73 typedef struct lwpSem empth_sem_t;
75 /* Flags for empth_select(): whether to sleep on input or output */
76 #define EMPTH_FD_READ LWP_FD_READ
77 #define EMPTH_FD_WRITE LWP_FD_WRITE
79 /* Flags for empth_init() and empth_create() */
80 /* Request debug prints */
81 #define EMPTH_PRINT LWP_PRINT
82 /* Request stack checking */
83 #define EMPTH_STACKCHECK LWP_STACKCHECK
85 #endif /* EMPTH_LWP */
89 #define EMPTH_FD_READ 0x1
90 #define EMPTH_FD_WRITE 0x2
92 #define EMPTH_PRINT 0x1
93 #define EMPTH_STACKCHECK 0x2
95 typedef struct empth_t empth_t;
96 typedef struct empth_sem_t empth_sem_t;
98 #endif /* EMPTH_POSIX */
101 /* The Windows NT Threads */
102 #define EMPTH_FD_READ 0x1
103 #define EMPTH_FD_WRITE 0x2
105 #define EMPTH_PRINT 0x1
106 #define EMPTH_STACKCHECK 0x2
108 typedef struct loc_Thread_t empth_t;
109 typedef struct loc_Sem_t empth_sem_t;
111 void empth_request_shutdown(void);
112 #endif /* EMPTH_W32 */
115 * Initialize thread package.
116 * CTX points to a thread context variable; see empth_create().
117 * FLAGS request optional features.
118 * Should return 0 on success, -1 on error, but currently always
121 int empth_init(void **ctx, int flags);
124 * Create a new thread.
125 * PRIO is the scheduling priority.
126 * ENTRY is the entry point. It will be called with argument UD.
127 * Thread stack is at least SIZE bytes.
128 * FLAGS should be the same as were passed to empth_init(), or zero.
129 * NAME is the threads name, and DESC its description. These are used
130 * for logging and debugging.
131 * UD is the value to pass to ENTRY. It is also assigned to the
132 * context variable defined with empth_init() whenever the thread gets
134 * Yield the processor.
135 * Return the thread, or NULL on error.
137 empth_t *empth_create(int prio, void (*entry)(void *),
138 int size, int flags, char *name, char *desc, void *ud);
141 * Return the current thread.
143 empth_t *empth_self(void);
146 * Terminate the current thread.
147 * The current thread should not be the thread that executed main().
148 * If it is, implementations may terminate the process rather than the
152 void empth_exit(void);
155 * Yield the processor.
157 void empth_yield(void);
161 * THREAD will not be scheduled again. Instead, it will terminate as
162 * if it executed empth_exit(). It is unspecified when exactly that
164 * THREAD must not be the current thread.
166 void empth_terminate(empth_t *thread);
169 * Put current thread to sleep until file descriptor FD is ready for I/O.
170 * If FLAGS & EMPTH_FD_READ, wake up if FD is ready for input.
171 * If FLAGS & EMPTH_FD_WRITE, wake up if FD is ready for output.
172 * At most one thread may sleep on the same file descriptor.
173 * Note: Currently, Empire sleeps only on network I/O, i.e. FD is a
174 * socket. Implementations should not rely on that.
176 void empth_select(int fd, int flags);
179 * Awaken THREAD if it is sleeping in empth_select().
180 * Note: This must not awaken threads sleeping in other functions.
182 void empth_wakeup(empth_t *thread);
185 * Put current thread to sleep until the time is UNTIL.
186 * May sleep somehwat longer, but never shorter.
188 void empth_sleep(time_t until);
191 * Wait for some implementation-defined external shutdown signal.
192 * Return a non-negative number identifying the signal.
194 int empth_wait_for_shutdown(void);
197 * Create a semaphore.
198 * NAME is its name, it is used for debugging.
199 * COUNT is the initial count value of the semaphore, it must not be
201 * Return the semaphore, or NULL on error.
203 empth_sem_t *empth_sem_create(char *name, int count);
207 * Increase SEM's count. If threads are sleeping on it, wake up
208 * exactly one of them. If that thread has a higher priority, yield
210 * This semaphore operation is often called `down' or `V' otherwhere.
212 void empth_sem_signal(empth_sem_t *sem);
216 * If SEM has a zero count, put current thread to sleep until
217 * empth_sem_signal() awakens it. SEM will have non-zero value then.
218 * Decrement SEM's count.
219 * This semaphore operation is often called `up' or `P' otherwhere.
221 void empth_sem_wait(empth_sem_t *sem);
225 * Stuff for implementations, not for clients.
228 void empth_init_signals(void);