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