gdb/mi/mi-cmd-var.c

   1 /* MI Command Set - varobj commands.
   2    Copyright (C) 2000-2023 Free Software Foundation, Inc.
   3
   4    Contributed by Cygnus Solutions (a Red Hat company).
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #include "defs.h"
  22 #include "mi-cmds.h"
  23 #include "mi-main.h"
  24 #include "ui-out.h"
  25 #include "mi-out.h"
  26 #include "varobj.h"
  27 #include "language.h"
  28 #include "value.h"
  29 #include <ctype.h>
  30 #include "mi-getopt.h"
  31 #include "gdbthread.h"
  32 #include "mi-parse.h"
  33 #include "gdbsupport/gdb_optional.h"
  34 #include "inferior.h"
  35
  36 static void varobj_update_one (struct varobj *var,
  37                                enum print_values print_values,
  38                                bool is_explicit);
  39
  40 static int mi_print_value_p (struct varobj *var,
  41                              enum print_values print_values);
  42
  43 /* Print variable object VAR.  The PRINT_VALUES parameter controls
  44    if the value should be printed.  The PRINT_EXPRESSION parameter
  45    controls if the expression should be printed.  */
  46
  47 static void
  48 print_varobj (struct varobj *var, enum print_values print_values,
  49               int print_expression)
  50 {
  51   struct ui_out *uiout = current_uiout;
  52   int thread_id;
  53
  54   uiout->field_string ("name", varobj_get_objname (var));
  55   if (print_expression)
  56     {
  57       std::string exp = varobj_get_expression (var);
  58
  59       uiout->field_string ("exp", exp);
  60     }
  61   uiout->field_signed ("numchild", varobj_get_num_children (var));
  62
  63   if (mi_print_value_p (var, print_values))
  64     {
  65       std::string val = varobj_get_value (var);
  66
  67       uiout->field_string ("value", val);
  68     }
  69
  70   std::string type = varobj_get_type (var);
  71   if (!type.empty ())
  72     uiout->field_string ("type", type);
  73
  74   thread_id = varobj_get_thread_id (var);
  75   if (thread_id > 0)
  76     uiout->field_signed ("thread-id", thread_id);
  77
  78   if (varobj_get_frozen (var))
  79     uiout->field_signed ("frozen", 1);
  80
  81   gdb::unique_xmalloc_ptr<char> display_hint = varobj_get_display_hint (var);
  82   if (display_hint)
  83     uiout->field_string ("displayhint", display_hint.get ());
  84
  85   if (varobj_is_dynamic_p (var))
  86     uiout->field_signed ("dynamic", 1);
  87 }
  88
  89 /* VAROBJ operations */
  90
  91 void
  92 mi_cmd_var_create (const char *command, char **argv, int argc)
  93 {
  94   struct ui_out *uiout = current_uiout;
  95   CORE_ADDR frameaddr = 0;
  96   struct varobj *var;
  97   char *frame;
  98   char *expr;
  99   enum varobj_type var_type;
 100
 101   if (argc != 3)
 102     error (_("-var-create: Usage: NAME FRAME EXPRESSION."));
 103
 104   frame = argv[1];
 105   expr = argv[2];
 106
 107   const char *name = argv[0];
 108   std::string gen_name;
 109   if (strcmp (name, "-") == 0)
 110     {
 111       gen_name = varobj_gen_name ();
 112       name = gen_name.c_str ();
 113     }
 114   else if (!isalpha (name[0]))
 115     error (_("-var-create: name of object must begin with a letter"));
 116
 117   if (strcmp (frame, "*") == 0)
 118     var_type = USE_CURRENT_FRAME;
 119   else if (strcmp (frame, "@") == 0)
 120     var_type = USE_SELECTED_FRAME;
 121   else
 122     {
 123       var_type = USE_SPECIFIED_FRAME;
 124       frameaddr = string_to_core_addr (frame);
 125     }
 126
 127   if (varobjdebug)
 128     gdb_printf (gdb_stdlog,
 129                 "Name=\"%s\", Frame=\"%s\" (%s), Expression=\"%s\"\n",
 130                 name, frame, hex_string (frameaddr), expr);
 131
 132   var = varobj_create (name, expr, frameaddr, var_type);
 133
 134   if (var == NULL)
 135     error (_("-var-create: unable to create variable object"));
 136
 137   print_varobj (var, PRINT_ALL_VALUES, 0 /* don't print expression */);
 138
 139   uiout->field_signed ("has_more", varobj_has_more (var, 0));
 140 }
 141
 142 void
 143 mi_cmd_var_delete (const char *command, char **argv, int argc)
 144 {
 145   char *name;
 146   struct varobj *var;
 147   int numdel;
 148   int children_only_p = 0;
 149   struct ui_out *uiout = current_uiout;
 150
 151   if (argc < 1 || argc > 2)
 152     error (_("-var-delete: Usage: [-c] EXPRESSION."));
 153
 154   name = argv[0];
 155
 156   /* If we have one single argument it cannot be '-c' or any string
 157      starting with '-'.  */
 158   if (argc == 1)
 159     {
 160       if (strcmp (name, "-c") == 0)
 161         error (_("-var-delete: Missing required "
 162                  "argument after '-c': variable object name"));
 163       if (*name == '-')
 164         error (_("-var-delete: Illegal variable object name"));
 165     }
 166
 167   /* If we have 2 arguments they must be '-c' followed by a string
 168      which would be the variable name.  */
 169   if (argc == 2)
 170     {
 171       if (strcmp (name, "-c") != 0)
 172         error (_("-var-delete: Invalid option."));
 173       children_only_p = 1;
 174       name = argv[1];
 175     }
 176
 177   /* If we didn't error out, now NAME contains the name of the
 178      variable.  */
 179
 180   var = varobj_get_handle (name);
 181
 182   numdel = varobj_delete (var, children_only_p);
 183
 184   uiout->field_signed ("ndeleted", numdel);
 185 }
 186
 187 /* Parse a string argument into a format value.  */
 188
 189 static enum varobj_display_formats
 190 mi_parse_format (const char *arg)
 191 {
 192   if (arg != NULL)
 193     {
 194       int len;
 195
 196       len = strlen (arg);
 197
 198       if (strncmp (arg, "natural", len) == 0)
 199         return FORMAT_NATURAL;
 200       else if (strncmp (arg, "binary", len) == 0)
 201         return FORMAT_BINARY;
 202       else if (strncmp (arg, "decimal", len) == 0)
 203         return FORMAT_DECIMAL;
 204       else if (strncmp (arg, "hexadecimal", len) == 0)
 205         return FORMAT_HEXADECIMAL;
 206       else if (strncmp (arg, "octal", len) == 0)
 207         return FORMAT_OCTAL;
 208       else if (strncmp (arg, "zero-hexadecimal", len) == 0)
 209         return FORMAT_ZHEXADECIMAL;
 210     }
 211
 212   error (_("Must specify the format as: \"natural\", "
 213            "\"binary\", \"decimal\", \"hexadecimal\", \"octal\" or \"zero-hexadecimal\""));
 214 }
 215
 216 void
 217 mi_cmd_var_set_format (const char *command, char **argv, int argc)
 218 {
 219   enum varobj_display_formats format;
 220   struct varobj *var;
 221   struct ui_out *uiout = current_uiout;
 222
 223   if (argc != 2)
 224     error (_("-var-set-format: Usage: NAME FORMAT."));
 225
 226   /* Get varobj handle, if a valid var obj name was specified.  */
 227   var = varobj_get_handle (argv[0]);
 228
 229   format = mi_parse_format (argv[1]);
 230
 231   /* Set the format of VAR to the given format.  */
 232   varobj_set_display_format (var, format);
 233
 234   /* Report the new current format.  */
 235   uiout->field_string ("format", varobj_format_string[(int) format]);
 236
 237   /* Report the value in the new format.  */
 238   std::string val = varobj_get_value (var);
 239   uiout->field_string ("value", val);
 240 }
 241
 242 void
 243 mi_cmd_var_set_visualizer (const char *command, char **argv, int argc)
 244 {
 245   struct varobj *var;
 246
 247   if (argc != 2)
 248     error (_("Usage: NAME VISUALIZER_FUNCTION."));
 249
 250   var = varobj_get_handle (argv[0]);
 251
 252   if (var == NULL)
 253     error (_("Variable object not found"));
 254
 255   varobj_set_visualizer (var, argv[1]);
 256 }
 257
 258 void
 259 mi_cmd_var_set_frozen (const char *command, char **argv, int argc)
 260 {
 261   struct varobj *var;
 262   bool frozen;
 263
 264   if (argc != 2)
 265     error (_("-var-set-format: Usage: NAME FROZEN_FLAG."));
 266
 267   var = varobj_get_handle (argv[0]);
 268
 269   if (strcmp (argv[1], "0") == 0)
 270     frozen = false;
 271   else if (strcmp (argv[1], "1") == 0)
 272     frozen = true;
 273   else
 274     error (_("Invalid flag value"));
 275
 276   varobj_set_frozen (var, frozen);
 277
 278   /* We don't automatically return the new value, or what varobjs got
 279      new values during unfreezing.  If this information is required,
 280      client should call -var-update explicitly.  */
 281 }
 282
 283 void
 284 mi_cmd_var_show_format (const char *command, char **argv, int argc)
 285 {
 286   struct ui_out *uiout = current_uiout;
 287   enum varobj_display_formats format;
 288   struct varobj *var;
 289
 290   if (argc != 1)
 291     error (_("-var-show-format: Usage: NAME."));
 292
 293   /* Get varobj handle, if a valid var obj name was specified.  */
 294   var = varobj_get_handle (argv[0]);
 295
 296   format = varobj_get_display_format (var);
 297
 298   /* Report the current format.  */
 299   uiout->field_string ("format", varobj_format_string[(int) format]);
 300 }
 301
 302 void
 303 mi_cmd_var_info_num_children (const char *command, char **argv, int argc)
 304 {
 305   struct ui_out *uiout = current_uiout;
 306   struct varobj *var;
 307
 308   if (argc != 1)
 309     error (_("-var-info-num-children: Usage: NAME."));
 310
 311   /* Get varobj handle, if a valid var obj name was specified.  */
 312   var = varobj_get_handle (argv[0]);
 313
 314   uiout->field_signed ("numchild", varobj_get_num_children (var));
 315 }
 316
 317 /* Return 1 if given the argument PRINT_VALUES we should display
 318    the varobj VAR.  */
 319
 320 static int
 321 mi_print_value_p (struct varobj *var, enum print_values print_values)
 322 {
 323   struct type *type;
 324
 325   if (print_values == PRINT_NO_VALUES)
 326     return 0;
 327
 328   if (print_values == PRINT_ALL_VALUES)
 329     return 1;
 330
 331   if (varobj_is_dynamic_p (var))
 332     return 1;
 333
 334   type = varobj_get_gdb_type (var);
 335   if (type == NULL)
 336     return 1;
 337   else
 338     {
 339       type = check_typedef (type);
 340
 341       /* For PRINT_SIMPLE_VALUES, only print the value if it has a type
 342          and that type is not a compound type.  */
 343       return (type->code () != TYPE_CODE_ARRAY
 344               && type->code () != TYPE_CODE_STRUCT
 345               && type->code () != TYPE_CODE_UNION);
 346     }
 347 }
 348
 349 void
 350 mi_cmd_var_list_children (const char *command, char **argv, int argc)
 351 {
 352   struct ui_out *uiout = current_uiout;
 353   struct varobj *var;
 354   enum print_values print_values;
 355   int from, to;
 356
 357   if (argc < 1 || argc > 4)
 358     error (_("-var-list-children: Usage: "
 359              "[PRINT_VALUES] NAME [FROM TO]"));
 360
 361   /* Get varobj handle, if a valid var obj name was specified.  */
 362   if (argc == 1 || argc == 3)
 363     var = varobj_get_handle (argv[0]);
 364   else
 365     var = varobj_get_handle (argv[1]);
 366
 367   if (argc > 2)
 368     {
 369       from = atoi (argv[argc - 2]);
 370       to = atoi (argv[argc - 1]);
 371     }
 372   else
 373     {
 374       from = -1;
 375       to = -1;
 376     }
 377
 378   const std::vector<varobj *> &children
 379     = varobj_list_children (var, &from, &to);
 380
 381   uiout->field_signed ("numchild", to - from);
 382   if (argc == 2 || argc == 4)
 383     print_values = mi_parse_print_values (argv[0]);
 384   else
 385     print_values = PRINT_NO_VALUES;
 386
 387   gdb::unique_xmalloc_ptr<char> display_hint = varobj_get_display_hint (var);
 388   if (display_hint)
 389     uiout->field_string ("displayhint", display_hint.get ());
 390
 391   if (from < to)
 392     {
 393       ui_out_emit_list list_emitter (uiout, "children");
 394       for (int ix = from; ix < to && ix < children.size (); ix++)
 395         {
 396           ui_out_emit_tuple child_emitter (uiout, "child");
 397
 398           print_varobj (children[ix], print_values, 1 /* print expression */);
 399         }
 400     }
 401
 402   uiout->field_signed ("has_more", varobj_has_more (var, to));
 403 }
 404
 405 void
 406 mi_cmd_var_info_type (const char *command, char **argv, int argc)
 407 {
 408   struct ui_out *uiout = current_uiout;
 409   struct varobj *var;
 410
 411   if (argc != 1)
 412     error (_("-var-info-type: Usage: NAME."));
 413
 414   /* Get varobj handle, if a valid var obj name was specified.  */
 415   var = varobj_get_handle (argv[0]);
 416
 417   std::string type_name = varobj_get_type (var);
 418   uiout->field_string ("type", type_name);
 419 }
 420
 421 void
 422 mi_cmd_var_info_path_expression (const char *command, char **argv, int argc)
 423 {
 424   struct ui_out *uiout = current_uiout;
 425   struct varobj *var;
 426
 427   if (argc != 1)
 428     error (_("Usage: NAME."));
 429
 430   /* Get varobj handle, if a valid var obj name was specified.  */
 431   var = varobj_get_handle (argv[0]);
 432
 433   const char *path_expr = varobj_get_path_expr (var);
 434
 435   uiout->field_string ("path_expr", path_expr);
 436 }
 437
 438 void
 439 mi_cmd_var_info_expression (const char *command, char **argv, int argc)
 440 {
 441   struct ui_out *uiout = current_uiout;
 442   const struct language_defn *lang;
 443   struct varobj *var;
 444
 445   if (argc != 1)
 446     error (_("-var-info-expression: Usage: NAME."));
 447
 448   /* Get varobj handle, if a valid var obj name was specified.  */
 449   var = varobj_get_handle (argv[0]);
 450
 451   lang = varobj_get_language (var);
 452
 453   uiout->field_string ("lang", lang->natural_name ());
 454
 455   std::string exp = varobj_get_expression (var);
 456   uiout->field_string ("exp", exp);
 457 }
 458
 459 void
 460 mi_cmd_var_show_attributes (const char *command, char **argv, int argc)
 461 {
 462   struct ui_out *uiout = current_uiout;
 463   int attr;
 464   const char *attstr;
 465   struct varobj *var;
 466
 467   if (argc != 1)
 468     error (_("-var-show-attributes: Usage: NAME."));
 469
 470   /* Get varobj handle, if a valid var obj name was specified */
 471   var = varobj_get_handle (argv[0]);
 472
 473   attr = varobj_get_attributes (var);
 474   /* FIXME: define masks for attributes */
 475   if (attr & 0x00000001)
 476     attstr = "editable";
 477   else
 478     attstr = "noneditable";
 479
 480   uiout->field_string ("attr", attstr);
 481 }
 482
 483 void
 484 mi_cmd_var_evaluate_expression (const char *command, char **argv, int argc)
 485 {
 486   struct ui_out *uiout = current_uiout;
 487   struct varobj *var;
 488
 489   enum varobj_display_formats format;
 490   int formatFound;
 491   int oind;
 492   char *oarg;
 493
 494   enum opt
 495   {
 496     OP_FORMAT
 497   };
 498   static const struct mi_opt opts[] =
 499     {
 500       {"f", OP_FORMAT, 1},
 501       { 0, 0, 0 }
 502     };
 503
 504   /* Parse arguments.  */
 505   format = FORMAT_NATURAL;
 506   formatFound = 0;
 507   oind = 0;
 508   while (1)
 509     {
 510       int opt = mi_getopt ("-var-evaluate-expression", argc, argv,
 511                            opts, &oind, &oarg);
 512
 513       if (opt < 0)
 514         break;
 515       switch ((enum opt) opt)
 516         {
 517         case OP_FORMAT:
 518           if (formatFound)
 519             error (_("Cannot specify format more than once"));
 520
 521           format = mi_parse_format (oarg);
 522           formatFound = 1;
 523           break;
 524         }
 525     }
 526
 527   if (oind >= argc)
 528     error (_("Usage: [-f FORMAT] NAME"));
 529
 530   if (oind < argc - 1)
 531     error (_("Garbage at end of command"));
 532
 533   /* Get varobj handle, if a valid var obj name was specified.  */
 534   var = varobj_get_handle (argv[oind]);
 535
 536   if (formatFound)
 537     {
 538       std::string val = varobj_get_formatted_value (var, format);
 539
 540       uiout->field_string ("value", val);
 541     }
 542   else
 543     {
 544       std::string val = varobj_get_value (var);
 545
 546       uiout->field_string ("value", val);
 547     }
 548 }
 549
 550 void
 551 mi_cmd_var_assign (const char *command, char **argv, int argc)
 552 {
 553   struct ui_out *uiout = current_uiout;
 554   struct varobj *var;
 555
 556   if (argc != 2)
 557     error (_("-var-assign: Usage: NAME EXPRESSION."));
 558
 559   /* Get varobj handle, if a valid var obj name was specified.  */
 560   var = varobj_get_handle (argv[0]);
 561
 562   if (!varobj_editable_p (var))
 563     error (_("-var-assign: Variable object is not editable"));
 564
 565   const char *expression = argv[1];
 566
 567   /* MI command '-var-assign' may write memory, so suppress memory
 568      changed notification if it does.  */
 569   scoped_restore save_suppress
 570     = make_scoped_restore (&mi_suppress_notification.memory, 1);
 571
 572   if (!varobj_set_value (var, expression))
 573     error (_("-var-assign: Could not assign "
 574              "expression to variable object"));
 575
 576   std::string val = varobj_get_value (var);
 577   uiout->field_string ("value", val);
 578 }
 579
 580 /* Helper for mi_cmd_var_update - update each VAR.  */
 581
 582 static void
 583 mi_cmd_var_update_iter (struct varobj *var, bool only_floating,
 584                         enum print_values print_values)
 585 {
 586   bool thread_stopped;
 587
 588   int thread_id = varobj_get_thread_id (var);
 589
 590   if (thread_id == -1)
 591     {
 592       thread_stopped = (inferior_ptid == null_ptid
 593                         || inferior_thread ()->state == THREAD_STOPPED);
 594     }
 595   else
 596     {
 597       thread_info *tp = find_thread_global_id (thread_id);
 598
 599       thread_stopped = (tp == NULL
 600                         || tp->state == THREAD_STOPPED);
 601     }
 602
 603   if (thread_stopped
 604       && (!only_floating || varobj_floating_p (var)))
 605     varobj_update_one (var, print_values, false /* implicit */);
 606 }
 607
 608 void
 609 mi_cmd_var_update (const char *command, char **argv, int argc)
 610 {
 611   struct ui_out *uiout = current_uiout;
 612   char *name;
 613   enum print_values print_values;
 614
 615   if (argc != 1 && argc != 2)
 616     error (_("-var-update: Usage: [PRINT_VALUES] NAME."));
 617
 618   if (argc == 1)
 619     name = argv[0];
 620   else
 621     name = argv[1];
 622
 623   if (argc == 2)
 624     print_values = mi_parse_print_values (argv[0]);
 625   else
 626     print_values = PRINT_NO_VALUES;
 627
 628   ui_out_emit_list list_emitter (uiout, "changelist");
 629
 630   /* Check if the parameter is a "*", which means that we want to
 631      update all variables.  */
 632
 633   if ((*name == '*' || *name == '@') && (*(name + 1) == '\0'))
 634     {
 635       /* varobj_update_one automatically updates all the children of
 636          VAROBJ.  Therefore update each VAROBJ only once by iterating
 637          only the root VAROBJs.  */
 638
 639       all_root_varobjs ([=] (varobj *var)
 640         {
 641           mi_cmd_var_update_iter (var, *name == '0', print_values);
 642         });
 643     }
 644   else
 645     {
 646       /* Get varobj handle, if a valid var obj name was specified.  */
 647       struct varobj *var = varobj_get_handle (name);
 648
 649       varobj_update_one (var, print_values, true /* explicit */);
 650     }
 651 }
 652
 653 /* Helper for mi_cmd_var_update().  */
 654
 655 static void
 656 varobj_update_one (struct varobj *var, enum print_values print_values,
 657                    bool is_explicit)
 658 {
 659   struct ui_out *uiout = current_uiout;
 660
 661   std::vector<varobj_update_result> changes = varobj_update (&var, is_explicit);
 662
 663   for (const varobj_update_result &r : changes)
 664     {
 665       int from, to;
 666
 667       ui_out_emit_tuple tuple_emitter (uiout, nullptr);
 668       uiout->field_string ("name", varobj_get_objname (r.varobj));
 669
 670       switch (r.status)
 671         {
 672         case VAROBJ_IN_SCOPE:
 673           if (mi_print_value_p (r.varobj, print_values))
 674             {
 675               std::string val = varobj_get_value (r.varobj);
 676
 677               uiout->field_string ("value", val);
 678             }
 679           uiout->field_string ("in_scope", "true");
 680           break;
 681         case VAROBJ_NOT_IN_SCOPE:
 682           uiout->field_string ("in_scope", "false");
 683           break;
 684         case VAROBJ_INVALID:
 685           uiout->field_string ("in_scope", "invalid");
 686           break;
 687         }
 688
 689       if (r.status != VAROBJ_INVALID)
 690         {
 691           if (r.type_changed)
 692             uiout->field_string ("type_changed", "true");
 693           else
 694             uiout->field_string ("type_changed", "false");
 695         }
 696
 697       if (r.type_changed)
 698         {
 699           std::string type_name = varobj_get_type (r.varobj);
 700
 701           uiout->field_string ("new_type", type_name);
 702         }
 703
 704       if (r.type_changed || r.children_changed)
 705         uiout->field_signed ("new_num_children",
 706                              varobj_get_num_children (r.varobj));
 707
 708       gdb::unique_xmalloc_ptr<char> display_hint
 709         = varobj_get_display_hint (r.varobj);
 710       if (display_hint)
 711         uiout->field_string ("displayhint", display_hint.get ());
 712
 713       if (varobj_is_dynamic_p (r.varobj))
 714         uiout->field_signed ("dynamic", 1);
 715
 716       varobj_get_child_range (r.varobj, &from, &to);
 717       uiout->field_signed ("has_more", varobj_has_more (r.varobj, to));
 718
 719       if (!r.newobj.empty ())
 720         {
 721           ui_out_emit_list list_emitter (uiout, "new_children");
 722
 723           for (varobj *child : r.newobj)
 724             {
 725               ui_out_emit_tuple inner_tuple_emitter (uiout, NULL);
 726               print_varobj (child, print_values, 1 /* print_expression */);
 727             }
 728         }
 729     }
 730 }
 731
 732 void
 733 mi_cmd_enable_pretty_printing (const char *command, char **argv, int argc)
 734 {
 735   if (argc != 0)
 736     error (_("-enable-pretty-printing: no arguments allowed"));
 737
 738   varobj_enable_pretty_printing ();
 739 }
 740
 741 void
 742 mi_cmd_var_set_update_range (const char *command, char **argv, int argc)
 743 {
 744   struct varobj *var;
 745   int from, to;
 746
 747   if (argc != 3)
 748     error (_("-var-set-update-range: Usage: VAROBJ FROM TO"));
 749
 750   var = varobj_get_handle (argv[0]);
 751   from = atoi (argv[1]);
 752   to = atoi (argv[2]);
 753
 754   varobj_set_child_range (var, from, to);
 755 }