xref: /freebsd-12.1/sys/sys/exec.h (revision 5bf39b8d)
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  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the University of
21  *	California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *	@(#)exec.h	8.3 (Berkeley) 1/21/94
39  * $FreeBSD$
40  */
41 
42 #ifndef _SYS_EXEC_H_
43 #define _SYS_EXEC_H_
44 
45 /*
46  * The following structure is found at the top of the user stack of each
47  * user process. The ps program uses it to locate argv and environment
48  * strings. Programs that wish ps to display other information may modify
49  * it; normally ps_argvstr points to the argv vector, and ps_nargvstr
50  * is the same as the program's argc. The fields ps_envstr and ps_nenvstr
51  * are the equivalent for the environment.
52  */
53 struct ps_strings {
54 	char	**ps_argvstr;	/* first of 0 or more argument strings */
55 	int	ps_nargvstr;	/* the number of argument strings */
56 	char	**ps_envstr;	/* first of 0 or more environment strings */
57 	int	ps_nenvstr;	/* the number of environment strings */
58 };
59 
60 /*
61  * Address of ps_strings structure (in user space).
62  */
63 #define	PS_STRINGS	(USRSTACK - sizeof(struct ps_strings))
64 #define SPARE_USRSPACE	4096
65 
66 struct image_params;
67 
68 struct execsw {
69 	int (*ex_imgact)(struct image_params *);
70 	const char *ex_name;
71 };
72 
73 #include <machine/exec.h>
74 
75 #ifdef _KERNEL
76 #include <sys/cdefs.h>
77 
78 int exec_map_first_page(struct image_params *);
79 void exec_unmap_first_page(struct image_params *);
80 
81 int exec_register(const struct execsw *);
82 int exec_unregister(const struct execsw *);
83 
84 /*
85  * note: name##_mod cannot be const storage because the
86  * linker_file_sysinit() function modifies _file in the
87  * moduledata_t.
88  */
89 
90 #include <sys/module.h>
91 
92 #define EXEC_SET(name, execsw_arg) \
93 	static int __CONCAT(name,_modevent)(module_t mod, int type, \
94 	    void *data) \
95 	{ \
96 		struct execsw *exec = (struct execsw *)data; \
97 		int error = 0; \
98 		switch (type) { \
99 		case MOD_LOAD: \
100 			/* printf(#name " module loaded\n"); */ \
101 			error = exec_register(exec); \
102 			if (error) \
103 				printf(__XSTRING(name) "register failed\n"); \
104 			break; \
105 		case MOD_UNLOAD: \
106 			/* printf(#name " module unloaded\n"); */ \
107 			error = exec_unregister(exec); \
108 			if (error) \
109 				printf(__XSTRING(name) " unregister failed\n");\
110 			break; \
111 		default: \
112 			break; \
113 		} \
114 		return error; \
115 	} \
116 	static moduledata_t __CONCAT(name,_mod) = { \
117 		__XSTRING(name), \
118 		__CONCAT(name,_modevent), \
119 		(void *)& execsw_arg \
120 	}; \
121 	DECLARE_MODULE(name, __CONCAT(name,_mod), SI_SUB_EXEC, SI_ORDER_ANY)
122 #endif
123 
124 #endif
125