xref: /freebsd/sys/sys/procfs.h (revision b2d48be1bc7df45ddd13b143a160d0acb5a383c5)
1 /*-
2  * Copyright (c) 1998 John D. Polstra.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
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.
53  */
54 
55 #define PRSTATUS_VERSION	1	/* Current version of prstatus_t */
56 
57 typedef struct prstatus {
58     int		pr_version;	/* Version number of struct (1) */
59     size_t	pr_statussz;	/* sizeof(prstatus_t) (1) */
60     size_t	pr_gregsetsz;	/* sizeof(gregset_t) (1) */
61     size_t	pr_fpregsetsz;	/* sizeof(fpregset_t) (1) */
62     int		pr_osreldate;	/* Kernel version (1) */
63     int		pr_cursig;	/* Current signal (1) */
64     pid_t	pr_pid;		/* Process ID (1) */
65     gregset_t	pr_reg;		/* General purpose registers (1) */
66 } prstatus_t;
67 
68 typedef gregset_t prgregset_t[1];
69 typedef fpregset_t prfpregset_t;
70 
71 #define PRFNAMESZ	16	/* Maximum command length saved */
72 #define PRARGSZ		80	/* Maximum argument bytes saved */
73 
74 #define PRPSINFO_VERSION	1	/* Current version of prpsinfo_t */
75 
76 typedef struct prpsinfo {
77     int		pr_version;	/* Version number of struct (1) */
78     size_t	pr_psinfosz;	/* sizeof(prpsinfo_t) (1) */
79     char	pr_fname[PRFNAMESZ+1];	/* Command name, null terminated (1) */
80     char	pr_psargs[PRARGSZ+1];	/* Arguments, null terminated (1) */
81 } prpsinfo_t;
82 
83 typedef struct thrmisc {
84     char	pr_tname[MAXCOMLEN+1];	/* Thread name, null terminated (1) */
85     u_int	_pad;			/* Convenience pad, 0-filled (1) */
86 } thrmisc_t;
87 
88 typedef uint64_t psaddr_t;	/* An address in the target process. */
89 
90 #ifdef __HAVE_REG32
91 typedef struct prstatus32 {
92 	int32_t	pr_version;
93 	uint32_t pr_statussz;
94 	uint32_t pr_gregsetsz;
95 	uint32_t pr_fpregsetsz;
96 	int32_t	pr_osreldate;
97 	int32_t	pr_cursig;
98 	int32_t	pr_pid;
99 	struct reg32 pr_reg;
100 } prstatus32_t;
101 
102 typedef struct prpsinfo32 {
103 	int32_t	pr_version;
104 	uint32_t pr_psinfosz;
105 	char	pr_fname[PRFNAMESZ+1];
106 	char	pr_psargs[PRARGSZ+1];
107 } prpsinfo32_t;
108 
109 struct thrmisc32 {
110 	char	pr_tname[MAXCOMLEN+1];
111 	uint32_t _pad;
112 };
113 #endif /* __HAVE_REG32 */
114 
115 #endif /* _SYS_PROCFS_H_ */
116