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 */
56struct 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
63struct image_params;
64
65struct 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
81int exec_map_first_page(struct image_params *);
82void exec_unmap_first_page(struct image_params *);
83
84int exec_register(const struct execsw *);
85int exec_unregister(const struct execsw *);
86
87extern int coredump_pack_fileinfo;
88extern int coredump_pack_vmmapinfo;
89
90/*
91 * note: name##_mod cannot be const storage because the
92 * linker_file_sysinit() function modifies _file in the
93 * moduledata_t.
94 */
95
96#include <sys/module.h>
97
98#define EXEC_SET(name, execsw_arg) \
99	static int __CONCAT(name,_modevent)(module_t mod, int type, \
100	    void *data) \
101	{ \
102		struct execsw *exec = (struct execsw *)data; \
103		int error = 0; \
104		switch (type) { \
105		case MOD_LOAD: \
106			/* printf(#name " module loaded\n"); */ \
107			error = exec_register(exec); \
108			if (error) \
109				printf(__XSTRING(name) "register failed\n"); \
110			break; \
111		case MOD_UNLOAD: \
112			/* printf(#name " module unloaded\n"); */ \
113			error = exec_unregister(exec); \
114			if (error) \
115				printf(__XSTRING(name) " unregister failed\n");\
116			break; \
117		default: \
118			error = EOPNOTSUPP; \
119			break; \
120		} \
121		return error; \
122	} \
123	static moduledata_t __CONCAT(name,_mod) = { \
124		__XSTRING(name), \
125		__CONCAT(name,_modevent), \
126		(void *)& execsw_arg \
127	}; \
128	DECLARE_MODULE_TIED(name, __CONCAT(name,_mod), SI_SUB_EXEC, \
129	    SI_ORDER_ANY)
130#endif
131
132#endif
133