1/*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2010 The FreeBSD Foundation 5 * Copyright (c) 2008 John Birrell (jb@freebsd.org) 6 * All rights reserved. 7 * 8 * Portions of this software were developed by Rui Paulo under sponsorship 9 * from the FreeBSD Foundation. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 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. 19 * 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 30 * SUCH DAMAGE. 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 40struct ctf_file; 41struct proc_handle; 42 43typedef 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/* Flags for proc_attach(). */ 54#define PATTACH_FORCE 0x01 55#define PATTACH_RDONLY 0x02 56#define PATTACH_NOSTOP 0x04 57 58/* Reason values for proc_detach(). */ 59#define PRELEASE_HANG 1 60#define PRELEASE_KILL 2 61 62typedef struct prmap { 63 uintptr_t pr_vaddr; /* Virtual address. */ 64 size_t pr_size; /* Mapping size in bytes */ 65 size_t pr_offset; /* Mapping offset in object */ 66 char pr_mapname[PATH_MAX]; /* Mapping filename */ 67 uint8_t pr_mflags; /* Protection flags */ 68#define MA_READ 0x01 69#define MA_WRITE 0x02 70#define MA_EXEC 0x04 71#define MA_COW 0x08 72#define MA_NEEDS_COPY 0x10 73#define MA_NOCOREDUMP 0x20 74} prmap_t; 75 76typedef struct prsyminfo { 77 u_int prs_lmid; /* Map id. */ 78 u_int prs_id; /* Symbol id. */ 79} prsyminfo_t; 80 81typedef int proc_map_f(void *, const prmap_t *, const char *); 82typedef int proc_sym_f(void *, const GElf_Sym *, const char *); 83 84/* Values for ELF sections */ 85#define PR_SYMTAB 1 86#define PR_DYNSYM 2 87 88/* Values for the 'mask' parameter in the iteration functions */ 89#define BIND_LOCAL 0x0001 90#define BIND_GLOBAL 0x0002 91#define BIND_WEAK 0x0004 92#define BIND_ANY (BIND_LOCAL|BIND_GLOBAL|BIND_WEAK) 93#define TYPE_NOTYPE 0x0100 94#define TYPE_OBJECT 0x0200 95#define TYPE_FUNC 0x0400 96#define TYPE_SECTION 0x0800 97#define TYPE_FILE 0x1000 98#define TYPE_ANY (TYPE_NOTYPE|TYPE_OBJECT|TYPE_FUNC|TYPE_SECTION|\ 99 TYPE_FILE) 100 101typedef enum { 102 REG_PC, 103 REG_SP, 104 REG_RVAL1, 105 REG_RVAL2 106} proc_reg_t; 107 108#define SIG2STR_MAX 8 109 110typedef struct lwpstatus { 111 int pr_why; 112#define PR_REQUESTED 1 /* not implemented */ 113#define PR_FAULTED 2 114#define PR_SYSENTRY 3 115#define PR_SYSEXIT 4 116#define PR_SIGNALLED 5 117 int pr_what; 118#define FLTBPT -1 119} lwpstatus_t; 120 121#define PR_MODEL_ILP32 1 122#define PR_MODEL_LP64 2 123 124struct proc_handle_public { 125 pid_t pid; 126}; 127 128#define proc_getpid(phdl) (((struct proc_handle_public *)(phdl))->pid) 129 130/* Function prototype definitions. */ 131__BEGIN_DECLS 132 133prmap_t *proc_addr2map(struct proc_handle *, uintptr_t); 134prmap_t *proc_name2map(struct proc_handle *, const char *); 135char *proc_objname(struct proc_handle *, uintptr_t, char *, size_t); 136int proc_iter_objs(struct proc_handle *, proc_map_f *, void *); 137int proc_iter_symbyaddr(struct proc_handle *, const char *, int, 138 int, proc_sym_f *, void *); 139int proc_addr2sym(struct proc_handle *, uintptr_t, char *, size_t, GElf_Sym *); 140int proc_attach(pid_t pid, int flags, struct proc_handle **pphdl); 141int proc_continue(struct proc_handle *); 142int proc_clearflags(struct proc_handle *, int); 143int proc_create(const char *, char * const *, char * const *, 144 proc_child_func *, void *, struct proc_handle **); 145int proc_detach(struct proc_handle *, int); 146int proc_getflags(struct proc_handle *); 147int proc_name2sym(struct proc_handle *, const char *, const char *, 148 GElf_Sym *, prsyminfo_t *); 149struct ctf_file *proc_name2ctf(struct proc_handle *, const char *); 150int proc_setflags(struct proc_handle *, int); 151int proc_state(struct proc_handle *); 152int proc_getmodel(struct proc_handle *); 153int proc_wstatus(struct proc_handle *); 154int proc_getwstat(struct proc_handle *); 155char * proc_signame(int, char *, size_t); 156int proc_read(struct proc_handle *, void *, size_t, size_t); 157const lwpstatus_t *proc_getlwpstatus(struct proc_handle *); 158void proc_free(struct proc_handle *); 159rd_agent_t *proc_rdagent(struct proc_handle *); 160void proc_updatesyms(struct proc_handle *); 161int proc_bkptset(struct proc_handle *, uintptr_t, unsigned long *); 162int proc_bkptdel(struct proc_handle *, uintptr_t, unsigned long); 163void proc_bkptregadj(unsigned long *); 164int proc_bkptexec(struct proc_handle *, unsigned long); 165int proc_regget(struct proc_handle *, proc_reg_t, unsigned long *); 166int proc_regset(struct proc_handle *, proc_reg_t, unsigned long); 167 168__END_DECLS 169 170#endif /* _LIBPROC_H_ */ 171