trace.c revision bac2da505ee174b7fb984b975c5938f88f0dbab2
1/*
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
24#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>
31#include <stdio.h>
32#include <stdlib.h>
33#include <string.h>
34#include <unistd.h>
35
36#ifdef HAVE_LIBSELINUX
37# include <selinux/selinux.h>
38#endif
39
40#include "linux-gnu/trace.h"
41#include "backend.h"
42#include "breakpoint.h"
43#include "debug.h"
44#include "events.h"
45#include "options.h"
46#include "proc.h"
47#include "ptrace.h"
48#include "type.h"
49
50/* If the system headers did not provide the constants, hard-code the normal
51   values.  */
52#ifndef PTRACE_EVENT_FORK
53
54#define PTRACE_OLDSETOPTIONS    21
55#define PTRACE_SETOPTIONS       0x4200
56#define PTRACE_GETEVENTMSG      0x4201
57
58/* options set using PTRACE_SETOPTIONS */
59#define PTRACE_O_TRACESYSGOOD   0x00000001
60#define PTRACE_O_TRACEFORK      0x00000002
61#define PTRACE_O_TRACEVFORK     0x00000004
62#define PTRACE_O_TRACECLONE     0x00000008
63#define PTRACE_O_TRACEEXEC      0x00000010
64#define PTRACE_O_TRACEVFORKDONE 0x00000020
65#define PTRACE_O_TRACEEXIT      0x00000040
66
67/* Wait extended result codes for the above trace options.  */
68#define PTRACE_EVENT_FORK       1
69#define PTRACE_EVENT_VFORK      2
70#define PTRACE_EVENT_CLONE      3
71#define PTRACE_EVENT_EXEC       4
72#define PTRACE_EVENT_VFORK_DONE 5
73#define PTRACE_EVENT_EXIT       6
74
75#endif /* PTRACE_EVENT_FORK */
76
77void
78trace_fail_warning(pid_t pid)
79{
80	/* This was adapted from GDB.  */
81#ifdef HAVE_LIBSELINUX
82	static int checked = 0;
83	if (checked)
84		return;
85	checked = 1;
86
87	/* -1 is returned for errors, 0 if it has no effect, 1 if
88	 * PTRACE_ATTACH is forbidden.  */
89	if (security_get_boolean_active("deny_ptrace") == 1)
90		fprintf(stderr,
91"The SELinux boolean 'deny_ptrace' is enabled, which may prevent ltrace from\n"
92"tracing other processes.  You can disable this process attach protection by\n"
93"issuing 'setsebool deny_ptrace=0' in the superuser context.\n");
94#endif /* HAVE_LIBSELINUX */
95}
96
97void
98trace_me(void)
99{
100	debug(DEBUG_PROCESS, "trace_me: pid=%d", getpid());
101	if (ptrace(PTRACE_TRACEME, 0, 0, 0) < 0) {
102		perror("PTRACE_TRACEME");
103		trace_fail_warning(getpid());
104		exit(1);
105	}
106}
107
108/* There's a (hopefully) brief period of time after the child process
109 * forks when we can't trace it yet.  Here we wait for kernel to
110 * prepare the process.  */
111int
112wait_for_proc(pid_t pid)
113{
114	/* man ptrace: PTRACE_ATTACH attaches to the process specified
115	   in pid.  The child is sent a SIGSTOP, but will not
116	   necessarily have stopped by the completion of this call;
117	   use wait() to wait for the child to stop. */
118	if (waitpid(pid, NULL, __WALL) != pid) {
119		perror ("trace_pid: waitpid");
120		return -1;
121	}
122
123	return 0;
124}
125
126int
127trace_pid(pid_t pid)
128{
129	debug(DEBUG_PROCESS, "trace_pid: pid=%d", pid);
130	/* This shouldn't emit error messages, as there are legitimate
131	 * reasons that the PID can't be attached: like it may have
132	 * already ended.  */
133	if (ptrace(PTRACE_ATTACH, pid, 0, 0) < 0)
134		return -1;
135
136	return wait_for_proc(pid);
137}
138
139void
140trace_set_options(struct Process *proc)
141{
142	if (proc->tracesysgood & 0x80)
143		return;
144
145	pid_t pid = proc->pid;
146	debug(DEBUG_PROCESS, "trace_set_options: pid=%d", pid);
147
148	long options = PTRACE_O_TRACESYSGOOD | PTRACE_O_TRACEFORK |
149		PTRACE_O_TRACEVFORK | PTRACE_O_TRACECLONE |
150		PTRACE_O_TRACEEXEC;
151	if (ptrace(PTRACE_SETOPTIONS, pid, 0, (void *)options) < 0 &&
152	    ptrace(PTRACE_OLDSETOPTIONS, pid, 0, (void *)options) < 0) {
153		perror("PTRACE_SETOPTIONS");
154		return;
155	}
156	proc->tracesysgood |= 0x80;
157}
158
159void
160untrace_pid(pid_t pid) {
161	debug(DEBUG_PROCESS, "untrace_pid: pid=%d", pid);
162	ptrace(PTRACE_DETACH, pid, 0, 0);
163}
164
165void
166continue_after_signal(pid_t pid, int signum)
167{
168	debug(DEBUG_PROCESS, "continue_after_signal: pid=%d, signum=%d",
169	      pid, signum);
170	ptrace(PTRACE_SYSCALL, pid, 0, (void *)(uintptr_t)signum);
171}
172
173static enum ecb_status
174event_for_pid(Event * event, void * data)
175{
176	if (event->proc != NULL && event->proc->pid == (pid_t)(uintptr_t)data)
177		return ecb_yield;
178	return ecb_cont;
179}
180
181static int
182have_events_for(pid_t pid)
183{
184	return each_qd_event(event_for_pid, (void *)(uintptr_t)pid) != NULL;
185}
186
187void
188continue_process(pid_t pid)
189{
190	debug(DEBUG_PROCESS, "continue_process: pid=%d", pid);
191
192	/* Only really continue the process if there are no events in
193	   the queue for this process.  Otherwise just wait for the
194	   other events to arrive.  */
195	if (!have_events_for(pid))
196		/* We always trace syscalls to control fork(),
197		 * clone(), execve()... */
198		ptrace(PTRACE_SYSCALL, pid, 0, 0);
199	else
200		debug(DEBUG_PROCESS,
201		      "putting off the continue, events in que.");
202}
203
204static struct pid_task *
205get_task_info(struct pid_set * pids, pid_t pid)
206{
207	assert(pid != 0);
208	size_t i;
209	for (i = 0; i < pids->count; ++i)
210		if (pids->tasks[i].pid == pid)
211			return &pids->tasks[i];
212
213	return NULL;
214}
215
216static struct pid_task *
217add_task_info(struct pid_set * pids, pid_t pid)
218{
219	if (pids->count == pids->alloc) {
220		size_t ns = (2 * pids->alloc) ?: 4;
221		struct pid_task * n = realloc(pids->tasks,
222					      sizeof(*pids->tasks) * ns);
223		if (n == NULL)
224			return NULL;
225		pids->tasks = n;
226		pids->alloc = ns;
227	}
228	struct pid_task * task_info = &pids->tasks[pids->count++];
229	memset(task_info, 0, sizeof(*task_info));
230	task_info->pid = pid;
231	return task_info;
232}
233
234static enum callback_status
235task_stopped(struct Process *task, void *data)
236{
237	enum process_status st = process_status(task->pid);
238	if (data != NULL)
239		*(enum process_status *)data = st;
240
241	/* If the task is already stopped, don't worry about it.
242	 * Likewise if it managed to become a zombie or terminate in
243	 * the meantime.  This can happen when the whole thread group
244	 * is terminating.  */
245	switch (st) {
246	case ps_invalid:
247	case ps_tracing_stop:
248	case ps_zombie:
249		return CBS_CONT;
250	case ps_sleeping:
251	case ps_stop:
252	case ps_other:
253		return CBS_STOP;
254	}
255
256	abort ();
257}
258
259/* Task is blocked if it's stopped, or if it's a vfork parent.  */
260static enum callback_status
261task_blocked(struct Process *task, void *data)
262{
263	struct pid_set * pids = data;
264	struct pid_task * task_info = get_task_info(pids, task->pid);
265	if (task_info != NULL
266	    && task_info->vforked)
267		return CBS_CONT;
268
269	return task_stopped(task, NULL);
270}
271
272static Event *process_vfork_on_event(struct event_handler *super, Event *event);
273
274static enum callback_status
275task_vforked(struct Process *task, void *data)
276{
277	if (task->event_handler != NULL
278	    && task->event_handler->on_event == &process_vfork_on_event)
279		return CBS_STOP;
280	return CBS_CONT;
281}
282
283static int
284is_vfork_parent(struct Process *task)
285{
286	return each_task(task->leader, NULL, &task_vforked, NULL) != NULL;
287}
288
289static enum callback_status
290send_sigstop(struct Process *task, void *data)
291{
292	Process * leader = task->leader;
293	struct pid_set * pids = data;
294
295	/* Look for pre-existing task record, or add new.  */
296	struct pid_task * task_info = get_task_info(pids, task->pid);
297	if (task_info == NULL)
298		task_info = add_task_info(pids, task->pid);
299	if (task_info == NULL) {
300		perror("send_sigstop: add_task_info");
301		destroy_event_handler(leader);
302		/* Signal failure upwards.  */
303		return CBS_STOP;
304	}
305
306	/* This task still has not been attached to.  It should be
307	   stopped by the kernel.  */
308	if (task->state == STATE_BEING_CREATED)
309		return CBS_CONT;
310
311	/* Don't bother sending SIGSTOP if we are already stopped, or
312	 * if we sent the SIGSTOP already, which happens when we are
313	 * handling "onexit" and inherited the handler from breakpoint
314	 * re-enablement.  */
315	enum process_status st;
316	if (task_stopped(task, &st) == CBS_CONT)
317		return CBS_CONT;
318	if (task_info->sigstopped) {
319		if (!task_info->delivered)
320			return CBS_CONT;
321		task_info->delivered = 0;
322	}
323
324	/* Also don't attempt to stop the process if it's a parent of
325	 * vforked process.  We set up event handler specially to hint
326	 * us.  In that case parent is in D state, which we use to
327	 * weed out unnecessary looping.  */
328	if (st == ps_sleeping
329	    && is_vfork_parent (task)) {
330		task_info->vforked = 1;
331		return CBS_CONT;
332	}
333
334	if (task_kill(task->pid, SIGSTOP) >= 0) {
335		debug(DEBUG_PROCESS, "send SIGSTOP to %d", task->pid);
336		task_info->sigstopped = 1;
337	} else
338		fprintf(stderr,
339			"Warning: couldn't send SIGSTOP to %d\n", task->pid);
340
341	return CBS_CONT;
342}
343
344/* On certain kernels, detaching right after a singlestep causes the
345   tracee to be killed with a SIGTRAP (that even though the singlestep
346   was properly caught by waitpid.  The ugly workaround is to put a
347   breakpoint where IP points and let the process continue.  After
348   this the breakpoint can be retracted and the process detached.  */
349static void
350ugly_workaround(Process * proc)
351{
352	void * ip = get_instruction_pointer(proc);
353	struct breakpoint *sbp = dict_find_entry(proc->leader->breakpoints, ip);
354	if (sbp != NULL)
355		enable_breakpoint(proc, sbp);
356	else
357		insert_breakpoint(proc, ip, NULL);
358	ptrace(PTRACE_CONT, proc->pid, 0, 0);
359}
360
361static void
362process_stopping_done(struct process_stopping_handler * self, Process * leader)
363{
364	debug(DEBUG_PROCESS, "process stopping done %d",
365	      self->task_enabling_breakpoint->pid);
366
367	if (!self->exiting) {
368		size_t i;
369		for (i = 0; i < self->pids.count; ++i)
370			if (self->pids.tasks[i].pid != 0
371			    && (self->pids.tasks[i].delivered
372				|| self->pids.tasks[i].sysret))
373				continue_process(self->pids.tasks[i].pid);
374		continue_process(self->task_enabling_breakpoint->pid);
375	}
376
377	if (self->exiting) {
378	ugly_workaround:
379		self->state = psh_ugly_workaround;
380		ugly_workaround(self->task_enabling_breakpoint);
381	} else {
382		switch ((self->ugly_workaround_p)(self)) {
383		case CBS_FAIL:
384			/* xxx handle me */
385		case CBS_STOP:
386			break;
387		case CBS_CONT:
388			goto ugly_workaround;
389		}
390		destroy_event_handler(leader);
391	}
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
408static enum callback_status
409untrace_task(struct Process *task, void *data)
410{
411	if (task != data)
412		untrace_pid(task->pid);
413	return CBS_CONT;
414}
415
416static enum callback_status
417remove_task(struct Process *task, void *data)
418{
419	/* Don't untrace leader just yet.  */
420	if (task != data)
421		remove_process(task);
422	return CBS_CONT;
423}
424
425static 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
432static void
433detach_process(Process * leader)
434{
435	each_qd_event(&undo_breakpoint, leader);
436	disable_all_breakpoints(leader);
437	proc_each_breakpoint(leader, NULL, retract_breakpoint_cb, NULL);
438
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) {
446			each_task(leader, NULL, &untrace_task, NULL);
447			break;
448		}
449	}
450	each_task(leader, NULL, &remove_task, leader);
451	destroy_event_handler(leader);
452	remove_task(leader, NULL);
453}
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.  */
459	if (task_info != NULL)
460		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);
479	}
480}
481
482/* 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
485 * 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.  */
489static void
490continue_for_sigstop_delivery(struct pid_set * pids)
491{
492	size_t i;
493	for (i = 0; i < pids->count; ++i) {
494		if (pids->tasks[i].pid != 0
495		    && pids->tasks[i].sigstopped
496		    && !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	}
503}
504
505static int
506event_exit_p(Event * event)
507{
508	return event != NULL && (event->type == EVENT_EXIT
509				 || event->type == EVENT_EXIT_SIGNAL);
510}
511
512static int
513event_exit_or_none_p(Event * event)
514{
515	return event == NULL || event_exit_p(event)
516		|| 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)
544			if (pids->tasks[i].pid != 0
545			    && pids->tasks[i].sigstopped
546			    && !pids->tasks[i].delivered) {
547				all_clear = 0;
548				break;
549			}
550		return all_clear;
551	}
552
553	return 0;
554}
555
556static 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
568/* The protocol is: 0 for success, negative for failure, positive if
569 * default singlestep is to be used.  */
570int arch_atomic_singlestep(struct Process *proc, struct breakpoint *sbp,
571			   int (*add_cb)(void *addr, void *data),
572			   void *add_cb_data);
573
574#ifndef ARCH_HAVE_ATOMIC_SINGLESTEP
575int
576arch_atomic_singlestep(struct Process *proc, struct breakpoint *sbp,
577		       int (*add_cb)(void *addr, void *data),
578		       void *add_cb_data)
579{
580	return 1;
581}
582#endif
583
584static Event *process_stopping_on_event(struct event_handler *super,
585					Event *event);
586
587static void
588remove_atomic_breakpoints(struct Process *proc)
589{
590	struct process_stopping_handler *self
591		= (void *)proc->leader->event_handler;
592	assert(self != NULL);
593	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) {
600			delete_breakpoint(proc, self->atomic_skip_bp_addrs[i]);
601			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
611static 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
617	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
627				= insert_breakpoint(proc, addr, NULL);
628			breakpoint_set_callbacks(bp, &cbs);
629			return 0;
630		}
631
632	assert(!"Too many atomic singlestep breakpoints!");
633	abort();
634}
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.  */
650	debug(1, "PTRACE_SINGLESTEP");
651	if (ptrace(PTRACE_SINGLESTEP, proc->pid, 0, 0)) {
652		perror("PTRACE_SINGLESTEP");
653		return -1;
654	}
655	return 0;
656}
657
658static void
659post_singlestep(struct process_stopping_handler *self,
660		struct Event **eventp)
661{
662	continue_for_sigstop_delivery(&self->pids);
663
664	if (*eventp != NULL && (*eventp)->type == EVENT_BREAKPOINT)
665		*eventp = NULL; // handled
666
667	struct Process *proc = self->task_enabling_breakpoint;
668
669	remove_atomic_breakpoints(proc);
670	self->breakpoint_being_enabled = NULL;
671}
672
673static void
674singlestep_error(struct process_stopping_handler *self)
675{
676	struct Process *teb = self->task_enabling_breakpoint;
677	struct breakpoint *sbp = self->breakpoint_being_enabled;
678	fprintf(stderr, "%d couldn't continue when handling %s (%p) at %p\n",
679		teb->pid, breakpoint_name(sbp),	sbp->addr,
680		get_instruction_pointer(teb));
681	delete_breakpoint(teb->leader, sbp->addr);
682}
683
684static void
685pt_continue(struct process_stopping_handler *self)
686{
687	struct Process *teb = self->task_enabling_breakpoint;
688	debug(1, "PTRACE_CONT");
689	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);
697}
698
699static void
700disable_and(struct process_stopping_handler *self,
701	    void (*do_this)(struct process_stopping_handler *self))
702{
703	struct Process *teb = self->task_enabling_breakpoint;
704	debug(DEBUG_PROCESS, "all stopped, now singlestep/cont %d", teb->pid);
705	if (self->breakpoint_being_enabled->enabled)
706		disable_breakpoint(teb, self->breakpoint_being_enabled);
707	(do_this)(self);
708	self->state = psh_singlestep;
709}
710
711void
712linux_ptrace_disable_and_singlestep(struct process_stopping_handler *self)
713{
714	disable_and(self, &pt_singlestep);
715}
716
717void
718linux_ptrace_disable_and_continue(struct process_stopping_handler *self)
719{
720	disable_and(self, &pt_continue);
721}
722
723/* 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 *
730process_stopping_on_event(struct event_handler *super, Event *event)
731{
732	struct process_stopping_handler * self = (void *)super;
733	Process * task = event->proc;
734	Process * leader = task->leader;
735	Process * teb = self->task_enabling_breakpoint;
736
737	debug(DEBUG_PROCESS,
738	      "process_stopping_on_event: pid %d; event type %d; state %d",
739	      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
749	/* Deactivate the entry if the task exits.  */
750	if (event_exit_p(event) && task_info != NULL)
751		task_info->pid = 0;
752
753	/* 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
764	switch (state) {
765	case psh_stopping:
766		/* If everyone is stopped, singlestep.  */
767		if (each_task(leader, NULL, &task_blocked,
768			      &self->pids) == NULL) {
769			(self->on_all_stopped)(self);
770			state = self->state;
771		}
772		break;
773
774	case psh_singlestep:
775		/* In singlestep state, breakpoint signifies that we
776		 * have now stepped, and can re-enable the breakpoint.  */
777		if (event != NULL && task == teb) {
778
779			/* 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				arch_addr_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
793			/* If we got SIGNAL instead of BREAKPOINT,
794			 * then this is not singlestep at all.  */
795			if (event->type == EVENT_SIGNAL) {
796			do_singlestep:
797				if (singlestep(self) < 0) {
798					singlestep_error(self);
799					post_singlestep(self, &event);
800					goto psh_sinking;
801				}
802				break;
803			} 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:
810					/* Sink singlestep event.  */
811					if (event->type == EVENT_BREAKPOINT)
812						event = NULL;
813					goto do_singlestep;
814				}
815			}
816
817			/* Re-enable the breakpoint that we are
818			 * stepping over.  */
819			struct breakpoint *sbp = self->breakpoint_being_enabled;
820			if (sbp->enabled)
821				enable_breakpoint(teb, sbp);
822
823			post_singlestep(self, &event);
824			goto psh_sinking;
825		}
826		break;
827
828	psh_sinking:
829		state = self->state = psh_sinking;
830	case psh_sinking:
831		if (await_sigstop_delivery(&self->pids, task_info, event))
832			process_stopping_done(self, leader);
833		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		}
849	}
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
860process_stopping_destroy(struct event_handler *super)
861{
862	struct process_stopping_handler * self = (void *)super;
863	free(self->pids.tasks);
864}
865
866static enum callback_status
867no(struct process_stopping_handler *self)
868{
869	return CBS_STOP;
870}
871
872int
873process_install_stopping_handler(struct Process *proc, struct breakpoint *sbp,
874				 void (*as)(struct process_stopping_handler *),
875				 enum callback_status (*ks)
876					 (struct process_stopping_handler *),
877				 enum callback_status (*uw)
878					(struct process_stopping_handler *))
879{
880	debug(DEBUG_FUNCTION,
881	      "process_install_stopping_handler: pid=%d", proc->pid);
882
883	struct process_stopping_handler *handler = calloc(sizeof(*handler), 1);
884	if (handler == NULL)
885		return -1;
886
887	if (as == NULL)
888		as = &linux_ptrace_disable_and_singlestep;
889	if (ks == NULL)
890		ks = &no;
891	if (uw == NULL)
892		uw = &no;
893
894	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;
898	handler->on_all_stopped = as;
899	handler->keep_stepping_p = ks;
900	handler->ugly_workaround_p = uw;
901
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
921void
922continue_after_breakpoint(Process *proc, struct breakpoint *sbp)
923{
924	debug(DEBUG_PROCESS,
925	      "continue_after_breakpoint: pid=%d, addr=%p",
926	      proc->pid, sbp->addr);
927
928	set_instruction_pointer(proc, sbp->addr);
929
930	if (sbp->enabled == 0) {
931		continue_process(proc->pid);
932	} else {
933#if defined __sparc__  || defined __ia64___ || defined __mips__
934		/* we don't want to singlestep here */
935		continue_process(proc->pid);
936#else
937		if (process_install_stopping_handler
938		    (proc, sbp, NULL, NULL, NULL) < 0) {
939			perror("process_stopping_handler_create");
940			/* Carry on not bothering to re-enable.  */
941			continue_process(proc->pid);
942		}
943#endif
944	}
945}
946
947/**
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{
957	struct event_handler super;
958	struct pid_set pids;
959};
960
961static Event *
962ltrace_exiting_on_event(struct event_handler *super, Event *event)
963{
964	struct ltrace_exiting_handler * self = (void *)super;
965	Process * task = event->proc;
966	Process * leader = task->leader;
967
968	debug(DEBUG_PROCESS,
969	      "ltrace_exiting_on_event: pid %d; event type %d",
970	      task->pid, event->type);
971
972	struct pid_task * task_info = get_task_info(&self->pids, task->pid);
973	handle_stopping_event(task_info, &event);
974
975	if (event != NULL && event->type == EVENT_BREAKPOINT)
976		undo_breakpoint(event, leader);
977
978	if (await_sigstop_delivery(&self->pids, task_info, event)
979	    && all_stops_accountable(&self->pids))
980		detach_process(leader);
981
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;
986
987	return NULL;
988}
989
990static void
991ltrace_exiting_destroy(struct event_handler *super)
992{
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
1010	/* 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
1021	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
1030	handler->super.on_event = ltrace_exiting_on_event;
1031	handler->super.destroy = ltrace_exiting_destroy;
1032	install_event_handler(proc->leader, &handler->super);
1033
1034	if (each_task(proc->leader, NULL, &send_sigstop,
1035		      &handler->pids) != NULL)
1036		goto fatal;
1037
1038	return 0;
1039}
1040
1041/*
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.
1058 */
1059
1060struct process_vfork_handler
1061{
1062	struct event_handler super;
1063	void * bp_addr;
1064};
1065
1066static Event *
1067process_vfork_on_event(struct event_handler *super, Event *event)
1068{
1069	debug(DEBUG_PROCESS,
1070	      "process_vfork_on_event: pid %d; event type %d",
1071	      event->proc->pid, event->type);
1072
1073	struct process_vfork_handler * self = (void *)super;
1074	struct breakpoint *sbp;
1075	assert(self != NULL);
1076
1077	switch (event->type) {
1078	case EVENT_BREAKPOINT:
1079		/* Remember the vfork return breakpoint.  */
1080		if (self->bp_addr == 0)
1081			self->bp_addr = event->e_un.brk_addr;
1082		break;
1083
1084	case EVENT_EXIT:
1085	case EVENT_EXIT_SIGNAL:
1086	case EVENT_EXEC:
1087		/* Smuggle back in the vfork return breakpoint, so
1088		 * that our parent can trip over it once again.  */
1089		if (self->bp_addr != 0) {
1090			sbp = dict_find_entry(event->proc->leader->breakpoints,
1091					      self->bp_addr);
1092			if (sbp != NULL)
1093				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);
1098		}
1099
1100		continue_process(event->proc->parent->pid);
1101
1102		/* Remove the leader that we artificially set up
1103		 * earlier.  */
1104		change_process_leader(event->proc, event->proc);
1105		destroy_event_handler(event->proc);
1106
1107	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);
1118	struct process_vfork_handler * handler = calloc(sizeof(*handler), 1);
1119	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.  */
1129	handler->super.on_event = process_vfork_on_event;
1130	install_event_handler(proc, &handler->super);
1131
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);
1141}
1142
1143static 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
1151void
1152continue_after_syscall(Process * proc, int sysnum, int ret_p)
1153{
1154	/* Don't continue if we are mid-stopping.  */
1155	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);
1159		return;
1160	}
1161	continue_process(proc->pid);
1162}
1163
1164/* 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
1176os_ltrace_exiting(void)
1177{
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
1190int
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
1201size_t
1202umovebytes(Process *proc, void *addr, void *laddr, size_t len) {
1203
1204	union {
1205		long a;
1206		char c[sizeof(long)];
1207	} a;
1208	int started = 0;
1209	size_t offset = 0, bytes_read = 0;
1210
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