Change sendfile() to use the new m_ext callback scheme for cleaning up after
[dragonfly.git] / sys / sys / thread.h
CommitLineData
2df9fa87
MD
1/*
2 * SYS/THREAD.H
3 *
4 * Implements the architecture independant portion of the LWKT
5 * subsystem.
05220613
MD
6 *
7 * Types which must already be defined when this header is included by
8 * userland: struct md_thread
2df9fa87 9 *
f470d0c8 10 * $DragonFly: src/sys/sys/thread.h,v 1.57 2004/07/29 08:55:02 dillon Exp $
2df9fa87
MD
11 */
12
13#ifndef _SYS_THREAD_H_
14#define _SYS_THREAD_H_
15
05220613
MD
16#ifndef _SYS_STDINT_H_
17#include <sys/stdint.h> /* __int types */
18#endif
19#ifndef _SYS_PARAM_H_
20#include <sys/param.h> /* MAXCOMLEN */
21#endif
8a8d5d85
MD
22#ifndef _SYS_QUEUE_H_
23#include <sys/queue.h> /* TAILQ_* macros */
24#endif
05220613
MD
25#ifndef _SYS_MSGPORT_H_
26#include <sys/msgport.h> /* lwkt_port */
27#endif
41f3429e
HP
28#ifndef _SYS_TIME_H_
29#include <sys/time.h> /* struct timeval */
30#endif
8a8d5d85 31
f1d1c3fa 32struct globaldata;
2df9fa87
MD
33struct proc;
34struct thread;
f1d1c3fa
MD
35struct lwkt_queue;
36struct lwkt_token;
41a01a4d 37struct lwkt_tokref;
f1d1c3fa 38struct lwkt_wait;
96728c05 39struct lwkt_ipiq;
f1d1c3fa
MD
40struct lwkt_cpu_msg;
41struct lwkt_cpu_port;
42struct lwkt_rwlock;
ece04fd0
MD
43struct lwkt_msg;
44struct lwkt_port;
3b6b7bd1 45struct lwkt_cpusync;
4fd10eb6 46union sysunion;
f1d1c3fa
MD
47
48typedef struct lwkt_queue *lwkt_queue_t;
49typedef struct lwkt_token *lwkt_token_t;
41a01a4d 50typedef struct lwkt_tokref *lwkt_tokref_t;
f1d1c3fa 51typedef struct lwkt_wait *lwkt_wait_t;
f1d1c3fa
MD
52typedef struct lwkt_cpu_msg *lwkt_cpu_msg_t;
53typedef struct lwkt_cpu_port *lwkt_cpu_port_t;
54typedef struct lwkt_rwlock *lwkt_rwlock_t;
96728c05 55typedef struct lwkt_ipiq *lwkt_ipiq_t;
3b6b7bd1 56typedef struct lwkt_cpusync *lwkt_cpusync_t;
f1d1c3fa
MD
57typedef struct thread *thread_t;
58
59typedef TAILQ_HEAD(lwkt_queue, thread) lwkt_queue;
f1d1c3fa 60
05220613
MD
61/*
62 * Differentiation between kernel threads and user threads. Userland
63 * programs which want to access to kernel structures have to define
64 * _KERNEL_STRUCTURES. This is a kinda safety valve to prevent badly
65 * written user programs from getting an LWKT thread that is neither the
66 * kernel nor the user version.
67 */
68#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
85100692
MD
69#ifndef _MACHINE_THREAD_H_
70#include <machine/thread.h> /* md_thread */
71#endif
88c4d2f6
MD
72#ifndef _MACHINE_FRAME_H_
73#include <machine/frame.h>
74#endif
75#else
76struct intrframe;
ece04fd0 77#endif
f1d1c3fa
MD
78
79/*
41a01a4d
MD
80 * Tokens are used to serialize access to information. They are 'soft'
81 * serialization entities that only stay in effect while the thread is
82 * running. If the thread blocks, other threads can run holding the same
83 * tokens. The tokens are reacquired when the original thread resumes.
84 *
85 * A thread can depend on its serialization remaining intact through a
86 * preemption. An interrupt which attempts to use the same token as the
87 * thread being preempted will reschedule itself for non-preemptive
88 * operation, so the new token code is capable of interlocking against
89 * interrupts as well as other cpus.
90 *
91 * Tokens are managed through a helper reference structure, lwkt_tokref,
92 * which is typically declared on the caller's stack. Multiple tokref's
93 * may reference the same token.
f1d1c3fa
MD
94 */
95typedef struct lwkt_token {
41a01a4d
MD
96 struct globaldata *t_cpu; /* the current owner of the token */
97 struct globaldata *t_reqcpu; /* requesting cpu */
98 int t_unused01; /* (used to be generation number) */
f1d1c3fa
MD
99} lwkt_token;
100
41a01a4d
MD
101typedef struct lwkt_tokref {
102 lwkt_token_t tr_tok; /* token in question */
103 __uint32_t tr_magic; /* sanity check */
104 lwkt_tokref_t tr_next; /* linked list */
105 lwkt_tokref_t tr_gdreqnext; /* based at gd_tokreqbase */
106 struct globaldata *tr_reqgd; /* requesting cpu */
107} lwkt_tokref;
108
109#define LWKT_TOKREF_MAGIC1 \
110 ((__uint32_t)0x544f4b52) /* normal */
111#define LWKT_TOKREF_MAGIC2 \
112 ((__uint32_t)0x544f4b53) /* pending req */
113#define LWKT_TOKREF_INIT(tok) \
114 { tok, LWKT_TOKREF_MAGIC1 }
115#define LWKT_TOKREF_DECLARE(name, tok) \
116 lwkt_tokref name = LWKT_TOKREF_INIT(tok)
117
f1d1c3fa
MD
118/*
119 * Wait structures deal with blocked threads. Due to the way remote cpus
120 * interact with these structures stable storage must be used.
121 */
122typedef struct lwkt_wait {
123 lwkt_queue wa_waitq; /* list of waiting threads */
124 lwkt_token wa_token; /* who currently owns the list */
125 int wa_gen;
126 int wa_count;
127} lwkt_wait;
128
96728c05
MD
129#define MAXCPUFIFO 16 /* power of 2 */
130#define MAXCPUFIFO_MASK (MAXCPUFIFO - 1)
41a01a4d 131#define LWKT_MAXTOKENS 16 /* max tokens beneficially held by thread */
96728c05 132
88c4d2f6
MD
133/*
134 * Always cast to ipifunc_t when registering an ipi. The actual ipi function
135 * is called with both the data and an interrupt frame, but the ipi function
136 * that is registered might only declare a data argument.
137 */
96728c05 138typedef void (*ipifunc_t)(void *arg);
88c4d2f6 139typedef void (*ipifunc2_t)(void *arg, struct intrframe *frame);
96728c05
MD
140
141typedef struct lwkt_ipiq {
142 int ip_rindex; /* only written by target cpu */
166ec852 143 int ip_xindex; /* written by target, indicates completion */
96728c05 144 int ip_windex; /* only written by source cpu */
88c4d2f6 145 ipifunc2_t ip_func[MAXCPUFIFO];
96728c05 146 void *ip_arg[MAXCPUFIFO];
3b6b7bd1 147 int ip_npoll;
96728c05
MD
148} lwkt_ipiq;
149
3b6b7bd1
MD
150/*
151 * CPU Synchronization structure. See lwkt_cpusync_start() and
152 * lwkt_cpusync_finish() for more information.
153 */
154typedef void (*cpusync_func_t)(lwkt_cpusync_t poll);
155typedef void (*cpusync_func2_t)(void *data);
156
157struct lwkt_cpusync {
158 cpusync_func_t cs_run_func; /* run (tandem w/ acquire) */
159 cpusync_func_t cs_fin1_func; /* fin1 (synchronized) */
160 cpusync_func2_t cs_fin2_func; /* fin2 (tandem w/ release) */
161 void *cs_data;
5c71a36a 162 int cs_maxcount;
3b6b7bd1 163 volatile int cs_count;
5c71a36a 164 cpumask_t cs_mask;
3b6b7bd1
MD
165};
166
f1d1c3fa
MD
167/*
168 * The standard message and queue structure used for communications between
169 * cpus. Messages are typically queued via a machine-specific non-linked
170 * FIFO matrix allowing any cpu to send a message to any other cpu without
171 * blocking.
172 */
173typedef struct lwkt_cpu_msg {
174 void (*cm_func)(lwkt_cpu_msg_t msg); /* primary dispatch function */
175 int cm_code; /* request code if applicable */
176 int cm_cpu; /* reply to cpu */
177 thread_t cm_originator; /* originating thread for wakeup */
178} lwkt_cpu_msg;
179
180/*
181 * reader/writer lock
182 */
183typedef struct lwkt_rwlock {
ae8050a4 184 lwkt_wait rw_wait;
f1d1c3fa
MD
185 thread_t rw_owner;
186 int rw_count;
17d46a8c 187 int rw_requests;
f1d1c3fa
MD
188} lwkt_rwlock;
189
190#define rw_token rw_wait.wa_token
191
192/*
193 * Thread structure. Note that ownership of a thread structure is special
a72187e9
MD
194 * cased and there is no 'token'. A thread is always owned by the cpu
195 * represented by td_gd, any manipulation of the thread by some other cpu
196 * must be done through cpu_*msg() functions. e.g. you could request
197 * ownership of a thread that way, or hand a thread off to another cpu.
4b5f931b
MD
198 *
199 * NOTE: td_pri is bumped by TDPRI_CRIT when entering a critical section,
200 * but this does not effect how the thread is scheduled by LWKT.
f1d1c3fa 201 */
96728c05 202struct md_intr_info;
f6bf3af1 203struct caps_kinfo;
96728c05 204
2df9fa87
MD
205struct thread {
206 TAILQ_ENTRY(thread) td_threadq;
73e4f7b9 207 TAILQ_ENTRY(thread) td_allq;
ece04fd0 208 lwkt_port td_msgport; /* built-in message port for replies */
2df9fa87
MD
209 struct proc *td_proc; /* (optional) associated process */
210 struct pcb *td_pcb; /* points to pcb and top of kstack */
26a0694b 211 struct globaldata *td_gd; /* associated with this cpu */
ae8050a4 212 const char *td_wmesg; /* string name for blockage */
0cfcada1 213 void *td_wchan; /* waiting on channel */
4b5f931b 214 int td_pri; /* 0-31, 31=highest priority (note 1) */
b8337f35 215 int td_flags; /* TDF flags */
f1d1c3fa 216 int td_gen; /* wait queue chasing generation number */
96728c05
MD
217 /* maybe preempt */
218 void (*td_preemptable)(struct thread *td, int critpri);
a2a5ad0d 219 void (*td_release)(struct thread *td);
96728c05
MD
220 union {
221 struct md_intr_info *intdata;
222 } td_info;
7e1d4bf4 223 char *td_kstack; /* kernel stack */
f470d0c8 224 int td_kstack_size; /* size of kernel stack */
8ad65e08
MD
225 char *td_sp; /* kernel stack pointer for LWKT restore */
226 void (*td_switch)(struct thread *ntd);
f1d1c3fa 227 lwkt_wait_t td_wait; /* thread sitting on wait structure */
05220613
MD
228 __uint64_t td_uticks; /* Statclock hits in user mode (uS) */
229 __uint64_t td_sticks; /* Statclock hits in system mode (uS) */
230 __uint64_t td_iticks; /* Statclock hits processing intr (uS) */
dadab5e9 231 int td_locks; /* lockmgr lock debugging YYY */
73e4f7b9 232 int td_refs; /* hold position in gd_tdallq / hold free */
46a3f46d 233 int td_nest_count; /* prevent splz nesting */
8a8d5d85
MD
234#ifdef SMP
235 int td_mpcount; /* MP lock held (count) */
0f7a3396 236 int td_cscount; /* cpu synchronization master */
8a8d5d85
MD
237#else
238 int td_unused001;
0f7a3396 239 int td_unused002;
8a8d5d85 240#endif
41f3429e 241 struct timeval td_start; /* start time for a thread/process */
0cfcada1 242 char td_comm[MAXCOMLEN+1]; /* typ 16+1 bytes */
99df837e 243 struct thread *td_preempted; /* we preempted this thread */
f6bf3af1 244 struct caps_kinfo *td_caps; /* list of client and server registrations */
41a01a4d 245 lwkt_tokref_t td_toks; /* tokens beneficially held */
85100692 246 struct md_thread td_mach;
2df9fa87
MD
247};
248
8ad65e08 249/*
d9eea1a5
MD
250 * Thread flags. Note that TDF_RUNNING is cleared on the old thread after
251 * we switch to the new one, which is necessary because LWKTs don't need
252 * to hold the BGL. This flag is used by the exit code and the managed
253 * thread migration code.
a2a5ad0d
MD
254 *
255 * LWKT threads stay on their (per-cpu) run queue while running, not to
256 * be confused with user processes which are removed from the user scheduling
257 * run queue while actually running.
8ad65e08 258 */
d9eea1a5 259#define TDF_RUNNING 0x0001 /* thread still active */
a2a5ad0d 260#define TDF_RUNQ 0x0002 /* on an LWKT run queue */
26a0694b
MD
261#define TDF_PREEMPT_LOCK 0x0004 /* I have been preempted */
262#define TDF_PREEMPT_DONE 0x0008 /* acknowledge preemption complete */
a2a5ad0d 263#define TDF_IDLE_NOHLT 0x0010 /* we need to spin */
5d21b981 264#define TDF_MIGRATING 0x0020 /* thread is being migrated */
d9d6cb99 265#define TDF_SINTR 0x0040 /* interruptability hint for 'ps' */
26a0694b 266
39766b86 267#define TDF_SYSTHREAD 0x0100 /* system thread */
99df837e
MD
268#define TDF_ALLOCATED_THREAD 0x0200 /* zalloc allocated thread */
269#define TDF_ALLOCATED_STACK 0x0400 /* zalloc allocated stack */
270#define TDF_VERBOSE 0x0800 /* verbose on exit */
dadab5e9 271#define TDF_DEADLKTREAT 0x1000 /* special lockmgr deadlock treatment */
0cfcada1
MD
272#define TDF_STOPREQ 0x2000 /* suspend_kproc */
273#define TDF_WAKEREQ 0x4000 /* resume_kproc */
274#define TDF_TIMEOUT 0x8000 /* tsleep timeout */
03aa8d99 275#define TDF_INTTHREAD 0x00010000 /* interrupt thread */
0a3f9b47 276#define TDF_NORESCHED 0x00020000 /* Do not reschedule on wake */
8ec60c3f 277#define TDF_BLOCKED 0x00040000 /* Thread is blocked */
8ad65e08 278
2df9fa87
MD
279/*
280 * Thread priorities. Typically only one thread from any given
281 * user process scheduling queue is on the LWKT run queue at a time.
282 * Remember that there is one LWKT run queue per cpu.
f1d1c3fa
MD
283 *
284 * Critical sections are handled by bumping td_pri above TDPRI_MAX, which
235957ed
MD
285 * causes interrupts to be masked as they occur. When this occurs a
286 * rollup flag will be set in mycpu->gd_reqflags.
2df9fa87 287 */
f1d1c3fa
MD
288#define TDPRI_IDLE_THREAD 0 /* the idle thread */
289#define TDPRI_USER_IDLE 4 /* user scheduler idle */
290#define TDPRI_USER_NORM 6 /* user scheduler normal */
291#define TDPRI_USER_REAL 8 /* user scheduler real time */
9ae9ee8d 292#define TDPRI_KERN_LPSCHED 9 /* scheduler helper for userland sch */
f1d1c3fa 293#define TDPRI_KERN_USER 10 /* kernel / block in syscall */
26a0694b 294#define TDPRI_KERN_DAEMON 12 /* kernel daemon (pageout, etc) */
f1d1c3fa
MD
295#define TDPRI_SOFT_NORM 14 /* kernel / normal */
296#define TDPRI_SOFT_TIMER 16 /* kernel / timer */
ae8050a4 297#define TDPRI_EXITING 19 /* exiting thread */
f1d1c3fa
MD
298#define TDPRI_INT_SUPPORT 20 /* kernel / high priority support */
299#define TDPRI_INT_LOW 27 /* low priority interrupt */
300#define TDPRI_INT_MED 28 /* medium priority interrupt */
301#define TDPRI_INT_HIGH 29 /* high priority interrupt */
302#define TDPRI_MAX 31
303
304#define TDPRI_MASK 31
305#define TDPRI_CRIT 32 /* high bits of td_pri used for crit */
2df9fa87 306
f470d0c8
MD
307#define LWKT_THREAD_STACK (UPAGES * PAGE_SIZE)
308
ef0fdad1 309#define CACHE_NTHREADS 6
7e1d4bf4 310
f8c3996b
MD
311#define IN_CRITICAL_SECT(td) ((td)->td_pri >= TDPRI_CRIT)
312
2df9fa87
MD
313#ifdef _KERNEL
314
315extern struct vm_zone *thread_zone;
316
05220613
MD
317#endif
318
319/*
320 * Applies both to the kernel and to liblwkt.
321 */
f470d0c8
MD
322extern struct thread *lwkt_alloc_thread(struct thread *template, int stksize,
323 int cpu);
324extern void lwkt_init_thread(struct thread *td, void *stack, int stksize,
325 int flags, struct globaldata *gd);
73e4f7b9
MD
326extern void lwkt_set_comm(thread_t td, const char *ctl, ...);
327extern void lwkt_wait_free(struct thread *td);
99df837e 328extern void lwkt_free_thread(struct thread *td);
41a01a4d 329extern void lwkt_wait_init(struct lwkt_wait *w);
8ad65e08
MD
330extern void lwkt_gdinit(struct globaldata *gd);
331extern void lwkt_switch(void);
96728c05 332extern void lwkt_preempt(thread_t ntd, int critpri);
8ad65e08 333extern void lwkt_schedule(thread_t td);
37af14fe 334extern void lwkt_schedule_self(thread_t td);
8ad65e08 335extern void lwkt_deschedule(thread_t td);
37af14fe 336extern void lwkt_deschedule_self(thread_t td);
a2a5ad0d 337extern void lwkt_acquire(thread_t td);
f1d1c3fa
MD
338extern void lwkt_yield(void);
339extern void lwkt_yield_quick(void);
41a01a4d 340extern void lwkt_token_wait(void);
73e4f7b9
MD
341extern void lwkt_hold(thread_t td);
342extern void lwkt_rele(thread_t td);
f1d1c3fa 343
ae8050a4 344extern void lwkt_block(lwkt_wait_t w, const char *wmesg, int *gen);
ece04fd0 345extern void lwkt_signal(lwkt_wait_t w, int count);
41a01a4d
MD
346
347extern int lwkt_havetoken(lwkt_token_t tok);
348extern int lwkt_havetokref(lwkt_tokref_t xref);
349extern void lwkt_gettoken(lwkt_tokref_t ref, lwkt_token_t tok);
350extern int lwkt_trytoken(lwkt_tokref_t ref, lwkt_token_t tok);
351extern void lwkt_gettokref(lwkt_tokref_t ref);
352extern int lwkt_trytokref(lwkt_tokref_t ref);
353extern void lwkt_reltoken(lwkt_tokref_t ref);
354extern void lwkt_reqtoken_remote(void *data);
355extern int lwkt_chktokens(thread_t td);
356extern void lwkt_drain_token_requests(void);
357extern void lwkt_token_init(lwkt_token_t tok);
358extern void lwkt_token_uninit(lwkt_token_t tok);
359
360extern void lwkt_token_pool_init(void);
361extern lwkt_token_t lwkt_token_pool_get(void *ptraddr);
362
ae8050a4 363extern void lwkt_rwlock_init(lwkt_rwlock_t lock);
41a01a4d 364extern void lwkt_rwlock_uninit(lwkt_rwlock_t lock);
ae8050a4
MD
365extern void lwkt_exlock(lwkt_rwlock_t lock, const char *wmesg);
366extern void lwkt_shlock(lwkt_rwlock_t lock, const char *wmesg);
367extern void lwkt_exunlock(lwkt_rwlock_t lock);
368extern void lwkt_shunlock(lwkt_rwlock_t lock);
41a01a4d 369
4b5f931b 370extern void lwkt_setpri(thread_t td, int pri);
26a0694b 371extern void lwkt_setpri_self(int pri);
8ec60c3f 372extern int lwkt_checkpri_self(void);
5d21b981 373extern void lwkt_setcpu_self(struct globaldata *rgd);
3fccdbef 374extern int lwkt_send_ipiq(struct globaldata *targ, ipifunc_t func, void *arg);
41a01a4d 375extern int lwkt_send_ipiq_passive(struct globaldata *targ, ipifunc_t func, void *arg);
3b6b7bd1
MD
376extern int lwkt_send_ipiq_bycpu(int dcpu, ipifunc_t func, void *arg);
377extern int lwkt_send_ipiq_mask(cpumask_t mask, ipifunc_t func, void *arg);
3fccdbef 378extern void lwkt_wait_ipiq(struct globaldata *targ, int seq);
41a01a4d 379extern int lwkt_seq_ipiq(struct globaldata *targ);
96728c05 380extern void lwkt_process_ipiq(void);
88c4d2f6
MD
381#ifdef _KERNEL
382extern void lwkt_process_ipiq_frame(struct intrframe frame);
383#endif
5c71a36a
MD
384extern void lwkt_cpusync_simple(cpumask_t mask, cpusync_func_t func, void *data);
385extern void lwkt_cpusync_fastdata(cpumask_t mask, cpusync_func2_t func, void *data);
386extern void lwkt_cpusync_start(cpumask_t mask, lwkt_cpusync_t poll);
387extern void lwkt_cpusync_add(cpumask_t mask, lwkt_cpusync_t poll);
388extern void lwkt_cpusync_finish(lwkt_cpusync_t poll);
26a0694b 389extern void crit_panic(void);
4b5f931b
MD
390extern struct proc *lwkt_preempted_proc(void);
391
99df837e 392extern int lwkt_create (void (*func)(void *), void *arg, struct thread **ptd,
75cdbe6c 393 struct thread *template, int tdflags, int cpu,
99df837e 394 const char *ctl, ...);
b153f746 395extern void lwkt_exit (void) __dead2;
99df837e 396
2df9fa87
MD
397#endif
398