proc.h revision bac2da505ee174b7fb984b975c5938f88f0dbab2
1/* 2 * This file is part of ltrace. 3 * Copyright (C) 2010,2011,2012 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 30#if defined(HAVE_LIBUNWIND) 31# include <libunwind.h> 32#endif /* defined(HAVE_LIBUNWIND) */ 33 34#include "ltrace.h" 35#include "dict.h" 36#include "sysdep.h" 37 38struct library; 39struct breakpoint; 40 41/* XXX Move this somewhere where it makes sense. When the mess in 42 * common.h is disentangled, that would actually be a good place for 43 * this. */ 44enum callback_status { 45 CBS_STOP, /* The iteration should stop. */ 46 CBS_CONT, /* The iteration should continue. */ 47 CBS_FAIL, /* There was an error. The iteration should stop 48 * and return error. */ 49}; 50 51struct event_handler { 52 /* Event handler that overrides the default one. Should 53 * return NULL if the event was handled, otherwise the 54 * returned event is passed to the default handler. */ 55 Event *(*on_event)(struct event_handler *self, Event *event); 56 57 /* Called when the event handler removal is requested. */ 58 void (*destroy)(struct event_handler *self); 59}; 60 61enum process_state { 62 STATE_ATTACHED = 0, 63 STATE_BEING_CREATED, 64 STATE_IGNORED /* ignore this process (it's a fork and no -f was used) */ 65}; 66 67struct output_state { 68 size_t params_left; 69 int need_delim; 70}; 71 72struct callstack_element { 73 union { 74 int syscall; 75 struct library_symbol * libfunc; 76 } c_un; 77 int is_syscall; 78 void * return_addr; 79 struct timeval time_spent; 80 struct fetch_context *fetch_context; 81 struct value_dict *arguments; 82 struct output_state out; 83}; 84 85/* XXX We should get rid of this. */ 86#define MAX_CALLDEPTH 64 87 88/* XXX We would rather have this all organized a little differently, 89 * have Process for the whole group and Task for what's there for 90 * per-thread stuff. But for now this is the less invasive way of 91 * structuring it. */ 92typedef struct Process Process; 93struct Process { 94 enum process_state state; 95 Process * parent; /* needed by STATE_BEING_CREATED */ 96 char * filename; 97 pid_t pid; 98 99 /* Dictionary of breakpoints (which is a mapping 100 * address->breakpoint). This is NULL for non-leader 101 * processes. XXX note that we store addresses (keys) by 102 * value. That assumes that arch_addr_t fits in host 103 * pointer. */ 104 Dict * breakpoints; 105 106 int mask_32bit; /* 1 if 64-bit ltrace is tracing 32-bit process */ 107 unsigned int personality; 108 int tracesysgood; /* signal indicating a PTRACE_SYSCALL trap */ 109 110 size_t callstack_depth; 111 struct callstack_element callstack[MAX_CALLDEPTH]; 112 113 /* Linked list of libraries in backwards order of mapping. 114 * The last element is the executed binary itself. */ 115 struct library *libraries; 116 117 /* Arch-dependent: */ 118 void *debug; /* arch-dep process debug struct XXX move to 119 * os_process_data after it's invented. */ 120 void * instruction_pointer; 121 void * stack_pointer; /* To get return addr, args... */ 122 void * return_addr; 123 void * arch_ptr; 124 short e_machine; 125#ifdef __arm__ 126 int thumb_mode; /* ARM execution mode: 0: ARM, 1: Thumb */ 127#endif 128 129#if defined(HAVE_LIBUNWIND) 130 /* libunwind address space */ 131 unw_addr_space_t unwind_as; 132 void *unwind_priv; 133#endif /* defined(HAVE_LIBUNWIND) */ 134 135 /* Set in leader. */ 136 struct event_handler *event_handler; 137 138 /** 139 * Process chaining. 140 **/ 141 Process * next; 142 143 /* LEADER points to the leader thread of the POSIX.1 process. 144 If X->LEADER == X, then X is the leader thread and the 145 Process structures chained by NEXT represent other threads, 146 up until, but not including, the next leader thread. 147 LEADER may be NULL after the leader has already exited. In 148 that case this process is waiting to be collected. */ 149 Process * leader; 150 151 struct arch_process_data arch; 152}; 153 154/* Initialize a process given a path to binary FILENAME, with a PID, 155 * and add the process to an internal chain of traced processes. */ 156int process_init(struct Process *proc, const char *filename, pid_t pid); 157 158/* PROC underwent an exec. This is a bit like process_destroy 159 * followed by process_init, except that some state is kept and the 160 * process doesn't lose it's place in the list of processes. */ 161int process_exec(struct Process *proc); 162 163/* Release any memory allocated for PROC (but not PROC itself). Does 164 * NOT remove PROC from internal chain. 165 * 166 * XXX clearly this init/destroy pair is different than others and 167 * should be fixed. process_init should presumably be separate from 168 * process_add. */ 169void process_destroy(struct Process *proc); 170 171struct Process *open_program(const char *filename, pid_t pid); 172void open_pid(pid_t pid); 173Process * pid2proc(pid_t pid); 174 175/* Clone the contents of PROC into the memory referenced by RETP. 176 * Returns 0 on success or a negative value on failure. */ 177int process_clone(struct Process *retp, struct Process *proc, pid_t pid); 178 179/* Iterate through the processes that ltrace currently traces. CB is 180 * called for each process. Tasks are considered to be processes for 181 * the purpose of this iterator. 182 * 183 * Notes on this iteration interface: The iteration starts after the 184 * process designated by START_AFTER, or at the first process if 185 * START_AFTER is NULL. DATA is passed verbatim to CB. If CB returns 186 * CBS_STOP, the iteration stops and the current iterator is returned. 187 * That iterator can then be used to restart the iteration. NULL is 188 * returned when iteration ends. 189 * 190 * There's no provision for returning error states. Errors need to be 191 * signaled to the caller via DATA, together with any other data that 192 * the callback needs. */ 193Process *each_process(Process *start_after, 194 enum callback_status (*cb)(struct Process *proc, 195 void *data), 196 void *data); 197 198/* Iterate through list of tasks of given process PROC. Restarts are 199 * supported via START_AFTER (see each_process for details of 200 * iteration interface). */ 201Process *each_task(struct Process *proc, struct Process *start_after, 202 enum callback_status (*cb)(struct Process *proc, 203 void *data), 204 void *data); 205 206void change_process_leader(Process *proc, Process *leader); 207 208/* Remove process from the list of traced processes, drop any events 209 * in the event queue, destroy it and free memory. */ 210void remove_process(struct Process *proc); 211 212void install_event_handler(Process *proc, struct event_handler *handler); 213void destroy_event_handler(Process *proc); 214 215/* Add a library LIB to the list of PROC's libraries. */ 216void proc_add_library(struct Process *proc, struct library *lib); 217 218/* Remove LIB from list of PROC's libraries. Returns 0 if the library 219 * was found and unlinked, otherwise returns a negative value. */ 220int proc_remove_library(struct Process *proc, struct library *lib); 221 222/* Iterate through the libraries of PROC. See each_process for 223 * detailed description of the iteration interface. */ 224struct library *proc_each_library(struct Process *proc, struct library *start, 225 enum callback_status (*cb)(struct Process *p, 226 struct library *l, 227 void *data), 228 void *data); 229 230/* Insert BP into PROC. */ 231int proc_add_breakpoint(struct Process *proc, struct breakpoint *bp); 232 233/* Remove BP from PROC. This has no reason to fail in runtime. If it 234 * does not find BP in PROC, it's hard error guarded by assertion. */ 235void proc_remove_breakpoint(struct Process *proc, struct breakpoint *bp); 236 237/* Iterate through the libraries of PROC. See each_process for 238 * detailed description of the iteration interface. */ 239void *proc_each_breakpoint(struct Process *proc, void *start, 240 enum callback_status (*cb)(struct Process *proc, 241 struct breakpoint *bp, 242 void *data), 243 void *data); 244 245#endif /* _PROC_H_ */ 246