1/*
2 * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
29/*-
30 * Copyright (c) 1982, 1988, 1991, 1993
31 * The Regents of the University of California. All rights reserved.
32 * (c) UNIX System Laboratories, Inc.
33 * All or some portions of this file are derived from material licensed
34 * to the University of California by American Telephone and Telegraph
35 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
36 * the permission of UNIX System Laboratories, Inc.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * 3. All advertising materials mentioning features or use of this software
47 * must display the following acknowledgement:
48 * This product includes software developed by the University of
49 * California, Berkeley and its contributors.
50 * 4. Neither the name of the University nor the names of its contributors
51 * may be used to endorse or promote products derived from this software
52 * without specific prior written permission.
53 *
54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64 * SUCH DAMAGE.
65 *
66 * @(#)systm.h 8.7 (Berkeley) 3/29/95
67 */
68
69/*
70 * The `securelevel' variable controls the security level of the system.
71 * It can only be decreased by process 1 (/sbin/init).
72 *
73 * Security levels are as follows:
74 * -1 permannently insecure mode - always run system in level 0 mode.
75 * 0 insecure mode - immutable and append-only flags make be turned off.
76 * All devices may be read or written subject to permission modes.
77 * 1 secure mode - immutable and append-only flags may not be changed;
78 * raw disks of mounted filesystems, /dev/mem, and /dev/kmem are
79 * read-only.
80 * 2 highly secure mode - same as (1) plus raw disks are always
81 * read-only whether mounted or not. This level precludes tampering
82 * with filesystems by unmounting them, but also inhibits running
83 * newfs while the system is secured.
84 *
85 * In normal operation, the system runs in level 0 mode while single user
86 * and in level 1 mode while multiuser. If level 2 mode is desired while
87 * running multiuser, it can be set in the multiuser startup script
88 * (/etc/rc.local) using sysctl(1). If it is desired to run the system
89 * in level 0 mode while multiuser, initialize the variable securelevel
90 * in /sys/kern/kern_sysctl.c to -1. Note that it is NOT initialized to
91 * zero as that would allow the vmunix binary to be patched to -1.
92 * Without initialization, securelevel loads in the BSS area which only
93 * comes into existence when the kernel is loaded and hence cannot be
94 * patched by a stalking hacker.
95 */
96
97#ifndef _SYS_SYSTM_H_
98#define _SYS_SYSTM_H_
99
100#include <sys/appleapiopts.h>
101#include <sys/cdefs.h>
102#include <sys/types.h>
103#include <sys/time.h>
104#include <sys/ioctl.h>
105#include <sys/malloc.h>
106#ifdef BSD_KERNEL_PRIVATE
107#include <sys/tty.h>
108#include <sys/vm.h>
109#endif
110#include <sys/proc.h>
111__BEGIN_DECLS
112#ifdef KERNEL
113#include <libkern/libkern.h>
114#endif
115#include <kern/thread.h>
116#include <kern/debug.h>
117__END_DECLS
118
119#ifdef BSD_KERNEL_PRIVATE
120extern char version[]; /* system version */
121extern const char *const copyright; /* system copyright */
122
123
124extern int boothowto; /* reboot flags, from console subsystem */
125extern int show_space;
126extern int minimalboot;
127#if CONFIG_DARKBOOT
128extern int darkboot;
129#endif
130
131extern const int nblkdev; /* number of entries in bdevsw */
132extern const int nchrdev; /* number of entries in cdevsw */
133#endif /* BSD_KERNEL_PRIVATE */
134
135#ifdef KERNEL_PRIVATE
136
137extern int securelevel; /* system security level */
138extern dev_t rootdev; /* root device */
139extern struct vnode *rootvp; /* vnode equivalent to above */
140
141#endif /* KERNEL_PRIVATE */
142
143#define SYSINIT(a, b, c, d, e)
144#define MALLOC_DEFINE(a, b, c)
145
146#define getenv_int(a, b) (*b = 0)
147#define KASSERT(exp, msg)
148/*
149 * General function declarations.
150 */
151__BEGIN_DECLS
152
153#ifdef BSD_KERNEL_PRIVATE
154int einval(void);
155void nullsys(void);
156int errsys(void);
157int seltrue(dev_t dev, int which, struct proc *p);
158void ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
159void realitexpire(struct proc *, void*);
160int hzto(struct timeval *tv);
161void tablefull(const char *);
162void uprintf(const char *, ...) __printflike(1, 2);
163int copywithin(void *saddr, void *daddr, size_t len);
164int64_t fulong(user_addr_t addr);
165int sulong(user_addr_t addr, int64_t longword);
166uint64_t fuulong(user_addr_t addr);
167int suulong(user_addr_t addr, uint64_t ulongword);
168int clone_system_shared_regions(int shared_regions_active,
169 int chain_regions,
170 int base_vnode);
171extern kern_return_t bsd_exception(int, mach_exception_data_t codes, int);
172extern void bsdinit_task(void);
173extern void unix_syscall_return(int) __dead2;
174void initclocks(void);
175void startprofclock(struct proc *);
176void stopprofclock(struct proc *);
177void setstatclockrate(int hzrate);
178struct time_value;
179void get_procrustime(struct time_value *tv);
180void load_init_program(struct proc *p);
181void __pthread_testcancel(int presyscall);
182void throttle_info_get_last_io_time(mount_t mp, struct timeval *tv);
183void update_last_io_time(mount_t mp);
184void throttle_info_end_io(buf_t bp);
185#endif /* BSD_KERNEL_PRIVATE */
186
187#ifdef KERNEL_PRIVATE
188void timeout(void (*)(void *), void *arg, int ticks);
189void timeout_with_leeway(void (*)(void *), void *arg, int ticks, int leeway_ticks);
190void untimeout(void (*)(void *), void *arg);
191int bsd_hostname(char *, size_t, size_t*);
192int vslock(user_addr_t addr, user_size_t len);
193int vsunlock(user_addr_t addr, user_size_t len, int dirtied);
194#endif /* KERNEL_PRIVATE */
195
196int nullop(void);
197int nulldev(void);
198int enoioctl(void);
199int enosys(void);
200int enxio(void);
201int eopnotsupp(void);
202void *hashinit(int count, int type, u_long *hashmask);
203void hashdestroy(void *, int type, u_long hashmask);
204void ovbcopy(const void *from, void *to, size_t len);
205int fubyte(user_addr_t addr);
206int fuibyte(user_addr_t addr);
207int subyte(user_addr_t addr, int byte);
208int suibyte(user_addr_t addr, int byte);
209long fuword(user_addr_t addr);
210long fuiword(user_addr_t addr);
211int suword(user_addr_t addr, long word);
212int suiword(user_addr_t addr, long word);
213#define fusize(_a) ((user_size_t)fulong(_a))
214#define susize(_a, _s) sulong((_a), (_s))
215#define fuptr(a) ((user_addr_t)fulong(_a)
216#define suptr(_a, _p) sulong((_a), (_p))
217int useracc(user_addr_t addr, user_size_t len, int prot);
218typedef void (*timeout_fcn_t)(void *);
219void bsd_timeout(void (*)(void *), void *arg, struct timespec * ts);
220void bsd_untimeout(void (*)(void *), void *arg);
221void set_fsblocksize(struct vnode *);
222uint64_t tvtoabstime(struct timeval *);
223uint64_t tstoabstime(struct timespec *);
224void *throttle_info_create(void);
225void throttle_info_mount_ref(mount_t mp, void * throttle_info);
226void throttle_info_mount_rel(mount_t mp);
227void throttle_info_release(void *throttle_info);
228void throttle_info_update(void *throttle_info, int flags);
229uint32_t throttle_lowpri_io(int sleep_amount);
230/* returns TRUE if the throttle_lowpri_io called with the same sleep_amount would've slept */
231int throttle_lowpri_io_will_be_throttled(int sleep_amount);
232void throttle_set_thread_io_policy(int policy);
233int throttle_get_thread_effective_io_policy(void);
234int throttle_thread_io_tier_above_metadata(void);
235
236typedef struct __throttle_info_handle *throttle_info_handle_t;
237int throttle_info_ref_by_mask(uint64_t throttle_mask, throttle_info_handle_t *throttle_info_handle);
238void throttle_info_rel_by_mask(throttle_info_handle_t throttle_info_handle);
239void throttle_info_update_by_mask(void *throttle_info_handle, int flags);
240void throttle_info_disable_throttle(int devno, boolean_t isfusion);
241/*
242 * 'throttle_info_handle' acquired via 'throttle_info_ref_by_mask'
243 * 'policy' should be specified as either IOPOL_UTILITY or IPOL_THROTTLE,
244 * all other values will be treated as IOPOL_NORMAL (i.e. no throttling)
245 */
246int throttle_info_io_will_be_throttled(void *throttle_info_handle, int policy);
247
248#ifdef KERNEL_PRIVATE
249
250/* returned by throttle_io_will_be_throttled */
251#define THROTTLE_DISENGAGED 0
252#define THROTTLE_ENGAGED 1
253#define THROTTLE_NOW 2
254
255int throttle_io_will_be_throttled(int lowpri_window_msecs, mount_t mp);
256int throttle_lowpri_window(void) __attribute__((pure));
257struct uthread;
258void throttle_info_reset_window(struct uthread *ut);
259
260#endif
261
262#ifdef XNU_KERNEL_PRIVATE
263void *exec_spawnattr_getmacpolicyinfo(const void *macextensions, const char *policyname, size_t *lenp);
264#endif
265
266#ifdef BSD_KERNEL_PRIVATE
267
268void sys_override_io_throttle(boolean_t enable_override);
269
270#endif /* BSD_KERNEL_PRIVATE */
271
272__END_DECLS
273
274#endif /* !_SYS_SYSTM_H_ */
275