xref: /freebsd/sys/sys/procfs.h (revision 2008043f386721d58158e37e0d7e50df8095942d)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 1998 John D. Polstra.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _SYS_PROCFS_H_
30 #define _SYS_PROCFS_H_
31 
32 #include <sys/param.h>
33 #include <machine/reg.h>
34 
35 typedef struct reg gregset_t;
36 typedef struct fpreg fpregset_t;
37 
38 /*
39  * These structures define an interface between core files and the debugger.
40  * Never change or delete any elements.  If you add elements, add them to
41  * the end of the structure, and increment the value of its version field.
42  * This will help to ensure that today's core dump will still be usable
43  * with next year's debugger.
44  *
45  * A lot more things should be added to these structures.  At present,
46  * they contain the absolute bare minimum required to allow GDB to work
47  * with ELF core dumps.
48  */
49 
50 /*
51  * The parenthsized numbers like (1) indicate the minimum version number
52  * for which each element exists in the structure.  The version number is
53  * not bumped when adding new fields to the end, only if the meaning of
54  * an existing field changes.  Additional fields are annotated as (1a),
55  * (1b), etc. to indicate the groupings of additions.
56  */
57 
58 #define PRSTATUS_VERSION	1	/* Current version of prstatus_t */
59 
60 typedef struct prstatus {
61     int		pr_version;	/* Version number of struct (1) */
62     size_t	pr_statussz;	/* sizeof(prstatus_t) (1) */
63     size_t	pr_gregsetsz;	/* sizeof(gregset_t) (1) */
64     size_t	pr_fpregsetsz;	/* sizeof(fpregset_t) (1) */
65     int		pr_osreldate;	/* Kernel version (1) */
66     int		pr_cursig;	/* Current signal (1) */
67     pid_t	pr_pid;		/* LWP (Thread) ID (1) */
68     gregset_t	pr_reg;		/* General purpose registers (1) */
69 } prstatus_t;
70 
71 typedef gregset_t prgregset_t[1];
72 typedef fpregset_t prfpregset_t;
73 
74 #define PRFNAMESZ	16	/* Maximum command length saved */
75 #define PRARGSZ		80	/* Maximum argument bytes saved */
76 
77 #define PRPSINFO_VERSION	1	/* Current version of prpsinfo_t */
78 
79 typedef struct prpsinfo {
80     int		pr_version;	/* Version number of struct (1) */
81     size_t	pr_psinfosz;	/* sizeof(prpsinfo_t) (1) */
82     char	pr_fname[PRFNAMESZ+1];	/* Command name, null terminated (1) */
83     char	pr_psargs[PRARGSZ+1];	/* Arguments, null terminated (1) */
84     pid_t	pr_pid;		/* Process ID (1a) */
85 } prpsinfo_t;
86 
87 typedef struct thrmisc {
88     char	pr_tname[MAXCOMLEN+1];	/* Thread name, null terminated (1) */
89     u_int	_pad;			/* Convenience pad, 0-filled (1) */
90 } thrmisc_t;
91 
92 typedef uint64_t psaddr_t;	/* An address in the target process. */
93 
94 #ifdef __HAVE_REG32
95 typedef struct prstatus32 {
96 	int32_t	pr_version;
97 	uint32_t pr_statussz;
98 	uint32_t pr_gregsetsz;
99 	uint32_t pr_fpregsetsz;
100 	int32_t	pr_osreldate;
101 	int32_t	pr_cursig;
102 	int32_t	pr_pid;
103 	struct reg32 pr_reg;
104 } prstatus32_t;
105 
106 typedef struct prpsinfo32 {
107 	int32_t	pr_version;
108 	uint32_t pr_psinfosz;
109 	char	pr_fname[PRFNAMESZ+1];
110 	char	pr_psargs[PRARGSZ+1];
111 	int32_t	pr_pid;
112 } prpsinfo32_t;
113 
114 struct thrmisc32 {
115 	char	pr_tname[MAXCOMLEN+1];
116 	uint32_t _pad;
117 };
118 #endif /* __HAVE_REG32 */
119 
120 #endif /* _SYS_PROCFS_H_ */
121