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: head/lib/libproc/libproc.h 272488 2014-10-03 23:20:37Z markj $ 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#include <sys/ptrace.h> 40 41struct ctf_file; 42struct proc_handle; 43 44typedef void (*proc_child_func)(void *); 45 46/* Values returned by proc_state(). */ 47#define PS_IDLE 1 48#define PS_STOP 2 49#define PS_RUN 3 50#define PS_UNDEAD 4 51#define PS_DEAD 5 52#define PS_LOST 6 53 54/* Flags for proc_attach(). */ 55#define PATTACH_FORCE 0x01 56#define PATTACH_RDONLY 0x02 57#define PATTACH_NOSTOP 0x04 58 59/* Reason values for proc_detach(). */ 60#define PRELEASE_HANG 1 61#define PRELEASE_KILL 2 62 63typedef struct prmap { 64 uintptr_t pr_vaddr; /* Virtual address. */ 65 size_t pr_size; /* Mapping size in bytes */ 66 size_t pr_offset; /* Mapping offset in object */ 67 char pr_mapname[PATH_MAX]; /* Mapping filename */ 68 uint8_t pr_mflags; /* Protection flags */ 69#define MA_READ 0x01 70#define MA_WRITE 0x02 71#define MA_EXEC 0x04 72#define MA_COW 0x08 73#define MA_NEEDS_COPY 0x10 74#define MA_NOCOREDUMP 0x20 75} prmap_t; 76 77typedef struct prsyminfo { 78 u_int prs_lmid; /* Map id. */ 79 u_int prs_id; /* Symbol id. */ 80} prsyminfo_t; 81 82typedef int proc_map_f(void *, const prmap_t *, const char *); 83typedef int proc_sym_f(void *, const GElf_Sym *, const char *); 84 85/* Values for ELF sections */ 86#define PR_SYMTAB 1 87#define PR_DYNSYM 2 88 89/* Values for the 'mask' parameter in the iteration functions */ 90#define BIND_LOCAL 0x0001 91#define BIND_GLOBAL 0x0002 92#define BIND_WEAK 0x0004 93#define BIND_ANY (BIND_LOCAL|BIND_GLOBAL|BIND_WEAK) 94#define TYPE_NOTYPE 0x0100 95#define TYPE_OBJECT 0x0200 96#define TYPE_FUNC 0x0400 97#define TYPE_SECTION 0x0800 98#define TYPE_FILE 0x1000 99#define TYPE_ANY (TYPE_NOTYPE|TYPE_OBJECT|TYPE_FUNC|TYPE_SECTION|\ 100 TYPE_FILE) 101 102typedef enum { 103 REG_PC, 104 REG_SP, 105 REG_RVAL1, 106 REG_RVAL2 107} proc_reg_t; 108 109#define SIG2STR_MAX 8 110 111typedef struct lwpstatus { 112 int pr_why; 113#define PR_REQUESTED 1 114#define PR_FAULTED 2 115#define PR_SYSENTRY 3 116#define PR_SYSEXIT 4 117#define PR_SIGNALLED 5 118 int pr_what; 119#define FLTBPT -1 120} lwpstatus_t; 121 122#define PR_MODEL_ILP32 1 123#define PR_MODEL_LP64 2 124 125typedef struct { 126 uint8_t data[PTRACE_BREAKPOINT_SIZE]; 127} proc_breakpoint_t; 128 129typedef unsigned long proc_regvalue_t; 130 131/* Function prototype definitions. */ 132__BEGIN_DECLS 133 134prmap_t *proc_addr2map(struct proc_handle *, uintptr_t); 135prmap_t *proc_name2map(struct proc_handle *, const char *); 136char *proc_objname(struct proc_handle *, uintptr_t, char *, size_t); 137prmap_t *proc_obj2map(struct proc_handle *, const char *); 138int proc_iter_objs(struct proc_handle *, proc_map_f *, void *); 139int proc_iter_symbyaddr(struct proc_handle *, const char *, int, 140 int, proc_sym_f *, void *); 141int proc_addr2sym(struct proc_handle *, uintptr_t, char *, size_t, GElf_Sym *); 142int proc_attach(pid_t pid, int flags, struct proc_handle **pphdl); 143int proc_continue(struct proc_handle *); 144int proc_clearflags(struct proc_handle *, int); 145int proc_create(const char *, char * const *, proc_child_func *, void *, 146 struct proc_handle **); 147int proc_detach(struct proc_handle *, int); 148int proc_getflags(struct proc_handle *); 149int proc_name2sym(struct proc_handle *, const char *, const char *, 150 GElf_Sym *, prsyminfo_t *); 151struct ctf_file *proc_name2ctf(struct proc_handle *, const char *); 152int proc_setflags(struct proc_handle *, int); 153int proc_state(struct proc_handle *); 154int proc_getmodel(struct proc_handle *); 155pid_t proc_getpid(struct proc_handle *); 156int proc_wstatus(struct proc_handle *); 157int proc_getwstat(struct proc_handle *); 158char * proc_signame(int, char *, size_t); 159int proc_read(struct proc_handle *, void *, size_t, size_t); 160const lwpstatus_t *proc_getlwpstatus(struct proc_handle *); 161void proc_free(struct proc_handle *); 162rd_agent_t *proc_rdagent(struct proc_handle *); 163void proc_updatesyms(struct proc_handle *); 164int proc_bkptset(struct proc_handle *, uintptr_t, proc_breakpoint_t *); 165int proc_bkptdel(struct proc_handle *, uintptr_t, proc_breakpoint_t *); 166void proc_bkptregadj(unsigned long *); 167int proc_bkptexec(struct proc_handle *, proc_breakpoint_t *); 168int proc_regget(struct proc_handle *, proc_reg_t, proc_regvalue_t *); 169int proc_regset(struct proc_handle *, proc_reg_t, proc_regvalue_t); 170 171__END_DECLS 172 173#endif /* !_LIBPROC_H_ */ 174