2 * Empire - A multi-player, client/server Internet based war game.
3 * Copyright (C) 1986-2010, 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-2009
35 * Ron Koenderink, 2005-2009
39 * This header defines Empire's abstract thread interface. There are
40 * several concrete implementations.
42 * Empire threads are non-preemptive, i.e. they run until they
43 * voluntarily yield the processor. The thread scheduler then picks
44 * one of the runnable threads. The most common form of yielding the
45 * processor is sleeping for some event to happen.
57 /* Abstract data types */
60 typedef struct lwpProc empth_t;
62 /* A read-write lock, perferring writers */
63 typedef struct lwp_rwlock empth_rwlock_t;
65 /* Flags for empth_select(): whether to sleep on input or output */
66 #define EMPTH_FD_READ LWP_FD_READ
67 #define EMPTH_FD_WRITE LWP_FD_WRITE
69 /* Flags for empth_init() and empth_create() */
70 /* Request debug prints */
71 #define EMPTH_PRINT LWP_PRINT
72 /* Request stack checking */
73 #define EMPTH_STACKCHECK LWP_STACKCHECK
75 #endif /* EMPTH_LWP */
78 #define EMPTH_FD_READ 0x1
79 #define EMPTH_FD_WRITE 0x2
81 #define EMPTH_PRINT 0x1
82 #define EMPTH_STACKCHECK 0x2
84 typedef struct empth_t empth_t;
85 typedef struct empth_rwlock_t empth_rwlock_t;
87 #endif /* EMPTH_POSIX */
90 /* The Windows NT Threads */
91 #define EMPTH_FD_READ 0x1
92 #define EMPTH_FD_WRITE 0x2
94 #define EMPTH_PRINT 0x1
95 #define EMPTH_STACKCHECK 0x2
97 typedef struct loc_Thread empth_t;
98 typedef struct loc_RWLock empth_rwlock_t;
100 void empth_request_shutdown(void);
101 #endif /* EMPTH_W32 */
104 * Initialize thread package.
105 * CTX points to a thread context variable; see empth_create().
106 * FLAGS request optional features.
107 * Should return 0 on success, -1 on error, but currently always
110 int empth_init(void **ctx, int flags);
113 * Create a new thread.
114 * ENTRY is the entry point. It will be called with argument UD.
115 * If it returns, the thread terminates as if it called empth_exit().
116 * Thread stack is at least SIZE bytes.
117 * FLAGS should be the same as were passed to empth_init(), or zero.
118 * NAME is the thread's name, it is used for logging and debugging.
119 * UD is the value to pass to ENTRY. It is also assigned to the
120 * context variable defined with empth_init() whenever the thread gets
122 * Yield the processor.
123 * Return the thread, or NULL on error.
125 empth_t *empth_create(void (*entry)(void *),
126 int size, int flags, char *name, void *ud);
129 * Return the current thread.
131 empth_t *empth_self(void);
134 * Return the name THREAD.
136 char *empth_name(empth_t *thread);
139 * Set the name of THREAD to NAME.
141 void empth_set_name(empth_t *thread, char *name);
144 * Terminate the current thread.
145 * The current thread should not be the thread that executed main().
146 * If it is, implementations may terminate the process rather than the
150 void empth_exit(void);
153 * Yield the processor.
155 void empth_yield(void);
158 * Put current thread to sleep until file descriptor FD is ready for I/O.
159 * If FLAGS & EMPTH_FD_READ, wake up if FD is ready for input.
160 * If FLAGS & EMPTH_FD_WRITE, wake up if FD is ready for output.
161 * At most one thread may sleep on the same file descriptor.
162 * TIMEOUT, if non-null, limits the sleep time.
163 * Return one when the FD is ready, zero on timeout or early wakeup by
164 * empth_wakeup(), -1 on error with errno set.
165 * Note: Currently, Empire sleeps only on network I/O, i.e. FD is a
166 * socket. Implementations should not rely on that.
168 int empth_select(int fd, int flags, struct timeval *timeout);
171 * Awaken THREAD if it is sleeping in empth_select() or empth_sleep().
172 * This does not awaken threads sleeping in other functions.
173 * Does not yield the processor.
175 void empth_wakeup(empth_t *thread);
178 * Put current thread to sleep until the time is UNTIL.
179 * Return 0 if it slept until that time.
180 * Return -1 if woken up early, by empth_wakeup().
182 int empth_sleep(time_t until);
185 * Wait for signal, return the signal number.
187 int empth_wait_for_signal(void);
190 * Create a read-write lock.
191 * NAME is its name, it is used for debugging.
192 * Return the read-write lock, or NULL on error.
194 empth_rwlock_t *empth_rwlock_create(char *name);
199 void empth_rwlock_destroy(empth_rwlock_t *rwlock);
202 * Lock RWLOCK for writing.
203 * A read-write lock can be locked for writing only when it is
204 * unlocked. If this is not the case, put the current thread to sleep
207 void empth_rwlock_wrlock(empth_rwlock_t *rwlock);
210 * Lock RWLOCK for reading.
211 * A read-write lock can be locked for reading only when it is not
212 * locked for writing, and no other thread is attempting to lock it
213 * for writing. If this is not the case, put the current thread to
216 void empth_rwlock_rdlock(empth_rwlock_t *rwlock);
219 * Unlock read-write lock RWLOCK.
220 * The current thread must hold RWLOCK.
221 * Wake up threads that can now lock it.
223 void empth_rwlock_unlock(empth_rwlock_t *rwlock);
227 * Stuff for implementations, not for clients.
230 void empth_init_signals(void);