xref: /xnu-8792.81.2/bsd/sys/reboot.h (revision 19c3b8c28c31cb8130e034cfb5df6bf9ba342d90)
1 /*
2  * Copyright (c) 2000-2006 Apple Computer, 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, 1986, 1988, 1993, 1994
31  *	The Regents of the University of California.  All rights reserved.
32  *
33  * Redistribution and use in source and binary forms, with or without
34  * modification, are permitted provided that the following conditions
35  * are met:
36  * 1. Redistributions of source code must retain the above copyright
37  *    notice, this list of conditions and the following disclaimer.
38  * 2. Redistributions in binary form must reproduce the above copyright
39  *    notice, this list of conditions and the following disclaimer in the
40  *    documentation and/or other materials provided with the distribution.
41  * 3. All advertising materials mentioning features or use of this software
42  *    must display the following acknowledgement:
43  *	This product includes software developed by the University of
44  *	California, Berkeley and its contributors.
45  * 4. Neither the name of the University nor the names of its contributors
46  *    may be used to endorse or promote products derived from this software
47  *    without specific prior written permission.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59  * SUCH DAMAGE.
60  *
61  *	@(#)reboot.h	8.3 (Berkeley) 12/13/94
62  */
63 
64 #ifndef _SYS_REBOOT_H_
65 #define _SYS_REBOOT_H_
66 
67 #include <sys/appleapiopts.h>
68 #include <sys/cdefs.h>
69 #include <stdint.h>
70 
71 /*
72  * Arguments to reboot system call.
73  */
74 
75 #ifdef __APPLE_API_PRIVATE
76 #define RB_AUTOBOOT     0       /* flags for system auto-booting itself */
77 
78 #define RB_ASKNAME      0x01    /* ask for file name to reboot from */
79 #define RB_SINGLE       0x02    /* reboot to single user only */
80 #define RB_NOSYNC       0x04    /* dont sync before reboot */
81 #define RB_HALT         0x08    /* don't reboot, just halt */
82 #define RB_INITNAME     0x10    /* name given for /etc/init */
83 #define RB_DFLTROOT     0x20    /* use compiled-in rootdev */
84 #define RB_ALTBOOT      0x40    /* use /boot.old vs /boot */
85 #define RB_UNIPROC      0x80    /* don't start slaves */
86 #define RB_SAFEBOOT     0x100   /* booting safe */
87 #define RB_UPSDELAY 0x200   /* Delays restart by 5 minutes */
88 #define RB_QUICK        0x400   /* quick and ungraceful reboot with file system caches flushed*/
89 #define RB_PANIC        0x800   /* panic the kernel */
90 #define RB_PANIC_ZPRINT 0x1000   /* add zprint info to panic string */
91 #define RB_PANIC_FORCERESET 0x2000   /* do force-reset panic */
92 
93 #ifndef KERNEL
94 __BEGIN_DECLS
95 /* userspace reboot control */
96 int usrctl(uint32_t flags);
97 /* The normal reboot syscall. */
98 int reboot(int howto);
99 /* Used with RB_PANIC to panic the kernel from userspace with a message.
100  * Requires an entitlement on Release. */
101 int reboot_np(int howto, const char *message);
102 __END_DECLS
103 #endif
104 
105 #endif /* __APPLE_API_PRIVATE */
106 
107 #ifdef __APPLE_API_OBSOLETE
108 /*
109  * Constants for converting boot-style device number to type,
110  * adaptor (uba, mba, etc), unit number and partition number.
111  * Type (== major device number) is in the low byte
112  * for backward compatibility.  Except for that of the "magic
113  * number", each mask applies to the shifted value.
114  * Format:
115  *	 (4) (4) (4) (4)  (8)     (8)
116  *	--------------------------------
117  *	|MA | AD| CT| UN| PART  | TYPE |
118  *	--------------------------------
119  */
120 #define B_ADAPTORSHIFT  24
121 #define B_ADAPTORMASK   0x0f
122 #define B_ADAPTOR(val)          (((val) >> B_ADAPTORSHIFT) & B_ADAPTORMASK)
123 #define B_CONTROLLERSHIFT       20
124 #define B_CONTROLLERMASK        0xf
125 #define B_CONTROLLER(val)       (((val)>>B_CONTROLLERSHIFT) & B_CONTROLLERMASK)
126 #define B_UNITSHIFT     16
127 #define B_UNITMASK      0xff
128 #define B_UNIT(val)             (((val) >> B_UNITSHIFT) & B_UNITMASK)
129 #define B_PARTITIONSHIFT 8
130 #define B_PARTITIONMASK 0xff
131 #define B_PARTITION(val)        (((val) >> B_PARTITIONSHIFT) & B_PARTITIONMASK)
132 #define B_TYPESHIFT     0
133 #define B_TYPEMASK      0xff
134 #define B_TYPE(val)             (((val) >> B_TYPESHIFT) & B_TYPEMASK)
135 #define B_MAGICMASK     0xf0000000
136 #define B_DEVMAGIC      0xa0000000
137 
138 #define MAKEBOOTDEV(type, adaptor, controller, unit, partition) \
139 	(((type) << B_TYPESHIFT) | ((adaptor) << B_ADAPTORSHIFT) | \
140 	((controller) << B_CONTROLLERSHIFT) | ((unit) << B_UNITSHIFT) | \
141 	((partition) << B_PARTITIONSHIFT) | B_DEVMAGIC)
142 
143 #endif /* __APPLE_API_OBSOLETE */
144 
145 #ifdef XNU_KERNEL_PRIVATE
146 
147 __BEGIN_DECLS
148 int     reboot_kernel(int, char *);
149 __END_DECLS
150 
151 #define PROC_SHUTDOWN_LOG "/var/log/kernel-shutdown.log"
152 
153 #endif /* XNU_KERNEL_PRIVATE */
154 
155 #if KERNEL_PRIVATE
156 __BEGIN_DECLS
157 int get_system_inshutdown(void);
158 __END_DECLS
159 #endif /* KERNEL_PRIVATE */
160 
161 #endif  /* _SYS_REBOOT_H_ */
162