[apple/xnu.git] / bsd / sys / reboot.h

/*
 * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1982, 1986, 1988, 1993, 1994
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)reboot.h	8.3 (Berkeley) 12/13/94
 */

#ifndef	_SYS_REBOOT_H_
#define _SYS_REBOOT_H_

#include <sys/appleapiopts.h>
#include <sys/cdefs.h>
#include <stdint.h>

/*
 * Arguments to reboot system call.
 */

#ifdef __APPLE_API_PRIVATE
#define RB_AUTOBOOT	0	/* flags for system auto-booting itself */

#define RB_ASKNAME	0x01	/* ask for file name to reboot from */
#define RB_SINGLE	0x02	/* reboot to single user only */
#define RB_NOSYNC	0x04	/* dont sync before reboot */
#define RB_HALT		0x08	/* don't reboot, just halt */
#define RB_INITNAME	0x10	/* name given for /etc/init */
#define RB_DFLTROOT	0x20	/* use compiled-in rootdev */
#define RB_ALTBOOT	0x40	/* use /boot.old vs /boot */
#define RB_UNIPROC	0x80	/* don't start slaves */
#define RB_SAFEBOOT	0x100	/* booting safe */
#define RB_UPSDELAY 0x200   /* Delays restart by 5 minutes */
#define RB_QUICK	0x400	/* quick and ungraceful reboot with file system caches flushed*/
#define RB_PANIC	0x800   /* panic the kernel */
#define RB_PANIC_ZPRINT	0x1000   /* add zprint info to panic string */

#ifndef KERNEL
__BEGIN_DECLS
/* userspace reboot control */
int usrctl(uint32_t flags);
/* The normal reboot syscall. */
int reboot(int howto);
/* Used with RB_PANIC to panic the kernel from userspace with a message.
 * Requires an entitlement on Release. */
int reboot_np(int howto, const char *message);
__END_DECLS
#endif

#endif /* __APPLE_API_PRIVATE */

#ifdef __APPLE_API_OBSOLETE
/*
 * Constants for converting boot-style device number to type,
 * adaptor (uba, mba, etc), unit number and partition number.
 * Type (== major device number) is in the low byte
 * for backward compatibility.  Except for that of the "magic
 * number", each mask applies to the shifted value.
 * Format:
 *	 (4) (4) (4) (4)  (8)     (8)
 *	--------------------------------
 *	|MA | AD| CT| UN| PART  | TYPE |
 *	--------------------------------
 */
#define B_ADAPTORSHIFT	24
#define B_ADAPTORMASK	0x0f
#define	B_ADAPTOR(val)		(((val) >> B_ADAPTORSHIFT) & B_ADAPTORMASK)
#define B_CONTROLLERSHIFT	20
#define B_CONTROLLERMASK	0xf
#define	B_CONTROLLER(val)	(((val)>>B_CONTROLLERSHIFT) & B_CONTROLLERMASK)
#define B_UNITSHIFT	16
#define B_UNITMASK	0xff
#define	B_UNIT(val)		(((val) >> B_UNITSHIFT) & B_UNITMASK)
#define B_PARTITIONSHIFT 8
#define B_PARTITIONMASK	0xff
#define	B_PARTITION(val)	(((val) >> B_PARTITIONSHIFT) & B_PARTITIONMASK)
#define B_TYPESHIFT	0
#define B_TYPEMASK	0xff
#define	B_TYPE(val)		(((val) >> B_TYPESHIFT) & B_TYPEMASK)
#define B_MAGICMASK	0xf0000000
#define B_DEVMAGIC	0xa0000000

#define MAKEBOOTDEV(type, adaptor, controller, unit, partition) \
	(((type) << B_TYPESHIFT) | ((adaptor) << B_ADAPTORSHIFT) | \
	((controller) << B_CONTROLLERSHIFT) | ((unit) << B_UNITSHIFT) | \
	((partition) << B_PARTITIONSHIFT) | B_DEVMAGIC)

#endif /* __APPLE_API_OBSOLETE */

#ifdef BSD_KERNEL_PRIVATE
#include <machine/reboot.h>

__BEGIN_DECLS
int	reboot_kernel(int, char *);
__END_DECLS

#define PROC_SHUTDOWN_LOG "/var/log/kernel-shutdown.log"

#endif /* BSD_KERNEL_PRIVATE */

#if KERNEL_PRIVATE
__BEGIN_DECLS
int get_system_inshutdown(void);
__END_DECLS
#endif /* KERNEL_PRIVATE */

