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