blob: 42dd4d944667ba47439c488239bdfed55703b22c [file] [log] [blame]
Petr Machata64262602012-01-07 03:41:36 +01001/*
2 * This file is part of ltrace.
3 * Copyright (C) 2007,2011,2012 Petr Machata, Red Hat Inc.
4 * Copyright (C) 2010 Joe Damato
5 * Copyright (C) 1998,2002,2003,2004,2008,2009 Juan Cespedes
6 * Copyright (C) 2006 Ian Wienand
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of the
11 * License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21 * 02110-1301 USA
22 */
23
Petr Machatacec06ec2012-04-10 13:31:55 +020024#include "config.h"
25
26#include <asm/unistd.h>
27#include <sys/types.h>
28#include <sys/wait.h>
29#include <assert.h>
30#include <errno.h>
Juan Cespedes5e01f651998-03-08 22:31:44 +010031#include <stdio.h>
Juan Cespedes504a3852003-02-04 23:24:38 +010032#include <stdlib.h>
Juan Cespedes1fe93d51998-03-13 00:29:21 +010033#include <string.h>
Juan Cespedes8f8282f2002-03-03 18:58:40 +010034#include <unistd.h>
Juan Cespedes5e01f651998-03-08 22:31:44 +010035
Petr Machatacec06ec2012-04-10 13:31:55 +020036#ifdef HAVE_LIBSELINUX
37# include <selinux/selinux.h>
38#endif
39
Petr Machata92822542012-03-28 00:31:14 +020040#include "linux-gnu/trace.h"
Petr Machataaf766ab2012-11-07 21:59:13 +010041#include "linux-gnu/trace-defs.h"
Petr Machata64262602012-01-07 03:41:36 +010042#include "backend.h"
Petr Machataba1664b2012-04-28 14:59:05 +020043#include "breakpoint.h"
44#include "debug.h"
Petr Machatacd972582012-01-07 03:02:07 +010045#include "events.h"
Petr Machataba1664b2012-04-28 14:59:05 +020046#include "options.h"
47#include "proc.h"
48#include "ptrace.h"
49#include "type.h"
Petr Machata55ed83b2007-05-17 16:24:15 +020050
Juan Cespedesf1350522008-12-16 18:19:58 +010051void
Petr Machatacec06ec2012-04-10 13:31:55 +020052trace_fail_warning(pid_t pid)
53{
54 /* This was adapted from GDB. */
55#ifdef HAVE_LIBSELINUX
56 static int checked = 0;
57 if (checked)
58 return;
59 checked = 1;
60
61 /* -1 is returned for errors, 0 if it has no effect, 1 if
62 * PTRACE_ATTACH is forbidden. */
63 if (security_get_boolean_active("deny_ptrace") == 1)
64 fprintf(stderr,
65"The SELinux boolean 'deny_ptrace' is enabled, which may prevent ltrace from\n"
66"tracing other processes. You can disable this process attach protection by\n"
67"issuing 'setsebool deny_ptrace=0' in the superuser context.\n");
68#endif /* HAVE_LIBSELINUX */
69}
70
71void
72trace_me(void)
73{
Petr Machata26627682011-07-08 18:15:32 +020074 debug(DEBUG_PROCESS, "trace_me: pid=%d", getpid());
Petr Machatac897cb72012-05-05 01:26:58 +020075 if (ptrace(PTRACE_TRACEME, 0, 0, 0) < 0) {
Juan Cespedes5e01f651998-03-08 22:31:44 +010076 perror("PTRACE_TRACEME");
Petr Machatacec06ec2012-04-10 13:31:55 +020077 trace_fail_warning(getpid());
Juan Cespedes5e01f651998-03-08 22:31:44 +010078 exit(1);
79 }
80}
81
Petr Machatab4f9e0c2012-02-07 01:57:59 +010082/* There's a (hopefully) brief period of time after the child process
Petr Machatac805c622012-03-02 00:10:37 +010083 * forks when we can't trace it yet. Here we wait for kernel to
Petr Machatab4f9e0c2012-02-07 01:57:59 +010084 * prepare the process. */
Petr Machatac805c622012-03-02 00:10:37 +010085int
Petr Machatab4f9e0c2012-02-07 01:57:59 +010086wait_for_proc(pid_t pid)
87{
Petr Machatac805c622012-03-02 00:10:37 +010088 /* man ptrace: PTRACE_ATTACH attaches to the process specified
89 in pid. The child is sent a SIGSTOP, but will not
90 necessarily have stopped by the completion of this call;
91 use wait() to wait for the child to stop. */
92 if (waitpid(pid, NULL, __WALL) != pid) {
93 perror ("trace_pid: waitpid");
94 return -1;
Petr Machatab4f9e0c2012-02-07 01:57:59 +010095 }
96
Petr Machatac805c622012-03-02 00:10:37 +010097 return 0;
Petr Machatab4f9e0c2012-02-07 01:57:59 +010098}
99
Juan Cespedesf1350522008-12-16 18:19:58 +0100100int
Petr Machatacec06ec2012-04-10 13:31:55 +0200101trace_pid(pid_t pid)
102{
Petr Machata26627682011-07-08 18:15:32 +0200103 debug(DEBUG_PROCESS, "trace_pid: pid=%d", pid);
Petr Machatacec06ec2012-04-10 13:31:55 +0200104 /* This shouldn't emit error messages, as there are legitimate
105 * reasons that the PID can't be attached: like it may have
106 * already ended. */
Petr Machatac897cb72012-05-05 01:26:58 +0200107 if (ptrace(PTRACE_ATTACH, pid, 0, 0) < 0)
Juan Cespedes273ea6d1998-03-14 23:02:40 +0100108 return -1;
Petr Machata89a53602007-01-25 18:05:44 +0100109
Petr Machatac805c622012-03-02 00:10:37 +0100110 return wait_for_proc(pid);
Juan Cespedes273ea6d1998-03-14 23:02:40 +0100111}
112
Juan Cespedesf1350522008-12-16 18:19:58 +0100113void
Petr Machata929bd572012-12-17 03:20:34 +0100114trace_set_options(struct process *proc)
Petr Machata3ed2a422012-04-06 17:18:55 +0200115{
Ian Wienand9a2ad352006-02-20 22:44:45 +0100116 if (proc->tracesysgood & 0x80)
117 return;
Petr Machata55ed83b2007-05-17 16:24:15 +0200118
Petr Machata3ed2a422012-04-06 17:18:55 +0200119 pid_t pid = proc->pid;
Petr Machata26627682011-07-08 18:15:32 +0200120 debug(DEBUG_PROCESS, "trace_set_options: pid=%d", pid);
Juan Cespedescd8976d2009-05-14 13:47:58 +0200121
Juan Cespedes1e583132009-04-07 18:17:11 +0200122 long options = PTRACE_O_TRACESYSGOOD | PTRACE_O_TRACEFORK |
123 PTRACE_O_TRACEVFORK | PTRACE_O_TRACECLONE |
124 PTRACE_O_TRACEEXEC;
Petr Machatac897cb72012-05-05 01:26:58 +0200125 if (ptrace(PTRACE_SETOPTIONS, pid, 0, (void *)options) < 0 &&
126 ptrace(PTRACE_OLDSETOPTIONS, pid, 0, (void *)options) < 0) {
Ian Wienand9a2ad352006-02-20 22:44:45 +0100127 perror("PTRACE_SETOPTIONS");
128 return;
129 }
130 proc->tracesysgood |= 0x80;
131}
132
Juan Cespedesf1350522008-12-16 18:19:58 +0100133void
134untrace_pid(pid_t pid) {
Petr Machata26627682011-07-08 18:15:32 +0200135 debug(DEBUG_PROCESS, "untrace_pid: pid=%d", pid);
Petr Machatac897cb72012-05-05 01:26:58 +0200136 ptrace(PTRACE_DETACH, pid, 0, 0);
Juan Cespedes1fe93d51998-03-13 00:29:21 +0100137}
138
Juan Cespedesf1350522008-12-16 18:19:58 +0100139void
Petr Machatac897cb72012-05-05 01:26:58 +0200140continue_after_signal(pid_t pid, int signum)
141{
142 debug(DEBUG_PROCESS, "continue_after_signal: pid=%d, signum=%d",
143 pid, signum);
144 ptrace(PTRACE_SYSCALL, pid, 0, (void *)(uintptr_t)signum);
Petr Machata98f09922011-07-09 10:55:29 +0200145}
146
147static enum ecb_status
Petr Machata6c2e57a2012-10-27 01:50:22 +0200148event_for_pid(Event *event, void *data)
Petr Machata98f09922011-07-09 10:55:29 +0200149{
150 if (event->proc != NULL && event->proc->pid == (pid_t)(uintptr_t)data)
151 return ecb_yield;
152 return ecb_cont;
153}
154
155static int
156have_events_for(pid_t pid)
157{
158 return each_qd_event(event_for_pid, (void *)(uintptr_t)pid) != NULL;
159}
160
161void
162continue_process(pid_t pid)
163{
164 debug(DEBUG_PROCESS, "continue_process: pid=%d", pid);
Petr Machata98f09922011-07-09 10:55:29 +0200165
166 /* Only really continue the process if there are no events in
Petr Machata36d19822011-10-21 16:03:45 +0200167 the queue for this process. Otherwise just wait for the
168 other events to arrive. */
Petr Machata98f09922011-07-09 10:55:29 +0200169 if (!have_events_for(pid))
170 /* We always trace syscalls to control fork(),
171 * clone(), execve()... */
172 ptrace(PTRACE_SYSCALL, pid, 0, 0);
173 else
174 debug(DEBUG_PROCESS,
175 "putting off the continue, events in que.");
176}
177
Petr Machata98f09922011-07-09 10:55:29 +0200178static struct pid_task *
Petr Machata6c2e57a2012-10-27 01:50:22 +0200179get_task_info(struct pid_set *pids, pid_t pid)
Petr Machata98f09922011-07-09 10:55:29 +0200180{
Petr Machata750ca8c2011-10-06 14:29:34 +0200181 assert(pid != 0);
Petr Machata98f09922011-07-09 10:55:29 +0200182 size_t i;
183 for (i = 0; i < pids->count; ++i)
184 if (pids->tasks[i].pid == pid)
185 return &pids->tasks[i];
186
187 return NULL;
188}
189
190static struct pid_task *
Petr Machata6c2e57a2012-10-27 01:50:22 +0200191add_task_info(struct pid_set *pids, pid_t pid)
Petr Machata98f09922011-07-09 10:55:29 +0200192{
193 if (pids->count == pids->alloc) {
194 size_t ns = (2 * pids->alloc) ?: 4;
Petr Machata6c2e57a2012-10-27 01:50:22 +0200195 struct pid_task *n = realloc(pids->tasks,
196 sizeof(*pids->tasks) * ns);
Petr Machata98f09922011-07-09 10:55:29 +0200197 if (n == NULL)
198 return NULL;
199 pids->tasks = n;
200 pids->alloc = ns;
201 }
202 struct pid_task * task_info = &pids->tasks[pids->count++];
203 memset(task_info, 0, sizeof(*task_info));
204 task_info->pid = pid;
205 return task_info;
206}
207
Petr Machata2b46cfc2012-02-18 11:17:29 +0100208static enum callback_status
Petr Machata929bd572012-12-17 03:20:34 +0100209task_stopped(struct process *task, void *data)
Petr Machatacbe29c62011-09-27 02:27:58 +0200210{
211 enum process_status st = process_status(task->pid);
212 if (data != NULL)
213 *(enum process_status *)data = st;
214
215 /* If the task is already stopped, don't worry about it.
216 * Likewise if it managed to become a zombie or terminate in
217 * the meantime. This can happen when the whole thread group
218 * is terminating. */
219 switch (st) {
Petr Machata6dfc5442012-12-17 03:38:36 +0100220 case PS_INVALID:
221 case PS_TRACING_STOP:
222 case PS_ZOMBIE:
Petr Machata2b46cfc2012-02-18 11:17:29 +0100223 return CBS_CONT;
Petr Machata6dfc5442012-12-17 03:38:36 +0100224 case PS_SLEEPING:
225 case PS_STOP:
226 case PS_OTHER:
Petr Machata2b46cfc2012-02-18 11:17:29 +0100227 return CBS_STOP;
Petr Machatacbe29c62011-09-27 02:27:58 +0200228 }
Petr Machata36d19822011-10-21 16:03:45 +0200229
230 abort ();
Petr Machatacbe29c62011-09-27 02:27:58 +0200231}
232
233/* Task is blocked if it's stopped, or if it's a vfork parent. */
Petr Machata2b46cfc2012-02-18 11:17:29 +0100234static enum callback_status
Petr Machata929bd572012-12-17 03:20:34 +0100235task_blocked(struct process *task, void *data)
Petr Machatacbe29c62011-09-27 02:27:58 +0200236{
Petr Machata6c2e57a2012-10-27 01:50:22 +0200237 struct pid_set *pids = data;
238 struct pid_task *task_info = get_task_info(pids, task->pid);
Petr Machatacbe29c62011-09-27 02:27:58 +0200239 if (task_info != NULL
240 && task_info->vforked)
Petr Machata2b46cfc2012-02-18 11:17:29 +0100241 return CBS_CONT;
Petr Machatacbe29c62011-09-27 02:27:58 +0200242
243 return task_stopped(task, NULL);
244}
245
Petr Machata366c2f42012-02-09 19:34:36 +0100246static Event *process_vfork_on_event(struct event_handler *super, Event *event);
Petr Machatacbe29c62011-09-27 02:27:58 +0200247
Petr Machata2b46cfc2012-02-18 11:17:29 +0100248static enum callback_status
Petr Machata929bd572012-12-17 03:20:34 +0100249task_vforked(struct process *task, void *data)
Petr Machatacbe29c62011-09-27 02:27:58 +0200250{
251 if (task->event_handler != NULL
252 && task->event_handler->on_event == &process_vfork_on_event)
Petr Machata2b46cfc2012-02-18 11:17:29 +0100253 return CBS_STOP;
254 return CBS_CONT;
Petr Machatacbe29c62011-09-27 02:27:58 +0200255}
256
257static int
Petr Machata929bd572012-12-17 03:20:34 +0100258is_vfork_parent(struct process *task)
Petr Machatacbe29c62011-09-27 02:27:58 +0200259{
Petr Machata74132a42012-03-16 02:46:18 +0100260 return each_task(task->leader, NULL, &task_vforked, NULL) != NULL;
Petr Machatacbe29c62011-09-27 02:27:58 +0200261}
262
Petr Machata2b46cfc2012-02-18 11:17:29 +0100263static enum callback_status
Petr Machata929bd572012-12-17 03:20:34 +0100264send_sigstop(struct process *task, void *data)
Petr Machata98f09922011-07-09 10:55:29 +0200265{
Petr Machata929bd572012-12-17 03:20:34 +0100266 struct process *leader = task->leader;
Petr Machata6c2e57a2012-10-27 01:50:22 +0200267 struct pid_set *pids = data;
Petr Machata98f09922011-07-09 10:55:29 +0200268
269 /* Look for pre-existing task record, or add new. */
Petr Machata6c2e57a2012-10-27 01:50:22 +0200270 struct pid_task *task_info = get_task_info(pids, task->pid);
Petr Machata98f09922011-07-09 10:55:29 +0200271 if (task_info == NULL)
272 task_info = add_task_info(pids, task->pid);
273 if (task_info == NULL) {
274 perror("send_sigstop: add_task_info");
275 destroy_event_handler(leader);
276 /* Signal failure upwards. */
Petr Machata2b46cfc2012-02-18 11:17:29 +0100277 return CBS_STOP;
Petr Machata98f09922011-07-09 10:55:29 +0200278 }
279
280 /* This task still has not been attached to. It should be
281 stopped by the kernel. */
282 if (task->state == STATE_BEING_CREATED)
Petr Machata2b46cfc2012-02-18 11:17:29 +0100283 return CBS_CONT;
Petr Machata98f09922011-07-09 10:55:29 +0200284
285 /* Don't bother sending SIGSTOP if we are already stopped, or
Petr Machatacbe29c62011-09-27 02:27:58 +0200286 * if we sent the SIGSTOP already, which happens when we are
287 * handling "onexit" and inherited the handler from breakpoint
288 * re-enablement. */
289 enum process_status st;
Petr Machata2b46cfc2012-02-18 11:17:29 +0100290 if (task_stopped(task, &st) == CBS_CONT)
291 return CBS_CONT;
Petr Machata98f09922011-07-09 10:55:29 +0200292 if (task_info->sigstopped) {
293 if (!task_info->delivered)
Petr Machata2b46cfc2012-02-18 11:17:29 +0100294 return CBS_CONT;
Petr Machata98f09922011-07-09 10:55:29 +0200295 task_info->delivered = 0;
296 }
297
Petr Machatacbe29c62011-09-27 02:27:58 +0200298 /* Also don't attempt to stop the process if it's a parent of
299 * vforked process. We set up event handler specially to hint
300 * us. In that case parent is in D state, which we use to
301 * weed out unnecessary looping. */
Petr Machata6dfc5442012-12-17 03:38:36 +0100302 if (st == PS_SLEEPING
303 && is_vfork_parent(task)) {
Petr Machatacbe29c62011-09-27 02:27:58 +0200304 task_info->vforked = 1;
Petr Machata2b46cfc2012-02-18 11:17:29 +0100305 return CBS_CONT;
Petr Machatacbe29c62011-09-27 02:27:58 +0200306 }
307
Petr Machata98f09922011-07-09 10:55:29 +0200308 if (task_kill(task->pid, SIGSTOP) >= 0) {
309 debug(DEBUG_PROCESS, "send SIGSTOP to %d", task->pid);
310 task_info->sigstopped = 1;
311 } else
312 fprintf(stderr,
313 "Warning: couldn't send SIGSTOP to %d\n", task->pid);
314
Petr Machata2b46cfc2012-02-18 11:17:29 +0100315 return CBS_CONT;
Petr Machata98f09922011-07-09 10:55:29 +0200316}
317
Petr Machata73894bd2011-08-20 23:47:34 +0200318/* On certain kernels, detaching right after a singlestep causes the
319 tracee to be killed with a SIGTRAP (that even though the singlestep
320 was properly caught by waitpid. The ugly workaround is to put a
321 breakpoint where IP points and let the process continue. After
322 this the breakpoint can be retracted and the process detached. */
Petr Machata98f09922011-07-09 10:55:29 +0200323static void
Petr Machata929bd572012-12-17 03:20:34 +0100324ugly_workaround(struct process *proc)
Petr Machata590c8082011-08-20 22:45:26 +0200325{
Petr Machata6c2e57a2012-10-27 01:50:22 +0200326 void *ip = get_instruction_pointer(proc);
Petr Machatabc373262012-02-07 23:31:15 +0100327 struct breakpoint *sbp = dict_find_entry(proc->leader->breakpoints, ip);
Petr Machata590c8082011-08-20 22:45:26 +0200328 if (sbp != NULL)
329 enable_breakpoint(proc, sbp);
330 else
Petr Machata9df15012012-02-20 12:49:46 +0100331 insert_breakpoint(proc, ip, NULL);
Petr Machata73894bd2011-08-20 23:47:34 +0200332 ptrace(PTRACE_CONT, proc->pid, 0, 0);
Petr Machata590c8082011-08-20 22:45:26 +0200333}
334
335static void
Petr Machata6c2e57a2012-10-27 01:50:22 +0200336process_stopping_done(struct process_stopping_handler *self,
Petr Machata929bd572012-12-17 03:20:34 +0100337 struct process *leader)
Petr Machata98f09922011-07-09 10:55:29 +0200338{
339 debug(DEBUG_PROCESS, "process stopping done %d",
340 self->task_enabling_breakpoint->pid);
Petr Machata8ae36732012-04-30 01:19:09 +0200341
Petr Machata590c8082011-08-20 22:45:26 +0200342 if (!self->exiting) {
Petr Machata8ae36732012-04-30 01:19:09 +0200343 size_t i;
Petr Machata590c8082011-08-20 22:45:26 +0200344 for (i = 0; i < self->pids.count; ++i)
345 if (self->pids.tasks[i].pid != 0
Petr Machata43d2fe52011-11-02 13:25:49 +0100346 && (self->pids.tasks[i].delivered
347 || self->pids.tasks[i].sysret))
Petr Machata590c8082011-08-20 22:45:26 +0200348 continue_process(self->pids.tasks[i].pid);
349 continue_process(self->task_enabling_breakpoint->pid);
Petr Machatacb9a28d2012-03-28 11:11:32 +0200350 }
351
352 if (self->exiting) {
353 ugly_workaround:
Petr Machata590c8082011-08-20 22:45:26 +0200354 self->state = psh_ugly_workaround;
Petr Machata73894bd2011-08-20 23:47:34 +0200355 ugly_workaround(self->task_enabling_breakpoint);
Petr Machatacb9a28d2012-03-28 11:11:32 +0200356 } else {
357 switch ((self->ugly_workaround_p)(self)) {
358 case CBS_FAIL:
359 /* xxx handle me */
360 case CBS_STOP:
361 break;
362 case CBS_CONT:
363 goto ugly_workaround;
364 }
Petr Machata8ae36732012-04-30 01:19:09 +0200365 destroy_event_handler(leader);
Petr Machata590c8082011-08-20 22:45:26 +0200366 }
367}
368
369/* Before we detach, we need to make sure that task's IP is on the
370 * edge of an instruction. So for tasks that have a breakpoint event
371 * in the queue, we adjust the instruction pointer, just like
372 * continue_after_breakpoint does. */
373static enum ecb_status
Petr Machata6c2e57a2012-10-27 01:50:22 +0200374undo_breakpoint(Event *event, void *data)
Petr Machata590c8082011-08-20 22:45:26 +0200375{
376 if (event != NULL
377 && event->proc->leader == data
378 && event->type == EVENT_BREAKPOINT)
379 set_instruction_pointer(event->proc, event->e_un.brk_addr);
380 return ecb_cont;
381}
382
Petr Machata2b46cfc2012-02-18 11:17:29 +0100383static enum callback_status
Petr Machata929bd572012-12-17 03:20:34 +0100384untrace_task(struct process *task, void *data)
Petr Machata590c8082011-08-20 22:45:26 +0200385{
386 if (task != data)
387 untrace_pid(task->pid);
Petr Machata2b46cfc2012-02-18 11:17:29 +0100388 return CBS_CONT;
Petr Machata590c8082011-08-20 22:45:26 +0200389}
390
Petr Machata2b46cfc2012-02-18 11:17:29 +0100391static enum callback_status
Petr Machata929bd572012-12-17 03:20:34 +0100392remove_task(struct process *task, void *data)
Petr Machata590c8082011-08-20 22:45:26 +0200393{
394 /* Don't untrace leader just yet. */
395 if (task != data)
396 remove_process(task);
Petr Machata2b46cfc2012-02-18 11:17:29 +0100397 return CBS_CONT;
Petr Machata590c8082011-08-20 22:45:26 +0200398}
399
Petr Machata86d38282012-04-24 18:09:01 +0200400static enum callback_status
Petr Machata929bd572012-12-17 03:20:34 +0100401retract_breakpoint_cb(struct process *proc, struct breakpoint *bp, void *data)
Petr Machata86d38282012-04-24 18:09:01 +0200402{
403 breakpoint_on_retract(bp, proc);
404 return CBS_CONT;
405}
406
Petr Machata590c8082011-08-20 22:45:26 +0200407static void
Petr Machata929bd572012-12-17 03:20:34 +0100408detach_process(struct process *leader)
Petr Machata590c8082011-08-20 22:45:26 +0200409{
410 each_qd_event(&undo_breakpoint, leader);
411 disable_all_breakpoints(leader);
Petr Machata86d38282012-04-24 18:09:01 +0200412 proc_each_breakpoint(leader, NULL, retract_breakpoint_cb, NULL);
Petr Machata590c8082011-08-20 22:45:26 +0200413
414 /* Now untrace the process, if it was attached to by -p. */
Petr Machata6c2e57a2012-10-27 01:50:22 +0200415 struct opt_p_t *it;
Petr Machata590c8082011-08-20 22:45:26 +0200416 for (it = opt_p; it != NULL; it = it->next) {
Petr Machata929bd572012-12-17 03:20:34 +0100417 struct process *proc = pid2proc(it->pid);
Petr Machata590c8082011-08-20 22:45:26 +0200418 if (proc == NULL)
419 continue;
420 if (proc->leader == leader) {
Petr Machata74132a42012-03-16 02:46:18 +0100421 each_task(leader, NULL, &untrace_task, NULL);
Petr Machata590c8082011-08-20 22:45:26 +0200422 break;
423 }
424 }
Petr Machata74132a42012-03-16 02:46:18 +0100425 each_task(leader, NULL, &remove_task, leader);
Petr Machata98f09922011-07-09 10:55:29 +0200426 destroy_event_handler(leader);
Petr Machata590c8082011-08-20 22:45:26 +0200427 remove_task(leader, NULL);
Petr Machata98f09922011-07-09 10:55:29 +0200428}
429
430static void
Petr Machata6c2e57a2012-10-27 01:50:22 +0200431handle_stopping_event(struct pid_task *task_info, Event **eventp)
Petr Machata98f09922011-07-09 10:55:29 +0200432{
433 /* Mark all events, so that we know whom to SIGCONT later. */
Petr Machata3c9b6292011-08-20 15:05:41 +0200434 if (task_info != NULL)
Petr Machata98f09922011-07-09 10:55:29 +0200435 task_info->got_event = 1;
436
Petr Machata6c2e57a2012-10-27 01:50:22 +0200437 Event *event = *eventp;
Petr Machata98f09922011-07-09 10:55:29 +0200438
439 /* In every state, sink SIGSTOP events for tasks that it was
440 * sent to. */
441 if (task_info != NULL
442 && event->type == EVENT_SIGNAL
443 && event->e_un.signum == SIGSTOP) {
444 debug(DEBUG_PROCESS, "SIGSTOP delivered to %d", task_info->pid);
445 if (task_info->sigstopped
446 && !task_info->delivered) {
447 task_info->delivered = 1;
448 *eventp = NULL; // sink the event
449 } else
450 fprintf(stderr, "suspicious: %d got SIGSTOP, but "
451 "sigstopped=%d and delivered=%d\n",
452 task_info->pid, task_info->sigstopped,
453 task_info->delivered);
Juan Cespedese74c80d2009-02-11 11:32:31 +0100454 }
Juan Cespedes5e01f651998-03-08 22:31:44 +0100455}
456
Petr Machata98f09922011-07-09 10:55:29 +0200457/* Some SIGSTOPs may have not been delivered to their respective tasks
458 * yet. They are still in the queue. If we have seen an event for
459 * that process, continue it, so that the SIGSTOP can be delivered and
Petr Machata36d19822011-10-21 16:03:45 +0200460 * caught by ltrace. We don't mind that the process is after
461 * breakpoint (and therefore potentially doesn't have aligned IP),
462 * because the signal will be delivered without the process actually
463 * starting. */
Petr Machata98f09922011-07-09 10:55:29 +0200464static void
Petr Machata6c2e57a2012-10-27 01:50:22 +0200465continue_for_sigstop_delivery(struct pid_set *pids)
Petr Machata98f09922011-07-09 10:55:29 +0200466{
467 size_t i;
468 for (i = 0; i < pids->count; ++i) {
Petr Machata750ca8c2011-10-06 14:29:34 +0200469 if (pids->tasks[i].pid != 0
470 && pids->tasks[i].sigstopped
Petr Machata98f09922011-07-09 10:55:29 +0200471 && !pids->tasks[i].delivered
472 && pids->tasks[i].got_event) {
473 debug(DEBUG_PROCESS, "continue %d for SIGSTOP delivery",
474 pids->tasks[i].pid);
475 ptrace(PTRACE_SYSCALL, pids->tasks[i].pid, 0, 0);
476 }
477 }
Juan Cespedes5e01f651998-03-08 22:31:44 +0100478}
479
Petr Machata98f09922011-07-09 10:55:29 +0200480static int
Petr Machata6c2e57a2012-10-27 01:50:22 +0200481event_exit_p(Event *event)
Petr Machata750ca8c2011-10-06 14:29:34 +0200482{
483 return event != NULL && (event->type == EVENT_EXIT
484 || event->type == EVENT_EXIT_SIGNAL);
485}
486
487static int
Petr Machata6c2e57a2012-10-27 01:50:22 +0200488event_exit_or_none_p(Event *event)
Petr Machataf789c9c2011-07-09 10:54:27 +0200489{
Petr Machata750ca8c2011-10-06 14:29:34 +0200490 return event == NULL || event_exit_p(event)
Petr Machata98f09922011-07-09 10:55:29 +0200491 || event->type == EVENT_NONE;
492}
493
494static int
Petr Machata6c2e57a2012-10-27 01:50:22 +0200495await_sigstop_delivery(struct pid_set *pids, struct pid_task *task_info,
496 Event *event)
Petr Machata98f09922011-07-09 10:55:29 +0200497{
498 /* If we still didn't get our SIGSTOP, continue the process
499 * and carry on. */
500 if (event != NULL && !event_exit_or_none_p(event)
501 && task_info != NULL && task_info->sigstopped) {
502 debug(DEBUG_PROCESS, "continue %d for SIGSTOP delivery",
503 task_info->pid);
504 /* We should get the signal the first thing
505 * after this, so it should be OK to continue
506 * even if we are over a breakpoint. */
507 ptrace(PTRACE_SYSCALL, task_info->pid, 0, 0);
508
509 } else {
510 /* If all SIGSTOPs were delivered, uninstall the
511 * handler and continue everyone. */
512 /* XXX I suspect that we should check tasks that are
513 * still around. Is things are now, there should be a
514 * race between waiting for everyone to stop and one
515 * of the tasks exiting. */
516 int all_clear = 1;
517 size_t i;
518 for (i = 0; i < pids->count; ++i)
Petr Machata750ca8c2011-10-06 14:29:34 +0200519 if (pids->tasks[i].pid != 0
520 && pids->tasks[i].sigstopped
Petr Machata98f09922011-07-09 10:55:29 +0200521 && !pids->tasks[i].delivered) {
522 all_clear = 0;
523 break;
524 }
525 return all_clear;
526 }
527
528 return 0;
529}
530
Petr Machata590c8082011-08-20 22:45:26 +0200531static int
Petr Machata6c2e57a2012-10-27 01:50:22 +0200532all_stops_accountable(struct pid_set *pids)
Petr Machata590c8082011-08-20 22:45:26 +0200533{
534 size_t i;
535 for (i = 0; i < pids->count; ++i)
536 if (pids->tasks[i].pid != 0
537 && !pids->tasks[i].got_event
538 && !have_events_for(pids->tasks[i].pid))
539 return 0;
540 return 1;
541}
542
Petr Machataa266acb2012-04-12 23:50:23 +0200543/* The protocol is: 0 for success, negative for failure, positive if
544 * default singlestep is to be used. */
Petr Machata929bd572012-12-17 03:20:34 +0100545int arch_atomic_singlestep(struct process *proc, struct breakpoint *sbp,
Petr Machataa266acb2012-04-12 23:50:23 +0200546 int (*add_cb)(void *addr, void *data),
547 void *add_cb_data);
548
549#ifndef ARCH_HAVE_ATOMIC_SINGLESTEP
550int
Petr Machata929bd572012-12-17 03:20:34 +0100551arch_atomic_singlestep(struct process *proc, struct breakpoint *sbp,
Petr Machataa266acb2012-04-12 23:50:23 +0200552 int (*add_cb)(void *addr, void *data),
553 void *add_cb_data)
Petr Machata06986d52011-11-02 13:22:46 +0100554{
Petr Machataa266acb2012-04-12 23:50:23 +0200555 return 1;
556}
557#endif
558
Petr Machata42748ac2012-04-19 04:24:25 +0200559static Event *process_stopping_on_event(struct event_handler *super,
560 Event *event);
561
562static void
Petr Machata929bd572012-12-17 03:20:34 +0100563remove_atomic_breakpoints(struct process *proc)
Petr Machata42748ac2012-04-19 04:24:25 +0200564{
Petr Machata24a47042012-04-19 18:15:08 +0200565 struct process_stopping_handler *self
566 = (void *)proc->leader->event_handler;
567 assert(self != NULL);
Petr Machata42748ac2012-04-19 04:24:25 +0200568 assert(self->super.on_event == process_stopping_on_event);
569
570 int ct = sizeof(self->atomic_skip_bp_addrs)
571 / sizeof(*self->atomic_skip_bp_addrs);
572 int i;
573 for (i = 0; i < ct; ++i)
574 if (self->atomic_skip_bp_addrs[i] != 0) {
Petr Machata622581f2012-04-23 19:40:40 +0200575 delete_breakpoint(proc, self->atomic_skip_bp_addrs[i]);
Petr Machata42748ac2012-04-19 04:24:25 +0200576 self->atomic_skip_bp_addrs[i] = 0;
577 }
578}
579
580static void
Petr Machata929bd572012-12-17 03:20:34 +0100581atomic_singlestep_bp_on_hit(struct breakpoint *bp, struct process *proc)
Petr Machata42748ac2012-04-19 04:24:25 +0200582{
583 remove_atomic_breakpoints(proc);
584}
585
Petr Machataa266acb2012-04-12 23:50:23 +0200586static int
587atomic_singlestep_add_bp(void *addr, void *data)
588{
589 struct process_stopping_handler *self = data;
Petr Machata929bd572012-12-17 03:20:34 +0100590 struct process *proc = self->task_enabling_breakpoint;
Petr Machataa266acb2012-04-12 23:50:23 +0200591
Petr Machata42748ac2012-04-19 04:24:25 +0200592 int ct = sizeof(self->atomic_skip_bp_addrs)
593 / sizeof(*self->atomic_skip_bp_addrs);
594 int i;
595 for (i = 0; i < ct; ++i)
596 if (self->atomic_skip_bp_addrs[i] == 0) {
597 self->atomic_skip_bp_addrs[i] = addr;
598 static struct bp_callbacks cbs = {
599 .on_hit = atomic_singlestep_bp_on_hit,
600 };
601 struct breakpoint *bp
Petr Machata622581f2012-04-23 19:40:40 +0200602 = insert_breakpoint(proc, addr, NULL);
Petr Machata42748ac2012-04-19 04:24:25 +0200603 breakpoint_set_callbacks(bp, &cbs);
604 return 0;
605 }
Petr Machataa266acb2012-04-12 23:50:23 +0200606
Petr Machata42748ac2012-04-19 04:24:25 +0200607 assert(!"Too many atomic singlestep breakpoints!");
608 abort();
Petr Machataa266acb2012-04-12 23:50:23 +0200609}
610
611static int
612singlestep(struct process_stopping_handler *self)
613{
Petr Machata929bd572012-12-17 03:20:34 +0100614 struct process *proc = self->task_enabling_breakpoint;
Petr Machataa266acb2012-04-12 23:50:23 +0200615
616 int status = arch_atomic_singlestep(self->task_enabling_breakpoint,
617 self->breakpoint_being_enabled,
618 &atomic_singlestep_add_bp, self);
619
620 /* Propagate failure and success. */
621 if (status <= 0)
622 return status;
623
624 /* Otherwise do the default action: singlestep. */
Petr Machata06986d52011-11-02 13:22:46 +0100625 debug(1, "PTRACE_SINGLESTEP");
Petr Machataa266acb2012-04-12 23:50:23 +0200626 if (ptrace(PTRACE_SINGLESTEP, proc->pid, 0, 0)) {
Petr Machata06986d52011-11-02 13:22:46 +0100627 perror("PTRACE_SINGLESTEP");
Petr Machataa266acb2012-04-12 23:50:23 +0200628 return -1;
629 }
630 return 0;
631}
632
633static void
Petr Machata9e1e9692012-04-19 02:29:38 +0200634post_singlestep(struct process_stopping_handler *self,
635 struct Event **eventp)
Petr Machataa266acb2012-04-12 23:50:23 +0200636{
637 continue_for_sigstop_delivery(&self->pids);
638
Petr Machataf1fd7cd2012-04-19 03:05:58 +0200639 if (*eventp != NULL && (*eventp)->type == EVENT_BREAKPOINT)
Petr Machataa266acb2012-04-12 23:50:23 +0200640 *eventp = NULL; // handled
641
Petr Machata929bd572012-12-17 03:20:34 +0100642 struct process *proc = self->task_enabling_breakpoint;
Petr Machataa266acb2012-04-12 23:50:23 +0200643
Petr Machata42748ac2012-04-19 04:24:25 +0200644 remove_atomic_breakpoints(proc);
Petr Machataa266acb2012-04-12 23:50:23 +0200645 self->breakpoint_being_enabled = NULL;
646}
647
648static void
Petr Machata9e1e9692012-04-19 02:29:38 +0200649singlestep_error(struct process_stopping_handler *self)
Petr Machataa266acb2012-04-12 23:50:23 +0200650{
Petr Machata929bd572012-12-17 03:20:34 +0100651 struct process *teb = self->task_enabling_breakpoint;
Petr Machata9e1e9692012-04-19 02:29:38 +0200652 struct breakpoint *sbp = self->breakpoint_being_enabled;
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200653 fprintf(stderr, "%d couldn't continue when handling %s (%p) at %p\n",
Petr Machataba1664b2012-04-28 14:59:05 +0200654 teb->pid, breakpoint_name(sbp), sbp->addr,
655 get_instruction_pointer(teb));
Petr Machataa266acb2012-04-12 23:50:23 +0200656 delete_breakpoint(teb->leader, sbp->addr);
Petr Machata06986d52011-11-02 13:22:46 +0100657}
658
Petr Machata9e1e9692012-04-19 02:29:38 +0200659static void
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200660pt_continue(struct process_stopping_handler *self)
Petr Machatac1aa9582012-03-27 23:54:01 +0200661{
Petr Machata929bd572012-12-17 03:20:34 +0100662 struct process *teb = self->task_enabling_breakpoint;
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200663 debug(1, "PTRACE_CONT");
Petr Machata9e1e9692012-04-19 02:29:38 +0200664 ptrace(PTRACE_CONT, teb->pid, 0, 0);
665}
666
667static void
668pt_singlestep(struct process_stopping_handler *self)
669{
670 if (singlestep(self) < 0)
671 singlestep_error(self);
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200672}
673
674static void
675disable_and(struct process_stopping_handler *self,
Petr Machata9e1e9692012-04-19 02:29:38 +0200676 void (*do_this)(struct process_stopping_handler *self))
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200677{
Petr Machata929bd572012-12-17 03:20:34 +0100678 struct process *teb = self->task_enabling_breakpoint;
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200679 debug(DEBUG_PROCESS, "all stopped, now singlestep/cont %d", teb->pid);
Petr Machatac1aa9582012-03-27 23:54:01 +0200680 if (self->breakpoint_being_enabled->enabled)
681 disable_breakpoint(teb, self->breakpoint_being_enabled);
Petr Machata9e1e9692012-04-19 02:29:38 +0200682 (do_this)(self);
Petr Machatac1aa9582012-03-27 23:54:01 +0200683 self->state = psh_singlestep;
684}
685
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200686void
687linux_ptrace_disable_and_singlestep(struct process_stopping_handler *self)
688{
Petr Machata9e1e9692012-04-19 02:29:38 +0200689 disable_and(self, &pt_singlestep);
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200690}
691
692void
693linux_ptrace_disable_and_continue(struct process_stopping_handler *self)
694{
695 disable_and(self, &pt_continue);
696}
697
Petr Machata98f09922011-07-09 10:55:29 +0200698/* This event handler is installed when we are in the process of
699 * stopping the whole thread group to do the pointer re-enablement for
700 * one of the threads. We pump all events to the queue for later
701 * processing while we wait for all the threads to stop. When this
702 * happens, we let the re-enablement thread to PTRACE_SINGLESTEP,
703 * re-enable, and continue everyone. */
704static Event *
Petr Machata366c2f42012-02-09 19:34:36 +0100705process_stopping_on_event(struct event_handler *super, Event *event)
Petr Machata98f09922011-07-09 10:55:29 +0200706{
Petr Machata6c2e57a2012-10-27 01:50:22 +0200707 struct process_stopping_handler *self = (void *)super;
Petr Machata929bd572012-12-17 03:20:34 +0100708 struct process *task = event->proc;
709 struct process *leader = task->leader;
710 struct process *teb = self->task_enabling_breakpoint;
Petr Machata98f09922011-07-09 10:55:29 +0200711
712 debug(DEBUG_PROCESS,
Petr Machata9ace5742012-04-14 02:29:57 +0200713 "process_stopping_on_event: pid %d; event type %d; state %d",
Petr Machata98f09922011-07-09 10:55:29 +0200714 task->pid, event->type, self->state);
715
Petr Machata6c2e57a2012-10-27 01:50:22 +0200716 struct pid_task *task_info = get_task_info(&self->pids, task->pid);
Petr Machata98f09922011-07-09 10:55:29 +0200717 if (task_info == NULL)
718 fprintf(stderr, "new task??? %d\n", task->pid);
719 handle_stopping_event(task_info, &event);
720
721 int state = self->state;
722 int event_to_queue = !event_exit_or_none_p(event);
723
Petr Machata18c97072011-10-06 14:30:11 +0200724 /* Deactivate the entry if the task exits. */
725 if (event_exit_p(event) && task_info != NULL)
726 task_info->pid = 0;
727
Petr Machata43d2fe52011-11-02 13:25:49 +0100728 /* Always handle sysrets. Whether sysret occurred and what
729 * sys it rets from may need to be determined based on process
730 * stack, so we need to keep that in sync with reality. Note
731 * that we don't continue the process after the sysret is
732 * handled. See continue_after_syscall. */
733 if (event != NULL && event->type == EVENT_SYSRET) {
734 debug(1, "%d LT_EV_SYSRET", event->proc->pid);
735 event_to_queue = 0;
736 task_info->sysret = 1;
737 }
738
Petr Machata98f09922011-07-09 10:55:29 +0200739 switch (state) {
740 case psh_stopping:
741 /* If everyone is stopped, singlestep. */
Petr Machata74132a42012-03-16 02:46:18 +0100742 if (each_task(leader, NULL, &task_blocked,
743 &self->pids) == NULL) {
Petr Machatac1aa9582012-03-27 23:54:01 +0200744 (self->on_all_stopped)(self);
745 state = self->state;
Petr Machata98f09922011-07-09 10:55:29 +0200746 }
747 break;
748
Petr Machata06986d52011-11-02 13:22:46 +0100749 case psh_singlestep:
Petr Machata98f09922011-07-09 10:55:29 +0200750 /* In singlestep state, breakpoint signifies that we
751 * have now stepped, and can re-enable the breakpoint. */
Petr Machatae21264e2011-10-06 14:30:33 +0200752 if (event != NULL && task == teb) {
Petr Machatad5d93c42011-10-21 16:41:10 +0200753
Petr Machata42748ac2012-04-19 04:24:25 +0200754 /* If this was caused by a real breakpoint, as
755 * opposed to a singlestep, assume that it's
756 * an artificial breakpoint installed for some
757 * reason for the re-enablement. In that case
758 * handle it. */
759 if (event->type == EVENT_BREAKPOINT) {
Petr Machatabac2da52012-05-29 00:42:59 +0200760 arch_addr_t ip
Petr Machata42748ac2012-04-19 04:24:25 +0200761 = get_instruction_pointer(task);
762 struct breakpoint *other
763 = address2bpstruct(leader, ip);
764 if (other != NULL)
765 breakpoint_on_hit(other, task);
766 }
767
Petr Machata36f40e72012-03-28 02:07:19 +0200768 /* If we got SIGNAL instead of BREAKPOINT,
769 * then this is not singlestep at all. */
Petr Machatacb9a28d2012-03-28 11:11:32 +0200770 if (event->type == EVENT_SIGNAL) {
771 do_singlestep:
Petr Machataa266acb2012-04-12 23:50:23 +0200772 if (singlestep(self) < 0) {
Petr Machata9e1e9692012-04-19 02:29:38 +0200773 singlestep_error(self);
774 post_singlestep(self, &event);
Petr Machataa266acb2012-04-12 23:50:23 +0200775 goto psh_sinking;
776 }
Petr Machatad5d93c42011-10-21 16:41:10 +0200777 break;
Petr Machatacb9a28d2012-03-28 11:11:32 +0200778 } else {
779 switch ((self->keep_stepping_p)(self)) {
780 case CBS_FAIL:
781 /* XXX handle me */
782 case CBS_STOP:
783 break;
784 case CBS_CONT:
Petr Machata949a56a2012-04-03 00:32:03 +0200785 /* Sink singlestep event. */
786 if (event->type == EVENT_BREAKPOINT)
787 event = NULL;
Petr Machatacb9a28d2012-03-28 11:11:32 +0200788 goto do_singlestep;
789 }
Petr Machatad5d93c42011-10-21 16:41:10 +0200790 }
791
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200792 /* Re-enable the breakpoint that we are
793 * stepping over. */
Petr Machatac1aa9582012-03-27 23:54:01 +0200794 struct breakpoint *sbp = self->breakpoint_being_enabled;
Petr Machata590c8082011-08-20 22:45:26 +0200795 if (sbp->enabled)
796 enable_breakpoint(teb, sbp);
Petr Machata98f09922011-07-09 10:55:29 +0200797
Petr Machataa266acb2012-04-12 23:50:23 +0200798 post_singlestep(self, &event);
799 goto psh_sinking;
800 }
801 break;
Petr Machata98f09922011-07-09 10:55:29 +0200802
Petr Machataa266acb2012-04-12 23:50:23 +0200803 psh_sinking:
804 state = self->state = psh_sinking;
Petr Machata98f09922011-07-09 10:55:29 +0200805 case psh_sinking:
806 if (await_sigstop_delivery(&self->pids, task_info, event))
807 process_stopping_done(self, leader);
Petr Machata590c8082011-08-20 22:45:26 +0200808 break;
809
810 case psh_ugly_workaround:
811 if (event == NULL)
812 break;
813 if (event->type == EVENT_BREAKPOINT) {
814 undo_breakpoint(event, leader);
815 if (task == teb)
816 self->task_enabling_breakpoint = NULL;
817 }
818 if (self->task_enabling_breakpoint == NULL
819 && all_stops_accountable(&self->pids)) {
820 undo_breakpoint(event, leader);
821 detach_process(leader);
822 event = NULL; // handled
823 }
Petr Machata98f09922011-07-09 10:55:29 +0200824 }
825
826 if (event != NULL && event_to_queue) {
827 enque_event(event);
828 event = NULL; // sink the event
829 }
830
831 return event;
832}
833
834static void
Petr Machata366c2f42012-02-09 19:34:36 +0100835process_stopping_destroy(struct event_handler *super)
Petr Machata98f09922011-07-09 10:55:29 +0200836{
Petr Machata6c2e57a2012-10-27 01:50:22 +0200837 struct process_stopping_handler *self = (void *)super;
Petr Machata98f09922011-07-09 10:55:29 +0200838 free(self->pids.tasks);
Juan Cespedes5e01f651998-03-08 22:31:44 +0100839}
Juan Cespedes8cc1b9d2002-03-01 19:54:23 +0100840
Petr Machata36f40e72012-03-28 02:07:19 +0200841static enum callback_status
842no(struct process_stopping_handler *self)
843{
Petr Machatacb9a28d2012-03-28 11:11:32 +0200844 return CBS_STOP;
Petr Machata36f40e72012-03-28 02:07:19 +0200845}
846
Petr Machatac1aa9582012-03-27 23:54:01 +0200847int
Petr Machata929bd572012-12-17 03:20:34 +0100848process_install_stopping_handler(struct process *proc, struct breakpoint *sbp,
Petr Machata36f40e72012-03-28 02:07:19 +0200849 void (*as)(struct process_stopping_handler *),
850 enum callback_status (*ks)
Petr Machatacb9a28d2012-03-28 11:11:32 +0200851 (struct process_stopping_handler *),
852 enum callback_status (*uw)
Petr Machata36f40e72012-03-28 02:07:19 +0200853 (struct process_stopping_handler *))
Petr Machatac1aa9582012-03-27 23:54:01 +0200854{
Petr Machata9ace5742012-04-14 02:29:57 +0200855 debug(DEBUG_FUNCTION,
856 "process_install_stopping_handler: pid=%d", proc->pid);
857
Petr Machatac1aa9582012-03-27 23:54:01 +0200858 struct process_stopping_handler *handler = calloc(sizeof(*handler), 1);
859 if (handler == NULL)
860 return -1;
861
Petr Machata36f40e72012-03-28 02:07:19 +0200862 if (as == NULL)
Petr Machata1e2a4dd2012-04-15 04:35:48 +0200863 as = &linux_ptrace_disable_and_singlestep;
Petr Machata36f40e72012-03-28 02:07:19 +0200864 if (ks == NULL)
865 ks = &no;
Petr Machatacb9a28d2012-03-28 11:11:32 +0200866 if (uw == NULL)
867 uw = &no;
Petr Machata36f40e72012-03-28 02:07:19 +0200868
Petr Machatac1aa9582012-03-27 23:54:01 +0200869 handler->super.on_event = process_stopping_on_event;
870 handler->super.destroy = process_stopping_destroy;
871 handler->task_enabling_breakpoint = proc;
872 handler->breakpoint_being_enabled = sbp;
Petr Machata36f40e72012-03-28 02:07:19 +0200873 handler->on_all_stopped = as;
874 handler->keep_stepping_p = ks;
Petr Machatacb9a28d2012-03-28 11:11:32 +0200875 handler->ugly_workaround_p = uw;
Petr Machatac1aa9582012-03-27 23:54:01 +0200876
877 install_event_handler(proc->leader, &handler->super);
878
879 if (each_task(proc->leader, NULL, &send_sigstop,
880 &handler->pids) != NULL) {
881 destroy_event_handler(proc);
882 return -1;
883 }
884
885 /* And deliver the first fake event, in case all the
886 * conditions are already fulfilled. */
887 Event ev = {
888 .type = EVENT_NONE,
889 .proc = proc,
890 };
891 process_stopping_on_event(&handler->super, &ev);
892
893 return 0;
894}
895
Juan Cespedesf1350522008-12-16 18:19:58 +0100896void
Petr Machata929bd572012-12-17 03:20:34 +0100897continue_after_breakpoint(struct process *proc, struct breakpoint *sbp)
Petr Machata26627682011-07-08 18:15:32 +0200898{
Petr Machata9ace5742012-04-14 02:29:57 +0200899 debug(DEBUG_PROCESS,
900 "continue_after_breakpoint: pid=%d, addr=%p",
901 proc->pid, sbp->addr);
902
Juan Cespedes5c3fe062004-06-14 18:08:37 +0200903 set_instruction_pointer(proc, sbp->addr);
Petr Machatac1aa9582012-03-27 23:54:01 +0200904
Juan Cespedes8f8282f2002-03-03 18:58:40 +0100905 if (sbp->enabled == 0) {
906 continue_process(proc->pid);
907 } else {
Edgar E. Iglesiasaddae052012-09-27 17:02:39 +0200908#if defined __sparc__ || defined __ia64___
Ian Wienand9a2ad352006-02-20 22:44:45 +0100909 /* we don't want to singlestep here */
Juan Cespedes5c3fe062004-06-14 18:08:37 +0200910 continue_process(proc->pid);
911#else
Petr Machatacb9a28d2012-03-28 11:11:32 +0200912 if (process_install_stopping_handler
913 (proc, sbp, NULL, NULL, NULL) < 0) {
Petr Machatac1aa9582012-03-27 23:54:01 +0200914 perror("process_stopping_handler_create");
Petr Machata98f09922011-07-09 10:55:29 +0200915 /* Carry on not bothering to re-enable. */
916 continue_process(proc->pid);
Petr Machata98f09922011-07-09 10:55:29 +0200917 }
Juan Cespedes5c3fe062004-06-14 18:08:37 +0200918#endif
Juan Cespedes8f8282f2002-03-03 18:58:40 +0100919 }
920}
921
Petr Machata602330f2011-07-09 11:15:34 +0200922/**
923 * Ltrace exit. When we are about to exit, we have to go through all
924 * the processes, stop them all, remove all the breakpoints, and then
925 * detach the processes that we attached to using -p. If we left the
926 * other tasks running, they might hit stray return breakpoints and
927 * produce artifacts, so we better stop everyone, even if it's a bit
928 * of extra work.
929 */
930struct ltrace_exiting_handler
931{
Petr Machata366c2f42012-02-09 19:34:36 +0100932 struct event_handler super;
Petr Machata602330f2011-07-09 11:15:34 +0200933 struct pid_set pids;
934};
935
Petr Machata602330f2011-07-09 11:15:34 +0200936static Event *
Petr Machata366c2f42012-02-09 19:34:36 +0100937ltrace_exiting_on_event(struct event_handler *super, Event *event)
Petr Machata602330f2011-07-09 11:15:34 +0200938{
Petr Machata6c2e57a2012-10-27 01:50:22 +0200939 struct ltrace_exiting_handler *self = (void *)super;
Petr Machata929bd572012-12-17 03:20:34 +0100940 struct process *task = event->proc;
941 struct process *leader = task->leader;
Petr Machata602330f2011-07-09 11:15:34 +0200942
Petr Machata9ace5742012-04-14 02:29:57 +0200943 debug(DEBUG_PROCESS,
944 "ltrace_exiting_on_event: pid %d; event type %d",
945 task->pid, event->type);
Petr Machata602330f2011-07-09 11:15:34 +0200946
Petr Machata6c2e57a2012-10-27 01:50:22 +0200947 struct pid_task *task_info = get_task_info(&self->pids, task->pid);
Petr Machata602330f2011-07-09 11:15:34 +0200948 handle_stopping_event(task_info, &event);
949
Petr Machata590c8082011-08-20 22:45:26 +0200950 if (event != NULL && event->type == EVENT_BREAKPOINT)
951 undo_breakpoint(event, leader);
Petr Machata4b9f4d92011-08-20 04:07:05 +0200952
953 if (await_sigstop_delivery(&self->pids, task_info, event)
Petr Machata590c8082011-08-20 22:45:26 +0200954 && all_stops_accountable(&self->pids))
955 detach_process(leader);
Petr Machata602330f2011-07-09 11:15:34 +0200956
957 /* Sink all non-exit events. We are about to exit, so we
958 * don't bother with queuing them. */
959 if (event_exit_or_none_p(event))
960 return event;
Petr Machata13d5df72011-08-19 23:15:15 +0200961
Petr Machata13d5df72011-08-19 23:15:15 +0200962 return NULL;
Petr Machata602330f2011-07-09 11:15:34 +0200963}
964
965static void
Petr Machata366c2f42012-02-09 19:34:36 +0100966ltrace_exiting_destroy(struct event_handler *super)
Petr Machata602330f2011-07-09 11:15:34 +0200967{
Petr Machata6c2e57a2012-10-27 01:50:22 +0200968 struct ltrace_exiting_handler *self = (void *)super;
Petr Machata602330f2011-07-09 11:15:34 +0200969 free(self->pids.tasks);
970}
971
972static int
Petr Machata929bd572012-12-17 03:20:34 +0100973ltrace_exiting_install_handler(struct process *proc)
Petr Machata602330f2011-07-09 11:15:34 +0200974{
975 /* Only install to leader. */
976 if (proc->leader != proc)
977 return 0;
978
979 /* Perhaps we are already installed, if the user passed
980 * several -p options that are tasks of one process. */
981 if (proc->event_handler != NULL
982 && proc->event_handler->on_event == &ltrace_exiting_on_event)
983 return 0;
984
Petr Machata590c8082011-08-20 22:45:26 +0200985 /* If stopping handler is already present, let it do the
986 * work. */
987 if (proc->event_handler != NULL) {
988 assert(proc->event_handler->on_event
989 == &process_stopping_on_event);
Petr Machata6c2e57a2012-10-27 01:50:22 +0200990 struct process_stopping_handler *other
Petr Machata590c8082011-08-20 22:45:26 +0200991 = (void *)proc->event_handler;
992 other->exiting = 1;
993 return 0;
994 }
995
Petr Machata6c2e57a2012-10-27 01:50:22 +0200996 struct ltrace_exiting_handler *handler
Petr Machata602330f2011-07-09 11:15:34 +0200997 = calloc(sizeof(*handler), 1);
998 if (handler == NULL) {
999 perror("malloc exiting handler");
1000 fatal:
1001 /* XXXXXXXXXXXXXXXXXXX fixme */
1002 return -1;
1003 }
1004
Petr Machata602330f2011-07-09 11:15:34 +02001005 handler->super.on_event = ltrace_exiting_on_event;
1006 handler->super.destroy = ltrace_exiting_destroy;
1007 install_event_handler(proc->leader, &handler->super);
1008
Petr Machata74132a42012-03-16 02:46:18 +01001009 if (each_task(proc->leader, NULL, &send_sigstop,
Petr Machata602330f2011-07-09 11:15:34 +02001010 &handler->pids) != NULL)
1011 goto fatal;
1012
1013 return 0;
1014}
1015
Petr Machatacbe29c62011-09-27 02:27:58 +02001016/*
1017 * When the traced process vforks, it's suspended until the child
1018 * process calls _exit or exec*. In the meantime, the two share the
1019 * address space.
1020 *
1021 * The child process should only ever call _exit or exec*, but we
1022 * can't count on that (it's not the role of ltrace to policy, but to
1023 * observe). In any case, we will _at least_ have to deal with
1024 * removal of vfork return breakpoint (which we have to smuggle back
1025 * in, so that the parent can see it, too), and introduction of exec*
1026 * return breakpoint. Since we already have both breakpoint actions
1027 * to deal with, we might as well support it all.
1028 *
1029 * The gist is that we pretend that the child is in a thread group
1030 * with its parent, and handle it as a multi-threaded case, with the
1031 * exception that we know that the parent is blocked, and don't
1032 * attempt to stop it. When the child execs, we undo the setup.
Petr Machatacbe29c62011-09-27 02:27:58 +02001033 */
1034
Petr Machata134a1082011-09-27 20:25:58 +02001035struct process_vfork_handler
1036{
Petr Machata366c2f42012-02-09 19:34:36 +01001037 struct event_handler super;
Petr Machata6c2e57a2012-10-27 01:50:22 +02001038 void *bp_addr;
Petr Machata134a1082011-09-27 20:25:58 +02001039};
1040
Petr Machatacbe29c62011-09-27 02:27:58 +02001041static Event *
Petr Machata366c2f42012-02-09 19:34:36 +01001042process_vfork_on_event(struct event_handler *super, Event *event)
Petr Machatacbe29c62011-09-27 02:27:58 +02001043{
Petr Machata9ace5742012-04-14 02:29:57 +02001044 debug(DEBUG_PROCESS,
1045 "process_vfork_on_event: pid %d; event type %d",
1046 event->proc->pid, event->type);
1047
Petr Machata6c2e57a2012-10-27 01:50:22 +02001048 struct process_vfork_handler *self = (void *)super;
Petr Machatabc373262012-02-07 23:31:15 +01001049 struct breakpoint *sbp;
Petr Machatacbe29c62011-09-27 02:27:58 +02001050 assert(self != NULL);
1051
1052 switch (event->type) {
Petr Machata134a1082011-09-27 20:25:58 +02001053 case EVENT_BREAKPOINT:
1054 /* Remember the vfork return breakpoint. */
Petr Machata77e8fa82012-04-19 18:36:32 +02001055 if (self->bp_addr == 0)
Petr Machata134a1082011-09-27 20:25:58 +02001056 self->bp_addr = event->e_un.brk_addr;
1057 break;
1058
Petr Machatacbe29c62011-09-27 02:27:58 +02001059 case EVENT_EXIT:
1060 case EVENT_EXIT_SIGNAL:
1061 case EVENT_EXEC:
Petr Machata134a1082011-09-27 20:25:58 +02001062 /* Smuggle back in the vfork return breakpoint, so
1063 * that our parent can trip over it once again. */
Petr Machata77e8fa82012-04-19 18:36:32 +02001064 if (self->bp_addr != 0) {
Petr Machata134a1082011-09-27 20:25:58 +02001065 sbp = dict_find_entry(event->proc->leader->breakpoints,
1066 self->bp_addr);
1067 if (sbp != NULL)
Petr Machata77e8fa82012-04-19 18:36:32 +02001068 assert(sbp->libsym == NULL);
1069 /* We don't mind failing that, it's not a big
1070 * deal to not display one extra vfork return. */
1071 insert_breakpoint(event->proc->parent,
1072 self->bp_addr, NULL);
Petr Machata134a1082011-09-27 20:25:58 +02001073 }
1074
Petr Machataba9911f2011-09-27 21:09:47 +02001075 continue_process(event->proc->parent->pid);
Petr Machata134a1082011-09-27 20:25:58 +02001076
1077 /* Remove the leader that we artificially set up
1078 * earlier. */
Petr Machatacbe29c62011-09-27 02:27:58 +02001079 change_process_leader(event->proc, event->proc);
1080 destroy_event_handler(event->proc);
1081
Petr Machatacbe29c62011-09-27 02:27:58 +02001082 default:
1083 ;
1084 }
1085
1086 return event;
1087}
1088
1089void
Petr Machata929bd572012-12-17 03:20:34 +01001090continue_after_vfork(struct process *proc)
Petr Machatacbe29c62011-09-27 02:27:58 +02001091{
1092 debug(DEBUG_PROCESS, "continue_after_vfork: pid=%d", proc->pid);
Petr Machata6c2e57a2012-10-27 01:50:22 +02001093 struct process_vfork_handler *handler = calloc(sizeof(*handler), 1);
Petr Machatacbe29c62011-09-27 02:27:58 +02001094 if (handler == NULL) {
1095 perror("malloc vfork handler");
1096 /* Carry on not bothering to treat the process as
1097 * necessary. */
1098 continue_process(proc->parent->pid);
1099 return;
1100 }
1101
1102 /* We must set up custom event handler, so that we see
1103 * exec/exit events for the task itself. */
Petr Machata134a1082011-09-27 20:25:58 +02001104 handler->super.on_event = process_vfork_on_event;
1105 install_event_handler(proc, &handler->super);
Petr Machatacbe29c62011-09-27 02:27:58 +02001106
1107 /* Make sure that the child is sole thread. */
1108 assert(proc->leader == proc);
1109 assert(proc->next == NULL || proc->next->leader != proc);
1110
1111 /* Make sure that the child's parent is properly set up. */
1112 assert(proc->parent != NULL);
1113 assert(proc->parent->leader != NULL);
1114
1115 change_process_leader(proc, proc->parent->leader);
Petr Machatacbe29c62011-09-27 02:27:58 +02001116}
1117
Petr Machata9d29b3e2011-11-09 16:46:56 +01001118static int
Petr Machata929bd572012-12-17 03:20:34 +01001119is_mid_stopping(struct process *proc)
Petr Machata9d29b3e2011-11-09 16:46:56 +01001120{
1121 return proc != NULL
1122 && proc->event_handler != NULL
1123 && proc->event_handler->on_event == &process_stopping_on_event;
1124}
1125
Petr Machata43d2fe52011-11-02 13:25:49 +01001126void
Petr Machata929bd572012-12-17 03:20:34 +01001127continue_after_syscall(struct process *proc, int sysnum, int ret_p)
Petr Machata43d2fe52011-11-02 13:25:49 +01001128{
1129 /* Don't continue if we are mid-stopping. */
Petr Machata9d29b3e2011-11-09 16:46:56 +01001130 if (ret_p && (is_mid_stopping(proc) || is_mid_stopping(proc->leader))) {
1131 debug(DEBUG_PROCESS,
1132 "continue_after_syscall: don't continue %d",
1133 proc->pid);
Petr Machata43d2fe52011-11-02 13:25:49 +01001134 return;
Petr Machata9d29b3e2011-11-09 16:46:56 +01001135 }
Petr Machata43d2fe52011-11-02 13:25:49 +01001136 continue_process(proc->pid);
1137}
1138
Petr Machata602330f2011-07-09 11:15:34 +02001139/* If ltrace gets SIGINT, the processes directly or indirectly run by
1140 * ltrace get it too. We just have to wait long enough for the signal
1141 * to be delivered and the process terminated, which we notice and
1142 * exit ltrace, too. So there's not much we need to do there. We
1143 * want to keep tracing those processes as usual, in case they just
1144 * SIG_IGN the SIGINT to do their shutdown etc.
1145 *
1146 * For processes ran on the background, we want to install an exit
1147 * handler that stops all the threads, removes all breakpoints, and
1148 * detaches.
1149 */
1150void
Petr Machataffe4cd22012-04-11 18:01:44 +02001151os_ltrace_exiting(void)
Petr Machata602330f2011-07-09 11:15:34 +02001152{
Petr Machata6c2e57a2012-10-27 01:50:22 +02001153 struct opt_p_t *it;
Petr Machata602330f2011-07-09 11:15:34 +02001154 for (it = opt_p; it != NULL; it = it->next) {
Petr Machata929bd572012-12-17 03:20:34 +01001155 struct process *proc = pid2proc(it->pid);
Petr Machata602330f2011-07-09 11:15:34 +02001156 if (proc == NULL || proc->leader == NULL)
1157 continue;
1158 if (ltrace_exiting_install_handler(proc->leader) < 0)
1159 fprintf(stderr,
1160 "Couldn't install exiting handler for %d.\n",
1161 proc->pid);
1162 }
1163}
1164
Petr Machataffe4cd22012-04-11 18:01:44 +02001165int
1166os_ltrace_exiting_sighandler(void)
1167{
1168 extern int linux_in_waitpid;
1169 if (linux_in_waitpid) {
1170 os_ltrace_exiting();
1171 return 1;
1172 }
1173 return 0;
1174}
1175
Joe Damatodfa3fa32010-11-08 15:47:35 -08001176size_t
Petr Machata929bd572012-12-17 03:20:34 +01001177umovebytes(struct process *proc, void *addr, void *laddr, size_t len)
1178{
Joe Damatodfa3fa32010-11-08 15:47:35 -08001179
1180 union {
1181 long a;
1182 char c[sizeof(long)];
1183 } a;
Zachary T Welchba6aca22010-12-08 18:55:09 -08001184 int started = 0;
1185 size_t offset = 0, bytes_read = 0;
Joe Damatodfa3fa32010-11-08 15:47:35 -08001186
1187 while (offset < len) {
1188 a.a = ptrace(PTRACE_PEEKTEXT, proc->pid, addr + offset, 0);
1189 if (a.a == -1 && errno) {
1190 if (started && errno == EIO)
1191 return bytes_read;
1192 else
1193 return -1;
1194 }
1195 started = 1;
1196
1197 if (len - offset >= sizeof(long)) {
1198 memcpy(laddr + offset, &a.c[0], sizeof(long));
1199 bytes_read += sizeof(long);
1200 }
1201 else {
1202 memcpy(laddr + offset, &a.c[0], len - offset);
1203 bytes_read += (len - offset);
1204 }
1205 offset += sizeof(long);
1206 }
1207
1208 return bytes_read;
1209}