2 * This file is part of ltrace.
3 * Copyright (C) 2012 Petr Machata, Red Hat Inc.
4 * Copyright (C) 2009 Juan Cespedes
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.
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.
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
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
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.
36 * Service breakpoints like the handling of dlopen would be a
37 * low-level breakpoint, likely without tracepoint attached.
39 * So that's for sometimes.
49 void (*on_hit)(struct breakpoint *bp, struct Process *proc);
50 void (*on_continue)(struct breakpoint *bp, struct Process *proc);
51 void (*on_retract)(struct breakpoint *bp, struct Process *proc);
55 struct bp_callbacks *cbs;
56 struct library_symbol *libsym;
58 unsigned char orig_value[BREAKPOINT_LENGTH];
60 struct arch_breakpoint_data arch;
63 /* Call on-hit handler of BP, if any is set. */
64 void breakpoint_on_hit(struct breakpoint *bp, struct Process *proc);
66 /* Call on-continue handler of BP. If none is set, call
67 * continue_after_breakpoint. */
68 void breakpoint_on_continue(struct breakpoint *bp, struct Process *proc);
70 /* Call on-retract handler of BP, if any is set. This should be
71 * called before the breakpoints are destroyed. The reason for a
72 * separate interface is that breakpoint_destroy has to be callable
73 * without PROC. ON_DISABLE might be useful as well, but that would
74 * be called every time we disable the breakpoint, which is too often
75 * (a breakpoint has to be disabled every time that we need to execute
76 * the instruction underneath it). */
77 void breakpoint_on_retract(struct breakpoint *bp, struct Process *proc);
79 /* Initialize a breakpoint structure. That doesn't actually realize
80 * the breakpoint. The breakpoint is initially assumed to be
81 * disabled. orig_value has to be set separately. CBS may be
83 int breakpoint_init(struct breakpoint *bp, struct Process *proc,
84 arch_addr_t addr, struct library_symbol *libsym);
86 /* Make a clone of breakpoint BP into the area of memory pointed to by
87 * RETP. The original breakpoint was assigned to process OLD_PROC,
88 * the cloned breakpoint will be attached to process NEW_PROC.
89 * Returns 0 on success or a negative value on failure. */
90 int breakpoint_clone(struct breakpoint *retp, struct Process *new_proc,
91 struct breakpoint *bp, struct Process *old_proc);
93 /* Set callbacks. If CBS is non-NULL, then BP->cbs shall be NULL. */
94 void breakpoint_set_callbacks(struct breakpoint *bp, struct bp_callbacks *cbs);
96 /* Destroy a breakpoint structure. */
97 void breakpoint_destroy(struct breakpoint *bp);
99 /* Call enable_breakpoint the first time it's called. Returns 0 on
100 * success and a negative value on failure. */
101 int breakpoint_turn_on(struct breakpoint *bp, struct Process *proc);
103 /* Call disable_breakpoint when turned off the same number of times
104 * that it was turned on. Returns 0 on success and a negative value
106 int breakpoint_turn_off(struct breakpoint *bp, struct Process *proc);
108 /* Utility function that does what typically needs to be done when a
109 * breakpoint is to be inserted. It checks whether there is another
110 * breakpoint in PROC->LEADER for given ADDR. If not, it allocates
111 * memory for a new breakpoint on the heap, initializes it, and calls
112 * PROC_ADD_BREAKPOINT to add the newly-created breakpoint. For newly
113 * added as well as preexisting breakpoints, it then calls
114 * BREAKPOINT_TURN_ON. If anything fails, it cleans up and returns
115 * NULL. Otherwise it returns the breakpoint for ADDR. */
116 struct breakpoint *insert_breakpoint(struct Process *proc, void *addr,
117 struct library_symbol *libsym);
119 /* Name of a symbol associated with BP. May be NULL. */
120 const char *breakpoint_name(const struct breakpoint *bp);
122 /* A library that this breakpoint comes from. May be NULL. */
123 struct library *breakpoint_library(const struct breakpoint *bp);
125 /* Again, this seems to be several interfaces rolled into one:
126 * - breakpoint_disable
127 * - proc_remove_breakpoint
128 * - breakpoint_destroy
130 void delete_breakpoint(struct Process *proc, void *addr);
132 /* XXX some of the following belongs to proc.h/proc.c. */
133 struct breakpoint *address2bpstruct(struct Process *proc, void *addr);
134 void enable_all_breakpoints(struct Process *proc);
135 void disable_all_breakpoints(struct Process *proc);
136 int breakpoints_init(struct Process *proc);
138 #endif /* BREAKPOINT_H */