1 /*- 2 * Copyright (c) 2010 The FreeBSD Foundation 3 * Copyright (c) 2008 John Birrell (jb@freebsd.org) 4 * All rights reserved. 5 * 6 * Portions of this software were developed by Rui Paulo under sponsorship 7 * from the FreeBSD Foundation. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 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. 17 * 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 28 * SUCH DAMAGE. 29 * 30 * $FreeBSD$ 31 */ 32 33 #ifndef _LIBPROC_H_ 34 #define _LIBPROC_H_ 35 36 #include <gelf.h> 37 #include <rtld_db.h> 38 #include <limits.h> 39 40 struct ctf_file; 41 struct proc_handle; 42 43 typedef void (*proc_child_func)(void *); 44 45 /* Values returned by proc_state(). */ 46 #define PS_IDLE 1 47 #define PS_STOP 2 48 #define PS_RUN 3 49 #define PS_UNDEAD 4 50 #define PS_DEAD 5 51 #define PS_LOST 6 52 53 /* Reason values for proc_detach(). */ 54 #define PRELEASE_HANG 1 55 #define PRELEASE_KILL 2 56 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 */ 63 #define MA_READ 0x01 64 #define MA_WRITE 0x02 65 #define MA_EXEC 0x04 66 #define MA_COW 0x08 67 #define MA_NEEDS_COPY 0x10 68 #define MA_NOCOREDUMP 0x20 69 } prmap_t; 70 71 typedef struct prsyminfo { 72 u_int prs_lmid; /* Map id. */ 73 u_int prs_id; /* Symbol id. */ 74 } prsyminfo_t; 75 76 typedef int proc_map_f(void *, const prmap_t *, const char *); 77 typedef int proc_sym_f(void *, const GElf_Sym *, const char *); 78 79 /* Values for ELF sections */ 80 #define PR_SYMTAB 1 81 #define PR_DYNSYM 2 82 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|\ 94 TYPE_FILE) 95 96 typedef enum { 97 REG_PC, 98 REG_SP, 99 REG_RVAL1, 100 REG_RVAL2 101 } proc_reg_t; 102 103 #define SIG2STR_MAX 8 104 105 typedef struct lwpstatus { 106 int pr_why; 107 #define PR_REQUESTED 1 108 #define PR_FAULTED 2 109 #define PR_SYSENTRY 3 110 #define PR_SYSEXIT 4 111 #define PR_SIGNALLED 5 112 int pr_what; 113 #define FLTBPT -1 114 } lwpstatus_t; 115 116 /* Function prototype definitions. */ 117 __BEGIN_DECLS 118 119 prmap_t *proc_addr2map(struct proc_handle *, uintptr_t); 120 prmap_t *proc_name2map(struct proc_handle *, const char *); 121 char *proc_objname(struct proc_handle *, uintptr_t, char *, size_t); 122 prmap_t *proc_obj2map(struct proc_handle *, const char *); 123 int proc_iter_objs(struct proc_handle *, proc_map_f *, void *); 124 int proc_iter_symbyaddr(struct proc_handle *, const char *, int, 125 int, proc_sym_f *, void *); 126 int proc_addr2sym(struct proc_handle *, uintptr_t, char *, size_t, GElf_Sym *); 127 int proc_attach(pid_t pid, int flags, struct proc_handle **pphdl); 128 int proc_continue(struct proc_handle *); 129 int proc_clearflags(struct proc_handle *, int); 130 int proc_create(const char *, char * const *, proc_child_func *, void *, 131 struct proc_handle **); 132 int proc_detach(struct proc_handle *, int); 133 int proc_getflags(struct proc_handle *); 134 int proc_name2sym(struct proc_handle *, const char *, const char *, 135 GElf_Sym *, prsyminfo_t *); 136 struct ctf_file *proc_name2ctf(struct proc_handle *, const char *); 137 int proc_setflags(struct proc_handle *, int); 138 int proc_state(struct proc_handle *); 139 pid_t proc_getpid(struct proc_handle *); 140 int proc_wstatus(struct proc_handle *); 141 int proc_getwstat(struct proc_handle *); 142 char * proc_signame(int, char *, size_t); 143 int proc_read(struct proc_handle *, void *, size_t, size_t); 144 const lwpstatus_t *proc_getlwpstatus(struct proc_handle *); 145 void proc_free(struct proc_handle *); 146 rd_agent_t *proc_rdagent(struct proc_handle *); 147 void proc_updatesyms(struct proc_handle *); 148 int proc_bkptset(struct proc_handle *, uintptr_t, unsigned long *); 149 int proc_bkptdel(struct proc_handle *, uintptr_t, unsigned long); 150 void proc_bkptregadj(unsigned long *); 151 int proc_bkptexec(struct proc_handle *, unsigned long); 152 int proc_regget(struct proc_handle *, proc_reg_t, unsigned long *); 153 int proc_regset(struct proc_handle *, proc_reg_t, unsigned long); 154 155 __END_DECLS 156 157 #endif /* !_LIBPROC_H_ */ 158