Do some fairly major include file cleanups to further separate kernelland
[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.21 2003/11/21 22:46:13 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
51 /*
52  * This structure maps out the global data that needs to be kept on a
53  * per-cpu basis.  genassym uses this to generate offsets for the assembler
54  * code.  The machine-dependant portions of this file can be found in
55  * <machine/globaldata.h>, but only MD code should retrieve it.
56  *
57  * The SMP parts are setup in pmap.c and locore.s for the BSP, and
58  * mp_machdep.c sets up the data for the AP's to "see" when they awake.
59  * The reason for doing it via a struct is so that an array of pointers
60  * to each CPU's data can be set up for things like "check curproc on all
61  * other processors"
62  *
63  * NOTE! this structure needs to remain compatible between module accessors
64  * and the kernel, so we can't throw in lots of #ifdef's.
65  *
66  * gd_reqflags serves serveral purposes, but it is primarily an interrupt
67  * rollup flag used by the task switcher and spl mechanisms to decide that
68  * further checks are necessary.  Interrupts are typically managed on a
69  * per-processor basis at least until you leave a critical section, but
70  * may then be scheduled to other cpus.
71  *
72  * gd_vme_avail and gd_vme_base cache free vm_map_entry structures for use
73  * in various vm_map related operations.  gd_vme_avail is *NOT* a count of
74  * the number of structures in the cache but is instead a count of the number
75  * of unreserved structures in the cache.  See vm_map_entry_reserve().
76  */
77
78 struct sysmsg;
79 struct privatespace;
80 struct vm_map_entry;
81
82 struct globaldata {
83         struct privatespace *gd_prvspace;       /* self-reference */
84         struct thread   *gd_curthread;
85         int             gd_tdfreecount;         /* new thread cache */
86         __uint32_t      gd_reqflags;            /* (see note above) */
87         union sysunion  *gd_freesysun;          /* free syscall messages */
88         TAILQ_HEAD(,thread) gd_tdallq;          /* all threads */
89         TAILQ_HEAD(,thread) gd_tdfreeq;         /* new thread cache */
90         TAILQ_HEAD(,thread) gd_tdrunq[32];      /* runnable threads */
91         __uint32_t      gd_runqmask;            /* which queues? */
92         __uint32_t      gd_cpuid;
93         __uint32_t      gd_other_cpus;          /* mask of 'other' cpus */
94         struct timeval  gd_stattv;
95         int             gd_intr_nesting_level;  /* (for interrupts) */
96         int             gd_psticks;             /* profile kern/kern_clock.c */
97         int             gd_psdiv;               /* profile kern/kern_clock.c */
98         struct vmmeter  gd_cnt;
99         struct lwkt_ipiq *gd_ipiq;
100         short           gd_upri;                /* userland scheduler helper */
101         short           gd_unused01;
102         struct thread   gd_schedthread;         /* userland scheduler helper */
103         struct thread   gd_idlethread;
104         SLGlobalData    gd_slab;                /* slab allocator */
105         int             gd_vme_kdeficit;        /* vm_map_entry reservation */
106         int             gd_vme_avail;           /* vm_map_entry reservation */
107         struct vm_map_entry *gd_vme_base;       /* vm_map_entry reservation */
108         /* extended by <machine/pcpu.h> */
109 };
110
111 typedef struct globaldata *globaldata_t;
112
113 #define RQB_IPIQ        0
114 #define RQB_INTPEND     1
115 #define RQB_AST_OWEUPC  2
116 #define RQB_AST_SIGNAL  3
117 #define RQB_AST_RESCHED 4
118 #define RQB_AST_UPCALL  5
119
120 #define RQF_IPIQ        (1 << RQB_IPIQ)
121 #define RQF_INTPEND     (1 << RQB_INTPEND)
122 #define RQF_AST_OWEUPC  (1 << RQB_AST_OWEUPC)
123 #define RQF_AST_SIGNAL  (1 << RQB_AST_SIGNAL)
124 #define RQF_AST_RESCHED (1 << RQB_AST_RESCHED)
125 #define RQF_AST_UPCALL  (1 << RQB_AST_UPCALL)
126 #define RQF_AST_MASK    (RQF_AST_OWEUPC|RQF_AST_SIGNAL|RQF_AST_RESCHED|\
127                          RQF_AST_UPCALL)
128
129 #endif
130
131 #ifdef _KERNEL
132 struct globaldata *globaldata_find(int cpu);
133 #endif
134
135 #endif