master
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 */
38
39#ifndef _SYS_EXEC_H_
40#define _SYS_EXEC_H_
41
42/*
43 * Before ps_args existed, the following structure, found at the top of
44 * the user stack of each user process, was used by ps(1) to locate
45 * environment and argv strings. Normally ps_argvstr points to the
46 * argv vector, and ps_nargvstr is the same as the program's argc. The
47 * fields ps_envstr and ps_nenvstr are the equivalent for the environment.
48 *
49 * Programs should now use setproctitle(3) to change ps output.
50 * setproctitle() always informs the kernel with sysctl and sets the
51 * pointers in ps_strings. The kern.proc.args sysctl first tries p_args.
52 * If p_args is NULL, it then falls back to reading ps_strings and following
53 * the pointers.
54 */
55struct ps_strings {
56 char **ps_argvstr; /* first of 0 or more argument strings */
57 unsigned int ps_nargvstr; /* the number of argument strings */
58 char **ps_envstr; /* first of 0 or more environment strings */
59 unsigned int ps_nenvstr; /* the number of environment strings */
60};
61
62/* Coredump output parameters. */
63struct coredump_params {
64 off_t offset;
65 struct ucred *active_cred;
66 struct ucred *file_cred;
67 struct thread *td;
68 struct vnode *vp;
69 struct compressor *comp;
70};
71
72struct image_params;
73
74struct execsw {
75 int (*ex_imgact)(struct image_params *);
76 const char *ex_name;
77};
78
79#include <machine/exec.h>
80
81#ifdef _KERNEL
82#include <sys/cdefs.h>
83
84/*
85 * Address of ps_strings structure (in user space).
86 * Prefer the kern.ps_strings or kern.proc.ps_strings sysctls to this constant.
87 */
88#define PS_STRINGS (USRSTACK - sizeof(struct ps_strings))
89#define PROC_PS_STRINGS(p) \
90 ((p)->p_vmspace->vm_stacktop - (p)->p_sysent->sv_psstringssz)
91
92/*
93 * Address of signal trampoline (in user space).
94 * This assumes that the sigcode resides in the shared page.
95 */
96#define PROC_SIGCODE(p) \
97 ((p)->p_vmspace->vm_shp_base + (p)->p_sysent->sv_sigcode_offset)
98
99#define PROC_HAS_SHP(p) \
100 ((p)->p_sysent->sv_shared_page_obj != NULL)
101
102int exec_map_first_page(struct image_params *);
103void exec_unmap_first_page(struct image_params *);
104
105int exec_register(const struct execsw *);
106int exec_unregister(const struct execsw *);
107
108enum uio_seg;
109
110#define CORE_BUF_SIZE (16 * 1024)
111
112int core_write(struct coredump_params *, const void *, size_t, off_t,
113 enum uio_seg, size_t *);
114int core_output(char *, size_t, off_t, struct coredump_params *, void *);
115int sbuf_drain_core_output(void *, const char *, int);
116
117extern int coredump_pack_fileinfo;
118extern int coredump_pack_vmmapinfo;
119
120/*
121 * note: name##_mod cannot be const storage because the
122 * linker_file_sysinit() function modifies _file in the
123 * moduledata_t.
124 */
125
126#include <sys/module.h>
127
128#define EXEC_SET(name, execsw_arg) \
129 static int __CONCAT(name,_modevent)(module_t mod, int type, \
130 void *data) \
131 { \
132 struct execsw *exec = (struct execsw *)data; \
133 int error = 0; \
134 switch (type) { \
135 case MOD_LOAD: \
136 /* printf(#name " module loaded\n"); */ \
137 error = exec_register(exec); \
138 if (error) \
139 printf(__XSTRING(name) "register failed\n"); \
140 break; \
141 case MOD_UNLOAD: \
142 /* printf(#name " module unloaded\n"); */ \
143 error = exec_unregister(exec); \
144 if (error) \
145 printf(__XSTRING(name) " unregister failed\n");\
146 break; \
147 default: \
148 error = EOPNOTSUPP; \
149 break; \
150 } \
151 return error; \
152 } \
153 static moduledata_t __CONCAT(name,_mod) = { \
154 __XSTRING(name), \
155 __CONCAT(name,_modevent), \
156 (void *)& execsw_arg \
157 }; \
158 DECLARE_MODULE_TIED(name, __CONCAT(name,_mod), SI_SUB_EXEC, \
159 SI_ORDER_ANY)
160#endif
161
162#endif