blob: d5c526236c46c472aacd8bdb29cebec8b72ffd59 [file] [log] [blame]
Petr Machatacec06ec2012-04-10 13:31:55 +02001#include "config.h"
2
3#include <asm/unistd.h>
4#include <sys/types.h>
5#include <sys/wait.h>
6#include <assert.h>
7#include <errno.h>
Juan Cespedes5e01f651998-03-08 22:31:44 +01008#include <stdio.h>
Juan Cespedes504a3852003-02-04 23:24:38 +01009#include <stdlib.h>
Juan Cespedes1fe93d51998-03-13 00:29:21 +010010#include <string.h>
Juan Cespedes8f8282f2002-03-03 18:58:40 +010011#include <unistd.h>
Juan Cespedes5e01f651998-03-08 22:31:44 +010012
Petr Machatacec06ec2012-04-10 13:31:55 +020013#ifdef HAVE_LIBSELINUX
14# include <selinux/selinux.h>
15#endif
16
17#include "ptrace.h"
Juan Cespedesf7281232009-06-25 16:11:21 +020018#include "common.h"
Petr Machata9294d822012-02-07 12:35:58 +010019#include "breakpoint.h"
Petr Machata366c2f42012-02-09 19:34:36 +010020#include "proc.h"
Petr Machata92822542012-03-28 00:31:14 +020021#include "linux-gnu/trace.h"
Petr Machata55ed83b2007-05-17 16:24:15 +020022
23/* If the system headers did not provide the constants, hard-code the normal
24 values. */
25#ifndef PTRACE_EVENT_FORK
26
27#define PTRACE_OLDSETOPTIONS 21
28#define PTRACE_SETOPTIONS 0x4200
29#define PTRACE_GETEVENTMSG 0x4201
30
31/* options set using PTRACE_SETOPTIONS */
32#define PTRACE_O_TRACESYSGOOD 0x00000001
33#define PTRACE_O_TRACEFORK 0x00000002
34#define PTRACE_O_TRACEVFORK 0x00000004
35#define PTRACE_O_TRACECLONE 0x00000008
36#define PTRACE_O_TRACEEXEC 0x00000010
37#define PTRACE_O_TRACEVFORKDONE 0x00000020
38#define PTRACE_O_TRACEEXIT 0x00000040
39
40/* Wait extended result codes for the above trace options. */
41#define PTRACE_EVENT_FORK 1
42#define PTRACE_EVENT_VFORK 2
43#define PTRACE_EVENT_CLONE 3
44#define PTRACE_EVENT_EXEC 4
45#define PTRACE_EVENT_VFORK_DONE 5
46#define PTRACE_EVENT_EXIT 6
47
48#endif /* PTRACE_EVENT_FORK */
Ian Wienand9a2ad352006-02-20 22:44:45 +010049
Luis Machado55c5feb2008-03-12 15:56:01 +010050#ifdef ARCH_HAVE_UMOVELONG
Juan Cespedesa8909f72009-04-28 20:02:41 +020051extern int arch_umovelong (Process *, void *, long *, arg_type_info *);
Juan Cespedesf1350522008-12-16 18:19:58 +010052int
Juan Cespedesa8909f72009-04-28 20:02:41 +020053umovelong (Process *proc, void *addr, long *result, arg_type_info *info) {
Luis Machado55c5feb2008-03-12 15:56:01 +010054 return arch_umovelong (proc, addr, result, info);
55}
56#else
57/* Read a single long from the process's memory address 'addr' */
Juan Cespedesf1350522008-12-16 18:19:58 +010058int
Juan Cespedesa8909f72009-04-28 20:02:41 +020059umovelong (Process *proc, void *addr, long *result, arg_type_info *info) {
Luis Machado55c5feb2008-03-12 15:56:01 +010060 long pointed_to;
61
62 errno = 0;
63 pointed_to = ptrace (PTRACE_PEEKTEXT, proc->pid, addr, 0);
64 if (pointed_to == -1 && errno)
65 return -errno;
66
67 *result = pointed_to;
Arnaud Patardf16fcff2010-01-08 08:40:19 -050068 if (info) {
69 switch(info->type) {
70 case ARGTYPE_INT:
71 *result &= 0x00000000ffffffffUL;
72 default:
73 break;
74 };
75 }
Luis Machado55c5feb2008-03-12 15:56:01 +010076 return 0;
77}
78#endif
79
Juan Cespedesf1350522008-12-16 18:19:58 +010080void
Petr Machatacec06ec2012-04-10 13:31:55 +020081trace_fail_warning(pid_t pid)
82{
83 /* This was adapted from GDB. */
84#ifdef HAVE_LIBSELINUX
85 static int checked = 0;
86 if (checked)
87 return;
88 checked = 1;
89
90 /* -1 is returned for errors, 0 if it has no effect, 1 if
91 * PTRACE_ATTACH is forbidden. */
92 if (security_get_boolean_active("deny_ptrace") == 1)
93 fprintf(stderr,
94"The SELinux boolean 'deny_ptrace' is enabled, which may prevent ltrace from\n"
95"tracing other processes. You can disable this process attach protection by\n"
96"issuing 'setsebool deny_ptrace=0' in the superuser context.\n");
97#endif /* HAVE_LIBSELINUX */
98}
99
100void
101trace_me(void)
102{
Petr Machata26627682011-07-08 18:15:32 +0200103 debug(DEBUG_PROCESS, "trace_me: pid=%d", getpid());
Ian Wienand2d45b1a2006-02-20 22:48:07 +0100104 if (ptrace(PTRACE_TRACEME, 0, 1, 0) < 0) {
Juan Cespedes5e01f651998-03-08 22:31:44 +0100105 perror("PTRACE_TRACEME");
Petr Machatacec06ec2012-04-10 13:31:55 +0200106 trace_fail_warning(getpid());
Juan Cespedes5e01f651998-03-08 22:31:44 +0100107 exit(1);
108 }
109}
110
Petr Machatab4f9e0c2012-02-07 01:57:59 +0100111/* There's a (hopefully) brief period of time after the child process
Petr Machatac805c622012-03-02 00:10:37 +0100112 * forks when we can't trace it yet. Here we wait for kernel to
Petr Machatab4f9e0c2012-02-07 01:57:59 +0100113 * prepare the process. */
Petr Machatac805c622012-03-02 00:10:37 +0100114int
Petr Machatab4f9e0c2012-02-07 01:57:59 +0100115wait_for_proc(pid_t pid)
116{
Petr Machatac805c622012-03-02 00:10:37 +0100117 /* man ptrace: PTRACE_ATTACH attaches to the process specified
118 in pid. The child is sent a SIGSTOP, but will not
119 necessarily have stopped by the completion of this call;
120 use wait() to wait for the child to stop. */
121 if (waitpid(pid, NULL, __WALL) != pid) {
122 perror ("trace_pid: waitpid");
123 return -1;
Petr Machatab4f9e0c2012-02-07 01:57:59 +0100124 }
125
Petr Machatac805c622012-03-02 00:10:37 +0100126 return 0;
Petr Machatab4f9e0c2012-02-07 01:57:59 +0100127}
128
Juan Cespedesf1350522008-12-16 18:19:58 +0100129int
Petr Machatacec06ec2012-04-10 13:31:55 +0200130trace_pid(pid_t pid)
131{
Petr Machata26627682011-07-08 18:15:32 +0200132 debug(DEBUG_PROCESS, "trace_pid: pid=%d", pid);
Petr Machatacec06ec2012-04-10 13:31:55 +0200133 /* This shouldn't emit error messages, as there are legitimate
134 * reasons that the PID can't be attached: like it may have
135 * already ended. */
136 if (ptrace(PTRACE_ATTACH, pid, 1, 0) < 0)
Juan Cespedes273ea6d1998-03-14 23:02:40 +0100137 return -1;
Petr Machata89a53602007-01-25 18:05:44 +0100138
Petr Machatac805c622012-03-02 00:10:37 +0100139 return wait_for_proc(pid);
Juan Cespedes273ea6d1998-03-14 23:02:40 +0100140}
141
Juan Cespedesf1350522008-12-16 18:19:58 +0100142void
Petr Machata3ed2a422012-04-06 17:18:55 +0200143trace_set_options(struct Process *proc)
144{
Ian Wienand9a2ad352006-02-20 22:44:45 +0100145 if (proc->tracesysgood & 0x80)
146 return;
Petr Machata55ed83b2007-05-17 16:24:15 +0200147
Petr Machata3ed2a422012-04-06 17:18:55 +0200148 pid_t pid = proc->pid;
Petr Machata26627682011-07-08 18:15:32 +0200149 debug(DEBUG_PROCESS, "trace_set_options: pid=%d", pid);
Juan Cespedescd8976d2009-05-14 13:47:58 +0200150
Juan Cespedes1e583132009-04-07 18:17:11 +0200151 long options = PTRACE_O_TRACESYSGOOD | PTRACE_O_TRACEFORK |
152 PTRACE_O_TRACEVFORK | PTRACE_O_TRACECLONE |
153 PTRACE_O_TRACEEXEC;
Petr Machata55ed83b2007-05-17 16:24:15 +0200154 if (ptrace(PTRACE_SETOPTIONS, pid, 0, options) < 0 &&
155 ptrace(PTRACE_OLDSETOPTIONS, pid, 0, options) < 0) {
Ian Wienand9a2ad352006-02-20 22:44:45 +0100156 perror("PTRACE_SETOPTIONS");
157 return;
158 }
159 proc->tracesysgood |= 0x80;
160}
161
Juan Cespedesf1350522008-12-16 18:19:58 +0100162void
163untrace_pid(pid_t pid) {
Petr Machata26627682011-07-08 18:15:32 +0200164 debug(DEBUG_PROCESS, "untrace_pid: pid=%d", pid);
Juan Cespedes273ea6d1998-03-14 23:02:40 +0100165 ptrace(PTRACE_DETACH, pid, 1, 0);
Juan Cespedes1fe93d51998-03-13 00:29:21 +0100166}
167
Juan Cespedesf1350522008-12-16 18:19:58 +0100168void
169continue_after_signal(pid_t pid, int signum) {
Juan Cespedescd8976d2009-05-14 13:47:58 +0200170 debug(DEBUG_PROCESS, "continue_after_signal: pid=%d, signum=%d", pid, signum);
Petr Machata98f09922011-07-09 10:55:29 +0200171 ptrace(PTRACE_SYSCALL, pid, 0, signum);
172}
173
174static enum ecb_status
175event_for_pid(Event * event, void * data)
176{
177 if (event->proc != NULL && event->proc->pid == (pid_t)(uintptr_t)data)
178 return ecb_yield;
179 return ecb_cont;
180}
181
182static int
183have_events_for(pid_t pid)
184{
185 return each_qd_event(event_for_pid, (void *)(uintptr_t)pid) != NULL;
186}
187
188void
189continue_process(pid_t pid)
190{
191 debug(DEBUG_PROCESS, "continue_process: pid=%d", pid);
Petr Machata98f09922011-07-09 10:55:29 +0200192
193 /* Only really continue the process if there are no events in
Petr Machata36d19822011-10-21 16:03:45 +0200194 the queue for this process. Otherwise just wait for the
195 other events to arrive. */
Petr Machata98f09922011-07-09 10:55:29 +0200196 if (!have_events_for(pid))
197 /* We always trace syscalls to control fork(),
198 * clone(), execve()... */
199 ptrace(PTRACE_SYSCALL, pid, 0, 0);
200 else
201 debug(DEBUG_PROCESS,
202 "putting off the continue, events in que.");
203}
204
Petr Machata98f09922011-07-09 10:55:29 +0200205static struct pid_task *
206get_task_info(struct pid_set * pids, pid_t pid)
207{
Petr Machata750ca8c2011-10-06 14:29:34 +0200208 assert(pid != 0);
Petr Machata98f09922011-07-09 10:55:29 +0200209 size_t i;
210 for (i = 0; i < pids->count; ++i)
211 if (pids->tasks[i].pid == pid)
212 return &pids->tasks[i];
213
214 return NULL;
215}
216
217static struct pid_task *
218add_task_info(struct pid_set * pids, pid_t pid)
219{
220 if (pids->count == pids->alloc) {
221 size_t ns = (2 * pids->alloc) ?: 4;
222 struct pid_task * n = realloc(pids->tasks,
223 sizeof(*pids->tasks) * ns);
224 if (n == NULL)
225 return NULL;
226 pids->tasks = n;
227 pids->alloc = ns;
228 }
229 struct pid_task * task_info = &pids->tasks[pids->count++];
230 memset(task_info, 0, sizeof(*task_info));
231 task_info->pid = pid;
232 return task_info;
233}
234
Petr Machata2b46cfc2012-02-18 11:17:29 +0100235static enum callback_status
236task_stopped(struct Process *task, void *data)
Petr Machatacbe29c62011-09-27 02:27:58 +0200237{
238 enum process_status st = process_status(task->pid);
239 if (data != NULL)
240 *(enum process_status *)data = st;
241
242 /* If the task is already stopped, don't worry about it.
243 * Likewise if it managed to become a zombie or terminate in
244 * the meantime. This can happen when the whole thread group
245 * is terminating. */
246 switch (st) {
247 case ps_invalid:
248 case ps_tracing_stop:
249 case ps_zombie:
Petr Machata2b46cfc2012-02-18 11:17:29 +0100250 return CBS_CONT;
Petr Machataffe4cd22012-04-11 18:01:44 +0200251 case ps_sleeping:
Petr Machata36d19822011-10-21 16:03:45 +0200252 case ps_stop:
253 case ps_other:
Petr Machata2b46cfc2012-02-18 11:17:29 +0100254 return CBS_STOP;
Petr Machatacbe29c62011-09-27 02:27:58 +0200255 }
Petr Machata36d19822011-10-21 16:03:45 +0200256
257 abort ();
Petr Machatacbe29c62011-09-27 02:27:58 +0200258}
259
260/* Task is blocked if it's stopped, or if it's a vfork parent. */
Petr Machata2b46cfc2012-02-18 11:17:29 +0100261static enum callback_status
262task_blocked(struct Process *task, void *data)
Petr Machatacbe29c62011-09-27 02:27:58 +0200263{
264 struct pid_set * pids = data;
265 struct pid_task * task_info = get_task_info(pids, task->pid);
266 if (task_info != NULL
267 && task_info->vforked)
Petr Machata2b46cfc2012-02-18 11:17:29 +0100268 return CBS_CONT;
Petr Machatacbe29c62011-09-27 02:27:58 +0200269
270 return task_stopped(task, NULL);
271}
272
Petr Machata366c2f42012-02-09 19:34:36 +0100273static Event *process_vfork_on_event(struct event_handler *super, Event *event);
Petr Machatacbe29c62011-09-27 02:27:58 +0200274
Petr Machata2b46cfc2012-02-18 11:17:29 +0100275static enum callback_status
276task_vforked(struct Process *task, void *data)
Petr Machatacbe29c62011-09-27 02:27:58 +0200277{
278 if (task->event_handler != NULL
279 && task->event_handler->on_event == &process_vfork_on_event)
Petr Machata2b46cfc2012-02-18 11:17:29 +0100280 return CBS_STOP;
281 return CBS_CONT;
Petr Machatacbe29c62011-09-27 02:27:58 +0200282}
283
284static int
Petr Machata74132a42012-03-16 02:46:18 +0100285is_vfork_parent(struct Process *task)
Petr Machatacbe29c62011-09-27 02:27:58 +0200286{
Petr Machata74132a42012-03-16 02:46:18 +0100287 return each_task(task->leader, NULL, &task_vforked, NULL) != NULL;
Petr Machatacbe29c62011-09-27 02:27:58 +0200288}
289
Petr Machata2b46cfc2012-02-18 11:17:29 +0100290static enum callback_status
291send_sigstop(struct Process *task, void *data)
Petr Machata98f09922011-07-09 10:55:29 +0200292{
293 Process * leader = task->leader;
294 struct pid_set * pids = data;
295
296 /* Look for pre-existing task record, or add new. */
297 struct pid_task * task_info = get_task_info(pids, task->pid);
298 if (task_info == NULL)
299 task_info = add_task_info(pids, task->pid);
300 if (task_info == NULL) {
301 perror("send_sigstop: add_task_info");
302 destroy_event_handler(leader);
303 /* Signal failure upwards. */
Petr Machata2b46cfc2012-02-18 11:17:29 +0100304 return CBS_STOP;
Petr Machata98f09922011-07-09 10:55:29 +0200305 }
306
307 /* This task still has not been attached to. It should be
308 stopped by the kernel. */
309 if (task->state == STATE_BEING_CREATED)
Petr Machata2b46cfc2012-02-18 11:17:29 +0100310 return CBS_CONT;
Petr Machata98f09922011-07-09 10:55:29 +0200311
312 /* Don't bother sending SIGSTOP if we are already stopped, or
Petr Machatacbe29c62011-09-27 02:27:58 +0200313 * if we sent the SIGSTOP already, which happens when we are
314 * handling "onexit" and inherited the handler from breakpoint
315 * re-enablement. */
316 enum process_status st;
Petr Machata2b46cfc2012-02-18 11:17:29 +0100317 if (task_stopped(task, &st) == CBS_CONT)
318 return CBS_CONT;
Petr Machata98f09922011-07-09 10:55:29 +0200319 if (task_info->sigstopped) {
320 if (!task_info->delivered)
Petr Machata2b46cfc2012-02-18 11:17:29 +0100321 return CBS_CONT;
Petr Machata98f09922011-07-09 10:55:29 +0200322 task_info->delivered = 0;
323 }
324
Petr Machatacbe29c62011-09-27 02:27:58 +0200325 /* Also don't attempt to stop the process if it's a parent of
326 * vforked process. We set up event handler specially to hint
327 * us. In that case parent is in D state, which we use to
328 * weed out unnecessary looping. */
329 if (st == ps_sleeping
330 && is_vfork_parent (task)) {
331 task_info->vforked = 1;
Petr Machata2b46cfc2012-02-18 11:17:29 +0100332 return CBS_CONT;
Petr Machatacbe29c62011-09-27 02:27:58 +0200333 }
334
Petr Machata98f09922011-07-09 10:55:29 +0200335 if (task_kill(task->pid, SIGSTOP) >= 0) {
336 debug(DEBUG_PROCESS, "send SIGSTOP to %d", task->pid);
337 task_info->sigstopped = 1;
338 } else
339 fprintf(stderr,
340 "Warning: couldn't send SIGSTOP to %d\n", task->pid);
341
Petr Machata2b46cfc2012-02-18 11:17:29 +0100342 return CBS_CONT;
Petr Machata98f09922011-07-09 10:55:29 +0200343}
344
Petr Machata73894bd2011-08-20 23:47:34 +0200345/* On certain kernels, detaching right after a singlestep causes the
346 tracee to be killed with a SIGTRAP (that even though the singlestep
347 was properly caught by waitpid. The ugly workaround is to put a
348 breakpoint where IP points and let the process continue. After
349 this the breakpoint can be retracted and the process detached. */
Petr Machata98f09922011-07-09 10:55:29 +0200350static void
Petr Machata73894bd2011-08-20 23:47:34 +0200351ugly_workaround(Process * proc)
Petr Machata590c8082011-08-20 22:45:26 +0200352{
353 void * ip = get_instruction_pointer(proc);
Petr Machatabc373262012-02-07 23:31:15 +0100354 struct breakpoint *sbp = dict_find_entry(proc->leader->breakpoints, ip);
Petr Machata590c8082011-08-20 22:45:26 +0200355 if (sbp != NULL)
356 enable_breakpoint(proc, sbp);
357 else
Petr Machata9df15012012-02-20 12:49:46 +0100358 insert_breakpoint(proc, ip, NULL);
Petr Machata73894bd2011-08-20 23:47:34 +0200359 ptrace(PTRACE_CONT, proc->pid, 0, 0);
Petr Machata590c8082011-08-20 22:45:26 +0200360}
361
362static void
Petr Machata98f09922011-07-09 10:55:29 +0200363process_stopping_done(struct process_stopping_handler * self, Process * leader)
364{
365 debug(DEBUG_PROCESS, "process stopping done %d",
366 self->task_enabling_breakpoint->pid);
367 size_t i;
Petr Machata590c8082011-08-20 22:45:26 +0200368 if (!self->exiting) {
369 for (i = 0; i < self->pids.count; ++i)
370 if (self->pids.tasks[i].pid != 0
Petr Machata43d2fe52011-11-02 13:25:49 +0100371 && (self->pids.tasks[i].delivered
372 || self->pids.tasks[i].sysret))
Petr Machata590c8082011-08-20 22:45:26 +0200373 continue_process(self->pids.tasks[i].pid);
374 continue_process(self->task_enabling_breakpoint->pid);
375 destroy_event_handler(leader);
Petr Machatacb9a28d2012-03-28 11:11:32 +0200376 }
377
378 if (self->exiting) {
379 ugly_workaround:
Petr Machata590c8082011-08-20 22:45:26 +0200380 self->state = psh_ugly_workaround;
Petr Machata73894bd2011-08-20 23:47:34 +0200381 ugly_workaround(self->task_enabling_breakpoint);
Petr Machatacb9a28d2012-03-28 11:11:32 +0200382 } else {
383 switch ((self->ugly_workaround_p)(self)) {
384 case CBS_FAIL:
385 /* xxx handle me */
386 case CBS_STOP:
387 break;
388 case CBS_CONT:
389 goto ugly_workaround;
390 }
Petr Machata590c8082011-08-20 22:45:26 +0200391 }
392}
393
394/* Before we detach, we need to make sure that task's IP is on the
395 * edge of an instruction. So for tasks that have a breakpoint event
396 * in the queue, we adjust the instruction pointer, just like
397 * continue_after_breakpoint does. */
398static enum ecb_status
399undo_breakpoint(Event * event, void * data)
400{
401 if (event != NULL
402 && event->proc->leader == data
403 && event->type == EVENT_BREAKPOINT)
404 set_instruction_pointer(event->proc, event->e_un.brk_addr);
405 return ecb_cont;
406}
407
Petr Machata2b46cfc2012-02-18 11:17:29 +0100408static enum callback_status
409untrace_task(struct Process *task, void *data)
Petr Machata590c8082011-08-20 22:45:26 +0200410{
411 if (task != data)
412 untrace_pid(task->pid);
Petr Machata2b46cfc2012-02-18 11:17:29 +0100413 return CBS_CONT;
Petr Machata590c8082011-08-20 22:45:26 +0200414}
415
Petr Machata2b46cfc2012-02-18 11:17:29 +0100416static enum callback_status
417remove_task(struct Process *task, void *data)
Petr Machata590c8082011-08-20 22:45:26 +0200418{
419 /* Don't untrace leader just yet. */
420 if (task != data)
421 remove_process(task);
Petr Machata2b46cfc2012-02-18 11:17:29 +0100422 return CBS_CONT;
Petr Machata590c8082011-08-20 22:45:26 +0200423}
424
Petr Machata86d38282012-04-24 18:09:01 +0200425static enum callback_status
426retract_breakpoint_cb(struct Process *proc, struct breakpoint *bp, void *data)
427{
428 breakpoint_on_retract(bp, proc);
429 return CBS_CONT;
430}
431
Petr Machata590c8082011-08-20 22:45:26 +0200432static void
433detach_process(Process * leader)
434{
435 each_qd_event(&undo_breakpoint, leader);
436 disable_all_breakpoints(leader);
Petr Machata86d38282012-04-24 18:09:01 +0200437 proc_each_breakpoint(leader, NULL, retract_breakpoint_cb, NULL);
Petr Machata590c8082011-08-20 22:45:26 +0200438
439 /* Now untrace the process, if it was attached to by -p. */
440 struct opt_p_t * it;
441 for (it = opt_p; it != NULL; it = it->next) {
442 Process * proc = pid2proc(it->pid);
443 if (proc == NULL)
444 continue;
445 if (proc->leader == leader) {
Petr Machata74132a42012-03-16 02:46:18 +0100446 each_task(leader, NULL, &untrace_task, NULL);
Petr Machata590c8082011-08-20 22:45:26 +0200447 break;
448 }
449 }
Petr Machata74132a42012-03-16 02:46:18 +0100450 each_task(leader, NULL, &remove_task, leader);
Petr Machata98f09922011-07-09 10:55:29 +0200451 destroy_event_handler(leader);
Petr Machata590c8082011-08-20 22:45:26 +0200452 remove_task(leader, NULL);
Petr Machata98f09922011-07-09 10:55:29 +0200453}
454
455static void
456handle_stopping_event(struct pid_task * task_info, Event ** eventp)
457{
458 /* Mark all events, so that we know whom to SIGCONT later. */
Petr Machata3c9b6292011-08-20 15:05:41 +0200459 if (task_info != NULL)
Petr Machata98f09922011-07-09 10:55:29 +0200460 task_info->got_event = 1;
461
462 Event * event = *eventp;
463
464 /* In every state, sink SIGSTOP events for tasks that it was
465 * sent to. */
466 if (task_info != NULL
467 && event->type == EVENT_SIGNAL
468 && event->e_un.signum == SIGSTOP) {
469 debug(DEBUG_PROCESS, "SIGSTOP delivered to %d", task_info->pid);
470 if (task_info->sigstopped
471 && !task_info->delivered) {
472 task_info->delivered = 1;
473 *eventp = NULL; // sink the event
474 } else
475 fprintf(stderr, "suspicious: %d got SIGSTOP, but "
476 "sigstopped=%d and delivered=%d\n",
477 task_info->pid, task_info->sigstopped,
478 task_info->delivered);
Juan Cespedese74c80d2009-02-11 11:32:31 +0100479 }
Juan Cespedes5e01f651998-03-08 22:31:44 +0100480}
481
Petr Machata98f09922011-07-09 10:55:29 +0200482/* Some SIGSTOPs may have not been delivered to their respective tasks
483 * yet. They are still in the queue. If we have seen an event for
484 * that process, continue it, so that the SIGSTOP can be delivered and
Petr Machata36d19822011-10-21 16:03:45 +0200485 * caught by ltrace. We don't mind that the process is after
486 * breakpoint (and therefore potentially doesn't have aligned IP),
487 * because the signal will be delivered without the process actually
488 * starting. */
Petr Machata98f09922011-07-09 10:55:29 +0200489static void
490continue_for_sigstop_delivery(struct pid_set * pids)
491{
492 size_t i;
493 for (i = 0; i < pids->count; ++i) {
Petr Machata750ca8c2011-10-06 14:29:34 +0200494 if (pids->tasks[i].pid != 0
495 && pids->tasks[i].sigstopped
Petr Machata98f09922011-07-09 10:55:29 +0200496 && !pids->tasks[i].delivered
497 && pids->tasks[i].got_event) {
498 debug(DEBUG_PROCESS, "continue %d for SIGSTOP delivery",
499 pids->tasks[i].pid);
500 ptrace(PTRACE_SYSCALL, pids->tasks[i].pid, 0, 0);
501 }
502 }
Juan Cespedes5e01f651998-03-08 22:31:44 +0100503}
504
Petr Machata98f09922011-07-09 10:55:29 +0200505static int
Petr Machata750ca8c2011-10-06 14:29:34 +0200506event_exit_p(Event * event)
507{
508 return event != NULL && (event->type == EVENT_EXIT
509 || event->type == EVENT_EXIT_SIGNAL);
510}
511
512static int
Petr Machata98f09922011-07-09 10:55:29 +0200513event_exit_or_none_p(Event * event)
Petr Machataf789c9c2011-07-09 10:54:27 +0200514{
Petr Machata750ca8c2011-10-06 14:29:34 +0200515 return event == NULL || event_exit_p(event)
Petr Machata98f09922011-07-09 10:55:29 +0200516 || event->type == EVENT_NONE;
517}
518
519static int
520await_sigstop_delivery(struct pid_set * pids, struct pid_task * task_info,
521 Event * event)
522{
523 /* If we still didn't get our SIGSTOP, continue the process
524 * and carry on. */
525 if (event != NULL && !event_exit_or_none_p(event)
526 && task_info != NULL && task_info->sigstopped) {
527 debug(DEBUG_PROCESS, "continue %d for SIGSTOP delivery",
528 task_info->pid);
529 /* We should get the signal the first thing
530 * after this, so it should be OK to continue
531 * even if we are over a breakpoint. */
532 ptrace(PTRACE_SYSCALL, task_info->pid, 0, 0);
533
534 } else {
535 /* If all SIGSTOPs were delivered, uninstall the
536 * handler and continue everyone. */
537 /* XXX I suspect that we should check tasks that are
538 * still around. Is things are now, there should be a
539 * race between waiting for everyone to stop and one
540 * of the tasks exiting. */
541 int all_clear = 1;
542 size_t i;
543 for (i = 0; i < pids->count; ++i)
Petr Machata750ca8c2011-10-06 14:29:34 +0200544 if (pids->tasks[i].pid != 0
545 && pids->tasks[i].sigstopped
Petr Machata98f09922011-07-09 10:55:29 +0200546 && !pids->tasks[i].delivered) {
547 all_clear = 0;
548 break;
549 }
550 return all_clear;
551 }
552
553 return 0;
554}
555
Petr Machata590c8082011-08-20 22:45:26 +0200556static int
557all_stops_accountable(struct pid_set * pids)
558{
559 size_t i;
560 for (i = 0; i < pids->count; ++i)
561 if (pids->tasks[i].pid != 0
562 && !pids->tasks[i].got_event
563 && !have_events_for(pids->tasks[i].pid))
564 return 0;
565 return 1;
566}
567
Petr Machataa266acb2012-04-12 23:50:23 +0200568/* The protocol is: 0 for success, negative for failure, positive if
569 * default singlestep is to be used. */
Petr Machata9e1e9692012-04-19 02:29:38 +0200570int arch_atomic_singlestep(struct Process *proc, struct breakpoint *sbp,
Petr Machataa266acb2012-04-12 23:50:23 +0200571 int (*add_cb)(void *addr, void *data),
572 void *add_cb_data);
573
574#ifndef ARCH_HAVE_ATOMIC_SINGLESTEP
575int
Petr Machata9e1e9692012-04-19 02:29:38 +0200576arch_atomic_singlestep(struct Process *proc, struct breakpoint *sbp,
Petr Machataa266acb2012-04-12 23:50:23 +0200577 int (*add_cb)(void *addr, void *data),
578 void *add_cb_data)
Petr Machata06986d52011-11-02 13:22:46 +0100579{
Petr Machataa266acb2012-04-12 23:50:23 +0200580 return 1;
581}
582#endif
583
Petr Machata42748ac2012-04-19 04:24:25 +0200584static Event *process_stopping_on_event(struct event_handler *super,
585 Event *event);
586
587static void
588remove_atomic_breakpoints(struct Process *proc)
589{
Petr Machata24a47042012-04-19 18:15:08 +0200590 struct process_stopping_handler *self
591 = (void *)proc->leader->event_handler;
592 assert(self != NULL);
Petr Machata42748ac2012-04-19 04:24:25 +0200593 assert(self->super.on_event == process_stopping_on_event);
594
595 int ct = sizeof(self->atomic_skip_bp_addrs)
596 / sizeof(*self->atomic_skip_bp_addrs);
597 int i;
598 for (i = 0; i < ct; ++i)
599 if (self->atomic_skip_bp_addrs[i] != 0) {
Petr Machata622581f2012-04-23 19:40:40 +0200600 delete_breakpoint(proc, self->atomic_skip_bp_addrs[i]);
Petr Machata42748ac2012-04-19 04:24:25 +0200601 self->atomic_skip_bp_addrs[i] = 0;
602 }
603}
604
605static void
606atomic_singlestep_bp_on_hit(struct breakpoint *bp, struct Process *proc)
607{
608 remove_atomic_breakpoints(proc);
609}
610
Petr Machataa266acb2012-04-12 23:50:23 +0200611static int
612atomic_singlestep_add_bp(void *addr, void *data)
613{
614 struct process_stopping_handler *self = data;
615 struct Process *proc = self->task_enabling_breakpoint;
616
Petr Machata42748ac2012-04-19 04:24:25 +0200617 int ct = sizeof(self->atomic_skip_bp_addrs)
618 / sizeof(*self->atomic_skip_bp_addrs);
619 int i;
620 for (i = 0; i < ct; ++i)
621 if (self->atomic_skip_bp_addrs[i] == 0) {
622 self->atomic_skip_bp_addrs[i] = addr;
623 static struct bp_callbacks cbs = {
624 .on_hit = atomic_singlestep_bp_on_hit,
625 };
626 struct breakpoint *bp
Petr Machata622581f2012-04-23 19:40:40 +0200627 = insert_breakpoint(proc, addr, NULL);
Petr Machata42748ac2012-04-19 04:24:25 +0200628 breakpoint_set_callbacks(bp, &cbs);
629 return 0;
630 }
Petr Machataa266acb2012-04-12 23:50:23 +0200631
Petr Machata42748ac2012-04-19 04:24:25 +0200632 assert(!"Too many atomic singlestep breakpoints!");
633 abort();
Petr Machataa266acb2012-04-12 23:50:23 +0200634}
635
636static int
637singlestep(struct process_stopping_handler *self)
638{
639 struct Process *proc = self->task_enabling_breakpoint;
640
641 int status = arch_atomic_singlestep(self->task_enabling_breakpoint,
642 self->breakpoint_being_enabled,
643 &atomic_singlestep_add_bp, self);
644
645 /* Propagate failure and success. */
646 if (status <= 0)
647 return status;
648
649 /* Otherwise do the default action: singlestep. */
Petr Machata06986d52011-11-02 13:22:46 +0100650 debug(1, "PTRACE_SINGLESTEP");
Petr Machataa266acb2012-04-12 23:50:23 +0200651 if (ptrace(PTRACE_SINGLESTEP, proc->pid, 0, 0)) {
Petr Machata06986d52011-11-02 13:22:46 +0100652 perror("PTRACE_SINGLESTEP");
Petr Machataa266acb2012-04-12 23:50:23 +0200653 return -1;
654 }
655 return 0;
656}
657
658static void
Petr Machata9e1e9692012-04-19 02:29:38 +0200659post_singlestep(struct process_stopping_handler *self,
660 struct Event **eventp)
Petr Machataa266acb2012-04-12 23:50:23 +0200661{
662 continue_for_sigstop_delivery(&self->pids);
663
Petr Machataf1fd7cd2012-04-19 03:05:58 +0200664 if (*eventp != NULL && (*eventp)->type == EVENT_BREAKPOINT)
Petr Machataa266acb2012-04-12 23:50:23 +0200665 *eventp = NULL; // handled
666
Petr Machata42748ac2012-04-19 04:24:25 +0200667 struct Process *proc = self->task_enabling_breakpoint;
Petr Machataa266acb2012-04-12 23:50:23 +0200668
Petr Machata42748ac2012-04-19 04:24:25 +0200669 remove_atomic_breakpoints(proc);
Petr Machataa266acb2012-04-12 23:50:23 +0200670 self->breakpoint_being_enabled = NULL;
671}
672
673static void
Petr Machata9e1e9692012-04-19 02:29:38 +0200674singlestep_error(struct process_stopping_handler *self)
Petr Machataa266acb2012-04-12 23:50:23 +0200675{
676 struct Process *teb = self->task_enabling_breakpoint;
Petr Machata9e1e9692012-04-19 02:29:38 +0200677 struct breakpoint *sbp = self->breakpoint_being_enabled;
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200678 fprintf(stderr, "%d couldn't continue when handling %s (%p) at %p\n",
Petr Machataa266acb2012-04-12 23:50:23 +0200679 teb->pid, sbp->libsym != NULL ? sbp->libsym->name : NULL,
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200680 sbp->addr, get_instruction_pointer(teb));
Petr Machataa266acb2012-04-12 23:50:23 +0200681 delete_breakpoint(teb->leader, sbp->addr);
Petr Machata06986d52011-11-02 13:22:46 +0100682}
683
Petr Machata9e1e9692012-04-19 02:29:38 +0200684static void
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200685pt_continue(struct process_stopping_handler *self)
Petr Machatac1aa9582012-03-27 23:54:01 +0200686{
687 struct Process *teb = self->task_enabling_breakpoint;
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200688 debug(1, "PTRACE_CONT");
Petr Machata9e1e9692012-04-19 02:29:38 +0200689 ptrace(PTRACE_CONT, teb->pid, 0, 0);
690}
691
692static void
693pt_singlestep(struct process_stopping_handler *self)
694{
695 if (singlestep(self) < 0)
696 singlestep_error(self);
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200697}
698
699static void
700disable_and(struct process_stopping_handler *self,
Petr Machata9e1e9692012-04-19 02:29:38 +0200701 void (*do_this)(struct process_stopping_handler *self))
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200702{
703 struct Process *teb = self->task_enabling_breakpoint;
704 debug(DEBUG_PROCESS, "all stopped, now singlestep/cont %d", teb->pid);
Petr Machatac1aa9582012-03-27 23:54:01 +0200705 if (self->breakpoint_being_enabled->enabled)
706 disable_breakpoint(teb, self->breakpoint_being_enabled);
Petr Machata9e1e9692012-04-19 02:29:38 +0200707 (do_this)(self);
Petr Machatac1aa9582012-03-27 23:54:01 +0200708 self->state = psh_singlestep;
709}
710
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200711void
712linux_ptrace_disable_and_singlestep(struct process_stopping_handler *self)
713{
Petr Machata9e1e9692012-04-19 02:29:38 +0200714 disable_and(self, &pt_singlestep);
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200715}
716
717void
718linux_ptrace_disable_and_continue(struct process_stopping_handler *self)
719{
720 disable_and(self, &pt_continue);
721}
722
Petr Machata98f09922011-07-09 10:55:29 +0200723/* This event handler is installed when we are in the process of
724 * stopping the whole thread group to do the pointer re-enablement for
725 * one of the threads. We pump all events to the queue for later
726 * processing while we wait for all the threads to stop. When this
727 * happens, we let the re-enablement thread to PTRACE_SINGLESTEP,
728 * re-enable, and continue everyone. */
729static Event *
Petr Machata366c2f42012-02-09 19:34:36 +0100730process_stopping_on_event(struct event_handler *super, Event *event)
Petr Machata98f09922011-07-09 10:55:29 +0200731{
732 struct process_stopping_handler * self = (void *)super;
733 Process * task = event->proc;
734 Process * leader = task->leader;
Petr Machatae21264e2011-10-06 14:30:33 +0200735 Process * teb = self->task_enabling_breakpoint;
Petr Machata98f09922011-07-09 10:55:29 +0200736
737 debug(DEBUG_PROCESS,
Petr Machata9ace5742012-04-14 02:29:57 +0200738 "process_stopping_on_event: pid %d; event type %d; state %d",
Petr Machata98f09922011-07-09 10:55:29 +0200739 task->pid, event->type, self->state);
740
741 struct pid_task * task_info = get_task_info(&self->pids, task->pid);
742 if (task_info == NULL)
743 fprintf(stderr, "new task??? %d\n", task->pid);
744 handle_stopping_event(task_info, &event);
745
746 int state = self->state;
747 int event_to_queue = !event_exit_or_none_p(event);
748
Petr Machata18c97072011-10-06 14:30:11 +0200749 /* Deactivate the entry if the task exits. */
750 if (event_exit_p(event) && task_info != NULL)
751 task_info->pid = 0;
752
Petr Machata43d2fe52011-11-02 13:25:49 +0100753 /* Always handle sysrets. Whether sysret occurred and what
754 * sys it rets from may need to be determined based on process
755 * stack, so we need to keep that in sync with reality. Note
756 * that we don't continue the process after the sysret is
757 * handled. See continue_after_syscall. */
758 if (event != NULL && event->type == EVENT_SYSRET) {
759 debug(1, "%d LT_EV_SYSRET", event->proc->pid);
760 event_to_queue = 0;
761 task_info->sysret = 1;
762 }
763
Petr Machata98f09922011-07-09 10:55:29 +0200764 switch (state) {
765 case psh_stopping:
766 /* If everyone is stopped, singlestep. */
Petr Machata74132a42012-03-16 02:46:18 +0100767 if (each_task(leader, NULL, &task_blocked,
768 &self->pids) == NULL) {
Petr Machatac1aa9582012-03-27 23:54:01 +0200769 (self->on_all_stopped)(self);
770 state = self->state;
Petr Machata98f09922011-07-09 10:55:29 +0200771 }
772 break;
773
Petr Machata06986d52011-11-02 13:22:46 +0100774 case psh_singlestep:
Petr Machata98f09922011-07-09 10:55:29 +0200775 /* In singlestep state, breakpoint signifies that we
776 * have now stepped, and can re-enable the breakpoint. */
Petr Machatae21264e2011-10-06 14:30:33 +0200777 if (event != NULL && task == teb) {
Petr Machatad5d93c42011-10-21 16:41:10 +0200778
Petr Machata42748ac2012-04-19 04:24:25 +0200779 /* If this was caused by a real breakpoint, as
780 * opposed to a singlestep, assume that it's
781 * an artificial breakpoint installed for some
782 * reason for the re-enablement. In that case
783 * handle it. */
784 if (event->type == EVENT_BREAKPOINT) {
785 target_address_t ip
786 = get_instruction_pointer(task);
787 struct breakpoint *other
788 = address2bpstruct(leader, ip);
789 if (other != NULL)
790 breakpoint_on_hit(other, task);
791 }
792
Petr Machata36f40e72012-03-28 02:07:19 +0200793 /* If we got SIGNAL instead of BREAKPOINT,
794 * then this is not singlestep at all. */
Petr Machatacb9a28d2012-03-28 11:11:32 +0200795 if (event->type == EVENT_SIGNAL) {
796 do_singlestep:
Petr Machataa266acb2012-04-12 23:50:23 +0200797 if (singlestep(self) < 0) {
Petr Machata9e1e9692012-04-19 02:29:38 +0200798 singlestep_error(self);
799 post_singlestep(self, &event);
Petr Machataa266acb2012-04-12 23:50:23 +0200800 goto psh_sinking;
801 }
Petr Machatad5d93c42011-10-21 16:41:10 +0200802 break;
Petr Machatacb9a28d2012-03-28 11:11:32 +0200803 } else {
804 switch ((self->keep_stepping_p)(self)) {
805 case CBS_FAIL:
806 /* XXX handle me */
807 case CBS_STOP:
808 break;
809 case CBS_CONT:
Petr Machata949a56a2012-04-03 00:32:03 +0200810 /* Sink singlestep event. */
811 if (event->type == EVENT_BREAKPOINT)
812 event = NULL;
Petr Machatacb9a28d2012-03-28 11:11:32 +0200813 goto do_singlestep;
814 }
Petr Machatad5d93c42011-10-21 16:41:10 +0200815 }
816
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200817 /* Re-enable the breakpoint that we are
818 * stepping over. */
Petr Machatac1aa9582012-03-27 23:54:01 +0200819 struct breakpoint *sbp = self->breakpoint_being_enabled;
Petr Machata590c8082011-08-20 22:45:26 +0200820 if (sbp->enabled)
821 enable_breakpoint(teb, sbp);
Petr Machata98f09922011-07-09 10:55:29 +0200822
Petr Machataa266acb2012-04-12 23:50:23 +0200823 post_singlestep(self, &event);
824 goto psh_sinking;
825 }
826 break;
Petr Machata98f09922011-07-09 10:55:29 +0200827
Petr Machataa266acb2012-04-12 23:50:23 +0200828 psh_sinking:
829 state = self->state = psh_sinking;
Petr Machata98f09922011-07-09 10:55:29 +0200830 case psh_sinking:
831 if (await_sigstop_delivery(&self->pids, task_info, event))
832 process_stopping_done(self, leader);
Petr Machata590c8082011-08-20 22:45:26 +0200833 break;
834
835 case psh_ugly_workaround:
836 if (event == NULL)
837 break;
838 if (event->type == EVENT_BREAKPOINT) {
839 undo_breakpoint(event, leader);
840 if (task == teb)
841 self->task_enabling_breakpoint = NULL;
842 }
843 if (self->task_enabling_breakpoint == NULL
844 && all_stops_accountable(&self->pids)) {
845 undo_breakpoint(event, leader);
846 detach_process(leader);
847 event = NULL; // handled
848 }
Petr Machata98f09922011-07-09 10:55:29 +0200849 }
850
851 if (event != NULL && event_to_queue) {
852 enque_event(event);
853 event = NULL; // sink the event
854 }
855
856 return event;
857}
858
859static void
Petr Machata366c2f42012-02-09 19:34:36 +0100860process_stopping_destroy(struct event_handler *super)
Petr Machata98f09922011-07-09 10:55:29 +0200861{
862 struct process_stopping_handler * self = (void *)super;
Petr Machata98f09922011-07-09 10:55:29 +0200863 free(self->pids.tasks);
Juan Cespedes5e01f651998-03-08 22:31:44 +0100864}
Juan Cespedes8cc1b9d2002-03-01 19:54:23 +0100865
Petr Machata36f40e72012-03-28 02:07:19 +0200866static enum callback_status
867no(struct process_stopping_handler *self)
868{
Petr Machatacb9a28d2012-03-28 11:11:32 +0200869 return CBS_STOP;
Petr Machata36f40e72012-03-28 02:07:19 +0200870}
871
Petr Machatac1aa9582012-03-27 23:54:01 +0200872int
873process_install_stopping_handler(struct Process *proc, struct breakpoint *sbp,
Petr Machata36f40e72012-03-28 02:07:19 +0200874 void (*as)(struct process_stopping_handler *),
875 enum callback_status (*ks)
Petr Machatacb9a28d2012-03-28 11:11:32 +0200876 (struct process_stopping_handler *),
877 enum callback_status (*uw)
Petr Machata36f40e72012-03-28 02:07:19 +0200878 (struct process_stopping_handler *))
Petr Machatac1aa9582012-03-27 23:54:01 +0200879{
Petr Machata9ace5742012-04-14 02:29:57 +0200880 debug(DEBUG_FUNCTION,
881 "process_install_stopping_handler: pid=%d", proc->pid);
882
Petr Machatac1aa9582012-03-27 23:54:01 +0200883 struct process_stopping_handler *handler = calloc(sizeof(*handler), 1);
884 if (handler == NULL)
885 return -1;
886
Petr Machata36f40e72012-03-28 02:07:19 +0200887 if (as == NULL)
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200888 as = &linux_ptrace_disable_and_singlestep;
Petr Machata36f40e72012-03-28 02:07:19 +0200889 if (ks == NULL)
890 ks = &no;
Petr Machatacb9a28d2012-03-28 11:11:32 +0200891 if (uw == NULL)
892 uw = &no;
Petr Machata36f40e72012-03-28 02:07:19 +0200893
Petr Machatac1aa9582012-03-27 23:54:01 +0200894 handler->super.on_event = process_stopping_on_event;
895 handler->super.destroy = process_stopping_destroy;
896 handler->task_enabling_breakpoint = proc;
897 handler->breakpoint_being_enabled = sbp;
Petr Machata36f40e72012-03-28 02:07:19 +0200898 handler->on_all_stopped = as;
899 handler->keep_stepping_p = ks;
Petr Machatacb9a28d2012-03-28 11:11:32 +0200900 handler->ugly_workaround_p = uw;
Petr Machatac1aa9582012-03-27 23:54:01 +0200901
902 install_event_handler(proc->leader, &handler->super);
903
904 if (each_task(proc->leader, NULL, &send_sigstop,
905 &handler->pids) != NULL) {
906 destroy_event_handler(proc);
907 return -1;
908 }
909
910 /* And deliver the first fake event, in case all the
911 * conditions are already fulfilled. */
912 Event ev = {
913 .type = EVENT_NONE,
914 .proc = proc,
915 };
916 process_stopping_on_event(&handler->super, &ev);
917
918 return 0;
919}
920
Juan Cespedesf1350522008-12-16 18:19:58 +0100921void
Petr Machatabc373262012-02-07 23:31:15 +0100922continue_after_breakpoint(Process *proc, struct breakpoint *sbp)
Petr Machata26627682011-07-08 18:15:32 +0200923{
Petr Machata9ace5742012-04-14 02:29:57 +0200924 debug(DEBUG_PROCESS,
925 "continue_after_breakpoint: pid=%d, addr=%p",
926 proc->pid, sbp->addr);
927
Juan Cespedes5c3fe062004-06-14 18:08:37 +0200928 set_instruction_pointer(proc, sbp->addr);
Petr Machatac1aa9582012-03-27 23:54:01 +0200929
Juan Cespedes8f8282f2002-03-03 18:58:40 +0100930 if (sbp->enabled == 0) {
931 continue_process(proc->pid);
932 } else {
Arnaud Patardf3d1c532010-01-08 08:40:04 -0500933#if defined __sparc__ || defined __ia64___ || defined __mips__
Ian Wienand9a2ad352006-02-20 22:44:45 +0100934 /* we don't want to singlestep here */
Juan Cespedes5c3fe062004-06-14 18:08:37 +0200935 continue_process(proc->pid);
936#else
Petr Machatacb9a28d2012-03-28 11:11:32 +0200937 if (process_install_stopping_handler
938 (proc, sbp, NULL, NULL, NULL) < 0) {
Petr Machatac1aa9582012-03-27 23:54:01 +0200939 perror("process_stopping_handler_create");
Petr Machata98f09922011-07-09 10:55:29 +0200940 /* Carry on not bothering to re-enable. */
941 continue_process(proc->pid);
Petr Machata98f09922011-07-09 10:55:29 +0200942 }
Juan Cespedes5c3fe062004-06-14 18:08:37 +0200943#endif
Juan Cespedes8f8282f2002-03-03 18:58:40 +0100944 }
945}
946
Petr Machata602330f2011-07-09 11:15:34 +0200947/**
948 * Ltrace exit. When we are about to exit, we have to go through all
949 * the processes, stop them all, remove all the breakpoints, and then
950 * detach the processes that we attached to using -p. If we left the
951 * other tasks running, they might hit stray return breakpoints and
952 * produce artifacts, so we better stop everyone, even if it's a bit
953 * of extra work.
954 */
955struct ltrace_exiting_handler
956{
Petr Machata366c2f42012-02-09 19:34:36 +0100957 struct event_handler super;
Petr Machata602330f2011-07-09 11:15:34 +0200958 struct pid_set pids;
959};
960
Petr Machata602330f2011-07-09 11:15:34 +0200961static Event *
Petr Machata366c2f42012-02-09 19:34:36 +0100962ltrace_exiting_on_event(struct event_handler *super, Event *event)
Petr Machata602330f2011-07-09 11:15:34 +0200963{
964 struct ltrace_exiting_handler * self = (void *)super;
965 Process * task = event->proc;
966 Process * leader = task->leader;
967
Petr Machata9ace5742012-04-14 02:29:57 +0200968 debug(DEBUG_PROCESS,
969 "ltrace_exiting_on_event: pid %d; event type %d",
970 task->pid, event->type);
Petr Machata602330f2011-07-09 11:15:34 +0200971
972 struct pid_task * task_info = get_task_info(&self->pids, task->pid);
973 handle_stopping_event(task_info, &event);
974
Petr Machata590c8082011-08-20 22:45:26 +0200975 if (event != NULL && event->type == EVENT_BREAKPOINT)
976 undo_breakpoint(event, leader);
Petr Machata4b9f4d92011-08-20 04:07:05 +0200977
978 if (await_sigstop_delivery(&self->pids, task_info, event)
Petr Machata590c8082011-08-20 22:45:26 +0200979 && all_stops_accountable(&self->pids))
980 detach_process(leader);
Petr Machata602330f2011-07-09 11:15:34 +0200981
982 /* Sink all non-exit events. We are about to exit, so we
983 * don't bother with queuing them. */
984 if (event_exit_or_none_p(event))
985 return event;
Petr Machata13d5df72011-08-19 23:15:15 +0200986
Petr Machata13d5df72011-08-19 23:15:15 +0200987 return NULL;
Petr Machata602330f2011-07-09 11:15:34 +0200988}
989
990static void
Petr Machata366c2f42012-02-09 19:34:36 +0100991ltrace_exiting_destroy(struct event_handler *super)
Petr Machata602330f2011-07-09 11:15:34 +0200992{
993 struct ltrace_exiting_handler * self = (void *)super;
994 free(self->pids.tasks);
995}
996
997static int
998ltrace_exiting_install_handler(Process * proc)
999{
1000 /* Only install to leader. */
1001 if (proc->leader != proc)
1002 return 0;
1003
1004 /* Perhaps we are already installed, if the user passed
1005 * several -p options that are tasks of one process. */
1006 if (proc->event_handler != NULL
1007 && proc->event_handler->on_event == &ltrace_exiting_on_event)
1008 return 0;
1009
Petr Machata590c8082011-08-20 22:45:26 +02001010 /* If stopping handler is already present, let it do the
1011 * work. */
1012 if (proc->event_handler != NULL) {
1013 assert(proc->event_handler->on_event
1014 == &process_stopping_on_event);
1015 struct process_stopping_handler * other
1016 = (void *)proc->event_handler;
1017 other->exiting = 1;
1018 return 0;
1019 }
1020
Petr Machata602330f2011-07-09 11:15:34 +02001021 struct ltrace_exiting_handler * handler
1022 = calloc(sizeof(*handler), 1);
1023 if (handler == NULL) {
1024 perror("malloc exiting handler");
1025 fatal:
1026 /* XXXXXXXXXXXXXXXXXXX fixme */
1027 return -1;
1028 }
1029
Petr Machata602330f2011-07-09 11:15:34 +02001030 handler->super.on_event = ltrace_exiting_on_event;
1031 handler->super.destroy = ltrace_exiting_destroy;
1032 install_event_handler(proc->leader, &handler->super);
1033
Petr Machata74132a42012-03-16 02:46:18 +01001034 if (each_task(proc->leader, NULL, &send_sigstop,
Petr Machata602330f2011-07-09 11:15:34 +02001035 &handler->pids) != NULL)
1036 goto fatal;
1037
1038 return 0;
1039}
1040
Petr Machatacbe29c62011-09-27 02:27:58 +02001041/*
1042 * When the traced process vforks, it's suspended until the child
1043 * process calls _exit or exec*. In the meantime, the two share the
1044 * address space.
1045 *
1046 * The child process should only ever call _exit or exec*, but we
1047 * can't count on that (it's not the role of ltrace to policy, but to
1048 * observe). In any case, we will _at least_ have to deal with
1049 * removal of vfork return breakpoint (which we have to smuggle back
1050 * in, so that the parent can see it, too), and introduction of exec*
1051 * return breakpoint. Since we already have both breakpoint actions
1052 * to deal with, we might as well support it all.
1053 *
1054 * The gist is that we pretend that the child is in a thread group
1055 * with its parent, and handle it as a multi-threaded case, with the
1056 * exception that we know that the parent is blocked, and don't
1057 * attempt to stop it. When the child execs, we undo the setup.
Petr Machatacbe29c62011-09-27 02:27:58 +02001058 */
1059
Petr Machata134a1082011-09-27 20:25:58 +02001060struct process_vfork_handler
1061{
Petr Machata366c2f42012-02-09 19:34:36 +01001062 struct event_handler super;
Petr Machata134a1082011-09-27 20:25:58 +02001063 void * bp_addr;
1064};
1065
Petr Machatacbe29c62011-09-27 02:27:58 +02001066static Event *
Petr Machata366c2f42012-02-09 19:34:36 +01001067process_vfork_on_event(struct event_handler *super, Event *event)
Petr Machatacbe29c62011-09-27 02:27:58 +02001068{
Petr Machata9ace5742012-04-14 02:29:57 +02001069 debug(DEBUG_PROCESS,
1070 "process_vfork_on_event: pid %d; event type %d",
1071 event->proc->pid, event->type);
1072
Petr Machatacbe29c62011-09-27 02:27:58 +02001073 struct process_vfork_handler * self = (void *)super;
Petr Machatabc373262012-02-07 23:31:15 +01001074 struct breakpoint *sbp;
Petr Machatacbe29c62011-09-27 02:27:58 +02001075 assert(self != NULL);
1076
1077 switch (event->type) {
Petr Machata134a1082011-09-27 20:25:58 +02001078 case EVENT_BREAKPOINT:
1079 /* Remember the vfork return breakpoint. */
Petr Machata77e8fa82012-04-19 18:36:32 +02001080 if (self->bp_addr == 0)
Petr Machata134a1082011-09-27 20:25:58 +02001081 self->bp_addr = event->e_un.brk_addr;
1082 break;
1083
Petr Machatacbe29c62011-09-27 02:27:58 +02001084 case EVENT_EXIT:
1085 case EVENT_EXIT_SIGNAL:
1086 case EVENT_EXEC:
Petr Machata134a1082011-09-27 20:25:58 +02001087 /* Smuggle back in the vfork return breakpoint, so
1088 * that our parent can trip over it once again. */
Petr Machata77e8fa82012-04-19 18:36:32 +02001089 if (self->bp_addr != 0) {
Petr Machata134a1082011-09-27 20:25:58 +02001090 sbp = dict_find_entry(event->proc->leader->breakpoints,
1091 self->bp_addr);
1092 if (sbp != NULL)
Petr Machata77e8fa82012-04-19 18:36:32 +02001093 assert(sbp->libsym == NULL);
1094 /* We don't mind failing that, it's not a big
1095 * deal to not display one extra vfork return. */
1096 insert_breakpoint(event->proc->parent,
1097 self->bp_addr, NULL);
Petr Machata134a1082011-09-27 20:25:58 +02001098 }
1099
Petr Machataba9911f2011-09-27 21:09:47 +02001100 continue_process(event->proc->parent->pid);
Petr Machata134a1082011-09-27 20:25:58 +02001101
1102 /* Remove the leader that we artificially set up
1103 * earlier. */
Petr Machatacbe29c62011-09-27 02:27:58 +02001104 change_process_leader(event->proc, event->proc);
1105 destroy_event_handler(event->proc);
1106
Petr Machatacbe29c62011-09-27 02:27:58 +02001107 default:
1108 ;
1109 }
1110
1111 return event;
1112}
1113
1114void
1115continue_after_vfork(Process * proc)
1116{
1117 debug(DEBUG_PROCESS, "continue_after_vfork: pid=%d", proc->pid);
Petr Machata134a1082011-09-27 20:25:58 +02001118 struct process_vfork_handler * handler = calloc(sizeof(*handler), 1);
Petr Machatacbe29c62011-09-27 02:27:58 +02001119 if (handler == NULL) {
1120 perror("malloc vfork handler");
1121 /* Carry on not bothering to treat the process as
1122 * necessary. */
1123 continue_process(proc->parent->pid);
1124 return;
1125 }
1126
1127 /* We must set up custom event handler, so that we see
1128 * exec/exit events for the task itself. */
Petr Machata134a1082011-09-27 20:25:58 +02001129 handler->super.on_event = process_vfork_on_event;
1130 install_event_handler(proc, &handler->super);
Petr Machatacbe29c62011-09-27 02:27:58 +02001131
1132 /* Make sure that the child is sole thread. */
1133 assert(proc->leader == proc);
1134 assert(proc->next == NULL || proc->next->leader != proc);
1135
1136 /* Make sure that the child's parent is properly set up. */
1137 assert(proc->parent != NULL);
1138 assert(proc->parent->leader != NULL);
1139
1140 change_process_leader(proc, proc->parent->leader);
Petr Machatacbe29c62011-09-27 02:27:58 +02001141}
1142
Petr Machata9d29b3e2011-11-09 16:46:56 +01001143static int
1144is_mid_stopping(Process *proc)
1145{
1146 return proc != NULL
1147 && proc->event_handler != NULL
1148 && proc->event_handler->on_event == &process_stopping_on_event;
1149}
1150
Petr Machata43d2fe52011-11-02 13:25:49 +01001151void
1152continue_after_syscall(Process * proc, int sysnum, int ret_p)
1153{
1154 /* Don't continue if we are mid-stopping. */
Petr Machata9d29b3e2011-11-09 16:46:56 +01001155 if (ret_p && (is_mid_stopping(proc) || is_mid_stopping(proc->leader))) {
1156 debug(DEBUG_PROCESS,
1157 "continue_after_syscall: don't continue %d",
1158 proc->pid);
Petr Machata43d2fe52011-11-02 13:25:49 +01001159 return;
Petr Machata9d29b3e2011-11-09 16:46:56 +01001160 }
Petr Machata43d2fe52011-11-02 13:25:49 +01001161 continue_process(proc->pid);
1162}
1163
Petr Machata602330f2011-07-09 11:15:34 +02001164/* If ltrace gets SIGINT, the processes directly or indirectly run by
1165 * ltrace get it too. We just have to wait long enough for the signal
1166 * to be delivered and the process terminated, which we notice and
1167 * exit ltrace, too. So there's not much we need to do there. We
1168 * want to keep tracing those processes as usual, in case they just
1169 * SIG_IGN the SIGINT to do their shutdown etc.
1170 *
1171 * For processes ran on the background, we want to install an exit
1172 * handler that stops all the threads, removes all breakpoints, and
1173 * detaches.
1174 */
1175void
Petr Machataffe4cd22012-04-11 18:01:44 +02001176os_ltrace_exiting(void)
Petr Machata602330f2011-07-09 11:15:34 +02001177{
1178 struct opt_p_t * it;
1179 for (it = opt_p; it != NULL; it = it->next) {
1180 Process * proc = pid2proc(it->pid);
1181 if (proc == NULL || proc->leader == NULL)
1182 continue;
1183 if (ltrace_exiting_install_handler(proc->leader) < 0)
1184 fprintf(stderr,
1185 "Couldn't install exiting handler for %d.\n",
1186 proc->pid);
1187 }
1188}
1189
Petr Machataffe4cd22012-04-11 18:01:44 +02001190int
1191os_ltrace_exiting_sighandler(void)
1192{
1193 extern int linux_in_waitpid;
1194 if (linux_in_waitpid) {
1195 os_ltrace_exiting();
1196 return 1;
1197 }
1198 return 0;
1199}
1200
Joe Damatodfa3fa32010-11-08 15:47:35 -08001201size_t
1202umovebytes(Process *proc, void *addr, void *laddr, size_t len) {
1203
1204 union {
1205 long a;
1206 char c[sizeof(long)];
1207 } a;
Zachary T Welchba6aca22010-12-08 18:55:09 -08001208 int started = 0;
1209 size_t offset = 0, bytes_read = 0;
Joe Damatodfa3fa32010-11-08 15:47:35 -08001210
1211 while (offset < len) {
1212 a.a = ptrace(PTRACE_PEEKTEXT, proc->pid, addr + offset, 0);
1213 if (a.a == -1 && errno) {
1214 if (started && errno == EIO)
1215 return bytes_read;
1216 else
1217 return -1;
1218 }
1219 started = 1;
1220
1221 if (len - offset >= sizeof(long)) {
1222 memcpy(laddr + offset, &a.c[0], sizeof(long));
1223 bytes_read += sizeof(long);
1224 }
1225 else {
1226 memcpy(laddr + offset, &a.c[0], len - offset);
1227 bytes_read += (len - offset);
1228 }
1229 offset += sizeof(long);
1230 }
1231
1232 return bytes_read;
1233}
1234
Steve Fink7bafff02006-08-07 04:50:42 +02001235/* Read a series of bytes starting at the process's memory address
1236 'addr' and continuing until a NUL ('\0') is seen or 'len' bytes
1237 have been read.
1238*/
Juan Cespedesf1350522008-12-16 18:19:58 +01001239int
Juan Cespedesa8909f72009-04-28 20:02:41 +02001240umovestr(Process *proc, void *addr, int len, void *laddr) {
Ian Wienand2d45b1a2006-02-20 22:48:07 +01001241 union {
1242 long a;
1243 char c[sizeof(long)];
1244 } a;
Zachary T Welchba6aca22010-12-08 18:55:09 -08001245 unsigned i;
Ian Wienand2d45b1a2006-02-20 22:48:07 +01001246 int offset = 0;
Juan Cespedes8cc1b9d2002-03-01 19:54:23 +01001247
Ian Wienand2d45b1a2006-02-20 22:48:07 +01001248 while (offset < len) {
1249 a.a = ptrace(PTRACE_PEEKTEXT, proc->pid, addr + offset, 0);
1250 for (i = 0; i < sizeof(long); i++) {
Paul Gilliam3f1219f2006-04-24 18:25:38 +02001251 if (a.c[i] && offset + (signed)i < len) {
Ian Wienand2d45b1a2006-02-20 22:48:07 +01001252 *(char *)(laddr + offset + i) = a.c[i];
Juan Cespedes8cc1b9d2002-03-01 19:54:23 +01001253 } else {
Ian Wienand2d45b1a2006-02-20 22:48:07 +01001254 *(char *)(laddr + offset + i) = '\0';
Juan Cespedes8cc1b9d2002-03-01 19:54:23 +01001255 return 0;
1256 }
1257 }
1258 offset += sizeof(long);
1259 }
Ian Wienand2d45b1a2006-02-20 22:48:07 +01001260 *(char *)(laddr + offset) = '\0';
Juan Cespedes8cc1b9d2002-03-01 19:54:23 +01001261 return 0;
1262}