sys/sys/thread.h

   1 /*
   2  * SYS/THREAD.H
   3  *
   4  *      Implements the architecture independant portion of the LWKT
   5  *      subsystem.
   6  *
   7  * Types which must already be defined when this header is included by
   8  * userland:    struct md_thread
   9  *
  10  * $DragonFly: src/sys/sys/thread.h,v 1.44 2004/02/15 02:14:42 dillon Exp $
  11  */
  12
  13 #ifndef _SYS_THREAD_H_
  14 #define _SYS_THREAD_H_
  15
  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
  22 #ifndef _SYS_QUEUE_H_
  23 #include <sys/queue.h>          /* TAILQ_* macros */
  24 #endif
  25 #ifndef _SYS_MSGPORT_H_
  26 #include <sys/msgport.h>        /* lwkt_port */
  27 #endif
  28
  29 struct globaldata;
  30 struct proc;
  31 struct thread;
  32 struct lwkt_queue;
  33 struct lwkt_token;
  34 struct lwkt_wait;
  35 struct lwkt_ipiq;
  36 struct lwkt_cpu_msg;
  37 struct lwkt_cpu_port;
  38 struct lwkt_rwlock;
  39 struct lwkt_msg;
  40 struct lwkt_port;
  41 struct lwkt_cpusync;
  42 union sysunion;
  43
  44 typedef struct lwkt_queue       *lwkt_queue_t;
  45 typedef struct lwkt_token       *lwkt_token_t;
  46 typedef struct lwkt_wait        *lwkt_wait_t;
  47 typedef struct lwkt_cpu_msg     *lwkt_cpu_msg_t;
  48 typedef struct lwkt_cpu_port    *lwkt_cpu_port_t;
  49 typedef struct lwkt_rwlock      *lwkt_rwlock_t;
  50 typedef struct lwkt_ipiq        *lwkt_ipiq_t;
  51 typedef struct lwkt_cpusync     *lwkt_cpusync_t;
  52 typedef struct thread           *thread_t;
  53
  54 typedef TAILQ_HEAD(lwkt_queue, thread) lwkt_queue;
  55
  56 /*
  57  * Differentiation between kernel threads and user threads.  Userland
  58  * programs which want to access to kernel structures have to define
  59  * _KERNEL_STRUCTURES.  This is a kinda safety valve to prevent badly
  60  * written user programs from getting an LWKT thread that is neither the
  61  * kernel nor the user version.
  62  */
  63 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  64 #ifndef _MACHINE_THREAD_H_
  65 #include <machine/thread.h>             /* md_thread */
  66 #endif
  67 #ifndef _MACHINE_FRAME_H_
  68 #include <machine/frame.h>
  69 #endif
  70 #else
  71 struct intrframe;
  72 #endif
  73
  74 /*
  75  * Tokens arbitrate access to information.  They are 'soft' arbitrators
  76  * in that they are associated with cpus rather then threads, making the
  77  * optimal aquisition case very fast if your cpu already happens to own the
  78  * token you are requesting.
  79  */
  80 typedef struct lwkt_token {
  81     struct globaldata *t_cpu;   /* the current owner of the token */
  82     struct globaldata *t_reqcpu;/* return ownership to this cpu on release */
  83     int         t_gen;          /* generation number */
  84 } lwkt_token;
  85
  86 /*
  87  * Wait structures deal with blocked threads.  Due to the way remote cpus
  88  * interact with these structures stable storage must be used.
  89  */
  90 typedef struct lwkt_wait {
  91     lwkt_queue  wa_waitq;       /* list of waiting threads */
  92     lwkt_token  wa_token;       /* who currently owns the list */
  93     int         wa_gen;
  94     int         wa_count;
  95 } lwkt_wait;
  96
  97 #define MAXCPUFIFO      16      /* power of 2 */
  98 #define MAXCPUFIFO_MASK (MAXCPUFIFO - 1)
  99
 100 /*
 101  * Always cast to ipifunc_t when registering an ipi.  The actual ipi function
 102  * is called with both the data and an interrupt frame, but the ipi function
 103  * that is registered might only declare a data argument.
 104  */
 105 typedef void (*ipifunc_t)(void *arg);
 106 typedef void (*ipifunc2_t)(void *arg, struct intrframe *frame);
 107
 108 typedef struct lwkt_ipiq {
 109     int         ip_rindex;      /* only written by target cpu */
 110     int         ip_xindex;      /* writte by target, indicates completion */
 111     int         ip_windex;      /* only written by source cpu */
 112     ipifunc2_t  ip_func[MAXCPUFIFO];
 113     void        *ip_arg[MAXCPUFIFO];
 114     int         ip_npoll;
 115 } lwkt_ipiq;
 116
 117 /*
 118  * CPU Synchronization structure.  See lwkt_cpusync_start() and
 119  * lwkt_cpusync_finish() for more information.
 120  */
 121 typedef void (*cpusync_func_t)(lwkt_cpusync_t poll);
 122 typedef void (*cpusync_func2_t)(void *data);
 123
 124 struct lwkt_cpusync {
 125     cpusync_func_t cs_run_func;         /* run (tandem w/ acquire) */
 126     cpusync_func_t cs_fin1_func;        /* fin1 (synchronized) */
 127     cpusync_func2_t cs_fin2_func;       /* fin2 (tandem w/ release) */
 128     void        *cs_data;
 129     volatile int cs_count;
 130 };
 131
 132 /*
 133  * The standard message and queue structure used for communications between
 134  * cpus.  Messages are typically queued via a machine-specific non-linked
 135  * FIFO matrix allowing any cpu to send a message to any other cpu without
 136  * blocking.
 137  */
 138 typedef struct lwkt_cpu_msg {
 139     void        (*cm_func)(lwkt_cpu_msg_t msg); /* primary dispatch function */
 140     int         cm_code;                /* request code if applicable */
 141     int         cm_cpu;                 /* reply to cpu */
 142     thread_t    cm_originator;          /* originating thread for wakeup */
 143 } lwkt_cpu_msg;
 144
 145 /*
 146  * reader/writer lock
 147  */
 148 typedef struct lwkt_rwlock {
 149     lwkt_wait   rw_wait;
 150     thread_t    rw_owner;
 151     int         rw_count;
 152     int         rw_requests;
 153 } lwkt_rwlock;
 154
 155 #define rw_token        rw_wait.wa_token
 156
 157 /*
 158  * Thread structure.  Note that ownership of a thread structure is special
 159  * cased and there is no 'token'.  A thread is always owned by the cpu
 160  * represented by td_gd, any manipulation of the thread by some other cpu
 161  * must be done through cpu_*msg() functions.  e.g. you could request
 162  * ownership of a thread that way, or hand a thread off to another cpu.
 163  *
 164  * NOTE: td_pri is bumped by TDPRI_CRIT when entering a critical section,
 165  * but this does not effect how the thread is scheduled by LWKT.
 166  */
 167 struct md_intr_info;
 168 struct caps_kinfo;
 169
 170 struct thread {
 171     TAILQ_ENTRY(thread) td_threadq;
 172     TAILQ_ENTRY(thread) td_allq;
 173     lwkt_port   td_msgport;     /* built-in message port for replies */
 174     struct proc *td_proc;       /* (optional) associated process */
 175     struct pcb  *td_pcb;        /* points to pcb and top of kstack */
 176     struct globaldata *td_gd;   /* associated with this cpu */
 177     const char  *td_wmesg;      /* string name for blockage */
 178     void        *td_wchan;      /* waiting on channel */
 179     int         td_pri;         /* 0-31, 31=highest priority (note 1) */
 180     int         td_flags;       /* TDF flags */
 181     int         td_gen;         /* wait queue chasing generation number */
 182                                 /* maybe preempt */
 183     void        (*td_preemptable)(struct thread *td, int critpri);
 184     void        (*td_release)(struct thread *td);
 185     union {
 186         struct md_intr_info *intdata;
 187     } td_info;
 188     char        *td_kstack;     /* kernel stack */
 189     char        *td_sp;         /* kernel stack pointer for LWKT restore */
 190     void        (*td_switch)(struct thread *ntd);
 191     lwkt_wait_t td_wait;        /* thread sitting on wait structure */
 192     __uint64_t  td_uticks;      /* Statclock hits in user mode (uS) */
 193     __uint64_t  td_sticks;      /* Statclock hits in system mode (uS) */
 194     __uint64_t  td_iticks;      /* Statclock hits processing intr (uS) */
 195     int         td_locks;       /* lockmgr lock debugging YYY */
 196     int         td_refs;        /* hold position in gd_tdallq / hold free */
 197     int         td_nest_count;  /* prevent splz nesting */
 198 #ifdef SMP
 199     int         td_mpcount;     /* MP lock held (count) */
 200 #else
 201     int         td_unused001;
 202 #endif
 203     char        td_comm[MAXCOMLEN+1]; /* typ 16+1 bytes */
 204     struct thread *td_preempted; /* we preempted this thread */
 205     struct caps_kinfo *td_caps; /* list of client and server registrations */
 206     struct md_thread td_mach;
 207 };
 208
 209 /*
 210  * Thread flags.  Note that TDF_RUNNING is cleared on the old thread after
 211  * we switch to the new one, which is necessary because LWKTs don't need
 212  * to hold the BGL.  This flag is used by the exit code and the managed
 213  * thread migration code.
 214  *
 215  * LWKT threads stay on their (per-cpu) run queue while running, not to
 216  * be confused with user processes which are removed from the user scheduling
 217  * run queue while actually running.
 218  */
 219 #define TDF_RUNNING             0x0001  /* thread still active */
 220 #define TDF_RUNQ                0x0002  /* on an LWKT run queue */
 221 #define TDF_PREEMPT_LOCK        0x0004  /* I have been preempted */
 222 #define TDF_PREEMPT_DONE        0x0008  /* acknowledge preemption complete */
 223 #define TDF_IDLE_NOHLT          0x0010  /* we need to spin */
 224
 225 #define TDF_SYSTHREAD           0x0100  /* system thread */
 226 #define TDF_ALLOCATED_THREAD    0x0200  /* zalloc allocated thread */
 227 #define TDF_ALLOCATED_STACK     0x0400  /* zalloc allocated stack */
 228 #define TDF_VERBOSE             0x0800  /* verbose on exit */
 229 #define TDF_DEADLKTREAT         0x1000  /* special lockmgr deadlock treatment */
 230 #define TDF_STOPREQ             0x2000  /* suspend_kproc */
 231 #define TDF_WAKEREQ             0x4000  /* resume_kproc */
 232 #define TDF_TIMEOUT             0x8000  /* tsleep timeout */
 233 #define TDF_INTTHREAD           0x00010000      /* interrupt thread */
 234
 235 /*
 236  * Thread priorities.  Typically only one thread from any given
 237  * user process scheduling queue is on the LWKT run queue at a time.
 238  * Remember that there is one LWKT run queue per cpu.
 239  *
 240  * Critical sections are handled by bumping td_pri above TDPRI_MAX, which
 241  * causes interrupts to be masked as they occur.  When this occurs a
 242  * rollup flag will be set in mycpu->gd_reqflags.
 243  */
 244 #define TDPRI_IDLE_THREAD       0       /* the idle thread */
 245 #define TDPRI_USER_IDLE         4       /* user scheduler idle */
 246 #define TDPRI_USER_NORM         6       /* user scheduler normal */
 247 #define TDPRI_USER_REAL         8       /* user scheduler real time */
 248 #define TDPRI_KERN_LPSCHED      9       /* scheduler helper for userland sch */
 249 #define TDPRI_KERN_USER         10      /* kernel / block in syscall */
 250 #define TDPRI_KERN_DAEMON       12      /* kernel daemon (pageout, etc) */
 251 #define TDPRI_SOFT_NORM         14      /* kernel / normal */
 252 #define TDPRI_SOFT_TIMER        16      /* kernel / timer */
 253 #define TDPRI_EXITING           19      /* exiting thread */
 254 #define TDPRI_INT_SUPPORT       20      /* kernel / high priority support */
 255 #define TDPRI_INT_LOW           27      /* low priority interrupt */
 256 #define TDPRI_INT_MED           28      /* medium priority interrupt */
 257 #define TDPRI_INT_HIGH          29      /* high priority interrupt */
 258 #define TDPRI_MAX               31
 259
 260 #define TDPRI_MASK              31
 261 #define TDPRI_CRIT              32      /* high bits of td_pri used for crit */
 262
 263 #define CACHE_NTHREADS          6
 264
 265 #define IN_CRITICAL_SECT(td)    ((td)->td_pri >= TDPRI_CRIT)
 266
 267 #ifdef _KERNEL
 268
 269 extern struct vm_zone   *thread_zone;
 270
 271 #endif
 272
 273 /*
 274  * Applies both to the kernel and to liblwkt.
 275  */
 276 extern struct thread *lwkt_alloc_thread(struct thread *template, int cpu);
 277 extern void lwkt_init_thread(struct thread *td, void *stack, int flags,
 278         struct globaldata *gd);
 279 extern void lwkt_set_comm(thread_t td, const char *ctl, ...);
 280 extern void lwkt_wait_free(struct thread *td);
 281 extern void lwkt_free_thread(struct thread *td);
 282 extern void lwkt_init_wait(struct lwkt_wait *w);
 283 extern void lwkt_gdinit(struct globaldata *gd);
 284 extern void lwkt_switch(void);
 285 extern void lwkt_maybe_switch(void);
 286 extern void lwkt_preempt(thread_t ntd, int critpri);
 287 extern void lwkt_schedule(thread_t td);
 288 extern void lwkt_schedule_self(void);
 289 extern void lwkt_deschedule(thread_t td);
 290 extern void lwkt_deschedule_self(void);
 291 extern void lwkt_acquire(thread_t td);
 292 extern void lwkt_yield(void);
 293 extern void lwkt_yield_quick(void);
 294 extern void lwkt_hold(thread_t td);
 295 extern void lwkt_rele(thread_t td);
 296
 297 extern void lwkt_block(lwkt_wait_t w, const char *wmesg, int *gen);
 298 extern void lwkt_signal(lwkt_wait_t w, int count);
 299 extern int lwkt_trytoken(lwkt_token_t tok);
 300 extern int lwkt_gettoken(lwkt_token_t tok);
 301 extern int lwkt_gentoken(lwkt_token_t tok, int *gen);
 302 extern int lwkt_reltoken(lwkt_token_t tok);
 303 extern void lwkt_inittoken(lwkt_token_t tok);
 304 extern int  lwkt_regettoken(lwkt_token_t tok);
 305 extern void lwkt_rwlock_init(lwkt_rwlock_t lock);
 306 extern void lwkt_exlock(lwkt_rwlock_t lock, const char *wmesg);
 307 extern void lwkt_shlock(lwkt_rwlock_t lock, const char *wmesg);
 308 extern void lwkt_exunlock(lwkt_rwlock_t lock);
 309 extern void lwkt_shunlock(lwkt_rwlock_t lock);
 310 extern void lwkt_setpri(thread_t td, int pri);
 311 extern void lwkt_setpri_self(int pri);
 312 extern int  lwkt_send_ipiq(struct globaldata *targ, ipifunc_t func, void *arg);
 313 extern int  lwkt_send_ipiq_bycpu(int dcpu, ipifunc_t func, void *arg);
 314 extern int  lwkt_send_ipiq_mask(cpumask_t mask, ipifunc_t func, void *arg);
 315 extern void lwkt_wait_ipiq(struct globaldata *targ, int seq);
 316 extern void lwkt_process_ipiq(void);
 317 #ifdef _KERNEL
 318 extern void lwkt_process_ipiq_frame(struct intrframe frame);
 319 #endif
 320 extern void lwkt_cpusync_simple(cpumask_t mask, cpusync_func2_t func, void *data);
 321 extern int lwkt_cpusync_start(cpumask_t mask, lwkt_cpusync_t poll);
 322 extern void lwkt_cpusync_finish(lwkt_cpusync_t poll, int count);
 323 extern void crit_panic(void);
 324 extern struct proc *lwkt_preempted_proc(void);
 325
 326 extern int  lwkt_create (void (*func)(void *), void *arg, struct thread **ptd,
 327                             struct thread *template, int tdflags, int cpu,
 328                             const char *ctl, ...);
 329 extern void lwkt_exit (void) __dead2;
 330
 331 #endif
 332