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