xref: /dragonfly/sys/sys/exec.h (revision 479ab7f0)
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. 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: src/sys/sys/exec.h,v 1.26 1999/12/29 04:24:40 peter Exp $
36  * $DragonFly: src/sys/sys/exec.h,v 1.5 2006/12/23 00:27:03 swildner Exp $
37  */
38 
39 #ifndef _SYS_EXEC_H_
40 #define _SYS_EXEC_H_
41 
42 /*
43  * The following structure is found at the top of the user stack of each
44  * user process. The ps program uses it to locate argv and environment
45  * strings. Programs that wish ps to display other information may modify
46  * it; normally ps_argvstr points to the argv vector, and ps_nargvstr
47  * is the same as the program's argc. The fields ps_envstr and ps_nenvstr
48  * are the equivalent for the environment.
49  */
50 struct ps_strings {
51 	char	**ps_argvstr;	/* first of 0 or more argument strings */
52 	int	ps_nargvstr;	/* the number of argument strings */
53 	char	**ps_envstr;	/* first of 0 or more environment strings */
54 	int	ps_nenvstr;	/* the number of environment strings */
55 };
56 
57 /*
58  * Address of ps_strings structure (in user space).
59  */
60 #define	PS_STRINGS	(USRSTACK - sizeof(struct ps_strings))
61 #define SPARE_USRSPACE	256
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 struct lwbuf;
76 int exec_map_page(struct image_params *, vm_pindex_t, struct lwbuf **,
77 		  const char **);
78 void exec_unmap_page(struct lwbuf *);
79 int exec_map_first_page (struct image_params *);
80 void exec_unmap_first_page (struct image_params *);
81 
82 int exec_register (const struct execsw *);
83 int exec_unregister (const struct execsw *);
84 
85 /*
86  * note: name##_mod cannot be const storage because the
87  * linker_file_sysinit() function modifies _file in the
88  * moduledata_t.
89  */
90 
91 #include <sys/module.h>
92 
93 #define DEFINE_EXEC_MODULE(name, execsw_arg) \
94 	static int name ## _modevent(module_t mod, int type, void *data) \
95 	{ \
96 		struct execsw *exec = (struct execsw *)data; \
97 		int error = 0; \
98 		switch (type) { \
99 		case MOD_LOAD: \
100 			/* kprintf(#name " module loaded\n"); */ \
101 			error = exec_register(exec); \
102 			if (error) \
103 				kprintf(#name "register failed\n"); \
104 			break; \
105 		case MOD_UNLOAD: \
106 			/* kprintf(#name " module unloaded\n"); */ \
107 			error = exec_unregister(exec); \
108 			if (error) \
109 				kprintf(#name " unregister failed\n"); \
110 			break; \
111 		default: \
112 			break; \
113 		} \
114 		return error; \
115 	} \
116 	static moduledata_t name ## _mod = { \
117 		#name, \
118 		name ## _modevent, \
119 		(void *)& execsw_arg \
120 	};
121 
122 #define EXEC_SET_ORDERED(name, execsw_arg, order)			\
123 	DEFINE_EXEC_MODULE(name, execsw_arg)				\
124 	DECLARE_MODULE(name, name ## _mod, SI_SUB_EXEC, order)
125 
126 #define EXEC_SET(name, execsw_arg)					\
127 	EXEC_SET_ORDERED(name, execsw_arg, SI_ORDER_ANY)
128 
129 #endif
130 
131 #endif
132