]> git.pond.sub.org Git - empserver/blob - src/lib/lwp/lwpint.h
Streamline copyright notices. Clearly document Stephen Crane's in
[empserver] / src / lib / lwp / lwpint.h
1 /*
2  *  Empire - A multi-player, client/server Internet based war game.
3  *  Copyright (C) 1994-2006, Dave Pare, Jeff Bailey, Thomas Ruschak,
4  *                           Ken Stevens, Steve McClure
5  *  Copyright (C) 1991-3 Stephen Crane
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; either version 2 of the License, or
10  *  (at your option) any later version.
11  *
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program; if not, write to the Free Software
19  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  *
21  *  ---
22  *
23  *  See the "LEGAL", "LICENSE", "CREDITS" and "README" files for all the
24  *  related information and legal notices. It is expected that any future
25  *  projects/authors will amend these files as needed.
26  *
27  *  ---
28  *
29  *  lwpint.h: lwp internal structures
30  * 
31  *  Known contributors to this file:
32  *     Markus Armbruster, 2004-2006
33  */
34
35 #ifndef LWPINT_H
36 #define LWPINT_H
37
38 #ifdef UCONTEXT
39 #include <ucontext.h>
40 #else  /* !UCONTEXT */
41 #include <setjmp.h>
42 #endif /* !UCONTEXT */
43
44 /* `liveness' counter: check signals every `n' visits to the scheduler */
45 /* note: the lower this value, the more responsive the system but the */
46 /* more inefficient the context switch time */
47 #define LCOUNT  -1
48
49 /* process control block.  do *not* change the position of context */
50 struct lwpProc {
51 #ifdef UCONTEXT
52     ucontext_t context;         /* context structure */
53 #else  /* !UCONTEXT */
54     jmp_buf context;            /* processor context area */
55 #endif /* !UCONTEXT */
56     void *sbtm;                 /* stack buffer attached to it */
57     int size;                   /* size of stack buffer */
58     char *ustack;               /* lowest usable stack address */
59     int usize;                  /* size of usable stack */
60     void (*entry)(void *);      /* entry point */
61     int dead;                   /* whether the process can be rescheduled */
62     int pri;                    /* which scheduling queue we're on */
63     long runtime;               /* time at which process is restarted */
64     int fd;                     /* fd we're blocking on */
65     int argc;                   /* initial arguments */
66     char **argv;
67     void *ud;                   /* user data */
68     char *name;                 /* process name and description */
69     char *desc;
70     int flags;
71     struct lwpProc *next;
72 };
73
74 /* queue */
75 struct lwpQueue {
76     struct lwpProc *head;
77     struct lwpProc *tail;
78 };
79
80 /* semaphore */
81 struct lwpSem {
82     int count;
83     struct lwpQueue q;
84     char *name;
85 };
86
87 #define LWP_REDZONE     1024    /* make this a multiple of 1024 */
88
89 /* XXX Note that this assumes sizeof(long) == 4 */
90 #define LWP_CHECKMARK   0x5a5a5a5aL
91
92 extern int LwpStackGrowsDown;
93
94 int lwpNewContext(struct lwpProc *, int);
95 void lwpSwitchContext(struct lwpProc *, struct lwpProc *);
96 void lwpAddTail(struct lwpQueue *, struct lwpProc *);
97 struct lwpProc *lwpGetFirst(struct lwpQueue *);
98 void lwpReady(struct lwpProc *);
99 void lwpReschedule(void);
100 void lwpEntryPoint(void);
101 void lwpInitSelect(struct lwpProc * self);
102 void lwpDestroy(struct lwpProc * proc);
103
104 #endif