xref: /illumos-gate/usr/src/boot/sys/sys/exec.h (revision 55fea89d)
1 /*-
2  * Copyright (c) 1992, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 4. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)exec.h	8.3 (Berkeley) 1/21/94
35  * $FreeBSD$
36  */
37 
38 #ifndef _SYS_EXEC_H_
39 #define _SYS_EXEC_H_
40 
41 /*
42  * Before ps_args existed, the following structure, found at the top of
43  * the user stack of each user process, was used by ps(1) to locate
44  * environment and argv strings.  Normally ps_argvstr points to the
45  * argv vector, and ps_nargvstr is the same as the program's argc. The
46  * fields ps_envstr and ps_nenvstr are the equivalent for the environment.
47  *
48  * Programs should now use setproctitle(3) to change ps output.
49  * setproctitle() always informs the kernel with sysctl and sets the
50  * pointers in ps_strings.  The kern.proc.args sysctl first tries p_args.
51  * If p_args is NULL, it then falls back to reading ps_strings and following
52  * the pointers.
53  */
54 struct ps_strings {
55 	char	**ps_argvstr;	/* first of 0 or more argument strings */
56 	unsigned int ps_nargvstr; /* the number of argument strings */
57 	char	**ps_envstr;	/* first of 0 or more environment strings */
58 	unsigned int ps_nenvstr; /* the number of environment strings */
59 };
60 
61 /*
62  * Address of ps_strings structure (in user space).
63  * Prefer the kern.ps_strings or kern.proc.ps_strings sysctls to this constant.
64  */
65 #define	PS_STRINGS	(USRSTACK - sizeof(struct ps_strings))
66 #define SPARE_USRSPACE	4096
67 
68 struct image_params;
69 
70 struct execsw {
71 	int (*ex_imgact)(struct image_params *);
72 	const char *ex_name;
73 };
74 
75 #include <machine/exec.h>
76 
77 #ifdef _KERNEL
78 #include <sys/cdefs.h>
79 
80 int exec_map_first_page(struct image_params *);
81 void exec_unmap_first_page(struct image_params *);
82 
83 int exec_register(const struct execsw *);
84 int exec_unregister(const struct execsw *);
85 
86 extern int coredump_pack_fileinfo;
87 extern int coredump_pack_vmmapinfo;
88 
89 /*
90  * note: name##_mod cannot be const storage because the
91  * linker_file_sysinit() function modifies _file in the
92  * moduledata_t.
93  */
94 
95 #include <sys/module.h>
96 
97 #define EXEC_SET(name, execsw_arg) \
98 	static int __CONCAT(name,_modevent)(module_t mod, int type, \
99 	    void *data) \
100 	{ \
101 		struct execsw *exec = (struct execsw *)data; \
102 		int error = 0; \
103 		switch (type) { \
104 		case MOD_LOAD: \
105 			/* printf(#name " module loaded\n"); */ \
106 			error = exec_register(exec); \
107 			if (error) \
108 				printf(__XSTRING(name) "register failed\n"); \
109 			break; \
110 		case MOD_UNLOAD: \
111 			/* printf(#name " module unloaded\n"); */ \
112 			error = exec_unregister(exec); \
113 			if (error) \
114 				printf(__XSTRING(name) " unregister failed\n");\
115 			break; \
116 		default: \
117 			error = EOPNOTSUPP; \
118 			break; \
119 		} \
120 		return error; \
121 	} \
122 	static moduledata_t __CONCAT(name,_mod) = { \
123 		__XSTRING(name), \
124 		__CONCAT(name,_modevent), \
125 		(void *)& execsw_arg \
126 	}; \
127 	DECLARE_MODULE_TIED(name, __CONCAT(name,_mod), SI_SUB_EXEC, \
128 	    SI_ORDER_ANY)
129 #endif
130 
131 #endif
132