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