xref: /xnu-12377.81.4/bsd/sys/reboot.h (revision 043036a2b3718f7f0be807e2870f8f47d3fa0796)
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 #include <uuid/uuid.h>
71 
72 /*
73  * Arguments to reboot system call.
74  */
75 
76 #ifdef __APPLE_API_PRIVATE
77 #define RB_AUTOBOOT     0       /* flags for system auto-booting itself */
78 
79 #define RB_ASKNAME      0x01    /* ask for file name to reboot from */
80 #define RB_SINGLE       0x02    /* reboot to single user only */
81 #define RB_NOSYNC       0x04    /* dont sync before reboot */
82 #define RB_HALT         0x08    /* don't reboot, just halt */
83 #define RB_INITNAME     0x10    /* name given for /etc/init */
84 #define RB_DFLTROOT     0x20    /* use compiled-in rootdev */
85 #define RB_ALTBOOT      0x40    /* use /boot.old vs /boot */
86 #define RB_UNIPROC      0x80    /* don't start slaves */
87 #define RB_SAFEBOOT     0x100   /* booting safe */
88 #define RB_UPSDELAY 0x200   /* Delays restart by 5 minutes */
89 #define RB_QUICK        0x400   /* quick and ungraceful reboot with file system caches flushed*/
90 #define RB_PANIC        0x800   /* panic the kernel */
91 #define RB_PANIC_ZPRINT 0x1000   /* add zprint info to panic string */
92 #define RB_PANIC_FORCERESET 0x2000   /* do force-reset panic */
93 
94 __BEGIN_DECLS
95 __options_closed_decl(panic_with_data_flags, unsigned int, {
96 	PANIC_WITH_DATA_FLAGS_NONE = 0,
97 	PANIC_WITH_DATA_FLAGS_EXCLAVE_STACKSHOT,
98 	PANIC_WITH_DATA_FLAGS_MAX,
99 });
100 
101 #ifndef KERNEL
102 /* userspace reboot control */
103 int usrctl(uint32_t flags);
104 /* The normal reboot syscall. */
105 int reboot(int howto);
106 /* Used with RB_PANIC to panic the kernel from userspace with a message.
107  * Requires an entitlement on Release. */
108 int reboot_np(int howto, const char *message);
109 
110 /* Used to panic the kernel from user space and add additional data to
111  * the paniclog.
112  */
113 int panic_with_data(uuid_t uuid, void *addr, uint32_t len, uint32_t flags, const char *msg);
114 #endif /* KERNEL */
115 __END_DECLS
116 
117 #endif /* __APPLE_API_PRIVATE */
118 
119 #ifdef __APPLE_API_OBSOLETE
120 /*
121  * Constants for converting boot-style device number to type,
122  * adaptor (uba, mba, etc), unit number and partition number.
123  * Type (== major device number) is in the low byte
124  * for backward compatibility.  Except for that of the "magic
125  * number", each mask applies to the shifted value.
126  * Format:
127  *	 (4) (4) (4) (4)  (8)     (8)
128  *	--------------------------------
129  *	|MA | AD| CT| UN| PART  | TYPE |
130  *	--------------------------------
131  */
132 #define B_ADAPTORSHIFT  24
133 #define B_ADAPTORMASK   0x0f
134 #define B_ADAPTOR(val)          (((val) >> B_ADAPTORSHIFT) & B_ADAPTORMASK)
135 #define B_CONTROLLERSHIFT       20
136 #define B_CONTROLLERMASK        0xf
137 #define B_CONTROLLER(val)       (((val)>>B_CONTROLLERSHIFT) & B_CONTROLLERMASK)
138 #define B_UNITSHIFT     16
139 #define B_UNITMASK      0xff
140 #define B_UNIT(val)             (((val) >> B_UNITSHIFT) & B_UNITMASK)
141 #define B_PARTITIONSHIFT 8
142 #define B_PARTITIONMASK 0xff
143 #define B_PARTITION(val)        (((val) >> B_PARTITIONSHIFT) & B_PARTITIONMASK)
144 #define B_TYPESHIFT     0
145 #define B_TYPEMASK      0xff
146 #define B_TYPE(val)             (((val) >> B_TYPESHIFT) & B_TYPEMASK)
147 #define B_MAGICMASK     0xf0000000
148 #define B_DEVMAGIC      0xa0000000
149 
150 #define MAKEBOOTDEV(type, adaptor, controller, unit, partition) \
151 	(((type) << B_TYPESHIFT) | ((adaptor) << B_ADAPTORSHIFT) | \
152 	((controller) << B_CONTROLLERSHIFT) | ((unit) << B_UNITSHIFT) | \
153 	((partition) << B_PARTITIONSHIFT) | B_DEVMAGIC)
154 
155 #endif /* __APPLE_API_OBSOLETE */
156 
157 #ifdef XNU_KERNEL_PRIVATE
158 
159 __BEGIN_DECLS
160 int     reboot_kernel(int, char *);
161 __END_DECLS
162 
163 #define PROC_SHUTDOWN_LOG "/var/log/kernel-shutdown.log"
164 
165 #endif /* XNU_KERNEL_PRIVATE */
166 
167 #if KERNEL_PRIVATE
168 __BEGIN_DECLS
169 int get_system_inshutdown(void);
170 int get_system_inuserspacereboot(void);
171 __END_DECLS
172 #endif /* KERNEL_PRIVATE */
173 
174 #endif  /* _SYS_REBOOT_H_ */
175