xref: /illumos-gate/usr/src/uts/common/sys/uadmin.h (revision afbc45417fe46ac092547adfe04ef4966809b862)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 /*	Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T	*/
27 /*	  All Rights Reserved  	*/
28 
29 
30 #ifndef _SYS_UADMIN_H
31 #define	_SYS_UADMIN_H
32 
33 #pragma ident	"%Z%%M%	%I%	%E% SMI"
34 
35 #if !defined(_ASM)
36 #include <sys/types.h>
37 #include <sys/cred.h>
38 #endif
39 
40 #ifdef	__cplusplus
41 extern "C" {
42 #endif
43 
44 #define	A_REBOOT	1
45 #define	A_SHUTDOWN	2
46 #define	A_FREEZE	3	/* For freeze and thaw */
47 #define	A_REMOUNT	4
48 #define	A_DUMP		5
49 #define	A_FTRACE	15
50 #define	A_SWAPCTL	16
51 /*			17-21	   reserved for obsolete interface */
52 
53 #define	AD_UNKNOWN	-1	/* no method */
54 #define	AD_HALT		0	/* halt the processor */
55 #define	AD_BOOT		1	/* multi-user reboot */
56 #define	AD_IBOOT	2	/* multi-user reboot, ask for name of file */
57 #define	AD_SBOOT	3	/* single-user reboot */
58 #define	AD_SIBOOT	4	/* single-user reboot, ask for name of file */
59 #define	AD_POWEROFF	6	/* software poweroff */
60 #define	AD_NOSYNC	7	/* do not sync filesystems on next A_DUMP */
61 
62 
63 /*
64  * Functions reserved for A_FREEZE (may not be available on all platforms)
65  * Note:  AD_COMPRESS, AD_CHECK and AD_FORCE are now obsolete
66  *	The first two are succeeded by AD_SUSPEND_TO_DISK and
67  *		AD_CHECK_SUSPEND_TO_DISK respectively.
68  *	AD_FORCE should not be used by any new application
69  *
70  *	We maintain compatibility with the earlier interfaces:
71  *	AD_COMPRESS and AD_CHECK, by preserving those values
72  *	in the corresponding new interfaces
73  */
74 
75 #define	AD_COMPRESS	0	/* store state file compressed during CPR */
76 #define	AD_FORCE	1	/* force to do AD_COMPRESS */
77 #define	AD_CHECK	2	/* test if CPR module is available */
78 #define	AD_SUSPEND_TO_DISK	   AD_COMPRESS	/* A_FREEZE, CPR or ACPI S4 */
79 #define	AD_CHECK_SUSPEND_TO_DISK   AD_CHECK	/* A_FREEZE, CPR/S4 capable? */
80 #define	AD_SUSPEND_TO_RAM	   20		/* A_FREEZE, S3 */
81 #define	AD_CHECK_SUSPEND_TO_RAM	   21		/* A_FREEZE, S3 capable? */
82 
83 /*
84  * NOTE: the following defines comprise an Unstable interface.  Their semantics
85  * may change or they may be removed completely in a later release
86  */
87 #define	AD_REUSEINIT	3	/* prepare for AD_REUSABLE */
88 #define	AD_REUSABLE	4	/* create reusable statefile */
89 #define	AD_REUSEFINI	5	/* revert to normal CPR mode (not reusable) */
90 
91 #define	AD_FTRACE_START	1
92 #define	AD_FTRACE_STOP	2
93 
94 /*
95  * When 'mdep' (the second argument to uadmin(2)) is initialized for A_REBOOT,
96  * A_SHUTDOWN or A_DUMP, it represents the boot arguments string of at most
97  * 256 characters.
98  */
99 #define	BOOTARGS_MAX	256
100 
101 #if !defined(_ASM)
102 
103 #if defined(_KERNEL)
104 extern kmutex_t ualock;
105 extern void mdboot(int, int, char *, boolean_t);
106 extern void mdpreboot(int, int, char *);
107 extern int kadmin(int, int, void *, cred_t *);
108 extern void killall(zoneid_t);
109 #endif
110 
111 #if defined(__STDC__)
112 extern int uadmin(int, int, uintptr_t);
113 #else
114 extern int uadmin();
115 #endif
116 
117 #endif	/* _ASM */
118 
119 #ifdef	__cplusplus
120 }
121 #endif
122 
123 #endif	/* _SYS_UADMIN_H */
124