proc.h revision df2c88cec5bf17a92f0d5d740e3b756f00b798c6
1/* 2 * This file is part of ltrace. 3 * Copyright (C) 2010,2011,2012,2013 Petr Machata, Red Hat Inc. 4 * Copyright (C) 2010 Joe Damato 5 * Copyright (C) 1998,2001,2008,2009 Juan Cespedes 6 * 7 * This program is free software; you can redistribute it and/or 8 * modify it under the terms of the GNU General Public License as 9 * published by the Free Software Foundation; either version 2 of the 10 * License, or (at your option) any later version. 11 * 12 * This program is distributed in the hope that it will be useful, but 13 * WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 15 * General Public License for more details. 16 * 17 * You should have received a copy of the GNU General Public License 18 * along with this program; if not, write to the Free Software 19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 20 * 02110-1301 USA 21 */ 22 23#ifndef _PROC_H_ 24#define _PROC_H_ 25 26#include "config.h" 27 28#include <sys/time.h> 29#include <stdint.h> 30 31#if defined(HAVE_LIBUNWIND) 32# include <libunwind.h> 33#endif /* defined(HAVE_LIBUNWIND) */ 34 35#include "ltrace.h" 36#include "dict.h" 37#include "sysdep.h" 38#include "callback.h" 39#include "forward.h" 40 41struct event_handler { 42 /* Event handler that overrides the default one. Should 43 * return NULL if the event was handled, otherwise the 44 * returned event is passed to the default handler. */ 45 Event *(*on_event)(struct event_handler *self, Event *event); 46 47 /* Called when the event handler removal is requested. */ 48 void (*destroy)(struct event_handler *self); 49}; 50 51enum process_state { 52 STATE_ATTACHED = 0, 53 STATE_BEING_CREATED, 54 STATE_IGNORED /* ignore this process (it's a fork and no -f was used) */ 55}; 56 57struct output_state { 58 size_t params_left; 59 int need_delim; 60}; 61 62struct callstack_element { 63 union { 64 int syscall; 65 struct library_symbol * libfunc; 66 } c_un; 67 int is_syscall; 68 arch_addr_t return_addr; 69 struct timeval time_spent; 70 struct fetch_context *fetch_context; 71 struct value_dict *arguments; 72 struct output_state out; 73}; 74 75/* XXX We should get rid of this. */ 76#define MAX_CALLDEPTH 64 77 78/* XXX We would rather have this all organized a little differently, 79 * have struct process for the whole group and struct task (or struct 80 * lwp, struct thread) for what's there for per-thread stuff. But for 81 * now this is the less invasive way of structuring it. */ 82struct process { 83 enum process_state state; 84 struct process *parent; /* needed by STATE_BEING_CREATED */ 85 char * filename; 86 pid_t pid; 87 88 /* Dictionary of breakpoints (which is a mapping 89 * address->breakpoint). This is NULL for non-leader 90 * processes. */ 91 struct dict *breakpoints; 92 93 int mask_32bit; /* 1 if 64-bit ltrace is tracing 32-bit process */ 94 unsigned int personality; 95 int tracesysgood; /* signal indicating a PTRACE_SYSCALL trap */ 96 97 size_t callstack_depth; 98 struct callstack_element callstack[MAX_CALLDEPTH]; 99 100 /* Linked list of libraries in backwards order of mapping. 101 * The last element is the executed binary itself. */ 102 struct library *libraries; 103 104 /* Arch-dependent: */ 105 void * instruction_pointer; 106 void * stack_pointer; /* To get return addr, args... */ 107 void * arch_ptr; 108 109 /* XXX We would like to replace this with a pointer to ABI 110 * object that would provide the relevant services, instead of 111 * checking the necessary flags in the back end ad 112 * nauseam. */ 113 short e_machine; 114 char e_class; 115 116#if defined(HAVE_LIBUNWIND) 117 /* libunwind address space */ 118 unw_addr_space_t unwind_as; 119 void *unwind_priv; 120#endif /* defined(HAVE_LIBUNWIND) */ 121 122 /* Set in leader. */ 123 struct event_handler *event_handler; 124 125 /** 126 * Process chaining. 127 **/ 128 struct process *next; 129 130 /* LEADER points to the leader thread of the POSIX.1 process. 131 If X->LEADER == X, then X is the leader thread and the 132 process structures chained by NEXT represent other threads, 133 up until, but not including, the next leader thread. 134 LEADER may be NULL after the leader has already exited. In 135 that case this process is waiting to be collected. */ 136 struct process *leader; 137 138 struct os_process_data os; 139 struct arch_process_data arch; 140}; 141 142/* Initialize a process given a path to binary FILENAME, with a PID, 143 * and add the process to an internal chain of traced processes. */ 144int process_init(struct process *proc, const char *filename, pid_t pid); 145 146/* PROC underwent an exec. This is a bit like process_destroy 147 * followed by process_init, except that some state is kept and the 148 * process doesn't lose it's place in the list of processes. */ 149int process_exec(struct process *proc); 150 151/* Release any memory allocated for PROC (but not PROC itself). Does 152 * NOT remove PROC from internal chain. 153 * 154 * XXX clearly this init/destroy pair is different than others and 155 * should be fixed. process_init should presumably be separate from 156 * process_add. */ 157void process_destroy(struct process *proc); 158 159struct process *open_program(const char *filename, pid_t pid); 160void open_pid(pid_t pid); 161struct process *pid2proc(pid_t pid); 162 163/* Clone the contents of PROC into the memory referenced by RETP. 164 * Returns 0 on success or a negative value on failure. */ 165int process_clone(struct process *retp, struct process *proc, pid_t pid); 166 167/* Iterate through the processes that ltrace currently traces. Tasks 168 * are considered to be processes for the purpose of this iterator. 169 * See callback.h for notes on iteration interfaces. */ 170struct process *each_process(struct process *start_after, 171 enum callback_status (*cb)(struct process *proc, 172 void *data), 173 void *data); 174 175/* Iterate through list of tasks of given process PROC. See 176 * callback.h for notes on iteration interfaces. */ 177struct process *each_task(struct process *proc, struct process *start_after, 178 enum callback_status (*cb)(struct process *proc, 179 void *data), 180 void *data); 181 182void change_process_leader(struct process *proc, struct process *leader); 183 184/* Prepare those parts of process initialization that need to be done 185 * after _start is hit (i.e. after dynamic linking was done). */ 186void process_hit_start(struct process *proc); 187 188/* Remove process from the list of traced processes, drop any events 189 * in the event queue, destroy it and free memory. */ 190void remove_process(struct process *proc); 191 192void install_event_handler(struct process *proc, struct event_handler *handler); 193void destroy_event_handler(struct process *proc); 194 195/* Add a library LIB to the list of PROC's libraries. */ 196void proc_add_library(struct process *proc, struct library *lib); 197 198/* Remove LIB from list of PROC's libraries. Returns 0 if the library 199 * was found and unlinked, otherwise returns a negative value. */ 200int proc_remove_library(struct process *proc, struct library *lib); 201 202/* Clear a delayed flag. If a symbol is neither latent, nor delayed, 203 * a breakpoint is inserted for it. Returns 0 if the activation was 204 * successful or a negative value if it failed. Note that if a symbol 205 * is both latent and delayed, this will not enable the corresponding 206 * breakpoint. */ 207int proc_activate_delayed_symbol(struct process *proc, 208 struct library_symbol *libsym); 209 210/* Iterate through the libraries of PROC. See callback.h for notes on 211 * iteration interfaces. */ 212struct library *proc_each_library(struct process *proc, 213 struct library *start_after, 214 enum callback_status (*cb)(struct process *p, 215 struct library *l, 216 void *data), 217 void *data); 218 219/* Insert BP into PROC. */ 220int proc_add_breakpoint(struct process *proc, struct breakpoint *bp); 221 222/* Remove BP from PROC. This has no reason to fail in runtime. If it 223 * does not find BP in PROC, it's hard error guarded by assertion. */ 224void proc_remove_breakpoint(struct process *proc, struct breakpoint *bp); 225 226/* Iterate through the breakpoints of PROC. See callback.h for notes 227 * on iteration interfaces. */ 228void *proc_each_breakpoint(struct process *proc, void *start, 229 enum callback_status (*cb)(struct process *proc, 230 struct breakpoint *bp, 231 void *data), 232 void *data); 233 234/* Iterate through the dynamic section at src_addr looking for D_TAG. 235 * If tag is found, fill it's value in RET and return 0. 236 * If tag is not found, return a negative value. */ 237int proc_find_dynamic_entry_addr(struct process *proc, arch_addr_t src_addr, 238 int d_tag, arch_addr_t *ret); 239 240/* Finds a symbol corresponding to LIBSYM in a process PROC. Returns 241 * 0 and sets *RETLIB and *RETSYM if the corresponding pointer is 242 * non-NULL. Returns a negative value when the symbols couldn't be 243 * found. */ 244int proc_find_symbol(struct process *proc, struct library_symbol *sym, 245 struct library **retlib, struct library_symbol **retsym); 246 247/* Iterate through all symbols in all libraries of PROC. See 248 * callback.h for notes on this interface. */ 249struct library_symbol *proc_each_symbol 250 (struct process *proc, struct library_symbol *start_after, 251 enum callback_status (*cb)(struct library_symbol *, void *), 252 void *data); 253 254/* Read 8, 16, 32 or 64-bit quantity located at ADDR in PROC. The 255 * resulting value is stored in *LP. 0 is returned on success or a 256 * negative value on failure. This uses umovebytes under the hood 257 * (see backend.h). */ 258int proc_read_8(struct process *proc, arch_addr_t addr, uint8_t *lp); 259int proc_read_16(struct process *proc, arch_addr_t addr, uint16_t *lp); 260int proc_read_32(struct process *proc, arch_addr_t addr, uint32_t *lp); 261int proc_read_64(struct process *proc, arch_addr_t addr, uint64_t *lp); 262 263#endif /* _PROC_H_ */ 264