[PATCH 12/57][Arm][GAS] Add support for MVE instructions: vaddlv and vaddv
[binutils-gdb.git] / gdb / tracefile-tfile.c
blob593556a8ba8935da475909fb6d82b57f2c15015d
1 /* Trace file TFILE format support in GDB.
3 Copyright (C) 1997-2019 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "defs.h"
21 #include "tracefile.h"
22 #include "readline/tilde.h"
23 #include "common/filestuff.h"
24 #include "common/rsp-low.h" /* bin2hex */
25 #include "regcache.h"
26 #include "inferior.h"
27 #include "gdbthread.h"
28 #include "exec.h" /* exec_bfd */
29 #include "completer.h"
30 #include "filenames.h"
31 #include "remote.h"
32 #include "xml-tdesc.h"
33 #include "target-descriptions.h"
34 #include "common/buffer.h"
35 #include <algorithm>
37 #ifndef O_LARGEFILE
38 #define O_LARGEFILE 0
39 #endif
41 /* The tfile target. */
43 static const target_info tfile_target_info = {
44 "tfile",
45 N_("Local trace dump file"),
46 N_("Use a trace file as a target. Specify the filename of the trace file.")
49 class tfile_target final : public tracefile_target
51 public:
52 const target_info &info () const override
53 { return tfile_target_info; }
55 void close () override;
56 void fetch_registers (struct regcache *, int) override;
57 enum target_xfer_status xfer_partial (enum target_object object,
58 const char *annex,
59 gdb_byte *readbuf,
60 const gdb_byte *writebuf,
61 ULONGEST offset, ULONGEST len,
62 ULONGEST *xfered_len) override;
63 void files_info () override;
64 int trace_find (enum trace_find_type type, int num,
65 CORE_ADDR addr1, CORE_ADDR addr2, int *tpp) override;
66 bool get_trace_state_variable_value (int tsv, LONGEST *val) override;
67 traceframe_info_up traceframe_info () override;
69 void get_tracepoint_status (struct breakpoint *tp,
70 struct uploaded_tp *utp) override;
73 /* TFILE trace writer. */
75 struct tfile_trace_file_writer
77 struct trace_file_writer base;
79 /* File pointer to tfile trace file. */
80 FILE *fp;
81 /* Path name of the tfile trace file. */
82 char *pathname;
85 /* This is the implementation of trace_file_write_ops method
86 target_save. We just call the generic target
87 target_save_trace_data to do target-side saving. */
89 static int
90 tfile_target_save (struct trace_file_writer *self,
91 const char *filename)
93 int err = target_save_trace_data (filename);
95 return (err >= 0);
98 /* This is the implementation of trace_file_write_ops method
99 dtor. */
101 static void
102 tfile_dtor (struct trace_file_writer *self)
104 struct tfile_trace_file_writer *writer
105 = (struct tfile_trace_file_writer *) self;
107 xfree (writer->pathname);
109 if (writer->fp != NULL)
110 fclose (writer->fp);
113 /* This is the implementation of trace_file_write_ops method
114 start. It creates the trace file FILENAME and registers some
115 cleanups. */
117 static void
118 tfile_start (struct trace_file_writer *self, const char *filename)
120 struct tfile_trace_file_writer *writer
121 = (struct tfile_trace_file_writer *) self;
123 writer->pathname = tilde_expand (filename);
124 writer->fp = gdb_fopen_cloexec (writer->pathname, "wb").release ();
125 if (writer->fp == NULL)
126 error (_("Unable to open file '%s' for saving trace data (%s)"),
127 writer->pathname, safe_strerror (errno));
130 /* This is the implementation of trace_file_write_ops method
131 write_header. Write the TFILE header. */
133 static void
134 tfile_write_header (struct trace_file_writer *self)
136 struct tfile_trace_file_writer *writer
137 = (struct tfile_trace_file_writer *) self;
138 int written;
140 /* Write a file header, with a high-bit-set char to indicate a
141 binary file, plus a hint as what this file is, and a version
142 number in case of future needs. */
143 written = fwrite ("\x7fTRACE0\n", 8, 1, writer->fp);
144 if (written < 1)
145 perror_with_name (writer->pathname);
148 /* This is the implementation of trace_file_write_ops method
149 write_regblock_type. Write the size of register block. */
151 static void
152 tfile_write_regblock_type (struct trace_file_writer *self, int size)
154 struct tfile_trace_file_writer *writer
155 = (struct tfile_trace_file_writer *) self;
157 fprintf (writer->fp, "R %x\n", size);
160 /* This is the implementation of trace_file_write_ops method
161 write_status. */
163 static void
164 tfile_write_status (struct trace_file_writer *self,
165 struct trace_status *ts)
167 struct tfile_trace_file_writer *writer
168 = (struct tfile_trace_file_writer *) self;
170 fprintf (writer->fp, "status %c;%s",
171 (ts->running ? '1' : '0'), stop_reason_names[ts->stop_reason]);
172 if (ts->stop_reason == tracepoint_error
173 || ts->stop_reason == trace_stop_command)
175 char *buf = (char *) alloca (strlen (ts->stop_desc) * 2 + 1);
177 bin2hex ((gdb_byte *) ts->stop_desc, buf, strlen (ts->stop_desc));
178 fprintf (writer->fp, ":%s", buf);
180 fprintf (writer->fp, ":%x", ts->stopping_tracepoint);
181 if (ts->traceframe_count >= 0)
182 fprintf (writer->fp, ";tframes:%x", ts->traceframe_count);
183 if (ts->traceframes_created >= 0)
184 fprintf (writer->fp, ";tcreated:%x", ts->traceframes_created);
185 if (ts->buffer_free >= 0)
186 fprintf (writer->fp, ";tfree:%x", ts->buffer_free);
187 if (ts->buffer_size >= 0)
188 fprintf (writer->fp, ";tsize:%x", ts->buffer_size);
189 if (ts->disconnected_tracing)
190 fprintf (writer->fp, ";disconn:%x", ts->disconnected_tracing);
191 if (ts->circular_buffer)
192 fprintf (writer->fp, ";circular:%x", ts->circular_buffer);
193 if (ts->start_time)
195 fprintf (writer->fp, ";starttime:%s",
196 phex_nz (ts->start_time, sizeof (ts->start_time)));
198 if (ts->stop_time)
200 fprintf (writer->fp, ";stoptime:%s",
201 phex_nz (ts->stop_time, sizeof (ts->stop_time)));
203 if (ts->notes != NULL)
205 char *buf = (char *) alloca (strlen (ts->notes) * 2 + 1);
207 bin2hex ((gdb_byte *) ts->notes, buf, strlen (ts->notes));
208 fprintf (writer->fp, ";notes:%s", buf);
210 if (ts->user_name != NULL)
212 char *buf = (char *) alloca (strlen (ts->user_name) * 2 + 1);
214 bin2hex ((gdb_byte *) ts->user_name, buf, strlen (ts->user_name));
215 fprintf (writer->fp, ";username:%s", buf);
217 fprintf (writer->fp, "\n");
220 /* This is the implementation of trace_file_write_ops method
221 write_uploaded_tsv. */
223 static void
224 tfile_write_uploaded_tsv (struct trace_file_writer *self,
225 struct uploaded_tsv *utsv)
227 char *buf = NULL;
228 struct tfile_trace_file_writer *writer
229 = (struct tfile_trace_file_writer *) self;
231 if (utsv->name)
233 buf = (char *) xmalloc (strlen (utsv->name) * 2 + 1);
234 bin2hex ((gdb_byte *) (utsv->name), buf, strlen (utsv->name));
237 fprintf (writer->fp, "tsv %x:%s:%x:%s\n",
238 utsv->number, phex_nz (utsv->initial_value, 8),
239 utsv->builtin, buf != NULL ? buf : "");
241 if (utsv->name)
242 xfree (buf);
245 #define MAX_TRACE_UPLOAD 2000
247 /* This is the implementation of trace_file_write_ops method
248 write_uploaded_tp. */
250 static void
251 tfile_write_uploaded_tp (struct trace_file_writer *self,
252 struct uploaded_tp *utp)
254 struct tfile_trace_file_writer *writer
255 = (struct tfile_trace_file_writer *) self;
256 char buf[MAX_TRACE_UPLOAD];
258 fprintf (writer->fp, "tp T%x:%s:%c:%x:%x",
259 utp->number, phex_nz (utp->addr, sizeof (utp->addr)),
260 (utp->enabled ? 'E' : 'D'), utp->step, utp->pass);
261 if (utp->type == bp_fast_tracepoint)
262 fprintf (writer->fp, ":F%x", utp->orig_size);
263 if (utp->cond)
264 fprintf (writer->fp,
265 ":X%x,%s", (unsigned int) strlen (utp->cond.get ()) / 2,
266 utp->cond.get ());
267 fprintf (writer->fp, "\n");
268 for (const auto &act : utp->actions)
269 fprintf (writer->fp, "tp A%x:%s:%s\n",
270 utp->number, phex_nz (utp->addr, sizeof (utp->addr)), act.get ());
271 for (const auto &act : utp->step_actions)
272 fprintf (writer->fp, "tp S%x:%s:%s\n",
273 utp->number, phex_nz (utp->addr, sizeof (utp->addr)), act.get ());
274 if (utp->at_string)
276 encode_source_string (utp->number, utp->addr,
277 "at", utp->at_string.get (),
278 buf, MAX_TRACE_UPLOAD);
279 fprintf (writer->fp, "tp Z%s\n", buf);
281 if (utp->cond_string)
283 encode_source_string (utp->number, utp->addr,
284 "cond", utp->cond_string.get (),
285 buf, MAX_TRACE_UPLOAD);
286 fprintf (writer->fp, "tp Z%s\n", buf);
288 for (const auto &act : utp->cmd_strings)
290 encode_source_string (utp->number, utp->addr, "cmd", act.get (),
291 buf, MAX_TRACE_UPLOAD);
292 fprintf (writer->fp, "tp Z%s\n", buf);
294 fprintf (writer->fp, "tp V%x:%s:%x:%s\n",
295 utp->number, phex_nz (utp->addr, sizeof (utp->addr)),
296 utp->hit_count,
297 phex_nz (utp->traceframe_usage,
298 sizeof (utp->traceframe_usage)));
301 /* This is the implementation of trace_file_write_ops method
302 write_tdesc. */
304 static void
305 tfile_write_tdesc (struct trace_file_writer *self)
307 struct tfile_trace_file_writer *writer
308 = (struct tfile_trace_file_writer *) self;
310 gdb::optional<std::string> tdesc
311 = target_fetch_description_xml (current_top_target ());
313 if (!tdesc)
314 return;
316 const char *ptr = tdesc->c_str ();
318 /* Write tdesc line by line, prefixing each line with "tdesc ". */
319 while (ptr != NULL)
321 const char *next = strchr (ptr, '\n');
322 if (next != NULL)
324 fprintf (writer->fp, "tdesc %.*s\n", (int) (next - ptr), ptr);
325 /* Skip the \n. */
326 next++;
328 else if (*ptr != '\0')
330 /* Last line, doesn't have a newline. */
331 fprintf (writer->fp, "tdesc %s\n", ptr);
333 ptr = next;
337 /* This is the implementation of trace_file_write_ops method
338 write_definition_end. */
340 static void
341 tfile_write_definition_end (struct trace_file_writer *self)
343 struct tfile_trace_file_writer *writer
344 = (struct tfile_trace_file_writer *) self;
346 fprintf (writer->fp, "\n");
349 /* This is the implementation of trace_file_write_ops method
350 write_raw_data. */
352 static void
353 tfile_write_raw_data (struct trace_file_writer *self, gdb_byte *buf,
354 LONGEST len)
356 struct tfile_trace_file_writer *writer
357 = (struct tfile_trace_file_writer *) self;
359 if (fwrite (buf, len, 1, writer->fp) < 1)
360 perror_with_name (writer->pathname);
363 /* This is the implementation of trace_file_write_ops method
364 end. */
366 static void
367 tfile_end (struct trace_file_writer *self)
369 struct tfile_trace_file_writer *writer
370 = (struct tfile_trace_file_writer *) self;
371 uint32_t gotten = 0;
373 /* Mark the end of trace data. */
374 if (fwrite (&gotten, 4, 1, writer->fp) < 1)
375 perror_with_name (writer->pathname);
378 /* Operations to write trace buffers into TFILE format. */
380 static const struct trace_file_write_ops tfile_write_ops =
382 tfile_dtor,
383 tfile_target_save,
384 tfile_start,
385 tfile_write_header,
386 tfile_write_regblock_type,
387 tfile_write_status,
388 tfile_write_uploaded_tsv,
389 tfile_write_uploaded_tp,
390 tfile_write_tdesc,
391 tfile_write_definition_end,
392 tfile_write_raw_data,
393 NULL,
394 tfile_end,
397 /* Return a trace writer for TFILE format. */
399 struct trace_file_writer *
400 tfile_trace_file_writer_new (void)
402 struct tfile_trace_file_writer *writer
403 = XNEW (struct tfile_trace_file_writer);
405 writer->base.ops = &tfile_write_ops;
406 writer->fp = NULL;
407 writer->pathname = NULL;
409 return (struct trace_file_writer *) writer;
412 /* target tfile command */
414 static tfile_target tfile_ops;
416 #define TRACE_HEADER_SIZE 8
418 #define TFILE_PID (1)
420 static char *trace_filename;
421 static int trace_fd = -1;
422 static off_t trace_frames_offset;
423 static off_t cur_offset;
424 static int cur_data_size;
425 int trace_regblock_size;
426 static struct buffer trace_tdesc;
428 static void tfile_append_tdesc_line (const char *line);
429 static void tfile_interp_line (char *line,
430 struct uploaded_tp **utpp,
431 struct uploaded_tsv **utsvp);
433 /* Read SIZE bytes into READBUF from the trace frame, starting at
434 TRACE_FD's current position. Note that this call `read'
435 underneath, hence it advances the file's seek position. Throws an
436 error if the `read' syscall fails, or less than SIZE bytes are
437 read. */
439 static void
440 tfile_read (gdb_byte *readbuf, int size)
442 int gotten;
444 gotten = read (trace_fd, readbuf, size);
445 if (gotten < 0)
446 perror_with_name (trace_filename);
447 else if (gotten < size)
448 error (_("Premature end of file while reading trace file"));
451 /* Open the tfile target. */
453 static void
454 tfile_target_open (const char *arg, int from_tty)
456 int flags;
457 int scratch_chan;
458 char header[TRACE_HEADER_SIZE];
459 char linebuf[1000]; /* Should be max remote packet size or so. */
460 gdb_byte byte;
461 int bytes, i;
462 struct trace_status *ts;
463 struct uploaded_tp *uploaded_tps = NULL;
464 struct uploaded_tsv *uploaded_tsvs = NULL;
466 target_preopen (from_tty);
467 if (!arg)
468 error (_("No trace file specified."));
470 gdb::unique_xmalloc_ptr<char> filename (tilde_expand (arg));
471 if (!IS_ABSOLUTE_PATH (filename.get ()))
472 filename.reset (concat (current_directory, "/", filename.get (),
473 (char *) NULL));
475 flags = O_BINARY | O_LARGEFILE;
476 flags |= O_RDONLY;
477 scratch_chan = gdb_open_cloexec (filename.get (), flags, 0);
478 if (scratch_chan < 0)
479 perror_with_name (filename.get ());
481 /* Looks semi-reasonable. Toss the old trace file and work on the new. */
483 unpush_target (&tfile_ops);
485 trace_filename = filename.release ();
486 trace_fd = scratch_chan;
488 /* Make sure this is clear. */
489 buffer_free (&trace_tdesc);
491 bytes = 0;
492 /* Read the file header and test for validity. */
493 tfile_read ((gdb_byte *) &header, TRACE_HEADER_SIZE);
495 bytes += TRACE_HEADER_SIZE;
496 if (!(header[0] == 0x7f
497 && (startswith (header + 1, "TRACE0\n"))))
498 error (_("File is not a valid trace file."));
500 push_target (&tfile_ops);
502 trace_regblock_size = 0;
503 ts = current_trace_status ();
504 /* We know we're working with a file. Record its name. */
505 ts->filename = trace_filename;
506 /* Set defaults in case there is no status line. */
507 ts->running_known = 0;
508 ts->stop_reason = trace_stop_reason_unknown;
509 ts->traceframe_count = -1;
510 ts->buffer_free = 0;
511 ts->disconnected_tracing = 0;
512 ts->circular_buffer = 0;
516 /* Read through a section of newline-terminated lines that
517 define things like tracepoints. */
518 i = 0;
519 while (1)
521 tfile_read (&byte, 1);
523 ++bytes;
524 if (byte == '\n')
526 /* Empty line marks end of the definition section. */
527 if (i == 0)
528 break;
529 linebuf[i] = '\0';
530 i = 0;
531 tfile_interp_line (linebuf, &uploaded_tps, &uploaded_tsvs);
533 else
534 linebuf[i++] = byte;
535 if (i >= 1000)
536 error (_("Excessively long lines in trace file"));
539 /* By now, tdesc lines have been read from tfile - let's parse them. */
540 target_find_description ();
542 /* Record the starting offset of the binary trace data. */
543 trace_frames_offset = bytes;
545 /* If we don't have a blocksize, we can't interpret the
546 traceframes. */
547 if (trace_regblock_size == 0)
548 error (_("No register block size recorded in trace file"));
550 catch (const gdb_exception &ex)
552 /* Remove the partially set up target. */
553 unpush_target (&tfile_ops);
554 throw;
557 inferior_appeared (current_inferior (), TFILE_PID);
558 inferior_ptid = ptid_t (TFILE_PID);
559 add_thread_silent (inferior_ptid);
561 if (ts->traceframe_count <= 0)
562 warning (_("No traceframes present in this file."));
564 /* Add the file's tracepoints and variables into the current mix. */
566 /* Get trace state variables first, they may be checked when parsing
567 uploaded commands. */
568 merge_uploaded_trace_state_variables (&uploaded_tsvs);
570 merge_uploaded_tracepoints (&uploaded_tps);
572 post_create_inferior (&tfile_ops, from_tty);
575 /* Interpret the given line from the definitions part of the trace
576 file. */
578 static void
579 tfile_interp_line (char *line, struct uploaded_tp **utpp,
580 struct uploaded_tsv **utsvp)
582 char *p = line;
584 if (startswith (p, "R "))
586 p += strlen ("R ");
587 trace_regblock_size = strtol (p, &p, 16);
589 else if (startswith (p, "status "))
591 p += strlen ("status ");
592 parse_trace_status (p, current_trace_status ());
594 else if (startswith (p, "tp "))
596 p += strlen ("tp ");
597 parse_tracepoint_definition (p, utpp);
599 else if (startswith (p, "tsv "))
601 p += strlen ("tsv ");
602 parse_tsv_definition (p, utsvp);
604 else if (startswith (p, "tdesc "))
606 p += strlen ("tdesc ");
607 tfile_append_tdesc_line (p);
609 else
610 warning (_("Ignoring trace file definition \"%s\""), line);
613 /* Close the trace file and generally clean up. */
615 void
616 tfile_target::close ()
618 if (trace_fd < 0)
619 return;
621 inferior_ptid = null_ptid; /* Avoid confusion from thread stuff. */
622 exit_inferior_silent (current_inferior ());
624 ::close (trace_fd);
625 trace_fd = -1;
626 xfree (trace_filename);
627 trace_filename = NULL;
628 buffer_free (&trace_tdesc);
630 trace_reset_local_state ();
633 void
634 tfile_target::files_info ()
636 printf_filtered ("\t`%s'\n", trace_filename);
639 void
640 tfile_target::get_tracepoint_status (struct breakpoint *tp, struct uploaded_tp *utp)
642 /* Other bits of trace status were collected as part of opening the
643 trace files, so nothing to do here. */
646 /* Given the position of a traceframe in the file, figure out what
647 address the frame was collected at. This would normally be the
648 value of a collected PC register, but if not available, we
649 improvise. */
651 static CORE_ADDR
652 tfile_get_traceframe_address (off_t tframe_offset)
654 CORE_ADDR addr = 0;
655 short tpnum;
656 struct tracepoint *tp;
657 off_t saved_offset = cur_offset;
659 /* FIXME dig pc out of collected registers. */
661 /* Fall back to using tracepoint address. */
662 lseek (trace_fd, tframe_offset, SEEK_SET);
663 tfile_read ((gdb_byte *) &tpnum, 2);
664 tpnum = (short) extract_signed_integer ((gdb_byte *) &tpnum, 2,
665 gdbarch_byte_order
666 (target_gdbarch ()));
668 tp = get_tracepoint_by_number_on_target (tpnum);
669 /* FIXME this is a poor heuristic if multiple locations. */
670 if (tp && tp->loc)
671 addr = tp->loc->address;
673 /* Restore our seek position. */
674 cur_offset = saved_offset;
675 lseek (trace_fd, cur_offset, SEEK_SET);
676 return addr;
679 /* Given a type of search and some parameters, scan the collection of
680 traceframes in the file looking for a match. When found, return
681 both the traceframe and tracepoint number, otherwise -1 for
682 each. */
685 tfile_target::trace_find (enum trace_find_type type, int num,
686 CORE_ADDR addr1, CORE_ADDR addr2, int *tpp)
688 short tpnum;
689 int tfnum = 0, found = 0;
690 unsigned int data_size;
691 struct tracepoint *tp;
692 off_t offset, tframe_offset;
693 CORE_ADDR tfaddr;
695 if (num == -1)
697 if (tpp)
698 *tpp = -1;
699 return -1;
702 lseek (trace_fd, trace_frames_offset, SEEK_SET);
703 offset = trace_frames_offset;
704 while (1)
706 tframe_offset = offset;
707 tfile_read ((gdb_byte *) &tpnum, 2);
708 tpnum = (short) extract_signed_integer ((gdb_byte *) &tpnum, 2,
709 gdbarch_byte_order
710 (target_gdbarch ()));
711 offset += 2;
712 if (tpnum == 0)
713 break;
714 tfile_read ((gdb_byte *) &data_size, 4);
715 data_size = (unsigned int) extract_unsigned_integer
716 ((gdb_byte *) &data_size, 4,
717 gdbarch_byte_order (target_gdbarch ()));
718 offset += 4;
720 if (type == tfind_number)
722 /* Looking for a specific trace frame. */
723 if (tfnum == num)
724 found = 1;
726 else
728 /* Start from the _next_ trace frame. */
729 if (tfnum > get_traceframe_number ())
731 switch (type)
733 case tfind_pc:
734 tfaddr = tfile_get_traceframe_address (tframe_offset);
735 if (tfaddr == addr1)
736 found = 1;
737 break;
738 case tfind_tp:
739 tp = get_tracepoint (num);
740 if (tp && tpnum == tp->number_on_target)
741 found = 1;
742 break;
743 case tfind_range:
744 tfaddr = tfile_get_traceframe_address (tframe_offset);
745 if (addr1 <= tfaddr && tfaddr <= addr2)
746 found = 1;
747 break;
748 case tfind_outside:
749 tfaddr = tfile_get_traceframe_address (tframe_offset);
750 if (!(addr1 <= tfaddr && tfaddr <= addr2))
751 found = 1;
752 break;
753 default:
754 internal_error (__FILE__, __LINE__, _("unknown tfind type"));
759 if (found)
761 if (tpp)
762 *tpp = tpnum;
763 cur_offset = offset;
764 cur_data_size = data_size;
766 return tfnum;
768 /* Skip past the traceframe's data. */
769 lseek (trace_fd, data_size, SEEK_CUR);
770 offset += data_size;
771 /* Update our own count of traceframes. */
772 ++tfnum;
774 /* Did not find what we were looking for. */
775 if (tpp)
776 *tpp = -1;
777 return -1;
780 /* Prototype of the callback passed to tframe_walk_blocks. */
781 typedef int (*walk_blocks_callback_func) (char blocktype, void *data);
783 /* Callback for traceframe_walk_blocks, used to find a given block
784 type in a traceframe. */
786 static int
787 match_blocktype (char blocktype, void *data)
789 char *wantedp = (char *) data;
791 if (*wantedp == blocktype)
792 return 1;
794 return 0;
797 /* Walk over all traceframe block starting at POS offset from
798 CUR_OFFSET, and call CALLBACK for each block found, passing in DATA
799 unmodified. If CALLBACK returns true, this returns the position in
800 the traceframe where the block is found, relative to the start of
801 the traceframe (cur_offset). Returns -1 if no callback call
802 returned true, indicating that all blocks have been walked. */
804 static int
805 traceframe_walk_blocks (walk_blocks_callback_func callback,
806 int pos, void *data)
808 /* Iterate through a traceframe's blocks, looking for a block of the
809 requested type. */
811 lseek (trace_fd, cur_offset + pos, SEEK_SET);
812 while (pos < cur_data_size)
814 unsigned short mlen;
815 char block_type;
817 tfile_read ((gdb_byte *) &block_type, 1);
819 ++pos;
821 if ((*callback) (block_type, data))
822 return pos;
824 switch (block_type)
826 case 'R':
827 lseek (trace_fd, cur_offset + pos + trace_regblock_size, SEEK_SET);
828 pos += trace_regblock_size;
829 break;
830 case 'M':
831 lseek (trace_fd, cur_offset + pos + 8, SEEK_SET);
832 tfile_read ((gdb_byte *) &mlen, 2);
833 mlen = (unsigned short)
834 extract_unsigned_integer ((gdb_byte *) &mlen, 2,
835 gdbarch_byte_order
836 (target_gdbarch ()));
837 lseek (trace_fd, mlen, SEEK_CUR);
838 pos += (8 + 2 + mlen);
839 break;
840 case 'V':
841 lseek (trace_fd, cur_offset + pos + 4 + 8, SEEK_SET);
842 pos += (4 + 8);
843 break;
844 default:
845 error (_("Unknown block type '%c' (0x%x) in trace frame"),
846 block_type, block_type);
847 break;
851 return -1;
854 /* Convenience wrapper around traceframe_walk_blocks. Looks for the
855 position offset of a block of type TYPE_WANTED in the current trace
856 frame, starting at POS. Returns -1 if no such block was found. */
858 static int
859 traceframe_find_block_type (char type_wanted, int pos)
861 return traceframe_walk_blocks (match_blocktype, pos, &type_wanted);
864 /* Look for a block of saved registers in the traceframe, and get the
865 requested register from it. */
867 void
868 tfile_target::fetch_registers (struct regcache *regcache, int regno)
870 struct gdbarch *gdbarch = regcache->arch ();
871 int offset, regn, regsize, dummy;
873 /* An uninitialized reg size says we're not going to be
874 successful at getting register blocks. */
875 if (!trace_regblock_size)
876 return;
878 if (traceframe_find_block_type ('R', 0) >= 0)
880 gdb_byte *regs = (gdb_byte *) alloca (trace_regblock_size);
882 tfile_read (regs, trace_regblock_size);
884 for (regn = 0; regn < gdbarch_num_regs (gdbarch); regn++)
886 if (!remote_register_number_and_offset (regcache->arch (),
887 regn, &dummy, &offset))
888 continue;
890 regsize = register_size (gdbarch, regn);
891 /* Make sure we stay within block bounds. */
892 if (offset + regsize > trace_regblock_size)
893 break;
894 if (regcache->get_register_status (regn) == REG_UNKNOWN)
896 if (regno == regn)
898 regcache->raw_supply (regno, regs + offset);
899 break;
901 else if (regno == -1)
903 regcache->raw_supply (regn, regs + offset);
908 else
909 tracefile_fetch_registers (regcache, regno);
912 static enum target_xfer_status
913 tfile_xfer_partial_features (const char *annex,
914 gdb_byte *readbuf, const gdb_byte *writebuf,
915 ULONGEST offset, ULONGEST len,
916 ULONGEST *xfered_len)
918 if (strcmp (annex, "target.xml"))
919 return TARGET_XFER_E_IO;
921 if (readbuf == NULL)
922 error (_("tfile_xfer_partial: tdesc is read-only"));
924 if (trace_tdesc.used_size == 0)
925 return TARGET_XFER_E_IO;
927 if (offset >= trace_tdesc.used_size)
928 return TARGET_XFER_EOF;
930 if (len > trace_tdesc.used_size - offset)
931 len = trace_tdesc.used_size - offset;
933 memcpy (readbuf, trace_tdesc.buffer + offset, len);
934 *xfered_len = len;
936 return TARGET_XFER_OK;
939 enum target_xfer_status
940 tfile_target::xfer_partial (enum target_object object,
941 const char *annex, gdb_byte *readbuf,
942 const gdb_byte *writebuf, ULONGEST offset, ULONGEST len,
943 ULONGEST *xfered_len)
945 /* We're only doing regular memory and tdesc for now. */
946 if (object == TARGET_OBJECT_AVAILABLE_FEATURES)
947 return tfile_xfer_partial_features (annex, readbuf, writebuf,
948 offset, len, xfered_len);
949 if (object != TARGET_OBJECT_MEMORY)
950 return TARGET_XFER_E_IO;
952 if (readbuf == NULL)
953 error (_("tfile_xfer_partial: trace file is read-only"));
955 if (get_traceframe_number () != -1)
957 int pos = 0;
958 enum target_xfer_status res;
959 /* Records the lowest available address of all blocks that
960 intersects the requested range. */
961 ULONGEST low_addr_available = 0;
963 /* Iterate through the traceframe's blocks, looking for
964 memory. */
965 while ((pos = traceframe_find_block_type ('M', pos)) >= 0)
967 ULONGEST maddr, amt;
968 unsigned short mlen;
969 enum bfd_endian byte_order = gdbarch_byte_order (target_gdbarch ());
971 tfile_read ((gdb_byte *) &maddr, 8);
972 maddr = extract_unsigned_integer ((gdb_byte *) &maddr, 8,
973 byte_order);
974 tfile_read ((gdb_byte *) &mlen, 2);
975 mlen = (unsigned short)
976 extract_unsigned_integer ((gdb_byte *) &mlen, 2, byte_order);
978 /* If the block includes the first part of the desired
979 range, return as much it has; GDB will re-request the
980 remainder, which might be in a different block of this
981 trace frame. */
982 if (maddr <= offset && offset < (maddr + mlen))
984 amt = (maddr + mlen) - offset;
985 if (amt > len)
986 amt = len;
988 if (maddr != offset)
989 lseek (trace_fd, offset - maddr, SEEK_CUR);
990 tfile_read (readbuf, amt);
991 *xfered_len = amt;
992 return TARGET_XFER_OK;
995 if (offset < maddr && maddr < (offset + len))
996 if (low_addr_available == 0 || low_addr_available > maddr)
997 low_addr_available = maddr;
999 /* Skip over this block. */
1000 pos += (8 + 2 + mlen);
1003 /* Requested memory is unavailable in the context of traceframes,
1004 and this address falls within a read-only section, fallback
1005 to reading from executable, up to LOW_ADDR_AVAILABLE. */
1006 if (offset < low_addr_available)
1007 len = std::min (len, low_addr_available - offset);
1008 res = exec_read_partial_read_only (readbuf, offset, len, xfered_len);
1010 if (res == TARGET_XFER_OK)
1011 return TARGET_XFER_OK;
1012 else
1014 /* No use trying further, we know some memory starting
1015 at MEMADDR isn't available. */
1016 *xfered_len = len;
1017 return TARGET_XFER_UNAVAILABLE;
1020 else
1022 /* Fallback to reading from read-only sections. */
1023 return section_table_read_available_memory (readbuf, offset, len,
1024 xfered_len);
1028 /* Iterate through the blocks of a trace frame, looking for a 'V'
1029 block with a matching tsv number. */
1031 bool
1032 tfile_target::get_trace_state_variable_value (int tsvnum, LONGEST *val)
1034 int pos;
1035 bool found = false;
1037 /* Iterate over blocks in current frame and find the last 'V'
1038 block in which tsv number is TSVNUM. In one trace frame, there
1039 may be multiple 'V' blocks created for a given trace variable,
1040 and the last matched 'V' block contains the updated value. */
1041 pos = 0;
1042 while ((pos = traceframe_find_block_type ('V', pos)) >= 0)
1044 int vnum;
1046 tfile_read ((gdb_byte *) &vnum, 4);
1047 vnum = (int) extract_signed_integer ((gdb_byte *) &vnum, 4,
1048 gdbarch_byte_order
1049 (target_gdbarch ()));
1050 if (tsvnum == vnum)
1052 tfile_read ((gdb_byte *) val, 8);
1053 *val = extract_signed_integer ((gdb_byte *) val, 8,
1054 gdbarch_byte_order
1055 (target_gdbarch ()));
1056 found = true;
1058 pos += (4 + 8);
1061 return found;
1064 /* Callback for traceframe_walk_blocks. Builds a traceframe_info
1065 object for the tfile target's current traceframe. */
1067 static int
1068 build_traceframe_info (char blocktype, void *data)
1070 struct traceframe_info *info = (struct traceframe_info *) data;
1072 switch (blocktype)
1074 case 'M':
1076 ULONGEST maddr;
1077 unsigned short mlen;
1079 tfile_read ((gdb_byte *) &maddr, 8);
1080 maddr = extract_unsigned_integer ((gdb_byte *) &maddr, 8,
1081 gdbarch_byte_order
1082 (target_gdbarch ()));
1083 tfile_read ((gdb_byte *) &mlen, 2);
1084 mlen = (unsigned short)
1085 extract_unsigned_integer ((gdb_byte *) &mlen,
1086 2, gdbarch_byte_order
1087 (target_gdbarch ()));
1089 info->memory.emplace_back (maddr, mlen);
1090 break;
1092 case 'V':
1094 int vnum;
1096 tfile_read ((gdb_byte *) &vnum, 4);
1097 info->tvars.push_back (vnum);
1099 case 'R':
1100 case 'S':
1102 break;
1104 default:
1105 warning (_("Unhandled trace block type (%d) '%c ' "
1106 "while building trace frame info."),
1107 blocktype, blocktype);
1108 break;
1111 return 0;
1114 traceframe_info_up
1115 tfile_target::traceframe_info ()
1117 traceframe_info_up info (new struct traceframe_info);
1119 traceframe_walk_blocks (build_traceframe_info, 0, info.get ());
1121 return info;
1124 /* Handles tdesc lines from tfile by appending the payload to
1125 a global trace_tdesc variable. */
1127 static void
1128 tfile_append_tdesc_line (const char *line)
1130 buffer_grow_str (&trace_tdesc, line);
1131 buffer_grow_str (&trace_tdesc, "\n");
1134 void
1135 _initialize_tracefile_tfile (void)
1137 add_target (tfile_target_info, tfile_target_open, filename_completer);