#endif	/* _SYS_REBOOT_H_ */
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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
9bccf70c	67	#include <sys/appleapiopts.h>
490019cf A	68	#include <sys/cdefs.h>
490019cf A	69	#include <stdint.h>
9bccf70c	70
1c79356b A	71	/*
	72	* Arguments to reboot system call.
	73	*/
	74
9bccf70c	75	#ifdef __APPLE_API_PRIVATE
1c79356b A	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 */
1c79356b A	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 */
2d21ac55	86	#define RB_SAFEBOOT 0x100 /* booting safe */
0c530ab8	87	#define RB_UPSDELAY 0x200 /* Delays restart by 5 minutes */
4a3eedf9	88	#define RB_QUICK 0x400 /* quick and ungraceful reboot with file system caches flushed*/
3e170ce0	89	#define RB_PANIC 0x800 /* panic the kernel */
d26ffc64	90	#define RB_PANIC_ZPRINT 0x1000 /* add zprint info to panic string */
1c79356b	91
490019cf A	92	#ifndef KERNEL
	93	__BEGIN_DECLS
	94	/* userspace reboot control */
	95	int usrctl(uint32_t flags);
5c9f4661 A	96	/* The normal reboot syscall. */
	97	int reboot(int howto);
	98	/* Used with RB_PANIC to panic the kernel from userspace with a message.
	99	* Requires an entitlement on Release. */
	100	int reboot_np(int howto, const char *message);
490019cf A	101	__END_DECLS
	102	#endif
	103
9bccf70c A	104	#endif /* __APPLE_API_PRIVATE */
	105
	106	#ifdef __APPLE_API_OBSOLETE
1c79356b A	107	/*
	108	* Constants for converting boot-style device number to type,
	109	* adaptor (uba, mba, etc), unit number and partition number.
	110	* Type (== major device number) is in the low byte
	111	* for backward compatibility. Except for that of the "magic
	112	* number", each mask applies to the shifted value.
	113	* Format:
	114	* (4) (4) (4) (4) (8) (8)
	115	* --------------------------------
	116	* \|MA \| AD\| CT\| UN\| PART \| TYPE \|
	117	* --------------------------------
	118	*/
	119	#define B_ADAPTORSHIFT 24
	120	#define B_ADAPTORMASK 0x0f
	121	#define B_ADAPTOR(val) (((val) >> B_ADAPTORSHIFT) & B_ADAPTORMASK)
	122	#define B_CONTROLLERSHIFT 20
	123	#define B_CONTROLLERMASK 0xf
	124	#define B_CONTROLLER(val) (((val)>>B_CONTROLLERSHIFT) & B_CONTROLLERMASK)
	125	#define B_UNITSHIFT 16
	126	#define B_UNITMASK 0xff
	127	#define B_UNIT(val) (((val) >> B_UNITSHIFT) & B_UNITMASK)
	128	#define B_PARTITIONSHIFT 8
	129	#define B_PARTITIONMASK 0xff
	130	#define B_PARTITION(val) (((val) >> B_PARTITIONSHIFT) & B_PARTITIONMASK)
	131	#define B_TYPESHIFT 0
	132	#define B_TYPEMASK 0xff
	133	#define B_TYPE(val) (((val) >> B_TYPESHIFT) & B_TYPEMASK)
	134	#define B_MAGICMASK 0xf0000000
	135	#define B_DEVMAGIC 0xa0000000
	136
	137	#define MAKEBOOTDEV(type, adaptor, controller, unit, partition) \
	138	(((type) << B_TYPESHIFT) \| ((adaptor) << B_ADAPTORSHIFT) \| \
	139	((controller) << B_CONTROLLERSHIFT) \| ((unit) << B_UNITSHIFT) \| \
	140	((partition) << B_PARTITIONSHIFT) \| B_DEVMAGIC)
	141
9bccf70c	142	#endif /* __APPLE_API_OBSOLETE */
91447636 A	143
91447636 A	144	#ifdef BSD_KERNEL_PRIVATE
1c79356b	145	#include <machine/reboot.h>
2d21ac55 A	146
2d21ac55 A	147	__BEGIN_DECLS
3e170ce0	148	int reboot_kernel(int, char *);
2d21ac55 A	149	__END_DECLS
2d21ac55 A	150
b0d623f7 A	151	#define PROC_SHUTDOWN_LOG "/var/log/kernel-shutdown.log"
b0d623f7 A	152
91447636	153	#endif /* BSD_KERNEL_PRIVATE */
1c79356b	154
813fb2f6 A	155	#if KERNEL_PRIVATE
	156	__BEGIN_DECLS
	157	int get_system_inshutdown(void);
	158	__END_DECLS
	159	#endif /* KERNEL_PRIVATE */
	160
1c79356b	161	#endif /* _SYS_REBOOT_H_ */