breakpoint.h revision fa0c5704352beb3f81efe8970dbd5af45a4b00ce 
1/*
2 * This file is part of ltrace.
3 * Copyright (C) 2012 Petr Machata, Red Hat Inc.
4 * Copyright (C) 2009 Juan Cespedes
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 2 of the
9 * License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
19 * 02110-1301 USA
20 */
21
22#ifndef BREAKPOINT_H
23#define BREAKPOINT_H
24
25/* XXX This is currently a very weak abstraction.  We would like to
26 * much expand this to allow things like breakpoints on SDT probes and
27 * such.
28 *
29 * In particular, we would like to add a tracepoint abstraction.
30 * Tracepoint is a traceable feature--e.g. an exact address, a DWARF
31 * symbol, an ELF symbol, a PLT entry, or an SDT probe.  Tracepoints
32 * are named and the user can configure which of them he wants to
33 * enable.  Realized tracepoints enable breakpoints, which are a
34 * low-level realization of high-level tracepoint.
35 *
36 * Tracepoints are provided by the main binary as well as by any
37 * opened libraries: every time an ELF file is mapped into the address
38 * space, a new set of tracepoints is extracted, and filtered
39 * according to user settings.  Those tracepoints that are left are
40 * then realized, and the tracing starts.
41 *
42 * A scheme like this would take care of gradually introducing
43 * breakpoints when the library is mapped, and therefore ready, and
44 * would avoid certain hacks.  For example on PPC64, we don't actually
45 * add breakpoints to PLT.  Instead, we read the PLT (which contains
46 * addresses, not code), to figure out where to put the breakpoints.
47 * In prelinked code, that address is non-zero, and points to an
48 * address that's not yet mapped.  ptrace then fails when we try to
49 * add the breakpoint.
50 *
51 * Ideally, return breakpoints would be just a special kind of
52 * tracepoint that has attached some magic.  Or a feature of a
53 * tracepoint.  Service breakpoints like the handling of dlopen would
54 * be a low-level breakpoint, likely without tracepoint attached.
55 *
56 * So that's for sometimes.
57 */
58
59#include "sysdep.h"
60#include "library.h"
61
62struct Process;
63struct breakpoint;
64
65struct bp_callbacks {
66	void (*on_hit) (struct breakpoint *bp, struct Process *proc);
67	void (*on_continue) (struct breakpoint *bp, struct Process *proc);
68	void (*on_destroy) (struct breakpoint *bp);
69};
70
71struct breakpoint {
72	struct bp_callbacks *cbs;
73	struct library_symbol *libsym;
74	void *addr;
75	unsigned char orig_value[BREAKPOINT_LENGTH];
76	int enabled;
77	struct arch_breakpoint_data arch;
78};
79
80/* Call on-hit handler of BP, if any is set.  */
81void breakpoint_on_hit(struct breakpoint *bp, struct Process *proc);
82
83/* Call on-reenable handler of BP.  If none is set, call
84 * continue_after_breakpoint.  */
85void breakpoint_on_continue(struct breakpoint *bp, struct Process *proc);
86
87/* Initialize a breakpoint structure.  That doesn't actually realize
88 * the breakpoint.  The breakpoint is initially assumed to be
89 * disabled.  orig_value has to be set separately.  CBS may be
90 * NULL.  */
91int breakpoint_init(struct breakpoint *bp, struct Process *proc,
92		    target_address_t addr, struct library_symbol *libsym);
93
94/* Set callbacks.  If CBS is non-NULL, then BP->cbs shall be NULL.  */
95void breakpoint_set_callbacks(struct breakpoint *bp, struct bp_callbacks *cbs);
96
97/* XXX this is currently not called anywhere.   */
98void breakpoint_destroy(struct breakpoint *bp);
99
100/* Call enable_breakpoint the first time it's called.  Returns 0 on
101 * success and a negative value on failure.  */
102int breakpoint_turn_on(struct breakpoint *bp, struct Process *proc);
103
104/* Call disable_breakpoint when turned off the same number of times
105 * that it was turned on.  Returns 0 on success and a negative value
106 * on failure.  */
107int breakpoint_turn_off(struct breakpoint *bp, struct Process *proc);
108
109/* This is actually several functions rolled in one:
110 *  - malloc
111 *  - breakpoint_init
112 *  - proc_add_breakpoint
113 *  - breakpoint_enable
114 * XXX I think it should be broken up somehow.  */
115struct breakpoint *insert_breakpoint(struct Process *proc, void *addr,
116				     struct library_symbol *libsym);
117
118/* Name of a symbol associated with BP.  May be NULL.  */
119const char *breakpoint_name(const struct breakpoint *bp);
120
121/* A library that this breakpoint comes from.  May be NULL.  */
122struct library *breakpoint_library(const struct breakpoint *bp);
123
124/* Again, this seems to be several interfaces rolled into one:
125 *  - breakpoint_disable
126 *  - proc_remove_breakpoint
127 *  - breakpoint_destroy
128 * XXX */
129void delete_breakpoint(struct Process *proc, void *addr);
130
131/* XXX some of the following belongs to proc.h/proc.c.  */
132struct breakpoint *address2bpstruct(struct Process *proc, void *addr);
133void enable_all_breakpoints(struct Process *proc);
134void disable_all_breakpoints(struct Process *proc);
135int breakpoints_init(struct Process *proc, int enable);
136
137#endif /* BREAKPOINT_H */
138