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 120 extern char version[]; /* system version */ 121 extern const char *const copyright; /* system copyright */ 122 123 124 extern int boothowto; /* reboot flags, from console subsystem */ 125 extern int show_space; 126 extern int minimalboot; 127 #if CONFIG_DARKBOOT 128 extern int darkboot; 129 #endif 130 131 extern const int nblkdev; /* number of entries in bdevsw */ 132 extern const int nchrdev; /* number of entries in cdevsw */ 133 #endif /* BSD_KERNEL_PRIVATE */ 134 135 #ifdef KERNEL_PRIVATE 136 137 extern int securelevel; /* system security level */ 138 extern dev_t rootdev; /* root device */ 139 extern 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 154 int einval(void); 155 void nullsys(void); 156 int errsys(void); 157 int seltrue(dev_t dev, int which, struct proc *p); 158 void ttyprintf(struct tty *, const char *, ...) __printflike(2, 3); 159 void realitexpire(struct proc *, void*); 160 int hzto(struct timeval *tv); 161 void tablefull(const char *); 162 void uprintf(const char *, ...) __printflike(1, 2); 163 int copywithin(void *saddr, void *daddr, size_t len); 164 int64_t fulong(user_addr_t addr); 165 int sulong(user_addr_t addr, int64_t longword); 166 uint64_t fuulong(user_addr_t addr); 167 int suulong(user_addr_t addr, uint64_t ulongword); 168 int clone_system_shared_regions(int shared_regions_active, 169 int chain_regions, 170 int base_vnode); 171 extern kern_return_t bsd_exception(int, mach_exception_data_t codes, int); 172 extern void bsdinit_task(void); 173 extern void unix_syscall_return(int) __dead2; 174 void initclocks(void); 175 void startprofclock(struct proc *); 176 void stopprofclock(struct proc *); 177 void setstatclockrate(int hzrate); 178 struct time_value; 179 void get_procrustime(struct time_value *tv); 180 void load_init_program(struct proc *p); 181 void __pthread_testcancel(int presyscall); 182 void throttle_info_get_last_io_time(mount_t mp, struct timeval *tv); 183 void update_last_io_time(mount_t mp); 184 void throttle_info_end_io(buf_t bp); 185 #endif /* BSD_KERNEL_PRIVATE */ 186 187 #ifdef KERNEL_PRIVATE 188 void timeout(void (*)(void *), void *arg, int ticks); 189 void timeout_with_leeway(void (*)(void *), void *arg, int ticks, int leeway_ticks); 190 void untimeout(void (*)(void *), void *arg); 191 int bsd_hostname(char *, size_t, size_t*); 192 int vslock(user_addr_ut addr, user_size_ut len); 193 int vsunlock(user_addr_ut addr, user_size_ut len, int dirtied); 194 #endif /* KERNEL_PRIVATE */ 195 196 int nullop(void); 197 int nulldev(void); 198 int enoioctl(void); 199 int enosys(void); 200 int enxio(void); 201 int eopnotsupp(void); 202 void *hashinit(int count, int type, u_long *hashmask); 203 #if XNU_KERNEL_PRIVATE 204 LIST_HEAD(generic_hash_head, generic); 205 void hashinit_generic(int elements, 206 struct generic_hash_head *__counted_by(*out_count) *out_ptr, size_t *out_count); 207 #define hashinit_counted_by(_elements, _out_ptr, _out_count) do { \ 208 size_t __hashinit_out_count = 0; \ 209 struct generic_hash_head *__counted_by(__hashinit_out_count) __hashinit_out_hash = NULL; \ 210 hashinit_generic((_elements), &__hashinit_out_hash, &__hashinit_out_count); \ 211 (_out_ptr) = (typeof(*(_out_ptr)) *)__hashinit_out_hash; \ 212 (_out_count) = __hashinit_out_count; \ 213 } while (0) 214 #endif /* XNU_KERNEL_PRIVATE */ 215 void hashdestroy(void *, int type, u_long hashmask); 216 void ovbcopy(const void *from, void *to, size_t len); 217 int fubyte(user_addr_t addr); 218 int fuibyte(user_addr_t addr); 219 int subyte(user_addr_t addr, int byte); 220 int suibyte(user_addr_t addr, int byte); 221 long fuword(user_addr_t addr); 222 long fuiword(user_addr_t addr); 223 int suword(user_addr_t addr, long word); 224 int suiword(user_addr_t addr, long word); 225 #define fusize(_a) ((user_size_t)fulong(_a)) 226 #define susize(_a, _s) sulong((_a), (_s)) 227 #define fuptr(a) ((user_addr_t)fulong(_a) 228 #define suptr(_a, _p) sulong((_a), (_p)) 229 int useracc(user_addr_t addr, user_size_t len, int prot); 230 typedef void (*timeout_fcn_t)(void *); 231 void bsd_timeout(void (*)(void *), void *arg, struct timespec * ts); 232 void bsd_untimeout(void (*)(void *), void *arg); 233 void set_fsblocksize(struct vnode *); 234 uint64_t tvtoabstime(struct timeval *); 235 uint64_t tstoabstime(struct timespec *); 236 void *throttle_info_create(void); 237 void throttle_info_mount_ref(mount_t mp, void * throttle_info); 238 void throttle_info_mount_rel(mount_t mp); 239 void throttle_info_release(void *throttle_info); 240 void throttle_info_update(void *throttle_info, int flags); 241 uint32_t throttle_lowpri_io(int sleep_amount); 242 /* returns TRUE if the throttle_lowpri_io called with the same sleep_amount would've slept */ 243 int throttle_lowpri_io_will_be_throttled(int sleep_amount); 244 void throttle_set_thread_io_policy(int policy); 245 int throttle_get_thread_effective_io_policy(void); 246 int throttle_thread_io_tier_above_metadata(void); 247 248 typedef struct __throttle_info_handle *throttle_info_handle_t; 249 int throttle_info_ref_by_mask(uint64_t throttle_mask, throttle_info_handle_t *throttle_info_handle); 250 void throttle_info_rel_by_mask(throttle_info_handle_t throttle_info_handle); 251 void throttle_info_update_by_mask(void *throttle_info_handle, int flags); 252 void throttle_info_disable_throttle(int devno, boolean_t isfusion); 253 /* 254 * 'throttle_info_handle' acquired via 'throttle_info_ref_by_mask' 255 * 'policy' should be specified as either IOPOL_UTILITY or IPOL_THROTTLE, 256 * all other values will be treated as IOPOL_NORMAL (i.e. no throttling) 257 */ 258 int throttle_info_io_will_be_throttled(void *throttle_info_handle, int policy); 259 260 #ifdef KERNEL_PRIVATE 261 262 /* returned by throttle_io_will_be_throttled */ 263 #define THROTTLE_DISENGAGED 0 264 #define THROTTLE_ENGAGED 1 265 #define THROTTLE_NOW 2 266 267 int throttle_io_will_be_throttled(int lowpri_window_msecs, mount_t mp); 268 int throttle_lowpri_window(void) __attribute__((pure)); 269 struct uthread; 270 void throttle_info_reset_window(struct uthread *ut); 271 void throttle_info_update_with_type(void *throttle_info, int flags, boolean_t isssd); 272 273 #endif 274 275 #ifdef XNU_KERNEL_PRIVATE 276 void *exec_spawnattr_getmacpolicyinfo(const void *macextensions, const char *policyname, size_t *lenp); 277 #endif 278 279 #ifdef BSD_KERNEL_PRIVATE 280 281 void sys_override_io_throttle(boolean_t enable_override); 282 283 #endif /* BSD_KERNEL_PRIVATE */ 284 285 __END_DECLS 286 287 #endif /* !_SYS_SYSTM_H_ */ 288