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