proc.h revision ecb082f480f057dc166c9d62e8776c892caf5e11
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 long debug_state; /* arch-dep debug state */ 116 void * instruction_pointer; 117 void * stack_pointer; /* To get return addr, args... */ 118 void * return_addr; 119 void * arch_ptr; 120 short e_machine; 121#ifdef __arm__ 122 int thumb_mode; /* ARM execution mode: 0: ARM, 1: Thumb */ 123#endif 124 125#if defined(HAVE_LIBUNWIND) 126 /* libunwind address space */ 127 unw_addr_space_t unwind_as; 128 void *unwind_priv; 129#endif /* defined(HAVE_LIBUNWIND) */ 130 131 /* Set in leader. */ 132 struct event_handler *event_handler; 133 134 /** 135 * Process chaining. 136 **/ 137 Process * next; 138 139 /* LEADER points to the leader thread of the POSIX.1 process. 140 If X->LEADER == X, then X is the leader thread and the 141 Process structures chained by NEXT represent other threads, 142 up until, but not including, the next leader thread. 143 LEADER may be NULL after the leader has already exited. In 144 that case this process is waiting to be collected. */ 145 Process * leader; 146}; 147 148int process_init(struct Process *proc, 149 const char *filename, pid_t pid, int enable_breakpoints); 150 151Process * open_program(const char *filename, pid_t pid, int enable_breakpoints); 152void open_pid(pid_t pid); 153Process * pid2proc(pid_t pid); 154 155/* Clone the contents of PROC into the memory referenced by RETP. 156 * Returns 0 on success or a negative value on failure. */ 157int process_clone(struct Process *retp, struct Process *proc, pid_t pid); 158 159/* Iterate through the processes that ltrace currently traces. CB is 160 * called for each process. Tasks are considered to be processes for 161 * the purpose of this iterator. 162 * 163 * Notes on this iteration interface: The iteration starts after the 164 * process designated by START_AFTER, or at the first process if 165 * START_AFTER is NULL. DATA is passed verbatim to CB. If CB returns 166 * CBS_STOP, the iteration stops and the current iterator is returned. 167 * That iterator can then be used to restart the iteration. NULL is 168 * returned when iteration ends. 169 * 170 * There's no provision for returning error states. Errors need to be 171 * signaled to the caller via DATA, together with any other data that 172 * the callback needs. */ 173Process *each_process(Process *start_after, 174 enum callback_status (*cb)(struct Process *proc, 175 void *data), 176 void *data); 177 178/* Iterate through list of tasks of given process PROC. Restarts are 179 * supported via START_AFTER (see each_process for details of 180 * iteration interface). */ 181Process *each_task(struct Process *proc, struct Process *start_after, 182 enum callback_status (*cb)(struct Process *proc, 183 void *data), 184 void *data); 185 186void add_process(Process *proc); 187void change_process_leader(Process *proc, Process *leader); 188void remove_process(Process *proc); 189void install_event_handler(Process *proc, struct event_handler *handler); 190void destroy_event_handler(Process *proc); 191 192/* Add a library LIB to the list of PROC's libraries. */ 193void proc_add_library(struct Process *proc, struct library *lib); 194 195/* Remove LIB from list of PROC's libraries. Returns 0 if the library 196 * was found and unlinked, otherwise returns a negative value. */ 197int proc_remove_library(struct Process *proc, struct library *lib); 198 199/* Iterate through the libraries of PROC. See each_process for 200 * detailed description of the iteration interface. */ 201struct library *proc_each_library(struct Process *proc, struct library *start, 202 enum callback_status (*cb)(struct Process *p, 203 struct library *l, 204 void *data), 205 void *data); 206 207/* Insert BP into PROC. */ 208int proc_add_breakpoint(struct Process *proc, struct breakpoint *bp); 209 210/* Remove BP from PROC. */ 211int proc_remove_breakpoint(struct Process *proc, struct breakpoint *bp); 212 213#endif /* _PROC_H_ */ 214