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