gdb/mi/mi-cmds.c

   1 /* MI Command Set for GDB, the GNU debugger.
   2    Copyright (C) 2000-2019 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 "top.h"
  23 #include "mi-cmds.h"
  24 #include "mi-main.h"
  25
  26 struct mi_cmd;
  27 static struct mi_cmd **lookup_table (const char *command);
  28 static void build_table (struct mi_cmd *commands);
  29
  30 static struct mi_cmd mi_cmds[] =
  31 {
  32 /* Define a MI command of NAME, and its corresponding CLI command is
  33    CLI_NAME.  */
  34 #define DEF_MI_CMD_CLI_1(NAME, CLI_NAME, ARGS_P, CALLED)        \
  35   { NAME, { CLI_NAME, ARGS_P}, NULL, CALLED }
  36 #define DEF_MI_CMD_CLI(NAME, CLI_NAME, ARGS_P) \
  37   DEF_MI_CMD_CLI_1(NAME, CLI_NAME, ARGS_P, NULL)
  38
  39 /* Define a MI command of NAME, and implemented by function MI_FUNC.  */
  40 #define DEF_MI_CMD_MI_1(NAME, MI_FUNC, CALLED) \
  41   { NAME, {NULL, 0}, MI_FUNC, CALLED }
  42 #define DEF_MI_CMD_MI(NAME, MI_FUNC) DEF_MI_CMD_MI_1(NAME, MI_FUNC, NULL)
  43
  44   DEF_MI_CMD_MI ("ada-task-info", mi_cmd_ada_task_info),
  45   DEF_MI_CMD_MI ("add-inferior", mi_cmd_add_inferior),
  46   DEF_MI_CMD_CLI_1 ("break-after", "ignore", 1,
  47                     &mi_suppress_notification.breakpoint),
  48   DEF_MI_CMD_CLI_1 ("break-condition","cond", 1,
  49                   &mi_suppress_notification.breakpoint),
  50   DEF_MI_CMD_MI_1 ("break-commands", mi_cmd_break_commands,
  51                    &mi_suppress_notification.breakpoint),
  52   DEF_MI_CMD_CLI_1 ("break-delete", "delete breakpoint", 1,
  53                     &mi_suppress_notification.breakpoint),
  54   DEF_MI_CMD_CLI_1 ("break-disable", "disable breakpoint", 1,
  55                     &mi_suppress_notification.breakpoint),
  56   DEF_MI_CMD_CLI_1 ("break-enable", "enable breakpoint", 1,
  57                      &mi_suppress_notification.breakpoint),
  58   DEF_MI_CMD_CLI ("break-info", "info break", 1),
  59   DEF_MI_CMD_MI_1 ("break-insert", mi_cmd_break_insert,
  60                    &mi_suppress_notification.breakpoint),
  61   DEF_MI_CMD_MI_1 ("dprintf-insert", mi_cmd_dprintf_insert,
  62                    &mi_suppress_notification.breakpoint),
  63   DEF_MI_CMD_CLI ("break-list", "info break", 0),
  64   DEF_MI_CMD_MI_1 ("break-passcount", mi_cmd_break_passcount,
  65                    &mi_suppress_notification.breakpoint),
  66   DEF_MI_CMD_MI_1 ("break-watch", mi_cmd_break_watch,
  67                    &mi_suppress_notification.breakpoint),
  68   DEF_MI_CMD_MI_1 ("catch-assert", mi_cmd_catch_assert,
  69                    &mi_suppress_notification.breakpoint),
  70   DEF_MI_CMD_MI_1 ("catch-exception", mi_cmd_catch_exception,
  71                    &mi_suppress_notification.breakpoint),
  72   DEF_MI_CMD_MI_1 ("catch-handlers", mi_cmd_catch_handlers,
  73                    &mi_suppress_notification.breakpoint),
  74   DEF_MI_CMD_MI_1 ("catch-load", mi_cmd_catch_load,
  75                    &mi_suppress_notification.breakpoint),
  76   DEF_MI_CMD_MI_1 ("catch-unload", mi_cmd_catch_unload,
  77                    &mi_suppress_notification.breakpoint),
  78   DEF_MI_CMD_MI ("data-disassemble", mi_cmd_disassemble),
  79   DEF_MI_CMD_MI ("data-evaluate-expression", mi_cmd_data_evaluate_expression),
  80   DEF_MI_CMD_MI ("data-list-changed-registers",
  81                  mi_cmd_data_list_changed_registers),
  82   DEF_MI_CMD_MI ("data-list-register-names", mi_cmd_data_list_register_names),
  83   DEF_MI_CMD_MI ("data-list-register-values", mi_cmd_data_list_register_values),
  84   DEF_MI_CMD_MI ("data-read-memory", mi_cmd_data_read_memory),
  85   DEF_MI_CMD_MI ("data-read-memory-bytes", mi_cmd_data_read_memory_bytes),
  86   DEF_MI_CMD_MI_1 ("data-write-memory", mi_cmd_data_write_memory,
  87                    &mi_suppress_notification.memory),
  88   DEF_MI_CMD_MI_1 ("data-write-memory-bytes", mi_cmd_data_write_memory_bytes,
  89                    &mi_suppress_notification.memory),
  90   DEF_MI_CMD_MI ("data-write-register-values",
  91                  mi_cmd_data_write_register_values),
  92   DEF_MI_CMD_MI ("enable-timings", mi_cmd_enable_timings),
  93   DEF_MI_CMD_MI ("enable-pretty-printing", mi_cmd_enable_pretty_printing),
  94   DEF_MI_CMD_MI ("enable-frame-filters", mi_cmd_enable_frame_filters),
  95   DEF_MI_CMD_MI ("environment-cd", mi_cmd_env_cd),
  96   DEF_MI_CMD_MI ("environment-directory", mi_cmd_env_dir),
  97   DEF_MI_CMD_MI ("environment-path", mi_cmd_env_path),
  98   DEF_MI_CMD_MI ("environment-pwd", mi_cmd_env_pwd),
  99   DEF_MI_CMD_CLI_1 ("exec-arguments", "set args", 1,
 100                     &mi_suppress_notification.cmd_param_changed),
 101   DEF_MI_CMD_MI ("exec-continue", mi_cmd_exec_continue),
 102   DEF_MI_CMD_MI ("exec-finish", mi_cmd_exec_finish),
 103   DEF_MI_CMD_MI ("exec-jump", mi_cmd_exec_jump),
 104   DEF_MI_CMD_MI ("exec-interrupt", mi_cmd_exec_interrupt),
 105   DEF_MI_CMD_MI ("exec-next", mi_cmd_exec_next),
 106   DEF_MI_CMD_MI ("exec-next-instruction", mi_cmd_exec_next_instruction),
 107   DEF_MI_CMD_MI ("exec-return", mi_cmd_exec_return),
 108   DEF_MI_CMD_MI ("exec-run", mi_cmd_exec_run),
 109   DEF_MI_CMD_MI ("exec-step", mi_cmd_exec_step),
 110   DEF_MI_CMD_MI ("exec-step-instruction", mi_cmd_exec_step_instruction),
 111   DEF_MI_CMD_CLI ("exec-until", "until", 1),
 112   DEF_MI_CMD_CLI ("file-exec-and-symbols", "file", 1),
 113   DEF_MI_CMD_CLI ("file-exec-file", "exec-file", 1),
 114   DEF_MI_CMD_MI ("file-list-exec-source-file",
 115                  mi_cmd_file_list_exec_source_file),
 116   DEF_MI_CMD_MI ("file-list-exec-source-files",
 117                  mi_cmd_file_list_exec_source_files),
 118   DEF_MI_CMD_MI ("file-list-shared-libraries",
 119                  mi_cmd_file_list_shared_libraries),
 120   DEF_MI_CMD_CLI ("file-symbol-file", "symbol-file", 1),
 121   DEF_MI_CMD_MI ("fix-multi-location-breakpoint-output",
 122                  mi_cmd_fix_multi_location_breakpoint_output),
 123   DEF_MI_CMD_MI ("gdb-exit", mi_cmd_gdb_exit),
 124   DEF_MI_CMD_CLI_1 ("gdb-set", "set", 1,
 125                     &mi_suppress_notification.cmd_param_changed),
 126   DEF_MI_CMD_CLI ("gdb-show", "show", 1),
 127   DEF_MI_CMD_CLI ("gdb-version", "show version", 0),
 128   DEF_MI_CMD_MI ("inferior-tty-set", mi_cmd_inferior_tty_set),
 129   DEF_MI_CMD_MI ("inferior-tty-show", mi_cmd_inferior_tty_show),
 130   DEF_MI_CMD_MI ("info-ada-exceptions", mi_cmd_info_ada_exceptions),
 131   DEF_MI_CMD_MI ("info-gdb-mi-command", mi_cmd_info_gdb_mi_command),
 132   DEF_MI_CMD_MI ("info-os", mi_cmd_info_os),
 133   DEF_MI_CMD_MI ("interpreter-exec", mi_cmd_interpreter_exec),
 134   DEF_MI_CMD_MI ("list-features", mi_cmd_list_features),
 135   DEF_MI_CMD_MI ("list-target-features", mi_cmd_list_target_features),
 136   DEF_MI_CMD_MI ("list-thread-groups", mi_cmd_list_thread_groups),
 137   DEF_MI_CMD_MI ("remove-inferior", mi_cmd_remove_inferior),
 138   DEF_MI_CMD_MI ("stack-info-depth", mi_cmd_stack_info_depth),
 139   DEF_MI_CMD_MI ("stack-info-frame", mi_cmd_stack_info_frame),
 140   DEF_MI_CMD_MI ("stack-list-arguments", mi_cmd_stack_list_args),
 141   DEF_MI_CMD_MI ("stack-list-frames", mi_cmd_stack_list_frames),
 142   DEF_MI_CMD_MI ("stack-list-locals", mi_cmd_stack_list_locals),
 143   DEF_MI_CMD_MI ("stack-list-variables", mi_cmd_stack_list_variables),
 144   DEF_MI_CMD_MI_1 ("stack-select-frame", mi_cmd_stack_select_frame,
 145                    &mi_suppress_notification.user_selected_context),
 146   DEF_MI_CMD_MI ("symbol-list-lines", mi_cmd_symbol_list_lines),
 147   DEF_MI_CMD_CLI ("target-attach", "attach", 1),
 148   DEF_MI_CMD_MI ("target-detach", mi_cmd_target_detach),
 149   DEF_MI_CMD_CLI ("target-disconnect", "disconnect", 0),
 150   DEF_MI_CMD_CLI ("target-download", "load", 1),
 151   DEF_MI_CMD_MI ("target-file-delete", mi_cmd_target_file_delete),
 152   DEF_MI_CMD_MI ("target-file-get", mi_cmd_target_file_get),
 153   DEF_MI_CMD_MI ("target-file-put", mi_cmd_target_file_put),
 154   DEF_MI_CMD_MI ("target-flash-erase", mi_cmd_target_flash_erase),
 155   DEF_MI_CMD_CLI ("target-select", "target", 1),
 156   DEF_MI_CMD_MI ("thread-info", mi_cmd_thread_info),
 157   DEF_MI_CMD_MI ("thread-list-ids", mi_cmd_thread_list_ids),
 158   DEF_MI_CMD_MI_1 ("thread-select", mi_cmd_thread_select,
 159                    &mi_suppress_notification.user_selected_context),
 160   DEF_MI_CMD_MI ("trace-define-variable", mi_cmd_trace_define_variable),
 161   DEF_MI_CMD_MI_1 ("trace-find", mi_cmd_trace_find,
 162                    &mi_suppress_notification.traceframe),
 163   DEF_MI_CMD_MI ("trace-frame-collected",
 164                  mi_cmd_trace_frame_collected),
 165   DEF_MI_CMD_MI ("trace-list-variables", mi_cmd_trace_list_variables),
 166   DEF_MI_CMD_MI ("trace-save", mi_cmd_trace_save),
 167   DEF_MI_CMD_MI ("trace-start", mi_cmd_trace_start),
 168   DEF_MI_CMD_MI ("trace-status", mi_cmd_trace_status),
 169   DEF_MI_CMD_MI ("trace-stop", mi_cmd_trace_stop),
 170   DEF_MI_CMD_MI ("var-assign", mi_cmd_var_assign),
 171   DEF_MI_CMD_MI ("var-create", mi_cmd_var_create),
 172   DEF_MI_CMD_MI ("var-delete", mi_cmd_var_delete),
 173   DEF_MI_CMD_MI ("var-evaluate-expression", mi_cmd_var_evaluate_expression),
 174   DEF_MI_CMD_MI ("var-info-path-expression", mi_cmd_var_info_path_expression),
 175   DEF_MI_CMD_MI ("var-info-expression", mi_cmd_var_info_expression),
 176   DEF_MI_CMD_MI ("var-info-num-children", mi_cmd_var_info_num_children),
 177   DEF_MI_CMD_MI ("var-info-type", mi_cmd_var_info_type),
 178   DEF_MI_CMD_MI ("var-list-children", mi_cmd_var_list_children),
 179   DEF_MI_CMD_MI ("var-set-format", mi_cmd_var_set_format),
 180   DEF_MI_CMD_MI ("var-set-frozen", mi_cmd_var_set_frozen),
 181   DEF_MI_CMD_MI ("var-set-update-range", mi_cmd_var_set_update_range),
 182   DEF_MI_CMD_MI ("var-set-visualizer", mi_cmd_var_set_visualizer),
 183   DEF_MI_CMD_MI ("var-show-attributes", mi_cmd_var_show_attributes),
 184   DEF_MI_CMD_MI ("var-show-format", mi_cmd_var_show_format),
 185   DEF_MI_CMD_MI ("var-update", mi_cmd_var_update),
 186   { NULL, }
 187 };
 188
 189 /* Pointer to the mi command table (built at run time). */
 190
 191 static struct mi_cmd **mi_table;
 192
 193 /* A prime large enough to accomodate the entire command table.  */
 194 enum
 195   {
 196     MI_TABLE_SIZE = 227
 197   };
 198
 199 /* Exported function used to obtain info from the table.  */
 200 struct mi_cmd *
 201 mi_lookup (const char *command)
 202 {
 203   return *lookup_table (command);
 204 }
 205
 206 /* Used for collecting hash hit/miss statistics.  */
 207
 208 struct mi_cmd_stats
 209 {
 210   int hit;
 211   int miss;
 212   int rehash;
 213 };
 214 struct mi_cmd_stats stats;
 215
 216 /* Look up a command.  */
 217
 218 static struct mi_cmd **
 219 lookup_table (const char *command)
 220 {
 221   const char *chp;
 222   unsigned int index = 0;
 223
 224   /* Compute our hash.  */
 225   for (chp = command; *chp; chp++)
 226     {
 227       /* We use a somewhat arbitrary formula.  */
 228       index = ((index << 6) + (unsigned int) *chp) % MI_TABLE_SIZE;
 229     }
 230
 231   while (1)
 232     {
 233       struct mi_cmd **entry = &mi_table[index];
 234       if ((*entry) == 0)
 235         {
 236           /* not found, return pointer to next free. */
 237           stats.miss++;
 238           return entry;
 239         }
 240       if (strcmp (command, (*entry)->name) == 0)
 241         {
 242           stats.hit++;
 243           return entry;         /* found */
 244         }
 245       index = (index + 1) % MI_TABLE_SIZE;
 246       stats.rehash++;
 247     }
 248 }
 249
 250 static void
 251 build_table (struct mi_cmd *commands)
 252 {
 253   int nr_rehash = 0;
 254   int nr_entries = 0;
 255   struct mi_cmd *command;
 256
 257   mi_table = XCNEWVEC (struct mi_cmd *, MI_TABLE_SIZE);
 258   for (command = commands; command->name != 0; command++)
 259     {
 260       struct mi_cmd **entry = lookup_table (command->name);
 261
 262       if (*entry)
 263         internal_error (__FILE__, __LINE__,
 264                         _("command `%s' appears to be duplicated"),
 265                         command->name);
 266       *entry = command;
 267       /* FIXME lose these prints */
 268       if (0)
 269         {
 270           fprintf_unfiltered (gdb_stdlog, "%-30s %2d\n",
 271                               command->name, stats.rehash - nr_rehash);
 272         }
 273       nr_entries++;
 274       nr_rehash = stats.rehash;
 275     }
 276   if (0)
 277     {
 278       fprintf_filtered (gdb_stdlog, "Average %3.1f\n",
 279                         (double) nr_rehash / (double) nr_entries);
 280     }
 281 }
 282
 283 void
 284 _initialize_mi_cmds (void)
 285 {
 286   build_table (mi_cmds);
 287   memset (&stats, 0, sizeof (stats));
 288 }