Style variable names
[external/binutils.git] / gdb / printcmd.c
1 /* Print values for GNU debugger GDB.
2
3    Copyright (C) 1986-2018 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
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.
11
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.
16
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/>.  */
19
20 #include "defs.h"
21 #include "frame.h"
22 #include "symtab.h"
23 #include "gdbtypes.h"
24 #include "value.h"
25 #include "language.h"
26 #include "expression.h"
27 #include "gdbcore.h"
28 #include "gdbcmd.h"
29 #include "target.h"
30 #include "breakpoint.h"
31 #include "demangle.h"
32 #include "gdb-demangle.h"
33 #include "valprint.h"
34 #include "annotate.h"
35 #include "symfile.h"            /* for overlay functions */
36 #include "objfiles.h"           /* ditto */
37 #include "completer.h"          /* for completion functions */
38 #include "ui-out.h"
39 #include "block.h"
40 #include "disasm.h"
41 #include "target-float.h"
42 #include "observable.h"
43 #include "solist.h"
44 #include "parser-defs.h"
45 #include "charset.h"
46 #include "arch-utils.h"
47 #include "cli/cli-utils.h"
48 #include "cli/cli-script.h"
49 #include "cli/cli-style.h"
50 #include "format.h"
51 #include "source.h"
52 #include "common/byte-vector.h"
53
54 /* Last specified output format.  */
55
56 static char last_format = 0;
57
58 /* Last specified examination size.  'b', 'h', 'w' or `q'.  */
59
60 static char last_size = 'w';
61
62 /* Last specified count for the 'x' command.  */
63
64 static int last_count;
65
66 /* Default address to examine next, and associated architecture.  */
67
68 static struct gdbarch *next_gdbarch;
69 static CORE_ADDR next_address;
70
71 /* Number of delay instructions following current disassembled insn.  */
72
73 static int branch_delay_insns;
74
75 /* Last address examined.  */
76
77 static CORE_ADDR last_examine_address;
78
79 /* Contents of last address examined.
80    This is not valid past the end of the `x' command!  */
81
82 static value_ref_ptr last_examine_value;
83
84 /* Largest offset between a symbolic value and an address, that will be
85    printed as `0x1234 <symbol+offset>'.  */
86
87 static unsigned int max_symbolic_offset = UINT_MAX;
88 static void
89 show_max_symbolic_offset (struct ui_file *file, int from_tty,
90                           struct cmd_list_element *c, const char *value)
91 {
92   fprintf_filtered (file,
93                     _("The largest offset that will be "
94                       "printed in <symbol+1234> form is %s.\n"),
95                     value);
96 }
97
98 /* Append the source filename and linenumber of the symbol when
99    printing a symbolic value as `<symbol at filename:linenum>' if set.  */
100 static int print_symbol_filename = 0;
101 static void
102 show_print_symbol_filename (struct ui_file *file, int from_tty,
103                             struct cmd_list_element *c, const char *value)
104 {
105   fprintf_filtered (file, _("Printing of source filename and "
106                             "line number with <symbol> is %s.\n"),
107                     value);
108 }
109
110 /* Number of auto-display expression currently being displayed.
111    So that we can disable it if we get a signal within it.
112    -1 when not doing one.  */
113
114 static int current_display_number;
115
116 struct display
117   {
118     /* Chain link to next auto-display item.  */
119     struct display *next;
120
121     /* The expression as the user typed it.  */
122     char *exp_string;
123
124     /* Expression to be evaluated and displayed.  */
125     expression_up exp;
126
127     /* Item number of this auto-display item.  */
128     int number;
129
130     /* Display format specified.  */
131     struct format_data format;
132
133     /* Program space associated with `block'.  */
134     struct program_space *pspace;
135
136     /* Innermost block required by this expression when evaluated.  */
137     const struct block *block;
138
139     /* Status of this display (enabled or disabled).  */
140     int enabled_p;
141   };
142
143 /* Chain of expressions whose values should be displayed
144    automatically each time the program stops.  */
145
146 static struct display *display_chain;
147
148 static int display_number;
149
150 /* Walk the following statement or block through all displays.
151    ALL_DISPLAYS_SAFE does so even if the statement deletes the current
152    display.  */
153
154 #define ALL_DISPLAYS(B)                         \
155   for (B = display_chain; B; B = B->next)
156
157 #define ALL_DISPLAYS_SAFE(B,TMP)                \
158   for (B = display_chain;                       \
159        B ? (TMP = B->next, 1): 0;               \
160        B = TMP)
161
162 /* Prototypes for local functions.  */
163
164 static void do_one_display (struct display *);
165 \f
166
167 /* Decode a format specification.  *STRING_PTR should point to it.
168    OFORMAT and OSIZE are used as defaults for the format and size
169    if none are given in the format specification.
170    If OSIZE is zero, then the size field of the returned value
171    should be set only if a size is explicitly specified by the
172    user.
173    The structure returned describes all the data
174    found in the specification.  In addition, *STRING_PTR is advanced
175    past the specification and past all whitespace following it.  */
176
177 static struct format_data
178 decode_format (const char **string_ptr, int oformat, int osize)
179 {
180   struct format_data val;
181   const char *p = *string_ptr;
182
183   val.format = '?';
184   val.size = '?';
185   val.count = 1;
186   val.raw = 0;
187
188   if (*p == '-')
189     {
190       val.count = -1;
191       p++;
192     }
193   if (*p >= '0' && *p <= '9')
194     val.count *= atoi (p);
195   while (*p >= '0' && *p <= '9')
196     p++;
197
198   /* Now process size or format letters that follow.  */
199
200   while (1)
201     {
202       if (*p == 'b' || *p == 'h' || *p == 'w' || *p == 'g')
203         val.size = *p++;
204       else if (*p == 'r')
205         {
206           val.raw = 1;
207           p++;
208         }
209       else if (*p >= 'a' && *p <= 'z')
210         val.format = *p++;
211       else
212         break;
213     }
214
215   *string_ptr = skip_spaces (p);
216
217   /* Set defaults for format and size if not specified.  */
218   if (val.format == '?')
219     {
220       if (val.size == '?')
221         {
222           /* Neither has been specified.  */
223           val.format = oformat;
224           val.size = osize;
225         }
226       else
227         /* If a size is specified, any format makes a reasonable
228            default except 'i'.  */
229         val.format = oformat == 'i' ? 'x' : oformat;
230     }
231   else if (val.size == '?')
232     switch (val.format)
233       {
234       case 'a':
235         /* Pick the appropriate size for an address.  This is deferred
236            until do_examine when we know the actual architecture to use.
237            A special size value of 'a' is used to indicate this case.  */
238         val.size = osize ? 'a' : osize;
239         break;
240       case 'f':
241         /* Floating point has to be word or giantword.  */
242         if (osize == 'w' || osize == 'g')
243           val.size = osize;
244         else
245           /* Default it to giantword if the last used size is not
246              appropriate.  */
247           val.size = osize ? 'g' : osize;
248         break;
249       case 'c':
250         /* Characters default to one byte.  */
251         val.size = osize ? 'b' : osize;
252         break;
253       case 's':
254         /* Display strings with byte size chars unless explicitly
255            specified.  */
256         val.size = '\0';
257         break;
258
259       default:
260         /* The default is the size most recently specified.  */
261         val.size = osize;
262       }
263
264   return val;
265 }
266 \f
267 /* Print value VAL on stream according to OPTIONS.
268    Do not end with a newline.
269    SIZE is the letter for the size of datum being printed.
270    This is used to pad hex numbers so they line up.  SIZE is 0
271    for print / output and set for examine.  */
272
273 static void
274 print_formatted (struct value *val, int size,
275                  const struct value_print_options *options,
276                  struct ui_file *stream)
277 {
278   struct type *type = check_typedef (value_type (val));
279   int len = TYPE_LENGTH (type);
280
281   if (VALUE_LVAL (val) == lval_memory)
282     next_address = value_address (val) + len;
283
284   if (size)
285     {
286       switch (options->format)
287         {
288         case 's':
289           {
290             struct type *elttype = value_type (val);
291
292             next_address = (value_address (val)
293                             + val_print_string (elttype, NULL,
294                                                 value_address (val), -1,
295                                                 stream, options) * len);
296           }
297           return;
298
299         case 'i':
300           /* We often wrap here if there are long symbolic names.  */
301           wrap_here ("    ");
302           next_address = (value_address (val)
303                           + gdb_print_insn (get_type_arch (type),
304                                             value_address (val), stream,
305                                             &branch_delay_insns));
306           return;
307         }
308     }
309
310   if (options->format == 0 || options->format == 's'
311       || TYPE_CODE (type) == TYPE_CODE_REF
312       || TYPE_CODE (type) == TYPE_CODE_ARRAY
313       || TYPE_CODE (type) == TYPE_CODE_STRING
314       || TYPE_CODE (type) == TYPE_CODE_STRUCT
315       || TYPE_CODE (type) == TYPE_CODE_UNION
316       || TYPE_CODE (type) == TYPE_CODE_NAMESPACE)
317     value_print (val, stream, options);
318   else
319     /* User specified format, so don't look to the type to tell us
320        what to do.  */
321     val_print_scalar_formatted (type,
322                                 value_embedded_offset (val),
323                                 val,
324                                 options, size, stream);
325 }
326
327 /* Return builtin floating point type of same length as TYPE.
328    If no such type is found, return TYPE itself.  */
329 static struct type *
330 float_type_from_length (struct type *type)
331 {
332   struct gdbarch *gdbarch = get_type_arch (type);
333   const struct builtin_type *builtin = builtin_type (gdbarch);
334
335   if (TYPE_LENGTH (type) == TYPE_LENGTH (builtin->builtin_float))
336     type = builtin->builtin_float;
337   else if (TYPE_LENGTH (type) == TYPE_LENGTH (builtin->builtin_double))
338     type = builtin->builtin_double;
339   else if (TYPE_LENGTH (type) == TYPE_LENGTH (builtin->builtin_long_double))
340     type = builtin->builtin_long_double;
341
342   return type;
343 }
344
345 /* Print a scalar of data of type TYPE, pointed to in GDB by VALADDR,
346    according to OPTIONS and SIZE on STREAM.  Formats s and i are not
347    supported at this level.  */
348
349 void
350 print_scalar_formatted (const gdb_byte *valaddr, struct type *type,
351                         const struct value_print_options *options,
352                         int size, struct ui_file *stream)
353 {
354   struct gdbarch *gdbarch = get_type_arch (type);
355   unsigned int len = TYPE_LENGTH (type);
356   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
357
358   /* String printing should go through val_print_scalar_formatted.  */
359   gdb_assert (options->format != 's');
360
361   /* If the value is a pointer, and pointers and addresses are not the
362      same, then at this point, the value's length (in target bytes) is
363      gdbarch_addr_bit/TARGET_CHAR_BIT, not TYPE_LENGTH (type).  */
364   if (TYPE_CODE (type) == TYPE_CODE_PTR)
365     len = gdbarch_addr_bit (gdbarch) / TARGET_CHAR_BIT;
366
367   /* If we are printing it as unsigned, truncate it in case it is actually
368      a negative signed value (e.g. "print/u (short)-1" should print 65535
369      (if shorts are 16 bits) instead of 4294967295).  */
370   if (options->format != 'c'
371       && (options->format != 'd' || TYPE_UNSIGNED (type)))
372     {
373       if (len < TYPE_LENGTH (type) && byte_order == BFD_ENDIAN_BIG)
374         valaddr += TYPE_LENGTH (type) - len;
375     }
376
377   if (size != 0 && (options->format == 'x' || options->format == 't'))
378     {
379       /* Truncate to fit.  */
380       unsigned newlen;
381       switch (size)
382         {
383         case 'b':
384           newlen = 1;
385           break;
386         case 'h':
387           newlen = 2;
388           break;
389         case 'w':
390           newlen = 4;
391           break;
392         case 'g':
393           newlen = 8;
394           break;
395         default:
396           error (_("Undefined output size \"%c\"."), size);
397         }
398       if (newlen < len && byte_order == BFD_ENDIAN_BIG)
399         valaddr += len - newlen;
400       len = newlen;
401     }
402
403   /* Historically gdb has printed floats by first casting them to a
404      long, and then printing the long.  PR cli/16242 suggests changing
405      this to using C-style hex float format.  */
406   gdb::byte_vector converted_float_bytes;
407   if (TYPE_CODE (type) == TYPE_CODE_FLT
408       && (options->format == 'o'
409           || options->format == 'x'
410           || options->format == 't'
411           || options->format == 'z'
412           || options->format == 'd'
413           || options->format == 'u'))
414     {
415       LONGEST val_long = unpack_long (type, valaddr);
416       converted_float_bytes.resize (TYPE_LENGTH (type));
417       store_signed_integer (converted_float_bytes.data (), TYPE_LENGTH (type),
418                             byte_order, val_long);
419       valaddr = converted_float_bytes.data ();
420     }
421
422   /* Printing a non-float type as 'f' will interpret the data as if it were
423      of a floating-point type of the same length, if that exists.  Otherwise,
424      the data is printed as integer.  */
425   char format = options->format;
426   if (format == 'f' && TYPE_CODE (type) != TYPE_CODE_FLT)
427     {
428       type = float_type_from_length (type);
429       if (TYPE_CODE (type) != TYPE_CODE_FLT)
430         format = 0;
431     }
432
433   switch (format)
434     {
435     case 'o':
436       print_octal_chars (stream, valaddr, len, byte_order);
437       break;
438     case 'd':
439       print_decimal_chars (stream, valaddr, len, true, byte_order);
440       break;
441     case 'u':
442       print_decimal_chars (stream, valaddr, len, false, byte_order);
443       break;
444     case 0:
445       if (TYPE_CODE (type) != TYPE_CODE_FLT)
446         {
447           print_decimal_chars (stream, valaddr, len, !TYPE_UNSIGNED (type),
448                                byte_order);
449           break;
450         }
451       /* FALLTHROUGH */
452     case 'f':
453       print_floating (valaddr, type, stream);
454       break;
455
456     case 't':
457       print_binary_chars (stream, valaddr, len, byte_order, size > 0);
458       break;
459     case 'x':
460       print_hex_chars (stream, valaddr, len, byte_order, size > 0);
461       break;
462     case 'z':
463       print_hex_chars (stream, valaddr, len, byte_order, true);
464       break;
465     case 'c':
466       {
467         struct value_print_options opts = *options;
468
469         LONGEST val_long = unpack_long (type, valaddr);
470
471         opts.format = 0;
472         if (TYPE_UNSIGNED (type))
473           type = builtin_type (gdbarch)->builtin_true_unsigned_char;
474         else
475           type = builtin_type (gdbarch)->builtin_true_char;
476
477         value_print (value_from_longest (type, val_long), stream, &opts);
478       }
479       break;
480
481     case 'a':
482       {
483         CORE_ADDR addr = unpack_pointer (type, valaddr);
484
485         print_address (gdbarch, addr, stream);
486       }
487       break;
488
489     default:
490       error (_("Undefined output format \"%c\"."), format);
491     }
492 }
493
494 /* Specify default address for `x' command.
495    The `info lines' command uses this.  */
496
497 void
498 set_next_address (struct gdbarch *gdbarch, CORE_ADDR addr)
499 {
500   struct type *ptr_type = builtin_type (gdbarch)->builtin_data_ptr;
501
502   next_gdbarch = gdbarch;
503   next_address = addr;
504
505   /* Make address available to the user as $_.  */
506   set_internalvar (lookup_internalvar ("_"),
507                    value_from_pointer (ptr_type, addr));
508 }
509
510 /* Optionally print address ADDR symbolically as <SYMBOL+OFFSET> on STREAM,
511    after LEADIN.  Print nothing if no symbolic name is found nearby.
512    Optionally also print source file and line number, if available.
513    DO_DEMANGLE controls whether to print a symbol in its native "raw" form,
514    or to interpret it as a possible C++ name and convert it back to source
515    form.  However note that DO_DEMANGLE can be overridden by the specific
516    settings of the demangle and asm_demangle variables.  Returns
517    non-zero if anything was printed; zero otherwise.  */
518
519 int
520 print_address_symbolic (struct gdbarch *gdbarch, CORE_ADDR addr,
521                         struct ui_file *stream,
522                         int do_demangle, const char *leadin)
523 {
524   std::string name, filename;
525   int unmapped = 0;
526   int offset = 0;
527   int line = 0;
528
529   if (build_address_symbolic (gdbarch, addr, do_demangle, &name, &offset,
530                               &filename, &line, &unmapped))
531     return 0;
532
533   fputs_filtered (leadin, stream);
534   if (unmapped)
535     fputs_filtered ("<*", stream);
536   else
537     fputs_filtered ("<", stream);
538   fputs_filtered (name.c_str (), stream);
539   if (offset != 0)
540     fprintf_filtered (stream, "+%u", (unsigned int) offset);
541
542   /* Append source filename and line number if desired.  Give specific
543      line # of this addr, if we have it; else line # of the nearest symbol.  */
544   if (print_symbol_filename && !filename.empty ())
545     {
546       if (line != -1)
547         fprintf_filtered (stream, " at %s:%d", filename.c_str (), line);
548       else
549         fprintf_filtered (stream, " in %s", filename.c_str ());
550     }
551   if (unmapped)
552     fputs_filtered ("*>", stream);
553   else
554     fputs_filtered (">", stream);
555
556   return 1;
557 }
558
559 /* See valprint.h.  */
560
561 int
562 build_address_symbolic (struct gdbarch *gdbarch,
563                         CORE_ADDR addr,  /* IN */
564                         int do_demangle, /* IN */
565                         std::string *name, /* OUT */
566                         int *offset,     /* OUT */
567                         std::string *filename, /* OUT */
568                         int *line,       /* OUT */
569                         int *unmapped)   /* OUT */
570 {
571   struct bound_minimal_symbol msymbol;
572   struct symbol *symbol;
573   CORE_ADDR name_location = 0;
574   struct obj_section *section = NULL;
575   const char *name_temp = "";
576   
577   /* Let's say it is mapped (not unmapped).  */
578   *unmapped = 0;
579
580   /* Determine if the address is in an overlay, and whether it is
581      mapped.  */
582   if (overlay_debugging)
583     {
584       section = find_pc_overlay (addr);
585       if (pc_in_unmapped_range (addr, section))
586         {
587           *unmapped = 1;
588           addr = overlay_mapped_address (addr, section);
589         }
590     }
591
592   /* First try to find the address in the symbol table, then
593      in the minsyms.  Take the closest one.  */
594
595   /* This is defective in the sense that it only finds text symbols.  So
596      really this is kind of pointless--we should make sure that the
597      minimal symbols have everything we need (by changing that we could
598      save some memory, but for many debug format--ELF/DWARF or
599      anything/stabs--it would be inconvenient to eliminate those minimal
600      symbols anyway).  */
601   msymbol = lookup_minimal_symbol_by_pc_section (addr, section);
602   symbol = find_pc_sect_function (addr, section);
603
604   if (symbol)
605     {
606       /* If this is a function (i.e. a code address), strip out any
607          non-address bits.  For instance, display a pointer to the
608          first instruction of a Thumb function as <function>; the
609          second instruction will be <function+2>, even though the
610          pointer is <function+3>.  This matches the ISA behavior.  */
611       addr = gdbarch_addr_bits_remove (gdbarch, addr);
612
613       name_location = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (symbol));
614       if (do_demangle || asm_demangle)
615         name_temp = SYMBOL_PRINT_NAME (symbol);
616       else
617         name_temp = SYMBOL_LINKAGE_NAME (symbol);
618     }
619
620   if (msymbol.minsym != NULL
621       && MSYMBOL_HAS_SIZE (msymbol.minsym)
622       && MSYMBOL_SIZE (msymbol.minsym) == 0
623       && MSYMBOL_TYPE (msymbol.minsym) != mst_text
624       && MSYMBOL_TYPE (msymbol.minsym) != mst_text_gnu_ifunc
625       && MSYMBOL_TYPE (msymbol.minsym) != mst_file_text)
626     msymbol.minsym = NULL;
627
628   if (msymbol.minsym != NULL)
629     {
630       if (BMSYMBOL_VALUE_ADDRESS (msymbol) > name_location || symbol == NULL)
631         {
632           /* If this is a function (i.e. a code address), strip out any
633              non-address bits.  For instance, display a pointer to the
634              first instruction of a Thumb function as <function>; the
635              second instruction will be <function+2>, even though the
636              pointer is <function+3>.  This matches the ISA behavior.  */
637           if (MSYMBOL_TYPE (msymbol.minsym) == mst_text
638               || MSYMBOL_TYPE (msymbol.minsym) == mst_text_gnu_ifunc
639               || MSYMBOL_TYPE (msymbol.minsym) == mst_file_text
640               || MSYMBOL_TYPE (msymbol.minsym) == mst_solib_trampoline)
641             addr = gdbarch_addr_bits_remove (gdbarch, addr);
642
643           /* The msymbol is closer to the address than the symbol;
644              use the msymbol instead.  */
645           symbol = 0;
646           name_location = BMSYMBOL_VALUE_ADDRESS (msymbol);
647           if (do_demangle || asm_demangle)
648             name_temp = MSYMBOL_PRINT_NAME (msymbol.minsym);
649           else
650             name_temp = MSYMBOL_LINKAGE_NAME (msymbol.minsym);
651         }
652     }
653   if (symbol == NULL && msymbol.minsym == NULL)
654     return 1;
655
656   /* If the nearest symbol is too far away, don't print anything symbolic.  */
657
658   /* For when CORE_ADDR is larger than unsigned int, we do math in
659      CORE_ADDR.  But when we detect unsigned wraparound in the
660      CORE_ADDR math, we ignore this test and print the offset,
661      because addr+max_symbolic_offset has wrapped through the end
662      of the address space back to the beginning, giving bogus comparison.  */
663   if (addr > name_location + max_symbolic_offset
664       && name_location + max_symbolic_offset > name_location)
665     return 1;
666
667   *offset = addr - name_location;
668
669   *name = name_temp;
670
671   if (print_symbol_filename)
672     {
673       struct symtab_and_line sal;
674
675       sal = find_pc_sect_line (addr, section, 0);
676
677       if (sal.symtab)
678         {
679           *filename = symtab_to_filename_for_display (sal.symtab);
680           *line = sal.line;
681         }
682     }
683   return 0;
684 }
685
686
687 /* Print address ADDR symbolically on STREAM.
688    First print it as a number.  Then perhaps print
689    <SYMBOL + OFFSET> after the number.  */
690
691 void
692 print_address (struct gdbarch *gdbarch,
693                CORE_ADDR addr, struct ui_file *stream)
694 {
695   fputs_filtered (paddress (gdbarch, addr), stream);
696   print_address_symbolic (gdbarch, addr, stream, asm_demangle, " ");
697 }
698
699 /* Return a prefix for instruction address:
700    "=> " for current instruction, else "   ".  */
701
702 const char *
703 pc_prefix (CORE_ADDR addr)
704 {
705   if (has_stack_frames ())
706     {
707       struct frame_info *frame;
708       CORE_ADDR pc;
709
710       frame = get_selected_frame (NULL);
711       if (get_frame_pc_if_available (frame, &pc) && pc == addr)
712         return "=> ";
713     }
714   return "   ";
715 }
716
717 /* Print address ADDR symbolically on STREAM.  Parameter DEMANGLE
718    controls whether to print the symbolic name "raw" or demangled.
719    Return non-zero if anything was printed; zero otherwise.  */
720
721 int
722 print_address_demangle (const struct value_print_options *opts,
723                         struct gdbarch *gdbarch, CORE_ADDR addr,
724                         struct ui_file *stream, int do_demangle)
725 {
726   if (opts->addressprint)
727     {
728       fputs_filtered (paddress (gdbarch, addr), stream);
729       print_address_symbolic (gdbarch, addr, stream, do_demangle, " ");
730     }
731   else
732     {
733       return print_address_symbolic (gdbarch, addr, stream, do_demangle, "");
734     }
735   return 1;
736 }
737 \f
738
739 /* Find the address of the instruction that is INST_COUNT instructions before
740    the instruction at ADDR.
741    Since some architectures have variable-length instructions, we can't just
742    simply subtract INST_COUNT * INSN_LEN from ADDR.  Instead, we use line
743    number information to locate the nearest known instruction boundary,
744    and disassemble forward from there.  If we go out of the symbol range
745    during disassembling, we return the lowest address we've got so far and
746    set the number of instructions read to INST_READ.  */
747
748 static CORE_ADDR
749 find_instruction_backward (struct gdbarch *gdbarch, CORE_ADDR addr,
750                            int inst_count, int *inst_read)
751 {
752   /* The vector PCS is used to store instruction addresses within
753      a pc range.  */
754   CORE_ADDR loop_start, loop_end, p;
755   std::vector<CORE_ADDR> pcs;
756   struct symtab_and_line sal;
757
758   *inst_read = 0;
759   loop_start = loop_end = addr;
760
761   /* In each iteration of the outer loop, we get a pc range that ends before
762      LOOP_START, then we count and store every instruction address of the range
763      iterated in the loop.
764      If the number of instructions counted reaches INST_COUNT, return the
765      stored address that is located INST_COUNT instructions back from ADDR.
766      If INST_COUNT is not reached, we subtract the number of counted
767      instructions from INST_COUNT, and go to the next iteration.  */
768   do
769     {
770       pcs.clear ();
771       sal = find_pc_sect_line (loop_start, NULL, 1);
772       if (sal.line <= 0)
773         {
774           /* We reach here when line info is not available.  In this case,
775              we print a message and just exit the loop.  The return value
776              is calculated after the loop.  */
777           printf_filtered (_("No line number information available "
778                              "for address "));
779           wrap_here ("  ");
780           print_address (gdbarch, loop_start - 1, gdb_stdout);
781           printf_filtered ("\n");
782           break;
783         }
784
785       loop_end = loop_start;
786       loop_start = sal.pc;
787
788       /* This loop pushes instruction addresses in the range from
789          LOOP_START to LOOP_END.  */
790       for (p = loop_start; p < loop_end;)
791         {
792           pcs.push_back (p);
793           p += gdb_insn_length (gdbarch, p);
794         }
795
796       inst_count -= pcs.size ();
797       *inst_read += pcs.size ();
798     }
799   while (inst_count > 0);
800
801   /* After the loop, the vector PCS has instruction addresses of the last
802      source line we processed, and INST_COUNT has a negative value.
803      We return the address at the index of -INST_COUNT in the vector for
804      the reason below.
805      Let's assume the following instruction addresses and run 'x/-4i 0x400e'.
806        Line X of File
807           0x4000
808           0x4001
809           0x4005
810        Line Y of File
811           0x4009
812           0x400c
813        => 0x400e
814           0x4011
815      find_instruction_backward is called with INST_COUNT = 4 and expected to
816      return 0x4001.  When we reach here, INST_COUNT is set to -1 because
817      it was subtracted by 2 (from Line Y) and 3 (from Line X).  The value
818      4001 is located at the index 1 of the last iterated line (= Line X),
819      which is simply calculated by -INST_COUNT.
820      The case when the length of PCS is 0 means that we reached an area for
821      which line info is not available.  In such case, we return LOOP_START,
822      which was the lowest instruction address that had line info.  */
823   p = pcs.size () > 0 ? pcs[-inst_count] : loop_start;
824
825   /* INST_READ includes all instruction addresses in a pc range.  Need to
826      exclude the beginning part up to the address we're returning.  That
827      is, exclude {0x4000} in the example above.  */
828   if (inst_count < 0)
829     *inst_read += inst_count;
830
831   return p;
832 }
833
834 /* Backward read LEN bytes of target memory from address MEMADDR + LEN,
835    placing the results in GDB's memory from MYADDR + LEN.  Returns
836    a count of the bytes actually read.  */
837
838 static int
839 read_memory_backward (struct gdbarch *gdbarch,
840                       CORE_ADDR memaddr, gdb_byte *myaddr, int len)
841 {
842   int errcode;
843   int nread;      /* Number of bytes actually read.  */
844
845   /* First try a complete read.  */
846   errcode = target_read_memory (memaddr, myaddr, len);
847   if (errcode == 0)
848     {
849       /* Got it all.  */
850       nread = len;
851     }
852   else
853     {
854       /* Loop, reading one byte at a time until we get as much as we can.  */
855       memaddr += len;
856       myaddr += len;
857       for (nread = 0; nread < len; ++nread)
858         {
859           errcode = target_read_memory (--memaddr, --myaddr, 1);
860           if (errcode != 0)
861             {
862               /* The read was unsuccessful, so exit the loop.  */
863               printf_filtered (_("Cannot access memory at address %s\n"),
864                                paddress (gdbarch, memaddr));
865               break;
866             }
867         }
868     }
869   return nread;
870 }
871
872 /* Returns true if X (which is LEN bytes wide) is the number zero.  */
873
874 static int
875 integer_is_zero (const gdb_byte *x, int len)
876 {
877   int i = 0;
878
879   while (i < len && x[i] == 0)
880     ++i;
881   return (i == len);
882 }
883
884 /* Find the start address of a string in which ADDR is included.
885    Basically we search for '\0' and return the next address,
886    but if OPTIONS->PRINT_MAX is smaller than the length of a string,
887    we stop searching and return the address to print characters as many as
888    PRINT_MAX from the string.  */
889
890 static CORE_ADDR
891 find_string_backward (struct gdbarch *gdbarch,
892                       CORE_ADDR addr, int count, int char_size,
893                       const struct value_print_options *options,
894                       int *strings_counted)
895 {
896   const int chunk_size = 0x20;
897   int read_error = 0;
898   int chars_read = 0;
899   int chars_to_read = chunk_size;
900   int chars_counted = 0;
901   int count_original = count;
902   CORE_ADDR string_start_addr = addr;
903
904   gdb_assert (char_size == 1 || char_size == 2 || char_size == 4);
905   gdb::byte_vector buffer (chars_to_read * char_size);
906   while (count > 0 && read_error == 0)
907     {
908       int i;
909
910       addr -= chars_to_read * char_size;
911       chars_read = read_memory_backward (gdbarch, addr, buffer.data (),
912                                          chars_to_read * char_size);
913       chars_read /= char_size;
914       read_error = (chars_read == chars_to_read) ? 0 : 1;
915       /* Searching for '\0' from the end of buffer in backward direction.  */
916       for (i = 0; i < chars_read && count > 0 ; ++i, ++chars_counted)
917         {
918           int offset = (chars_to_read - i - 1) * char_size;
919
920           if (integer_is_zero (&buffer[offset], char_size)
921               || chars_counted == options->print_max)
922             {
923               /* Found '\0' or reached print_max.  As OFFSET is the offset to
924                  '\0', we add CHAR_SIZE to return the start address of
925                  a string.  */
926               --count;
927               string_start_addr = addr + offset + char_size;
928               chars_counted = 0;
929             }
930         }
931     }
932
933   /* Update STRINGS_COUNTED with the actual number of loaded strings.  */
934   *strings_counted = count_original - count;
935
936   if (read_error != 0)
937     {
938       /* In error case, STRING_START_ADDR is pointing to the string that
939          was last successfully loaded.  Rewind the partially loaded string.  */
940       string_start_addr -= chars_counted * char_size;
941     }
942
943   return string_start_addr;
944 }
945
946 /* Examine data at address ADDR in format FMT.
947    Fetch it from memory and print on gdb_stdout.  */
948
949 static void
950 do_examine (struct format_data fmt, struct gdbarch *gdbarch, CORE_ADDR addr)
951 {
952   char format = 0;
953   char size;
954   int count = 1;
955   struct type *val_type = NULL;
956   int i;
957   int maxelts;
958   struct value_print_options opts;
959   int need_to_update_next_address = 0;
960   CORE_ADDR addr_rewound = 0;
961
962   format = fmt.format;
963   size = fmt.size;
964   count = fmt.count;
965   next_gdbarch = gdbarch;
966   next_address = addr;
967
968   /* Instruction format implies fetch single bytes
969      regardless of the specified size.
970      The case of strings is handled in decode_format, only explicit
971      size operator are not changed to 'b'.  */
972   if (format == 'i')
973     size = 'b';
974
975   if (size == 'a')
976     {
977       /* Pick the appropriate size for an address.  */
978       if (gdbarch_ptr_bit (next_gdbarch) == 64)
979         size = 'g';
980       else if (gdbarch_ptr_bit (next_gdbarch) == 32)
981         size = 'w';
982       else if (gdbarch_ptr_bit (next_gdbarch) == 16)
983         size = 'h';
984       else
985         /* Bad value for gdbarch_ptr_bit.  */
986         internal_error (__FILE__, __LINE__,
987                         _("failed internal consistency check"));
988     }
989
990   if (size == 'b')
991     val_type = builtin_type (next_gdbarch)->builtin_int8;
992   else if (size == 'h')
993     val_type = builtin_type (next_gdbarch)->builtin_int16;
994   else if (size == 'w')
995     val_type = builtin_type (next_gdbarch)->builtin_int32;
996   else if (size == 'g')
997     val_type = builtin_type (next_gdbarch)->builtin_int64;
998
999   if (format == 's')
1000     {
1001       struct type *char_type = NULL;
1002
1003       /* Search for "char16_t"  or "char32_t" types or fall back to 8-bit char
1004          if type is not found.  */
1005       if (size == 'h')
1006         char_type = builtin_type (next_gdbarch)->builtin_char16;
1007       else if (size == 'w')
1008         char_type = builtin_type (next_gdbarch)->builtin_char32;
1009       if (char_type)
1010         val_type = char_type;
1011       else
1012         {
1013           if (size != '\0' && size != 'b')
1014             warning (_("Unable to display strings with "
1015                        "size '%c', using 'b' instead."), size);
1016           size = 'b';
1017           val_type = builtin_type (next_gdbarch)->builtin_int8;
1018         }
1019     }
1020
1021   maxelts = 8;
1022   if (size == 'w')
1023     maxelts = 4;
1024   if (size == 'g')
1025     maxelts = 2;
1026   if (format == 's' || format == 'i')
1027     maxelts = 1;
1028
1029   get_formatted_print_options (&opts, format);
1030
1031   if (count < 0)
1032     {
1033       /* This is the negative repeat count case.
1034          We rewind the address based on the given repeat count and format,
1035          then examine memory from there in forward direction.  */
1036
1037       count = -count;
1038       if (format == 'i')
1039         {
1040           next_address = find_instruction_backward (gdbarch, addr, count,
1041                                                     &count);
1042         }
1043       else if (format == 's')
1044         {
1045           next_address = find_string_backward (gdbarch, addr, count,
1046                                                TYPE_LENGTH (val_type),
1047                                                &opts, &count);
1048         }
1049       else
1050         {
1051           next_address = addr - count * TYPE_LENGTH (val_type);
1052         }
1053
1054       /* The following call to print_formatted updates next_address in every
1055          iteration.  In backward case, we store the start address here
1056          and update next_address with it before exiting the function.  */
1057       addr_rewound = (format == 's'
1058                       ? next_address - TYPE_LENGTH (val_type)
1059                       : next_address);
1060       need_to_update_next_address = 1;
1061     }
1062
1063   /* Print as many objects as specified in COUNT, at most maxelts per line,
1064      with the address of the next one at the start of each line.  */
1065
1066   while (count > 0)
1067     {
1068       QUIT;
1069       if (format == 'i')
1070         fputs_filtered (pc_prefix (next_address), gdb_stdout);
1071       print_address (next_gdbarch, next_address, gdb_stdout);
1072       printf_filtered (":");
1073       for (i = maxelts;
1074            i > 0 && count > 0;
1075            i--, count--)
1076         {
1077           printf_filtered ("\t");
1078           /* Note that print_formatted sets next_address for the next
1079              object.  */
1080           last_examine_address = next_address;
1081
1082           /* The value to be displayed is not fetched greedily.
1083              Instead, to avoid the possibility of a fetched value not
1084              being used, its retrieval is delayed until the print code
1085              uses it.  When examining an instruction stream, the
1086              disassembler will perform its own memory fetch using just
1087              the address stored in LAST_EXAMINE_VALUE.  FIXME: Should
1088              the disassembler be modified so that LAST_EXAMINE_VALUE
1089              is left with the byte sequence from the last complete
1090              instruction fetched from memory?  */
1091           last_examine_value
1092             = release_value (value_at_lazy (val_type, next_address));
1093
1094           print_formatted (last_examine_value.get (), size, &opts, gdb_stdout);
1095
1096           /* Display any branch delay slots following the final insn.  */
1097           if (format == 'i' && count == 1)
1098             count += branch_delay_insns;
1099         }
1100       printf_filtered ("\n");
1101       gdb_flush (gdb_stdout);
1102     }
1103
1104   if (need_to_update_next_address)
1105     next_address = addr_rewound;
1106 }
1107 \f
1108 static void
1109 validate_format (struct format_data fmt, const char *cmdname)
1110 {
1111   if (fmt.size != 0)
1112     error (_("Size letters are meaningless in \"%s\" command."), cmdname);
1113   if (fmt.count != 1)
1114     error (_("Item count other than 1 is meaningless in \"%s\" command."),
1115            cmdname);
1116   if (fmt.format == 'i')
1117     error (_("Format letter \"%c\" is meaningless in \"%s\" command."),
1118            fmt.format, cmdname);
1119 }
1120
1121 /* Parse print command format string into *FMTP and update *EXPP.
1122    CMDNAME should name the current command.  */
1123
1124 void
1125 print_command_parse_format (const char **expp, const char *cmdname,
1126                             struct format_data *fmtp)
1127 {
1128   const char *exp = *expp;
1129
1130   if (exp && *exp == '/')
1131     {
1132       exp++;
1133       *fmtp = decode_format (&exp, last_format, 0);
1134       validate_format (*fmtp, cmdname);
1135       last_format = fmtp->format;
1136     }
1137   else
1138     {
1139       fmtp->count = 1;
1140       fmtp->format = 0;
1141       fmtp->size = 0;
1142       fmtp->raw = 0;
1143     }
1144
1145   *expp = exp;
1146 }
1147
1148 /* Print VAL to console according to *FMTP, including recording it to
1149    the history.  */
1150
1151 void
1152 print_value (struct value *val, const struct format_data *fmtp)
1153 {
1154   struct value_print_options opts;
1155   int histindex = record_latest_value (val);
1156
1157   annotate_value_history_begin (histindex, value_type (val));
1158
1159   printf_filtered ("$%d = ", histindex);
1160
1161   annotate_value_history_value ();
1162
1163   get_formatted_print_options (&opts, fmtp->format);
1164   opts.raw = fmtp->raw;
1165
1166   print_formatted (val, fmtp->size, &opts, gdb_stdout);
1167   printf_filtered ("\n");
1168
1169   annotate_value_history_end ();
1170 }
1171
1172 /* Evaluate string EXP as an expression in the current language and
1173    print the resulting value.  EXP may contain a format specifier as the
1174    first argument ("/x myvar" for example, to print myvar in hex).  */
1175
1176 static void
1177 print_command_1 (const char *exp, int voidprint)
1178 {
1179   struct value *val;
1180   struct format_data fmt;
1181
1182   print_command_parse_format (&exp, "print", &fmt);
1183
1184   if (exp && *exp)
1185     {
1186       expression_up expr = parse_expression (exp);
1187       val = evaluate_expression (expr.get ());
1188     }
1189   else
1190     val = access_value_history (0);
1191
1192   if (voidprint || (val && value_type (val) &&
1193                     TYPE_CODE (value_type (val)) != TYPE_CODE_VOID))
1194     print_value (val, &fmt);
1195 }
1196
1197 static void
1198 print_command (const char *exp, int from_tty)
1199 {
1200   print_command_1 (exp, 1);
1201 }
1202
1203 /* Same as print, except it doesn't print void results.  */
1204 static void
1205 call_command (const char *exp, int from_tty)
1206 {
1207   print_command_1 (exp, 0);
1208 }
1209
1210 /* Implementation of the "output" command.  */
1211
1212 void
1213 output_command (const char *exp, int from_tty)
1214 {
1215   char format = 0;
1216   struct value *val;
1217   struct format_data fmt;
1218   struct value_print_options opts;
1219
1220   fmt.size = 0;
1221   fmt.raw = 0;
1222
1223   if (exp && *exp == '/')
1224     {
1225       exp++;
1226       fmt = decode_format (&exp, 0, 0);
1227       validate_format (fmt, "output");
1228       format = fmt.format;
1229     }
1230
1231   expression_up expr = parse_expression (exp);
1232
1233   val = evaluate_expression (expr.get ());
1234
1235   annotate_value_begin (value_type (val));
1236
1237   get_formatted_print_options (&opts, format);
1238   opts.raw = fmt.raw;
1239   print_formatted (val, fmt.size, &opts, gdb_stdout);
1240
1241   annotate_value_end ();
1242
1243   wrap_here ("");
1244   gdb_flush (gdb_stdout);
1245 }
1246
1247 static void
1248 set_command (const char *exp, int from_tty)
1249 {
1250   expression_up expr = parse_expression (exp);
1251
1252   if (expr->nelts >= 1)
1253     switch (expr->elts[0].opcode)
1254       {
1255       case UNOP_PREINCREMENT:
1256       case UNOP_POSTINCREMENT:
1257       case UNOP_PREDECREMENT:
1258       case UNOP_POSTDECREMENT:
1259       case BINOP_ASSIGN:
1260       case BINOP_ASSIGN_MODIFY:
1261       case BINOP_COMMA:
1262         break;
1263       default:
1264         warning
1265           (_("Expression is not an assignment (and might have no effect)"));
1266       }
1267
1268   evaluate_expression (expr.get ());
1269 }
1270
1271 static void
1272 info_symbol_command (const char *arg, int from_tty)
1273 {
1274   struct minimal_symbol *msymbol;
1275   struct objfile *objfile;
1276   struct obj_section *osect;
1277   CORE_ADDR addr, sect_addr;
1278   int matches = 0;
1279   unsigned int offset;
1280
1281   if (!arg)
1282     error_no_arg (_("address"));
1283
1284   addr = parse_and_eval_address (arg);
1285   ALL_OBJSECTIONS (objfile, osect)
1286   {
1287     /* Only process each object file once, even if there's a separate
1288        debug file.  */
1289     if (objfile->separate_debug_objfile_backlink)
1290       continue;
1291
1292     sect_addr = overlay_mapped_address (addr, osect);
1293
1294     if (obj_section_addr (osect) <= sect_addr
1295         && sect_addr < obj_section_endaddr (osect)
1296         && (msymbol
1297             = lookup_minimal_symbol_by_pc_section (sect_addr, osect).minsym))
1298       {
1299         const char *obj_name, *mapped, *sec_name, *msym_name;
1300         const char *loc_string;
1301
1302         matches = 1;
1303         offset = sect_addr - MSYMBOL_VALUE_ADDRESS (objfile, msymbol);
1304         mapped = section_is_mapped (osect) ? _("mapped") : _("unmapped");
1305         sec_name = osect->the_bfd_section->name;
1306         msym_name = MSYMBOL_PRINT_NAME (msymbol);
1307
1308         /* Don't print the offset if it is zero.
1309            We assume there's no need to handle i18n of "sym + offset".  */
1310         std::string string_holder;
1311         if (offset)
1312           {
1313             string_holder = string_printf ("%s + %u", msym_name, offset);
1314             loc_string = string_holder.c_str ();
1315           }
1316         else
1317           loc_string = msym_name;
1318
1319         gdb_assert (osect->objfile && objfile_name (osect->objfile));
1320         obj_name = objfile_name (osect->objfile);
1321
1322         if (MULTI_OBJFILE_P ())
1323           if (pc_in_unmapped_range (addr, osect))
1324             if (section_is_overlay (osect))
1325               printf_filtered (_("%s in load address range of "
1326                                  "%s overlay section %s of %s\n"),
1327                                loc_string, mapped, sec_name, obj_name);
1328             else
1329               printf_filtered (_("%s in load address range of "
1330                                  "section %s of %s\n"),
1331                                loc_string, sec_name, obj_name);
1332           else
1333             if (section_is_overlay (osect))
1334               printf_filtered (_("%s in %s overlay section %s of %s\n"),
1335                                loc_string, mapped, sec_name, obj_name);
1336             else
1337               printf_filtered (_("%s in section %s of %s\n"),
1338                                loc_string, sec_name, obj_name);
1339         else
1340           if (pc_in_unmapped_range (addr, osect))
1341             if (section_is_overlay (osect))
1342               printf_filtered (_("%s in load address range of %s overlay "
1343                                  "section %s\n"),
1344                                loc_string, mapped, sec_name);
1345             else
1346               printf_filtered (_("%s in load address range of section %s\n"),
1347                                loc_string, sec_name);
1348           else
1349             if (section_is_overlay (osect))
1350               printf_filtered (_("%s in %s overlay section %s\n"),
1351                                loc_string, mapped, sec_name);
1352             else
1353               printf_filtered (_("%s in section %s\n"),
1354                                loc_string, sec_name);
1355       }
1356   }
1357   if (matches == 0)
1358     printf_filtered (_("No symbol matches %s.\n"), arg);
1359 }
1360
1361 static void
1362 info_address_command (const char *exp, int from_tty)
1363 {
1364   struct gdbarch *gdbarch;
1365   int regno;
1366   struct symbol *sym;
1367   struct bound_minimal_symbol msymbol;
1368   long val;
1369   struct obj_section *section;
1370   CORE_ADDR load_addr, context_pc = 0;
1371   struct field_of_this_result is_a_field_of_this;
1372
1373   if (exp == 0)
1374     error (_("Argument required."));
1375
1376   sym = lookup_symbol (exp, get_selected_block (&context_pc), VAR_DOMAIN,
1377                        &is_a_field_of_this).symbol;
1378   if (sym == NULL)
1379     {
1380       if (is_a_field_of_this.type != NULL)
1381         {
1382           printf_filtered ("Symbol \"");
1383           fprintf_symbol_filtered (gdb_stdout, exp,
1384                                    current_language->la_language, DMGL_ANSI);
1385           printf_filtered ("\" is a field of the local class variable ");
1386           if (current_language->la_language == language_objc)
1387             printf_filtered ("`self'\n");       /* ObjC equivalent of "this" */
1388           else
1389             printf_filtered ("`this'\n");
1390           return;
1391         }
1392
1393       msymbol = lookup_bound_minimal_symbol (exp);
1394
1395       if (msymbol.minsym != NULL)
1396         {
1397           struct objfile *objfile = msymbol.objfile;
1398
1399           gdbarch = get_objfile_arch (objfile);
1400           load_addr = BMSYMBOL_VALUE_ADDRESS (msymbol);
1401
1402           printf_filtered ("Symbol \"");
1403           fprintf_symbol_filtered (gdb_stdout, exp,
1404                                    current_language->la_language, DMGL_ANSI);
1405           printf_filtered ("\" is at ");
1406           fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1407           printf_filtered (" in a file compiled without debugging");
1408           section = MSYMBOL_OBJ_SECTION (objfile, msymbol.minsym);
1409           if (section_is_overlay (section))
1410             {
1411               load_addr = overlay_unmapped_address (load_addr, section);
1412               printf_filtered (",\n -- loaded at ");
1413               fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1414               printf_filtered (" in overlay section %s",
1415                                section->the_bfd_section->name);
1416             }
1417           printf_filtered (".\n");
1418         }
1419       else
1420         error (_("No symbol \"%s\" in current context."), exp);
1421       return;
1422     }
1423
1424   printf_filtered ("Symbol \"");
1425   fprintf_symbol_filtered (gdb_stdout, SYMBOL_PRINT_NAME (sym),
1426                            current_language->la_language, DMGL_ANSI);
1427   printf_filtered ("\" is ");
1428   val = SYMBOL_VALUE (sym);
1429   if (SYMBOL_OBJFILE_OWNED (sym))
1430     section = SYMBOL_OBJ_SECTION (symbol_objfile (sym), sym);
1431   else
1432     section = NULL;
1433   gdbarch = symbol_arch (sym);
1434
1435   if (SYMBOL_COMPUTED_OPS (sym) != NULL)
1436     {
1437       SYMBOL_COMPUTED_OPS (sym)->describe_location (sym, context_pc,
1438                                                     gdb_stdout);
1439       printf_filtered (".\n");
1440       return;
1441     }
1442
1443   switch (SYMBOL_CLASS (sym))
1444     {
1445     case LOC_CONST:
1446     case LOC_CONST_BYTES:
1447       printf_filtered ("constant");
1448       break;
1449
1450     case LOC_LABEL:
1451       printf_filtered ("a label at address ");
1452       load_addr = SYMBOL_VALUE_ADDRESS (sym);
1453       fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1454       if (section_is_overlay (section))
1455         {
1456           load_addr = overlay_unmapped_address (load_addr, section);
1457           printf_filtered (",\n -- loaded at ");
1458           fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1459           printf_filtered (" in overlay section %s",
1460                            section->the_bfd_section->name);
1461         }
1462       break;
1463
1464     case LOC_COMPUTED:
1465       gdb_assert_not_reached (_("LOC_COMPUTED variable missing a method"));
1466
1467     case LOC_REGISTER:
1468       /* GDBARCH is the architecture associated with the objfile the symbol
1469          is defined in; the target architecture may be different, and may
1470          provide additional registers.  However, we do not know the target
1471          architecture at this point.  We assume the objfile architecture
1472          will contain all the standard registers that occur in debug info
1473          in that objfile.  */
1474       regno = SYMBOL_REGISTER_OPS (sym)->register_number (sym, gdbarch);
1475
1476       if (SYMBOL_IS_ARGUMENT (sym))
1477         printf_filtered (_("an argument in register %s"),
1478                          gdbarch_register_name (gdbarch, regno));
1479       else
1480         printf_filtered (_("a variable in register %s"),
1481                          gdbarch_register_name (gdbarch, regno));
1482       break;
1483
1484     case LOC_STATIC:
1485       printf_filtered (_("static storage at address "));
1486       load_addr = SYMBOL_VALUE_ADDRESS (sym);
1487       fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1488       if (section_is_overlay (section))
1489         {
1490           load_addr = overlay_unmapped_address (load_addr, section);
1491           printf_filtered (_(",\n -- loaded at "));
1492           fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1493           printf_filtered (_(" in overlay section %s"),
1494                            section->the_bfd_section->name);
1495         }
1496       break;
1497
1498     case LOC_REGPARM_ADDR:
1499       /* Note comment at LOC_REGISTER.  */
1500       regno = SYMBOL_REGISTER_OPS (sym)->register_number (sym, gdbarch);
1501       printf_filtered (_("address of an argument in register %s"),
1502                        gdbarch_register_name (gdbarch, regno));
1503       break;
1504
1505     case LOC_ARG:
1506       printf_filtered (_("an argument at offset %ld"), val);
1507       break;
1508
1509     case LOC_LOCAL:
1510       printf_filtered (_("a local variable at frame offset %ld"), val);
1511       break;
1512
1513     case LOC_REF_ARG:
1514       printf_filtered (_("a reference argument at offset %ld"), val);
1515       break;
1516
1517     case LOC_TYPEDEF:
1518       printf_filtered (_("a typedef"));
1519       break;
1520
1521     case LOC_BLOCK:
1522       printf_filtered (_("a function at address "));
1523       load_addr = BLOCK_ENTRY_PC (SYMBOL_BLOCK_VALUE (sym));
1524       fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1525       if (section_is_overlay (section))
1526         {
1527           load_addr = overlay_unmapped_address (load_addr, section);
1528           printf_filtered (_(",\n -- loaded at "));
1529           fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1530           printf_filtered (_(" in overlay section %s"),
1531                            section->the_bfd_section->name);
1532         }
1533       break;
1534
1535     case LOC_UNRESOLVED:
1536       {
1537         struct bound_minimal_symbol msym;
1538
1539         msym = lookup_bound_minimal_symbol (SYMBOL_LINKAGE_NAME (sym));
1540         if (msym.minsym == NULL)
1541           printf_filtered ("unresolved");
1542         else
1543           {
1544             section = MSYMBOL_OBJ_SECTION (msym.objfile, msym.minsym);
1545
1546             if (section
1547                 && (section->the_bfd_section->flags & SEC_THREAD_LOCAL) != 0)
1548               {
1549                 load_addr = MSYMBOL_VALUE_RAW_ADDRESS (msym.minsym);
1550                 printf_filtered (_("a thread-local variable at offset %s "
1551                                    "in the thread-local storage for `%s'"),
1552                                  paddress (gdbarch, load_addr),
1553                                  objfile_name (section->objfile));
1554               }
1555             else
1556               {
1557                 load_addr = BMSYMBOL_VALUE_ADDRESS (msym);
1558                 printf_filtered (_("static storage at address "));
1559                 fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1560                 if (section_is_overlay (section))
1561                   {
1562                     load_addr = overlay_unmapped_address (load_addr, section);
1563                     printf_filtered (_(",\n -- loaded at "));
1564                     fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1565                     printf_filtered (_(" in overlay section %s"),
1566                                      section->the_bfd_section->name);
1567                   }
1568               }
1569           }
1570       }
1571       break;
1572
1573     case LOC_OPTIMIZED_OUT:
1574       printf_filtered (_("optimized out"));
1575       break;
1576
1577     default:
1578       printf_filtered (_("of unknown (botched) type"));
1579       break;
1580     }
1581   printf_filtered (".\n");
1582 }
1583 \f
1584
1585 static void
1586 x_command (const char *exp, int from_tty)
1587 {
1588   struct format_data fmt;
1589   struct value *val;
1590
1591   fmt.format = last_format ? last_format : 'x';
1592   fmt.size = last_size;
1593   fmt.count = 1;
1594   fmt.raw = 0;
1595
1596   /* If there is no expression and no format, use the most recent
1597      count.  */
1598   if (exp == nullptr && last_count > 0)
1599     fmt.count = last_count;
1600
1601   if (exp && *exp == '/')
1602     {
1603       const char *tmp = exp + 1;
1604
1605       fmt = decode_format (&tmp, last_format, last_size);
1606       exp = (char *) tmp;
1607     }
1608
1609   last_count = fmt.count;
1610
1611   /* If we have an expression, evaluate it and use it as the address.  */
1612
1613   if (exp != 0 && *exp != 0)
1614     {
1615       expression_up expr = parse_expression (exp);
1616       /* Cause expression not to be there any more if this command is
1617          repeated with Newline.  But don't clobber a user-defined
1618          command's definition.  */
1619       if (from_tty)
1620         set_repeat_arguments ("");
1621       val = evaluate_expression (expr.get ());
1622       if (TYPE_IS_REFERENCE (value_type (val)))
1623         val = coerce_ref (val);
1624       /* In rvalue contexts, such as this, functions are coerced into
1625          pointers to functions.  This makes "x/i main" work.  */
1626       if (/* last_format == 'i'  && */ 
1627           TYPE_CODE (value_type (val)) == TYPE_CODE_FUNC
1628            && VALUE_LVAL (val) == lval_memory)
1629         next_address = value_address (val);
1630       else
1631         next_address = value_as_address (val);
1632
1633       next_gdbarch = expr->gdbarch;
1634     }
1635
1636   if (!next_gdbarch)
1637     error_no_arg (_("starting display address"));
1638
1639   do_examine (fmt, next_gdbarch, next_address);
1640
1641   /* If the examine succeeds, we remember its size and format for next
1642      time.  Set last_size to 'b' for strings.  */
1643   if (fmt.format == 's')
1644     last_size = 'b';
1645   else
1646     last_size = fmt.size;
1647   last_format = fmt.format;
1648
1649   /* Set a couple of internal variables if appropriate.  */
1650   if (last_examine_value != nullptr)
1651     {
1652       /* Make last address examined available to the user as $_.  Use
1653          the correct pointer type.  */
1654       struct type *pointer_type
1655         = lookup_pointer_type (value_type (last_examine_value.get ()));
1656       set_internalvar (lookup_internalvar ("_"),
1657                        value_from_pointer (pointer_type,
1658                                            last_examine_address));
1659
1660       /* Make contents of last address examined available to the user
1661          as $__.  If the last value has not been fetched from memory
1662          then don't fetch it now; instead mark it by voiding the $__
1663          variable.  */
1664       if (value_lazy (last_examine_value.get ()))
1665         clear_internalvar (lookup_internalvar ("__"));
1666       else
1667         set_internalvar (lookup_internalvar ("__"), last_examine_value.get ());
1668     }
1669 }
1670 \f
1671
1672 /* Add an expression to the auto-display chain.
1673    Specify the expression.  */
1674
1675 static void
1676 display_command (const char *arg, int from_tty)
1677 {
1678   struct format_data fmt;
1679   struct display *newobj;
1680   const char *exp = arg;
1681
1682   if (exp == 0)
1683     {
1684       do_displays ();
1685       return;
1686     }
1687
1688   if (*exp == '/')
1689     {
1690       exp++;
1691       fmt = decode_format (&exp, 0, 0);
1692       if (fmt.size && fmt.format == 0)
1693         fmt.format = 'x';
1694       if (fmt.format == 'i' || fmt.format == 's')
1695         fmt.size = 'b';
1696     }
1697   else
1698     {
1699       fmt.format = 0;
1700       fmt.size = 0;
1701       fmt.count = 0;
1702       fmt.raw = 0;
1703     }
1704
1705   innermost_block.reset ();
1706   expression_up expr = parse_expression (exp);
1707
1708   newobj = new display ();
1709
1710   newobj->exp_string = xstrdup (exp);
1711   newobj->exp = std::move (expr);
1712   newobj->block = innermost_block.block ();
1713   newobj->pspace = current_program_space;
1714   newobj->number = ++display_number;
1715   newobj->format = fmt;
1716   newobj->enabled_p = 1;
1717   newobj->next = NULL;
1718
1719   if (display_chain == NULL)
1720     display_chain = newobj;
1721   else
1722     {
1723       struct display *last;
1724
1725       for (last = display_chain; last->next != NULL; last = last->next)
1726         ;
1727       last->next = newobj;
1728     }
1729
1730   if (from_tty)
1731     do_one_display (newobj);
1732
1733   dont_repeat ();
1734 }
1735
1736 static void
1737 free_display (struct display *d)
1738 {
1739   xfree (d->exp_string);
1740   delete d;
1741 }
1742
1743 /* Clear out the display_chain.  Done when new symtabs are loaded,
1744    since this invalidates the types stored in many expressions.  */
1745
1746 void
1747 clear_displays (void)
1748 {
1749   struct display *d;
1750
1751   while ((d = display_chain) != NULL)
1752     {
1753       display_chain = d->next;
1754       free_display (d);
1755     }
1756 }
1757
1758 /* Delete the auto-display DISPLAY.  */
1759
1760 static void
1761 delete_display (struct display *display)
1762 {
1763   struct display *d;
1764
1765   gdb_assert (display != NULL);
1766
1767   if (display_chain == display)
1768     display_chain = display->next;
1769
1770   ALL_DISPLAYS (d)
1771     if (d->next == display)
1772       {
1773         d->next = display->next;
1774         break;
1775       }
1776
1777   free_display (display);
1778 }
1779
1780 /* Call FUNCTION on each of the displays whose numbers are given in
1781    ARGS.  DATA is passed unmodified to FUNCTION.  */
1782
1783 static void
1784 map_display_numbers (const char *args,
1785                      void (*function) (struct display *,
1786                                        void *),
1787                      void *data)
1788 {
1789   int num;
1790
1791   if (args == NULL)
1792     error_no_arg (_("one or more display numbers"));
1793
1794   number_or_range_parser parser (args);
1795
1796   while (!parser.finished ())
1797     {
1798       const char *p = parser.cur_tok ();
1799
1800       num = parser.get_number ();
1801       if (num == 0)
1802         warning (_("bad display number at or near '%s'"), p);
1803       else
1804         {
1805           struct display *d, *tmp;
1806
1807           ALL_DISPLAYS_SAFE (d, tmp)
1808             if (d->number == num)
1809               break;
1810           if (d == NULL)
1811             printf_unfiltered (_("No display number %d.\n"), num);
1812           else
1813             function (d, data);
1814         }
1815     }
1816 }
1817
1818 /* Callback for map_display_numbers, that deletes a display.  */
1819
1820 static void
1821 do_delete_display (struct display *d, void *data)
1822 {
1823   delete_display (d);
1824 }
1825
1826 /* "undisplay" command.  */
1827
1828 static void
1829 undisplay_command (const char *args, int from_tty)
1830 {
1831   if (args == NULL)
1832     {
1833       if (query (_("Delete all auto-display expressions? ")))
1834         clear_displays ();
1835       dont_repeat ();
1836       return;
1837     }
1838
1839   map_display_numbers (args, do_delete_display, NULL);
1840   dont_repeat ();
1841 }
1842
1843 /* Display a single auto-display.  
1844    Do nothing if the display cannot be printed in the current context,
1845    or if the display is disabled.  */
1846
1847 static void
1848 do_one_display (struct display *d)
1849 {
1850   int within_current_scope;
1851
1852   if (d->enabled_p == 0)
1853     return;
1854
1855   /* The expression carries the architecture that was used at parse time.
1856      This is a problem if the expression depends on architecture features
1857      (e.g. register numbers), and the current architecture is now different.
1858      For example, a display statement like "display/i $pc" is expected to
1859      display the PC register of the current architecture, not the arch at
1860      the time the display command was given.  Therefore, we re-parse the
1861      expression if the current architecture has changed.  */
1862   if (d->exp != NULL && d->exp->gdbarch != get_current_arch ())
1863     {
1864       d->exp.reset ();
1865       d->block = NULL;
1866     }
1867
1868   if (d->exp == NULL)
1869     {
1870
1871       TRY
1872         {
1873           innermost_block.reset ();
1874           d->exp = parse_expression (d->exp_string);
1875           d->block = innermost_block.block ();
1876         }
1877       CATCH (ex, RETURN_MASK_ALL)
1878         {
1879           /* Can't re-parse the expression.  Disable this display item.  */
1880           d->enabled_p = 0;
1881           warning (_("Unable to display \"%s\": %s"),
1882                    d->exp_string, ex.message);
1883           return;
1884         }
1885       END_CATCH
1886     }
1887
1888   if (d->block)
1889     {
1890       if (d->pspace == current_program_space)
1891         within_current_scope = contained_in (get_selected_block (0), d->block);
1892       else
1893         within_current_scope = 0;
1894     }
1895   else
1896     within_current_scope = 1;
1897   if (!within_current_scope)
1898     return;
1899
1900   scoped_restore save_display_number
1901     = make_scoped_restore (&current_display_number, d->number);
1902
1903   annotate_display_begin ();
1904   printf_filtered ("%d", d->number);
1905   annotate_display_number_end ();
1906   printf_filtered (": ");
1907   if (d->format.size)
1908     {
1909
1910       annotate_display_format ();
1911
1912       printf_filtered ("x/");
1913       if (d->format.count != 1)
1914         printf_filtered ("%d", d->format.count);
1915       printf_filtered ("%c", d->format.format);
1916       if (d->format.format != 'i' && d->format.format != 's')
1917         printf_filtered ("%c", d->format.size);
1918       printf_filtered (" ");
1919
1920       annotate_display_expression ();
1921
1922       puts_filtered (d->exp_string);
1923       annotate_display_expression_end ();
1924
1925       if (d->format.count != 1 || d->format.format == 'i')
1926         printf_filtered ("\n");
1927       else
1928         printf_filtered ("  ");
1929
1930       annotate_display_value ();
1931
1932       TRY
1933         {
1934           struct value *val;
1935           CORE_ADDR addr;
1936
1937           val = evaluate_expression (d->exp.get ());
1938           addr = value_as_address (val);
1939           if (d->format.format == 'i')
1940             addr = gdbarch_addr_bits_remove (d->exp->gdbarch, addr);
1941           do_examine (d->format, d->exp->gdbarch, addr);
1942         }
1943       CATCH (ex, RETURN_MASK_ERROR)
1944         {
1945           fprintf_filtered (gdb_stdout, _("<error: %s>\n"), ex.message);
1946         }
1947       END_CATCH
1948     }
1949   else
1950     {
1951       struct value_print_options opts;
1952
1953       annotate_display_format ();
1954
1955       if (d->format.format)
1956         printf_filtered ("/%c ", d->format.format);
1957
1958       annotate_display_expression ();
1959
1960       puts_filtered (d->exp_string);
1961       annotate_display_expression_end ();
1962
1963       printf_filtered (" = ");
1964
1965       annotate_display_expression ();
1966
1967       get_formatted_print_options (&opts, d->format.format);
1968       opts.raw = d->format.raw;
1969
1970       TRY
1971         {
1972           struct value *val;
1973
1974           val = evaluate_expression (d->exp.get ());
1975           print_formatted (val, d->format.size, &opts, gdb_stdout);
1976         }
1977       CATCH (ex, RETURN_MASK_ERROR)
1978         {
1979           fprintf_filtered (gdb_stdout, _("<error: %s>"), ex.message);
1980         }
1981       END_CATCH
1982
1983       printf_filtered ("\n");
1984     }
1985
1986   annotate_display_end ();
1987
1988   gdb_flush (gdb_stdout);
1989 }
1990
1991 /* Display all of the values on the auto-display chain which can be
1992    evaluated in the current scope.  */
1993
1994 void
1995 do_displays (void)
1996 {
1997   struct display *d;
1998
1999   for (d = display_chain; d; d = d->next)
2000     do_one_display (d);
2001 }
2002
2003 /* Delete the auto-display which we were in the process of displaying.
2004    This is done when there is an error or a signal.  */
2005
2006 void
2007 disable_display (int num)
2008 {
2009   struct display *d;
2010
2011   for (d = display_chain; d; d = d->next)
2012     if (d->number == num)
2013       {
2014         d->enabled_p = 0;
2015         return;
2016       }
2017   printf_unfiltered (_("No display number %d.\n"), num);
2018 }
2019
2020 void
2021 disable_current_display (void)
2022 {
2023   if (current_display_number >= 0)
2024     {
2025       disable_display (current_display_number);
2026       fprintf_unfiltered (gdb_stderr,
2027                           _("Disabling display %d to "
2028                             "avoid infinite recursion.\n"),
2029                           current_display_number);
2030     }
2031   current_display_number = -1;
2032 }
2033
2034 static void
2035 info_display_command (const char *ignore, int from_tty)
2036 {
2037   struct display *d;
2038
2039   if (!display_chain)
2040     printf_unfiltered (_("There are no auto-display expressions now.\n"));
2041   else
2042     printf_filtered (_("Auto-display expressions now in effect:\n\
2043 Num Enb Expression\n"));
2044
2045   for (d = display_chain; d; d = d->next)
2046     {
2047       printf_filtered ("%d:   %c  ", d->number, "ny"[(int) d->enabled_p]);
2048       if (d->format.size)
2049         printf_filtered ("/%d%c%c ", d->format.count, d->format.size,
2050                          d->format.format);
2051       else if (d->format.format)
2052         printf_filtered ("/%c ", d->format.format);
2053       puts_filtered (d->exp_string);
2054       if (d->block && !contained_in (get_selected_block (0), d->block))
2055         printf_filtered (_(" (cannot be evaluated in the current context)"));
2056       printf_filtered ("\n");
2057       gdb_flush (gdb_stdout);
2058     }
2059 }
2060
2061 /* Callback fo map_display_numbers, that enables or disables the
2062    passed in display D.  */
2063
2064 static void
2065 do_enable_disable_display (struct display *d, void *data)
2066 {
2067   d->enabled_p = *(int *) data;
2068 }
2069
2070 /* Implamentation of both the "disable display" and "enable display"
2071    commands.  ENABLE decides what to do.  */
2072
2073 static void
2074 enable_disable_display_command (const char *args, int from_tty, int enable)
2075 {
2076   if (args == NULL)
2077     {
2078       struct display *d;
2079
2080       ALL_DISPLAYS (d)
2081         d->enabled_p = enable;
2082       return;
2083     }
2084
2085   map_display_numbers (args, do_enable_disable_display, &enable);
2086 }
2087
2088 /* The "enable display" command.  */
2089
2090 static void
2091 enable_display_command (const char *args, int from_tty)
2092 {
2093   enable_disable_display_command (args, from_tty, 1);
2094 }
2095
2096 /* The "disable display" command.  */
2097
2098 static void
2099 disable_display_command (const char *args, int from_tty)
2100 {
2101   enable_disable_display_command (args, from_tty, 0);
2102 }
2103
2104 /* display_chain items point to blocks and expressions.  Some expressions in
2105    turn may point to symbols.
2106    Both symbols and blocks are obstack_alloc'd on objfile_stack, and are
2107    obstack_free'd when a shared library is unloaded.
2108    Clear pointers that are about to become dangling.
2109    Both .exp and .block fields will be restored next time we need to display
2110    an item by re-parsing .exp_string field in the new execution context.  */
2111
2112 static void
2113 clear_dangling_display_expressions (struct objfile *objfile)
2114 {
2115   struct display *d;
2116   struct program_space *pspace;
2117
2118   /* With no symbol file we cannot have a block or expression from it.  */
2119   if (objfile == NULL)
2120     return;
2121   pspace = objfile->pspace;
2122   if (objfile->separate_debug_objfile_backlink)
2123     {
2124       objfile = objfile->separate_debug_objfile_backlink;
2125       gdb_assert (objfile->pspace == pspace);
2126     }
2127
2128   for (d = display_chain; d != NULL; d = d->next)
2129     {
2130       if (d->pspace != pspace)
2131         continue;
2132
2133       if (lookup_objfile_from_block (d->block) == objfile
2134           || (d->exp != NULL && exp_uses_objfile (d->exp.get (), objfile)))
2135       {
2136         d->exp.reset ();
2137         d->block = NULL;
2138       }
2139     }
2140 }
2141 \f
2142
2143 /* Print the value in stack frame FRAME of a variable specified by a
2144    struct symbol.  NAME is the name to print; if NULL then VAR's print
2145    name will be used.  STREAM is the ui_file on which to print the
2146    value.  INDENT specifies the number of indent levels to print
2147    before printing the variable name.
2148
2149    This function invalidates FRAME.  */
2150
2151 void
2152 print_variable_and_value (const char *name, struct symbol *var,
2153                           struct frame_info *frame,
2154                           struct ui_file *stream, int indent)
2155 {
2156
2157   if (!name)
2158     name = SYMBOL_PRINT_NAME (var);
2159
2160   fputs_filtered (n_spaces (2 * indent), stream);
2161   fputs_styled (name, variable_name_style.style (), stream);
2162   fputs_filtered (" = ", stream);
2163
2164   TRY
2165     {
2166       struct value *val;
2167       struct value_print_options opts;
2168
2169       /* READ_VAR_VALUE needs a block in order to deal with non-local
2170          references (i.e. to handle nested functions).  In this context, we
2171          print variables that are local to this frame, so we can avoid passing
2172          a block to it.  */
2173       val = read_var_value (var, NULL, frame);
2174       get_user_print_options (&opts);
2175       opts.deref_ref = 1;
2176       common_val_print (val, stream, indent, &opts, current_language);
2177
2178       /* common_val_print invalidates FRAME when a pretty printer calls inferior
2179          function.  */
2180       frame = NULL;
2181     }
2182   CATCH (except, RETURN_MASK_ERROR)
2183     {
2184       fprintf_filtered(stream, "<error reading variable %s (%s)>", name,
2185                        except.message);
2186     }
2187   END_CATCH
2188
2189   fprintf_filtered (stream, "\n");
2190 }
2191
2192 /* Subroutine of ui_printf to simplify it.
2193    Print VALUE to STREAM using FORMAT.
2194    VALUE is a C-style string on the target.  */
2195
2196 static void
2197 printf_c_string (struct ui_file *stream, const char *format,
2198                  struct value *value)
2199 {
2200   gdb_byte *str;
2201   CORE_ADDR tem;
2202   int j;
2203
2204   tem = value_as_address (value);
2205   if (tem == 0)
2206     {
2207       DIAGNOSTIC_PUSH
2208       DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL
2209       fprintf_filtered (stream, format, "(null)");
2210       DIAGNOSTIC_POP
2211       return;
2212     }
2213
2214   /* This is a %s argument.  Find the length of the string.  */
2215   for (j = 0;; j++)
2216     {
2217       gdb_byte c;
2218
2219       QUIT;
2220       read_memory (tem + j, &c, 1);
2221       if (c == 0)
2222         break;
2223     }
2224
2225   /* Copy the string contents into a string inside GDB.  */
2226   str = (gdb_byte *) alloca (j + 1);
2227   if (j != 0)
2228     read_memory (tem, str, j);
2229   str[j] = 0;
2230
2231   DIAGNOSTIC_PUSH
2232   DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL
2233   fprintf_filtered (stream, format, (char *) str);
2234   DIAGNOSTIC_POP
2235 }
2236
2237 /* Subroutine of ui_printf to simplify it.
2238    Print VALUE to STREAM using FORMAT.
2239    VALUE is a wide C-style string on the target.  */
2240
2241 static void
2242 printf_wide_c_string (struct ui_file *stream, const char *format,
2243                       struct value *value)
2244 {
2245   gdb_byte *str;
2246   CORE_ADDR tem;
2247   int j;
2248   struct gdbarch *gdbarch = get_type_arch (value_type (value));
2249   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
2250   struct type *wctype = lookup_typename (current_language, gdbarch,
2251                                          "wchar_t", NULL, 0);
2252   int wcwidth = TYPE_LENGTH (wctype);
2253   gdb_byte *buf = (gdb_byte *) alloca (wcwidth);
2254
2255   tem = value_as_address (value);
2256   if (tem == 0)
2257     {
2258       DIAGNOSTIC_PUSH
2259       DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL
2260       fprintf_filtered (stream, format, "(null)");
2261       DIAGNOSTIC_POP
2262       return;
2263     }
2264
2265   /* This is a %s argument.  Find the length of the string.  */
2266   for (j = 0;; j += wcwidth)
2267     {
2268       QUIT;
2269       read_memory (tem + j, buf, wcwidth);
2270       if (extract_unsigned_integer (buf, wcwidth, byte_order) == 0)
2271         break;
2272     }
2273
2274   /* Copy the string contents into a string inside GDB.  */
2275   str = (gdb_byte *) alloca (j + wcwidth);
2276   if (j != 0)
2277     read_memory (tem, str, j);
2278   memset (&str[j], 0, wcwidth);
2279
2280   auto_obstack output;
2281
2282   convert_between_encodings (target_wide_charset (gdbarch),
2283                              host_charset (),
2284                              str, j, wcwidth,
2285                              &output, translit_char);
2286   obstack_grow_str0 (&output, "");
2287
2288   DIAGNOSTIC_PUSH
2289   DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL
2290   fprintf_filtered (stream, format, obstack_base (&output));
2291   DIAGNOSTIC_POP
2292 }
2293
2294 /* Subroutine of ui_printf to simplify it.
2295    Print VALUE, a floating point value, to STREAM using FORMAT.  */
2296
2297 static void
2298 printf_floating (struct ui_file *stream, const char *format,
2299                  struct value *value, enum argclass argclass)
2300 {
2301   /* Parameter data.  */
2302   struct type *param_type = value_type (value);
2303   struct gdbarch *gdbarch = get_type_arch (param_type);
2304
2305   /* Determine target type corresponding to the format string.  */
2306   struct type *fmt_type;
2307   switch (argclass)
2308     {
2309       case double_arg:
2310         fmt_type = builtin_type (gdbarch)->builtin_double;
2311         break;
2312       case long_double_arg:
2313         fmt_type = builtin_type (gdbarch)->builtin_long_double;
2314         break;
2315       case dec32float_arg:
2316         fmt_type = builtin_type (gdbarch)->builtin_decfloat;
2317         break;
2318       case dec64float_arg:
2319         fmt_type = builtin_type (gdbarch)->builtin_decdouble;
2320         break;
2321       case dec128float_arg:
2322         fmt_type = builtin_type (gdbarch)->builtin_declong;
2323         break;
2324       default:
2325         gdb_assert_not_reached ("unexpected argument class");
2326     }
2327
2328   /* To match the traditional GDB behavior, the conversion is
2329      done differently depending on the type of the parameter:
2330
2331      - if the parameter has floating-point type, it's value
2332        is converted to the target type;
2333
2334      - otherwise, if the parameter has a type that is of the
2335        same size as a built-in floating-point type, the value
2336        bytes are interpreted as if they were of that type, and
2337        then converted to the target type (this is not done for
2338        decimal floating-point argument classes);
2339
2340      - otherwise, if the source value has an integer value,
2341        it's value is converted to the target type;
2342
2343      - otherwise, an error is raised.
2344
2345      In either case, the result of the conversion is a byte buffer
2346      formatted in the target format for the target type.  */
2347
2348   if (TYPE_CODE (fmt_type) == TYPE_CODE_FLT)
2349     {
2350       param_type = float_type_from_length (param_type);
2351       if (param_type != value_type (value))
2352         value = value_from_contents (param_type, value_contents (value));
2353     }
2354
2355   value = value_cast (fmt_type, value);
2356
2357   /* Convert the value to a string and print it.  */
2358   std::string str
2359     = target_float_to_string (value_contents (value), fmt_type, format);
2360   fputs_filtered (str.c_str (), stream);
2361 }
2362
2363 /* Subroutine of ui_printf to simplify it.
2364    Print VALUE, a target pointer, to STREAM using FORMAT.  */
2365
2366 static void
2367 printf_pointer (struct ui_file *stream, const char *format,
2368                 struct value *value)
2369 {
2370   /* We avoid the host's %p because pointers are too
2371      likely to be the wrong size.  The only interesting
2372      modifier for %p is a width; extract that, and then
2373      handle %p as glibc would: %#x or a literal "(nil)".  */
2374
2375   const char *p;
2376   char *fmt, *fmt_p;
2377 #ifdef PRINTF_HAS_LONG_LONG
2378   long long val = value_as_long (value);
2379 #else
2380   long val = value_as_long (value);
2381 #endif
2382
2383   fmt = (char *) alloca (strlen (format) + 5);
2384
2385   /* Copy up to the leading %.  */
2386   p = format;
2387   fmt_p = fmt;
2388   while (*p)
2389     {
2390       int is_percent = (*p == '%');
2391
2392       *fmt_p++ = *p++;
2393       if (is_percent)
2394         {
2395           if (*p == '%')
2396             *fmt_p++ = *p++;
2397           else
2398             break;
2399         }
2400     }
2401
2402   if (val != 0)
2403     *fmt_p++ = '#';
2404
2405   /* Copy any width or flags.  Only the "-" flag is valid for pointers
2406      -- see the format_pieces constructor.  */
2407   while (*p == '-' || (*p >= '0' && *p < '9'))
2408     *fmt_p++ = *p++;
2409
2410   gdb_assert (*p == 'p' && *(p + 1) == '\0');
2411   if (val != 0)
2412     {
2413 #ifdef PRINTF_HAS_LONG_LONG
2414       *fmt_p++ = 'l';
2415 #endif
2416       *fmt_p++ = 'l';
2417       *fmt_p++ = 'x';
2418       *fmt_p++ = '\0';
2419       DIAGNOSTIC_PUSH
2420       DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL
2421       fprintf_filtered (stream, fmt, val);
2422       DIAGNOSTIC_POP
2423     }
2424   else
2425     {
2426       *fmt_p++ = 's';
2427       *fmt_p++ = '\0';
2428       DIAGNOSTIC_PUSH
2429       DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL
2430       fprintf_filtered (stream, fmt, "(nil)");
2431       DIAGNOSTIC_POP
2432     }
2433 }
2434
2435 /* printf "printf format string" ARG to STREAM.  */
2436
2437 static void
2438 ui_printf (const char *arg, struct ui_file *stream)
2439 {
2440   const char *s = arg;
2441   std::vector<struct value *> val_args;
2442
2443   if (s == 0)
2444     error_no_arg (_("format-control string and values to print"));
2445
2446   s = skip_spaces (s);
2447
2448   /* A format string should follow, enveloped in double quotes.  */
2449   if (*s++ != '"')
2450     error (_("Bad format string, missing '\"'."));
2451
2452   format_pieces fpieces (&s);
2453
2454   if (*s++ != '"')
2455     error (_("Bad format string, non-terminated '\"'."));
2456   
2457   s = skip_spaces (s);
2458
2459   if (*s != ',' && *s != 0)
2460     error (_("Invalid argument syntax"));
2461
2462   if (*s == ',')
2463     s++;
2464   s = skip_spaces (s);
2465
2466   {
2467     int nargs_wanted;
2468     int i;
2469     const char *current_substring;
2470
2471     nargs_wanted = 0;
2472     for (auto &&piece : fpieces)
2473       if (piece.argclass != literal_piece)
2474         ++nargs_wanted;
2475
2476     /* Now, parse all arguments and evaluate them.
2477        Store the VALUEs in VAL_ARGS.  */
2478
2479     while (*s != '\0')
2480       {
2481         const char *s1;
2482
2483         s1 = s;
2484         val_args.push_back (parse_to_comma_and_eval (&s1));
2485
2486         s = s1;
2487         if (*s == ',')
2488           s++;
2489       }
2490
2491     if (val_args.size () != nargs_wanted)
2492       error (_("Wrong number of arguments for specified format-string"));
2493
2494     /* Now actually print them.  */
2495     i = 0;
2496     for (auto &&piece : fpieces)
2497       {
2498         current_substring = piece.string;
2499         switch (piece.argclass)
2500           {
2501           case string_arg:
2502             printf_c_string (stream, current_substring, val_args[i]);
2503             break;
2504           case wide_string_arg:
2505             printf_wide_c_string (stream, current_substring, val_args[i]);
2506             break;
2507           case wide_char_arg:
2508             {
2509               struct gdbarch *gdbarch
2510                 = get_type_arch (value_type (val_args[i]));
2511               struct type *wctype = lookup_typename (current_language, gdbarch,
2512                                                      "wchar_t", NULL, 0);
2513               struct type *valtype;
2514               const gdb_byte *bytes;
2515
2516               valtype = value_type (val_args[i]);
2517               if (TYPE_LENGTH (valtype) != TYPE_LENGTH (wctype)
2518                   || TYPE_CODE (valtype) != TYPE_CODE_INT)
2519                 error (_("expected wchar_t argument for %%lc"));
2520
2521               bytes = value_contents (val_args[i]);
2522
2523               auto_obstack output;
2524
2525               convert_between_encodings (target_wide_charset (gdbarch),
2526                                          host_charset (),
2527                                          bytes, TYPE_LENGTH (valtype),
2528                                          TYPE_LENGTH (valtype),
2529                                          &output, translit_char);
2530               obstack_grow_str0 (&output, "");
2531
2532               DIAGNOSTIC_PUSH
2533               DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL
2534               fprintf_filtered (stream, current_substring,
2535                                 obstack_base (&output));
2536               DIAGNOSTIC_POP
2537             }
2538             break;
2539           case long_long_arg:
2540 #ifdef PRINTF_HAS_LONG_LONG
2541             {
2542               long long val = value_as_long (val_args[i]);
2543
2544               DIAGNOSTIC_PUSH
2545               DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL
2546               fprintf_filtered (stream, current_substring, val);
2547               DIAGNOSTIC_POP
2548               break;
2549             }
2550 #else
2551             error (_("long long not supported in printf"));
2552 #endif
2553           case int_arg:
2554             {
2555               int val = value_as_long (val_args[i]);
2556
2557               DIAGNOSTIC_PUSH
2558               DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL
2559               fprintf_filtered (stream, current_substring, val);
2560               DIAGNOSTIC_POP
2561               break;
2562             }
2563           case long_arg:
2564             {
2565               long val = value_as_long (val_args[i]);
2566
2567               DIAGNOSTIC_PUSH
2568               DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL
2569               fprintf_filtered (stream, current_substring, val);
2570               DIAGNOSTIC_POP
2571               break;
2572             }
2573           /* Handles floating-point values.  */
2574           case double_arg:
2575           case long_double_arg:
2576           case dec32float_arg:
2577           case dec64float_arg:
2578           case dec128float_arg:
2579             printf_floating (stream, current_substring, val_args[i],
2580                              piece.argclass);
2581             break;
2582           case ptr_arg:
2583             printf_pointer (stream, current_substring, val_args[i]);
2584             break;
2585           case literal_piece:
2586             /* Print a portion of the format string that has no
2587                directives.  Note that this will not include any
2588                ordinary %-specs, but it might include "%%".  That is
2589                why we use printf_filtered and not puts_filtered here.
2590                Also, we pass a dummy argument because some platforms
2591                have modified GCC to include -Wformat-security by
2592                default, which will warn here if there is no
2593                argument.  */
2594             DIAGNOSTIC_PUSH
2595             DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL
2596             fprintf_filtered (stream, current_substring, 0);
2597             DIAGNOSTIC_POP
2598             break;
2599           default:
2600             internal_error (__FILE__, __LINE__,
2601                             _("failed internal consistency check"));
2602           }
2603         /* Maybe advance to the next argument.  */
2604         if (piece.argclass != literal_piece)
2605           ++i;
2606       }
2607   }
2608 }
2609
2610 /* Implement the "printf" command.  */
2611
2612 static void
2613 printf_command (const char *arg, int from_tty)
2614 {
2615   ui_printf (arg, gdb_stdout);
2616   reset_terminal_style (gdb_stdout);
2617   wrap_here ("");
2618   gdb_flush (gdb_stdout);
2619 }
2620
2621 /* Implement the "eval" command.  */
2622
2623 static void
2624 eval_command (const char *arg, int from_tty)
2625 {
2626   string_file stb;
2627
2628   ui_printf (arg, &stb);
2629
2630   std::string expanded = insert_user_defined_cmd_args (stb.c_str ());
2631
2632   execute_command (expanded.c_str (), from_tty);
2633 }
2634
2635 void
2636 _initialize_printcmd (void)
2637 {
2638   struct cmd_list_element *c;
2639
2640   current_display_number = -1;
2641
2642   gdb::observers::free_objfile.attach (clear_dangling_display_expressions);
2643
2644   add_info ("address", info_address_command,
2645             _("Describe where symbol SYM is stored."));
2646
2647   add_info ("symbol", info_symbol_command, _("\
2648 Describe what symbol is at location ADDR.\n\
2649 Only for symbols with fixed locations (global or static scope)."));
2650
2651   add_com ("x", class_vars, x_command, _("\
2652 Examine memory: x/FMT ADDRESS.\n\
2653 ADDRESS is an expression for the memory address to examine.\n\
2654 FMT is a repeat count followed by a format letter and a size letter.\n\
2655 Format letters are o(octal), x(hex), d(decimal), u(unsigned decimal),\n\
2656   t(binary), f(float), a(address), i(instruction), c(char), s(string)\n\
2657   and z(hex, zero padded on the left).\n\
2658 Size letters are b(byte), h(halfword), w(word), g(giant, 8 bytes).\n\
2659 The specified number of objects of the specified size are printed\n\
2660 according to the format.  If a negative number is specified, memory is\n\
2661 examined backward from the address.\n\n\
2662 Defaults for format and size letters are those previously used.\n\
2663 Default count is 1.  Default address is following last thing printed\n\
2664 with this command or \"print\"."));
2665
2666 #if 0
2667   add_com ("whereis", class_vars, whereis_command,
2668            _("Print line number and file of definition of variable."));
2669 #endif
2670
2671   add_info ("display", info_display_command, _("\
2672 Expressions to display when program stops, with code numbers."));
2673
2674   add_cmd ("undisplay", class_vars, undisplay_command, _("\
2675 Cancel some expressions to be displayed when program stops.\n\
2676 Arguments are the code numbers of the expressions to stop displaying.\n\
2677 No argument means cancel all automatic-display expressions.\n\
2678 \"delete display\" has the same effect as this command.\n\
2679 Do \"info display\" to see current list of code numbers."),
2680            &cmdlist);
2681
2682   add_com ("display", class_vars, display_command, _("\
2683 Print value of expression EXP each time the program stops.\n\
2684 /FMT may be used before EXP as in the \"print\" command.\n\
2685 /FMT \"i\" or \"s\" or including a size-letter is allowed,\n\
2686 as in the \"x\" command, and then EXP is used to get the address to examine\n\
2687 and examining is done as in the \"x\" command.\n\n\
2688 With no argument, display all currently requested auto-display expressions.\n\
2689 Use \"undisplay\" to cancel display requests previously made."));
2690
2691   add_cmd ("display", class_vars, enable_display_command, _("\
2692 Enable some expressions to be displayed when program stops.\n\
2693 Arguments are the code numbers of the expressions to resume displaying.\n\
2694 No argument means enable all automatic-display expressions.\n\
2695 Do \"info display\" to see current list of code numbers."), &enablelist);
2696
2697   add_cmd ("display", class_vars, disable_display_command, _("\
2698 Disable some expressions to be displayed when program stops.\n\
2699 Arguments are the code numbers of the expressions to stop displaying.\n\
2700 No argument means disable all automatic-display expressions.\n\
2701 Do \"info display\" to see current list of code numbers."), &disablelist);
2702
2703   add_cmd ("display", class_vars, undisplay_command, _("\
2704 Cancel some expressions to be displayed when program stops.\n\
2705 Arguments are the code numbers of the expressions to stop displaying.\n\
2706 No argument means cancel all automatic-display expressions.\n\
2707 Do \"info display\" to see current list of code numbers."), &deletelist);
2708
2709   add_com ("printf", class_vars, printf_command, _("\
2710 Formatted printing, like the C \"printf\" function.\n\
2711 Usage: printf \"format string\", arg1, arg2, arg3, ..., argn\n\
2712 This supports most C printf format specifications, like %s, %d, etc."));
2713
2714   add_com ("output", class_vars, output_command, _("\
2715 Like \"print\" but don't put in value history and don't print newline.\n\
2716 This is useful in user-defined commands."));
2717
2718   add_prefix_cmd ("set", class_vars, set_command, _("\
2719 Evaluate expression EXP and assign result to variable VAR, using assignment\n\
2720 syntax appropriate for the current language (VAR = EXP or VAR := EXP for\n\
2721 example).  VAR may be a debugger \"convenience\" variable (names starting\n\
2722 with $), a register (a few standard names starting with $), or an actual\n\
2723 variable in the program being debugged.  EXP is any valid expression.\n\
2724 Use \"set variable\" for variables with names identical to set subcommands.\n\
2725 \n\
2726 With a subcommand, this command modifies parts of the gdb environment.\n\
2727 You can see these environment settings with the \"show\" command."),
2728                   &setlist, "set ", 1, &cmdlist);
2729   if (dbx_commands)
2730     add_com ("assign", class_vars, set_command, _("\
2731 Evaluate expression EXP and assign result to variable VAR, using assignment\n\
2732 syntax appropriate for the current language (VAR = EXP or VAR := EXP for\n\
2733 example).  VAR may be a debugger \"convenience\" variable (names starting\n\
2734 with $), a register (a few standard names starting with $), or an actual\n\
2735 variable in the program being debugged.  EXP is any valid expression.\n\
2736 Use \"set variable\" for variables with names identical to set subcommands.\n\
2737 \nWith a subcommand, this command modifies parts of the gdb environment.\n\
2738 You can see these environment settings with the \"show\" command."));
2739
2740   /* "call" is the same as "set", but handy for dbx users to call fns.  */
2741   c = add_com ("call", class_vars, call_command, _("\
2742 Call a function in the program.\n\
2743 The argument is the function name and arguments, in the notation of the\n\
2744 current working language.  The result is printed and saved in the value\n\
2745 history, if it is not void."));
2746   set_cmd_completer (c, expression_completer);
2747
2748   add_cmd ("variable", class_vars, set_command, _("\
2749 Evaluate expression EXP and assign result to variable VAR, using assignment\n\
2750 syntax appropriate for the current language (VAR = EXP or VAR := EXP for\n\
2751 example).  VAR may be a debugger \"convenience\" variable (names starting\n\
2752 with $), a register (a few standard names starting with $), or an actual\n\
2753 variable in the program being debugged.  EXP is any valid expression.\n\
2754 This may usually be abbreviated to simply \"set\"."),
2755            &setlist);
2756   add_alias_cmd ("var", "variable", class_vars, 0, &setlist);
2757
2758   c = add_com ("print", class_vars, print_command, _("\
2759 Print value of expression EXP.\n\
2760 Variables accessible are those of the lexical environment of the selected\n\
2761 stack frame, plus all those whose scope is global or an entire file.\n\
2762 \n\
2763 $NUM gets previous value number NUM.  $ and $$ are the last two values.\n\
2764 $$NUM refers to NUM'th value back from the last one.\n\
2765 Names starting with $ refer to registers (with the values they would have\n\
2766 if the program were to return to the stack frame now selected, restoring\n\
2767 all registers saved by frames farther in) or else to debugger\n\
2768 \"convenience\" variables (any such name not a known register).\n\
2769 Use assignment expressions to give values to convenience variables.\n\
2770 \n\
2771 {TYPE}ADREXP refers to a datum of data type TYPE, located at address ADREXP.\n\
2772 @ is a binary operator for treating consecutive data objects\n\
2773 anywhere in memory as an array.  FOO@NUM gives an array whose first\n\
2774 element is FOO, whose second element is stored in the space following\n\
2775 where FOO is stored, etc.  FOO must be an expression whose value\n\
2776 resides in memory.\n\
2777 \n\
2778 EXP may be preceded with /FMT, where FMT is a format letter\n\
2779 but no count or size letter (see \"x\" command)."));
2780   set_cmd_completer (c, expression_completer);
2781   add_com_alias ("p", "print", class_vars, 1);
2782   add_com_alias ("inspect", "print", class_vars, 1);
2783
2784   add_setshow_uinteger_cmd ("max-symbolic-offset", no_class,
2785                             &max_symbolic_offset, _("\
2786 Set the largest offset that will be printed in <symbol+1234> form."), _("\
2787 Show the largest offset that will be printed in <symbol+1234> form."), _("\
2788 Tell GDB to only display the symbolic form of an address if the\n\
2789 offset between the closest earlier symbol and the address is less than\n\
2790 the specified maximum offset.  The default is \"unlimited\", which tells GDB\n\
2791 to always print the symbolic form of an address if any symbol precedes\n\
2792 it.  Zero is equivalent to \"unlimited\"."),
2793                             NULL,
2794                             show_max_symbolic_offset,
2795                             &setprintlist, &showprintlist);
2796   add_setshow_boolean_cmd ("symbol-filename", no_class,
2797                            &print_symbol_filename, _("\
2798 Set printing of source filename and line number with <symbol>."), _("\
2799 Show printing of source filename and line number with <symbol>."), NULL,
2800                            NULL,
2801                            show_print_symbol_filename,
2802                            &setprintlist, &showprintlist);
2803
2804   add_com ("eval", no_class, eval_command, _("\
2805 Convert \"printf format string\", arg1, arg2, arg3, ..., argn to\n\
2806 a command line, and call it."));
2807 }