2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2010 The FreeBSD Foundation
5 * Copyright (c) 2008 John Birrell (jb@freebsd.org)
8 * Portions of this software were developed by Rui Paulo under sponsorship
9 * from the FreeBSD Foundation.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
45 typedef void (*proc_child_func)(void *);
47 /* Values returned by proc_state(). */
55 /* Flags for proc_attach(). */
56 #define PATTACH_FORCE 0x01
57 #define PATTACH_RDONLY 0x02
58 #define PATTACH_NOSTOP 0x04
60 /* Reason values for proc_detach(). */
61 #define PRELEASE_HANG 1
62 #define PRELEASE_KILL 2
64 typedef struct prmap {
65 uintptr_t pr_vaddr; /* Virtual address. */
66 size_t pr_size; /* Mapping size in bytes */
67 size_t pr_offset; /* Mapping offset in object */
68 char pr_mapname[PATH_MAX]; /* Mapping filename */
69 uint8_t pr_mflags; /* Protection flags */
74 #define MA_NEEDS_COPY 0x10
75 #define MA_NOCOREDUMP 0x20
78 typedef struct prsyminfo {
79 u_int prs_lmid; /* Map id. */
80 u_int prs_id; /* Symbol id. */
83 typedef int proc_map_f(void *, const prmap_t *, const char *);
84 typedef int proc_sym_f(void *, const GElf_Sym *, const char *);
86 /* Values for ELF sections */
90 /* Values for the 'mask' parameter in the iteration functions */
91 #define BIND_LOCAL 0x0001
92 #define BIND_GLOBAL 0x0002
93 #define BIND_WEAK 0x0004
94 #define BIND_ANY (BIND_LOCAL|BIND_GLOBAL|BIND_WEAK)
95 #define TYPE_NOTYPE 0x0100
96 #define TYPE_OBJECT 0x0200
97 #define TYPE_FUNC 0x0400
98 #define TYPE_SECTION 0x0800
99 #define TYPE_FILE 0x1000
100 #define TYPE_ANY (TYPE_NOTYPE|TYPE_OBJECT|TYPE_FUNC|TYPE_SECTION|\
110 #define SIG2STR_MAX 8
112 typedef struct lwpstatus {
114 #define PR_REQUESTED 1
116 #define PR_SYSENTRY 3
118 #define PR_SIGNALLED 5
123 #define PR_MODEL_ILP32 1
124 #define PR_MODEL_LP64 2
126 struct proc_handle_public {
130 #define proc_getpid(phdl) (((struct proc_handle_public *)(phdl))->pid)
132 /* Function prototype definitions. */
135 prmap_t *proc_addr2map(struct proc_handle *, uintptr_t);
136 prmap_t *proc_name2map(struct proc_handle *, const char *);
137 char *proc_objname(struct proc_handle *, uintptr_t, char *, size_t);
138 int proc_iter_objs(struct proc_handle *, proc_map_f *, void *);
139 int proc_iter_symbyaddr(struct proc_handle *, const char *, int,
140 int, proc_sym_f *, void *);
141 int proc_addr2sym(struct proc_handle *, uintptr_t, char *, size_t, GElf_Sym *);
142 int proc_attach(pid_t pid, int flags, struct proc_handle **pphdl);
143 int proc_continue(struct proc_handle *);
144 int proc_clearflags(struct proc_handle *, int);
145 int proc_create(const char *, char * const *, char * const *,
146 proc_child_func *, void *, struct proc_handle **);
147 int proc_detach(struct proc_handle *, int);
148 int proc_getflags(struct proc_handle *);
149 int proc_name2sym(struct proc_handle *, const char *, const char *,
150 GElf_Sym *, prsyminfo_t *);
151 struct ctf_file *proc_name2ctf(struct proc_handle *, const char *);
152 int proc_setflags(struct proc_handle *, int);
153 int proc_state(struct proc_handle *);
154 int proc_getmodel(struct proc_handle *);
155 int proc_wstatus(struct proc_handle *);
156 int proc_getwstat(struct proc_handle *);
157 char * proc_signame(int, char *, size_t);
158 int proc_read(struct proc_handle *, void *, size_t, size_t);
159 const lwpstatus_t *proc_getlwpstatus(struct proc_handle *);
160 void proc_free(struct proc_handle *);
161 rd_agent_t *proc_rdagent(struct proc_handle *);
162 void proc_updatesyms(struct proc_handle *);
163 int proc_bkptset(struct proc_handle *, uintptr_t, unsigned long *);
164 int proc_bkptdel(struct proc_handle *, uintptr_t, unsigned long);
165 void proc_bkptregadj(unsigned long *);
166 int proc_bkptexec(struct proc_handle *, unsigned long);
167 int proc_regget(struct proc_handle *, proc_reg_t, unsigned long *);
168 int proc_regset(struct proc_handle *, proc_reg_t, unsigned long);
172 #endif /* _LIBPROC_H_ */