1 /* Branch trace support for GDB, the GNU debugger.
3 Copyright (C) 2013-2018 Free Software Foundation, Inc.
5 Contributed by Intel Corp. <markus.t.metzger@intel.com>
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "gdbthread.h"
31 #include "filenames.h"
32 #include "xml-support.h"
36 #include "cli/cli-utils.h"
38 /* For maintenance commands. */
39 #include "record-btrace.h"
45 /* Command lists for btrace maintenance commands. */
46 static struct cmd_list_element *maint_btrace_cmdlist;
47 static struct cmd_list_element *maint_btrace_set_cmdlist;
48 static struct cmd_list_element *maint_btrace_show_cmdlist;
49 static struct cmd_list_element *maint_btrace_pt_set_cmdlist;
50 static struct cmd_list_element *maint_btrace_pt_show_cmdlist;
52 /* Control whether to skip PAD packets when computing the packet history. */
53 static int maint_btrace_pt_skip_pad = 1;
55 static void btrace_add_pc (struct thread_info *tp);
57 /* Print a record debug message. Use do ... while (0) to avoid ambiguities
58 when used in if statements. */
60 #define DEBUG(msg, args...) \
63 if (record_debug != 0) \
64 fprintf_unfiltered (gdb_stdlog, \
65 "[btrace] " msg "\n", ##args); \
69 #define DEBUG_FTRACE(msg, args...) DEBUG ("[ftrace] " msg, ##args)
71 /* Return the function name of a recorded function segment for printing.
72 This function never returns NULL. */
75 ftrace_print_function_name (const struct btrace_function *bfun)
77 struct minimal_symbol *msym;
84 return SYMBOL_PRINT_NAME (sym);
87 return MSYMBOL_PRINT_NAME (msym);
92 /* Return the file name of a recorded function segment for printing.
93 This function never returns NULL. */
96 ftrace_print_filename (const struct btrace_function *bfun)
104 filename = symtab_to_filename_for_display (symbol_symtab (sym));
106 filename = "<unknown>";
111 /* Return a string representation of the address of an instruction.
112 This function never returns NULL. */
115 ftrace_print_insn_addr (const struct btrace_insn *insn)
120 return core_addr_to_string_nz (insn->pc);
123 /* Print an ftrace debug status message. */
126 ftrace_debug (const struct btrace_function *bfun, const char *prefix)
128 const char *fun, *file;
129 unsigned int ibegin, iend;
132 fun = ftrace_print_function_name (bfun);
133 file = ftrace_print_filename (bfun);
136 ibegin = bfun->insn_offset;
137 iend = ibegin + bfun->insn.size ();
139 DEBUG_FTRACE ("%s: fun = %s, file = %s, level = %d, insn = [%u; %u)",
140 prefix, fun, file, level, ibegin, iend);
143 /* Return the number of instructions in a given function call segment. */
146 ftrace_call_num_insn (const struct btrace_function* bfun)
151 /* A gap is always counted as one instruction. */
152 if (bfun->errcode != 0)
155 return bfun->insn.size ();
158 /* Return the function segment with the given NUMBER or NULL if no such segment
159 exists. BTINFO is the branch trace information for the current thread. */
161 static struct btrace_function *
162 ftrace_find_call_by_number (struct btrace_thread_info *btinfo,
165 if (number == 0 || number > btinfo->functions.size ())
168 return &btinfo->functions[number - 1];
171 /* A const version of the function above. */
173 static const struct btrace_function *
174 ftrace_find_call_by_number (const struct btrace_thread_info *btinfo,
177 if (number == 0 || number > btinfo->functions.size ())
180 return &btinfo->functions[number - 1];
183 /* Return non-zero if BFUN does not match MFUN and FUN,
184 return zero otherwise. */
187 ftrace_function_switched (const struct btrace_function *bfun,
188 const struct minimal_symbol *mfun,
189 const struct symbol *fun)
191 struct minimal_symbol *msym;
197 /* If the minimal symbol changed, we certainly switched functions. */
198 if (mfun != NULL && msym != NULL
199 && strcmp (MSYMBOL_LINKAGE_NAME (mfun), MSYMBOL_LINKAGE_NAME (msym)) != 0)
202 /* If the symbol changed, we certainly switched functions. */
203 if (fun != NULL && sym != NULL)
205 const char *bfname, *fname;
207 /* Check the function name. */
208 if (strcmp (SYMBOL_LINKAGE_NAME (fun), SYMBOL_LINKAGE_NAME (sym)) != 0)
211 /* Check the location of those functions, as well. */
212 bfname = symtab_to_fullname (symbol_symtab (sym));
213 fname = symtab_to_fullname (symbol_symtab (fun));
214 if (filename_cmp (fname, bfname) != 0)
218 /* If we lost symbol information, we switched functions. */
219 if (!(msym == NULL && sym == NULL) && mfun == NULL && fun == NULL)
222 /* If we gained symbol information, we switched functions. */
223 if (msym == NULL && sym == NULL && !(mfun == NULL && fun == NULL))
229 /* Allocate and initialize a new branch trace function segment at the end of
231 BTINFO is the branch trace information for the current thread.
232 MFUN and FUN are the symbol information we have for this function.
233 This invalidates all struct btrace_function pointer currently held. */
235 static struct btrace_function *
236 ftrace_new_function (struct btrace_thread_info *btinfo,
237 struct minimal_symbol *mfun,
241 unsigned int number, insn_offset;
243 if (btinfo->functions.empty ())
245 /* Start counting NUMBER and INSN_OFFSET at one. */
252 const struct btrace_function *prev = &btinfo->functions.back ();
254 number = prev->number + 1;
255 insn_offset = prev->insn_offset + ftrace_call_num_insn (prev);
258 btinfo->functions.emplace_back (mfun, fun, number, insn_offset, level);
259 return &btinfo->functions.back ();
262 /* Update the UP field of a function segment. */
265 ftrace_update_caller (struct btrace_function *bfun,
266 struct btrace_function *caller,
267 enum btrace_function_flag flags)
270 ftrace_debug (bfun, "updating caller");
272 bfun->up = caller->number;
275 ftrace_debug (bfun, "set caller");
276 ftrace_debug (caller, "..to");
279 /* Fix up the caller for all segments of a function. */
282 ftrace_fixup_caller (struct btrace_thread_info *btinfo,
283 struct btrace_function *bfun,
284 struct btrace_function *caller,
285 enum btrace_function_flag flags)
287 unsigned int prev, next;
291 ftrace_update_caller (bfun, caller, flags);
293 /* Update all function segments belonging to the same function. */
294 for (; prev != 0; prev = bfun->prev)
296 bfun = ftrace_find_call_by_number (btinfo, prev);
297 ftrace_update_caller (bfun, caller, flags);
300 for (; next != 0; next = bfun->next)
302 bfun = ftrace_find_call_by_number (btinfo, next);
303 ftrace_update_caller (bfun, caller, flags);
307 /* Add a new function segment for a call at the end of the trace.
308 BTINFO is the branch trace information for the current thread.
309 MFUN and FUN are the symbol information we have for this function. */
311 static struct btrace_function *
312 ftrace_new_call (struct btrace_thread_info *btinfo,
313 struct minimal_symbol *mfun,
316 const unsigned int length = btinfo->functions.size ();
317 struct btrace_function *bfun = ftrace_new_function (btinfo, mfun, fun);
322 ftrace_debug (bfun, "new call");
327 /* Add a new function segment for a tail call at the end of the trace.
328 BTINFO is the branch trace information for the current thread.
329 MFUN and FUN are the symbol information we have for this function. */
331 static struct btrace_function *
332 ftrace_new_tailcall (struct btrace_thread_info *btinfo,
333 struct minimal_symbol *mfun,
336 const unsigned int length = btinfo->functions.size ();
337 struct btrace_function *bfun = ftrace_new_function (btinfo, mfun, fun);
341 bfun->flags |= BFUN_UP_LINKS_TO_TAILCALL;
343 ftrace_debug (bfun, "new tail call");
348 /* Return the caller of BFUN or NULL if there is none. This function skips
349 tail calls in the call chain. BTINFO is the branch trace information for
350 the current thread. */
351 static struct btrace_function *
352 ftrace_get_caller (struct btrace_thread_info *btinfo,
353 struct btrace_function *bfun)
355 for (; bfun != NULL; bfun = ftrace_find_call_by_number (btinfo, bfun->up))
356 if ((bfun->flags & BFUN_UP_LINKS_TO_TAILCALL) == 0)
357 return ftrace_find_call_by_number (btinfo, bfun->up);
362 /* Find the innermost caller in the back trace of BFUN with MFUN/FUN
363 symbol information. BTINFO is the branch trace information for the current
366 static struct btrace_function *
367 ftrace_find_caller (struct btrace_thread_info *btinfo,
368 struct btrace_function *bfun,
369 struct minimal_symbol *mfun,
372 for (; bfun != NULL; bfun = ftrace_find_call_by_number (btinfo, bfun->up))
374 /* Skip functions with incompatible symbol information. */
375 if (ftrace_function_switched (bfun, mfun, fun))
378 /* This is the function segment we're looking for. */
385 /* Find the innermost caller in the back trace of BFUN, skipping all
386 function segments that do not end with a call instruction (e.g.
387 tail calls ending with a jump). BTINFO is the branch trace information for
388 the current thread. */
390 static struct btrace_function *
391 ftrace_find_call (struct btrace_thread_info *btinfo,
392 struct btrace_function *bfun)
394 for (; bfun != NULL; bfun = ftrace_find_call_by_number (btinfo, bfun->up))
397 if (bfun->errcode != 0)
400 btrace_insn &last = bfun->insn.back ();
402 if (last.iclass == BTRACE_INSN_CALL)
409 /* Add a continuation segment for a function into which we return at the end of
411 BTINFO is the branch trace information for the current thread.
412 MFUN and FUN are the symbol information we have for this function. */
414 static struct btrace_function *
415 ftrace_new_return (struct btrace_thread_info *btinfo,
416 struct minimal_symbol *mfun,
419 struct btrace_function *prev, *bfun, *caller;
421 bfun = ftrace_new_function (btinfo, mfun, fun);
422 prev = ftrace_find_call_by_number (btinfo, bfun->number - 1);
424 /* It is important to start at PREV's caller. Otherwise, we might find
425 PREV itself, if PREV is a recursive function. */
426 caller = ftrace_find_call_by_number (btinfo, prev->up);
427 caller = ftrace_find_caller (btinfo, caller, mfun, fun);
430 /* The caller of PREV is the preceding btrace function segment in this
431 function instance. */
432 gdb_assert (caller->next == 0);
434 caller->next = bfun->number;
435 bfun->prev = caller->number;
437 /* Maintain the function level. */
438 bfun->level = caller->level;
440 /* Maintain the call stack. */
441 bfun->up = caller->up;
442 bfun->flags = caller->flags;
444 ftrace_debug (bfun, "new return");
448 /* We did not find a caller. This could mean that something went
449 wrong or that the call is simply not included in the trace. */
451 /* Let's search for some actual call. */
452 caller = ftrace_find_call_by_number (btinfo, prev->up);
453 caller = ftrace_find_call (btinfo, caller);
456 /* There is no call in PREV's back trace. We assume that the
457 branch trace did not include it. */
459 /* Let's find the topmost function and add a new caller for it.
460 This should handle a series of initial tail calls. */
461 while (prev->up != 0)
462 prev = ftrace_find_call_by_number (btinfo, prev->up);
464 bfun->level = prev->level - 1;
466 /* Fix up the call stack for PREV. */
467 ftrace_fixup_caller (btinfo, prev, bfun, BFUN_UP_LINKS_TO_RET);
469 ftrace_debug (bfun, "new return - no caller");
473 /* There is a call in PREV's back trace to which we should have
474 returned but didn't. Let's start a new, separate back trace
475 from PREV's level. */
476 bfun->level = prev->level - 1;
478 /* We fix up the back trace for PREV but leave other function segments
479 on the same level as they are.
480 This should handle things like schedule () correctly where we're
481 switching contexts. */
482 prev->up = bfun->number;
483 prev->flags = BFUN_UP_LINKS_TO_RET;
485 ftrace_debug (bfun, "new return - unknown caller");
492 /* Add a new function segment for a function switch at the end of the trace.
493 BTINFO is the branch trace information for the current thread.
494 MFUN and FUN are the symbol information we have for this function. */
496 static struct btrace_function *
497 ftrace_new_switch (struct btrace_thread_info *btinfo,
498 struct minimal_symbol *mfun,
501 struct btrace_function *prev, *bfun;
503 /* This is an unexplained function switch. We can't really be sure about the
504 call stack, yet the best I can think of right now is to preserve it. */
505 bfun = ftrace_new_function (btinfo, mfun, fun);
506 prev = ftrace_find_call_by_number (btinfo, bfun->number - 1);
508 bfun->flags = prev->flags;
510 ftrace_debug (bfun, "new switch");
515 /* Add a new function segment for a gap in the trace due to a decode error at
516 the end of the trace.
517 BTINFO is the branch trace information for the current thread.
518 ERRCODE is the format-specific error code. */
520 static struct btrace_function *
521 ftrace_new_gap (struct btrace_thread_info *btinfo, int errcode,
522 std::vector<unsigned int> &gaps)
524 struct btrace_function *bfun;
526 if (btinfo->functions.empty ())
527 bfun = ftrace_new_function (btinfo, NULL, NULL);
530 /* We hijack the previous function segment if it was empty. */
531 bfun = &btinfo->functions.back ();
532 if (bfun->errcode != 0 || !bfun->insn.empty ())
533 bfun = ftrace_new_function (btinfo, NULL, NULL);
536 bfun->errcode = errcode;
537 gaps.push_back (bfun->number);
539 ftrace_debug (bfun, "new gap");
544 /* Update the current function segment at the end of the trace in BTINFO with
545 respect to the instruction at PC. This may create new function segments.
546 Return the chronologically latest function segment, never NULL. */
548 static struct btrace_function *
549 ftrace_update_function (struct btrace_thread_info *btinfo, CORE_ADDR pc)
551 struct bound_minimal_symbol bmfun;
552 struct minimal_symbol *mfun;
554 struct btrace_function *bfun;
556 /* Try to determine the function we're in. We use both types of symbols
557 to avoid surprises when we sometimes get a full symbol and sometimes
558 only a minimal symbol. */
559 fun = find_pc_function (pc);
560 bmfun = lookup_minimal_symbol_by_pc (pc);
563 if (fun == NULL && mfun == NULL)
564 DEBUG_FTRACE ("no symbol at %s", core_addr_to_string_nz (pc));
566 /* If we didn't have a function, we create one. */
567 if (btinfo->functions.empty ())
568 return ftrace_new_function (btinfo, mfun, fun);
570 /* If we had a gap before, we create a function. */
571 bfun = &btinfo->functions.back ();
572 if (bfun->errcode != 0)
573 return ftrace_new_function (btinfo, mfun, fun);
575 /* Check the last instruction, if we have one.
576 We do this check first, since it allows us to fill in the call stack
577 links in addition to the normal flow links. */
578 btrace_insn *last = NULL;
579 if (!bfun->insn.empty ())
580 last = &bfun->insn.back ();
584 switch (last->iclass)
586 case BTRACE_INSN_RETURN:
590 /* On some systems, _dl_runtime_resolve returns to the resolved
591 function instead of jumping to it. From our perspective,
592 however, this is a tailcall.
593 If we treated it as return, we wouldn't be able to find the
594 resolved function in our stack back trace. Hence, we would
595 lose the current stack back trace and start anew with an empty
596 back trace. When the resolved function returns, we would then
597 create a stack back trace with the same function names but
598 different frame id's. This will confuse stepping. */
599 fname = ftrace_print_function_name (bfun);
600 if (strcmp (fname, "_dl_runtime_resolve") == 0)
601 return ftrace_new_tailcall (btinfo, mfun, fun);
603 return ftrace_new_return (btinfo, mfun, fun);
606 case BTRACE_INSN_CALL:
607 /* Ignore calls to the next instruction. They are used for PIC. */
608 if (last->pc + last->size == pc)
611 return ftrace_new_call (btinfo, mfun, fun);
613 case BTRACE_INSN_JUMP:
617 start = get_pc_function_start (pc);
619 /* A jump to the start of a function is (typically) a tail call. */
621 return ftrace_new_tailcall (btinfo, mfun, fun);
623 /* If we can't determine the function for PC, we treat a jump at
624 the end of the block as tail call if we're switching functions
625 and as an intra-function branch if we don't. */
626 if (start == 0 && ftrace_function_switched (bfun, mfun, fun))
627 return ftrace_new_tailcall (btinfo, mfun, fun);
634 /* Check if we're switching functions for some other reason. */
635 if (ftrace_function_switched (bfun, mfun, fun))
637 DEBUG_FTRACE ("switching from %s in %s at %s",
638 ftrace_print_insn_addr (last),
639 ftrace_print_function_name (bfun),
640 ftrace_print_filename (bfun));
642 return ftrace_new_switch (btinfo, mfun, fun);
648 /* Add the instruction at PC to BFUN's instructions. */
651 ftrace_update_insns (struct btrace_function *bfun, const btrace_insn &insn)
653 bfun->insn.push_back (insn);
655 if (record_debug > 1)
656 ftrace_debug (bfun, "update insn");
659 /* Classify the instruction at PC. */
661 static enum btrace_insn_class
662 ftrace_classify_insn (struct gdbarch *gdbarch, CORE_ADDR pc)
664 enum btrace_insn_class iclass;
666 iclass = BTRACE_INSN_OTHER;
669 if (gdbarch_insn_is_call (gdbarch, pc))
670 iclass = BTRACE_INSN_CALL;
671 else if (gdbarch_insn_is_ret (gdbarch, pc))
672 iclass = BTRACE_INSN_RETURN;
673 else if (gdbarch_insn_is_jump (gdbarch, pc))
674 iclass = BTRACE_INSN_JUMP;
676 CATCH (error, RETURN_MASK_ERROR)
684 /* Try to match the back trace at LHS to the back trace at RHS. Returns the
685 number of matching function segments or zero if the back traces do not
686 match. BTINFO is the branch trace information for the current thread. */
689 ftrace_match_backtrace (struct btrace_thread_info *btinfo,
690 struct btrace_function *lhs,
691 struct btrace_function *rhs)
695 for (matches = 0; lhs != NULL && rhs != NULL; ++matches)
697 if (ftrace_function_switched (lhs, rhs->msym, rhs->sym))
700 lhs = ftrace_get_caller (btinfo, lhs);
701 rhs = ftrace_get_caller (btinfo, rhs);
707 /* Add ADJUSTMENT to the level of BFUN and succeeding function segments.
708 BTINFO is the branch trace information for the current thread. */
711 ftrace_fixup_level (struct btrace_thread_info *btinfo,
712 struct btrace_function *bfun, int adjustment)
717 DEBUG_FTRACE ("fixup level (%+d)", adjustment);
718 ftrace_debug (bfun, "..bfun");
722 bfun->level += adjustment;
723 bfun = ftrace_find_call_by_number (btinfo, bfun->number + 1);
727 /* Recompute the global level offset. Traverse the function trace and compute
728 the global level offset as the negative of the minimal function level. */
731 ftrace_compute_global_level_offset (struct btrace_thread_info *btinfo)
738 if (btinfo->functions.empty ())
741 unsigned int length = btinfo->functions.size() - 1;
742 for (unsigned int i = 0; i < length; ++i)
743 level = std::min (level, btinfo->functions[i].level);
745 /* The last function segment contains the current instruction, which is not
746 really part of the trace. If it contains just this one instruction, we
747 ignore the segment. */
748 struct btrace_function *last = &btinfo->functions.back();
749 if (last->insn.size () != 1)
750 level = std::min (level, last->level);
752 DEBUG_FTRACE ("setting global level offset: %d", -level);
753 btinfo->level = -level;
756 /* Connect the function segments PREV and NEXT in a bottom-to-top walk as in
757 ftrace_connect_backtrace. BTINFO is the branch trace information for the
761 ftrace_connect_bfun (struct btrace_thread_info *btinfo,
762 struct btrace_function *prev,
763 struct btrace_function *next)
765 DEBUG_FTRACE ("connecting...");
766 ftrace_debug (prev, "..prev");
767 ftrace_debug (next, "..next");
769 /* The function segments are not yet connected. */
770 gdb_assert (prev->next == 0);
771 gdb_assert (next->prev == 0);
773 prev->next = next->number;
774 next->prev = prev->number;
776 /* We may have moved NEXT to a different function level. */
777 ftrace_fixup_level (btinfo, next, prev->level - next->level);
779 /* If we run out of back trace for one, let's use the other's. */
782 const btrace_function_flags flags = next->flags;
784 next = ftrace_find_call_by_number (btinfo, next->up);
787 DEBUG_FTRACE ("using next's callers");
788 ftrace_fixup_caller (btinfo, prev, next, flags);
791 else if (next->up == 0)
793 const btrace_function_flags flags = prev->flags;
795 prev = ftrace_find_call_by_number (btinfo, prev->up);
798 DEBUG_FTRACE ("using prev's callers");
799 ftrace_fixup_caller (btinfo, next, prev, flags);
804 /* PREV may have a tailcall caller, NEXT can't. If it does, fixup the up
805 link to add the tail callers to NEXT's back trace.
807 This removes NEXT->UP from NEXT's back trace. It will be added back
808 when connecting NEXT and PREV's callers - provided they exist.
810 If PREV's back trace consists of a series of tail calls without an
811 actual call, there will be no further connection and NEXT's caller will
812 be removed for good. To catch this case, we handle it here and connect
813 the top of PREV's back trace to NEXT's caller. */
814 if ((prev->flags & BFUN_UP_LINKS_TO_TAILCALL) != 0)
816 struct btrace_function *caller;
817 btrace_function_flags next_flags, prev_flags;
819 /* We checked NEXT->UP above so CALLER can't be NULL. */
820 caller = ftrace_find_call_by_number (btinfo, next->up);
821 next_flags = next->flags;
822 prev_flags = prev->flags;
824 DEBUG_FTRACE ("adding prev's tail calls to next");
826 prev = ftrace_find_call_by_number (btinfo, prev->up);
827 ftrace_fixup_caller (btinfo, next, prev, prev_flags);
829 for (; prev != NULL; prev = ftrace_find_call_by_number (btinfo,
832 /* At the end of PREV's back trace, continue with CALLER. */
835 DEBUG_FTRACE ("fixing up link for tailcall chain");
836 ftrace_debug (prev, "..top");
837 ftrace_debug (caller, "..up");
839 ftrace_fixup_caller (btinfo, prev, caller, next_flags);
841 /* If we skipped any tail calls, this may move CALLER to a
842 different function level.
844 Note that changing CALLER's level is only OK because we
845 know that this is the last iteration of the bottom-to-top
846 walk in ftrace_connect_backtrace.
848 Otherwise we will fix up CALLER's level when we connect it
849 to PREV's caller in the next iteration. */
850 ftrace_fixup_level (btinfo, caller,
851 prev->level - caller->level - 1);
855 /* There's nothing to do if we find a real call. */
856 if ((prev->flags & BFUN_UP_LINKS_TO_TAILCALL) == 0)
858 DEBUG_FTRACE ("will fix up link in next iteration");
866 /* Connect function segments on the same level in the back trace at LHS and RHS.
867 The back traces at LHS and RHS are expected to match according to
868 ftrace_match_backtrace. BTINFO is the branch trace information for the
872 ftrace_connect_backtrace (struct btrace_thread_info *btinfo,
873 struct btrace_function *lhs,
874 struct btrace_function *rhs)
876 while (lhs != NULL && rhs != NULL)
878 struct btrace_function *prev, *next;
880 gdb_assert (!ftrace_function_switched (lhs, rhs->msym, rhs->sym));
882 /* Connecting LHS and RHS may change the up link. */
886 lhs = ftrace_get_caller (btinfo, lhs);
887 rhs = ftrace_get_caller (btinfo, rhs);
889 ftrace_connect_bfun (btinfo, prev, next);
893 /* Bridge the gap between two function segments left and right of a gap if their
894 respective back traces match in at least MIN_MATCHES functions. BTINFO is
895 the branch trace information for the current thread.
897 Returns non-zero if the gap could be bridged, zero otherwise. */
900 ftrace_bridge_gap (struct btrace_thread_info *btinfo,
901 struct btrace_function *lhs, struct btrace_function *rhs,
904 struct btrace_function *best_l, *best_r, *cand_l, *cand_r;
907 DEBUG_FTRACE ("checking gap at insn %u (req matches: %d)",
908 rhs->insn_offset - 1, min_matches);
914 /* We search the back traces of LHS and RHS for valid connections and connect
915 the two functon segments that give the longest combined back trace. */
917 for (cand_l = lhs; cand_l != NULL;
918 cand_l = ftrace_get_caller (btinfo, cand_l))
919 for (cand_r = rhs; cand_r != NULL;
920 cand_r = ftrace_get_caller (btinfo, cand_r))
924 matches = ftrace_match_backtrace (btinfo, cand_l, cand_r);
925 if (best_matches < matches)
927 best_matches = matches;
933 /* We need at least MIN_MATCHES matches. */
934 gdb_assert (min_matches > 0);
935 if (best_matches < min_matches)
938 DEBUG_FTRACE ("..matches: %d", best_matches);
940 /* We will fix up the level of BEST_R and succeeding function segments such
941 that BEST_R's level matches BEST_L's when we connect BEST_L to BEST_R.
943 This will ignore the level of RHS and following if BEST_R != RHS. I.e. if
944 BEST_R is a successor of RHS in the back trace of RHS (phases 1 and 3).
946 To catch this, we already fix up the level here where we can start at RHS
947 instead of at BEST_R. We will ignore the level fixup when connecting
948 BEST_L to BEST_R as they will already be on the same level. */
949 ftrace_fixup_level (btinfo, rhs, best_l->level - best_r->level);
951 ftrace_connect_backtrace (btinfo, best_l, best_r);
956 /* Try to bridge gaps due to overflow or decode errors by connecting the
957 function segments that are separated by the gap. */
960 btrace_bridge_gaps (struct thread_info *tp, std::vector<unsigned int> &gaps)
962 struct btrace_thread_info *btinfo = &tp->btrace;
963 std::vector<unsigned int> remaining;
966 DEBUG ("bridge gaps");
968 /* We require a minimum amount of matches for bridging a gap. The number of
969 required matches will be lowered with each iteration.
971 The more matches the higher our confidence that the bridging is correct.
972 For big gaps or small traces, however, it may not be feasible to require a
973 high number of matches. */
974 for (min_matches = 5; min_matches > 0; --min_matches)
976 /* Let's try to bridge as many gaps as we can. In some cases, we need to
977 skip a gap and revisit it again after we closed later gaps. */
978 while (!gaps.empty ())
980 for (const unsigned int number : gaps)
982 struct btrace_function *gap, *lhs, *rhs;
985 gap = ftrace_find_call_by_number (btinfo, number);
987 /* We may have a sequence of gaps if we run from one error into
988 the next as we try to re-sync onto the trace stream. Ignore
989 all but the leftmost gap in such a sequence.
991 Also ignore gaps at the beginning of the trace. */
992 lhs = ftrace_find_call_by_number (btinfo, gap->number - 1);
993 if (lhs == NULL || lhs->errcode != 0)
996 /* Skip gaps to the right. */
997 rhs = ftrace_find_call_by_number (btinfo, gap->number + 1);
998 while (rhs != NULL && rhs->errcode != 0)
999 rhs = ftrace_find_call_by_number (btinfo, rhs->number + 1);
1001 /* Ignore gaps at the end of the trace. */
1005 bridged = ftrace_bridge_gap (btinfo, lhs, rhs, min_matches);
1007 /* Keep track of gaps we were not able to bridge and try again.
1008 If we just pushed them to the end of GAPS we would risk an
1009 infinite loop in case we simply cannot bridge a gap. */
1011 remaining.push_back (number);
1014 /* Let's see if we made any progress. */
1015 if (remaining.size () == gaps.size ())
1019 gaps.swap (remaining);
1022 /* We get here if either GAPS is empty or if GAPS equals REMAINING. */
1029 /* We may omit this in some cases. Not sure it is worth the extra
1030 complication, though. */
1031 ftrace_compute_global_level_offset (btinfo);
1034 /* Compute the function branch trace from BTS trace. */
1037 btrace_compute_ftrace_bts (struct thread_info *tp,
1038 const struct btrace_data_bts *btrace,
1039 std::vector<unsigned int> &gaps)
1041 struct btrace_thread_info *btinfo;
1042 struct gdbarch *gdbarch;
1046 gdbarch = target_gdbarch ();
1047 btinfo = &tp->btrace;
1048 blk = VEC_length (btrace_block_s, btrace->blocks);
1050 if (btinfo->functions.empty ())
1053 level = -btinfo->level;
1057 btrace_block_s *block;
1062 block = VEC_index (btrace_block_s, btrace->blocks, blk);
1067 struct btrace_function *bfun;
1068 struct btrace_insn insn;
1071 /* We should hit the end of the block. Warn if we went too far. */
1072 if (block->end < pc)
1074 /* Indicate the gap in the trace. */
1075 bfun = ftrace_new_gap (btinfo, BDE_BTS_OVERFLOW, gaps);
1077 warning (_("Recorded trace may be corrupted at instruction "
1078 "%u (pc = %s)."), bfun->insn_offset - 1,
1079 core_addr_to_string_nz (pc));
1084 bfun = ftrace_update_function (btinfo, pc);
1086 /* Maintain the function level offset.
1087 For all but the last block, we do it here. */
1089 level = std::min (level, bfun->level);
1094 size = gdb_insn_length (gdbarch, pc);
1096 CATCH (error, RETURN_MASK_ERROR)
1103 insn.iclass = ftrace_classify_insn (gdbarch, pc);
1106 ftrace_update_insns (bfun, insn);
1108 /* We're done once we pushed the instruction at the end. */
1109 if (block->end == pc)
1112 /* We can't continue if we fail to compute the size. */
1115 /* Indicate the gap in the trace. We just added INSN so we're
1116 not at the beginning. */
1117 bfun = ftrace_new_gap (btinfo, BDE_BTS_INSN_SIZE, gaps);
1119 warning (_("Recorded trace may be incomplete at instruction %u "
1120 "(pc = %s)."), bfun->insn_offset - 1,
1121 core_addr_to_string_nz (pc));
1128 /* Maintain the function level offset.
1129 For the last block, we do it here to not consider the last
1131 Since the last instruction corresponds to the current instruction
1132 and is not really part of the execution history, it shouldn't
1133 affect the level. */
1135 level = std::min (level, bfun->level);
1139 /* LEVEL is the minimal function level of all btrace function segments.
1140 Define the global level offset to -LEVEL so all function levels are
1141 normalized to start at zero. */
1142 btinfo->level = -level;
1145 #if defined (HAVE_LIBIPT)
1147 static enum btrace_insn_class
1148 pt_reclassify_insn (enum pt_insn_class iclass)
1153 return BTRACE_INSN_CALL;
1156 return BTRACE_INSN_RETURN;
1159 return BTRACE_INSN_JUMP;
1162 return BTRACE_INSN_OTHER;
1166 /* Return the btrace instruction flags for INSN. */
1168 static btrace_insn_flags
1169 pt_btrace_insn_flags (const struct pt_insn &insn)
1171 btrace_insn_flags flags = 0;
1173 if (insn.speculative)
1174 flags |= BTRACE_INSN_FLAG_SPECULATIVE;
1179 /* Return the btrace instruction for INSN. */
1182 pt_btrace_insn (const struct pt_insn &insn)
1184 return {(CORE_ADDR) insn.ip, (gdb_byte) insn.size,
1185 pt_reclassify_insn (insn.iclass),
1186 pt_btrace_insn_flags (insn)};
1189 /* Handle instruction decode events (libipt-v2). */
1192 handle_pt_insn_events (struct btrace_thread_info *btinfo,
1193 struct pt_insn_decoder *decoder,
1194 std::vector<unsigned int> &gaps, int status)
1196 #if defined (HAVE_PT_INSN_EVENT)
1197 while (status & pts_event_pending)
1199 struct btrace_function *bfun;
1200 struct pt_event event;
1203 status = pt_insn_event (decoder, &event, sizeof (event));
1213 if (event.variant.enabled.resumed == 0 && !btinfo->functions.empty ())
1215 bfun = ftrace_new_gap (btinfo, BDE_PT_DISABLED, gaps);
1217 pt_insn_get_offset (decoder, &offset);
1219 warning (_("Non-contiguous trace at instruction %u (offset = 0x%"
1220 PRIx64 ")."), bfun->insn_offset - 1, offset);
1226 bfun = ftrace_new_gap (btinfo, BDE_PT_OVERFLOW, gaps);
1228 pt_insn_get_offset (decoder, &offset);
1230 warning (_("Overflow at instruction %u (offset = 0x%" PRIx64 ")."),
1231 bfun->insn_offset - 1, offset);
1236 #endif /* defined (HAVE_PT_INSN_EVENT) */
1241 /* Handle events indicated by flags in INSN (libipt-v1). */
1244 handle_pt_insn_event_flags (struct btrace_thread_info *btinfo,
1245 struct pt_insn_decoder *decoder,
1246 const struct pt_insn &insn,
1247 std::vector<unsigned int> &gaps)
1249 #if defined (HAVE_STRUCT_PT_INSN_ENABLED)
1250 /* Tracing is disabled and re-enabled each time we enter the kernel. Most
1251 times, we continue from the same instruction we stopped before. This is
1252 indicated via the RESUMED instruction flag. The ENABLED instruction flag
1253 means that we continued from some other instruction. Indicate this as a
1254 trace gap except when tracing just started. */
1255 if (insn.enabled && !btinfo->functions.empty ())
1257 struct btrace_function *bfun;
1260 bfun = ftrace_new_gap (btinfo, BDE_PT_DISABLED, gaps);
1262 pt_insn_get_offset (decoder, &offset);
1264 warning (_("Non-contiguous trace at instruction %u (offset = 0x%" PRIx64
1265 ", pc = 0x%" PRIx64 ")."), bfun->insn_offset - 1, offset,
1268 #endif /* defined (HAVE_STRUCT_PT_INSN_ENABLED) */
1270 #if defined (HAVE_STRUCT_PT_INSN_RESYNCED)
1271 /* Indicate trace overflows. */
1274 struct btrace_function *bfun;
1277 bfun = ftrace_new_gap (btinfo, BDE_PT_OVERFLOW, gaps);
1279 pt_insn_get_offset (decoder, &offset);
1281 warning (_("Overflow at instruction %u (offset = 0x%" PRIx64 ", pc = 0x%"
1282 PRIx64 ")."), bfun->insn_offset - 1, offset, insn.ip);
1284 #endif /* defined (HAVE_STRUCT_PT_INSN_RESYNCED) */
1287 /* Add function branch trace to BTINFO using DECODER. */
1290 ftrace_add_pt (struct btrace_thread_info *btinfo,
1291 struct pt_insn_decoder *decoder,
1293 std::vector<unsigned int> &gaps)
1295 struct btrace_function *bfun;
1301 struct pt_insn insn;
1303 status = pt_insn_sync_forward (decoder);
1306 if (status != -pte_eos)
1307 warning (_("Failed to synchronize onto the Intel Processor "
1308 "Trace stream: %s."), pt_errstr (pt_errcode (status)));
1314 /* Handle events from the previous iteration or synchronization. */
1315 status = handle_pt_insn_events (btinfo, decoder, gaps, status);
1319 status = pt_insn_next (decoder, &insn, sizeof(insn));
1323 /* Handle events indicated by flags in INSN. */
1324 handle_pt_insn_event_flags (btinfo, decoder, insn, gaps);
1326 bfun = ftrace_update_function (btinfo, insn.ip);
1328 /* Maintain the function level offset. */
1329 *plevel = std::min (*plevel, bfun->level);
1331 ftrace_update_insns (bfun, pt_btrace_insn (insn));
1334 if (status == -pte_eos)
1337 /* Indicate the gap in the trace. */
1338 bfun = ftrace_new_gap (btinfo, status, gaps);
1340 pt_insn_get_offset (decoder, &offset);
1342 warning (_("Decode error (%d) at instruction %u (offset = 0x%" PRIx64
1343 ", pc = 0x%" PRIx64 "): %s."), status, bfun->insn_offset - 1,
1344 offset, insn.ip, pt_errstr (pt_errcode (status)));
1348 /* A callback function to allow the trace decoder to read the inferior's
1352 btrace_pt_readmem_callback (gdb_byte *buffer, size_t size,
1353 const struct pt_asid *asid, uint64_t pc,
1356 int result, errcode;
1358 result = (int) size;
1361 errcode = target_read_code ((CORE_ADDR) pc, buffer, size);
1363 result = -pte_nomap;
1365 CATCH (error, RETURN_MASK_ERROR)
1367 result = -pte_nomap;
1374 /* Translate the vendor from one enum to another. */
1376 static enum pt_cpu_vendor
1377 pt_translate_cpu_vendor (enum btrace_cpu_vendor vendor)
1389 /* Finalize the function branch trace after decode. */
1391 static void btrace_finalize_ftrace_pt (struct pt_insn_decoder *decoder,
1392 struct thread_info *tp, int level)
1394 pt_insn_free_decoder (decoder);
1396 /* LEVEL is the minimal function level of all btrace function segments.
1397 Define the global level offset to -LEVEL so all function levels are
1398 normalized to start at zero. */
1399 tp->btrace.level = -level;
1401 /* Add a single last instruction entry for the current PC.
1402 This allows us to compute the backtrace at the current PC using both
1403 standard unwind and btrace unwind.
1404 This extra entry is ignored by all record commands. */
1408 /* Compute the function branch trace from Intel Processor Trace
1412 btrace_compute_ftrace_pt (struct thread_info *tp,
1413 const struct btrace_data_pt *btrace,
1414 std::vector<unsigned int> &gaps)
1416 struct btrace_thread_info *btinfo;
1417 struct pt_insn_decoder *decoder;
1418 struct pt_config config;
1421 if (btrace->size == 0)
1424 btinfo = &tp->btrace;
1425 if (btinfo->functions.empty ())
1428 level = -btinfo->level;
1430 pt_config_init(&config);
1431 config.begin = btrace->data;
1432 config.end = btrace->data + btrace->size;
1434 /* We treat an unknown vendor as 'no errata'. */
1435 if (btrace->config.cpu.vendor != CV_UNKNOWN)
1438 = pt_translate_cpu_vendor (btrace->config.cpu.vendor);
1439 config.cpu.family = btrace->config.cpu.family;
1440 config.cpu.model = btrace->config.cpu.model;
1441 config.cpu.stepping = btrace->config.cpu.stepping;
1443 errcode = pt_cpu_errata (&config.errata, &config.cpu);
1445 error (_("Failed to configure the Intel Processor Trace "
1446 "decoder: %s."), pt_errstr (pt_errcode (errcode)));
1449 decoder = pt_insn_alloc_decoder (&config);
1450 if (decoder == NULL)
1451 error (_("Failed to allocate the Intel Processor Trace decoder."));
1455 struct pt_image *image;
1457 image = pt_insn_get_image(decoder);
1459 error (_("Failed to configure the Intel Processor Trace decoder."));
1461 errcode = pt_image_set_callback(image, btrace_pt_readmem_callback, NULL);
1463 error (_("Failed to configure the Intel Processor Trace decoder: "
1464 "%s."), pt_errstr (pt_errcode (errcode)));
1466 ftrace_add_pt (btinfo, decoder, &level, gaps);
1468 CATCH (error, RETURN_MASK_ALL)
1470 /* Indicate a gap in the trace if we quit trace processing. */
1471 if (error.reason == RETURN_QUIT && !btinfo->functions.empty ())
1472 ftrace_new_gap (btinfo, BDE_PT_USER_QUIT, gaps);
1474 btrace_finalize_ftrace_pt (decoder, tp, level);
1476 throw_exception (error);
1480 btrace_finalize_ftrace_pt (decoder, tp, level);
1483 #else /* defined (HAVE_LIBIPT) */
1486 btrace_compute_ftrace_pt (struct thread_info *tp,
1487 const struct btrace_data_pt *btrace,
1488 std::vector<unsigned int> &gaps)
1490 internal_error (__FILE__, __LINE__, _("Unexpected branch trace format."));
1493 #endif /* defined (HAVE_LIBIPT) */
1495 /* Compute the function branch trace from a block branch trace BTRACE for
1496 a thread given by BTINFO. If CPU is not NULL, overwrite the cpu in the
1497 branch trace configuration. This is currently only used for the PT
1501 btrace_compute_ftrace_1 (struct thread_info *tp,
1502 struct btrace_data *btrace,
1503 const struct btrace_cpu *cpu,
1504 std::vector<unsigned int> &gaps)
1506 DEBUG ("compute ftrace");
1508 switch (btrace->format)
1510 case BTRACE_FORMAT_NONE:
1513 case BTRACE_FORMAT_BTS:
1514 btrace_compute_ftrace_bts (tp, &btrace->variant.bts, gaps);
1517 case BTRACE_FORMAT_PT:
1518 /* Overwrite the cpu we use for enabling errata workarounds. */
1520 btrace->variant.pt.config.cpu = *cpu;
1522 btrace_compute_ftrace_pt (tp, &btrace->variant.pt, gaps);
1526 internal_error (__FILE__, __LINE__, _("Unkown branch trace format."));
1530 btrace_finalize_ftrace (struct thread_info *tp, std::vector<unsigned int> &gaps)
1534 tp->btrace.ngaps += gaps.size ();
1535 btrace_bridge_gaps (tp, gaps);
1540 btrace_compute_ftrace (struct thread_info *tp, struct btrace_data *btrace,
1541 const struct btrace_cpu *cpu)
1543 std::vector<unsigned int> gaps;
1547 btrace_compute_ftrace_1 (tp, btrace, cpu, gaps);
1549 CATCH (error, RETURN_MASK_ALL)
1551 btrace_finalize_ftrace (tp, gaps);
1553 throw_exception (error);
1557 btrace_finalize_ftrace (tp, gaps);
1560 /* Add an entry for the current PC. */
1563 btrace_add_pc (struct thread_info *tp)
1565 struct btrace_data btrace;
1566 struct btrace_block *block;
1567 struct regcache *regcache;
1568 struct cleanup *cleanup;
1571 regcache = get_thread_regcache (tp->ptid);
1572 pc = regcache_read_pc (regcache);
1574 btrace_data_init (&btrace);
1575 btrace.format = BTRACE_FORMAT_BTS;
1576 btrace.variant.bts.blocks = NULL;
1578 cleanup = make_cleanup_btrace_data (&btrace);
1580 block = VEC_safe_push (btrace_block_s, btrace.variant.bts.blocks, NULL);
1584 btrace_compute_ftrace (tp, &btrace, NULL);
1586 do_cleanups (cleanup);
1592 btrace_enable (struct thread_info *tp, const struct btrace_config *conf)
1594 if (tp->btrace.target != NULL)
1597 #if !defined (HAVE_LIBIPT)
1598 if (conf->format == BTRACE_FORMAT_PT)
1599 error (_("Intel Processor Trace support was disabled at compile time."));
1600 #endif /* !defined (HAVE_LIBIPT) */
1602 DEBUG ("enable thread %s (%s)", print_thread_id (tp),
1603 target_pid_to_str (tp->ptid));
1605 tp->btrace.target = target_enable_btrace (tp->ptid, conf);
1607 /* We're done if we failed to enable tracing. */
1608 if (tp->btrace.target == NULL)
1611 /* We need to undo the enable in case of errors. */
1614 /* Add an entry for the current PC so we start tracing from where we
1617 If we can't access TP's registers, TP is most likely running. In this
1618 case, we can't really say where tracing was enabled so it should be
1619 safe to simply skip this step.
1621 This is not relevant for BTRACE_FORMAT_PT since the trace will already
1622 start at the PC at which tracing was enabled. */
1623 if (conf->format != BTRACE_FORMAT_PT
1624 && can_access_registers_ptid (tp->ptid))
1627 CATCH (exception, RETURN_MASK_ALL)
1629 btrace_disable (tp);
1631 throw_exception (exception);
1638 const struct btrace_config *
1639 btrace_conf (const struct btrace_thread_info *btinfo)
1641 if (btinfo->target == NULL)
1644 return target_btrace_conf (btinfo->target);
1650 btrace_disable (struct thread_info *tp)
1652 struct btrace_thread_info *btp = &tp->btrace;
1654 if (btp->target == NULL)
1657 DEBUG ("disable thread %s (%s)", print_thread_id (tp),
1658 target_pid_to_str (tp->ptid));
1660 target_disable_btrace (btp->target);
1669 btrace_teardown (struct thread_info *tp)
1671 struct btrace_thread_info *btp = &tp->btrace;
1673 if (btp->target == NULL)
1676 DEBUG ("teardown thread %s (%s)", print_thread_id (tp),
1677 target_pid_to_str (tp->ptid));
1679 target_teardown_btrace (btp->target);
1685 /* Stitch branch trace in BTS format. */
1688 btrace_stitch_bts (struct btrace_data_bts *btrace, struct thread_info *tp)
1690 struct btrace_thread_info *btinfo;
1691 struct btrace_function *last_bfun;
1692 btrace_block_s *first_new_block;
1694 btinfo = &tp->btrace;
1695 gdb_assert (!btinfo->functions.empty ());
1696 gdb_assert (!VEC_empty (btrace_block_s, btrace->blocks));
1698 last_bfun = &btinfo->functions.back ();
1700 /* If the existing trace ends with a gap, we just glue the traces
1701 together. We need to drop the last (i.e. chronologically first) block
1702 of the new trace, though, since we can't fill in the start address.*/
1703 if (last_bfun->insn.empty ())
1705 VEC_pop (btrace_block_s, btrace->blocks);
1709 /* Beware that block trace starts with the most recent block, so the
1710 chronologically first block in the new trace is the last block in
1711 the new trace's block vector. */
1712 first_new_block = VEC_last (btrace_block_s, btrace->blocks);
1713 const btrace_insn &last_insn = last_bfun->insn.back ();
1715 /* If the current PC at the end of the block is the same as in our current
1716 trace, there are two explanations:
1717 1. we executed the instruction and some branch brought us back.
1718 2. we have not made any progress.
1719 In the first case, the delta trace vector should contain at least two
1721 In the second case, the delta trace vector should contain exactly one
1722 entry for the partial block containing the current PC. Remove it. */
1723 if (first_new_block->end == last_insn.pc
1724 && VEC_length (btrace_block_s, btrace->blocks) == 1)
1726 VEC_pop (btrace_block_s, btrace->blocks);
1730 DEBUG ("stitching %s to %s", ftrace_print_insn_addr (&last_insn),
1731 core_addr_to_string_nz (first_new_block->end));
1733 /* Do a simple sanity check to make sure we don't accidentally end up
1734 with a bad block. This should not occur in practice. */
1735 if (first_new_block->end < last_insn.pc)
1737 warning (_("Error while trying to read delta trace. Falling back to "
1742 /* We adjust the last block to start at the end of our current trace. */
1743 gdb_assert (first_new_block->begin == 0);
1744 first_new_block->begin = last_insn.pc;
1746 /* We simply pop the last insn so we can insert it again as part of
1747 the normal branch trace computation.
1748 Since instruction iterators are based on indices in the instructions
1749 vector, we don't leave any pointers dangling. */
1750 DEBUG ("pruning insn at %s for stitching",
1751 ftrace_print_insn_addr (&last_insn));
1753 last_bfun->insn.pop_back ();
1755 /* The instructions vector may become empty temporarily if this has
1756 been the only instruction in this function segment.
1757 This violates the invariant but will be remedied shortly by
1758 btrace_compute_ftrace when we add the new trace. */
1760 /* The only case where this would hurt is if the entire trace consisted
1761 of just that one instruction. If we remove it, we might turn the now
1762 empty btrace function segment into a gap. But we don't want gaps at
1763 the beginning. To avoid this, we remove the entire old trace. */
1764 if (last_bfun->number == 1 && last_bfun->insn.empty ())
1770 /* Adjust the block trace in order to stitch old and new trace together.
1771 BTRACE is the new delta trace between the last and the current stop.
1772 TP is the traced thread.
1773 May modifx BTRACE as well as the existing trace in TP.
1774 Return 0 on success, -1 otherwise. */
1777 btrace_stitch_trace (struct btrace_data *btrace, struct thread_info *tp)
1779 /* If we don't have trace, there's nothing to do. */
1780 if (btrace_data_empty (btrace))
1783 switch (btrace->format)
1785 case BTRACE_FORMAT_NONE:
1788 case BTRACE_FORMAT_BTS:
1789 return btrace_stitch_bts (&btrace->variant.bts, tp);
1791 case BTRACE_FORMAT_PT:
1792 /* Delta reads are not supported. */
1796 internal_error (__FILE__, __LINE__, _("Unkown branch trace format."));
1799 /* Clear the branch trace histories in BTINFO. */
1802 btrace_clear_history (struct btrace_thread_info *btinfo)
1804 xfree (btinfo->insn_history);
1805 xfree (btinfo->call_history);
1806 xfree (btinfo->replay);
1808 btinfo->insn_history = NULL;
1809 btinfo->call_history = NULL;
1810 btinfo->replay = NULL;
1813 /* Clear the branch trace maintenance histories in BTINFO. */
1816 btrace_maint_clear (struct btrace_thread_info *btinfo)
1818 switch (btinfo->data.format)
1823 case BTRACE_FORMAT_BTS:
1824 btinfo->maint.variant.bts.packet_history.begin = 0;
1825 btinfo->maint.variant.bts.packet_history.end = 0;
1828 #if defined (HAVE_LIBIPT)
1829 case BTRACE_FORMAT_PT:
1830 xfree (btinfo->maint.variant.pt.packets);
1832 btinfo->maint.variant.pt.packets = NULL;
1833 btinfo->maint.variant.pt.packet_history.begin = 0;
1834 btinfo->maint.variant.pt.packet_history.end = 0;
1836 #endif /* defined (HAVE_LIBIPT) */
1843 btrace_decode_error (enum btrace_format format, int errcode)
1847 case BTRACE_FORMAT_BTS:
1850 case BDE_BTS_OVERFLOW:
1851 return _("instruction overflow");
1853 case BDE_BTS_INSN_SIZE:
1854 return _("unknown instruction");
1861 #if defined (HAVE_LIBIPT)
1862 case BTRACE_FORMAT_PT:
1865 case BDE_PT_USER_QUIT:
1866 return _("trace decode cancelled");
1868 case BDE_PT_DISABLED:
1869 return _("disabled");
1871 case BDE_PT_OVERFLOW:
1872 return _("overflow");
1876 return pt_errstr (pt_errcode (errcode));
1880 #endif /* defined (HAVE_LIBIPT) */
1886 return _("unknown");
1892 btrace_fetch (struct thread_info *tp, const struct btrace_cpu *cpu)
1894 struct btrace_thread_info *btinfo;
1895 struct btrace_target_info *tinfo;
1896 struct btrace_data btrace;
1897 struct cleanup *cleanup;
1900 DEBUG ("fetch thread %s (%s)", print_thread_id (tp),
1901 target_pid_to_str (tp->ptid));
1903 btinfo = &tp->btrace;
1904 tinfo = btinfo->target;
1908 /* There's no way we could get new trace while replaying.
1909 On the other hand, delta trace would return a partial record with the
1910 current PC, which is the replay PC, not the last PC, as expected. */
1911 if (btinfo->replay != NULL)
1914 /* With CLI usage, TP->PTID always equals INFERIOR_PTID here. Now that we
1915 can store a gdb.Record object in Python referring to a different thread
1916 than the current one, temporarily set INFERIOR_PTID. */
1917 scoped_restore save_inferior_ptid = make_scoped_restore (&inferior_ptid);
1918 inferior_ptid = tp->ptid;
1920 /* We should not be called on running or exited threads. */
1921 gdb_assert (can_access_registers_ptid (tp->ptid));
1923 btrace_data_init (&btrace);
1924 cleanup = make_cleanup_btrace_data (&btrace);
1926 /* Let's first try to extend the trace we already have. */
1927 if (!btinfo->functions.empty ())
1929 errcode = target_read_btrace (&btrace, tinfo, BTRACE_READ_DELTA);
1932 /* Success. Let's try to stitch the traces together. */
1933 errcode = btrace_stitch_trace (&btrace, tp);
1937 /* We failed to read delta trace. Let's try to read new trace. */
1938 errcode = target_read_btrace (&btrace, tinfo, BTRACE_READ_NEW);
1940 /* If we got any new trace, discard what we have. */
1941 if (errcode == 0 && !btrace_data_empty (&btrace))
1945 /* If we were not able to read the trace, we start over. */
1949 errcode = target_read_btrace (&btrace, tinfo, BTRACE_READ_ALL);
1953 errcode = target_read_btrace (&btrace, tinfo, BTRACE_READ_ALL);
1955 /* If we were not able to read the branch trace, signal an error. */
1957 error (_("Failed to read branch trace."));
1959 /* Compute the trace, provided we have any. */
1960 if (!btrace_data_empty (&btrace))
1962 /* Store the raw trace data. The stored data will be cleared in
1963 btrace_clear, so we always append the new trace. */
1964 btrace_data_append (&btinfo->data, &btrace);
1965 btrace_maint_clear (btinfo);
1967 btrace_clear_history (btinfo);
1968 btrace_compute_ftrace (tp, &btrace, cpu);
1971 do_cleanups (cleanup);
1977 btrace_clear (struct thread_info *tp)
1979 struct btrace_thread_info *btinfo;
1981 DEBUG ("clear thread %s (%s)", print_thread_id (tp),
1982 target_pid_to_str (tp->ptid));
1984 /* Make sure btrace frames that may hold a pointer into the branch
1985 trace data are destroyed. */
1986 reinit_frame_cache ();
1988 btinfo = &tp->btrace;
1990 btinfo->functions.clear ();
1993 /* Must clear the maint data before - it depends on BTINFO->DATA. */
1994 btrace_maint_clear (btinfo);
1995 btrace_data_clear (&btinfo->data);
1996 btrace_clear_history (btinfo);
2002 btrace_free_objfile (struct objfile *objfile)
2004 struct thread_info *tp;
2006 DEBUG ("free objfile");
2008 ALL_NON_EXITED_THREADS (tp)
2012 #if defined (HAVE_LIBEXPAT)
2014 /* Check the btrace document version. */
2017 check_xml_btrace_version (struct gdb_xml_parser *parser,
2018 const struct gdb_xml_element *element,
2020 std::vector<gdb_xml_value> &attributes)
2023 = (const char *) xml_find_attribute (attributes, "version")->value.get ();
2025 if (strcmp (version, "1.0") != 0)
2026 gdb_xml_error (parser, _("Unsupported btrace version: \"%s\""), version);
2029 /* Parse a btrace "block" xml record. */
2032 parse_xml_btrace_block (struct gdb_xml_parser *parser,
2033 const struct gdb_xml_element *element,
2035 std::vector<gdb_xml_value> &attributes)
2037 struct btrace_data *btrace;
2038 struct btrace_block *block;
2039 ULONGEST *begin, *end;
2041 btrace = (struct btrace_data *) user_data;
2043 switch (btrace->format)
2045 case BTRACE_FORMAT_BTS:
2048 case BTRACE_FORMAT_NONE:
2049 btrace->format = BTRACE_FORMAT_BTS;
2050 btrace->variant.bts.blocks = NULL;
2054 gdb_xml_error (parser, _("Btrace format error."));
2057 begin = (ULONGEST *) xml_find_attribute (attributes, "begin")->value.get ();
2058 end = (ULONGEST *) xml_find_attribute (attributes, "end")->value.get ();
2060 block = VEC_safe_push (btrace_block_s, btrace->variant.bts.blocks, NULL);
2061 block->begin = *begin;
2065 /* Parse a "raw" xml record. */
2068 parse_xml_raw (struct gdb_xml_parser *parser, const char *body_text,
2069 gdb_byte **pdata, size_t *psize)
2071 struct cleanup *cleanup;
2072 gdb_byte *data, *bin;
2075 len = strlen (body_text);
2077 gdb_xml_error (parser, _("Bad raw data size."));
2081 bin = data = (gdb_byte *) xmalloc (size);
2082 cleanup = make_cleanup (xfree, data);
2084 /* We use hex encoding - see common/rsp-low.h. */
2092 if (hi == 0 || lo == 0)
2093 gdb_xml_error (parser, _("Bad hex encoding."));
2095 *bin++ = fromhex (hi) * 16 + fromhex (lo);
2099 discard_cleanups (cleanup);
2105 /* Parse a btrace pt-config "cpu" xml record. */
2108 parse_xml_btrace_pt_config_cpu (struct gdb_xml_parser *parser,
2109 const struct gdb_xml_element *element,
2111 std::vector<gdb_xml_value> &attributes)
2113 struct btrace_data *btrace;
2115 ULONGEST *family, *model, *stepping;
2118 (const char *) xml_find_attribute (attributes, "vendor")->value.get ();
2120 = (ULONGEST *) xml_find_attribute (attributes, "family")->value.get ();
2122 = (ULONGEST *) xml_find_attribute (attributes, "model")->value.get ();
2124 = (ULONGEST *) xml_find_attribute (attributes, "stepping")->value.get ();
2126 btrace = (struct btrace_data *) user_data;
2128 if (strcmp (vendor, "GenuineIntel") == 0)
2129 btrace->variant.pt.config.cpu.vendor = CV_INTEL;
2131 btrace->variant.pt.config.cpu.family = *family;
2132 btrace->variant.pt.config.cpu.model = *model;
2133 btrace->variant.pt.config.cpu.stepping = *stepping;
2136 /* Parse a btrace pt "raw" xml record. */
2139 parse_xml_btrace_pt_raw (struct gdb_xml_parser *parser,
2140 const struct gdb_xml_element *element,
2141 void *user_data, const char *body_text)
2143 struct btrace_data *btrace;
2145 btrace = (struct btrace_data *) user_data;
2146 parse_xml_raw (parser, body_text, &btrace->variant.pt.data,
2147 &btrace->variant.pt.size);
2150 /* Parse a btrace "pt" xml record. */
2153 parse_xml_btrace_pt (struct gdb_xml_parser *parser,
2154 const struct gdb_xml_element *element,
2156 std::vector<gdb_xml_value> &attributes)
2158 struct btrace_data *btrace;
2160 btrace = (struct btrace_data *) user_data;
2161 btrace->format = BTRACE_FORMAT_PT;
2162 btrace->variant.pt.config.cpu.vendor = CV_UNKNOWN;
2163 btrace->variant.pt.data = NULL;
2164 btrace->variant.pt.size = 0;
2167 static const struct gdb_xml_attribute block_attributes[] = {
2168 { "begin", GDB_XML_AF_NONE, gdb_xml_parse_attr_ulongest, NULL },
2169 { "end", GDB_XML_AF_NONE, gdb_xml_parse_attr_ulongest, NULL },
2170 { NULL, GDB_XML_AF_NONE, NULL, NULL }
2173 static const struct gdb_xml_attribute btrace_pt_config_cpu_attributes[] = {
2174 { "vendor", GDB_XML_AF_NONE, NULL, NULL },
2175 { "family", GDB_XML_AF_NONE, gdb_xml_parse_attr_ulongest, NULL },
2176 { "model", GDB_XML_AF_NONE, gdb_xml_parse_attr_ulongest, NULL },
2177 { "stepping", GDB_XML_AF_NONE, gdb_xml_parse_attr_ulongest, NULL },
2178 { NULL, GDB_XML_AF_NONE, NULL, NULL }
2181 static const struct gdb_xml_element btrace_pt_config_children[] = {
2182 { "cpu", btrace_pt_config_cpu_attributes, NULL, GDB_XML_EF_OPTIONAL,
2183 parse_xml_btrace_pt_config_cpu, NULL },
2184 { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
2187 static const struct gdb_xml_element btrace_pt_children[] = {
2188 { "pt-config", NULL, btrace_pt_config_children, GDB_XML_EF_OPTIONAL, NULL,
2190 { "raw", NULL, NULL, GDB_XML_EF_OPTIONAL, NULL, parse_xml_btrace_pt_raw },
2191 { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
2194 static const struct gdb_xml_attribute btrace_attributes[] = {
2195 { "version", GDB_XML_AF_NONE, NULL, NULL },
2196 { NULL, GDB_XML_AF_NONE, NULL, NULL }
2199 static const struct gdb_xml_element btrace_children[] = {
2200 { "block", block_attributes, NULL,
2201 GDB_XML_EF_REPEATABLE | GDB_XML_EF_OPTIONAL, parse_xml_btrace_block, NULL },
2202 { "pt", NULL, btrace_pt_children, GDB_XML_EF_OPTIONAL, parse_xml_btrace_pt,
2204 { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
2207 static const struct gdb_xml_element btrace_elements[] = {
2208 { "btrace", btrace_attributes, btrace_children, GDB_XML_EF_NONE,
2209 check_xml_btrace_version, NULL },
2210 { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
2213 #endif /* defined (HAVE_LIBEXPAT) */
2218 parse_xml_btrace (struct btrace_data *btrace, const char *buffer)
2220 struct cleanup *cleanup;
2223 #if defined (HAVE_LIBEXPAT)
2225 btrace->format = BTRACE_FORMAT_NONE;
2227 cleanup = make_cleanup_btrace_data (btrace);
2228 errcode = gdb_xml_parse_quick (_("btrace"), "btrace.dtd", btrace_elements,
2231 error (_("Error parsing branch trace."));
2233 /* Keep parse results. */
2234 discard_cleanups (cleanup);
2236 #else /* !defined (HAVE_LIBEXPAT) */
2238 error (_("Cannot process branch trace. XML support was disabled at "
2241 #endif /* !defined (HAVE_LIBEXPAT) */
2244 #if defined (HAVE_LIBEXPAT)
2246 /* Parse a btrace-conf "bts" xml record. */
2249 parse_xml_btrace_conf_bts (struct gdb_xml_parser *parser,
2250 const struct gdb_xml_element *element,
2252 std::vector<gdb_xml_value> &attributes)
2254 struct btrace_config *conf;
2255 struct gdb_xml_value *size;
2257 conf = (struct btrace_config *) user_data;
2258 conf->format = BTRACE_FORMAT_BTS;
2261 size = xml_find_attribute (attributes, "size");
2263 conf->bts.size = (unsigned int) *(ULONGEST *) size->value.get ();
2266 /* Parse a btrace-conf "pt" xml record. */
2269 parse_xml_btrace_conf_pt (struct gdb_xml_parser *parser,
2270 const struct gdb_xml_element *element,
2272 std::vector<gdb_xml_value> &attributes)
2274 struct btrace_config *conf;
2275 struct gdb_xml_value *size;
2277 conf = (struct btrace_config *) user_data;
2278 conf->format = BTRACE_FORMAT_PT;
2281 size = xml_find_attribute (attributes, "size");
2283 conf->pt.size = (unsigned int) *(ULONGEST *) size->value.get ();
2286 static const struct gdb_xml_attribute btrace_conf_pt_attributes[] = {
2287 { "size", GDB_XML_AF_OPTIONAL, gdb_xml_parse_attr_ulongest, NULL },
2288 { NULL, GDB_XML_AF_NONE, NULL, NULL }
2291 static const struct gdb_xml_attribute btrace_conf_bts_attributes[] = {
2292 { "size", GDB_XML_AF_OPTIONAL, gdb_xml_parse_attr_ulongest, NULL },
2293 { NULL, GDB_XML_AF_NONE, NULL, NULL }
2296 static const struct gdb_xml_element btrace_conf_children[] = {
2297 { "bts", btrace_conf_bts_attributes, NULL, GDB_XML_EF_OPTIONAL,
2298 parse_xml_btrace_conf_bts, NULL },
2299 { "pt", btrace_conf_pt_attributes, NULL, GDB_XML_EF_OPTIONAL,
2300 parse_xml_btrace_conf_pt, NULL },
2301 { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
2304 static const struct gdb_xml_attribute btrace_conf_attributes[] = {
2305 { "version", GDB_XML_AF_NONE, NULL, NULL },
2306 { NULL, GDB_XML_AF_NONE, NULL, NULL }
2309 static const struct gdb_xml_element btrace_conf_elements[] = {
2310 { "btrace-conf", btrace_conf_attributes, btrace_conf_children,
2311 GDB_XML_EF_NONE, NULL, NULL },
2312 { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
2315 #endif /* defined (HAVE_LIBEXPAT) */
2320 parse_xml_btrace_conf (struct btrace_config *conf, const char *xml)
2324 #if defined (HAVE_LIBEXPAT)
2326 errcode = gdb_xml_parse_quick (_("btrace-conf"), "btrace-conf.dtd",
2327 btrace_conf_elements, xml, conf);
2329 error (_("Error parsing branch trace configuration."));
2331 #else /* !defined (HAVE_LIBEXPAT) */
2333 error (_("Cannot process the branch trace configuration. XML support "
2334 "was disabled at compile time."));
2336 #endif /* !defined (HAVE_LIBEXPAT) */
2341 const struct btrace_insn *
2342 btrace_insn_get (const struct btrace_insn_iterator *it)
2344 const struct btrace_function *bfun;
2345 unsigned int index, end;
2347 index = it->insn_index;
2348 bfun = &it->btinfo->functions[it->call_index];
2350 /* Check if the iterator points to a gap in the trace. */
2351 if (bfun->errcode != 0)
2354 /* The index is within the bounds of this function's instruction vector. */
2355 end = bfun->insn.size ();
2356 gdb_assert (0 < end);
2357 gdb_assert (index < end);
2359 return &bfun->insn[index];
2365 btrace_insn_get_error (const struct btrace_insn_iterator *it)
2367 return it->btinfo->functions[it->call_index].errcode;
2373 btrace_insn_number (const struct btrace_insn_iterator *it)
2375 return it->btinfo->functions[it->call_index].insn_offset + it->insn_index;
2381 btrace_insn_begin (struct btrace_insn_iterator *it,
2382 const struct btrace_thread_info *btinfo)
2384 if (btinfo->functions.empty ())
2385 error (_("No trace."));
2387 it->btinfo = btinfo;
2395 btrace_insn_end (struct btrace_insn_iterator *it,
2396 const struct btrace_thread_info *btinfo)
2398 const struct btrace_function *bfun;
2399 unsigned int length;
2401 if (btinfo->functions.empty ())
2402 error (_("No trace."));
2404 bfun = &btinfo->functions.back ();
2405 length = bfun->insn.size ();
2407 /* The last function may either be a gap or it contains the current
2408 instruction, which is one past the end of the execution trace; ignore
2413 it->btinfo = btinfo;
2414 it->call_index = bfun->number - 1;
2415 it->insn_index = length;
2421 btrace_insn_next (struct btrace_insn_iterator *it, unsigned int stride)
2423 const struct btrace_function *bfun;
2424 unsigned int index, steps;
2426 bfun = &it->btinfo->functions[it->call_index];
2428 index = it->insn_index;
2432 unsigned int end, space, adv;
2434 end = bfun->insn.size ();
2436 /* An empty function segment represents a gap in the trace. We count
2437 it as one instruction. */
2440 const struct btrace_function *next;
2442 next = ftrace_find_call_by_number (it->btinfo, bfun->number + 1);
2455 gdb_assert (0 < end);
2456 gdb_assert (index < end);
2458 /* Compute the number of instructions remaining in this segment. */
2459 space = end - index;
2461 /* Advance the iterator as far as possible within this segment. */
2462 adv = std::min (space, stride);
2467 /* Move to the next function if we're at the end of this one. */
2470 const struct btrace_function *next;
2472 next = ftrace_find_call_by_number (it->btinfo, bfun->number + 1);
2475 /* We stepped past the last function.
2477 Let's adjust the index to point to the last instruction in
2478 the previous function. */
2484 /* We now point to the first instruction in the new function. */
2489 /* We did make progress. */
2490 gdb_assert (adv > 0);
2493 /* Update the iterator. */
2494 it->call_index = bfun->number - 1;
2495 it->insn_index = index;
2503 btrace_insn_prev (struct btrace_insn_iterator *it, unsigned int stride)
2505 const struct btrace_function *bfun;
2506 unsigned int index, steps;
2508 bfun = &it->btinfo->functions[it->call_index];
2510 index = it->insn_index;
2516 /* Move to the previous function if we're at the start of this one. */
2519 const struct btrace_function *prev;
2521 prev = ftrace_find_call_by_number (it->btinfo, bfun->number - 1);
2525 /* We point to one after the last instruction in the new function. */
2527 index = bfun->insn.size ();
2529 /* An empty function segment represents a gap in the trace. We count
2530 it as one instruction. */
2540 /* Advance the iterator as far as possible within this segment. */
2541 adv = std::min (index, stride);
2547 /* We did make progress. */
2548 gdb_assert (adv > 0);
2551 /* Update the iterator. */
2552 it->call_index = bfun->number - 1;
2553 it->insn_index = index;
2561 btrace_insn_cmp (const struct btrace_insn_iterator *lhs,
2562 const struct btrace_insn_iterator *rhs)
2564 gdb_assert (lhs->btinfo == rhs->btinfo);
2566 if (lhs->call_index != rhs->call_index)
2567 return lhs->call_index - rhs->call_index;
2569 return lhs->insn_index - rhs->insn_index;
2575 btrace_find_insn_by_number (struct btrace_insn_iterator *it,
2576 const struct btrace_thread_info *btinfo,
2577 unsigned int number)
2579 const struct btrace_function *bfun;
2580 unsigned int upper, lower;
2582 if (btinfo->functions.empty ())
2586 bfun = &btinfo->functions[lower];
2587 if (number < bfun->insn_offset)
2590 upper = btinfo->functions.size () - 1;
2591 bfun = &btinfo->functions[upper];
2592 if (number >= bfun->insn_offset + ftrace_call_num_insn (bfun))
2595 /* We assume that there are no holes in the numbering. */
2598 const unsigned int average = lower + (upper - lower) / 2;
2600 bfun = &btinfo->functions[average];
2602 if (number < bfun->insn_offset)
2604 upper = average - 1;
2608 if (number >= bfun->insn_offset + ftrace_call_num_insn (bfun))
2610 lower = average + 1;
2617 it->btinfo = btinfo;
2618 it->call_index = bfun->number - 1;
2619 it->insn_index = number - bfun->insn_offset;
2623 /* Returns true if the recording ends with a function segment that
2624 contains only a single (i.e. the current) instruction. */
2627 btrace_ends_with_single_insn (const struct btrace_thread_info *btinfo)
2629 const btrace_function *bfun;
2631 if (btinfo->functions.empty ())
2634 bfun = &btinfo->functions.back ();
2635 if (bfun->errcode != 0)
2638 return ftrace_call_num_insn (bfun) == 1;
2643 const struct btrace_function *
2644 btrace_call_get (const struct btrace_call_iterator *it)
2646 if (it->index >= it->btinfo->functions.size ())
2649 return &it->btinfo->functions[it->index];
2655 btrace_call_number (const struct btrace_call_iterator *it)
2657 const unsigned int length = it->btinfo->functions.size ();
2659 /* If the last function segment contains only a single instruction (i.e. the
2660 current instruction), skip it. */
2661 if ((it->index == length) && btrace_ends_with_single_insn (it->btinfo))
2664 return it->index + 1;
2670 btrace_call_begin (struct btrace_call_iterator *it,
2671 const struct btrace_thread_info *btinfo)
2673 if (btinfo->functions.empty ())
2674 error (_("No trace."));
2676 it->btinfo = btinfo;
2683 btrace_call_end (struct btrace_call_iterator *it,
2684 const struct btrace_thread_info *btinfo)
2686 if (btinfo->functions.empty ())
2687 error (_("No trace."));
2689 it->btinfo = btinfo;
2690 it->index = btinfo->functions.size ();
2696 btrace_call_next (struct btrace_call_iterator *it, unsigned int stride)
2698 const unsigned int length = it->btinfo->functions.size ();
2700 if (it->index + stride < length - 1)
2701 /* Default case: Simply advance the iterator. */
2702 it->index += stride;
2703 else if (it->index + stride == length - 1)
2705 /* We land exactly at the last function segment. If it contains only one
2706 instruction (i.e. the current instruction) it is not actually part of
2708 if (btrace_ends_with_single_insn (it->btinfo))
2711 it->index = length - 1;
2715 /* We land past the last function segment and have to adjust the stride.
2716 If the last function segment contains only one instruction (i.e. the
2717 current instruction) it is not actually part of the trace. */
2718 if (btrace_ends_with_single_insn (it->btinfo))
2719 stride = length - it->index - 1;
2721 stride = length - it->index;
2732 btrace_call_prev (struct btrace_call_iterator *it, unsigned int stride)
2734 const unsigned int length = it->btinfo->functions.size ();
2737 gdb_assert (it->index <= length);
2739 if (stride == 0 || it->index == 0)
2742 /* If we are at the end, the first step is a special case. If the last
2743 function segment contains only one instruction (i.e. the current
2744 instruction) it is not actually part of the trace. To be able to step
2745 over this instruction, we need at least one more function segment. */
2746 if ((it->index == length) && (length > 1))
2748 if (btrace_ends_with_single_insn (it->btinfo))
2749 it->index = length - 2;
2751 it->index = length - 1;
2757 stride = std::min (stride, it->index);
2759 it->index -= stride;
2760 return steps + stride;
2766 btrace_call_cmp (const struct btrace_call_iterator *lhs,
2767 const struct btrace_call_iterator *rhs)
2769 gdb_assert (lhs->btinfo == rhs->btinfo);
2770 return (int) (lhs->index - rhs->index);
2776 btrace_find_call_by_number (struct btrace_call_iterator *it,
2777 const struct btrace_thread_info *btinfo,
2778 unsigned int number)
2780 const unsigned int length = btinfo->functions.size ();
2782 if ((number == 0) || (number > length))
2785 it->btinfo = btinfo;
2786 it->index = number - 1;
2793 btrace_set_insn_history (struct btrace_thread_info *btinfo,
2794 const struct btrace_insn_iterator *begin,
2795 const struct btrace_insn_iterator *end)
2797 if (btinfo->insn_history == NULL)
2798 btinfo->insn_history = XCNEW (struct btrace_insn_history);
2800 btinfo->insn_history->begin = *begin;
2801 btinfo->insn_history->end = *end;
2807 btrace_set_call_history (struct btrace_thread_info *btinfo,
2808 const struct btrace_call_iterator *begin,
2809 const struct btrace_call_iterator *end)
2811 gdb_assert (begin->btinfo == end->btinfo);
2813 if (btinfo->call_history == NULL)
2814 btinfo->call_history = XCNEW (struct btrace_call_history);
2816 btinfo->call_history->begin = *begin;
2817 btinfo->call_history->end = *end;
2823 btrace_is_replaying (struct thread_info *tp)
2825 return tp->btrace.replay != NULL;
2831 btrace_is_empty (struct thread_info *tp)
2833 struct btrace_insn_iterator begin, end;
2834 struct btrace_thread_info *btinfo;
2836 btinfo = &tp->btrace;
2838 if (btinfo->functions.empty ())
2841 btrace_insn_begin (&begin, btinfo);
2842 btrace_insn_end (&end, btinfo);
2844 return btrace_insn_cmp (&begin, &end) == 0;
2847 /* Forward the cleanup request. */
2850 do_btrace_data_cleanup (void *arg)
2852 btrace_data_fini ((struct btrace_data *) arg);
2858 make_cleanup_btrace_data (struct btrace_data *data)
2860 return make_cleanup (do_btrace_data_cleanup, data);
2863 #if defined (HAVE_LIBIPT)
2865 /* Print a single packet. */
2868 pt_print_packet (const struct pt_packet *packet)
2870 switch (packet->type)
2873 printf_unfiltered (("[??: %x]"), packet->type);
2877 printf_unfiltered (("psb"));
2881 printf_unfiltered (("psbend"));
2885 printf_unfiltered (("pad"));
2889 printf_unfiltered (("tip %u: 0x%" PRIx64 ""),
2890 packet->payload.ip.ipc,
2891 packet->payload.ip.ip);
2895 printf_unfiltered (("tip.pge %u: 0x%" PRIx64 ""),
2896 packet->payload.ip.ipc,
2897 packet->payload.ip.ip);
2901 printf_unfiltered (("tip.pgd %u: 0x%" PRIx64 ""),
2902 packet->payload.ip.ipc,
2903 packet->payload.ip.ip);
2907 printf_unfiltered (("fup %u: 0x%" PRIx64 ""),
2908 packet->payload.ip.ipc,
2909 packet->payload.ip.ip);
2913 printf_unfiltered (("tnt-8 %u: 0x%" PRIx64 ""),
2914 packet->payload.tnt.bit_size,
2915 packet->payload.tnt.payload);
2919 printf_unfiltered (("tnt-64 %u: 0x%" PRIx64 ""),
2920 packet->payload.tnt.bit_size,
2921 packet->payload.tnt.payload);
2925 printf_unfiltered (("pip %" PRIx64 "%s"), packet->payload.pip.cr3,
2926 packet->payload.pip.nr ? (" nr") : (""));
2930 printf_unfiltered (("tsc %" PRIx64 ""), packet->payload.tsc.tsc);
2934 printf_unfiltered (("cbr %u"), packet->payload.cbr.ratio);
2938 switch (packet->payload.mode.leaf)
2941 printf_unfiltered (("mode %u"), packet->payload.mode.leaf);
2945 printf_unfiltered (("mode.exec%s%s"),
2946 packet->payload.mode.bits.exec.csl
2948 packet->payload.mode.bits.exec.csd
2949 ? (" cs.d") : (""));
2953 printf_unfiltered (("mode.tsx%s%s"),
2954 packet->payload.mode.bits.tsx.intx
2956 packet->payload.mode.bits.tsx.abrt
2957 ? (" abrt") : (""));
2963 printf_unfiltered (("ovf"));
2967 printf_unfiltered (("stop"));
2971 printf_unfiltered (("vmcs %" PRIx64 ""), packet->payload.vmcs.base);
2975 printf_unfiltered (("tma %x %x"), packet->payload.tma.ctc,
2976 packet->payload.tma.fc);
2980 printf_unfiltered (("mtc %x"), packet->payload.mtc.ctc);
2984 printf_unfiltered (("cyc %" PRIx64 ""), packet->payload.cyc.value);
2988 printf_unfiltered (("mnt %" PRIx64 ""), packet->payload.mnt.payload);
2993 /* Decode packets into MAINT using DECODER. */
2996 btrace_maint_decode_pt (struct btrace_maint_info *maint,
2997 struct pt_packet_decoder *decoder)
3003 struct btrace_pt_packet packet;
3005 errcode = pt_pkt_sync_forward (decoder);
3011 pt_pkt_get_offset (decoder, &packet.offset);
3013 errcode = pt_pkt_next (decoder, &packet.packet,
3014 sizeof(packet.packet));
3018 if (maint_btrace_pt_skip_pad == 0 || packet.packet.type != ppt_pad)
3020 packet.errcode = pt_errcode (errcode);
3021 VEC_safe_push (btrace_pt_packet_s, maint->variant.pt.packets,
3026 if (errcode == -pte_eos)
3029 packet.errcode = pt_errcode (errcode);
3030 VEC_safe_push (btrace_pt_packet_s, maint->variant.pt.packets,
3033 warning (_("Error at trace offset 0x%" PRIx64 ": %s."),
3034 packet.offset, pt_errstr (packet.errcode));
3037 if (errcode != -pte_eos)
3038 warning (_("Failed to synchronize onto the Intel Processor Trace "
3039 "stream: %s."), pt_errstr (pt_errcode (errcode)));
3042 /* Update the packet history in BTINFO. */
3045 btrace_maint_update_pt_packets (struct btrace_thread_info *btinfo)
3047 struct pt_packet_decoder *decoder;
3048 const struct btrace_cpu *cpu;
3049 struct btrace_data_pt *pt;
3050 struct pt_config config;
3053 pt = &btinfo->data.variant.pt;
3055 /* Nothing to do if there is no trace. */
3059 memset (&config, 0, sizeof(config));
3061 config.size = sizeof (config);
3062 config.begin = pt->data;
3063 config.end = pt->data + pt->size;
3065 cpu = record_btrace_get_cpu ();
3067 cpu = &pt->config.cpu;
3069 /* We treat an unknown vendor as 'no errata'. */
3070 if (cpu->vendor != CV_UNKNOWN)
3072 config.cpu.vendor = pt_translate_cpu_vendor (cpu->vendor);
3073 config.cpu.family = cpu->family;
3074 config.cpu.model = cpu->model;
3075 config.cpu.stepping = cpu->stepping;
3077 errcode = pt_cpu_errata (&config.errata, &config.cpu);
3079 error (_("Failed to configure the Intel Processor Trace "
3080 "decoder: %s."), pt_errstr (pt_errcode (errcode)));
3083 decoder = pt_pkt_alloc_decoder (&config);
3084 if (decoder == NULL)
3085 error (_("Failed to allocate the Intel Processor Trace decoder."));
3089 btrace_maint_decode_pt (&btinfo->maint, decoder);
3091 CATCH (except, RETURN_MASK_ALL)
3093 pt_pkt_free_decoder (decoder);
3095 if (except.reason < 0)
3096 throw_exception (except);
3100 pt_pkt_free_decoder (decoder);
3103 #endif /* !defined (HAVE_LIBIPT) */
3105 /* Update the packet maintenance information for BTINFO and store the
3106 low and high bounds into BEGIN and END, respectively.
3107 Store the current iterator state into FROM and TO. */
3110 btrace_maint_update_packets (struct btrace_thread_info *btinfo,
3111 unsigned int *begin, unsigned int *end,
3112 unsigned int *from, unsigned int *to)
3114 switch (btinfo->data.format)
3123 case BTRACE_FORMAT_BTS:
3124 /* Nothing to do - we operate directly on BTINFO->DATA. */
3126 *end = VEC_length (btrace_block_s, btinfo->data.variant.bts.blocks);
3127 *from = btinfo->maint.variant.bts.packet_history.begin;
3128 *to = btinfo->maint.variant.bts.packet_history.end;
3131 #if defined (HAVE_LIBIPT)
3132 case BTRACE_FORMAT_PT:
3133 if (VEC_empty (btrace_pt_packet_s, btinfo->maint.variant.pt.packets))
3134 btrace_maint_update_pt_packets (btinfo);
3137 *end = VEC_length (btrace_pt_packet_s, btinfo->maint.variant.pt.packets);
3138 *from = btinfo->maint.variant.pt.packet_history.begin;
3139 *to = btinfo->maint.variant.pt.packet_history.end;
3141 #endif /* defined (HAVE_LIBIPT) */
3145 /* Print packets in BTINFO from BEGIN (inclusive) until END (exclusive) and
3146 update the current iterator position. */
3149 btrace_maint_print_packets (struct btrace_thread_info *btinfo,
3150 unsigned int begin, unsigned int end)
3152 switch (btinfo->data.format)
3157 case BTRACE_FORMAT_BTS:
3159 VEC (btrace_block_s) *blocks;
3162 blocks = btinfo->data.variant.bts.blocks;
3163 for (blk = begin; blk < end; ++blk)
3165 const btrace_block_s *block;
3167 block = VEC_index (btrace_block_s, blocks, blk);
3169 printf_unfiltered ("%u\tbegin: %s, end: %s\n", blk,
3170 core_addr_to_string_nz (block->begin),
3171 core_addr_to_string_nz (block->end));
3174 btinfo->maint.variant.bts.packet_history.begin = begin;
3175 btinfo->maint.variant.bts.packet_history.end = end;
3179 #if defined (HAVE_LIBIPT)
3180 case BTRACE_FORMAT_PT:
3182 VEC (btrace_pt_packet_s) *packets;
3185 packets = btinfo->maint.variant.pt.packets;
3186 for (pkt = begin; pkt < end; ++pkt)
3188 const struct btrace_pt_packet *packet;
3190 packet = VEC_index (btrace_pt_packet_s, packets, pkt);
3192 printf_unfiltered ("%u\t", pkt);
3193 printf_unfiltered ("0x%" PRIx64 "\t", packet->offset);
3195 if (packet->errcode == pte_ok)
3196 pt_print_packet (&packet->packet);
3198 printf_unfiltered ("[error: %s]", pt_errstr (packet->errcode));
3200 printf_unfiltered ("\n");
3203 btinfo->maint.variant.pt.packet_history.begin = begin;
3204 btinfo->maint.variant.pt.packet_history.end = end;
3207 #endif /* defined (HAVE_LIBIPT) */
3211 /* Read a number from an argument string. */
3214 get_uint (const char **arg)
3216 const char *begin, *pos;
3218 unsigned long number;
3221 pos = skip_spaces (begin);
3223 if (!isdigit (*pos))
3224 error (_("Expected positive number, got: %s."), pos);
3226 number = strtoul (pos, &end, 10);
3227 if (number > UINT_MAX)
3228 error (_("Number too big."));
3230 *arg += (end - begin);
3232 return (unsigned int) number;
3235 /* Read a context size from an argument string. */
3238 get_context_size (const char **arg)
3240 const char *pos = skip_spaces (*arg);
3242 if (!isdigit (*pos))
3243 error (_("Expected positive number, got: %s."), pos);
3246 long result = strtol (pos, &end, 10);
3251 /* Complain about junk at the end of an argument string. */
3254 no_chunk (const char *arg)
3257 error (_("Junk after argument: %s."), arg);
3260 /* The "maintenance btrace packet-history" command. */
3263 maint_btrace_packet_history_cmd (const char *arg, int from_tty)
3265 struct btrace_thread_info *btinfo;
3266 struct thread_info *tp;
3267 unsigned int size, begin, end, from, to;
3269 tp = find_thread_ptid (inferior_ptid);
3271 error (_("No thread."));
3274 btinfo = &tp->btrace;
3276 btrace_maint_update_packets (btinfo, &begin, &end, &from, &to);
3279 printf_unfiltered (_("No trace.\n"));
3283 if (arg == NULL || *arg == 0 || strcmp (arg, "+") == 0)
3287 if (end - from < size)
3291 else if (strcmp (arg, "-") == 0)
3295 if (to - begin < size)
3301 from = get_uint (&arg);
3303 error (_("'%u' is out of range."), from);
3305 arg = skip_spaces (arg);
3308 arg = skip_spaces (++arg);
3313 size = get_context_size (&arg);
3317 if (end - from < size)
3321 else if (*arg == '-')
3324 size = get_context_size (&arg);
3328 /* Include the packet given as first argument. */
3332 if (to - begin < size)
3338 to = get_uint (&arg);
3340 /* Include the packet at the second argument and silently
3341 truncate the range. */
3354 if (end - from < size)
3362 btrace_maint_print_packets (btinfo, from, to);
3365 /* The "maintenance btrace clear-packet-history" command. */
3368 maint_btrace_clear_packet_history_cmd (const char *args, int from_tty)
3370 struct btrace_thread_info *btinfo;
3371 struct thread_info *tp;
3373 if (args != NULL && *args != 0)
3374 error (_("Invalid argument."));
3376 tp = find_thread_ptid (inferior_ptid);
3378 error (_("No thread."));
3380 btinfo = &tp->btrace;
3382 /* Must clear the maint data before - it depends on BTINFO->DATA. */
3383 btrace_maint_clear (btinfo);
3384 btrace_data_clear (&btinfo->data);
3387 /* The "maintenance btrace clear" command. */
3390 maint_btrace_clear_cmd (const char *args, int from_tty)
3392 struct thread_info *tp;
3394 if (args != NULL && *args != 0)
3395 error (_("Invalid argument."));
3397 tp = find_thread_ptid (inferior_ptid);
3399 error (_("No thread."));
3404 /* The "maintenance btrace" command. */
3407 maint_btrace_cmd (const char *args, int from_tty)
3409 help_list (maint_btrace_cmdlist, "maintenance btrace ", all_commands,
3413 /* The "maintenance set btrace" command. */
3416 maint_btrace_set_cmd (const char *args, int from_tty)
3418 help_list (maint_btrace_set_cmdlist, "maintenance set btrace ", all_commands,
3422 /* The "maintenance show btrace" command. */
3425 maint_btrace_show_cmd (const char *args, int from_tty)
3427 help_list (maint_btrace_show_cmdlist, "maintenance show btrace ",
3428 all_commands, gdb_stdout);
3431 /* The "maintenance set btrace pt" command. */
3434 maint_btrace_pt_set_cmd (const char *args, int from_tty)
3436 help_list (maint_btrace_pt_set_cmdlist, "maintenance set btrace pt ",
3437 all_commands, gdb_stdout);
3440 /* The "maintenance show btrace pt" command. */
3443 maint_btrace_pt_show_cmd (const char *args, int from_tty)
3445 help_list (maint_btrace_pt_show_cmdlist, "maintenance show btrace pt ",
3446 all_commands, gdb_stdout);
3449 /* The "maintenance info btrace" command. */
3452 maint_info_btrace_cmd (const char *args, int from_tty)
3454 struct btrace_thread_info *btinfo;
3455 struct thread_info *tp;
3456 const struct btrace_config *conf;
3458 if (args != NULL && *args != 0)
3459 error (_("Invalid argument."));
3461 tp = find_thread_ptid (inferior_ptid);
3463 error (_("No thread."));
3465 btinfo = &tp->btrace;
3467 conf = btrace_conf (btinfo);
3469 error (_("No btrace configuration."));
3471 printf_unfiltered (_("Format: %s.\n"),
3472 btrace_format_string (conf->format));
3474 switch (conf->format)
3479 case BTRACE_FORMAT_BTS:
3480 printf_unfiltered (_("Number of packets: %u.\n"),
3481 VEC_length (btrace_block_s,
3482 btinfo->data.variant.bts.blocks));
3485 #if defined (HAVE_LIBIPT)
3486 case BTRACE_FORMAT_PT:
3488 struct pt_version version;
3490 version = pt_library_version ();
3491 printf_unfiltered (_("Version: %u.%u.%u%s.\n"), version.major,
3492 version.minor, version.build,
3493 version.ext != NULL ? version.ext : "");
3495 btrace_maint_update_pt_packets (btinfo);
3496 printf_unfiltered (_("Number of packets: %u.\n"),
3497 VEC_length (btrace_pt_packet_s,
3498 btinfo->maint.variant.pt.packets));
3501 #endif /* defined (HAVE_LIBIPT) */
3505 /* The "maint show btrace pt skip-pad" show value function. */
3508 show_maint_btrace_pt_skip_pad (struct ui_file *file, int from_tty,
3509 struct cmd_list_element *c,
3512 fprintf_filtered (file, _("Skip PAD packets is %s.\n"), value);
3516 /* Initialize btrace maintenance commands. */
3519 _initialize_btrace (void)
3521 add_cmd ("btrace", class_maintenance, maint_info_btrace_cmd,
3522 _("Info about branch tracing data."), &maintenanceinfolist);
3524 add_prefix_cmd ("btrace", class_maintenance, maint_btrace_cmd,
3525 _("Branch tracing maintenance commands."),
3526 &maint_btrace_cmdlist, "maintenance btrace ",
3527 0, &maintenancelist);
3529 add_prefix_cmd ("btrace", class_maintenance, maint_btrace_set_cmd, _("\
3530 Set branch tracing specific variables."),
3531 &maint_btrace_set_cmdlist, "maintenance set btrace ",
3532 0, &maintenance_set_cmdlist);
3534 add_prefix_cmd ("pt", class_maintenance, maint_btrace_pt_set_cmd, _("\
3535 Set Intel Processor Trace specific variables."),
3536 &maint_btrace_pt_set_cmdlist, "maintenance set btrace pt ",
3537 0, &maint_btrace_set_cmdlist);
3539 add_prefix_cmd ("btrace", class_maintenance, maint_btrace_show_cmd, _("\
3540 Show branch tracing specific variables."),
3541 &maint_btrace_show_cmdlist, "maintenance show btrace ",
3542 0, &maintenance_show_cmdlist);
3544 add_prefix_cmd ("pt", class_maintenance, maint_btrace_pt_show_cmd, _("\
3545 Show Intel Processor Trace specific variables."),
3546 &maint_btrace_pt_show_cmdlist, "maintenance show btrace pt ",
3547 0, &maint_btrace_show_cmdlist);
3549 add_setshow_boolean_cmd ("skip-pad", class_maintenance,
3550 &maint_btrace_pt_skip_pad, _("\
3551 Set whether PAD packets should be skipped in the btrace packet history."), _("\
3552 Show whether PAD packets should be skipped in the btrace packet history."),_("\
3553 When enabled, PAD packets are ignored in the btrace packet history."),
3554 NULL, show_maint_btrace_pt_skip_pad,
3555 &maint_btrace_pt_set_cmdlist,
3556 &maint_btrace_pt_show_cmdlist);
3558 add_cmd ("packet-history", class_maintenance, maint_btrace_packet_history_cmd,
3559 _("Print the raw branch tracing data.\n\
3560 With no argument, print ten more packets after the previous ten-line print.\n\
3561 With '-' as argument print ten packets before a previous ten-line print.\n\
3562 One argument specifies the starting packet of a ten-line print.\n\
3563 Two arguments with comma between specify starting and ending packets to \
3565 Preceded with '+'/'-' the second argument specifies the distance from the \
3567 &maint_btrace_cmdlist);
3569 add_cmd ("clear-packet-history", class_maintenance,
3570 maint_btrace_clear_packet_history_cmd,
3571 _("Clears the branch tracing packet history.\n\
3572 Discards the raw branch tracing data but not the execution history data.\n\
3574 &maint_btrace_cmdlist);
3576 add_cmd ("clear", class_maintenance, maint_btrace_clear_cmd,
3577 _("Clears the branch tracing data.\n\
3578 Discards the raw branch tracing data and the execution history data.\n\
3579 The next 'record' command will fetch the branch tracing data anew.\n\
3581 &maint_btrace_cmdlist);