Automatic date update in version.in
[binutils-gdb.git] / gdbserver / tracepoint.cc
blob5459dc34cbb5527376cf9ee68822db7a39a2ed60
1 /* Tracepoint code for remote server for GDB.
2 Copyright (C) 2009-2022 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU 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, see <http://www.gnu.org/licenses/>. */
19 #include "server.h"
20 #include "tracepoint.h"
21 #include "gdbthread.h"
22 #include "gdbsupport/rsp-low.h"
24 #include <ctype.h>
25 #include <fcntl.h>
26 #include <unistd.h>
27 #include <chrono>
28 #include <inttypes.h>
29 #include "ax.h"
30 #include "tdesc.h"
32 #define IPA_SYM_STRUCT_NAME ipa_sym_addresses
33 #include "gdbsupport/agent.h"
35 #define DEFAULT_TRACE_BUFFER_SIZE 5242880 /* 5*1024*1024 */
37 /* This file is built for both GDBserver, and the in-process
38 agent (IPA), a shared library that includes a tracing agent that is
39 loaded by the inferior to support fast tracepoints. Fast
40 tracepoints (or more accurately, jump based tracepoints) are
41 implemented by patching the tracepoint location with a jump into a
42 small trampoline function whose job is to save the register state,
43 call the in-process tracing agent, and then execute the original
44 instruction that was under the tracepoint jump (possibly adjusted,
45 if PC-relative, or some such).
47 The current synchronization design is pull based. That means,
48 GDBserver does most of the work, by peeking/poking at the inferior
49 agent's memory directly for downloading tracepoint and associated
50 objects, and for uploading trace frames. Whenever the IPA needs
51 something from GDBserver (trace buffer is full, tracing stopped for
52 some reason, etc.) the IPA calls a corresponding hook function
53 where GDBserver has placed a breakpoint.
55 Each of the agents has its own trace buffer. When browsing the
56 trace frames built from slow and fast tracepoints from GDB (tfind
57 mode), there's no guarantee the user is seeing the trace frames in
58 strict chronological creation order, although, GDBserver tries to
59 keep the order relatively reasonable, by syncing the trace buffers
60 at appropriate times.
64 #ifdef IN_PROCESS_AGENT
66 static void trace_vdebug (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
68 static void
69 trace_vdebug (const char *fmt, ...)
71 char buf[1024];
72 va_list ap;
74 va_start (ap, fmt);
75 vsprintf (buf, fmt, ap);
76 fprintf (stderr, PROG "/tracepoint: %s\n", buf);
77 va_end (ap);
80 #define trace_debug(fmt, args...) \
81 do { \
82 if (debug_threads) \
83 trace_vdebug ((fmt), ##args); \
84 } while (0)
86 #else
88 #define trace_debug(fmt, args...) \
89 do { \
90 threads_debug_printf ((fmt), ##args); \
91 } while (0)
93 #endif
95 /* Prefix exported symbols, for good citizenship. All the symbols
96 that need exporting are defined in this module. Note that all
97 these symbols must be tagged with IP_AGENT_EXPORT_*. */
98 #ifdef IN_PROCESS_AGENT
99 # define gdb_tp_heap_buffer IPA_SYM_EXPORTED_NAME (gdb_tp_heap_buffer)
100 # define gdb_jump_pad_buffer IPA_SYM_EXPORTED_NAME (gdb_jump_pad_buffer)
101 # define gdb_jump_pad_buffer_end IPA_SYM_EXPORTED_NAME (gdb_jump_pad_buffer_end)
102 # define gdb_trampoline_buffer IPA_SYM_EXPORTED_NAME (gdb_trampoline_buffer)
103 # define gdb_trampoline_buffer_end IPA_SYM_EXPORTED_NAME (gdb_trampoline_buffer_end)
104 # define gdb_trampoline_buffer_error IPA_SYM_EXPORTED_NAME (gdb_trampoline_buffer_error)
105 # define collecting IPA_SYM_EXPORTED_NAME (collecting)
106 # define gdb_collect_ptr IPA_SYM_EXPORTED_NAME (gdb_collect_ptr)
107 # define stop_tracing IPA_SYM_EXPORTED_NAME (stop_tracing)
108 # define flush_trace_buffer IPA_SYM_EXPORTED_NAME (flush_trace_buffer)
109 # define about_to_request_buffer_space IPA_SYM_EXPORTED_NAME (about_to_request_buffer_space)
110 # define trace_buffer_is_full IPA_SYM_EXPORTED_NAME (trace_buffer_is_full)
111 # define stopping_tracepoint IPA_SYM_EXPORTED_NAME (stopping_tracepoint)
112 # define expr_eval_result IPA_SYM_EXPORTED_NAME (expr_eval_result)
113 # define error_tracepoint IPA_SYM_EXPORTED_NAME (error_tracepoint)
114 # define tracepoints IPA_SYM_EXPORTED_NAME (tracepoints)
115 # define tracing IPA_SYM_EXPORTED_NAME (tracing)
116 # define trace_buffer_ctrl IPA_SYM_EXPORTED_NAME (trace_buffer_ctrl)
117 # define trace_buffer_ctrl_curr IPA_SYM_EXPORTED_NAME (trace_buffer_ctrl_curr)
118 # define trace_buffer_lo IPA_SYM_EXPORTED_NAME (trace_buffer_lo)
119 # define trace_buffer_hi IPA_SYM_EXPORTED_NAME (trace_buffer_hi)
120 # define traceframe_read_count IPA_SYM_EXPORTED_NAME (traceframe_read_count)
121 # define traceframe_write_count IPA_SYM_EXPORTED_NAME (traceframe_write_count)
122 # define traceframes_created IPA_SYM_EXPORTED_NAME (traceframes_created)
123 # define trace_state_variables IPA_SYM_EXPORTED_NAME (trace_state_variables)
124 # define get_raw_reg_ptr IPA_SYM_EXPORTED_NAME (get_raw_reg_ptr)
125 # define get_trace_state_variable_value_ptr \
126 IPA_SYM_EXPORTED_NAME (get_trace_state_variable_value_ptr)
127 # define set_trace_state_variable_value_ptr \
128 IPA_SYM_EXPORTED_NAME (set_trace_state_variable_value_ptr)
129 # define ust_loaded IPA_SYM_EXPORTED_NAME (ust_loaded)
130 # define helper_thread_id IPA_SYM_EXPORTED_NAME (helper_thread_id)
131 # define cmd_buf IPA_SYM_EXPORTED_NAME (cmd_buf)
132 # define ipa_tdesc_idx IPA_SYM_EXPORTED_NAME (ipa_tdesc_idx)
133 #endif
135 #ifndef IN_PROCESS_AGENT
137 /* Addresses of in-process agent's symbols GDBserver cares about. */
139 struct ipa_sym_addresses
141 CORE_ADDR addr_gdb_tp_heap_buffer;
142 CORE_ADDR addr_gdb_jump_pad_buffer;
143 CORE_ADDR addr_gdb_jump_pad_buffer_end;
144 CORE_ADDR addr_gdb_trampoline_buffer;
145 CORE_ADDR addr_gdb_trampoline_buffer_end;
146 CORE_ADDR addr_gdb_trampoline_buffer_error;
147 CORE_ADDR addr_collecting;
148 CORE_ADDR addr_gdb_collect_ptr;
149 CORE_ADDR addr_stop_tracing;
150 CORE_ADDR addr_flush_trace_buffer;
151 CORE_ADDR addr_about_to_request_buffer_space;
152 CORE_ADDR addr_trace_buffer_is_full;
153 CORE_ADDR addr_stopping_tracepoint;
154 CORE_ADDR addr_expr_eval_result;
155 CORE_ADDR addr_error_tracepoint;
156 CORE_ADDR addr_tracepoints;
157 CORE_ADDR addr_tracing;
158 CORE_ADDR addr_trace_buffer_ctrl;
159 CORE_ADDR addr_trace_buffer_ctrl_curr;
160 CORE_ADDR addr_trace_buffer_lo;
161 CORE_ADDR addr_trace_buffer_hi;
162 CORE_ADDR addr_traceframe_read_count;
163 CORE_ADDR addr_traceframe_write_count;
164 CORE_ADDR addr_traceframes_created;
165 CORE_ADDR addr_trace_state_variables;
166 CORE_ADDR addr_get_raw_reg_ptr;
167 CORE_ADDR addr_get_trace_state_variable_value_ptr;
168 CORE_ADDR addr_set_trace_state_variable_value_ptr;
169 CORE_ADDR addr_ust_loaded;
170 CORE_ADDR addr_ipa_tdesc_idx;
173 static struct
175 const char *name;
176 int offset;
177 } symbol_list[] = {
178 IPA_SYM(gdb_tp_heap_buffer),
179 IPA_SYM(gdb_jump_pad_buffer),
180 IPA_SYM(gdb_jump_pad_buffer_end),
181 IPA_SYM(gdb_trampoline_buffer),
182 IPA_SYM(gdb_trampoline_buffer_end),
183 IPA_SYM(gdb_trampoline_buffer_error),
184 IPA_SYM(collecting),
185 IPA_SYM(gdb_collect_ptr),
186 IPA_SYM(stop_tracing),
187 IPA_SYM(flush_trace_buffer),
188 IPA_SYM(about_to_request_buffer_space),
189 IPA_SYM(trace_buffer_is_full),
190 IPA_SYM(stopping_tracepoint),
191 IPA_SYM(expr_eval_result),
192 IPA_SYM(error_tracepoint),
193 IPA_SYM(tracepoints),
194 IPA_SYM(tracing),
195 IPA_SYM(trace_buffer_ctrl),
196 IPA_SYM(trace_buffer_ctrl_curr),
197 IPA_SYM(trace_buffer_lo),
198 IPA_SYM(trace_buffer_hi),
199 IPA_SYM(traceframe_read_count),
200 IPA_SYM(traceframe_write_count),
201 IPA_SYM(traceframes_created),
202 IPA_SYM(trace_state_variables),
203 IPA_SYM(get_raw_reg_ptr),
204 IPA_SYM(get_trace_state_variable_value_ptr),
205 IPA_SYM(set_trace_state_variable_value_ptr),
206 IPA_SYM(ust_loaded),
207 IPA_SYM(ipa_tdesc_idx),
210 static struct ipa_sym_addresses ipa_sym_addrs;
212 static int read_inferior_integer (CORE_ADDR symaddr, int *val);
214 /* Returns true if both the in-process agent library and the static
215 tracepoints libraries are loaded in the inferior, and agent has
216 capability on static tracepoints. */
218 static int
219 in_process_agent_supports_ust (void)
221 int loaded = 0;
223 if (!agent_loaded_p ())
225 warning ("In-process agent not loaded");
226 return 0;
229 if (agent_capability_check (AGENT_CAPA_STATIC_TRACE))
231 /* Agent understands static tracepoint, then check whether UST is in
232 fact loaded in the inferior. */
233 if (read_inferior_integer (ipa_sym_addrs.addr_ust_loaded, &loaded))
235 warning ("Error reading ust_loaded in lib");
236 return 0;
239 return loaded;
241 else
242 return 0;
245 static void
246 write_e_ipa_not_loaded (char *buffer)
248 sprintf (buffer,
249 "E.In-process agent library not loaded in process. "
250 "Fast and static tracepoints unavailable.");
253 /* Write an error to BUFFER indicating that UST isn't loaded in the
254 inferior. */
256 static void
257 write_e_ust_not_loaded (char *buffer)
259 #ifdef HAVE_UST
260 sprintf (buffer,
261 "E.UST library not loaded in process. "
262 "Static tracepoints unavailable.");
263 #else
264 sprintf (buffer, "E.GDBserver was built without static tracepoints support");
265 #endif
268 /* If the in-process agent library isn't loaded in the inferior, write
269 an error to BUFFER, and return 1. Otherwise, return 0. */
271 static int
272 maybe_write_ipa_not_loaded (char *buffer)
274 if (!agent_loaded_p ())
276 write_e_ipa_not_loaded (buffer);
277 return 1;
279 return 0;
282 /* If the in-process agent library and the ust (static tracepoints)
283 library aren't loaded in the inferior, write an error to BUFFER,
284 and return 1. Otherwise, return 0. */
286 static int
287 maybe_write_ipa_ust_not_loaded (char *buffer)
289 if (!agent_loaded_p ())
291 write_e_ipa_not_loaded (buffer);
292 return 1;
294 else if (!in_process_agent_supports_ust ())
296 write_e_ust_not_loaded (buffer);
297 return 1;
299 return 0;
302 /* Cache all future symbols that the tracepoints module might request.
303 We can not request symbols at arbitrary states in the remote
304 protocol, only when the client tells us that new symbols are
305 available. So when we load the in-process library, make sure to
306 check the entire list. */
308 void
309 tracepoint_look_up_symbols (void)
311 int i;
313 if (agent_loaded_p ())
314 return;
316 for (i = 0; i < sizeof (symbol_list) / sizeof (symbol_list[0]); i++)
318 CORE_ADDR *addrp =
319 (CORE_ADDR *) ((char *) &ipa_sym_addrs + symbol_list[i].offset);
321 if (look_up_one_symbol (symbol_list[i].name, addrp, 1) == 0)
323 threads_debug_printf ("symbol `%s' not found", symbol_list[i].name);
324 return;
328 agent_look_up_symbols (NULL);
331 #endif
333 /* GDBserver places a breakpoint on the IPA's version (which is a nop)
334 of the "stop_tracing" function. When this breakpoint is hit,
335 tracing stopped in the IPA for some reason. E.g., due to
336 tracepoint reaching the pass count, hitting conditional expression
337 evaluation error, etc.
339 The IPA's trace buffer is never in circular tracing mode: instead,
340 GDBserver's is, and whenever the in-process buffer fills, it calls
341 "flush_trace_buffer", which triggers an internal breakpoint.
342 GDBserver reacts to this breakpoint by pulling the meanwhile
343 collected data. Old frames discarding is always handled on the
344 GDBserver side. */
346 #ifdef IN_PROCESS_AGENT
348 read_inferior_memory (CORE_ADDR memaddr, unsigned char *myaddr, int len)
350 memcpy (myaddr, (void *) (uintptr_t) memaddr, len);
351 return 0;
354 /* Call this in the functions where GDBserver places a breakpoint, so
355 that the compiler doesn't try to be clever and skip calling the
356 function at all. This is necessary, even if we tell the compiler
357 to not inline said functions. */
359 #if defined(__GNUC__)
360 # define UNKNOWN_SIDE_EFFECTS() asm ("")
361 #else
362 # define UNKNOWN_SIDE_EFFECTS() do {} while (0)
363 #endif
365 /* This is needed for -Wmissing-declarations. */
366 IP_AGENT_EXPORT_FUNC void stop_tracing (void);
368 IP_AGENT_EXPORT_FUNC void
369 stop_tracing (void)
371 /* GDBserver places breakpoint here. */
372 UNKNOWN_SIDE_EFFECTS();
375 /* This is needed for -Wmissing-declarations. */
376 IP_AGENT_EXPORT_FUNC void flush_trace_buffer (void);
378 IP_AGENT_EXPORT_FUNC void
379 flush_trace_buffer (void)
381 /* GDBserver places breakpoint here. */
382 UNKNOWN_SIDE_EFFECTS();
385 #endif
387 #ifndef IN_PROCESS_AGENT
388 static int
389 tracepoint_handler (CORE_ADDR address)
391 trace_debug ("tracepoint_handler: tracepoint at 0x%s hit",
392 paddress (address));
393 return 0;
396 /* Breakpoint at "stop_tracing" in the inferior lib. */
397 static struct breakpoint *stop_tracing_bkpt;
398 static int stop_tracing_handler (CORE_ADDR);
400 /* Breakpoint at "flush_trace_buffer" in the inferior lib. */
401 static struct breakpoint *flush_trace_buffer_bkpt;
402 static int flush_trace_buffer_handler (CORE_ADDR);
404 static void download_trace_state_variables (void);
405 static void upload_fast_traceframes (void);
407 static int run_inferior_command (char *cmd, int len);
409 static int
410 read_inferior_integer (CORE_ADDR symaddr, int *val)
412 return read_inferior_memory (symaddr, (unsigned char *) val,
413 sizeof (*val));
416 struct tracepoint;
417 static int tracepoint_send_agent (struct tracepoint *tpoint);
419 static int
420 read_inferior_uinteger (CORE_ADDR symaddr, unsigned int *val)
422 return read_inferior_memory (symaddr, (unsigned char *) val,
423 sizeof (*val));
426 static int
427 read_inferior_data_pointer (CORE_ADDR symaddr, CORE_ADDR *val)
429 void *pval = (void *) (uintptr_t) val;
430 int ret;
432 ret = read_inferior_memory (symaddr, (unsigned char *) &pval, sizeof (pval));
433 *val = (uintptr_t) pval;
434 return ret;
437 static int
438 write_inferior_data_pointer (CORE_ADDR symaddr, CORE_ADDR val)
440 void *pval = (void *) (uintptr_t) val;
441 return target_write_memory (symaddr,
442 (unsigned char *) &pval, sizeof (pval));
445 static int
446 write_inferior_integer (CORE_ADDR symaddr, int val)
448 return target_write_memory (symaddr, (unsigned char *) &val, sizeof (val));
451 static int
452 write_inferior_int8 (CORE_ADDR symaddr, int8_t val)
454 return target_write_memory (symaddr, (unsigned char *) &val, sizeof (val));
457 static int
458 write_inferior_uinteger (CORE_ADDR symaddr, unsigned int val)
460 return target_write_memory (symaddr, (unsigned char *) &val, sizeof (val));
463 static CORE_ADDR target_malloc (ULONGEST size);
465 #define COPY_FIELD_TO_BUF(BUF, OBJ, FIELD) \
466 do { \
467 memcpy (BUF, &(OBJ)->FIELD, sizeof ((OBJ)->FIELD)); \
468 BUF += sizeof ((OBJ)->FIELD); \
469 } while (0)
471 #endif
473 /* Base action. Concrete actions inherit this. */
475 struct tracepoint_action
477 char type;
480 /* An 'M' (collect memory) action. */
481 struct collect_memory_action
483 struct tracepoint_action base;
485 ULONGEST addr;
486 ULONGEST len;
487 int32_t basereg;
490 /* An 'R' (collect registers) action. */
492 struct collect_registers_action
494 struct tracepoint_action base;
497 /* An 'X' (evaluate expression) action. */
499 struct eval_expr_action
501 struct tracepoint_action base;
503 struct agent_expr *expr;
506 /* An 'L' (collect static trace data) action. */
507 struct collect_static_trace_data_action
509 struct tracepoint_action base;
512 #ifndef IN_PROCESS_AGENT
513 static CORE_ADDR
514 m_tracepoint_action_download (const struct tracepoint_action *action)
516 CORE_ADDR ipa_action = target_malloc (sizeof (struct collect_memory_action));
518 target_write_memory (ipa_action, (unsigned char *) action,
519 sizeof (struct collect_memory_action));
521 return ipa_action;
523 static char *
524 m_tracepoint_action_send (char *buffer, const struct tracepoint_action *action)
526 struct collect_memory_action *maction
527 = (struct collect_memory_action *) action;
529 COPY_FIELD_TO_BUF (buffer, maction, addr);
530 COPY_FIELD_TO_BUF (buffer, maction, len);
531 COPY_FIELD_TO_BUF (buffer, maction, basereg);
533 return buffer;
536 static CORE_ADDR
537 r_tracepoint_action_download (const struct tracepoint_action *action)
539 CORE_ADDR ipa_action = target_malloc (sizeof (struct collect_registers_action));
541 target_write_memory (ipa_action, (unsigned char *) action,
542 sizeof (struct collect_registers_action));
544 return ipa_action;
547 static char *
548 r_tracepoint_action_send (char *buffer, const struct tracepoint_action *action)
550 return buffer;
553 static CORE_ADDR download_agent_expr (struct agent_expr *expr);
555 static CORE_ADDR
556 x_tracepoint_action_download (const struct tracepoint_action *action)
558 CORE_ADDR ipa_action = target_malloc (sizeof (struct eval_expr_action));
559 CORE_ADDR expr;
561 target_write_memory (ipa_action, (unsigned char *) action,
562 sizeof (struct eval_expr_action));
563 expr = download_agent_expr (((struct eval_expr_action *) action)->expr);
564 write_inferior_data_pointer (ipa_action
565 + offsetof (struct eval_expr_action, expr),
566 expr);
568 return ipa_action;
571 /* Copy agent expression AEXPR to buffer pointed by P. If AEXPR is NULL,
572 copy 0 to P. Return updated header of buffer. */
574 static char *
575 agent_expr_send (char *p, const struct agent_expr *aexpr)
577 /* Copy the length of condition first, and then copy its
578 content. */
579 if (aexpr == NULL)
581 memset (p, 0, 4);
582 p += 4;
584 else
586 memcpy (p, &aexpr->length, 4);
587 p +=4;
589 memcpy (p, aexpr->bytes, aexpr->length);
590 p += aexpr->length;
592 return p;
595 static char *
596 x_tracepoint_action_send ( char *buffer, const struct tracepoint_action *action)
598 struct eval_expr_action *eaction = (struct eval_expr_action *) action;
600 return agent_expr_send (buffer, eaction->expr);
603 static CORE_ADDR
604 l_tracepoint_action_download (const struct tracepoint_action *action)
606 CORE_ADDR ipa_action
607 = target_malloc (sizeof (struct collect_static_trace_data_action));
609 target_write_memory (ipa_action, (unsigned char *) action,
610 sizeof (struct collect_static_trace_data_action));
612 return ipa_action;
615 static char *
616 l_tracepoint_action_send (char *buffer, const struct tracepoint_action *action)
618 return buffer;
621 static char *
622 tracepoint_action_send (char *buffer, const struct tracepoint_action *action)
624 switch (action->type)
626 case 'M':
627 return m_tracepoint_action_send (buffer, action);
628 case 'R':
629 return r_tracepoint_action_send (buffer, action);
630 case 'X':
631 return x_tracepoint_action_send (buffer, action);
632 case 'L':
633 return l_tracepoint_action_send (buffer, action);
635 error ("Unknown trace action '%c'.", action->type);
638 static CORE_ADDR
639 tracepoint_action_download (const struct tracepoint_action *action)
641 switch (action->type)
643 case 'M':
644 return m_tracepoint_action_download (action);
645 case 'R':
646 return r_tracepoint_action_download (action);
647 case 'X':
648 return x_tracepoint_action_download (action);
649 case 'L':
650 return l_tracepoint_action_download (action);
652 error ("Unknown trace action '%c'.", action->type);
654 #endif
656 /* This structure describes a piece of the source-level definition of
657 the tracepoint. The contents are not interpreted by the target,
658 but preserved verbatim for uploading upon reconnection. */
660 struct source_string
662 /* The type of string, such as "cond" for a conditional. */
663 char *type;
665 /* The source-level string itself. For the sake of target
666 debugging, we store it in plaintext, even though it is always
667 transmitted in hex. */
668 char *str;
670 /* Link to the next one in the list. We link them in the order
671 received, in case some make up an ordered list of commands or
672 some such. */
673 struct source_string *next;
676 enum tracepoint_type
678 /* Trap based tracepoint. */
679 trap_tracepoint,
681 /* A fast tracepoint implemented with a jump instead of a trap. */
682 fast_tracepoint,
684 /* A static tracepoint, implemented by a program call into a tracing
685 library. */
686 static_tracepoint
689 struct tracepoint_hit_ctx;
691 typedef enum eval_result_type (*condfn) (unsigned char *,
692 ULONGEST *);
694 /* The definition of a tracepoint. */
696 /* Tracepoints may have multiple locations, each at a different
697 address. This can occur with optimizations, template
698 instantiation, etc. Since the locations may be in different
699 scopes, the conditions and actions may be different for each
700 location. Our target version of tracepoints is more like GDB's
701 notion of "breakpoint locations", but we have almost nothing that
702 is not per-location, so we bother having two kinds of objects. The
703 key consequence is that numbers are not unique, and that it takes
704 both number and address to identify a tracepoint uniquely. */
706 struct tracepoint
708 /* The number of the tracepoint, as specified by GDB. Several
709 tracepoint objects here may share a number. */
710 uint32_t number;
712 /* Address at which the tracepoint is supposed to trigger. Several
713 tracepoints may share an address. */
714 CORE_ADDR address;
716 /* Tracepoint type. */
717 enum tracepoint_type type;
719 /* True if the tracepoint is currently enabled. */
720 int8_t enabled;
722 /* The number of single steps that will be performed after each
723 tracepoint hit. */
724 uint64_t step_count;
726 /* The number of times the tracepoint may be hit before it will
727 terminate the entire tracing run. */
728 uint64_t pass_count;
730 /* Pointer to the agent expression that is the tracepoint's
731 conditional, or NULL if the tracepoint is unconditional. */
732 struct agent_expr *cond;
734 /* The list of actions to take when the tracepoint triggers. */
735 uint32_t numactions;
736 struct tracepoint_action **actions;
738 /* Count of the times we've hit this tracepoint during the run.
739 Note that while-stepping steps are not counted as "hits". */
740 uint64_t hit_count;
742 /* Cached sum of the sizes of traceframes created by this point. */
743 uint64_t traceframe_usage;
745 CORE_ADDR compiled_cond;
747 /* Link to the next tracepoint in the list. */
748 struct tracepoint *next;
750 #ifndef IN_PROCESS_AGENT
751 /* The list of actions to take when the tracepoint triggers, in
752 string/packet form. */
753 char **actions_str;
755 /* The collection of strings that describe the tracepoint as it was
756 entered into GDB. These are not used by the target, but are
757 reported back to GDB upon reconnection. */
758 struct source_string *source_strings;
760 /* The number of bytes displaced by fast tracepoints. It may subsume
761 multiple instructions, for multi-byte fast tracepoints. This
762 field is only valid for fast tracepoints. */
763 uint32_t orig_size;
765 /* Only for fast tracepoints. */
766 CORE_ADDR obj_addr_on_target;
768 /* Address range where the original instruction under a fast
769 tracepoint was relocated to. (_end is actually one byte past
770 the end). */
771 CORE_ADDR adjusted_insn_addr;
772 CORE_ADDR adjusted_insn_addr_end;
774 /* The address range of the piece of the jump pad buffer that was
775 assigned to this fast tracepoint. (_end is actually one byte
776 past the end).*/
777 CORE_ADDR jump_pad;
778 CORE_ADDR jump_pad_end;
780 /* The address range of the piece of the trampoline buffer that was
781 assigned to this fast tracepoint. (_end is actually one byte
782 past the end). */
783 CORE_ADDR trampoline;
784 CORE_ADDR trampoline_end;
786 /* The list of actions to take while in a stepping loop. These
787 fields are only valid for patch-based tracepoints. */
788 int num_step_actions;
789 struct tracepoint_action **step_actions;
790 /* Same, but in string/packet form. */
791 char **step_actions_str;
793 /* Handle returned by the breakpoint or tracepoint module when we
794 inserted the trap or jump, or hooked into a static tracepoint.
795 NULL if we haven't inserted it yet. */
796 void *handle;
797 #endif
801 #ifndef IN_PROCESS_AGENT
803 /* Given `while-stepping', a thread may be collecting data for more
804 than one tracepoint simultaneously. On the other hand, the same
805 tracepoint with a while-stepping action may be hit by more than one
806 thread simultaneously (but not quite, each thread could be handling
807 a different step). Each thread holds a list of these objects,
808 representing the current step of each while-stepping action being
809 collected. */
811 struct wstep_state
813 struct wstep_state *next;
815 /* The tracepoint number. */
816 int tp_number;
817 /* The tracepoint's address. */
818 CORE_ADDR tp_address;
820 /* The number of the current step in this 'while-stepping'
821 action. */
822 long current_step;
825 #endif
827 EXTERN_C_PUSH
829 /* The linked list of all tracepoints. Marked explicitly as used as
830 the in-process library doesn't use it for the fast tracepoints
831 support. */
832 IP_AGENT_EXPORT_VAR struct tracepoint *tracepoints;
834 /* The first tracepoint to exceed its pass count. */
836 IP_AGENT_EXPORT_VAR struct tracepoint *stopping_tracepoint;
838 /* True if the trace buffer is full or otherwise no longer usable. */
840 IP_AGENT_EXPORT_VAR int trace_buffer_is_full;
842 /* The first error that occurred during expression evaluation. */
844 /* Stored as an int to avoid the IPA ABI being dependent on whatever
845 the compiler decides to use for the enum's underlying type. Holds
846 enum eval_result_type values. */
847 IP_AGENT_EXPORT_VAR int expr_eval_result = expr_eval_no_error;
849 EXTERN_C_POP
851 #ifndef IN_PROCESS_AGENT
853 /* Pointer to the last tracepoint in the list, new tracepoints are
854 linked in at the end. */
856 static struct tracepoint *last_tracepoint;
858 static const char * const eval_result_names[] =
860 "terror:in the attic", /* this should never be reported */
861 "terror:empty expression",
862 "terror:empty stack",
863 "terror:stack overflow",
864 "terror:stack underflow",
865 "terror:unhandled opcode",
866 "terror:unrecognized opcode",
867 "terror:divide by zero"
870 #endif
872 /* The tracepoint in which the error occurred. */
874 EXTERN_C_PUSH
875 IP_AGENT_EXPORT_VAR struct tracepoint *error_tracepoint;
876 EXTERN_C_POP
878 struct trace_state_variable
880 /* This is the name of the variable as used in GDB. The target
881 doesn't use the name, but needs to have it for saving and
882 reconnection purposes. */
883 char *name;
885 /* This number identifies the variable uniquely. Numbers may be
886 assigned either by the target (in the case of builtin variables),
887 or by GDB, and are presumed unique during the course of a trace
888 experiment. */
889 int number;
891 /* The variable's initial value, a 64-bit signed integer always. */
892 LONGEST initial_value;
894 /* The variable's value, a 64-bit signed integer always. */
895 LONGEST value;
897 /* Pointer to a getter function, used to supply computed values. */
898 LONGEST (*getter) (void);
900 /* Link to the next variable. */
901 struct trace_state_variable *next;
904 /* Linked list of all trace state variables. */
906 #ifdef IN_PROCESS_AGENT
907 static struct trace_state_variable *alloced_trace_state_variables;
908 #endif
910 IP_AGENT_EXPORT_VAR struct trace_state_variable *trace_state_variables;
912 /* The results of tracing go into a fixed-size space known as the
913 "trace buffer". Because usage follows a limited number of
914 patterns, we manage it ourselves rather than with malloc. Basic
915 rules are that we create only one trace frame at a time, each is
916 variable in size, they are never moved once created, and we only
917 discard if we are doing a circular buffer, and then only the oldest
918 ones. Each trace frame includes its own size, so we don't need to
919 link them together, and the trace frame number is relative to the
920 first one, so we don't need to record numbers. A trace frame also
921 records the number of the tracepoint that created it. The data
922 itself is a series of blocks, each introduced by a single character
923 and with a defined format. Each type of block has enough
924 type/length info to allow scanners to jump quickly from one block
925 to the next without reading each byte in the block. */
927 /* Trace buffer management would be simple - advance a free pointer
928 from beginning to end, then stop - were it not for the circular
929 buffer option, which is a useful way to prevent a trace run from
930 stopping prematurely because the buffer filled up. In the circular
931 case, the location of the first trace frame (trace_buffer_start)
932 moves as old trace frames are discarded. Also, since we grow trace
933 frames incrementally as actions are performed, we wrap around to
934 the beginning of the trace buffer. This is per-block, so each
935 block within a trace frame remains contiguous. Things get messy
936 when the wrapped-around trace frame is the one being discarded; the
937 free space ends up in two parts at opposite ends of the buffer. */
939 #ifndef ATTR_PACKED
940 # if defined(__GNUC__)
941 # define ATTR_PACKED __attribute__ ((packed))
942 # else
943 # define ATTR_PACKED /* nothing */
944 # endif
945 #endif
947 /* The data collected at a tracepoint hit. This object should be as
948 small as possible, since there may be a great many of them. We do
949 not need to keep a frame number, because they are all sequential
950 and there are no deletions; so the Nth frame in the buffer is
951 always frame number N. */
953 struct traceframe
955 /* Number of the tracepoint that collected this traceframe. A value
956 of 0 indicates the current end of the trace buffer. We make this
957 a 16-bit field because it's never going to happen that GDB's
958 numbering of tracepoints reaches 32,000. */
959 int tpnum : 16;
961 /* The size of the data in this trace frame. We limit this to 32
962 bits, even on a 64-bit target, because it's just implausible that
963 one is validly going to collect 4 gigabytes of data at a single
964 tracepoint hit. */
965 unsigned int data_size : 32;
967 /* The base of the trace data, which is contiguous from this point. */
968 unsigned char data[0];
970 } ATTR_PACKED;
972 /* The size of the EOB marker, in bytes. A traceframe with zeroed
973 fields (and no data) marks the end of trace data. */
974 #define TRACEFRAME_EOB_MARKER_SIZE offsetof (struct traceframe, data)
976 /* This flag is true if the trace buffer is circular, meaning that
977 when it fills, the oldest trace frames are discarded in order to
978 make room. */
980 #ifndef IN_PROCESS_AGENT
981 static int circular_trace_buffer;
982 #endif
984 /* Size of the trace buffer. */
986 static LONGEST trace_buffer_size;
988 EXTERN_C_PUSH
990 /* Pointer to the block of memory that traceframes all go into. */
992 IP_AGENT_EXPORT_VAR unsigned char *trace_buffer_lo;
994 /* Pointer to the end of the trace buffer, more precisely to the byte
995 after the end of the buffer. */
997 IP_AGENT_EXPORT_VAR unsigned char *trace_buffer_hi;
999 EXTERN_C_POP
1001 /* Control structure holding the read/write/etc. pointers into the
1002 trace buffer. We need more than one of these to implement a
1003 transaction-like mechanism to guarantees that both GDBserver and the
1004 in-process agent can try to change the trace buffer
1005 simultaneously. */
1007 struct trace_buffer_control
1009 /* Pointer to the first trace frame in the buffer. In the
1010 non-circular case, this is equal to trace_buffer_lo, otherwise it
1011 moves around in the buffer. */
1012 unsigned char *start;
1014 /* Pointer to the free part of the trace buffer. Note that we clear
1015 several bytes at and after this pointer, so that traceframe
1016 scans/searches terminate properly. */
1017 unsigned char *free;
1019 /* Pointer to the byte after the end of the free part. Note that
1020 this may be smaller than trace_buffer_free in the circular case,
1021 and means that the free part is in two pieces. Initially it is
1022 equal to trace_buffer_hi, then is generally equivalent to
1023 trace_buffer_start. */
1024 unsigned char *end_free;
1026 /* Pointer to the wraparound. If not equal to trace_buffer_hi, then
1027 this is the point at which the trace data breaks, and resumes at
1028 trace_buffer_lo. */
1029 unsigned char *wrap;
1032 /* Same as above, to be used by GDBserver when updating the in-process
1033 agent. */
1034 struct ipa_trace_buffer_control
1036 uintptr_t start;
1037 uintptr_t free;
1038 uintptr_t end_free;
1039 uintptr_t wrap;
1043 /* We have possibly both GDBserver and an inferior thread accessing
1044 the same IPA trace buffer memory. The IPA is the producer (tries
1045 to put new frames in the buffer), while GDBserver occasionally
1046 consumes them, that is, flushes the IPA's buffer into its own
1047 buffer. Both sides need to update the trace buffer control
1048 pointers (current head, tail, etc.). We can't use a global lock to
1049 synchronize the accesses, as otherwise we could deadlock GDBserver
1050 (if the thread holding the lock stops for a signal, say). So
1051 instead of that, we use a transaction scheme where GDBserver writes
1052 always prevail over the IPAs writes, and, we have the IPA detect
1053 the commit failure/overwrite, and retry the whole attempt. This is
1054 mainly implemented by having a global token object that represents
1055 who wrote last to the buffer control structure. We need to freeze
1056 any inferior writing to the buffer while GDBserver touches memory,
1057 so that the inferior can correctly detect that GDBserver had been
1058 there, otherwise, it could mistakingly think its commit was
1059 successful; that's implemented by simply having GDBserver set a
1060 breakpoint the inferior hits if it is the critical region.
1062 There are three cycling trace buffer control structure copies
1063 (buffer head, tail, etc.), with the token object including an index
1064 indicating which is current live copy. The IPA tentatively builds
1065 an updated copy in a non-current control structure, while GDBserver
1066 always clobbers the current version directly. The IPA then tries
1067 to atomically "commit" its version; if GDBserver clobbered the
1068 structure meanwhile, that will fail, and the IPA restarts the
1069 allocation process.
1071 Listing the step in further detail, we have:
1073 In-process agent (producer):
1075 - passes by `about_to_request_buffer_space' breakpoint/lock
1077 - reads current token, extracts current trace buffer control index,
1078 and starts tentatively updating the rightmost one (0->1, 1->2,
1079 2->0). Note that only one inferior thread is executing this code
1080 at any given time, due to an outer lock in the jump pads.
1082 - updates counters, and tries to commit the token.
1084 - passes by second `about_to_request_buffer_space' breakpoint/lock,
1085 leaving the sync region.
1087 - checks if the update was effective.
1089 - if trace buffer was found full, hits flush_trace_buffer
1090 breakpoint, and restarts later afterwards.
1092 GDBserver (consumer):
1094 - sets `about_to_request_buffer_space' breakpoint/lock.
1096 - updates the token unconditionally, using the current buffer
1097 control index, since it knows that the IP agent always writes to
1098 the rightmost, and due to the breakpoint, at most one IP thread
1099 can try to update the trace buffer concurrently to GDBserver, so
1100 there will be no danger of trace buffer control index wrap making
1101 the IPA write to the same index as GDBserver.
1103 - flushes the IP agent's trace buffer completely, and updates the
1104 current trace buffer control structure. GDBserver *always* wins.
1106 - removes the `about_to_request_buffer_space' breakpoint.
1108 The token is stored in the `trace_buffer_ctrl_curr' variable.
1109 Internally, it's bits are defined as:
1111 |-------------+-----+-------------+--------+-------------+--------------|
1112 | Bit offsets | 31 | 30 - 20 | 19 | 18-8 | 7-0 |
1113 |-------------+-----+-------------+--------+-------------+--------------|
1114 | What | GSB | PC (11-bit) | unused | CC (11-bit) | TBCI (8-bit) |
1115 |-------------+-----+-------------+--------+-------------+--------------|
1117 GSB - GDBserver Stamp Bit
1118 PC - Previous Counter
1119 CC - Current Counter
1120 TBCI - Trace Buffer Control Index
1123 An IPA update of `trace_buffer_ctrl_curr' does:
1125 - read CC from the current token, save as PC.
1126 - updates pointers
1127 - atomically tries to write PC+1,CC
1129 A GDBserver update of `trace_buffer_ctrl_curr' does:
1131 - reads PC and CC from the current token.
1132 - updates pointers
1133 - writes GSB,PC,CC
1136 /* These are the bits of `trace_buffer_ctrl_curr' that are reserved
1137 for the counters described below. The cleared bits are used to
1138 hold the index of the items of the `trace_buffer_ctrl' array that
1139 is "current". */
1140 #define GDBSERVER_FLUSH_COUNT_MASK 0xfffffff0
1142 /* `trace_buffer_ctrl_curr' contains two counters. The `previous'
1143 counter, and the `current' counter. */
1145 #define GDBSERVER_FLUSH_COUNT_MASK_PREV 0x7ff00000
1146 #define GDBSERVER_FLUSH_COUNT_MASK_CURR 0x0007ff00
1148 /* When GDBserver update the IP agent's `trace_buffer_ctrl_curr', it
1149 always stamps this bit as set. */
1150 #define GDBSERVER_UPDATED_FLUSH_COUNT_BIT 0x80000000
1152 #ifdef IN_PROCESS_AGENT
1153 IP_AGENT_EXPORT_VAR struct trace_buffer_control trace_buffer_ctrl[3];
1154 IP_AGENT_EXPORT_VAR unsigned int trace_buffer_ctrl_curr;
1156 # define TRACE_BUFFER_CTRL_CURR \
1157 (trace_buffer_ctrl_curr & ~GDBSERVER_FLUSH_COUNT_MASK)
1159 #else
1161 /* The GDBserver side agent only needs one instance of this object, as
1162 it doesn't need to sync with itself. Define it as array anyway so
1163 that the rest of the code base doesn't need to care for the
1164 difference. */
1165 static trace_buffer_control trace_buffer_ctrl[1];
1166 # define TRACE_BUFFER_CTRL_CURR 0
1167 #endif
1169 /* These are convenience macros used to access the current trace
1170 buffer control in effect. */
1171 #define trace_buffer_start (trace_buffer_ctrl[TRACE_BUFFER_CTRL_CURR].start)
1172 #define trace_buffer_free (trace_buffer_ctrl[TRACE_BUFFER_CTRL_CURR].free)
1173 #define trace_buffer_end_free \
1174 (trace_buffer_ctrl[TRACE_BUFFER_CTRL_CURR].end_free)
1175 #define trace_buffer_wrap (trace_buffer_ctrl[TRACE_BUFFER_CTRL_CURR].wrap)
1178 /* Macro that returns a pointer to the first traceframe in the buffer. */
1180 #define FIRST_TRACEFRAME() ((struct traceframe *) trace_buffer_start)
1182 /* Macro that returns a pointer to the next traceframe in the buffer.
1183 If the computed location is beyond the wraparound point, subtract
1184 the offset of the wraparound. */
1186 #define NEXT_TRACEFRAME_1(TF) \
1187 (((unsigned char *) (TF)) + sizeof (struct traceframe) + (TF)->data_size)
1189 #define NEXT_TRACEFRAME(TF) \
1190 ((struct traceframe *) (NEXT_TRACEFRAME_1 (TF) \
1191 - ((NEXT_TRACEFRAME_1 (TF) >= trace_buffer_wrap) \
1192 ? (trace_buffer_wrap - trace_buffer_lo) \
1193 : 0)))
1195 /* The difference between these counters represents the total number
1196 of complete traceframes present in the trace buffer. The IP agent
1197 writes to the write count, GDBserver writes to read count. */
1199 IP_AGENT_EXPORT_VAR unsigned int traceframe_write_count;
1200 IP_AGENT_EXPORT_VAR unsigned int traceframe_read_count;
1202 /* Convenience macro. */
1204 #define traceframe_count \
1205 ((unsigned int) (traceframe_write_count - traceframe_read_count))
1207 /* The count of all traceframes created in the current run, including
1208 ones that were discarded to make room. */
1210 IP_AGENT_EXPORT_VAR int traceframes_created;
1212 #ifndef IN_PROCESS_AGENT
1214 /* Read-only regions are address ranges whose contents don't change,
1215 and so can be read from target memory even while looking at a trace
1216 frame. Without these, disassembly for instance will likely fail,
1217 because the program code is not usually collected into a trace
1218 frame. This data structure does not need to be very complicated or
1219 particularly efficient, it's only going to be used occasionally,
1220 and only by some commands. */
1222 struct readonly_region
1224 /* The bounds of the region. */
1225 CORE_ADDR start, end;
1227 /* Link to the next one. */
1228 struct readonly_region *next;
1231 /* Linked list of readonly regions. This list stays in effect from
1232 one tstart to the next. */
1234 static struct readonly_region *readonly_regions;
1236 #endif
1238 /* The global that controls tracing overall. */
1240 IP_AGENT_EXPORT_VAR int tracing;
1242 #ifndef IN_PROCESS_AGENT
1244 /* Controls whether tracing should continue after GDB disconnects. */
1246 int disconnected_tracing;
1248 /* The reason for the last tracing run to have stopped. We initialize
1249 to a distinct string so that GDB can distinguish between "stopped
1250 after running" and "stopped because never run" cases. */
1252 static const char *tracing_stop_reason = "tnotrun";
1254 static int tracing_stop_tpnum;
1256 /* 64-bit timestamps for the trace run's start and finish, expressed
1257 in microseconds from the Unix epoch. */
1259 static LONGEST tracing_start_time;
1260 static LONGEST tracing_stop_time;
1262 /* The (optional) user-supplied name of the user that started the run.
1263 This is an arbitrary string, and may be NULL. */
1265 static char *tracing_user_name;
1267 /* Optional user-supplied text describing the run. This is
1268 an arbitrary string, and may be NULL. */
1270 static char *tracing_notes;
1272 /* Optional user-supplied text explaining a tstop command. This is an
1273 arbitrary string, and may be NULL. */
1275 static char *tracing_stop_note;
1277 #endif
1279 /* Functions local to this file. */
1281 /* Base "class" for tracepoint type specific data to be passed down to
1282 collect_data_at_tracepoint. */
1283 struct tracepoint_hit_ctx
1285 enum tracepoint_type type;
1288 #ifdef IN_PROCESS_AGENT
1290 /* Fast/jump tracepoint specific data to be passed down to
1291 collect_data_at_tracepoint. */
1292 struct fast_tracepoint_ctx
1294 struct tracepoint_hit_ctx base;
1296 struct regcache regcache;
1297 int regcache_initted;
1298 unsigned char *regspace;
1300 unsigned char *regs;
1301 struct tracepoint *tpoint;
1304 /* Static tracepoint specific data to be passed down to
1305 collect_data_at_tracepoint. */
1306 struct static_tracepoint_ctx
1308 struct tracepoint_hit_ctx base;
1310 /* The regcache corresponding to the registers state at the time of
1311 the tracepoint hit. Initialized lazily, from REGS. */
1312 struct regcache regcache;
1313 int regcache_initted;
1315 /* The buffer space REGCACHE above uses. We use a separate buffer
1316 instead of letting the regcache malloc for both signal safety and
1317 performance reasons; this is allocated on the stack instead. */
1318 unsigned char *regspace;
1320 /* The register buffer as passed on by lttng/ust. */
1321 struct registers *regs;
1323 /* The "printf" formatter and the args the user passed to the marker
1324 call. We use this to be able to collect "static trace data"
1325 ($_sdata). */
1326 const char *fmt;
1327 va_list *args;
1329 /* The GDB tracepoint matching the probed marker that was "hit". */
1330 struct tracepoint *tpoint;
1333 #else
1335 /* Static tracepoint specific data to be passed down to
1336 collect_data_at_tracepoint. */
1337 struct trap_tracepoint_ctx
1339 struct tracepoint_hit_ctx base;
1341 struct regcache *regcache;
1344 #endif
1346 #ifndef IN_PROCESS_AGENT
1347 static CORE_ADDR traceframe_get_pc (struct traceframe *tframe);
1348 static int traceframe_read_tsv (int num, LONGEST *val);
1349 #endif
1351 static int condition_true_at_tracepoint (struct tracepoint_hit_ctx *ctx,
1352 struct tracepoint *tpoint);
1354 #ifndef IN_PROCESS_AGENT
1355 static void clear_readonly_regions (void);
1356 static void clear_installed_tracepoints (void);
1357 #endif
1359 static void collect_data_at_tracepoint (struct tracepoint_hit_ctx *ctx,
1360 CORE_ADDR stop_pc,
1361 struct tracepoint *tpoint);
1362 #ifndef IN_PROCESS_AGENT
1363 static void collect_data_at_step (struct tracepoint_hit_ctx *ctx,
1364 CORE_ADDR stop_pc,
1365 struct tracepoint *tpoint, int current_step);
1366 static void compile_tracepoint_condition (struct tracepoint *tpoint,
1367 CORE_ADDR *jump_entry);
1368 #endif
1369 static void do_action_at_tracepoint (struct tracepoint_hit_ctx *ctx,
1370 CORE_ADDR stop_pc,
1371 struct tracepoint *tpoint,
1372 struct traceframe *tframe,
1373 struct tracepoint_action *taction);
1375 #ifndef IN_PROCESS_AGENT
1376 static struct tracepoint *fast_tracepoint_from_ipa_tpoint_address (CORE_ADDR);
1378 static void install_tracepoint (struct tracepoint *, char *own_buf);
1379 static void download_tracepoint (struct tracepoint *);
1380 static int install_fast_tracepoint (struct tracepoint *, char *errbuf);
1381 static void clone_fast_tracepoint (struct tracepoint *to,
1382 const struct tracepoint *from);
1383 #endif
1385 static LONGEST get_timestamp (void);
1387 #if defined(__GNUC__)
1388 # define memory_barrier() asm volatile ("" : : : "memory")
1389 #else
1390 # define memory_barrier() do {} while (0)
1391 #endif
1393 /* We only build the IPA if this builtin is supported, and there are
1394 no uses of this in GDBserver itself, so we're safe in defining this
1395 unconditionally. */
1396 #define cmpxchg(mem, oldval, newval) \
1397 __sync_val_compare_and_swap (mem, oldval, newval)
1399 /* Record that an error occurred during expression evaluation. */
1401 static void
1402 record_tracepoint_error (struct tracepoint *tpoint, const char *which,
1403 enum eval_result_type rtype)
1405 trace_debug ("Tracepoint %d at %s %s eval reports error %d",
1406 tpoint->number, paddress (tpoint->address), which, rtype);
1408 #ifdef IN_PROCESS_AGENT
1409 /* Only record the first error we get. */
1410 if (cmpxchg (&expr_eval_result,
1411 expr_eval_no_error,
1412 rtype) != expr_eval_no_error)
1413 return;
1414 #else
1415 if (expr_eval_result != expr_eval_no_error)
1416 return;
1417 #endif
1419 error_tracepoint = tpoint;
1422 /* Trace buffer management. */
1424 static void
1425 clear_trace_buffer (void)
1427 trace_buffer_start = trace_buffer_lo;
1428 trace_buffer_free = trace_buffer_lo;
1429 trace_buffer_end_free = trace_buffer_hi;
1430 trace_buffer_wrap = trace_buffer_hi;
1431 /* A traceframe with zeroed fields marks the end of trace data. */
1432 ((struct traceframe *) trace_buffer_free)->tpnum = 0;
1433 ((struct traceframe *) trace_buffer_free)->data_size = 0;
1434 traceframe_read_count = traceframe_write_count = 0;
1435 traceframes_created = 0;
1438 #ifndef IN_PROCESS_AGENT
1440 static void
1441 clear_inferior_trace_buffer (void)
1443 CORE_ADDR ipa_trace_buffer_lo;
1444 CORE_ADDR ipa_trace_buffer_hi;
1445 struct traceframe ipa_traceframe = { 0 };
1446 struct ipa_trace_buffer_control ipa_trace_buffer_ctrl;
1448 read_inferior_data_pointer (ipa_sym_addrs.addr_trace_buffer_lo,
1449 &ipa_trace_buffer_lo);
1450 read_inferior_data_pointer (ipa_sym_addrs.addr_trace_buffer_hi,
1451 &ipa_trace_buffer_hi);
1453 ipa_trace_buffer_ctrl.start = ipa_trace_buffer_lo;
1454 ipa_trace_buffer_ctrl.free = ipa_trace_buffer_lo;
1455 ipa_trace_buffer_ctrl.end_free = ipa_trace_buffer_hi;
1456 ipa_trace_buffer_ctrl.wrap = ipa_trace_buffer_hi;
1458 /* A traceframe with zeroed fields marks the end of trace data. */
1459 target_write_memory (ipa_sym_addrs.addr_trace_buffer_ctrl,
1460 (unsigned char *) &ipa_trace_buffer_ctrl,
1461 sizeof (ipa_trace_buffer_ctrl));
1463 write_inferior_uinteger (ipa_sym_addrs.addr_trace_buffer_ctrl_curr, 0);
1465 /* A traceframe with zeroed fields marks the end of trace data. */
1466 target_write_memory (ipa_trace_buffer_lo,
1467 (unsigned char *) &ipa_traceframe,
1468 sizeof (ipa_traceframe));
1470 write_inferior_uinteger (ipa_sym_addrs.addr_traceframe_write_count, 0);
1471 write_inferior_uinteger (ipa_sym_addrs.addr_traceframe_read_count, 0);
1472 write_inferior_integer (ipa_sym_addrs.addr_traceframes_created, 0);
1475 #endif
1477 static void
1478 init_trace_buffer (LONGEST bufsize)
1480 size_t alloc_size;
1482 trace_buffer_size = bufsize;
1484 /* Make sure to internally allocate at least space for the EOB
1485 marker. */
1486 alloc_size = (bufsize < TRACEFRAME_EOB_MARKER_SIZE
1487 ? TRACEFRAME_EOB_MARKER_SIZE : bufsize);
1488 trace_buffer_lo = (unsigned char *) xrealloc (trace_buffer_lo, alloc_size);
1490 trace_buffer_hi = trace_buffer_lo + trace_buffer_size;
1492 clear_trace_buffer ();
1495 #ifdef IN_PROCESS_AGENT
1497 /* This is needed for -Wmissing-declarations. */
1498 IP_AGENT_EXPORT_FUNC void about_to_request_buffer_space (void);
1500 IP_AGENT_EXPORT_FUNC void
1501 about_to_request_buffer_space (void)
1503 /* GDBserver places breakpoint here while it goes about to flush
1504 data at random times. */
1505 UNKNOWN_SIDE_EFFECTS();
1508 #endif
1510 /* Carve out a piece of the trace buffer, returning NULL in case of
1511 failure. */
1513 static void *
1514 trace_buffer_alloc (size_t amt)
1516 unsigned char *rslt;
1517 struct trace_buffer_control *tbctrl;
1518 unsigned int curr;
1519 #ifdef IN_PROCESS_AGENT
1520 unsigned int prev, prev_filtered;
1521 unsigned int commit_count;
1522 unsigned int commit;
1523 unsigned int readout;
1524 #else
1525 struct traceframe *oldest;
1526 unsigned char *new_start;
1527 #endif
1529 trace_debug ("Want to allocate %ld+%ld bytes in trace buffer",
1530 (long) amt, (long) sizeof (struct traceframe));
1532 /* Account for the EOB marker. */
1533 amt += TRACEFRAME_EOB_MARKER_SIZE;
1535 #ifdef IN_PROCESS_AGENT
1536 again:
1537 memory_barrier ();
1539 /* Read the current token and extract the index to try to write to,
1540 storing it in CURR. */
1541 prev = trace_buffer_ctrl_curr;
1542 prev_filtered = prev & ~GDBSERVER_FLUSH_COUNT_MASK;
1543 curr = prev_filtered + 1;
1544 if (curr > 2)
1545 curr = 0;
1547 about_to_request_buffer_space ();
1549 /* Start out with a copy of the current state. GDBserver may be
1550 midway writing to the PREV_FILTERED TBC, but, that's OK, we won't
1551 be able to commit anyway if that happens. */
1552 trace_buffer_ctrl[curr]
1553 = trace_buffer_ctrl[prev_filtered];
1554 trace_debug ("trying curr=%u", curr);
1555 #else
1556 /* The GDBserver's agent doesn't need all that syncing, and always
1557 updates TCB 0 (there's only one, mind you). */
1558 curr = 0;
1559 #endif
1560 tbctrl = &trace_buffer_ctrl[curr];
1562 /* Offsets are easier to grok for debugging than raw addresses,
1563 especially for the small trace buffer sizes that are useful for
1564 testing. */
1565 trace_debug ("Trace buffer [%d] start=%d free=%d endfree=%d wrap=%d hi=%d",
1566 curr,
1567 (int) (tbctrl->start - trace_buffer_lo),
1568 (int) (tbctrl->free - trace_buffer_lo),
1569 (int) (tbctrl->end_free - trace_buffer_lo),
1570 (int) (tbctrl->wrap - trace_buffer_lo),
1571 (int) (trace_buffer_hi - trace_buffer_lo));
1573 /* The algorithm here is to keep trying to get a contiguous block of
1574 the requested size, possibly discarding older traceframes to free
1575 up space. Since free space might come in one or two pieces,
1576 depending on whether discarded traceframes wrapped around at the
1577 high end of the buffer, we test both pieces after each
1578 discard. */
1579 while (1)
1581 /* First, if we have two free parts, try the upper one first. */
1582 if (tbctrl->end_free < tbctrl->free)
1584 if (tbctrl->free + amt <= trace_buffer_hi)
1585 /* We have enough in the upper part. */
1586 break;
1587 else
1589 /* Our high part of free space wasn't enough. Give up
1590 on it for now, set wraparound. We will recover the
1591 space later, if/when the wrapped-around traceframe is
1592 discarded. */
1593 trace_debug ("Upper part too small, setting wraparound");
1594 tbctrl->wrap = tbctrl->free;
1595 tbctrl->free = trace_buffer_lo;
1599 /* The normal case. */
1600 if (tbctrl->free + amt <= tbctrl->end_free)
1601 break;
1603 #ifdef IN_PROCESS_AGENT
1604 /* The IP Agent's buffer is always circular. It isn't used
1605 currently, but `circular_trace_buffer' could represent
1606 GDBserver's mode. If we didn't find space, ask GDBserver to
1607 flush. */
1609 flush_trace_buffer ();
1610 memory_barrier ();
1611 if (tracing)
1613 trace_debug ("gdbserver flushed buffer, retrying");
1614 goto again;
1617 /* GDBserver cancelled the tracing. Bail out as well. */
1618 return NULL;
1619 #else
1620 /* If we're here, then neither part is big enough, and
1621 non-circular trace buffers are now full. */
1622 if (!circular_trace_buffer)
1624 trace_debug ("Not enough space in the trace buffer");
1625 return NULL;
1628 trace_debug ("Need more space in the trace buffer");
1630 /* If we have a circular buffer, we can try discarding the
1631 oldest traceframe and see if that helps. */
1632 oldest = FIRST_TRACEFRAME ();
1633 if (oldest->tpnum == 0)
1635 /* Not good; we have no traceframes to free. Perhaps we're
1636 asking for a block that is larger than the buffer? In
1637 any case, give up. */
1638 trace_debug ("No traceframes to discard");
1639 return NULL;
1642 /* We don't run this code in the in-process agent currently.
1643 E.g., we could leave the in-process agent in autonomous
1644 circular mode if we only have fast tracepoints. If we do
1645 that, then this bit becomes racy with GDBserver, which also
1646 writes to this counter. */
1647 --traceframe_write_count;
1649 new_start = (unsigned char *) NEXT_TRACEFRAME (oldest);
1650 /* If we freed the traceframe that wrapped around, go back
1651 to the non-wrap case. */
1652 if (new_start < tbctrl->start)
1654 trace_debug ("Discarding past the wraparound");
1655 tbctrl->wrap = trace_buffer_hi;
1657 tbctrl->start = new_start;
1658 tbctrl->end_free = tbctrl->start;
1660 trace_debug ("Discarded a traceframe\n"
1661 "Trace buffer [%d], start=%d free=%d "
1662 "endfree=%d wrap=%d hi=%d",
1663 curr,
1664 (int) (tbctrl->start - trace_buffer_lo),
1665 (int) (tbctrl->free - trace_buffer_lo),
1666 (int) (tbctrl->end_free - trace_buffer_lo),
1667 (int) (tbctrl->wrap - trace_buffer_lo),
1668 (int) (trace_buffer_hi - trace_buffer_lo));
1670 /* Now go back around the loop. The discard might have resulted
1671 in either one or two pieces of free space, so we want to try
1672 both before freeing any more traceframes. */
1673 #endif
1676 /* If we get here, we know we can provide the asked-for space. */
1678 rslt = tbctrl->free;
1680 /* Adjust the request back down, now that we know we have space for
1681 the marker, but don't commit to AMT yet, we may still need to
1682 restart the operation if GDBserver touches the trace buffer
1683 (obviously only important in the in-process agent's version). */
1684 tbctrl->free += (amt - sizeof (struct traceframe));
1686 /* Or not. If GDBserver changed the trace buffer behind our back,
1687 we get to restart a new allocation attempt. */
1689 #ifdef IN_PROCESS_AGENT
1690 /* Build the tentative token. */
1691 commit_count = (((prev & GDBSERVER_FLUSH_COUNT_MASK_CURR) + 0x100)
1692 & GDBSERVER_FLUSH_COUNT_MASK_CURR);
1693 commit = (((prev & GDBSERVER_FLUSH_COUNT_MASK_CURR) << 12)
1694 | commit_count
1695 | curr);
1697 /* Try to commit it. */
1698 readout = cmpxchg (&trace_buffer_ctrl_curr, prev, commit);
1699 if (readout != prev)
1701 trace_debug ("GDBserver has touched the trace buffer, restarting."
1702 " (prev=%08x, commit=%08x, readout=%08x)",
1703 prev, commit, readout);
1704 goto again;
1707 /* Hold your horses here. Even if that change was committed,
1708 GDBserver could come in, and clobber it. We need to hold to be
1709 able to tell if GDBserver clobbers before or after we committed
1710 the change. Whenever GDBserver goes about touching the IPA
1711 buffer, it sets a breakpoint in this routine, so we have a sync
1712 point here. */
1713 about_to_request_buffer_space ();
1715 /* Check if the change has been effective, even if GDBserver stopped
1716 us at the breakpoint. */
1719 unsigned int refetch;
1721 memory_barrier ();
1723 refetch = trace_buffer_ctrl_curr;
1725 if (refetch == commit
1726 || ((refetch & GDBSERVER_FLUSH_COUNT_MASK_PREV) >> 12) == commit_count)
1728 /* effective */
1729 trace_debug ("change is effective: (prev=%08x, commit=%08x, "
1730 "readout=%08x, refetch=%08x)",
1731 prev, commit, readout, refetch);
1733 else
1735 trace_debug ("GDBserver has touched the trace buffer, not effective."
1736 " (prev=%08x, commit=%08x, readout=%08x, refetch=%08x)",
1737 prev, commit, readout, refetch);
1738 goto again;
1741 #endif
1743 /* We have a new piece of the trace buffer. Hurray! */
1745 /* Add an EOB marker just past this allocation. */
1746 ((struct traceframe *) tbctrl->free)->tpnum = 0;
1747 ((struct traceframe *) tbctrl->free)->data_size = 0;
1749 /* Adjust the request back down, now that we know we have space for
1750 the marker. */
1751 amt -= sizeof (struct traceframe);
1753 if (debug_threads)
1755 trace_debug ("Allocated %d bytes", (int) amt);
1756 trace_debug ("Trace buffer [%d] start=%d free=%d "
1757 "endfree=%d wrap=%d hi=%d",
1758 curr,
1759 (int) (tbctrl->start - trace_buffer_lo),
1760 (int) (tbctrl->free - trace_buffer_lo),
1761 (int) (tbctrl->end_free - trace_buffer_lo),
1762 (int) (tbctrl->wrap - trace_buffer_lo),
1763 (int) (trace_buffer_hi - trace_buffer_lo));
1766 return rslt;
1769 #ifndef IN_PROCESS_AGENT
1771 /* Return the total free space. This is not necessarily the largest
1772 block we can allocate, because of the two-part case. */
1774 static int
1775 free_space (void)
1777 if (trace_buffer_free <= trace_buffer_end_free)
1778 return trace_buffer_end_free - trace_buffer_free;
1779 else
1780 return ((trace_buffer_end_free - trace_buffer_lo)
1781 + (trace_buffer_hi - trace_buffer_free));
1784 /* An 'S' in continuation packets indicates remainder are for
1785 while-stepping. */
1787 static int seen_step_action_flag;
1789 /* Create a tracepoint (location) with given number and address. Add this
1790 new tracepoint to list and sort this list. */
1792 static struct tracepoint *
1793 add_tracepoint (int num, CORE_ADDR addr)
1795 struct tracepoint *tpoint, **tp_next;
1797 tpoint = XNEW (struct tracepoint);
1798 tpoint->number = num;
1799 tpoint->address = addr;
1800 tpoint->numactions = 0;
1801 tpoint->actions = NULL;
1802 tpoint->actions_str = NULL;
1803 tpoint->cond = NULL;
1804 tpoint->num_step_actions = 0;
1805 tpoint->step_actions = NULL;
1806 tpoint->step_actions_str = NULL;
1807 /* Start all off as regular (slow) tracepoints. */
1808 tpoint->type = trap_tracepoint;
1809 tpoint->orig_size = -1;
1810 tpoint->source_strings = NULL;
1811 tpoint->compiled_cond = 0;
1812 tpoint->handle = NULL;
1813 tpoint->next = NULL;
1815 /* Find a place to insert this tracepoint into list in order to keep
1816 the tracepoint list still in the ascending order. There may be
1817 multiple tracepoints at the same address as TPOINT's, and this
1818 guarantees TPOINT is inserted after all the tracepoints which are
1819 set at the same address. For example, fast tracepoints A, B, C are
1820 set at the same address, and D is to be insert at the same place as
1821 well,
1823 -->| A |--> | B |-->| C |->...
1825 One jump pad was created for tracepoint A, B, and C, and the target
1826 address of A is referenced/used in jump pad. So jump pad will let
1827 inferior jump to A. If D is inserted in front of A, like this,
1829 -->| D |-->| A |--> | B |-->| C |->...
1831 without updating jump pad, D is not reachable during collect, which
1832 is wrong. As we can see, the order of B, C and D doesn't matter, but
1833 A should always be the `first' one. */
1834 for (tp_next = &tracepoints;
1835 (*tp_next) != NULL && (*tp_next)->address <= tpoint->address;
1836 tp_next = &(*tp_next)->next)
1838 tpoint->next = *tp_next;
1839 *tp_next = tpoint;
1840 last_tracepoint = tpoint;
1842 seen_step_action_flag = 0;
1844 return tpoint;
1847 #ifndef IN_PROCESS_AGENT
1849 /* Return the tracepoint with the given number and address, or NULL. */
1851 static struct tracepoint *
1852 find_tracepoint (int id, CORE_ADDR addr)
1854 struct tracepoint *tpoint;
1856 for (tpoint = tracepoints; tpoint; tpoint = tpoint->next)
1857 if (tpoint->number == id && tpoint->address == addr)
1858 return tpoint;
1860 return NULL;
1863 /* Remove TPOINT from global list. */
1865 static void
1866 remove_tracepoint (struct tracepoint *tpoint)
1868 struct tracepoint *tp, *tp_prev;
1870 for (tp = tracepoints, tp_prev = NULL; tp && tp != tpoint;
1871 tp_prev = tp, tp = tp->next)
1874 if (tp)
1876 if (tp_prev)
1877 tp_prev->next = tp->next;
1878 else
1879 tracepoints = tp->next;
1881 xfree (tp);
1885 /* There may be several tracepoints with the same number (because they
1886 are "locations", in GDB parlance); return the next one after the
1887 given tracepoint, or search from the beginning of the list if the
1888 first argument is NULL. */
1890 static struct tracepoint *
1891 find_next_tracepoint_by_number (struct tracepoint *prev_tp, int num)
1893 struct tracepoint *tpoint;
1895 if (prev_tp)
1896 tpoint = prev_tp->next;
1897 else
1898 tpoint = tracepoints;
1899 for (; tpoint; tpoint = tpoint->next)
1900 if (tpoint->number == num)
1901 return tpoint;
1903 return NULL;
1906 #endif
1908 /* Append another action to perform when the tracepoint triggers. */
1910 static void
1911 add_tracepoint_action (struct tracepoint *tpoint, const char *packet)
1913 const char *act;
1915 if (*packet == 'S')
1917 seen_step_action_flag = 1;
1918 ++packet;
1921 act = packet;
1923 while (*act)
1925 const char *act_start = act;
1926 struct tracepoint_action *action = NULL;
1928 switch (*act)
1930 case 'M':
1932 struct collect_memory_action *maction =
1933 XNEW (struct collect_memory_action);
1934 ULONGEST basereg;
1935 int is_neg;
1937 maction->base.type = *act;
1938 action = &maction->base;
1940 ++act;
1941 is_neg = (*act == '-');
1942 if (*act == '-')
1943 ++act;
1944 act = unpack_varlen_hex (act, &basereg);
1945 ++act;
1946 act = unpack_varlen_hex (act, &maction->addr);
1947 ++act;
1948 act = unpack_varlen_hex (act, &maction->len);
1949 maction->basereg = (is_neg
1950 ? - (int) basereg
1951 : (int) basereg);
1952 trace_debug ("Want to collect %s bytes at 0x%s (basereg %d)",
1953 pulongest (maction->len),
1954 paddress (maction->addr), maction->basereg);
1955 break;
1957 case 'R':
1959 struct collect_registers_action *raction =
1960 XNEW (struct collect_registers_action);
1962 raction->base.type = *act;
1963 action = &raction->base;
1965 trace_debug ("Want to collect registers");
1966 ++act;
1967 /* skip past hex digits of mask for now */
1968 while (isxdigit(*act))
1969 ++act;
1970 break;
1972 case 'L':
1974 struct collect_static_trace_data_action *raction =
1975 XNEW (struct collect_static_trace_data_action);
1977 raction->base.type = *act;
1978 action = &raction->base;
1980 trace_debug ("Want to collect static trace data");
1981 ++act;
1982 break;
1984 case 'S':
1985 trace_debug ("Unexpected step action, ignoring");
1986 ++act;
1987 break;
1988 case 'X':
1990 struct eval_expr_action *xaction = XNEW (struct eval_expr_action);
1992 xaction->base.type = *act;
1993 action = &xaction->base;
1995 trace_debug ("Want to evaluate expression");
1996 xaction->expr = gdb_parse_agent_expr (&act);
1997 break;
1999 default:
2000 trace_debug ("unknown trace action '%c', ignoring...", *act);
2001 break;
2002 case '-':
2003 break;
2006 if (action == NULL)
2007 break;
2009 if (seen_step_action_flag)
2011 tpoint->num_step_actions++;
2013 tpoint->step_actions
2014 = XRESIZEVEC (struct tracepoint_action *, tpoint->step_actions,
2015 tpoint->num_step_actions);
2016 tpoint->step_actions_str
2017 = XRESIZEVEC (char *, tpoint->step_actions_str,
2018 tpoint->num_step_actions);
2019 tpoint->step_actions[tpoint->num_step_actions - 1] = action;
2020 tpoint->step_actions_str[tpoint->num_step_actions - 1]
2021 = savestring (act_start, act - act_start);
2023 else
2025 tpoint->numactions++;
2026 tpoint->actions
2027 = XRESIZEVEC (struct tracepoint_action *, tpoint->actions,
2028 tpoint->numactions);
2029 tpoint->actions_str
2030 = XRESIZEVEC (char *, tpoint->actions_str, tpoint->numactions);
2031 tpoint->actions[tpoint->numactions - 1] = action;
2032 tpoint->actions_str[tpoint->numactions - 1]
2033 = savestring (act_start, act - act_start);
2038 #endif
2040 /* Find or create a trace state variable with the given number. */
2042 static struct trace_state_variable *
2043 get_trace_state_variable (int num)
2045 struct trace_state_variable *tsv;
2047 #ifdef IN_PROCESS_AGENT
2048 /* Search for an existing variable. */
2049 for (tsv = alloced_trace_state_variables; tsv; tsv = tsv->next)
2050 if (tsv->number == num)
2051 return tsv;
2052 #endif
2054 /* Search for an existing variable. */
2055 for (tsv = trace_state_variables; tsv; tsv = tsv->next)
2056 if (tsv->number == num)
2057 return tsv;
2059 return NULL;
2062 /* Find or create a trace state variable with the given number. */
2064 static struct trace_state_variable *
2065 create_trace_state_variable (int num, int gdb)
2067 struct trace_state_variable *tsv;
2069 tsv = get_trace_state_variable (num);
2070 if (tsv != NULL)
2071 return tsv;
2073 /* Create a new variable. */
2074 tsv = XNEW (struct trace_state_variable);
2075 tsv->number = num;
2076 tsv->initial_value = 0;
2077 tsv->value = 0;
2078 tsv->getter = NULL;
2079 tsv->name = NULL;
2080 #ifdef IN_PROCESS_AGENT
2081 if (!gdb)
2083 tsv->next = alloced_trace_state_variables;
2084 alloced_trace_state_variables = tsv;
2086 else
2087 #endif
2089 tsv->next = trace_state_variables;
2090 trace_state_variables = tsv;
2092 return tsv;
2095 /* This is needed for -Wmissing-declarations. */
2096 IP_AGENT_EXPORT_FUNC LONGEST get_trace_state_variable_value (int num);
2098 IP_AGENT_EXPORT_FUNC LONGEST
2099 get_trace_state_variable_value (int num)
2101 struct trace_state_variable *tsv;
2103 tsv = get_trace_state_variable (num);
2105 if (!tsv)
2107 trace_debug ("No trace state variable %d, skipping value get", num);
2108 return 0;
2111 /* Call a getter function if we have one. While it's tempting to
2112 set up something to only call the getter once per tracepoint hit,
2113 it could run afoul of thread races. Better to let the getter
2114 handle it directly, if necessary to worry about it. */
2115 if (tsv->getter)
2116 tsv->value = (tsv->getter) ();
2118 trace_debug ("get_trace_state_variable_value(%d) ==> %s",
2119 num, plongest (tsv->value));
2121 return tsv->value;
2124 /* This is needed for -Wmissing-declarations. */
2125 IP_AGENT_EXPORT_FUNC void set_trace_state_variable_value (int num,
2126 LONGEST val);
2128 IP_AGENT_EXPORT_FUNC void
2129 set_trace_state_variable_value (int num, LONGEST val)
2131 struct trace_state_variable *tsv;
2133 tsv = get_trace_state_variable (num);
2135 if (!tsv)
2137 trace_debug ("No trace state variable %d, skipping value set", num);
2138 return;
2141 tsv->value = val;
2144 LONGEST
2145 agent_get_trace_state_variable_value (int num)
2147 return get_trace_state_variable_value (num);
2150 void
2151 agent_set_trace_state_variable_value (int num, LONGEST val)
2153 set_trace_state_variable_value (num, val);
2156 static void
2157 set_trace_state_variable_name (int num, const char *name)
2159 struct trace_state_variable *tsv;
2161 tsv = get_trace_state_variable (num);
2163 if (!tsv)
2165 trace_debug ("No trace state variable %d, skipping name set", num);
2166 return;
2169 tsv->name = (char *) name;
2172 static void
2173 set_trace_state_variable_getter (int num, LONGEST (*getter) (void))
2175 struct trace_state_variable *tsv;
2177 tsv = get_trace_state_variable (num);
2179 if (!tsv)
2181 trace_debug ("No trace state variable %d, skipping getter set", num);
2182 return;
2185 tsv->getter = getter;
2188 /* Add a raw traceframe for the given tracepoint. */
2190 static struct traceframe *
2191 add_traceframe (struct tracepoint *tpoint)
2193 struct traceframe *tframe;
2195 tframe
2196 = (struct traceframe *) trace_buffer_alloc (sizeof (struct traceframe));
2198 if (tframe == NULL)
2199 return NULL;
2201 tframe->tpnum = tpoint->number;
2202 tframe->data_size = 0;
2204 return tframe;
2207 /* Add a block to the traceframe currently being worked on. */
2209 static unsigned char *
2210 add_traceframe_block (struct traceframe *tframe,
2211 struct tracepoint *tpoint, int amt)
2213 unsigned char *block;
2215 if (!tframe)
2216 return NULL;
2218 block = (unsigned char *) trace_buffer_alloc (amt);
2220 if (!block)
2221 return NULL;
2223 gdb_assert (tframe->tpnum == tpoint->number);
2225 tframe->data_size += amt;
2226 tpoint->traceframe_usage += amt;
2228 return block;
2231 /* Flag that the current traceframe is finished. */
2233 static void
2234 finish_traceframe (struct traceframe *tframe)
2236 ++traceframe_write_count;
2237 ++traceframes_created;
2240 #ifndef IN_PROCESS_AGENT
2242 /* Given a traceframe number NUM, find the NUMth traceframe in the
2243 buffer. */
2245 static struct traceframe *
2246 find_traceframe (int num)
2248 struct traceframe *tframe;
2249 int tfnum = 0;
2251 for (tframe = FIRST_TRACEFRAME ();
2252 tframe->tpnum != 0;
2253 tframe = NEXT_TRACEFRAME (tframe))
2255 if (tfnum == num)
2256 return tframe;
2257 ++tfnum;
2260 return NULL;
2263 static CORE_ADDR
2264 get_traceframe_address (struct traceframe *tframe)
2266 CORE_ADDR addr;
2267 struct tracepoint *tpoint;
2269 addr = traceframe_get_pc (tframe);
2271 if (addr)
2272 return addr;
2274 /* Fallback strategy, will be incorrect for while-stepping frames
2275 and multi-location tracepoints. */
2276 tpoint = find_next_tracepoint_by_number (NULL, tframe->tpnum);
2277 return tpoint->address;
2280 /* Search for the next traceframe whose address is inside or outside
2281 the given range. */
2283 static struct traceframe *
2284 find_next_traceframe_in_range (CORE_ADDR lo, CORE_ADDR hi, int inside_p,
2285 int *tfnump)
2287 client_state &cs = get_client_state ();
2288 struct traceframe *tframe;
2289 CORE_ADDR tfaddr;
2291 *tfnump = cs.current_traceframe + 1;
2292 tframe = find_traceframe (*tfnump);
2293 /* The search is not supposed to wrap around. */
2294 if (!tframe)
2296 *tfnump = -1;
2297 return NULL;
2300 for (; tframe->tpnum != 0; tframe = NEXT_TRACEFRAME (tframe))
2302 tfaddr = get_traceframe_address (tframe);
2303 if (inside_p
2304 ? (lo <= tfaddr && tfaddr <= hi)
2305 : (lo > tfaddr || tfaddr > hi))
2306 return tframe;
2307 ++*tfnump;
2310 *tfnump = -1;
2311 return NULL;
2314 /* Search for the next traceframe recorded by the given tracepoint.
2315 Note that for multi-location tracepoints, this will find whatever
2316 location appears first. */
2318 static struct traceframe *
2319 find_next_traceframe_by_tracepoint (int num, int *tfnump)
2321 client_state &cs = get_client_state ();
2322 struct traceframe *tframe;
2324 *tfnump = cs.current_traceframe + 1;
2325 tframe = find_traceframe (*tfnump);
2326 /* The search is not supposed to wrap around. */
2327 if (!tframe)
2329 *tfnump = -1;
2330 return NULL;
2333 for (; tframe->tpnum != 0; tframe = NEXT_TRACEFRAME (tframe))
2335 if (tframe->tpnum == num)
2336 return tframe;
2337 ++*tfnump;
2340 *tfnump = -1;
2341 return NULL;
2344 #endif
2346 #ifndef IN_PROCESS_AGENT
2348 /* Clear all past trace state. */
2350 static void
2351 cmd_qtinit (char *packet)
2353 client_state &cs = get_client_state ();
2354 struct trace_state_variable *tsv, *prev, *next;
2356 /* Can't do this command without a pid attached. */
2357 if (current_thread == NULL)
2359 write_enn (packet);
2360 return;
2363 /* Make sure we don't try to read from a trace frame. */
2364 cs.current_traceframe = -1;
2366 stop_tracing ();
2368 trace_debug ("Initializing the trace");
2370 clear_installed_tracepoints ();
2371 clear_readonly_regions ();
2373 tracepoints = NULL;
2374 last_tracepoint = NULL;
2376 /* Clear out any leftover trace state variables. Ones with target
2377 defined getters should be kept however. */
2378 prev = NULL;
2379 tsv = trace_state_variables;
2380 while (tsv)
2382 trace_debug ("Looking at var %d", tsv->number);
2383 if (tsv->getter == NULL)
2385 next = tsv->next;
2386 if (prev)
2387 prev->next = next;
2388 else
2389 trace_state_variables = next;
2390 trace_debug ("Deleting var %d", tsv->number);
2391 free (tsv);
2392 tsv = next;
2394 else
2396 prev = tsv;
2397 tsv = tsv->next;
2401 clear_trace_buffer ();
2402 clear_inferior_trace_buffer ();
2404 write_ok (packet);
2407 /* Unprobe the UST marker at ADDRESS. */
2409 static void
2410 unprobe_marker_at (CORE_ADDR address)
2412 char cmd[IPA_CMD_BUF_SIZE];
2414 sprintf (cmd, "unprobe_marker_at:%s", paddress (address));
2415 run_inferior_command (cmd, strlen (cmd) + 1);
2418 /* Restore the program to its pre-tracing state. This routine may be called
2419 in error situations, so it needs to be careful about only restoring
2420 from known-valid bits. */
2422 static void
2423 clear_installed_tracepoints (void)
2425 struct tracepoint *tpoint;
2426 struct tracepoint *prev_stpoint;
2428 target_pause_all (true);
2430 prev_stpoint = NULL;
2432 /* Restore any bytes overwritten by tracepoints. */
2433 for (tpoint = tracepoints; tpoint; tpoint = tpoint->next)
2435 /* Catch the case where we might try to remove a tracepoint that
2436 was never actually installed. */
2437 if (tpoint->handle == NULL)
2439 trace_debug ("Tracepoint %d at 0x%s was "
2440 "never installed, nothing to clear",
2441 tpoint->number, paddress (tpoint->address));
2442 continue;
2445 switch (tpoint->type)
2447 case trap_tracepoint:
2449 struct breakpoint *bp
2450 = (struct breakpoint *) tpoint->handle;
2452 delete_breakpoint (bp);
2454 break;
2455 case fast_tracepoint:
2457 struct fast_tracepoint_jump *jump
2458 = (struct fast_tracepoint_jump *) tpoint->handle;
2460 delete_fast_tracepoint_jump (jump);
2462 break;
2463 case static_tracepoint:
2464 if (prev_stpoint != NULL
2465 && prev_stpoint->address == tpoint->address)
2466 /* Nothing to do. We already unprobed a tracepoint set at
2467 this marker address (and there can only be one probe
2468 per marker). */
2470 else
2472 unprobe_marker_at (tpoint->address);
2473 prev_stpoint = tpoint;
2475 break;
2478 tpoint->handle = NULL;
2481 target_unpause_all (true);
2484 /* Parse a packet that defines a tracepoint. */
2486 static void
2487 cmd_qtdp (char *own_buf)
2489 int tppacket;
2490 /* Whether there is a trailing hyphen at the end of the QTDP packet. */
2491 int trail_hyphen = 0;
2492 ULONGEST num;
2493 ULONGEST addr;
2494 ULONGEST count;
2495 struct tracepoint *tpoint;
2496 const char *packet = own_buf;
2498 packet += strlen ("QTDP:");
2500 /* A hyphen at the beginning marks a packet specifying actions for a
2501 tracepoint already supplied. */
2502 tppacket = 1;
2503 if (*packet == '-')
2505 tppacket = 0;
2506 ++packet;
2508 packet = unpack_varlen_hex (packet, &num);
2509 ++packet; /* skip a colon */
2510 packet = unpack_varlen_hex (packet, &addr);
2511 ++packet; /* skip a colon */
2513 /* See if we already have this tracepoint. */
2514 tpoint = find_tracepoint (num, addr);
2516 if (tppacket)
2518 /* Duplicate tracepoints are never allowed. */
2519 if (tpoint)
2521 trace_debug ("Tracepoint error: tracepoint %d"
2522 " at 0x%s already exists",
2523 (int) num, paddress (addr));
2524 write_enn (own_buf);
2525 return;
2528 tpoint = add_tracepoint (num, addr);
2530 tpoint->enabled = (*packet == 'E');
2531 ++packet; /* skip 'E' */
2532 ++packet; /* skip a colon */
2533 packet = unpack_varlen_hex (packet, &count);
2534 tpoint->step_count = count;
2535 ++packet; /* skip a colon */
2536 packet = unpack_varlen_hex (packet, &count);
2537 tpoint->pass_count = count;
2538 /* See if we have any of the additional optional fields. */
2539 while (*packet == ':')
2541 ++packet;
2542 if (*packet == 'F')
2544 tpoint->type = fast_tracepoint;
2545 ++packet;
2546 packet = unpack_varlen_hex (packet, &count);
2547 tpoint->orig_size = count;
2549 else if (*packet == 'S')
2551 tpoint->type = static_tracepoint;
2552 ++packet;
2554 else if (*packet == 'X')
2556 tpoint->cond = gdb_parse_agent_expr (&packet);
2558 else if (*packet == '-')
2559 break;
2560 else if (*packet == '\0')
2561 break;
2562 else
2563 trace_debug ("Unknown optional tracepoint field");
2565 if (*packet == '-')
2567 trail_hyphen = 1;
2568 trace_debug ("Also has actions\n");
2571 trace_debug ("Defined %stracepoint %d at 0x%s, "
2572 "enabled %d step %" PRIu64 " pass %" PRIu64,
2573 tpoint->type == fast_tracepoint ? "fast "
2574 : tpoint->type == static_tracepoint ? "static " : "",
2575 tpoint->number, paddress (tpoint->address), tpoint->enabled,
2576 tpoint->step_count, tpoint->pass_count);
2578 else if (tpoint)
2579 add_tracepoint_action (tpoint, packet);
2580 else
2582 trace_debug ("Tracepoint error: tracepoint %d at 0x%s not found",
2583 (int) num, paddress (addr));
2584 write_enn (own_buf);
2585 return;
2588 /* Install tracepoint during tracing only once for each tracepoint location.
2589 For each tracepoint loc, GDB may send multiple QTDP packets, and we can
2590 determine the last QTDP packet for one tracepoint location by checking
2591 trailing hyphen in QTDP packet. */
2592 if (tracing && !trail_hyphen)
2594 struct tracepoint *tp = NULL;
2596 /* Pause all threads temporarily while we patch tracepoints. */
2597 target_pause_all (false);
2599 /* download_tracepoint will update global `tracepoints'
2600 list, so it is unsafe to leave threads in jump pad. */
2601 target_stabilize_threads ();
2603 /* Freeze threads. */
2604 target_pause_all (true);
2607 if (tpoint->type != trap_tracepoint)
2609 /* Find another fast or static tracepoint at the same address. */
2610 for (tp = tracepoints; tp; tp = tp->next)
2612 if (tp->address == tpoint->address && tp->type == tpoint->type
2613 && tp->number != tpoint->number)
2614 break;
2617 /* TPOINT is installed at the same address as TP. */
2618 if (tp)
2620 if (tpoint->type == fast_tracepoint)
2621 clone_fast_tracepoint (tpoint, tp);
2622 else if (tpoint->type == static_tracepoint)
2623 tpoint->handle = (void *) -1;
2627 if (use_agent && tpoint->type == fast_tracepoint
2628 && agent_capability_check (AGENT_CAPA_FAST_TRACE))
2630 /* Download and install fast tracepoint by agent. */
2631 if (tracepoint_send_agent (tpoint) == 0)
2632 write_ok (own_buf);
2633 else
2635 write_enn (own_buf);
2636 remove_tracepoint (tpoint);
2639 else
2641 download_tracepoint (tpoint);
2643 if (tpoint->type == trap_tracepoint || tp == NULL)
2645 install_tracepoint (tpoint, own_buf);
2646 if (strcmp (own_buf, "OK") != 0)
2647 remove_tracepoint (tpoint);
2649 else
2650 write_ok (own_buf);
2653 target_unpause_all (true);
2654 return;
2657 write_ok (own_buf);
2660 static void
2661 cmd_qtdpsrc (char *own_buf)
2663 ULONGEST num, addr, start, slen;
2664 struct tracepoint *tpoint;
2665 const char *packet = own_buf;
2666 const char *saved;
2667 char *srctype, *src;
2668 size_t nbytes;
2669 struct source_string *last, *newlast;
2671 packet += strlen ("QTDPsrc:");
2673 packet = unpack_varlen_hex (packet, &num);
2674 ++packet; /* skip a colon */
2675 packet = unpack_varlen_hex (packet, &addr);
2676 ++packet; /* skip a colon */
2678 /* See if we already have this tracepoint. */
2679 tpoint = find_tracepoint (num, addr);
2681 if (!tpoint)
2683 trace_debug ("Tracepoint error: tracepoint %d at 0x%s not found",
2684 (int) num, paddress (addr));
2685 write_enn (own_buf);
2686 return;
2689 saved = packet;
2690 packet = strchr (packet, ':');
2691 srctype = (char *) xmalloc (packet - saved + 1);
2692 memcpy (srctype, saved, packet - saved);
2693 srctype[packet - saved] = '\0';
2694 ++packet;
2695 packet = unpack_varlen_hex (packet, &start);
2696 ++packet; /* skip a colon */
2697 packet = unpack_varlen_hex (packet, &slen);
2698 ++packet; /* skip a colon */
2699 src = (char *) xmalloc (slen + 1);
2700 nbytes = hex2bin (packet, (gdb_byte *) src, strlen (packet) / 2);
2701 src[nbytes] = '\0';
2703 newlast = XNEW (struct source_string);
2704 newlast->type = srctype;
2705 newlast->str = src;
2706 newlast->next = NULL;
2707 /* Always add a source string to the end of the list;
2708 this keeps sequences of actions/commands in the right
2709 order. */
2710 if (tpoint->source_strings)
2712 for (last = tpoint->source_strings; last->next; last = last->next)
2714 last->next = newlast;
2716 else
2717 tpoint->source_strings = newlast;
2719 write_ok (own_buf);
2722 static void
2723 cmd_qtdv (char *own_buf)
2725 ULONGEST num, val, builtin;
2726 char *varname;
2727 size_t nbytes;
2728 struct trace_state_variable *tsv;
2729 const char *packet = own_buf;
2731 packet += strlen ("QTDV:");
2733 packet = unpack_varlen_hex (packet, &num);
2734 ++packet; /* skip a colon */
2735 packet = unpack_varlen_hex (packet, &val);
2736 ++packet; /* skip a colon */
2737 packet = unpack_varlen_hex (packet, &builtin);
2738 ++packet; /* skip a colon */
2740 nbytes = strlen (packet) / 2;
2741 varname = (char *) xmalloc (nbytes + 1);
2742 nbytes = hex2bin (packet, (gdb_byte *) varname, nbytes);
2743 varname[nbytes] = '\0';
2745 tsv = create_trace_state_variable (num, 1);
2746 tsv->initial_value = (LONGEST) val;
2747 tsv->name = varname;
2749 set_trace_state_variable_value (num, (LONGEST) val);
2751 write_ok (own_buf);
2754 static void
2755 cmd_qtenable_disable (char *own_buf, int enable)
2757 const char *packet = own_buf;
2758 ULONGEST num, addr;
2759 struct tracepoint *tp;
2761 packet += strlen (enable ? "QTEnable:" : "QTDisable:");
2762 packet = unpack_varlen_hex (packet, &num);
2763 ++packet; /* skip a colon */
2764 packet = unpack_varlen_hex (packet, &addr);
2766 tp = find_tracepoint (num, addr);
2768 if (tp)
2770 if ((enable && tp->enabled) || (!enable && !tp->enabled))
2772 trace_debug ("Tracepoint %d at 0x%s is already %s",
2773 (int) num, paddress (addr),
2774 enable ? "enabled" : "disabled");
2775 write_ok (own_buf);
2776 return;
2779 trace_debug ("%s tracepoint %d at 0x%s",
2780 enable ? "Enabling" : "Disabling",
2781 (int) num, paddress (addr));
2783 tp->enabled = enable;
2785 if (tp->type == fast_tracepoint || tp->type == static_tracepoint)
2787 int ret;
2788 int offset = offsetof (struct tracepoint, enabled);
2789 CORE_ADDR obj_addr = tp->obj_addr_on_target + offset;
2791 ret = prepare_to_access_memory ();
2792 if (ret)
2794 trace_debug ("Failed to temporarily stop inferior threads");
2795 write_enn (own_buf);
2796 return;
2799 ret = write_inferior_int8 (obj_addr, enable);
2800 done_accessing_memory ();
2802 if (ret)
2804 trace_debug ("Cannot write enabled flag into "
2805 "inferior process memory");
2806 write_enn (own_buf);
2807 return;
2811 write_ok (own_buf);
2813 else
2815 trace_debug ("Tracepoint %d at 0x%s not found",
2816 (int) num, paddress (addr));
2817 write_enn (own_buf);
2821 static void
2822 cmd_qtv (char *own_buf)
2824 client_state &cs = get_client_state ();
2825 ULONGEST num;
2826 LONGEST val = 0;
2827 int err;
2828 char *packet = own_buf;
2830 packet += strlen ("qTV:");
2831 unpack_varlen_hex (packet, &num);
2833 if (cs.current_traceframe >= 0)
2835 err = traceframe_read_tsv ((int) num, &val);
2836 if (err)
2838 strcpy (own_buf, "U");
2839 return;
2842 /* Only make tsv's be undefined before the first trace run. After a
2843 trace run is over, the user might want to see the last value of
2844 the tsv, and it might not be available in a traceframe. */
2845 else if (!tracing && strcmp (tracing_stop_reason, "tnotrun") == 0)
2847 strcpy (own_buf, "U");
2848 return;
2850 else
2851 val = get_trace_state_variable_value (num);
2853 sprintf (own_buf, "V%s", phex_nz (val, 0));
2856 /* Clear out the list of readonly regions. */
2858 static void
2859 clear_readonly_regions (void)
2861 struct readonly_region *roreg;
2863 while (readonly_regions)
2865 roreg = readonly_regions;
2866 readonly_regions = readonly_regions->next;
2867 free (roreg);
2871 /* Parse the collection of address ranges whose contents GDB believes
2872 to be unchanging and so can be read directly from target memory
2873 even while looking at a traceframe. */
2875 static void
2876 cmd_qtro (char *own_buf)
2878 ULONGEST start, end;
2879 struct readonly_region *roreg;
2880 const char *packet = own_buf;
2882 trace_debug ("Want to mark readonly regions");
2884 clear_readonly_regions ();
2886 packet += strlen ("QTro");
2888 while (*packet == ':')
2890 ++packet; /* skip a colon */
2891 packet = unpack_varlen_hex (packet, &start);
2892 ++packet; /* skip a comma */
2893 packet = unpack_varlen_hex (packet, &end);
2895 roreg = XNEW (struct readonly_region);
2896 roreg->start = start;
2897 roreg->end = end;
2898 roreg->next = readonly_regions;
2899 readonly_regions = roreg;
2900 trace_debug ("Added readonly region from 0x%s to 0x%s",
2901 paddress (roreg->start), paddress (roreg->end));
2904 write_ok (own_buf);
2907 /* Test to see if the given range is in our list of readonly ranges.
2908 We only test for being entirely within a range, GDB is not going to
2909 send a single memory packet that spans multiple regions. */
2912 in_readonly_region (CORE_ADDR addr, ULONGEST length)
2914 struct readonly_region *roreg;
2916 for (roreg = readonly_regions; roreg; roreg = roreg->next)
2917 if (roreg->start <= addr && (addr + length - 1) <= roreg->end)
2918 return 1;
2920 return 0;
2923 static CORE_ADDR gdb_jump_pad_head;
2925 /* Return the address of the next free jump space. */
2927 static CORE_ADDR
2928 get_jump_space_head (void)
2930 if (gdb_jump_pad_head == 0)
2932 if (read_inferior_data_pointer (ipa_sym_addrs.addr_gdb_jump_pad_buffer,
2933 &gdb_jump_pad_head))
2935 internal_error (__FILE__, __LINE__,
2936 "error extracting jump_pad_buffer");
2940 return gdb_jump_pad_head;
2943 /* Reserve USED bytes from the jump space. */
2945 static void
2946 claim_jump_space (ULONGEST used)
2948 trace_debug ("claim_jump_space reserves %s bytes at %s",
2949 pulongest (used), paddress (gdb_jump_pad_head));
2950 gdb_jump_pad_head += used;
2953 static CORE_ADDR trampoline_buffer_head = 0;
2954 static CORE_ADDR trampoline_buffer_tail;
2956 /* Reserve USED bytes from the trampoline buffer and return the
2957 address of the start of the reserved space in TRAMPOLINE. Returns
2958 non-zero if the space is successfully claimed. */
2961 claim_trampoline_space (ULONGEST used, CORE_ADDR *trampoline)
2963 if (!trampoline_buffer_head)
2965 if (read_inferior_data_pointer (ipa_sym_addrs.addr_gdb_trampoline_buffer,
2966 &trampoline_buffer_tail))
2968 internal_error (__FILE__, __LINE__,
2969 "error extracting trampoline_buffer");
2972 if (read_inferior_data_pointer (ipa_sym_addrs.addr_gdb_trampoline_buffer_end,
2973 &trampoline_buffer_head))
2975 internal_error (__FILE__, __LINE__,
2976 "error extracting trampoline_buffer_end");
2980 /* Start claiming space from the top of the trampoline space. If
2981 the space is located at the bottom of the virtual address space,
2982 this reduces the possibility that corruption will occur if a null
2983 pointer is used to write to memory. */
2984 if (trampoline_buffer_head - trampoline_buffer_tail < used)
2986 trace_debug ("claim_trampoline_space failed to reserve %s bytes",
2987 pulongest (used));
2988 return 0;
2991 trampoline_buffer_head -= used;
2993 trace_debug ("claim_trampoline_space reserves %s bytes at %s",
2994 pulongest (used), paddress (trampoline_buffer_head));
2996 *trampoline = trampoline_buffer_head;
2997 return 1;
3000 /* Returns non-zero if there is space allocated for use in trampolines
3001 for fast tracepoints. */
3004 have_fast_tracepoint_trampoline_buffer (char *buf)
3006 CORE_ADDR trampoline_end, errbuf;
3008 if (read_inferior_data_pointer (ipa_sym_addrs.addr_gdb_trampoline_buffer_end,
3009 &trampoline_end))
3011 internal_error (__FILE__, __LINE__,
3012 "error extracting trampoline_buffer_end");
3015 if (buf)
3017 buf[0] = '\0';
3018 strcpy (buf, "was claiming");
3019 if (read_inferior_data_pointer (ipa_sym_addrs.addr_gdb_trampoline_buffer_error,
3020 &errbuf))
3022 internal_error (__FILE__, __LINE__,
3023 "error extracting errbuf");
3026 read_inferior_memory (errbuf, (unsigned char *) buf, 100);
3029 return trampoline_end != 0;
3032 /* Ask the IPA to probe the marker at ADDRESS. Returns -1 if running
3033 the command fails, or 0 otherwise. If the command ran
3034 successfully, but probing the marker failed, ERROUT will be filled
3035 with the error to reply to GDB, and -1 is also returned. This
3036 allows directly passing IPA errors to GDB. */
3038 static int
3039 probe_marker_at (CORE_ADDR address, char *errout)
3041 char cmd[IPA_CMD_BUF_SIZE];
3042 int err;
3044 sprintf (cmd, "probe_marker_at:%s", paddress (address));
3045 err = run_inferior_command (cmd, strlen (cmd) + 1);
3047 if (err == 0)
3049 if (*cmd == 'E')
3051 strcpy (errout, cmd);
3052 return -1;
3056 return err;
3059 static void
3060 clone_fast_tracepoint (struct tracepoint *to, const struct tracepoint *from)
3062 to->jump_pad = from->jump_pad;
3063 to->jump_pad_end = from->jump_pad_end;
3064 to->trampoline = from->trampoline;
3065 to->trampoline_end = from->trampoline_end;
3066 to->adjusted_insn_addr = from->adjusted_insn_addr;
3067 to->adjusted_insn_addr_end = from->adjusted_insn_addr_end;
3068 to->handle = from->handle;
3070 gdb_assert (from->handle);
3071 inc_ref_fast_tracepoint_jump ((struct fast_tracepoint_jump *) from->handle);
3074 #define MAX_JUMP_SIZE 20
3076 /* Install fast tracepoint. Return 0 if successful, otherwise return
3077 non-zero. */
3079 static int
3080 install_fast_tracepoint (struct tracepoint *tpoint, char *errbuf)
3082 CORE_ADDR jentry, jump_entry;
3083 CORE_ADDR trampoline;
3084 CORE_ADDR collect;
3085 ULONGEST trampoline_size;
3086 int err = 0;
3087 /* The jump to the jump pad of the last fast tracepoint
3088 installed. */
3089 unsigned char fjump[MAX_JUMP_SIZE];
3090 ULONGEST fjump_size;
3092 if (tpoint->orig_size < target_get_min_fast_tracepoint_insn_len ())
3094 trace_debug ("Requested a fast tracepoint on an instruction "
3095 "that is of less than the minimum length.");
3096 return 0;
3099 if (read_inferior_data_pointer (ipa_sym_addrs.addr_gdb_collect_ptr,
3100 &collect))
3102 error ("error extracting gdb_collect_ptr");
3103 return 1;
3106 jentry = jump_entry = get_jump_space_head ();
3108 trampoline = 0;
3109 trampoline_size = 0;
3111 /* Install the jump pad. */
3112 err = target_install_fast_tracepoint_jump_pad
3113 (tpoint->obj_addr_on_target, tpoint->address, collect,
3114 ipa_sym_addrs.addr_collecting, tpoint->orig_size, &jentry,
3115 &trampoline, &trampoline_size, fjump, &fjump_size,
3116 &tpoint->adjusted_insn_addr, &tpoint->adjusted_insn_addr_end, errbuf);
3118 if (err)
3119 return 1;
3121 /* Wire it in. */
3122 tpoint->handle = set_fast_tracepoint_jump (tpoint->address, fjump,
3123 fjump_size);
3125 if (tpoint->handle != NULL)
3127 tpoint->jump_pad = jump_entry;
3128 tpoint->jump_pad_end = jentry;
3129 tpoint->trampoline = trampoline;
3130 tpoint->trampoline_end = trampoline + trampoline_size;
3132 /* Pad to 8-byte alignment. */
3133 jentry = ((jentry + 7) & ~0x7);
3134 claim_jump_space (jentry - jump_entry);
3137 return 0;
3141 /* Install tracepoint TPOINT, and write reply message in OWN_BUF. */
3143 static void
3144 install_tracepoint (struct tracepoint *tpoint, char *own_buf)
3146 tpoint->handle = NULL;
3147 *own_buf = '\0';
3149 if (tpoint->type == trap_tracepoint)
3151 /* Tracepoints are installed as memory breakpoints. Just go
3152 ahead and install the trap. The breakpoints module
3153 handles duplicated breakpoints, and the memory read
3154 routine handles un-patching traps from memory reads. */
3155 tpoint->handle = set_breakpoint_at (tpoint->address,
3156 tracepoint_handler);
3158 else if (tpoint->type == fast_tracepoint || tpoint->type == static_tracepoint)
3160 if (!agent_loaded_p ())
3162 trace_debug ("Requested a %s tracepoint, but fast "
3163 "tracepoints aren't supported.",
3164 tpoint->type == static_tracepoint ? "static" : "fast");
3165 write_e_ipa_not_loaded (own_buf);
3166 return;
3168 if (tpoint->type == static_tracepoint
3169 && !in_process_agent_supports_ust ())
3171 trace_debug ("Requested a static tracepoint, but static "
3172 "tracepoints are not supported.");
3173 write_e_ust_not_loaded (own_buf);
3174 return;
3177 if (tpoint->type == fast_tracepoint)
3178 install_fast_tracepoint (tpoint, own_buf);
3179 else
3181 if (probe_marker_at (tpoint->address, own_buf) == 0)
3182 tpoint->handle = (void *) -1;
3186 else
3187 internal_error (__FILE__, __LINE__, "Unknown tracepoint type");
3189 if (tpoint->handle == NULL)
3191 if (*own_buf == '\0')
3192 write_enn (own_buf);
3194 else
3195 write_ok (own_buf);
3198 static void download_tracepoint_1 (struct tracepoint *tpoint);
3200 static void
3201 cmd_qtstart (char *packet)
3203 struct tracepoint *tpoint, *prev_ftpoint, *prev_stpoint;
3204 CORE_ADDR tpptr = 0, prev_tpptr = 0;
3206 trace_debug ("Starting the trace");
3208 /* Pause all threads temporarily while we patch tracepoints. */
3209 target_pause_all (false);
3211 /* Get threads out of jump pads. Safe to do here, since this is a
3212 top level command. And, required to do here, since we're
3213 deleting/rewriting jump pads. */
3215 target_stabilize_threads ();
3217 /* Freeze threads. */
3218 target_pause_all (true);
3220 /* Sync the fast tracepoints list in the inferior ftlib. */
3221 if (agent_loaded_p ())
3222 download_trace_state_variables ();
3224 /* No previous fast tpoint yet. */
3225 prev_ftpoint = NULL;
3227 /* No previous static tpoint yet. */
3228 prev_stpoint = NULL;
3230 *packet = '\0';
3232 if (agent_loaded_p ())
3234 /* Tell IPA about the correct tdesc. */
3235 if (write_inferior_integer (ipa_sym_addrs.addr_ipa_tdesc_idx,
3236 target_get_ipa_tdesc_idx ()))
3237 error ("Error setting ipa_tdesc_idx variable in lib");
3240 /* Start out empty. */
3241 if (agent_loaded_p ())
3242 write_inferior_data_pointer (ipa_sym_addrs.addr_tracepoints, 0);
3244 /* Download and install tracepoints. */
3245 for (tpoint = tracepoints; tpoint; tpoint = tpoint->next)
3247 /* Ensure all the hit counts start at zero. */
3248 tpoint->hit_count = 0;
3249 tpoint->traceframe_usage = 0;
3251 if (tpoint->type == trap_tracepoint)
3253 /* Tracepoints are installed as memory breakpoints. Just go
3254 ahead and install the trap. The breakpoints module
3255 handles duplicated breakpoints, and the memory read
3256 routine handles un-patching traps from memory reads. */
3257 tpoint->handle = set_breakpoint_at (tpoint->address,
3258 tracepoint_handler);
3260 else if (tpoint->type == fast_tracepoint
3261 || tpoint->type == static_tracepoint)
3263 if (maybe_write_ipa_not_loaded (packet))
3265 trace_debug ("Requested a %s tracepoint, but fast "
3266 "tracepoints aren't supported.",
3267 tpoint->type == static_tracepoint
3268 ? "static" : "fast");
3269 break;
3272 if (tpoint->type == fast_tracepoint)
3274 int use_agent_p
3275 = use_agent && agent_capability_check (AGENT_CAPA_FAST_TRACE);
3277 if (prev_ftpoint != NULL
3278 && prev_ftpoint->address == tpoint->address)
3280 if (use_agent_p)
3281 tracepoint_send_agent (tpoint);
3282 else
3283 download_tracepoint_1 (tpoint);
3285 clone_fast_tracepoint (tpoint, prev_ftpoint);
3287 else
3289 /* Tracepoint is installed successfully? */
3290 int installed = 0;
3292 /* Download and install fast tracepoint by agent. */
3293 if (use_agent_p)
3294 installed = !tracepoint_send_agent (tpoint);
3295 else
3297 download_tracepoint_1 (tpoint);
3298 installed = !install_fast_tracepoint (tpoint, packet);
3301 if (installed)
3302 prev_ftpoint = tpoint;
3305 else
3307 if (!in_process_agent_supports_ust ())
3309 trace_debug ("Requested a static tracepoint, but static "
3310 "tracepoints are not supported.");
3311 break;
3314 download_tracepoint_1 (tpoint);
3315 /* Can only probe a given marker once. */
3316 if (prev_stpoint != NULL
3317 && prev_stpoint->address == tpoint->address)
3318 tpoint->handle = (void *) -1;
3319 else
3321 if (probe_marker_at (tpoint->address, packet) == 0)
3323 tpoint->handle = (void *) -1;
3325 /* So that we can handle multiple static tracepoints
3326 at the same address easily. */
3327 prev_stpoint = tpoint;
3332 prev_tpptr = tpptr;
3333 tpptr = tpoint->obj_addr_on_target;
3335 if (tpoint == tracepoints)
3336 /* First object in list, set the head pointer in the
3337 inferior. */
3338 write_inferior_data_pointer (ipa_sym_addrs.addr_tracepoints, tpptr);
3339 else
3340 write_inferior_data_pointer (prev_tpptr
3341 + offsetof (struct tracepoint, next),
3342 tpptr);
3345 /* Any failure in the inner loop is sufficient cause to give
3346 up. */
3347 if (tpoint->handle == NULL)
3348 break;
3351 /* Any error in tracepoint insertion is unacceptable; better to
3352 address the problem now, than end up with a useless or misleading
3353 trace run. */
3354 if (tpoint != NULL)
3356 clear_installed_tracepoints ();
3357 if (*packet == '\0')
3358 write_enn (packet);
3359 target_unpause_all (true);
3360 return;
3363 stopping_tracepoint = NULL;
3364 trace_buffer_is_full = 0;
3365 expr_eval_result = expr_eval_no_error;
3366 error_tracepoint = NULL;
3367 tracing_start_time = get_timestamp ();
3369 /* Tracing is now active, hits will now start being logged. */
3370 tracing = 1;
3372 if (agent_loaded_p ())
3374 if (write_inferior_integer (ipa_sym_addrs.addr_tracing, 1))
3376 internal_error (__FILE__, __LINE__,
3377 "Error setting tracing variable in lib");
3380 if (write_inferior_data_pointer (ipa_sym_addrs.addr_stopping_tracepoint,
3383 internal_error (__FILE__, __LINE__,
3384 "Error clearing stopping_tracepoint variable"
3385 " in lib");
3388 if (write_inferior_integer (ipa_sym_addrs.addr_trace_buffer_is_full, 0))
3390 internal_error (__FILE__, __LINE__,
3391 "Error clearing trace_buffer_is_full variable"
3392 " in lib");
3395 stop_tracing_bkpt = set_breakpoint_at (ipa_sym_addrs.addr_stop_tracing,
3396 stop_tracing_handler);
3397 if (stop_tracing_bkpt == NULL)
3398 error ("Error setting stop_tracing breakpoint");
3400 flush_trace_buffer_bkpt
3401 = set_breakpoint_at (ipa_sym_addrs.addr_flush_trace_buffer,
3402 flush_trace_buffer_handler);
3403 if (flush_trace_buffer_bkpt == NULL)
3404 error ("Error setting flush_trace_buffer breakpoint");
3407 target_unpause_all (true);
3409 write_ok (packet);
3412 /* End a tracing run, filling in a stop reason to report back to GDB,
3413 and removing the tracepoints from the code. */
3415 void
3416 stop_tracing (void)
3418 if (!tracing)
3420 trace_debug ("Tracing is already off, ignoring");
3421 return;
3424 trace_debug ("Stopping the trace");
3426 /* Pause all threads before removing fast jumps from memory,
3427 breakpoints, and touching IPA state variables (inferior memory).
3428 Some thread may hit the internal tracing breakpoints, or be
3429 collecting this moment, but that's ok, we don't release the
3430 tpoint object's memory or the jump pads here (we only do that
3431 when we're sure we can move all threads out of the jump pads).
3432 We can't now, since we may be getting here due to the inferior
3433 agent calling us. */
3434 target_pause_all (true);
3436 /* Stop logging. Tracepoints can still be hit, but they will not be
3437 recorded. */
3438 tracing = 0;
3439 if (agent_loaded_p ())
3441 if (write_inferior_integer (ipa_sym_addrs.addr_tracing, 0))
3443 internal_error (__FILE__, __LINE__,
3444 "Error clearing tracing variable in lib");
3448 tracing_stop_time = get_timestamp ();
3449 tracing_stop_reason = "t???";
3450 tracing_stop_tpnum = 0;
3451 if (stopping_tracepoint)
3453 trace_debug ("Stopping the trace because "
3454 "tracepoint %d was hit %" PRIu64 " times",
3455 stopping_tracepoint->number,
3456 stopping_tracepoint->pass_count);
3457 tracing_stop_reason = "tpasscount";
3458 tracing_stop_tpnum = stopping_tracepoint->number;
3460 else if (trace_buffer_is_full)
3462 trace_debug ("Stopping the trace because the trace buffer is full");
3463 tracing_stop_reason = "tfull";
3465 else if (expr_eval_result != expr_eval_no_error)
3467 trace_debug ("Stopping the trace because of an expression eval error");
3468 tracing_stop_reason = eval_result_names[expr_eval_result];
3469 tracing_stop_tpnum = error_tracepoint->number;
3471 #ifndef IN_PROCESS_AGENT
3472 else if (!gdb_connected ())
3474 trace_debug ("Stopping the trace because GDB disconnected");
3475 tracing_stop_reason = "tdisconnected";
3477 #endif
3478 else
3480 trace_debug ("Stopping the trace because of a tstop command");
3481 tracing_stop_reason = "tstop";
3484 stopping_tracepoint = NULL;
3485 error_tracepoint = NULL;
3487 /* Clear out the tracepoints. */
3488 clear_installed_tracepoints ();
3490 if (agent_loaded_p ())
3492 /* Pull in fast tracepoint trace frames from the inferior lib
3493 buffer into our buffer, even if our buffer is already full,
3494 because we want to present the full number of created frames
3495 in addition to what fit in the trace buffer. */
3496 upload_fast_traceframes ();
3499 if (stop_tracing_bkpt != NULL)
3501 delete_breakpoint (stop_tracing_bkpt);
3502 stop_tracing_bkpt = NULL;
3505 if (flush_trace_buffer_bkpt != NULL)
3507 delete_breakpoint (flush_trace_buffer_bkpt);
3508 flush_trace_buffer_bkpt = NULL;
3511 target_unpause_all (true);
3514 static int
3515 stop_tracing_handler (CORE_ADDR addr)
3517 trace_debug ("lib hit stop_tracing");
3519 /* Don't actually handle it here. When we stop tracing we remove
3520 breakpoints from the inferior, and that is not allowed in a
3521 breakpoint handler (as the caller is walking the breakpoint
3522 list). */
3523 return 0;
3526 static int
3527 flush_trace_buffer_handler (CORE_ADDR addr)
3529 trace_debug ("lib hit flush_trace_buffer");
3530 return 0;
3533 static void
3534 cmd_qtstop (char *packet)
3536 stop_tracing ();
3537 write_ok (packet);
3540 static void
3541 cmd_qtdisconnected (char *own_buf)
3543 ULONGEST setting;
3544 char *packet = own_buf;
3546 packet += strlen ("QTDisconnected:");
3548 unpack_varlen_hex (packet, &setting);
3550 write_ok (own_buf);
3552 disconnected_tracing = setting;
3555 static void
3556 cmd_qtframe (char *own_buf)
3558 client_state &cs = get_client_state ();
3559 ULONGEST frame, pc, lo, hi, num;
3560 int tfnum, tpnum;
3561 struct traceframe *tframe;
3562 const char *packet = own_buf;
3564 packet += strlen ("QTFrame:");
3566 if (startswith (packet, "pc:"))
3568 packet += strlen ("pc:");
3569 unpack_varlen_hex (packet, &pc);
3570 trace_debug ("Want to find next traceframe at pc=0x%s", paddress (pc));
3571 tframe = find_next_traceframe_in_range (pc, pc, 1, &tfnum);
3573 else if (startswith (packet, "range:"))
3575 packet += strlen ("range:");
3576 packet = unpack_varlen_hex (packet, &lo);
3577 ++packet;
3578 unpack_varlen_hex (packet, &hi);
3579 trace_debug ("Want to find next traceframe in the range 0x%s to 0x%s",
3580 paddress (lo), paddress (hi));
3581 tframe = find_next_traceframe_in_range (lo, hi, 1, &tfnum);
3583 else if (startswith (packet, "outside:"))
3585 packet += strlen ("outside:");
3586 packet = unpack_varlen_hex (packet, &lo);
3587 ++packet;
3588 unpack_varlen_hex (packet, &hi);
3589 trace_debug ("Want to find next traceframe "
3590 "outside the range 0x%s to 0x%s",
3591 paddress (lo), paddress (hi));
3592 tframe = find_next_traceframe_in_range (lo, hi, 0, &tfnum);
3594 else if (startswith (packet, "tdp:"))
3596 packet += strlen ("tdp:");
3597 unpack_varlen_hex (packet, &num);
3598 tpnum = (int) num;
3599 trace_debug ("Want to find next traceframe for tracepoint %d", tpnum);
3600 tframe = find_next_traceframe_by_tracepoint (tpnum, &tfnum);
3602 else
3604 unpack_varlen_hex (packet, &frame);
3605 tfnum = (int) frame;
3606 if (tfnum == -1)
3608 trace_debug ("Want to stop looking at traceframes");
3609 cs.current_traceframe = -1;
3610 write_ok (own_buf);
3611 return;
3613 trace_debug ("Want to look at traceframe %d", tfnum);
3614 tframe = find_traceframe (tfnum);
3617 if (tframe)
3619 cs.current_traceframe = tfnum;
3620 sprintf (own_buf, "F%xT%x", tfnum, tframe->tpnum);
3622 else
3623 sprintf (own_buf, "F-1");
3626 static void
3627 cmd_qtstatus (char *packet)
3629 char *stop_reason_rsp = NULL;
3630 char *buf1, *buf2, *buf3;
3631 const char *str;
3632 int slen;
3634 /* Translate the plain text of the notes back into hex for
3635 transmission. */
3637 str = (tracing_user_name ? tracing_user_name : "");
3638 slen = strlen (str);
3639 buf1 = (char *) alloca (slen * 2 + 1);
3640 bin2hex ((gdb_byte *) str, buf1, slen);
3642 str = (tracing_notes ? tracing_notes : "");
3643 slen = strlen (str);
3644 buf2 = (char *) alloca (slen * 2 + 1);
3645 bin2hex ((gdb_byte *) str, buf2, slen);
3647 str = (tracing_stop_note ? tracing_stop_note : "");
3648 slen = strlen (str);
3649 buf3 = (char *) alloca (slen * 2 + 1);
3650 bin2hex ((gdb_byte *) str, buf3, slen);
3652 trace_debug ("Returning trace status as %d, stop reason %s",
3653 tracing, tracing_stop_reason);
3655 if (agent_loaded_p ())
3657 target_pause_all (true);
3659 upload_fast_traceframes ();
3661 target_unpause_all (true);
3664 stop_reason_rsp = (char *) tracing_stop_reason;
3666 /* The user visible error string in terror needs to be hex encoded.
3667 We leave it as plain string in `tracing_stop_reason' to ease
3668 debugging. */
3669 if (startswith (stop_reason_rsp, "terror:"))
3671 const char *result_name;
3672 int hexstr_len;
3673 char *p;
3675 result_name = stop_reason_rsp + strlen ("terror:");
3676 hexstr_len = strlen (result_name) * 2;
3677 p = stop_reason_rsp
3678 = (char *) alloca (strlen ("terror:") + hexstr_len + 1);
3679 strcpy (p, "terror:");
3680 p += strlen (p);
3681 bin2hex ((gdb_byte *) result_name, p, strlen (result_name));
3684 /* If this was a forced stop, include any stop note that was supplied. */
3685 if (strcmp (stop_reason_rsp, "tstop") == 0)
3687 stop_reason_rsp = (char *) alloca (strlen ("tstop:") + strlen (buf3) + 1);
3688 strcpy (stop_reason_rsp, "tstop:");
3689 strcat (stop_reason_rsp, buf3);
3692 sprintf (packet,
3693 "T%d;"
3694 "%s:%x;"
3695 "tframes:%x;tcreated:%x;"
3696 "tfree:%x;tsize:%s;"
3697 "circular:%d;"
3698 "disconn:%d;"
3699 "starttime:%s;stoptime:%s;"
3700 "username:%s;notes:%s:",
3701 tracing ? 1 : 0,
3702 stop_reason_rsp, tracing_stop_tpnum,
3703 traceframe_count, traceframes_created,
3704 free_space (), phex_nz (trace_buffer_hi - trace_buffer_lo, 0),
3705 circular_trace_buffer,
3706 disconnected_tracing,
3707 phex_nz (tracing_start_time, sizeof (tracing_start_time)),
3708 phex_nz (tracing_stop_time, sizeof (tracing_stop_time)),
3709 buf1, buf2);
3712 static void
3713 cmd_qtp (char *own_buf)
3715 ULONGEST num, addr;
3716 struct tracepoint *tpoint;
3717 const char *packet = own_buf;
3719 packet += strlen ("qTP:");
3721 packet = unpack_varlen_hex (packet, &num);
3722 ++packet; /* skip a colon */
3723 packet = unpack_varlen_hex (packet, &addr);
3725 /* See if we already have this tracepoint. */
3726 tpoint = find_tracepoint (num, addr);
3728 if (!tpoint)
3730 trace_debug ("Tracepoint error: tracepoint %d at 0x%s not found",
3731 (int) num, paddress (addr));
3732 write_enn (own_buf);
3733 return;
3736 sprintf (own_buf, "V%" PRIu64 ":%" PRIu64 "", tpoint->hit_count,
3737 tpoint->traceframe_usage);
3740 /* State variables to help return all the tracepoint bits. */
3741 static struct tracepoint *cur_tpoint;
3742 static unsigned int cur_action;
3743 static unsigned int cur_step_action;
3744 static struct source_string *cur_source_string;
3745 static struct trace_state_variable *cur_tsv;
3747 /* Compose a response that is an imitation of the syntax by which the
3748 tracepoint was originally downloaded. */
3750 static void
3751 response_tracepoint (char *packet, struct tracepoint *tpoint)
3753 char *buf;
3755 sprintf (packet, "T%x:%s:%c:%" PRIx64 ":%" PRIx64, tpoint->number,
3756 paddress (tpoint->address),
3757 (tpoint->enabled ? 'E' : 'D'), tpoint->step_count,
3758 tpoint->pass_count);
3759 if (tpoint->type == fast_tracepoint)
3760 sprintf (packet + strlen (packet), ":F%x", tpoint->orig_size);
3761 else if (tpoint->type == static_tracepoint)
3762 sprintf (packet + strlen (packet), ":S");
3764 if (tpoint->cond)
3766 buf = gdb_unparse_agent_expr (tpoint->cond);
3767 sprintf (packet + strlen (packet), ":X%x,%s",
3768 tpoint->cond->length, buf);
3769 free (buf);
3773 /* Compose a response that is an imitation of the syntax by which the
3774 tracepoint action was originally downloaded (with the difference
3775 that due to the way we store the actions, this will output a packet
3776 per action, while GDB could have combined more than one action
3777 per-packet. */
3779 static void
3780 response_action (char *packet, struct tracepoint *tpoint,
3781 char *taction, int step)
3783 sprintf (packet, "%c%x:%s:%s",
3784 (step ? 'S' : 'A'), tpoint->number, paddress (tpoint->address),
3785 taction);
3788 /* Compose a response that is an imitation of the syntax by which the
3789 tracepoint source piece was originally downloaded. */
3791 static void
3792 response_source (char *packet,
3793 struct tracepoint *tpoint, struct source_string *src)
3795 char *buf;
3796 int len;
3798 len = strlen (src->str);
3799 buf = (char *) alloca (len * 2 + 1);
3800 bin2hex ((gdb_byte *) src->str, buf, len);
3802 sprintf (packet, "Z%x:%s:%s:%x:%x:%s",
3803 tpoint->number, paddress (tpoint->address),
3804 src->type, 0, len, buf);
3807 /* Return the first piece of tracepoint definition, and initialize the
3808 state machine that will iterate through all the tracepoint
3809 bits. */
3811 static void
3812 cmd_qtfp (char *packet)
3814 trace_debug ("Returning first tracepoint definition piece");
3816 cur_tpoint = tracepoints;
3817 cur_action = cur_step_action = 0;
3818 cur_source_string = NULL;
3820 if (cur_tpoint)
3821 response_tracepoint (packet, cur_tpoint);
3822 else
3823 strcpy (packet, "l");
3826 /* Return additional pieces of tracepoint definition. Each action and
3827 stepping action must go into its own packet, because of packet size
3828 limits, and so we use state variables to deliver one piece at a
3829 time. */
3831 static void
3832 cmd_qtsp (char *packet)
3834 trace_debug ("Returning subsequent tracepoint definition piece");
3836 if (!cur_tpoint)
3838 /* This case would normally never occur, but be prepared for
3839 GDB misbehavior. */
3840 strcpy (packet, "l");
3842 else if (cur_action < cur_tpoint->numactions)
3844 response_action (packet, cur_tpoint,
3845 cur_tpoint->actions_str[cur_action], 0);
3846 ++cur_action;
3848 else if (cur_step_action < cur_tpoint->num_step_actions)
3850 response_action (packet, cur_tpoint,
3851 cur_tpoint->step_actions_str[cur_step_action], 1);
3852 ++cur_step_action;
3854 else if ((cur_source_string
3855 ? cur_source_string->next
3856 : cur_tpoint->source_strings))
3858 if (cur_source_string)
3859 cur_source_string = cur_source_string->next;
3860 else
3861 cur_source_string = cur_tpoint->source_strings;
3862 response_source (packet, cur_tpoint, cur_source_string);
3864 else
3866 cur_tpoint = cur_tpoint->next;
3867 cur_action = cur_step_action = 0;
3868 cur_source_string = NULL;
3869 if (cur_tpoint)
3870 response_tracepoint (packet, cur_tpoint);
3871 else
3872 strcpy (packet, "l");
3876 /* Compose a response that is an imitation of the syntax by which the
3877 trace state variable was originally downloaded. */
3879 static void
3880 response_tsv (char *packet, struct trace_state_variable *tsv)
3882 char *buf = (char *) "";
3883 int namelen;
3885 if (tsv->name)
3887 namelen = strlen (tsv->name);
3888 buf = (char *) alloca (namelen * 2 + 1);
3889 bin2hex ((gdb_byte *) tsv->name, buf, namelen);
3892 sprintf (packet, "%x:%s:%x:%s", tsv->number, phex_nz (tsv->initial_value, 0),
3893 tsv->getter ? 1 : 0, buf);
3896 /* Return the first trace state variable definition, and initialize
3897 the state machine that will iterate through all the tsv bits. */
3899 static void
3900 cmd_qtfv (char *packet)
3902 trace_debug ("Returning first trace state variable definition");
3904 cur_tsv = trace_state_variables;
3906 if (cur_tsv)
3907 response_tsv (packet, cur_tsv);
3908 else
3909 strcpy (packet, "l");
3912 /* Return additional trace state variable definitions. */
3914 static void
3915 cmd_qtsv (char *packet)
3917 trace_debug ("Returning additional trace state variable definition");
3919 if (cur_tsv)
3921 cur_tsv = cur_tsv->next;
3922 if (cur_tsv)
3923 response_tsv (packet, cur_tsv);
3924 else
3925 strcpy (packet, "l");
3927 else
3928 strcpy (packet, "l");
3931 /* Return the first static tracepoint marker, and initialize the state
3932 machine that will iterate through all the static tracepoints
3933 markers. */
3935 static void
3936 cmd_qtfstm (char *packet)
3938 if (!maybe_write_ipa_ust_not_loaded (packet))
3939 run_inferior_command (packet, strlen (packet) + 1);
3942 /* Return additional static tracepoints markers. */
3944 static void
3945 cmd_qtsstm (char *packet)
3947 if (!maybe_write_ipa_ust_not_loaded (packet))
3948 run_inferior_command (packet, strlen (packet) + 1);
3951 /* Return the definition of the static tracepoint at a given address.
3952 Result packet is the same as qTsST's. */
3954 static void
3955 cmd_qtstmat (char *packet)
3957 if (!maybe_write_ipa_ust_not_loaded (packet))
3958 run_inferior_command (packet, strlen (packet) + 1);
3961 /* Sent the agent a command to close it. */
3963 void
3964 gdb_agent_about_to_close (int pid)
3966 char buf[IPA_CMD_BUF_SIZE];
3968 if (!maybe_write_ipa_not_loaded (buf))
3970 scoped_restore_current_thread restore_thread;
3972 /* Find any thread which belongs to process PID. */
3973 switch_to_thread (find_any_thread_of_pid (pid));
3975 strcpy (buf, "close");
3977 run_inferior_command (buf, strlen (buf) + 1);
3981 /* Return the minimum instruction size needed for fast tracepoints as a
3982 hexadecimal number. */
3984 static void
3985 cmd_qtminftpilen (char *packet)
3987 if (current_thread == NULL)
3989 /* Indicate that the minimum length is currently unknown. */
3990 strcpy (packet, "0");
3991 return;
3994 sprintf (packet, "%x", target_get_min_fast_tracepoint_insn_len ());
3997 /* Respond to qTBuffer packet with a block of raw data from the trace
3998 buffer. GDB may ask for a lot, but we are allowed to reply with
3999 only as much as will fit within packet limits or whatever. */
4001 static void
4002 cmd_qtbuffer (char *own_buf)
4004 ULONGEST offset, num, tot;
4005 unsigned char *tbp;
4006 const char *packet = own_buf;
4008 packet += strlen ("qTBuffer:");
4010 packet = unpack_varlen_hex (packet, &offset);
4011 ++packet; /* skip a comma */
4012 unpack_varlen_hex (packet, &num);
4014 trace_debug ("Want to get trace buffer, %d bytes at offset 0x%s",
4015 (int) num, phex_nz (offset, 0));
4017 tot = (trace_buffer_hi - trace_buffer_lo) - free_space ();
4019 /* If we're right at the end, reply specially that we're done. */
4020 if (offset == tot)
4022 strcpy (own_buf, "l");
4023 return;
4026 /* Object to any other out-of-bounds request. */
4027 if (offset > tot)
4029 write_enn (own_buf);
4030 return;
4033 /* Compute the pointer corresponding to the given offset, accounting
4034 for wraparound. */
4035 tbp = trace_buffer_start + offset;
4036 if (tbp >= trace_buffer_wrap)
4037 tbp -= (trace_buffer_wrap - trace_buffer_lo);
4039 /* Trim to the remaining bytes if we're close to the end. */
4040 if (num > tot - offset)
4041 num = tot - offset;
4043 /* Trim to available packet size. */
4044 if (num >= (PBUFSIZ - 16) / 2 )
4045 num = (PBUFSIZ - 16) / 2;
4047 bin2hex (tbp, own_buf, num);
4050 static void
4051 cmd_bigqtbuffer_circular (char *own_buf)
4053 ULONGEST val;
4054 char *packet = own_buf;
4056 packet += strlen ("QTBuffer:circular:");
4058 unpack_varlen_hex (packet, &val);
4059 circular_trace_buffer = val;
4060 trace_debug ("Trace buffer is now %s",
4061 circular_trace_buffer ? "circular" : "linear");
4062 write_ok (own_buf);
4065 static void
4066 cmd_bigqtbuffer_size (char *own_buf)
4068 ULONGEST val;
4069 LONGEST sval;
4070 char *packet = own_buf;
4072 /* Can't change the size during a tracing run. */
4073 if (tracing)
4075 write_enn (own_buf);
4076 return;
4079 packet += strlen ("QTBuffer:size:");
4081 /* -1 is sent as literal "-1". */
4082 if (strcmp (packet, "-1") == 0)
4083 sval = DEFAULT_TRACE_BUFFER_SIZE;
4084 else
4086 unpack_varlen_hex (packet, &val);
4087 sval = (LONGEST) val;
4090 init_trace_buffer (sval);
4091 trace_debug ("Trace buffer is now %s bytes",
4092 plongest (trace_buffer_size));
4093 write_ok (own_buf);
4096 static void
4097 cmd_qtnotes (char *own_buf)
4099 size_t nbytes;
4100 char *saved, *user, *notes, *stopnote;
4101 char *packet = own_buf;
4103 packet += strlen ("QTNotes:");
4105 while (*packet)
4107 if (startswith (packet, "user:"))
4109 packet += strlen ("user:");
4110 saved = packet;
4111 packet = strchr (packet, ';');
4112 nbytes = (packet - saved) / 2;
4113 user = (char *) xmalloc (nbytes + 1);
4114 nbytes = hex2bin (saved, (gdb_byte *) user, nbytes);
4115 user[nbytes] = '\0';
4116 ++packet; /* skip the semicolon */
4117 trace_debug ("User is '%s'", user);
4118 xfree (tracing_user_name);
4119 tracing_user_name = user;
4121 else if (startswith (packet, "notes:"))
4123 packet += strlen ("notes:");
4124 saved = packet;
4125 packet = strchr (packet, ';');
4126 nbytes = (packet - saved) / 2;
4127 notes = (char *) xmalloc (nbytes + 1);
4128 nbytes = hex2bin (saved, (gdb_byte *) notes, nbytes);
4129 notes[nbytes] = '\0';
4130 ++packet; /* skip the semicolon */
4131 trace_debug ("Notes is '%s'", notes);
4132 xfree (tracing_notes);
4133 tracing_notes = notes;
4135 else if (startswith (packet, "tstop:"))
4137 packet += strlen ("tstop:");
4138 saved = packet;
4139 packet = strchr (packet, ';');
4140 nbytes = (packet - saved) / 2;
4141 stopnote = (char *) xmalloc (nbytes + 1);
4142 nbytes = hex2bin (saved, (gdb_byte *) stopnote, nbytes);
4143 stopnote[nbytes] = '\0';
4144 ++packet; /* skip the semicolon */
4145 trace_debug ("tstop note is '%s'", stopnote);
4146 xfree (tracing_stop_note);
4147 tracing_stop_note = stopnote;
4149 else
4150 break;
4153 write_ok (own_buf);
4157 handle_tracepoint_general_set (char *packet)
4159 if (strcmp ("QTinit", packet) == 0)
4161 cmd_qtinit (packet);
4162 return 1;
4164 else if (startswith (packet, "QTDP:"))
4166 cmd_qtdp (packet);
4167 return 1;
4169 else if (startswith (packet, "QTDPsrc:"))
4171 cmd_qtdpsrc (packet);
4172 return 1;
4174 else if (startswith (packet, "QTEnable:"))
4176 cmd_qtenable_disable (packet, 1);
4177 return 1;
4179 else if (startswith (packet, "QTDisable:"))
4181 cmd_qtenable_disable (packet, 0);
4182 return 1;
4184 else if (startswith (packet, "QTDV:"))
4186 cmd_qtdv (packet);
4187 return 1;
4189 else if (startswith (packet, "QTro:"))
4191 cmd_qtro (packet);
4192 return 1;
4194 else if (strcmp ("QTStart", packet) == 0)
4196 cmd_qtstart (packet);
4197 return 1;
4199 else if (strcmp ("QTStop", packet) == 0)
4201 cmd_qtstop (packet);
4202 return 1;
4204 else if (startswith (packet, "QTDisconnected:"))
4206 cmd_qtdisconnected (packet);
4207 return 1;
4209 else if (startswith (packet, "QTFrame:"))
4211 cmd_qtframe (packet);
4212 return 1;
4214 else if (startswith (packet, "QTBuffer:circular:"))
4216 cmd_bigqtbuffer_circular (packet);
4217 return 1;
4219 else if (startswith (packet, "QTBuffer:size:"))
4221 cmd_bigqtbuffer_size (packet);
4222 return 1;
4224 else if (startswith (packet, "QTNotes:"))
4226 cmd_qtnotes (packet);
4227 return 1;
4230 return 0;
4234 handle_tracepoint_query (char *packet)
4236 if (strcmp ("qTStatus", packet) == 0)
4238 cmd_qtstatus (packet);
4239 return 1;
4241 else if (startswith (packet, "qTP:"))
4243 cmd_qtp (packet);
4244 return 1;
4246 else if (strcmp ("qTfP", packet) == 0)
4248 cmd_qtfp (packet);
4249 return 1;
4251 else if (strcmp ("qTsP", packet) == 0)
4253 cmd_qtsp (packet);
4254 return 1;
4256 else if (strcmp ("qTfV", packet) == 0)
4258 cmd_qtfv (packet);
4259 return 1;
4261 else if (strcmp ("qTsV", packet) == 0)
4263 cmd_qtsv (packet);
4264 return 1;
4266 else if (startswith (packet, "qTV:"))
4268 cmd_qtv (packet);
4269 return 1;
4271 else if (startswith (packet, "qTBuffer:"))
4273 cmd_qtbuffer (packet);
4274 return 1;
4276 else if (strcmp ("qTfSTM", packet) == 0)
4278 cmd_qtfstm (packet);
4279 return 1;
4281 else if (strcmp ("qTsSTM", packet) == 0)
4283 cmd_qtsstm (packet);
4284 return 1;
4286 else if (startswith (packet, "qTSTMat:"))
4288 cmd_qtstmat (packet);
4289 return 1;
4291 else if (strcmp ("qTMinFTPILen", packet) == 0)
4293 cmd_qtminftpilen (packet);
4294 return 1;
4297 return 0;
4300 #endif
4301 #ifndef IN_PROCESS_AGENT
4303 /* Call this when thread TINFO has hit the tracepoint defined by
4304 TP_NUMBER and TP_ADDRESS, and that tracepoint has a while-stepping
4305 action. This adds a while-stepping collecting state item to the
4306 threads' collecting state list, so that we can keep track of
4307 multiple simultaneous while-stepping actions being collected by the
4308 same thread. This can happen in cases like:
4310 ff0001 INSN1 <-- TP1, while-stepping 10 collect $regs
4311 ff0002 INSN2
4312 ff0003 INSN3 <-- TP2, collect $regs
4313 ff0004 INSN4 <-- TP3, while-stepping 10 collect $regs
4314 ff0005 INSN5
4316 Notice that when instruction INSN5 is reached, the while-stepping
4317 actions of both TP1 and TP3 are still being collected, and that TP2
4318 had been collected meanwhile. The whole range of ff0001-ff0005
4319 should be single-stepped, due to at least TP1's while-stepping
4320 action covering the whole range. */
4322 static void
4323 add_while_stepping_state (struct thread_info *tinfo,
4324 int tp_number, CORE_ADDR tp_address)
4326 struct wstep_state *wstep = XNEW (struct wstep_state);
4328 wstep->next = tinfo->while_stepping;
4330 wstep->tp_number = tp_number;
4331 wstep->tp_address = tp_address;
4332 wstep->current_step = 0;
4334 tinfo->while_stepping = wstep;
4337 /* Release the while-stepping collecting state WSTEP. */
4339 static void
4340 release_while_stepping_state (struct wstep_state *wstep)
4342 free (wstep);
4345 /* Release all while-stepping collecting states currently associated
4346 with thread TINFO. */
4348 void
4349 release_while_stepping_state_list (struct thread_info *tinfo)
4351 struct wstep_state *head;
4353 while (tinfo->while_stepping)
4355 head = tinfo->while_stepping;
4356 tinfo->while_stepping = head->next;
4357 release_while_stepping_state (head);
4361 /* If TINFO was handling a 'while-stepping' action, the step has
4362 finished, so collect any step data needed, and check if any more
4363 steps are required. Return true if the thread was indeed
4364 collecting tracepoint data, false otherwise. */
4367 tracepoint_finished_step (struct thread_info *tinfo, CORE_ADDR stop_pc)
4369 struct tracepoint *tpoint;
4370 struct wstep_state *wstep;
4371 struct wstep_state **wstep_link;
4372 struct trap_tracepoint_ctx ctx;
4374 /* Pull in fast tracepoint trace frames from the inferior lib buffer into
4375 our buffer. */
4376 if (agent_loaded_p ())
4377 upload_fast_traceframes ();
4379 /* Check if we were indeed collecting data for one of more
4380 tracepoints with a 'while-stepping' count. */
4381 if (tinfo->while_stepping == NULL)
4382 return 0;
4384 if (!tracing)
4386 /* We're not even tracing anymore. Stop this thread from
4387 collecting. */
4388 release_while_stepping_state_list (tinfo);
4390 /* The thread had stopped due to a single-step request indeed
4391 explained by a tracepoint. */
4392 return 1;
4395 wstep = tinfo->while_stepping;
4396 wstep_link = &tinfo->while_stepping;
4398 trace_debug ("Thread %s finished a single-step for tracepoint %d at 0x%s",
4399 target_pid_to_str (tinfo->id).c_str (),
4400 wstep->tp_number, paddress (wstep->tp_address));
4402 ctx.base.type = trap_tracepoint;
4403 ctx.regcache = get_thread_regcache (tinfo, 1);
4405 while (wstep != NULL)
4407 tpoint = find_tracepoint (wstep->tp_number, wstep->tp_address);
4408 if (tpoint == NULL)
4410 trace_debug ("NO TRACEPOINT %d at 0x%s FOR THREAD %s!",
4411 wstep->tp_number, paddress (wstep->tp_address),
4412 target_pid_to_str (tinfo->id).c_str ());
4414 /* Unlink. */
4415 *wstep_link = wstep->next;
4416 release_while_stepping_state (wstep);
4417 wstep = *wstep_link;
4418 continue;
4421 /* We've just finished one step. */
4422 ++wstep->current_step;
4424 /* Collect data. */
4425 collect_data_at_step ((struct tracepoint_hit_ctx *) &ctx,
4426 stop_pc, tpoint, wstep->current_step);
4428 if (wstep->current_step >= tpoint->step_count)
4430 /* The requested numbers of steps have occurred. */
4431 trace_debug ("Thread %s done stepping for tracepoint %d at 0x%s",
4432 target_pid_to_str (tinfo->id).c_str (),
4433 wstep->tp_number, paddress (wstep->tp_address));
4435 /* Unlink the wstep. */
4436 *wstep_link = wstep->next;
4437 release_while_stepping_state (wstep);
4438 wstep = *wstep_link;
4440 /* Only check the hit count now, which ensure that we do all
4441 our stepping before stopping the run. */
4442 if (tpoint->pass_count > 0
4443 && tpoint->hit_count >= tpoint->pass_count
4444 && stopping_tracepoint == NULL)
4445 stopping_tracepoint = tpoint;
4447 else
4449 /* Keep single-stepping until the requested numbers of steps
4450 have occurred. */
4451 wstep_link = &wstep->next;
4452 wstep = *wstep_link;
4455 if (stopping_tracepoint
4456 || trace_buffer_is_full
4457 || expr_eval_result != expr_eval_no_error)
4459 stop_tracing ();
4460 break;
4464 return 1;
4467 /* Handle any internal tracing control breakpoint hits. That means,
4468 pull traceframes from the IPA to our buffer, and syncing both
4469 tracing agents when the IPA's tracing stops for some reason. */
4472 handle_tracepoint_bkpts (struct thread_info *tinfo, CORE_ADDR stop_pc)
4474 /* Pull in fast tracepoint trace frames from the inferior in-process
4475 agent's buffer into our buffer. */
4477 if (!agent_loaded_p ())
4478 return 0;
4480 upload_fast_traceframes ();
4482 /* Check if the in-process agent had decided we should stop
4483 tracing. */
4484 if (stop_pc == ipa_sym_addrs.addr_stop_tracing)
4486 int ipa_trace_buffer_is_full;
4487 CORE_ADDR ipa_stopping_tracepoint;
4488 int ipa_expr_eval_result;
4489 CORE_ADDR ipa_error_tracepoint;
4491 trace_debug ("lib stopped at stop_tracing");
4493 read_inferior_integer (ipa_sym_addrs.addr_trace_buffer_is_full,
4494 &ipa_trace_buffer_is_full);
4496 read_inferior_data_pointer (ipa_sym_addrs.addr_stopping_tracepoint,
4497 &ipa_stopping_tracepoint);
4498 write_inferior_data_pointer (ipa_sym_addrs.addr_stopping_tracepoint, 0);
4500 read_inferior_data_pointer (ipa_sym_addrs.addr_error_tracepoint,
4501 &ipa_error_tracepoint);
4502 write_inferior_data_pointer (ipa_sym_addrs.addr_error_tracepoint, 0);
4504 read_inferior_integer (ipa_sym_addrs.addr_expr_eval_result,
4505 &ipa_expr_eval_result);
4506 write_inferior_integer (ipa_sym_addrs.addr_expr_eval_result, 0);
4508 trace_debug ("lib: trace_buffer_is_full: %d, "
4509 "stopping_tracepoint: %s, "
4510 "ipa_expr_eval_result: %d, "
4511 "error_tracepoint: %s, ",
4512 ipa_trace_buffer_is_full,
4513 paddress (ipa_stopping_tracepoint),
4514 ipa_expr_eval_result,
4515 paddress (ipa_error_tracepoint));
4517 if (ipa_trace_buffer_is_full)
4518 trace_debug ("lib stopped due to full buffer.");
4520 if (ipa_stopping_tracepoint)
4521 trace_debug ("lib stopped due to tpoint");
4523 if (ipa_error_tracepoint)
4524 trace_debug ("lib stopped due to error");
4526 if (ipa_stopping_tracepoint != 0)
4528 stopping_tracepoint
4529 = fast_tracepoint_from_ipa_tpoint_address (ipa_stopping_tracepoint);
4531 else if (ipa_expr_eval_result != expr_eval_no_error)
4533 expr_eval_result = ipa_expr_eval_result;
4534 error_tracepoint
4535 = fast_tracepoint_from_ipa_tpoint_address (ipa_error_tracepoint);
4537 stop_tracing ();
4538 return 1;
4540 else if (stop_pc == ipa_sym_addrs.addr_flush_trace_buffer)
4542 trace_debug ("lib stopped at flush_trace_buffer");
4543 return 1;
4546 return 0;
4549 /* Return true if TINFO just hit a tracepoint. Collect data if
4550 so. */
4553 tracepoint_was_hit (struct thread_info *tinfo, CORE_ADDR stop_pc)
4555 struct tracepoint *tpoint;
4556 int ret = 0;
4557 struct trap_tracepoint_ctx ctx;
4559 /* Not tracing, don't handle. */
4560 if (!tracing)
4561 return 0;
4563 ctx.base.type = trap_tracepoint;
4564 ctx.regcache = get_thread_regcache (tinfo, 1);
4566 for (tpoint = tracepoints; tpoint; tpoint = tpoint->next)
4568 /* Note that we collect fast tracepoints here as well. We'll
4569 step over the fast tracepoint jump later, which avoids the
4570 double collect. However, we don't collect for static
4571 tracepoints here, because UST markers are compiled in program,
4572 and probes will be executed in program. So static tracepoints
4573 are collected there. */
4574 if (tpoint->enabled && stop_pc == tpoint->address
4575 && tpoint->type != static_tracepoint)
4577 trace_debug ("Thread %s at address of tracepoint %d at 0x%s",
4578 target_pid_to_str (tinfo->id).c_str (),
4579 tpoint->number, paddress (tpoint->address));
4581 /* Test the condition if present, and collect if true. */
4582 if (!tpoint->cond
4583 || (condition_true_at_tracepoint
4584 ((struct tracepoint_hit_ctx *) &ctx, tpoint)))
4585 collect_data_at_tracepoint ((struct tracepoint_hit_ctx *) &ctx,
4586 stop_pc, tpoint);
4588 if (stopping_tracepoint
4589 || trace_buffer_is_full
4590 || expr_eval_result != expr_eval_no_error)
4592 stop_tracing ();
4594 /* If the tracepoint had a 'while-stepping' action, then set
4595 the thread to collect this tracepoint on the following
4596 single-steps. */
4597 else if (tpoint->step_count > 0)
4599 add_while_stepping_state (tinfo,
4600 tpoint->number, tpoint->address);
4603 ret = 1;
4607 return ret;
4610 #endif
4612 #if defined IN_PROCESS_AGENT && defined HAVE_UST
4613 struct ust_marker_data;
4614 static void collect_ust_data_at_tracepoint (struct tracepoint_hit_ctx *ctx,
4615 struct traceframe *tframe);
4616 #endif
4618 /* Create a trace frame for the hit of the given tracepoint in the
4619 given thread. */
4621 static void
4622 collect_data_at_tracepoint (struct tracepoint_hit_ctx *ctx, CORE_ADDR stop_pc,
4623 struct tracepoint *tpoint)
4625 struct traceframe *tframe;
4626 int acti;
4628 /* Only count it as a hit when we actually collect data. */
4629 tpoint->hit_count++;
4631 /* If we've exceeded a defined pass count, record the event for
4632 later, and finish the collection for this hit. This test is only
4633 for nonstepping tracepoints, stepping tracepoints test at the end
4634 of their while-stepping loop. */
4635 if (tpoint->pass_count > 0
4636 && tpoint->hit_count >= tpoint->pass_count
4637 && tpoint->step_count == 0
4638 && stopping_tracepoint == NULL)
4639 stopping_tracepoint = tpoint;
4641 trace_debug ("Making new traceframe for tracepoint %d at 0x%s, hit %" PRIu64,
4642 tpoint->number, paddress (tpoint->address), tpoint->hit_count);
4644 tframe = add_traceframe (tpoint);
4646 if (tframe)
4648 for (acti = 0; acti < tpoint->numactions; ++acti)
4650 #ifndef IN_PROCESS_AGENT
4651 trace_debug ("Tracepoint %d at 0x%s about to do action '%s'",
4652 tpoint->number, paddress (tpoint->address),
4653 tpoint->actions_str[acti]);
4654 #endif
4656 do_action_at_tracepoint (ctx, stop_pc, tpoint, tframe,
4657 tpoint->actions[acti]);
4660 finish_traceframe (tframe);
4663 if (tframe == NULL && tracing)
4664 trace_buffer_is_full = 1;
4667 #ifndef IN_PROCESS_AGENT
4669 static void
4670 collect_data_at_step (struct tracepoint_hit_ctx *ctx,
4671 CORE_ADDR stop_pc,
4672 struct tracepoint *tpoint, int current_step)
4674 struct traceframe *tframe;
4675 int acti;
4677 trace_debug ("Making new step traceframe for "
4678 "tracepoint %d at 0x%s, step %d of %" PRIu64 ", hit %" PRIu64,
4679 tpoint->number, paddress (tpoint->address),
4680 current_step, tpoint->step_count,
4681 tpoint->hit_count);
4683 tframe = add_traceframe (tpoint);
4685 if (tframe)
4687 for (acti = 0; acti < tpoint->num_step_actions; ++acti)
4689 trace_debug ("Tracepoint %d at 0x%s about to do step action '%s'",
4690 tpoint->number, paddress (tpoint->address),
4691 tpoint->step_actions_str[acti]);
4693 do_action_at_tracepoint (ctx, stop_pc, tpoint, tframe,
4694 tpoint->step_actions[acti]);
4697 finish_traceframe (tframe);
4700 if (tframe == NULL && tracing)
4701 trace_buffer_is_full = 1;
4704 #endif
4706 #ifdef IN_PROCESS_AGENT
4707 /* The target description index for IPA. Passed from gdbserver, used
4708 to select ipa_tdesc. */
4709 EXTERN_C_PUSH
4710 IP_AGENT_EXPORT_VAR int ipa_tdesc_idx;
4711 EXTERN_C_POP
4712 #endif
4714 static struct regcache *
4715 get_context_regcache (struct tracepoint_hit_ctx *ctx)
4717 struct regcache *regcache = NULL;
4718 #ifdef IN_PROCESS_AGENT
4719 const struct target_desc *ipa_tdesc = get_ipa_tdesc (ipa_tdesc_idx);
4721 if (ctx->type == fast_tracepoint)
4723 struct fast_tracepoint_ctx *fctx = (struct fast_tracepoint_ctx *) ctx;
4724 if (!fctx->regcache_initted)
4726 fctx->regcache_initted = 1;
4727 init_register_cache (&fctx->regcache, ipa_tdesc, fctx->regspace);
4728 supply_regblock (&fctx->regcache, NULL);
4729 supply_fast_tracepoint_registers (&fctx->regcache, fctx->regs);
4731 regcache = &fctx->regcache;
4733 #ifdef HAVE_UST
4734 if (ctx->type == static_tracepoint)
4736 struct static_tracepoint_ctx *sctx
4737 = (struct static_tracepoint_ctx *) ctx;
4739 if (!sctx->regcache_initted)
4741 sctx->regcache_initted = 1;
4742 init_register_cache (&sctx->regcache, ipa_tdesc, sctx->regspace);
4743 supply_regblock (&sctx->regcache, NULL);
4744 /* Pass down the tracepoint address, because REGS doesn't
4745 include the PC, but we know what it must have been. */
4746 supply_static_tracepoint_registers (&sctx->regcache,
4747 (const unsigned char *)
4748 sctx->regs,
4749 sctx->tpoint->address);
4751 regcache = &sctx->regcache;
4753 #endif
4754 #else
4755 if (ctx->type == trap_tracepoint)
4757 struct trap_tracepoint_ctx *tctx = (struct trap_tracepoint_ctx *) ctx;
4758 regcache = tctx->regcache;
4760 #endif
4762 gdb_assert (regcache != NULL);
4764 return regcache;
4767 static void
4768 do_action_at_tracepoint (struct tracepoint_hit_ctx *ctx,
4769 CORE_ADDR stop_pc,
4770 struct tracepoint *tpoint,
4771 struct traceframe *tframe,
4772 struct tracepoint_action *taction)
4774 enum eval_result_type err;
4776 switch (taction->type)
4778 case 'M':
4780 struct collect_memory_action *maction;
4781 struct eval_agent_expr_context ax_ctx;
4783 maction = (struct collect_memory_action *) taction;
4784 ax_ctx.regcache = NULL;
4785 ax_ctx.tframe = tframe;
4786 ax_ctx.tpoint = tpoint;
4788 trace_debug ("Want to collect %s bytes at 0x%s (basereg %d)",
4789 pulongest (maction->len),
4790 paddress (maction->addr), maction->basereg);
4791 /* (should use basereg) */
4792 agent_mem_read (&ax_ctx, NULL, (CORE_ADDR) maction->addr,
4793 maction->len);
4794 break;
4796 case 'R':
4798 unsigned char *regspace;
4799 struct regcache tregcache;
4800 struct regcache *context_regcache;
4801 int regcache_size;
4803 trace_debug ("Want to collect registers");
4805 context_regcache = get_context_regcache (ctx);
4806 regcache_size = register_cache_size (context_regcache->tdesc);
4808 /* Collect all registers for now. */
4809 regspace = add_traceframe_block (tframe, tpoint, 1 + regcache_size);
4810 if (regspace == NULL)
4812 trace_debug ("Trace buffer block allocation failed, skipping");
4813 break;
4815 /* Identify a register block. */
4816 *regspace = 'R';
4818 /* Wrap the regblock in a register cache (in the stack, we
4819 don't want to malloc here). */
4820 init_register_cache (&tregcache, context_regcache->tdesc,
4821 regspace + 1);
4823 /* Copy the register data to the regblock. */
4824 regcache_cpy (&tregcache, context_regcache);
4826 #ifndef IN_PROCESS_AGENT
4827 /* On some platforms, trap-based tracepoints will have the PC
4828 pointing to the next instruction after the trap, but we
4829 don't want the user or GDB trying to guess whether the
4830 saved PC needs adjusting; so always record the adjusted
4831 stop_pc. Note that we can't use tpoint->address instead,
4832 since it will be wrong for while-stepping actions. This
4833 adjustment is a nop for fast tracepoints collected from the
4834 in-process lib (but not if GDBserver is collecting one
4835 preemptively), since the PC had already been adjusted to
4836 contain the tracepoint's address by the jump pad. */
4837 trace_debug ("Storing stop pc (0x%s) in regblock",
4838 paddress (stop_pc));
4840 /* This changes the regblock, not the thread's
4841 regcache. */
4842 regcache_write_pc (&tregcache, stop_pc);
4843 #endif
4845 break;
4846 case 'X':
4848 struct eval_expr_action *eaction;
4849 struct eval_agent_expr_context ax_ctx;
4851 eaction = (struct eval_expr_action *) taction;
4852 ax_ctx.regcache = get_context_regcache (ctx);
4853 ax_ctx.tframe = tframe;
4854 ax_ctx.tpoint = tpoint;
4856 trace_debug ("Want to evaluate expression");
4858 err = gdb_eval_agent_expr (&ax_ctx, eaction->expr, NULL);
4860 if (err != expr_eval_no_error)
4862 record_tracepoint_error (tpoint, "action expression", err);
4863 return;
4866 break;
4867 case 'L':
4869 #if defined IN_PROCESS_AGENT && defined HAVE_UST
4870 trace_debug ("Want to collect static trace data");
4871 collect_ust_data_at_tracepoint (ctx, tframe);
4872 #else
4873 trace_debug ("warning: collecting static trace data, "
4874 "but static tracepoints are not supported");
4875 #endif
4877 break;
4878 default:
4879 trace_debug ("unknown trace action '%c', ignoring", taction->type);
4880 break;
4884 static int
4885 condition_true_at_tracepoint (struct tracepoint_hit_ctx *ctx,
4886 struct tracepoint *tpoint)
4888 ULONGEST value = 0;
4889 enum eval_result_type err;
4891 /* Presently, gdbserver doesn't run compiled conditions, only the
4892 IPA does. If the program stops at a fast tracepoint's address
4893 (e.g., due to a breakpoint, trap tracepoint, or stepping),
4894 gdbserver preemptively collect the fast tracepoint. Later, on
4895 resume, gdbserver steps over the fast tracepoint like it steps
4896 over breakpoints, so that the IPA doesn't see that fast
4897 tracepoint. This avoids double collects of fast tracepoints in
4898 that stopping scenario. Having gdbserver itself handle the fast
4899 tracepoint gives the user a consistent view of when fast or trap
4900 tracepoints are collected, compared to an alternative where only
4901 trap tracepoints are collected on stop, and fast tracepoints on
4902 resume. When a fast tracepoint is being processed by gdbserver,
4903 it is always the non-compiled condition expression that is
4904 used. */
4905 #ifdef IN_PROCESS_AGENT
4906 if (tpoint->compiled_cond)
4908 struct fast_tracepoint_ctx *fctx = (struct fast_tracepoint_ctx *) ctx;
4909 err = ((condfn) (uintptr_t) (tpoint->compiled_cond)) (fctx->regs, &value);
4911 else
4912 #endif
4914 struct eval_agent_expr_context ax_ctx;
4916 ax_ctx.regcache = get_context_regcache (ctx);
4917 ax_ctx.tframe = NULL;
4918 ax_ctx.tpoint = tpoint;
4920 err = gdb_eval_agent_expr (&ax_ctx, tpoint->cond, &value);
4922 if (err != expr_eval_no_error)
4924 record_tracepoint_error (tpoint, "condition", err);
4925 /* The error case must return false. */
4926 return 0;
4929 trace_debug ("Tracepoint %d at 0x%s condition evals to %s",
4930 tpoint->number, paddress (tpoint->address),
4931 pulongest (value));
4932 return (value ? 1 : 0);
4935 /* Do memory copies for bytecodes. */
4936 /* Do the recording of memory blocks for actions and bytecodes. */
4939 agent_mem_read (struct eval_agent_expr_context *ctx,
4940 unsigned char *to, CORE_ADDR from, ULONGEST len)
4942 unsigned char *mspace;
4943 ULONGEST remaining = len;
4944 unsigned short blocklen;
4946 /* If a 'to' buffer is specified, use it. */
4947 if (to != NULL)
4949 read_inferior_memory (from, to, len);
4950 return 0;
4953 /* Otherwise, create a new memory block in the trace buffer. */
4954 while (remaining > 0)
4956 size_t sp;
4958 blocklen = (remaining > 65535 ? 65535 : remaining);
4959 sp = 1 + sizeof (from) + sizeof (blocklen) + blocklen;
4960 mspace = add_traceframe_block (ctx->tframe, ctx->tpoint, sp);
4961 if (mspace == NULL)
4962 return 1;
4963 /* Identify block as a memory block. */
4964 *mspace = 'M';
4965 ++mspace;
4966 /* Record address and size. */
4967 memcpy (mspace, &from, sizeof (from));
4968 mspace += sizeof (from);
4969 memcpy (mspace, &blocklen, sizeof (blocklen));
4970 mspace += sizeof (blocklen);
4971 /* Record the memory block proper. */
4972 read_inferior_memory (from, mspace, blocklen);
4973 trace_debug ("%d bytes recorded", blocklen);
4974 remaining -= blocklen;
4975 from += blocklen;
4977 return 0;
4981 agent_mem_read_string (struct eval_agent_expr_context *ctx,
4982 unsigned char *to, CORE_ADDR from, ULONGEST len)
4984 unsigned char *buf, *mspace;
4985 ULONGEST remaining = len;
4986 unsigned short blocklen, i;
4988 /* To save a bit of space, block lengths are 16-bit, so break large
4989 requests into multiple blocks. Bordering on overkill for strings,
4990 but it could happen that someone specifies a large max length. */
4991 while (remaining > 0)
4993 size_t sp;
4995 blocklen = (remaining > 65535 ? 65535 : remaining);
4996 /* We want working space to accumulate nonzero bytes, since
4997 traceframes must have a predecided size (otherwise it gets
4998 harder to wrap correctly for the circular case, etc). */
4999 buf = (unsigned char *) xmalloc (blocklen + 1);
5000 for (i = 0; i < blocklen; ++i)
5002 /* Read the string one byte at a time, in case the string is
5003 at the end of a valid memory area - we don't want a
5004 correctly-terminated string to engender segvio
5005 complaints. */
5006 read_inferior_memory (from + i, buf + i, 1);
5008 if (buf[i] == '\0')
5010 blocklen = i + 1;
5011 /* Make sure outer loop stops now too. */
5012 remaining = blocklen;
5013 break;
5016 sp = 1 + sizeof (from) + sizeof (blocklen) + blocklen;
5017 mspace = add_traceframe_block (ctx->tframe, ctx->tpoint, sp);
5018 if (mspace == NULL)
5020 xfree (buf);
5021 return 1;
5023 /* Identify block as a memory block. */
5024 *mspace = 'M';
5025 ++mspace;
5026 /* Record address and size. */
5027 memcpy ((void *) mspace, (void *) &from, sizeof (from));
5028 mspace += sizeof (from);
5029 memcpy ((void *) mspace, (void *) &blocklen, sizeof (blocklen));
5030 mspace += sizeof (blocklen);
5031 /* Copy the string contents. */
5032 memcpy ((void *) mspace, (void *) buf, blocklen);
5033 remaining -= blocklen;
5034 from += blocklen;
5035 xfree (buf);
5037 return 0;
5040 /* Record the value of a trace state variable. */
5043 agent_tsv_read (struct eval_agent_expr_context *ctx, int n)
5045 unsigned char *vspace;
5046 LONGEST val;
5048 vspace = add_traceframe_block (ctx->tframe, ctx->tpoint,
5049 1 + sizeof (n) + sizeof (LONGEST));
5050 if (vspace == NULL)
5051 return 1;
5052 /* Identify block as a variable. */
5053 *vspace = 'V';
5054 /* Record variable's number and value. */
5055 memcpy (vspace + 1, &n, sizeof (n));
5056 val = get_trace_state_variable_value (n);
5057 memcpy (vspace + 1 + sizeof (n), &val, sizeof (val));
5058 trace_debug ("Variable %d recorded", n);
5059 return 0;
5062 #ifndef IN_PROCESS_AGENT
5064 /* Callback for traceframe_walk_blocks, used to find a given block
5065 type in a traceframe. */
5067 static int
5068 match_blocktype (char blocktype, unsigned char *dataptr, void *data)
5070 char *wantedp = (char *) data;
5072 if (*wantedp == blocktype)
5073 return 1;
5075 return 0;
5078 /* Walk over all traceframe blocks of the traceframe buffer starting
5079 at DATABASE, of DATASIZE bytes long, and call CALLBACK for each
5080 block found, passing in DATA unmodified. If CALLBACK returns true,
5081 this returns a pointer to where the block is found. Returns NULL
5082 if no callback call returned true, indicating that all blocks have
5083 been walked. */
5085 static unsigned char *
5086 traceframe_walk_blocks (unsigned char *database, unsigned int datasize,
5087 int tfnum,
5088 int (*callback) (char blocktype,
5089 unsigned char *dataptr,
5090 void *data),
5091 void *data)
5093 unsigned char *dataptr;
5095 if (datasize == 0)
5097 trace_debug ("traceframe %d has no data", tfnum);
5098 return NULL;
5101 /* Iterate through a traceframe's blocks, looking for a block of the
5102 requested type. */
5103 for (dataptr = database;
5104 dataptr < database + datasize;
5105 /* nothing */)
5107 char blocktype;
5108 unsigned short mlen;
5110 if (dataptr == trace_buffer_wrap)
5112 /* Adjust to reflect wrapping part of the frame around to
5113 the beginning. */
5114 datasize = dataptr - database;
5115 dataptr = database = trace_buffer_lo;
5118 blocktype = *dataptr++;
5120 if ((*callback) (blocktype, dataptr, data))
5121 return dataptr;
5123 switch (blocktype)
5125 case 'R':
5126 /* Skip over the registers block. */
5127 dataptr += current_target_desc ()->registers_size;
5128 break;
5129 case 'M':
5130 /* Skip over the memory block. */
5131 dataptr += sizeof (CORE_ADDR);
5132 memcpy (&mlen, dataptr, sizeof (mlen));
5133 dataptr += (sizeof (mlen) + mlen);
5134 break;
5135 case 'V':
5136 /* Skip over the TSV block. */
5137 dataptr += (sizeof (int) + sizeof (LONGEST));
5138 break;
5139 case 'S':
5140 /* Skip over the static trace data block. */
5141 memcpy (&mlen, dataptr, sizeof (mlen));
5142 dataptr += (sizeof (mlen) + mlen);
5143 break;
5144 default:
5145 trace_debug ("traceframe %d has unknown block type 0x%x",
5146 tfnum, blocktype);
5147 return NULL;
5151 return NULL;
5154 /* Look for the block of type TYPE_WANTED in the traceframe starting
5155 at DATABASE of DATASIZE bytes long. TFNUM is the traceframe
5156 number. */
5158 static unsigned char *
5159 traceframe_find_block_type (unsigned char *database, unsigned int datasize,
5160 int tfnum, char type_wanted)
5162 return traceframe_walk_blocks (database, datasize, tfnum,
5163 match_blocktype, &type_wanted);
5166 static unsigned char *
5167 traceframe_find_regblock (struct traceframe *tframe, int tfnum)
5169 unsigned char *regblock;
5171 regblock = traceframe_find_block_type (tframe->data,
5172 tframe->data_size,
5173 tfnum, 'R');
5175 if (regblock == NULL)
5176 trace_debug ("traceframe %d has no register data", tfnum);
5178 return regblock;
5181 /* Get registers from a traceframe. */
5184 fetch_traceframe_registers (int tfnum, struct regcache *regcache, int regnum)
5186 unsigned char *dataptr;
5187 struct tracepoint *tpoint;
5188 struct traceframe *tframe;
5190 tframe = find_traceframe (tfnum);
5192 if (tframe == NULL)
5194 trace_debug ("traceframe %d not found", tfnum);
5195 return 1;
5198 dataptr = traceframe_find_regblock (tframe, tfnum);
5199 if (dataptr == NULL)
5201 /* Mark registers unavailable. */
5202 supply_regblock (regcache, NULL);
5204 /* We can generally guess at a PC, although this will be
5205 misleading for while-stepping frames and multi-location
5206 tracepoints. */
5207 tpoint = find_next_tracepoint_by_number (NULL, tframe->tpnum);
5208 if (tpoint != NULL)
5209 regcache_write_pc (regcache, tpoint->address);
5211 else
5212 supply_regblock (regcache, dataptr);
5214 return 0;
5217 static CORE_ADDR
5218 traceframe_get_pc (struct traceframe *tframe)
5220 struct regcache regcache;
5221 unsigned char *dataptr;
5222 const struct target_desc *tdesc = current_target_desc ();
5224 dataptr = traceframe_find_regblock (tframe, -1);
5225 if (dataptr == NULL)
5226 return 0;
5228 init_register_cache (&regcache, tdesc, dataptr);
5229 return regcache_read_pc (&regcache);
5232 /* Read a requested block of memory from a trace frame. */
5235 traceframe_read_mem (int tfnum, CORE_ADDR addr,
5236 unsigned char *buf, ULONGEST length,
5237 ULONGEST *nbytes)
5239 struct traceframe *tframe;
5240 unsigned char *database, *dataptr;
5241 unsigned int datasize;
5242 CORE_ADDR maddr;
5243 unsigned short mlen;
5245 trace_debug ("traceframe_read_mem");
5247 tframe = find_traceframe (tfnum);
5249 if (!tframe)
5251 trace_debug ("traceframe %d not found", tfnum);
5252 return 1;
5255 datasize = tframe->data_size;
5256 database = dataptr = &tframe->data[0];
5258 /* Iterate through a traceframe's blocks, looking for memory. */
5259 while ((dataptr = traceframe_find_block_type (dataptr,
5260 datasize
5261 - (dataptr - database),
5262 tfnum, 'M')) != NULL)
5264 memcpy (&maddr, dataptr, sizeof (maddr));
5265 dataptr += sizeof (maddr);
5266 memcpy (&mlen, dataptr, sizeof (mlen));
5267 dataptr += sizeof (mlen);
5268 trace_debug ("traceframe %d has %d bytes at %s",
5269 tfnum, mlen, paddress (maddr));
5271 /* If the block includes the first part of the desired range,
5272 return as much it has; GDB will re-request the remainder,
5273 which might be in a different block of this trace frame. */
5274 if (maddr <= addr && addr < (maddr + mlen))
5276 ULONGEST amt = (maddr + mlen) - addr;
5277 if (amt > length)
5278 amt = length;
5280 memcpy (buf, dataptr + (addr - maddr), amt);
5281 *nbytes = amt;
5282 return 0;
5285 /* Skip over this block. */
5286 dataptr += mlen;
5289 trace_debug ("traceframe %d has no memory data for the desired region",
5290 tfnum);
5292 *nbytes = 0;
5293 return 0;
5296 static int
5297 traceframe_read_tsv (int tsvnum, LONGEST *val)
5299 client_state &cs = get_client_state ();
5300 int tfnum;
5301 struct traceframe *tframe;
5302 unsigned char *database, *dataptr;
5303 unsigned int datasize;
5304 int vnum;
5305 int found = 0;
5307 trace_debug ("traceframe_read_tsv");
5309 tfnum = cs.current_traceframe;
5311 if (tfnum < 0)
5313 trace_debug ("no current traceframe");
5314 return 1;
5317 tframe = find_traceframe (tfnum);
5319 if (tframe == NULL)
5321 trace_debug ("traceframe %d not found", tfnum);
5322 return 1;
5325 datasize = tframe->data_size;
5326 database = dataptr = &tframe->data[0];
5328 /* Iterate through a traceframe's blocks, looking for the last
5329 matched tsv. */
5330 while ((dataptr = traceframe_find_block_type (dataptr,
5331 datasize
5332 - (dataptr - database),
5333 tfnum, 'V')) != NULL)
5335 memcpy (&vnum, dataptr, sizeof (vnum));
5336 dataptr += sizeof (vnum);
5338 trace_debug ("traceframe %d has variable %d", tfnum, vnum);
5340 /* Check that this is the variable we want. */
5341 if (tsvnum == vnum)
5343 memcpy (val, dataptr, sizeof (*val));
5344 found = 1;
5347 /* Skip over this block. */
5348 dataptr += sizeof (LONGEST);
5351 if (!found)
5352 trace_debug ("traceframe %d has no data for variable %d",
5353 tfnum, tsvnum);
5354 return !found;
5357 /* Read a requested block of static tracepoint data from a trace
5358 frame. */
5361 traceframe_read_sdata (int tfnum, ULONGEST offset,
5362 unsigned char *buf, ULONGEST length,
5363 ULONGEST *nbytes)
5365 struct traceframe *tframe;
5366 unsigned char *database, *dataptr;
5367 unsigned int datasize;
5368 unsigned short mlen;
5370 trace_debug ("traceframe_read_sdata");
5372 tframe = find_traceframe (tfnum);
5374 if (!tframe)
5376 trace_debug ("traceframe %d not found", tfnum);
5377 return 1;
5380 datasize = tframe->data_size;
5381 database = &tframe->data[0];
5383 /* Iterate through a traceframe's blocks, looking for static
5384 tracepoint data. */
5385 dataptr = traceframe_find_block_type (database, datasize,
5386 tfnum, 'S');
5387 if (dataptr != NULL)
5389 memcpy (&mlen, dataptr, sizeof (mlen));
5390 dataptr += sizeof (mlen);
5391 if (offset < mlen)
5393 if (offset + length > mlen)
5394 length = mlen - offset;
5396 memcpy (buf, dataptr, length);
5397 *nbytes = length;
5399 else
5400 *nbytes = 0;
5401 return 0;
5404 trace_debug ("traceframe %d has no static trace data", tfnum);
5406 *nbytes = 0;
5407 return 0;
5410 /* Callback for traceframe_walk_blocks. Builds a traceframe-info
5411 object. DATA is pointer to a struct buffer holding the
5412 traceframe-info object being built. */
5414 static int
5415 build_traceframe_info_xml (char blocktype, unsigned char *dataptr, void *data)
5417 struct buffer *buffer = (struct buffer *) data;
5419 switch (blocktype)
5421 case 'M':
5423 unsigned short mlen;
5424 CORE_ADDR maddr;
5426 memcpy (&maddr, dataptr, sizeof (maddr));
5427 dataptr += sizeof (maddr);
5428 memcpy (&mlen, dataptr, sizeof (mlen));
5429 dataptr += sizeof (mlen);
5430 buffer_xml_printf (buffer,
5431 "<memory start=\"0x%s\" length=\"0x%s\"/>\n",
5432 paddress (maddr), phex_nz (mlen, sizeof (mlen)));
5433 break;
5435 case 'V':
5437 int vnum;
5439 memcpy (&vnum, dataptr, sizeof (vnum));
5440 buffer_xml_printf (buffer, "<tvar id=\"%d\"/>\n", vnum);
5441 break;
5443 case 'R':
5444 case 'S':
5446 break;
5448 default:
5449 warning ("Unhandled trace block type (%d) '%c ' "
5450 "while building trace frame info.",
5451 blocktype, blocktype);
5452 break;
5455 return 0;
5458 /* Build a traceframe-info object for traceframe number TFNUM into
5459 BUFFER. */
5462 traceframe_read_info (int tfnum, struct buffer *buffer)
5464 struct traceframe *tframe;
5466 trace_debug ("traceframe_read_info");
5468 tframe = find_traceframe (tfnum);
5470 if (!tframe)
5472 trace_debug ("traceframe %d not found", tfnum);
5473 return 1;
5476 buffer_grow_str (buffer, "<traceframe-info>\n");
5477 traceframe_walk_blocks (tframe->data, tframe->data_size,
5478 tfnum, build_traceframe_info_xml, buffer);
5479 buffer_grow_str0 (buffer, "</traceframe-info>\n");
5480 return 0;
5483 /* Return the first fast tracepoint whose jump pad contains PC. */
5485 static struct tracepoint *
5486 fast_tracepoint_from_jump_pad_address (CORE_ADDR pc)
5488 struct tracepoint *tpoint;
5490 for (tpoint = tracepoints; tpoint; tpoint = tpoint->next)
5491 if (tpoint->type == fast_tracepoint)
5492 if (tpoint->jump_pad <= pc && pc < tpoint->jump_pad_end)
5493 return tpoint;
5495 return NULL;
5498 /* Return the first fast tracepoint whose trampoline contains PC. */
5500 static struct tracepoint *
5501 fast_tracepoint_from_trampoline_address (CORE_ADDR pc)
5503 struct tracepoint *tpoint;
5505 for (tpoint = tracepoints; tpoint; tpoint = tpoint->next)
5507 if (tpoint->type == fast_tracepoint
5508 && tpoint->trampoline <= pc && pc < tpoint->trampoline_end)
5509 return tpoint;
5512 return NULL;
5515 /* Return GDBserver's tracepoint that matches the IP Agent's
5516 tracepoint object that lives at IPA_TPOINT_OBJ in the IP Agent's
5517 address space. */
5519 static struct tracepoint *
5520 fast_tracepoint_from_ipa_tpoint_address (CORE_ADDR ipa_tpoint_obj)
5522 struct tracepoint *tpoint;
5524 for (tpoint = tracepoints; tpoint; tpoint = tpoint->next)
5525 if (tpoint->type == fast_tracepoint)
5526 if (tpoint->obj_addr_on_target == ipa_tpoint_obj)
5527 return tpoint;
5529 return NULL;
5532 #endif
5534 /* The type of the object that is used to synchronize fast tracepoint
5535 collection. */
5537 typedef struct collecting_t
5539 /* The fast tracepoint number currently collecting. */
5540 uintptr_t tpoint;
5542 /* A number that GDBserver can use to identify the thread that is
5543 presently holding the collect lock. This need not (and usually
5544 is not) the thread id, as getting the current thread ID usually
5545 requires a system call, which we want to avoid like the plague.
5546 Usually this is thread's TCB, found in the TLS (pseudo-)
5547 register, which is readable with a single insn on several
5548 architectures. */
5549 uintptr_t thread_area;
5550 } collecting_t;
5552 #ifndef IN_PROCESS_AGENT
5554 void
5555 force_unlock_trace_buffer (void)
5557 write_inferior_data_pointer (ipa_sym_addrs.addr_collecting, 0);
5560 /* Check if the thread identified by THREAD_AREA which is stopped at
5561 STOP_PC, is presently locking the fast tracepoint collection, and
5562 if so, gather some status of said collection. Returns 0 if the
5563 thread isn't collecting or in the jump pad at all. 1, if in the
5564 jump pad (or within gdb_collect) and hasn't executed the adjusted
5565 original insn yet (can set a breakpoint there and run to it). 2,
5566 if presently executing the adjusted original insn --- in which
5567 case, if we want to move the thread out of the jump pad, we need to
5568 single-step it until this function returns 0. */
5570 fast_tpoint_collect_result
5571 fast_tracepoint_collecting (CORE_ADDR thread_area,
5572 CORE_ADDR stop_pc,
5573 struct fast_tpoint_collect_status *status)
5575 CORE_ADDR ipa_collecting;
5576 CORE_ADDR ipa_gdb_jump_pad_buffer, ipa_gdb_jump_pad_buffer_end;
5577 CORE_ADDR ipa_gdb_trampoline_buffer;
5578 CORE_ADDR ipa_gdb_trampoline_buffer_end;
5579 struct tracepoint *tpoint;
5580 int needs_breakpoint;
5582 /* The thread THREAD_AREA is either:
5584 0. not collecting at all, not within the jump pad, or within
5585 gdb_collect or one of its callees.
5587 1. in the jump pad and haven't reached gdb_collect
5589 2. within gdb_collect (out of the jump pad) (collect is set)
5591 3. we're in the jump pad, after gdb_collect having returned,
5592 possibly executing the adjusted insns.
5594 For cases 1 and 3, `collecting' may or not be set. The jump pad
5595 doesn't have any complicated jump logic, so we can tell if the
5596 thread is executing the adjust original insn or not by just
5597 matching STOP_PC with known jump pad addresses. If we it isn't
5598 yet executing the original insn, set a breakpoint there, and let
5599 the thread run to it, so to quickly step over a possible (many
5600 insns) gdb_collect call. Otherwise, or when the breakpoint is
5601 hit, only a few (small number of) insns are left to be executed
5602 in the jump pad. Single-step the thread until it leaves the
5603 jump pad. */
5605 again:
5606 tpoint = NULL;
5607 needs_breakpoint = 0;
5608 trace_debug ("fast_tracepoint_collecting");
5610 if (read_inferior_data_pointer (ipa_sym_addrs.addr_gdb_jump_pad_buffer,
5611 &ipa_gdb_jump_pad_buffer))
5613 internal_error (__FILE__, __LINE__,
5614 "error extracting `gdb_jump_pad_buffer'");
5616 if (read_inferior_data_pointer (ipa_sym_addrs.addr_gdb_jump_pad_buffer_end,
5617 &ipa_gdb_jump_pad_buffer_end))
5619 internal_error (__FILE__, __LINE__,
5620 "error extracting `gdb_jump_pad_buffer_end'");
5623 if (read_inferior_data_pointer (ipa_sym_addrs.addr_gdb_trampoline_buffer,
5624 &ipa_gdb_trampoline_buffer))
5626 internal_error (__FILE__, __LINE__,
5627 "error extracting `gdb_trampoline_buffer'");
5629 if (read_inferior_data_pointer (ipa_sym_addrs.addr_gdb_trampoline_buffer_end,
5630 &ipa_gdb_trampoline_buffer_end))
5632 internal_error (__FILE__, __LINE__,
5633 "error extracting `gdb_trampoline_buffer_end'");
5636 if (ipa_gdb_jump_pad_buffer <= stop_pc
5637 && stop_pc < ipa_gdb_jump_pad_buffer_end)
5639 /* We can tell which tracepoint(s) the thread is collecting by
5640 matching the jump pad address back to the tracepoint. */
5641 tpoint = fast_tracepoint_from_jump_pad_address (stop_pc);
5642 if (tpoint == NULL)
5644 warning ("in jump pad, but no matching tpoint?");
5645 return fast_tpoint_collect_result::not_collecting;
5647 else
5649 trace_debug ("in jump pad of tpoint (%d, %s); jump_pad(%s, %s); "
5650 "adj_insn(%s, %s)",
5651 tpoint->number, paddress (tpoint->address),
5652 paddress (tpoint->jump_pad),
5653 paddress (tpoint->jump_pad_end),
5654 paddress (tpoint->adjusted_insn_addr),
5655 paddress (tpoint->adjusted_insn_addr_end));
5658 /* Definitely in the jump pad. May or may not need
5659 fast-exit-jump-pad breakpoint. */
5660 if (tpoint->jump_pad <= stop_pc
5661 && stop_pc < tpoint->adjusted_insn_addr)
5662 needs_breakpoint = 1;
5664 else if (ipa_gdb_trampoline_buffer <= stop_pc
5665 && stop_pc < ipa_gdb_trampoline_buffer_end)
5667 /* We can tell which tracepoint(s) the thread is collecting by
5668 matching the trampoline address back to the tracepoint. */
5669 tpoint = fast_tracepoint_from_trampoline_address (stop_pc);
5670 if (tpoint == NULL)
5672 warning ("in trampoline, but no matching tpoint?");
5673 return fast_tpoint_collect_result::not_collecting;
5675 else
5677 trace_debug ("in trampoline of tpoint (%d, %s); trampoline(%s, %s)",
5678 tpoint->number, paddress (tpoint->address),
5679 paddress (tpoint->trampoline),
5680 paddress (tpoint->trampoline_end));
5683 /* Have not reached jump pad yet, but treat the trampoline as a
5684 part of the jump pad that is before the adjusted original
5685 instruction. */
5686 needs_breakpoint = 1;
5688 else
5690 collecting_t ipa_collecting_obj;
5692 /* If `collecting' is set/locked, then the THREAD_AREA thread
5693 may or not be the one holding the lock. We have to read the
5694 lock to find out. */
5696 if (read_inferior_data_pointer (ipa_sym_addrs.addr_collecting,
5697 &ipa_collecting))
5699 trace_debug ("fast_tracepoint_collecting:"
5700 " failed reading 'collecting' in the inferior");
5701 return fast_tpoint_collect_result::not_collecting;
5704 if (!ipa_collecting)
5706 trace_debug ("fast_tracepoint_collecting: not collecting"
5707 " (and nobody is).");
5708 return fast_tpoint_collect_result::not_collecting;
5711 /* Some thread is collecting. Check which. */
5712 if (read_inferior_memory (ipa_collecting,
5713 (unsigned char *) &ipa_collecting_obj,
5714 sizeof (ipa_collecting_obj)) != 0)
5715 goto again;
5717 if (ipa_collecting_obj.thread_area != thread_area)
5719 trace_debug ("fast_tracepoint_collecting: not collecting "
5720 "(another thread is)");
5721 return fast_tpoint_collect_result::not_collecting;
5724 tpoint
5725 = fast_tracepoint_from_ipa_tpoint_address (ipa_collecting_obj.tpoint);
5726 if (tpoint == NULL)
5728 warning ("fast_tracepoint_collecting: collecting, "
5729 "but tpoint %s not found?",
5730 paddress ((CORE_ADDR) ipa_collecting_obj.tpoint));
5731 return fast_tpoint_collect_result::not_collecting;
5734 /* The thread is within `gdb_collect', skip over the rest of
5735 fast tracepoint collection quickly using a breakpoint. */
5736 needs_breakpoint = 1;
5739 /* The caller wants a bit of status detail. */
5740 if (status != NULL)
5742 status->tpoint_num = tpoint->number;
5743 status->tpoint_addr = tpoint->address;
5744 status->adjusted_insn_addr = tpoint->adjusted_insn_addr;
5745 status->adjusted_insn_addr_end = tpoint->adjusted_insn_addr_end;
5748 if (needs_breakpoint)
5750 /* Hasn't executed the original instruction yet. Set breakpoint
5751 there, and wait till it's hit, then single-step until exiting
5752 the jump pad. */
5754 trace_debug ("\
5755 fast_tracepoint_collecting, returning continue-until-break at %s",
5756 paddress (tpoint->adjusted_insn_addr));
5758 return fast_tpoint_collect_result::before_insn; /* continue */
5760 else
5762 /* Just single-step until exiting the jump pad. */
5764 trace_debug ("fast_tracepoint_collecting, returning "
5765 "need-single-step (%s-%s)",
5766 paddress (tpoint->adjusted_insn_addr),
5767 paddress (tpoint->adjusted_insn_addr_end));
5769 return fast_tpoint_collect_result::at_insn; /* single-step */
5773 #endif
5775 #ifdef IN_PROCESS_AGENT
5777 /* The global fast tracepoint collect lock. Points to a collecting_t
5778 object built on the stack by the jump pad, if presently locked;
5779 NULL if it isn't locked. Note that this lock *must* be set while
5780 executing any *function other than the jump pad. See
5781 fast_tracepoint_collecting. */
5782 EXTERN_C_PUSH
5783 IP_AGENT_EXPORT_VAR collecting_t *collecting;
5784 EXTERN_C_POP
5786 /* This is needed for -Wmissing-declarations. */
5787 IP_AGENT_EXPORT_FUNC void gdb_collect (struct tracepoint *tpoint,
5788 unsigned char *regs);
5790 /* This routine, called from the jump pad (in asm) is designed to be
5791 called from the jump pads of fast tracepoints, thus it is on the
5792 critical path. */
5794 IP_AGENT_EXPORT_FUNC void
5795 gdb_collect (struct tracepoint *tpoint, unsigned char *regs)
5797 struct fast_tracepoint_ctx ctx;
5798 const struct target_desc *ipa_tdesc;
5800 /* Don't do anything until the trace run is completely set up. */
5801 if (!tracing)
5802 return;
5804 ipa_tdesc = get_ipa_tdesc (ipa_tdesc_idx);
5805 ctx.base.type = fast_tracepoint;
5806 ctx.regs = regs;
5807 ctx.regcache_initted = 0;
5808 /* Wrap the regblock in a register cache (in the stack, we don't
5809 want to malloc here). */
5810 ctx.regspace = (unsigned char *) alloca (ipa_tdesc->registers_size);
5811 if (ctx.regspace == NULL)
5813 trace_debug ("Trace buffer block allocation failed, skipping");
5814 return;
5817 for (ctx.tpoint = tpoint;
5818 ctx.tpoint != NULL && ctx.tpoint->address == tpoint->address;
5819 ctx.tpoint = ctx.tpoint->next)
5821 if (!ctx.tpoint->enabled)
5822 continue;
5824 /* Multiple tracepoints of different types, such as fast tracepoint and
5825 static tracepoint, can be set at the same address. */
5826 if (ctx.tpoint->type != tpoint->type)
5827 continue;
5829 /* Test the condition if present, and collect if true. */
5830 if (ctx.tpoint->cond == NULL
5831 || condition_true_at_tracepoint ((struct tracepoint_hit_ctx *) &ctx,
5832 ctx.tpoint))
5834 collect_data_at_tracepoint ((struct tracepoint_hit_ctx *) &ctx,
5835 ctx.tpoint->address, ctx.tpoint);
5837 /* Note that this will cause original insns to be written back
5838 to where we jumped from, but that's OK because we're jumping
5839 back to the next whole instruction. This will go badly if
5840 instruction restoration is not atomic though. */
5841 if (stopping_tracepoint
5842 || trace_buffer_is_full
5843 || expr_eval_result != expr_eval_no_error)
5845 stop_tracing ();
5846 break;
5849 else
5851 /* If there was a condition and it evaluated to false, the only
5852 way we would stop tracing is if there was an error during
5853 condition expression evaluation. */
5854 if (expr_eval_result != expr_eval_no_error)
5856 stop_tracing ();
5857 break;
5863 /* These global variables points to the corresponding functions. This is
5864 necessary on powerpc64, where asking for function symbol address from gdb
5865 results in returning the actual code pointer, instead of the descriptor
5866 pointer. */
5868 typedef void (*gdb_collect_ptr_type) (struct tracepoint *, unsigned char *);
5869 typedef ULONGEST (*get_raw_reg_ptr_type) (const unsigned char *, int);
5870 typedef LONGEST (*get_trace_state_variable_value_ptr_type) (int);
5871 typedef void (*set_trace_state_variable_value_ptr_type) (int, LONGEST);
5873 EXTERN_C_PUSH
5874 IP_AGENT_EXPORT_VAR gdb_collect_ptr_type gdb_collect_ptr = gdb_collect;
5875 IP_AGENT_EXPORT_VAR get_raw_reg_ptr_type get_raw_reg_ptr = get_raw_reg;
5876 IP_AGENT_EXPORT_VAR get_trace_state_variable_value_ptr_type
5877 get_trace_state_variable_value_ptr = get_trace_state_variable_value;
5878 IP_AGENT_EXPORT_VAR set_trace_state_variable_value_ptr_type
5879 set_trace_state_variable_value_ptr = set_trace_state_variable_value;
5880 EXTERN_C_POP
5882 #endif
5884 #ifndef IN_PROCESS_AGENT
5886 CORE_ADDR
5887 get_raw_reg_func_addr (void)
5889 CORE_ADDR res;
5890 if (read_inferior_data_pointer (ipa_sym_addrs.addr_get_raw_reg_ptr, &res))
5892 error ("error extracting get_raw_reg_ptr");
5893 return 0;
5895 return res;
5898 CORE_ADDR
5899 get_get_tsv_func_addr (void)
5901 CORE_ADDR res;
5902 if (read_inferior_data_pointer (
5903 ipa_sym_addrs.addr_get_trace_state_variable_value_ptr, &res))
5905 error ("error extracting get_trace_state_variable_value_ptr");
5906 return 0;
5908 return res;
5911 CORE_ADDR
5912 get_set_tsv_func_addr (void)
5914 CORE_ADDR res;
5915 if (read_inferior_data_pointer (
5916 ipa_sym_addrs.addr_set_trace_state_variable_value_ptr, &res))
5918 error ("error extracting set_trace_state_variable_value_ptr");
5919 return 0;
5921 return res;
5924 static void
5925 compile_tracepoint_condition (struct tracepoint *tpoint,
5926 CORE_ADDR *jump_entry)
5928 CORE_ADDR entry_point = *jump_entry;
5929 enum eval_result_type err;
5931 trace_debug ("Starting condition compilation for tracepoint %d\n",
5932 tpoint->number);
5934 /* Initialize the global pointer to the code being built. */
5935 current_insn_ptr = *jump_entry;
5937 emit_prologue ();
5939 err = compile_bytecodes (tpoint->cond);
5941 if (err == expr_eval_no_error)
5943 emit_epilogue ();
5945 /* Record the beginning of the compiled code. */
5946 tpoint->compiled_cond = entry_point;
5948 trace_debug ("Condition compilation for tracepoint %d complete\n",
5949 tpoint->number);
5951 else
5953 /* Leave the unfinished code in situ, but don't point to it. */
5955 tpoint->compiled_cond = 0;
5957 trace_debug ("Condition compilation for tracepoint %d failed, "
5958 "error code %d",
5959 tpoint->number, err);
5962 /* Update the code pointer passed in. Note that we do this even if
5963 the compile fails, so that we can look at the partial results
5964 instead of letting them be overwritten. */
5965 *jump_entry = current_insn_ptr;
5967 /* Leave a gap, to aid dump decipherment. */
5968 *jump_entry += 16;
5971 /* The base pointer of the IPA's heap. This is the only memory the
5972 IPA is allowed to use. The IPA should _not_ call the inferior's
5973 `malloc' during operation. That'd be slow, and, most importantly,
5974 it may not be safe. We may be collecting a tracepoint in a signal
5975 handler, for example. */
5976 static CORE_ADDR target_tp_heap;
5978 /* Allocate at least SIZE bytes of memory from the IPA heap, aligned
5979 to 8 bytes. */
5981 static CORE_ADDR
5982 target_malloc (ULONGEST size)
5984 CORE_ADDR ptr;
5986 if (target_tp_heap == 0)
5988 /* We have the pointer *address*, need what it points to. */
5989 if (read_inferior_data_pointer (ipa_sym_addrs.addr_gdb_tp_heap_buffer,
5990 &target_tp_heap))
5992 internal_error (__FILE__, __LINE__,
5993 "couldn't get target heap head pointer");
5997 ptr = target_tp_heap;
5998 target_tp_heap += size;
6000 /* Pad to 8-byte alignment. */
6001 target_tp_heap = ((target_tp_heap + 7) & ~0x7);
6003 return ptr;
6006 static CORE_ADDR
6007 download_agent_expr (struct agent_expr *expr)
6009 CORE_ADDR expr_addr;
6010 CORE_ADDR expr_bytes;
6012 expr_addr = target_malloc (sizeof (*expr));
6013 target_write_memory (expr_addr, (unsigned char *) expr, sizeof (*expr));
6015 expr_bytes = target_malloc (expr->length);
6016 write_inferior_data_pointer (expr_addr + offsetof (struct agent_expr, bytes),
6017 expr_bytes);
6018 target_write_memory (expr_bytes, expr->bytes, expr->length);
6020 return expr_addr;
6023 /* Align V up to N bits. */
6024 #define UALIGN(V, N) (((V) + ((N) - 1)) & ~((N) - 1))
6026 /* Sync tracepoint with IPA, but leave maintenance of linked list to caller. */
6028 static void
6029 download_tracepoint_1 (struct tracepoint *tpoint)
6031 struct tracepoint target_tracepoint;
6032 CORE_ADDR tpptr = 0;
6034 gdb_assert (tpoint->type == fast_tracepoint
6035 || tpoint->type == static_tracepoint);
6037 if (tpoint->cond != NULL && target_emit_ops () != NULL)
6039 CORE_ADDR jentry, jump_entry;
6041 jentry = jump_entry = get_jump_space_head ();
6043 if (tpoint->cond != NULL)
6045 /* Pad to 8-byte alignment. (needed?) */
6046 /* Actually this should be left for the target to
6047 decide. */
6048 jentry = UALIGN (jentry, 8);
6050 compile_tracepoint_condition (tpoint, &jentry);
6053 /* Pad to 8-byte alignment. */
6054 jentry = UALIGN (jentry, 8);
6055 claim_jump_space (jentry - jump_entry);
6058 target_tracepoint = *tpoint;
6060 tpptr = target_malloc (sizeof (*tpoint));
6061 tpoint->obj_addr_on_target = tpptr;
6063 /* Write the whole object. We'll fix up its pointers in a bit.
6064 Assume no next for now. This is fixed up above on the next
6065 iteration, if there's any. */
6066 target_tracepoint.next = NULL;
6067 /* Need to clear this here too, since we're downloading the
6068 tracepoints before clearing our own copy. */
6069 target_tracepoint.hit_count = 0;
6071 target_write_memory (tpptr, (unsigned char *) &target_tracepoint,
6072 sizeof (target_tracepoint));
6074 if (tpoint->cond)
6075 write_inferior_data_pointer (tpptr
6076 + offsetof (struct tracepoint, cond),
6077 download_agent_expr (tpoint->cond));
6079 if (tpoint->numactions)
6081 int i;
6082 CORE_ADDR actions_array;
6084 /* The pointers array. */
6085 actions_array
6086 = target_malloc (sizeof (*tpoint->actions) * tpoint->numactions);
6087 write_inferior_data_pointer (tpptr + offsetof (struct tracepoint,
6088 actions),
6089 actions_array);
6091 /* Now for each pointer, download the action. */
6092 for (i = 0; i < tpoint->numactions; i++)
6094 struct tracepoint_action *action = tpoint->actions[i];
6095 CORE_ADDR ipa_action = tracepoint_action_download (action);
6097 if (ipa_action != 0)
6098 write_inferior_data_pointer (actions_array
6099 + i * sizeof (*tpoint->actions),
6100 ipa_action);
6105 #define IPA_PROTO_FAST_TRACE_FLAG 0
6106 #define IPA_PROTO_FAST_TRACE_ADDR_ON_TARGET 2
6107 #define IPA_PROTO_FAST_TRACE_JUMP_PAD 10
6108 #define IPA_PROTO_FAST_TRACE_FJUMP_SIZE 18
6109 #define IPA_PROTO_FAST_TRACE_FJUMP_INSN 22
6111 /* Send a command to agent to download and install tracepoint TPOINT. */
6113 static int
6114 tracepoint_send_agent (struct tracepoint *tpoint)
6116 char buf[IPA_CMD_BUF_SIZE];
6117 char *p;
6118 int i, ret;
6120 p = buf;
6121 strcpy (p, "FastTrace:");
6122 p += 10;
6124 COPY_FIELD_TO_BUF (p, tpoint, number);
6125 COPY_FIELD_TO_BUF (p, tpoint, address);
6126 COPY_FIELD_TO_BUF (p, tpoint, type);
6127 COPY_FIELD_TO_BUF (p, tpoint, enabled);
6128 COPY_FIELD_TO_BUF (p, tpoint, step_count);
6129 COPY_FIELD_TO_BUF (p, tpoint, pass_count);
6130 COPY_FIELD_TO_BUF (p, tpoint, numactions);
6131 COPY_FIELD_TO_BUF (p, tpoint, hit_count);
6132 COPY_FIELD_TO_BUF (p, tpoint, traceframe_usage);
6133 COPY_FIELD_TO_BUF (p, tpoint, compiled_cond);
6134 COPY_FIELD_TO_BUF (p, tpoint, orig_size);
6136 /* condition */
6137 p = agent_expr_send (p, tpoint->cond);
6139 /* tracepoint_action */
6140 for (i = 0; i < tpoint->numactions; i++)
6142 struct tracepoint_action *action = tpoint->actions[i];
6144 p[0] = action->type;
6145 p = tracepoint_action_send (&p[1], action);
6148 get_jump_space_head ();
6149 /* Copy the value of GDB_JUMP_PAD_HEAD to command buffer, so that
6150 agent can use jump pad from it. */
6151 if (tpoint->type == fast_tracepoint)
6153 memcpy (p, &gdb_jump_pad_head, 8);
6154 p += 8;
6157 ret = run_inferior_command (buf, (int) (ptrdiff_t) (p - buf));
6158 if (ret)
6159 return ret;
6161 if (!startswith (buf, "OK"))
6162 return 1;
6164 /* The value of tracepoint's target address is stored in BUF. */
6165 memcpy (&tpoint->obj_addr_on_target,
6166 &buf[IPA_PROTO_FAST_TRACE_ADDR_ON_TARGET], 8);
6168 if (tpoint->type == fast_tracepoint)
6170 unsigned char *insn
6171 = (unsigned char *) &buf[IPA_PROTO_FAST_TRACE_FJUMP_INSN];
6172 int fjump_size;
6174 trace_debug ("agent: read from cmd_buf 0x%x 0x%x\n",
6175 (unsigned int) tpoint->obj_addr_on_target,
6176 (unsigned int) gdb_jump_pad_head);
6178 memcpy (&gdb_jump_pad_head, &buf[IPA_PROTO_FAST_TRACE_JUMP_PAD], 8);
6180 /* This has been done in agent. We should also set up record for it. */
6181 memcpy (&fjump_size, &buf[IPA_PROTO_FAST_TRACE_FJUMP_SIZE], 4);
6182 /* Wire it in. */
6183 tpoint->handle
6184 = set_fast_tracepoint_jump (tpoint->address, insn, fjump_size);
6187 return 0;
6190 static void
6191 download_tracepoint (struct tracepoint *tpoint)
6193 struct tracepoint *tp, *tp_prev;
6195 if (tpoint->type != fast_tracepoint
6196 && tpoint->type != static_tracepoint)
6197 return;
6199 download_tracepoint_1 (tpoint);
6201 /* Find the previous entry of TPOINT, which is fast tracepoint or
6202 static tracepoint. */
6203 tp_prev = NULL;
6204 for (tp = tracepoints; tp != tpoint; tp = tp->next)
6206 if (tp->type == fast_tracepoint || tp->type == static_tracepoint)
6207 tp_prev = tp;
6210 if (tp_prev)
6212 CORE_ADDR tp_prev_target_next_addr;
6214 /* Insert TPOINT after TP_PREV in IPA. */
6215 if (read_inferior_data_pointer (tp_prev->obj_addr_on_target
6216 + offsetof (struct tracepoint, next),
6217 &tp_prev_target_next_addr))
6219 internal_error (__FILE__, __LINE__,
6220 "error reading `tp_prev->next'");
6223 /* tpoint->next = tp_prev->next */
6224 write_inferior_data_pointer (tpoint->obj_addr_on_target
6225 + offsetof (struct tracepoint, next),
6226 tp_prev_target_next_addr);
6227 /* tp_prev->next = tpoint */
6228 write_inferior_data_pointer (tp_prev->obj_addr_on_target
6229 + offsetof (struct tracepoint, next),
6230 tpoint->obj_addr_on_target);
6232 else
6233 /* First object in list, set the head pointer in the
6234 inferior. */
6235 write_inferior_data_pointer (ipa_sym_addrs.addr_tracepoints,
6236 tpoint->obj_addr_on_target);
6240 static void
6241 download_trace_state_variables (void)
6243 CORE_ADDR ptr = 0, prev_ptr = 0;
6244 struct trace_state_variable *tsv;
6246 /* Start out empty. */
6247 write_inferior_data_pointer (ipa_sym_addrs.addr_trace_state_variables, 0);
6249 for (tsv = trace_state_variables; tsv != NULL; tsv = tsv->next)
6251 struct trace_state_variable target_tsv;
6253 /* TSV's with a getter have been initialized equally in both the
6254 inferior and GDBserver. Skip them. */
6255 if (tsv->getter != NULL)
6256 continue;
6258 target_tsv = *tsv;
6260 prev_ptr = ptr;
6261 ptr = target_malloc (sizeof (*tsv));
6263 if (tsv == trace_state_variables)
6265 /* First object in list, set the head pointer in the
6266 inferior. */
6268 write_inferior_data_pointer (ipa_sym_addrs.addr_trace_state_variables,
6269 ptr);
6271 else
6273 write_inferior_data_pointer (prev_ptr
6274 + offsetof (struct trace_state_variable,
6275 next),
6276 ptr);
6279 /* Write the whole object. We'll fix up its pointers in a bit.
6280 Assume no next, fixup when needed. */
6281 target_tsv.next = NULL;
6283 target_write_memory (ptr, (unsigned char *) &target_tsv,
6284 sizeof (target_tsv));
6286 if (tsv->name != NULL)
6288 size_t size = strlen (tsv->name) + 1;
6289 CORE_ADDR name_addr = target_malloc (size);
6290 target_write_memory (name_addr,
6291 (unsigned char *) tsv->name, size);
6292 write_inferior_data_pointer (ptr
6293 + offsetof (struct trace_state_variable,
6294 name),
6295 name_addr);
6298 gdb_assert (tsv->getter == NULL);
6301 if (prev_ptr != 0)
6303 /* Fixup the next pointer in the last item in the list. */
6304 write_inferior_data_pointer (prev_ptr
6305 + offsetof (struct trace_state_variable,
6306 next), 0);
6310 /* Upload complete trace frames out of the IP Agent's trace buffer
6311 into GDBserver's trace buffer. This always uploads either all or
6312 no trace frames. This is the counter part of
6313 `trace_alloc_trace_buffer'. See its description of the atomic
6314 syncing mechanism. */
6316 static void
6317 upload_fast_traceframes (void)
6319 unsigned int ipa_traceframe_read_count, ipa_traceframe_write_count;
6320 unsigned int ipa_traceframe_read_count_racy, ipa_traceframe_write_count_racy;
6321 CORE_ADDR tf;
6322 struct ipa_trace_buffer_control ipa_trace_buffer_ctrl;
6323 unsigned int curr_tbctrl_idx;
6324 unsigned int ipa_trace_buffer_ctrl_curr;
6325 unsigned int ipa_trace_buffer_ctrl_curr_old;
6326 CORE_ADDR ipa_trace_buffer_ctrl_addr;
6327 struct breakpoint *about_to_request_buffer_space_bkpt;
6328 CORE_ADDR ipa_trace_buffer_lo;
6329 CORE_ADDR ipa_trace_buffer_hi;
6331 if (read_inferior_uinteger (ipa_sym_addrs.addr_traceframe_read_count,
6332 &ipa_traceframe_read_count_racy))
6334 /* This will happen in most targets if the current thread is
6335 running. */
6336 return;
6339 if (read_inferior_uinteger (ipa_sym_addrs.addr_traceframe_write_count,
6340 &ipa_traceframe_write_count_racy))
6341 return;
6343 trace_debug ("ipa_traceframe_count (racy area): %d (w=%d, r=%d)",
6344 ipa_traceframe_write_count_racy
6345 - ipa_traceframe_read_count_racy,
6346 ipa_traceframe_write_count_racy,
6347 ipa_traceframe_read_count_racy);
6349 if (ipa_traceframe_write_count_racy == ipa_traceframe_read_count_racy)
6350 return;
6352 about_to_request_buffer_space_bkpt
6353 = set_breakpoint_at (ipa_sym_addrs.addr_about_to_request_buffer_space,
6354 NULL);
6356 if (read_inferior_uinteger (ipa_sym_addrs.addr_trace_buffer_ctrl_curr,
6357 &ipa_trace_buffer_ctrl_curr))
6358 return;
6360 ipa_trace_buffer_ctrl_curr_old = ipa_trace_buffer_ctrl_curr;
6362 curr_tbctrl_idx = ipa_trace_buffer_ctrl_curr & ~GDBSERVER_FLUSH_COUNT_MASK;
6365 unsigned int prev, counter;
6367 /* Update the token, with new counters, and the GDBserver stamp
6368 bit. Alway reuse the current TBC index. */
6369 prev = ipa_trace_buffer_ctrl_curr & GDBSERVER_FLUSH_COUNT_MASK_CURR;
6370 counter = (prev + 0x100) & GDBSERVER_FLUSH_COUNT_MASK_CURR;
6372 ipa_trace_buffer_ctrl_curr = (GDBSERVER_UPDATED_FLUSH_COUNT_BIT
6373 | (prev << 12)
6374 | counter
6375 | curr_tbctrl_idx);
6378 if (write_inferior_uinteger (ipa_sym_addrs.addr_trace_buffer_ctrl_curr,
6379 ipa_trace_buffer_ctrl_curr))
6380 return;
6382 trace_debug ("Lib: Committed %08x -> %08x",
6383 ipa_trace_buffer_ctrl_curr_old,
6384 ipa_trace_buffer_ctrl_curr);
6386 /* Re-read these, now that we've installed the
6387 `about_to_request_buffer_space' breakpoint/lock. A thread could
6388 have finished a traceframe between the last read of these
6389 counters and setting the breakpoint above. If we start
6390 uploading, we never want to leave this function with
6391 traceframe_read_count != 0, otherwise, GDBserver could end up
6392 incrementing the counter tokens more than once (due to event loop
6393 nesting), which would break the IP agent's "effective" detection
6394 (see trace_alloc_trace_buffer). */
6395 if (read_inferior_uinteger (ipa_sym_addrs.addr_traceframe_read_count,
6396 &ipa_traceframe_read_count))
6397 return;
6398 if (read_inferior_uinteger (ipa_sym_addrs.addr_traceframe_write_count,
6399 &ipa_traceframe_write_count))
6400 return;
6402 if (debug_threads)
6404 trace_debug ("ipa_traceframe_count (blocked area): %d (w=%d, r=%d)",
6405 ipa_traceframe_write_count - ipa_traceframe_read_count,
6406 ipa_traceframe_write_count, ipa_traceframe_read_count);
6408 if (ipa_traceframe_write_count != ipa_traceframe_write_count_racy
6409 || ipa_traceframe_read_count != ipa_traceframe_read_count_racy)
6410 trace_debug ("note that ipa_traceframe_count's parts changed");
6413 /* Get the address of the current TBC object (the IP agent has an
6414 array of 3 such objects). The index is stored in the TBC
6415 token. */
6416 ipa_trace_buffer_ctrl_addr = ipa_sym_addrs.addr_trace_buffer_ctrl;
6417 ipa_trace_buffer_ctrl_addr
6418 += sizeof (struct ipa_trace_buffer_control) * curr_tbctrl_idx;
6420 if (read_inferior_memory (ipa_trace_buffer_ctrl_addr,
6421 (unsigned char *) &ipa_trace_buffer_ctrl,
6422 sizeof (struct ipa_trace_buffer_control)))
6423 return;
6425 if (read_inferior_data_pointer (ipa_sym_addrs.addr_trace_buffer_lo,
6426 &ipa_trace_buffer_lo))
6427 return;
6428 if (read_inferior_data_pointer (ipa_sym_addrs.addr_trace_buffer_hi,
6429 &ipa_trace_buffer_hi))
6430 return;
6432 /* Offsets are easier to grok for debugging than raw addresses,
6433 especially for the small trace buffer sizes that are useful for
6434 testing. */
6435 trace_debug ("Lib: Trace buffer [%d] start=%d free=%d "
6436 "endfree=%d wrap=%d hi=%d",
6437 curr_tbctrl_idx,
6438 (int) (ipa_trace_buffer_ctrl.start - ipa_trace_buffer_lo),
6439 (int) (ipa_trace_buffer_ctrl.free - ipa_trace_buffer_lo),
6440 (int) (ipa_trace_buffer_ctrl.end_free - ipa_trace_buffer_lo),
6441 (int) (ipa_trace_buffer_ctrl.wrap - ipa_trace_buffer_lo),
6442 (int) (ipa_trace_buffer_hi - ipa_trace_buffer_lo));
6444 /* Note that the IPA's buffer is always circular. */
6446 #define IPA_FIRST_TRACEFRAME() (ipa_trace_buffer_ctrl.start)
6448 #define IPA_NEXT_TRACEFRAME_1(TF, TFOBJ) \
6449 ((TF) + sizeof (struct traceframe) + (TFOBJ)->data_size)
6451 #define IPA_NEXT_TRACEFRAME(TF, TFOBJ) \
6452 (IPA_NEXT_TRACEFRAME_1 (TF, TFOBJ) \
6453 - ((IPA_NEXT_TRACEFRAME_1 (TF, TFOBJ) >= ipa_trace_buffer_ctrl.wrap) \
6454 ? (ipa_trace_buffer_ctrl.wrap - ipa_trace_buffer_lo) \
6455 : 0))
6457 tf = IPA_FIRST_TRACEFRAME ();
6459 while (ipa_traceframe_write_count - ipa_traceframe_read_count)
6461 struct tracepoint *tpoint;
6462 struct traceframe *tframe;
6463 unsigned char *block;
6464 struct traceframe ipa_tframe;
6466 if (read_inferior_memory (tf, (unsigned char *) &ipa_tframe,
6467 offsetof (struct traceframe, data)))
6468 error ("Uploading: couldn't read traceframe at %s\n", paddress (tf));
6470 if (ipa_tframe.tpnum == 0)
6472 internal_error (__FILE__, __LINE__,
6473 "Uploading: No (more) fast traceframes, but"
6474 " ipa_traceframe_count == %u??\n",
6475 ipa_traceframe_write_count
6476 - ipa_traceframe_read_count);
6479 /* Note that this will be incorrect for multi-location
6480 tracepoints... */
6481 tpoint = find_next_tracepoint_by_number (NULL, ipa_tframe.tpnum);
6483 tframe = add_traceframe (tpoint);
6484 if (tframe == NULL)
6486 trace_buffer_is_full = 1;
6487 trace_debug ("Uploading: trace buffer is full");
6489 else
6491 /* Copy the whole set of blocks in one go for now. FIXME:
6492 split this in smaller blocks. */
6493 block = add_traceframe_block (tframe, tpoint,
6494 ipa_tframe.data_size);
6495 if (block != NULL)
6497 if (read_inferior_memory (tf
6498 + offsetof (struct traceframe, data),
6499 block, ipa_tframe.data_size))
6500 error ("Uploading: Couldn't read traceframe data at %s\n",
6501 paddress (tf + offsetof (struct traceframe, data)));
6504 trace_debug ("Uploading: traceframe didn't fit");
6505 finish_traceframe (tframe);
6508 tf = IPA_NEXT_TRACEFRAME (tf, &ipa_tframe);
6510 /* If we freed the traceframe that wrapped around, go back
6511 to the non-wrap case. */
6512 if (tf < ipa_trace_buffer_ctrl.start)
6514 trace_debug ("Lib: Discarding past the wraparound");
6515 ipa_trace_buffer_ctrl.wrap = ipa_trace_buffer_hi;
6517 ipa_trace_buffer_ctrl.start = tf;
6518 ipa_trace_buffer_ctrl.end_free = ipa_trace_buffer_ctrl.start;
6519 ++ipa_traceframe_read_count;
6521 if (ipa_trace_buffer_ctrl.start == ipa_trace_buffer_ctrl.free
6522 && ipa_trace_buffer_ctrl.start == ipa_trace_buffer_ctrl.end_free)
6524 trace_debug ("Lib: buffer is fully empty. "
6525 "Trace buffer [%d] start=%d free=%d endfree=%d",
6526 curr_tbctrl_idx,
6527 (int) (ipa_trace_buffer_ctrl.start
6528 - ipa_trace_buffer_lo),
6529 (int) (ipa_trace_buffer_ctrl.free
6530 - ipa_trace_buffer_lo),
6531 (int) (ipa_trace_buffer_ctrl.end_free
6532 - ipa_trace_buffer_lo));
6534 ipa_trace_buffer_ctrl.start = ipa_trace_buffer_lo;
6535 ipa_trace_buffer_ctrl.free = ipa_trace_buffer_lo;
6536 ipa_trace_buffer_ctrl.end_free = ipa_trace_buffer_hi;
6537 ipa_trace_buffer_ctrl.wrap = ipa_trace_buffer_hi;
6540 trace_debug ("Uploaded a traceframe\n"
6541 "Lib: Trace buffer [%d] start=%d free=%d "
6542 "endfree=%d wrap=%d hi=%d",
6543 curr_tbctrl_idx,
6544 (int) (ipa_trace_buffer_ctrl.start - ipa_trace_buffer_lo),
6545 (int) (ipa_trace_buffer_ctrl.free - ipa_trace_buffer_lo),
6546 (int) (ipa_trace_buffer_ctrl.end_free
6547 - ipa_trace_buffer_lo),
6548 (int) (ipa_trace_buffer_ctrl.wrap - ipa_trace_buffer_lo),
6549 (int) (ipa_trace_buffer_hi - ipa_trace_buffer_lo));
6552 if (target_write_memory (ipa_trace_buffer_ctrl_addr,
6553 (unsigned char *) &ipa_trace_buffer_ctrl,
6554 sizeof (struct ipa_trace_buffer_control)))
6555 return;
6557 write_inferior_integer (ipa_sym_addrs.addr_traceframe_read_count,
6558 ipa_traceframe_read_count);
6560 trace_debug ("Done uploading traceframes [%d]\n", curr_tbctrl_idx);
6562 target_pause_all (true);
6564 delete_breakpoint (about_to_request_buffer_space_bkpt);
6565 about_to_request_buffer_space_bkpt = NULL;
6567 target_unpause_all (true);
6569 if (trace_buffer_is_full)
6570 stop_tracing ();
6572 #endif
6574 #ifdef IN_PROCESS_AGENT
6576 IP_AGENT_EXPORT_VAR int ust_loaded;
6577 IP_AGENT_EXPORT_VAR char cmd_buf[IPA_CMD_BUF_SIZE];
6579 #ifdef HAVE_UST
6581 /* Static tracepoints. */
6583 /* UST puts a "struct tracepoint" in the global namespace, which
6584 conflicts with our tracepoint. Arguably, being a library, it
6585 shouldn't take ownership of such a generic name. We work around it
6586 here. */
6587 #define tracepoint ust_tracepoint
6588 #include <ust/ust.h>
6589 #undef tracepoint
6591 extern int serialize_to_text (char *outbuf, int bufsize,
6592 const char *fmt, va_list ap);
6594 #define GDB_PROBE_NAME "gdb"
6596 /* We dynamically search for the UST symbols instead of linking them
6597 in. This lets the user decide if the application uses static
6598 tracepoints, instead of always pulling libust.so in. This vector
6599 holds pointers to all functions we care about. */
6601 static struct
6603 int (*serialize_to_text) (char *outbuf, int bufsize,
6604 const char *fmt, va_list ap);
6606 int (*ltt_probe_register) (struct ltt_available_probe *pdata);
6607 int (*ltt_probe_unregister) (struct ltt_available_probe *pdata);
6609 int (*ltt_marker_connect) (const char *channel, const char *mname,
6610 const char *pname);
6611 int (*ltt_marker_disconnect) (const char *channel, const char *mname,
6612 const char *pname);
6614 void (*marker_iter_start) (struct marker_iter *iter);
6615 void (*marker_iter_next) (struct marker_iter *iter);
6616 void (*marker_iter_stop) (struct marker_iter *iter);
6617 void (*marker_iter_reset) (struct marker_iter *iter);
6618 } ust_ops;
6620 #include <dlfcn.h>
6622 /* Cast through typeof to catch incompatible API changes. Since UST
6623 only builds with gcc, we can freely use gcc extensions here
6624 too. */
6625 #define GET_UST_SYM(SYM) \
6626 do \
6628 if (ust_ops.SYM == NULL) \
6629 ust_ops.SYM = (typeof (&SYM)) dlsym (RTLD_DEFAULT, #SYM); \
6630 if (ust_ops.SYM == NULL) \
6631 return 0; \
6632 } while (0)
6634 #define USTF(SYM) ust_ops.SYM
6636 /* Get pointers to all libust.so functions we care about. */
6638 static int
6639 dlsym_ust (void)
6641 GET_UST_SYM (serialize_to_text);
6643 GET_UST_SYM (ltt_probe_register);
6644 GET_UST_SYM (ltt_probe_unregister);
6645 GET_UST_SYM (ltt_marker_connect);
6646 GET_UST_SYM (ltt_marker_disconnect);
6648 GET_UST_SYM (marker_iter_start);
6649 GET_UST_SYM (marker_iter_next);
6650 GET_UST_SYM (marker_iter_stop);
6651 GET_UST_SYM (marker_iter_reset);
6653 ust_loaded = 1;
6654 return 1;
6657 /* Given an UST marker, return the matching gdb static tracepoint.
6658 The match is done by address. */
6660 static struct tracepoint *
6661 ust_marker_to_static_tracepoint (const struct marker *mdata)
6663 struct tracepoint *tpoint;
6665 for (tpoint = tracepoints; tpoint; tpoint = tpoint->next)
6667 if (tpoint->type != static_tracepoint)
6668 continue;
6670 if (tpoint->address == (uintptr_t) mdata->location)
6671 return tpoint;
6674 return NULL;
6677 /* The probe function we install on lttng/ust markers. Whenever a
6678 probed ust marker is hit, this function is called. This is similar
6679 to gdb_collect, only for static tracepoints, instead of fast
6680 tracepoints. */
6682 static void
6683 gdb_probe (const struct marker *mdata, void *probe_private,
6684 struct registers *regs, void *call_private,
6685 const char *fmt, va_list *args)
6687 struct tracepoint *tpoint;
6688 struct static_tracepoint_ctx ctx;
6689 const struct target_desc *ipa_tdesc;
6691 /* Don't do anything until the trace run is completely set up. */
6692 if (!tracing)
6694 trace_debug ("gdb_probe: not tracing\n");
6695 return;
6698 ipa_tdesc = get_ipa_tdesc (ipa_tdesc_idx);
6699 ctx.base.type = static_tracepoint;
6700 ctx.regcache_initted = 0;
6701 ctx.regs = regs;
6702 ctx.fmt = fmt;
6703 ctx.args = args;
6705 /* Wrap the regblock in a register cache (in the stack, we don't
6706 want to malloc here). */
6707 ctx.regspace = alloca (ipa_tdesc->registers_size);
6708 if (ctx.regspace == NULL)
6710 trace_debug ("Trace buffer block allocation failed, skipping");
6711 return;
6714 tpoint = ust_marker_to_static_tracepoint (mdata);
6715 if (tpoint == NULL)
6717 trace_debug ("gdb_probe: marker not known: "
6718 "loc:0x%p, ch:\"%s\",n:\"%s\",f:\"%s\"",
6719 mdata->location, mdata->channel,
6720 mdata->name, mdata->format);
6721 return;
6724 if (!tpoint->enabled)
6726 trace_debug ("gdb_probe: tracepoint disabled");
6727 return;
6730 ctx.tpoint = tpoint;
6732 trace_debug ("gdb_probe: collecting marker: "
6733 "loc:0x%p, ch:\"%s\",n:\"%s\",f:\"%s\"",
6734 mdata->location, mdata->channel,
6735 mdata->name, mdata->format);
6737 /* Test the condition if present, and collect if true. */
6738 if (tpoint->cond == NULL
6739 || condition_true_at_tracepoint ((struct tracepoint_hit_ctx *) &ctx,
6740 tpoint))
6742 collect_data_at_tracepoint ((struct tracepoint_hit_ctx *) &ctx,
6743 tpoint->address, tpoint);
6745 if (stopping_tracepoint
6746 || trace_buffer_is_full
6747 || expr_eval_result != expr_eval_no_error)
6748 stop_tracing ();
6750 else
6752 /* If there was a condition and it evaluated to false, the only
6753 way we would stop tracing is if there was an error during
6754 condition expression evaluation. */
6755 if (expr_eval_result != expr_eval_no_error)
6756 stop_tracing ();
6760 /* Called if the gdb static tracepoint requested collecting "$_sdata",
6761 static tracepoint string data. This is a string passed to the
6762 tracing library by the user, at the time of the tracepoint marker
6763 call. E.g., in the UST marker call:
6765 trace_mark (ust, bar33, "str %s", "FOOBAZ");
6767 the collected data is "str FOOBAZ".
6770 static void
6771 collect_ust_data_at_tracepoint (struct tracepoint_hit_ctx *ctx,
6772 struct traceframe *tframe)
6774 struct static_tracepoint_ctx *umd = (struct static_tracepoint_ctx *) ctx;
6775 unsigned char *bufspace;
6776 int size;
6777 va_list copy;
6778 unsigned short blocklen;
6780 if (umd == NULL)
6782 trace_debug ("Wanted to collect static trace data, "
6783 "but there's no static trace data");
6784 return;
6787 va_copy (copy, *umd->args);
6788 size = USTF(serialize_to_text) (NULL, 0, umd->fmt, copy);
6789 va_end (copy);
6791 trace_debug ("Want to collect ust data");
6793 /* 'S' + size + string */
6794 bufspace = add_traceframe_block (tframe, umd->tpoint,
6795 1 + sizeof (blocklen) + size + 1);
6796 if (bufspace == NULL)
6798 trace_debug ("Trace buffer block allocation failed, skipping");
6799 return;
6802 /* Identify a static trace data block. */
6803 *bufspace = 'S';
6805 blocklen = size + 1;
6806 memcpy (bufspace + 1, &blocklen, sizeof (blocklen));
6808 va_copy (copy, *umd->args);
6809 USTF(serialize_to_text) ((char *) bufspace + 1 + sizeof (blocklen),
6810 size + 1, umd->fmt, copy);
6811 va_end (copy);
6813 trace_debug ("Storing static tracepoint data in regblock: %s",
6814 bufspace + 1 + sizeof (blocklen));
6817 /* The probe to register with lttng/ust. */
6818 static struct ltt_available_probe gdb_ust_probe =
6820 GDB_PROBE_NAME,
6821 NULL,
6822 gdb_probe,
6825 #endif /* HAVE_UST */
6826 #endif /* IN_PROCESS_AGENT */
6828 #ifndef IN_PROCESS_AGENT
6830 /* Ask the in-process agent to run a command. Since we don't want to
6831 have to handle the IPA hitting breakpoints while running the
6832 command, we pause all threads, remove all breakpoints, and then set
6833 the helper thread re-running. We communicate with the helper
6834 thread by means of direct memory xfering, and a socket for
6835 synchronization. */
6837 static int
6838 run_inferior_command (char *cmd, int len)
6840 int err = -1;
6841 int pid = current_ptid.pid ();
6843 trace_debug ("run_inferior_command: running: %s", cmd);
6845 target_pause_all (false);
6846 uninsert_all_breakpoints ();
6848 err = agent_run_command (pid, (const char *) cmd, len);
6850 reinsert_all_breakpoints ();
6851 target_unpause_all (false);
6853 return err;
6856 #else /* !IN_PROCESS_AGENT */
6858 #include <sys/socket.h>
6859 #include <sys/un.h>
6861 #ifndef UNIX_PATH_MAX
6862 #define UNIX_PATH_MAX sizeof(((struct sockaddr_un *) NULL)->sun_path)
6863 #endif
6865 /* Where we put the socked used for synchronization. */
6866 #define SOCK_DIR P_tmpdir
6868 /* Thread ID of the helper thread. GDBserver reads this to know which
6869 is the help thread. This is an LWP id on Linux. */
6870 EXTERN_C_PUSH
6871 IP_AGENT_EXPORT_VAR int helper_thread_id;
6872 EXTERN_C_POP
6874 static int
6875 init_named_socket (const char *name)
6877 int result, fd;
6878 struct sockaddr_un addr;
6880 result = fd = socket (PF_UNIX, SOCK_STREAM, 0);
6881 if (result == -1)
6883 warning ("socket creation failed: %s", safe_strerror (errno));
6884 return -1;
6887 addr.sun_family = AF_UNIX;
6889 if (strlen (name) >= ARRAY_SIZE (addr.sun_path))
6891 warning ("socket name too long for sockaddr_un::sun_path field: %s", name);
6892 return -1;
6895 strcpy (addr.sun_path, name);
6897 result = access (name, F_OK);
6898 if (result == 0)
6900 /* File exists. */
6901 result = unlink (name);
6902 if (result == -1)
6904 warning ("unlink failed: %s", safe_strerror (errno));
6905 close (fd);
6906 return -1;
6908 warning ("socket %s already exists; overwriting", name);
6911 result = bind (fd, (struct sockaddr *) &addr, sizeof (addr));
6912 if (result == -1)
6914 warning ("bind failed: %s", safe_strerror (errno));
6915 close (fd);
6916 return -1;
6919 result = listen (fd, 1);
6920 if (result == -1)
6922 warning ("listen: %s", safe_strerror (errno));
6923 close (fd);
6924 return -1;
6927 return fd;
6930 static char agent_socket_name[UNIX_PATH_MAX];
6932 static int
6933 gdb_agent_socket_init (void)
6935 int result, fd;
6937 result = snprintf (agent_socket_name, UNIX_PATH_MAX, "%s/gdb_ust%d",
6938 SOCK_DIR, getpid ());
6939 if (result >= UNIX_PATH_MAX)
6941 trace_debug ("string overflow allocating socket name");
6942 return -1;
6945 fd = init_named_socket (agent_socket_name);
6946 if (fd < 0)
6947 warning ("Error initializing named socket (%s) for communication with the "
6948 "ust helper thread. Check that directory exists and that it "
6949 "is writable.", agent_socket_name);
6951 return fd;
6954 #ifdef HAVE_UST
6956 /* The next marker to be returned on a qTsSTM command. */
6957 static const struct marker *next_st;
6959 /* Returns the first known marker. */
6961 struct marker *
6962 first_marker (void)
6964 struct marker_iter iter;
6966 USTF(marker_iter_reset) (&iter);
6967 USTF(marker_iter_start) (&iter);
6969 return iter.marker;
6972 /* Returns the marker following M. */
6974 const struct marker *
6975 next_marker (const struct marker *m)
6977 struct marker_iter iter;
6979 USTF(marker_iter_reset) (&iter);
6980 USTF(marker_iter_start) (&iter);
6982 for (; iter.marker != NULL; USTF(marker_iter_next) (&iter))
6984 if (iter.marker == m)
6986 USTF(marker_iter_next) (&iter);
6987 return iter.marker;
6991 return NULL;
6994 /* Return an hexstr version of the STR C string, fit for sending to
6995 GDB. */
6997 static char *
6998 cstr_to_hexstr (const char *str)
7000 int len = strlen (str);
7001 char *hexstr = xmalloc (len * 2 + 1);
7002 bin2hex ((gdb_byte *) str, hexstr, len);
7003 return hexstr;
7006 /* Compose packet that is the response to the qTsSTM/qTfSTM/qTSTMat
7007 packets. */
7009 static void
7010 response_ust_marker (char *packet, const struct marker *st)
7012 char *strid, *format, *tmp;
7014 next_st = next_marker (st);
7016 tmp = xmalloc (strlen (st->channel) + 1 +
7017 strlen (st->name) + 1);
7018 sprintf (tmp, "%s/%s", st->channel, st->name);
7020 strid = cstr_to_hexstr (tmp);
7021 free (tmp);
7023 format = cstr_to_hexstr (st->format);
7025 sprintf (packet, "m%s:%s:%s",
7026 paddress ((uintptr_t) st->location),
7027 strid,
7028 format);
7030 free (strid);
7031 free (format);
7034 /* Return the first static tracepoint, and initialize the state
7035 machine that will iterate through all the static tracepoints. */
7037 static void
7038 cmd_qtfstm (char *packet)
7040 trace_debug ("Returning first trace state variable definition");
7042 if (first_marker ())
7043 response_ust_marker (packet, first_marker ());
7044 else
7045 strcpy (packet, "l");
7048 /* Return additional trace state variable definitions. */
7050 static void
7051 cmd_qtsstm (char *packet)
7053 trace_debug ("Returning static tracepoint");
7055 if (next_st)
7056 response_ust_marker (packet, next_st);
7057 else
7058 strcpy (packet, "l");
7061 /* Disconnect the GDB probe from a marker at a given address. */
7063 static void
7064 unprobe_marker_at (char *packet)
7066 char *p = packet;
7067 ULONGEST address;
7068 struct marker_iter iter;
7070 p += sizeof ("unprobe_marker_at:") - 1;
7072 p = unpack_varlen_hex (p, &address);
7074 USTF(marker_iter_reset) (&iter);
7075 USTF(marker_iter_start) (&iter);
7076 for (; iter.marker != NULL; USTF(marker_iter_next) (&iter))
7077 if ((uintptr_t ) iter.marker->location == address)
7079 int result;
7081 result = USTF(ltt_marker_disconnect) (iter.marker->channel,
7082 iter.marker->name,
7083 GDB_PROBE_NAME);
7084 if (result < 0)
7085 warning ("could not disable marker %s/%s",
7086 iter.marker->channel, iter.marker->name);
7087 break;
7091 /* Connect the GDB probe to a marker at a given address. */
7093 static int
7094 probe_marker_at (char *packet)
7096 char *p = packet;
7097 ULONGEST address;
7098 struct marker_iter iter;
7099 struct marker *m;
7101 p += sizeof ("probe_marker_at:") - 1;
7103 p = unpack_varlen_hex (p, &address);
7105 USTF(marker_iter_reset) (&iter);
7107 for (USTF(marker_iter_start) (&iter), m = iter.marker;
7108 m != NULL;
7109 USTF(marker_iter_next) (&iter), m = iter.marker)
7110 if ((uintptr_t ) m->location == address)
7112 int result;
7114 trace_debug ("found marker for address. "
7115 "ltt_marker_connect (marker = %s/%s)",
7116 m->channel, m->name);
7118 result = USTF(ltt_marker_connect) (m->channel, m->name,
7119 GDB_PROBE_NAME);
7120 if (result && result != -EEXIST)
7121 trace_debug ("ltt_marker_connect (marker = %s/%s, errno = %d)",
7122 m->channel, m->name, -result);
7124 if (result < 0)
7126 sprintf (packet, "E.could not connect marker: channel=%s, name=%s",
7127 m->channel, m->name);
7128 return -1;
7131 strcpy (packet, "OK");
7132 return 0;
7135 sprintf (packet, "E.no marker found at 0x%s", paddress (address));
7136 return -1;
7139 static int
7140 cmd_qtstmat (char *packet)
7142 char *p = packet;
7143 ULONGEST address;
7144 struct marker_iter iter;
7145 struct marker *m;
7147 p += sizeof ("qTSTMat:") - 1;
7149 p = unpack_varlen_hex (p, &address);
7151 USTF(marker_iter_reset) (&iter);
7153 for (USTF(marker_iter_start) (&iter), m = iter.marker;
7154 m != NULL;
7155 USTF(marker_iter_next) (&iter), m = iter.marker)
7156 if ((uintptr_t ) m->location == address)
7158 response_ust_marker (packet, m);
7159 return 0;
7162 strcpy (packet, "l");
7163 return -1;
7166 static void
7167 gdb_ust_init (void)
7169 if (!dlsym_ust ())
7170 return;
7172 USTF(ltt_probe_register) (&gdb_ust_probe);
7175 #endif /* HAVE_UST */
7177 #include <sys/syscall.h>
7179 static void
7180 gdb_agent_remove_socket (void)
7182 unlink (agent_socket_name);
7185 /* Helper thread of agent. */
7187 static void *
7188 gdb_agent_helper_thread (void *arg)
7190 int listen_fd;
7192 atexit (gdb_agent_remove_socket);
7194 while (1)
7196 listen_fd = gdb_agent_socket_init ();
7198 if (helper_thread_id == 0)
7199 helper_thread_id = syscall (SYS_gettid);
7201 if (listen_fd == -1)
7203 warning ("could not create sync socket");
7204 break;
7207 while (1)
7209 socklen_t tmp;
7210 struct sockaddr_un sockaddr;
7211 int fd;
7212 char buf[1];
7213 int ret;
7214 int stop_loop = 0;
7216 tmp = sizeof (sockaddr);
7220 fd = accept (listen_fd, (struct sockaddr *) &sockaddr, &tmp);
7222 /* It seems an ERESTARTSYS can escape out of accept. */
7223 while (fd == -512 || (fd == -1 && errno == EINTR));
7225 if (fd < 0)
7227 warning ("Accept returned %d, error: %s",
7228 fd, safe_strerror (errno));
7229 break;
7234 ret = read (fd, buf, 1);
7235 } while (ret == -1 && errno == EINTR);
7237 if (ret == -1)
7239 warning ("reading socket (fd=%d) failed with %s",
7240 fd, safe_strerror (errno));
7241 close (fd);
7242 break;
7245 if (cmd_buf[0])
7247 if (startswith (cmd_buf, "close"))
7249 stop_loop = 1;
7251 #ifdef HAVE_UST
7252 else if (strcmp ("qTfSTM", cmd_buf) == 0)
7254 cmd_qtfstm (cmd_buf);
7256 else if (strcmp ("qTsSTM", cmd_buf) == 0)
7258 cmd_qtsstm (cmd_buf);
7260 else if (startswith (cmd_buf, "unprobe_marker_at:"))
7262 unprobe_marker_at (cmd_buf);
7264 else if (startswith (cmd_buf, "probe_marker_at:"))
7266 probe_marker_at (cmd_buf);
7268 else if (startswith (cmd_buf, "qTSTMat:"))
7270 cmd_qtstmat (cmd_buf);
7272 #endif /* HAVE_UST */
7275 /* Fix compiler's warning: ignoring return value of 'write'. */
7276 ret = write (fd, buf, 1);
7277 close (fd);
7279 if (stop_loop)
7281 close (listen_fd);
7282 unlink (agent_socket_name);
7284 /* Sleep endlessly to wait the whole inferior stops. This
7285 thread can not exit because GDB or GDBserver may still need
7286 'current_thread' (representing this thread) to access
7287 inferior memory. Otherwise, this thread exits earlier than
7288 other threads, and 'current_thread' is set to NULL. */
7289 while (1)
7290 sleep (10);
7295 return NULL;
7298 #include <signal.h>
7299 #include <pthread.h>
7301 EXTERN_C_PUSH
7302 IP_AGENT_EXPORT_VAR int gdb_agent_capability = AGENT_CAPA_STATIC_TRACE;
7303 EXTERN_C_POP
7305 static void
7306 gdb_agent_init (void)
7308 int res;
7309 pthread_t thread;
7310 sigset_t new_mask;
7311 sigset_t orig_mask;
7313 /* We want the helper thread to be as transparent as possible, so
7314 have it inherit an all-signals-blocked mask. */
7316 sigfillset (&new_mask);
7317 res = pthread_sigmask (SIG_SETMASK, &new_mask, &orig_mask);
7318 if (res)
7319 perror_with_name ("pthread_sigmask (1)");
7321 res = pthread_create (&thread,
7322 NULL,
7323 gdb_agent_helper_thread,
7324 NULL);
7326 res = pthread_sigmask (SIG_SETMASK, &orig_mask, NULL);
7327 if (res)
7328 perror_with_name ("pthread_sigmask (2)");
7330 while (helper_thread_id == 0)
7331 usleep (1);
7333 #ifdef HAVE_UST
7334 gdb_ust_init ();
7335 #endif
7338 #include <sys/mman.h>
7340 IP_AGENT_EXPORT_VAR char *gdb_tp_heap_buffer;
7341 IP_AGENT_EXPORT_VAR char *gdb_jump_pad_buffer;
7342 IP_AGENT_EXPORT_VAR char *gdb_jump_pad_buffer_end;
7343 IP_AGENT_EXPORT_VAR char *gdb_trampoline_buffer;
7344 IP_AGENT_EXPORT_VAR char *gdb_trampoline_buffer_end;
7345 IP_AGENT_EXPORT_VAR char *gdb_trampoline_buffer_error;
7347 /* Record the result of getting buffer space for fast tracepoint
7348 trampolines. Any error message is copied, since caller may not be
7349 using persistent storage. */
7351 void
7352 set_trampoline_buffer_space (CORE_ADDR begin, CORE_ADDR end, char *errmsg)
7354 gdb_trampoline_buffer = (char *) (uintptr_t) begin;
7355 gdb_trampoline_buffer_end = (char *) (uintptr_t) end;
7356 if (errmsg)
7357 strncpy (gdb_trampoline_buffer_error, errmsg, 99);
7358 else
7359 strcpy (gdb_trampoline_buffer_error, "no buffer passed");
7362 static void __attribute__ ((constructor))
7363 initialize_tracepoint_ftlib (void)
7365 initialize_tracepoint ();
7367 gdb_agent_init ();
7370 #ifndef HAVE_GETAUXVAL
7371 /* Retrieve the value of TYPE from the auxiliary vector. If TYPE is not
7372 found, 0 is returned. This function is provided if glibc is too old. */
7374 unsigned long
7375 getauxval (unsigned long type)
7377 unsigned long data[2];
7378 FILE *f = fopen ("/proc/self/auxv", "r");
7379 unsigned long value = 0;
7381 if (f == NULL)
7382 return 0;
7384 while (fread (data, sizeof (data), 1, f) > 0)
7386 if (data[0] == type)
7388 value = data[1];
7389 break;
7393 fclose (f);
7394 return value;
7396 #endif
7398 #endif /* IN_PROCESS_AGENT */
7400 /* Return a timestamp, expressed as microseconds of the usual Unix
7401 time. (As the result is a 64-bit number, it will not overflow any
7402 time soon.) */
7404 static LONGEST
7405 get_timestamp (void)
7407 using namespace std::chrono;
7409 steady_clock::time_point now = steady_clock::now ();
7410 return duration_cast<microseconds> (now.time_since_epoch ()).count ();
7413 void
7414 initialize_tracepoint (void)
7416 /* Start with the default size. */
7417 init_trace_buffer (DEFAULT_TRACE_BUFFER_SIZE);
7419 /* Wire trace state variable 1 to be the timestamp. This will be
7420 uploaded to GDB upon connection and become one of its trace state
7421 variables. (In case you're wondering, if GDB already has a trace
7422 variable numbered 1, it will be renumbered.) */
7423 create_trace_state_variable (1, 0);
7424 set_trace_state_variable_name (1, "trace_timestamp");
7425 set_trace_state_variable_getter (1, get_timestamp);
7427 #ifdef IN_PROCESS_AGENT
7429 int pagesize;
7430 size_t jump_pad_size;
7432 pagesize = sysconf (_SC_PAGE_SIZE);
7433 if (pagesize == -1)
7434 perror_with_name ("sysconf");
7436 #define SCRATCH_BUFFER_NPAGES 20
7438 jump_pad_size = pagesize * SCRATCH_BUFFER_NPAGES;
7440 gdb_tp_heap_buffer = (char *) xmalloc (5 * 1024 * 1024);
7441 gdb_jump_pad_buffer = (char *) alloc_jump_pad_buffer (jump_pad_size);
7442 if (gdb_jump_pad_buffer == NULL)
7443 perror_with_name ("mmap");
7444 gdb_jump_pad_buffer_end = gdb_jump_pad_buffer + jump_pad_size;
7447 gdb_trampoline_buffer = gdb_trampoline_buffer_end = 0;
7449 /* It's not a fatal error for something to go wrong with trampoline
7450 buffer setup, but it can be mysterious, so create a channel to
7451 report back on what went wrong, using a fixed size since we may
7452 not be able to allocate space later when the problem occurs. */
7453 gdb_trampoline_buffer_error = (char *) xmalloc (IPA_BUFSIZ);
7455 strcpy (gdb_trampoline_buffer_error, "No errors reported");
7457 initialize_low_tracepoint ();
7458 #endif