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