Enhance the pmap_kenter*() API and friends, separating out entries which
[dragonfly.git] / sys / sys / globaldata.h
1 /*-
2  * Copyright (c) Peter Wemm <peter@netplex.com.au> All rights reserved.
3  * Copyright (c) 2003 Matthew Dillon <dillon@backplane.net> All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/i386/include/globaldata.h,v 1.11.2.1 2000/05/16 06:58:10 dillon Exp $
27  * $DragonFly: src/sys/sys/globaldata.h,v 1.30 2004/04/01 17:40:59 dillon Exp $
28  */
29
30 #ifndef _SYS_GLOBALDATA_H_
31 #define _SYS_GLOBALDATA_H_
32
33 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
34
35 #ifndef _SYS_STDINT_H_
36 #include <sys/stdint.h> /* __int types */
37 #endif
38 #ifndef _SYS_TIME_H_
39 #include <sys/time.h>   /* struct timeval */
40 #endif
41 #ifndef _SYS_VMMETER_H_
42 #include <sys/vmmeter.h> /* struct vmmeter */
43 #endif
44 #ifndef _SYS_THREAD_H_
45 #include <sys/thread.h> /* struct thread */
46 #endif
47 #ifndef _SYS_SLABALLOC_H_
48 #include <sys/slaballoc.h> /* SLGlobalData */
49 #endif
50 #ifndef _SYS_SYSTIMER_H_
51 #include <sys/systimer.h> /* fine-grained system timers */
52 #endif
53
54 /*
55  * This structure maps out the global data that needs to be kept on a
56  * per-cpu basis.  genassym uses this to generate offsets for the assembler
57  * code.  The machine-dependant portions of this file can be found in
58  * <machine/globaldata.h>, but only MD code should retrieve it.
59  *
60  * The SMP parts are setup in pmap.c and locore.s for the BSP, and
61  * mp_machdep.c sets up the data for the AP's to "see" when they awake.
62  * The reason for doing it via a struct is so that an array of pointers
63  * to each CPU's data can be set up for things like "check curproc on all
64  * other processors"
65  *
66  * NOTE! this structure needs to remain compatible between module accessors
67  * and the kernel, so we can't throw in lots of #ifdef's.
68  *
69  * gd_reqflags serves serveral purposes, but it is primarily an interrupt
70  * rollup flag used by the task switcher and spl mechanisms to decide that
71  * further checks are necessary.  Interrupts are typically managed on a
72  * per-processor basis at least until you leave a critical section, but
73  * may then be scheduled to other cpus.
74  *
75  * gd_vme_avail and gd_vme_base cache free vm_map_entry structures for use
76  * in various vm_map related operations.  gd_vme_avail is *NOT* a count of
77  * the number of structures in the cache but is instead a count of the number
78  * of unreserved structures in the cache.  See vm_map_entry_reserve().
79  *
80  * gd_uschedcp is internal to the userland scheduler.  It does not represent
81  * the currently running process.
82  */
83
84 struct sysmsg;
85 struct privatespace;
86 struct vm_map_entry;
87 struct pipe;
88
89 struct globaldata {
90         struct privatespace *gd_prvspace;       /* self-reference */
91         struct thread   *gd_curthread;
92         int             gd_tdfreecount;         /* new thread cache */
93         __uint32_t      gd_reqflags;            /* (see note above) */
94         union sysunion  *gd_freesysun;          /* free syscall messages */
95         TAILQ_HEAD(,thread) gd_tdallq;          /* all threads */
96         TAILQ_HEAD(,thread) gd_tdfreeq;         /* new thread cache */
97         TAILQ_HEAD(,thread) gd_tdrunq[32];      /* runnable threads */
98         __uint32_t      gd_runqmask;            /* which queues? */
99         __uint32_t      gd_cpuid;
100         cpumask_t       gd_cpumask;             /* mask = 1<<cpuid */
101         cpumask_t       gd_other_cpus;          /* mask of 'other' cpus */
102         struct timeval  gd_stattv;
103         int             gd_intr_nesting_level;  /* (for interrupts) */
104         struct vmmeter  gd_cnt;
105         struct lwkt_ipiq *gd_ipiq;              /* array[ncpu] of ipiq's */
106         struct lwkt_ipiq gd_cpusyncq;           /* ipiq for cpu synchro */
107         short           gd_upri;                /* userland scheduler helper */
108         short           gd_unused01;
109         struct thread   gd_schedthread;         /* userland scheduler helper */
110         struct thread   gd_idlethread;
111         SLGlobalData    gd_slab;                /* slab allocator */
112         int             gd_vme_kdeficit;        /* vm_map_entry reservation */
113         int             gd_vme_avail;           /* vm_map_entry reservation */
114         struct vm_map_entry *gd_vme_base;       /* vm_map_entry reservation */
115         struct systimerq gd_systimerq;          /* per-cpu system timers */
116         int             gd_syst_nest;
117         sysclock_t      gd_nextclock;           /* next best-case clock req */
118         struct systimer gd_hardclock;           /* scheduler periodic */
119         struct systimer gd_statclock;           /* statistics periodic */
120         struct systimer gd_schedclock;          /* scheduler periodic */
121         volatile __uint32_t gd_time_seconds;    /* uptime in seconds */
122         volatile sysclock_t gd_cpuclock_base;   /* cpuclock relative base */
123
124         struct pipe     *gd_pipeq;              /* cache pipe structures */
125         int             gd_pipeqcount;          /* number of structures */
126         lwkt_tokref_t   gd_tokreqbase;          /* requests from other cpus */
127         struct proc     *gd_uschedcp;           /* userland scheduler */
128         /* extended by <machine/globaldata.h> */
129 };
130
131 typedef struct globaldata *globaldata_t;
132
133 #define RQB_IPIQ                0
134 #define RQB_INTPEND             1
135 #define RQB_AST_OWEUPC          2
136 #define RQB_AST_SIGNAL          3
137 #define RQB_AST_USER_RESCHED    4
138 #define RQB_AST_LWKT_RESCHED    5
139 #define RQB_AST_UPCALL          6
140
141 #define RQF_IPIQ                (1 << RQB_IPIQ)
142 #define RQF_INTPEND             (1 << RQB_INTPEND)
143 #define RQF_AST_OWEUPC          (1 << RQB_AST_OWEUPC)
144 #define RQF_AST_SIGNAL          (1 << RQB_AST_SIGNAL)
145 #define RQF_AST_USER_RESCHED    (1 << RQB_AST_USER_RESCHED)
146 #define RQF_AST_LWKT_RESCHED    (1 << RQB_AST_LWKT_RESCHED)
147 #define RQF_AST_UPCALL          (1 << RQB_AST_UPCALL)
148 #define RQF_AST_MASK            (RQF_AST_OWEUPC|RQF_AST_SIGNAL|\
149                                 RQF_AST_USER_RESCHED|RQF_AST_LWKT_RESCHED|\
150                                 RQF_AST_UPCALL)
151 #define RQF_IDLECHECK_MASK      (RQF_IPIQ|RQF_INTPEND)
152
153 #endif
154
155 #ifdef _KERNEL
156 struct globaldata *globaldata_find(int cpu);
157 #endif
158
159 #endif