gdb/compile/compile.c

   1 /* General Compile and inject code
   2
   3    Copyright (C) 2014-2021 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 "top.h"
  22 #include "ui-out.h"
  23 #include "command.h"
  24 #include "cli/cli-script.h"
  25 #include "cli/cli-utils.h"
  26 #include "cli/cli-option.h"
  27 #include "completer.h"
  28 #include "gdbcmd.h"
  29 #include "compile.h"
  30 #include "compile-internal.h"
  31 #include "compile-object-load.h"
  32 #include "compile-object-run.h"
  33 #include "language.h"
  34 #include "frame.h"
  35 #include "source.h"
  36 #include "block.h"
  37 #include "arch-utils.h"
  38 #include "gdbsupport/filestuff.h"
  39 #include "target.h"
  40 #include "osabi.h"
  41 #include "gdbsupport/gdb_wait.h"
  42 #include "valprint.h"
  43 #include "gdbsupport/gdb_optional.h"
  44 #include "gdbsupport/gdb_unlinker.h"
  45 #include "gdbsupport/pathstuff.h"
  46
  47 \f
  48
  49 /* Initial filename for temporary files.  */
  50
  51 #define TMP_PREFIX "/tmp/gdbobj-"
  52
  53 /* Hold "compile" commands.  */
  54
  55 static struct cmd_list_element *compile_command_list;
  56
  57 /* Debug flag for "compile" commands.  */
  58
  59 bool compile_debug;
  60
  61 /* Object of this type are stored in the compiler's symbol_err_map.  */
  62
  63 struct symbol_error
  64 {
  65   /* The symbol.  */
  66
  67   const struct symbol *sym;
  68
  69   /* The error message to emit.  This is malloc'd and owned by the
  70      hash table.  */
  71
  72   char *message;
  73 };
  74
  75 /* Hash a type_map_instance.  */
  76
  77 static hashval_t
  78 hash_type_map_instance (const void *p)
  79 {
  80   const struct type_map_instance *inst = (const struct type_map_instance *) p;
  81
  82   return htab_hash_pointer (inst->type);
  83 }
  84
  85 /* Check two type_map_instance objects for equality.  */
  86
  87 static int
  88 eq_type_map_instance (const void *a, const void *b)
  89 {
  90   const struct type_map_instance *insta = (const struct type_map_instance *) a;
  91   const struct type_map_instance *instb = (const struct type_map_instance *) b;
  92
  93   return insta->type == instb->type;
  94 }
  95
  96 /* Hash function for struct symbol_error.  */
  97
  98 static hashval_t
  99 hash_symbol_error (const void *a)
 100 {
 101   const struct symbol_error *se = (const struct symbol_error *) a;
 102
 103   return htab_hash_pointer (se->sym);
 104 }
 105
 106 /* Equality function for struct symbol_error.  */
 107
 108 static int
 109 eq_symbol_error (const void *a, const void *b)
 110 {
 111   const struct symbol_error *sea = (const struct symbol_error *) a;
 112   const struct symbol_error *seb = (const struct symbol_error *) b;
 113
 114   return sea->sym == seb->sym;
 115 }
 116
 117 /* Deletion function for struct symbol_error.  */
 118
 119 static void
 120 del_symbol_error (void *a)
 121 {
 122   struct symbol_error *se = (struct symbol_error *) a;
 123
 124   xfree (se->message);
 125   xfree (se);
 126 }
 127
 128 /* Constructor for compile_instance.  */
 129
 130 compile_instance::compile_instance (struct gcc_base_context *gcc_fe,
 131                                     const char *options)
 132   : m_gcc_fe (gcc_fe), m_gcc_target_options (options),
 133     m_type_map (htab_create_alloc (10, hash_type_map_instance,
 134                                    eq_type_map_instance,
 135                                    xfree, xcalloc, xfree)),
 136     m_symbol_err_map (htab_create_alloc (10, hash_symbol_error,
 137                                          eq_symbol_error, del_symbol_error,
 138                                          xcalloc, xfree))
 139 {
 140 }
 141
 142 /* See compile-internal.h.  */
 143
 144 bool
 145 compile_instance::get_cached_type (struct type *type, gcc_type *ret) const
 146 {
 147   struct type_map_instance inst, *found;
 148
 149   inst.type = type;
 150   found = (struct type_map_instance *) htab_find (m_type_map.get (), &inst);
 151   if (found != NULL)
 152     {
 153       *ret = found->gcc_type_handle;
 154       return true;
 155     }
 156
 157   return false;
 158 }
 159
 160 /* See compile-internal.h.  */
 161
 162 void
 163 compile_instance::insert_type (struct type *type, gcc_type gcc_type)
 164 {
 165   struct type_map_instance inst, *add;
 166   void **slot;
 167
 168   inst.type = type;
 169   inst.gcc_type_handle = gcc_type;
 170   slot = htab_find_slot (m_type_map.get (), &inst, INSERT);
 171
 172   add = (struct type_map_instance *) *slot;
 173   /* The type might have already been inserted in order to handle
 174      recursive types.  */
 175   if (add != NULL && add->gcc_type_handle != gcc_type)
 176     error (_("Unexpected type id from GCC, check you use recent enough GCC."));
 177
 178   if (add == NULL)
 179     {
 180       add = XNEW (struct type_map_instance);
 181       *add = inst;
 182       *slot = add;
 183     }
 184 }
 185
 186 /* See compile-internal.h.  */
 187
 188 void
 189 compile_instance::insert_symbol_error (const struct symbol *sym,
 190                                        const char *text)
 191 {
 192   struct symbol_error e;
 193   void **slot;
 194
 195   e.sym = sym;
 196   slot = htab_find_slot (m_symbol_err_map.get (), &e, INSERT);
 197   if (*slot == NULL)
 198     {
 199       struct symbol_error *ep = XNEW (struct symbol_error);
 200
 201       ep->sym = sym;
 202       ep->message = xstrdup (text);
 203       *slot = ep;
 204     }
 205 }
 206
 207 /* See compile-internal.h.  */
 208
 209 void
 210 compile_instance::error_symbol_once (const struct symbol *sym)
 211 {
 212   struct symbol_error search;
 213   struct symbol_error *err;
 214
 215   if (m_symbol_err_map == NULL)
 216     return;
 217
 218   search.sym = sym;
 219   err = (struct symbol_error *) htab_find (m_symbol_err_map.get (), &search);
 220   if (err == NULL || err->message == NULL)
 221     return;
 222
 223   gdb::unique_xmalloc_ptr<char> message (err->message);
 224   err->message = NULL;
 225   error (_("%s"), message.get ());
 226 }
 227
 228 /* Implement "show debug compile".  */
 229
 230 static void
 231 show_compile_debug (struct ui_file *file, int from_tty,
 232                     struct cmd_list_element *c, const char *value)
 233 {
 234   fprintf_filtered (file, _("Compile debugging is %s.\n"), value);
 235 }
 236
 237 \f
 238
 239 /* Options for the compile command.  */
 240
 241 struct compile_options
 242 {
 243   /* For -raw.  */
 244   bool raw = false;
 245 };
 246
 247 using compile_flag_option_def
 248   = gdb::option::flag_option_def<compile_options>;
 249
 250 static const gdb::option::option_def compile_command_option_defs[] = {
 251
 252   compile_flag_option_def {
 253     "raw",
 254     [] (compile_options *opts) { return &opts->raw; },
 255     N_("Suppress automatic 'void _gdb_expr () { CODE }' wrapping."),
 256   },
 257
 258 };
 259
 260 /* Create an option_def_group for the "compile" command's options,
 261    with OPTS as context.  */
 262
 263 static gdb::option::option_def_group
 264 make_compile_options_def_group (compile_options *opts)
 265 {
 266   return {{compile_command_option_defs}, opts};
 267 }
 268
 269 /* Handle the input from the 'compile file' command.  The "compile
 270    file" command is used to evaluate an expression contained in a file
 271    that may contain calls to the GCC compiler.  */
 272
 273 static void
 274 compile_file_command (const char *args, int from_tty)
 275 {
 276   scoped_restore save_async = make_scoped_restore (&current_ui->async, 0);
 277
 278   /* Check if a -raw option is provided.  */
 279
 280   compile_options options;
 281
 282   const gdb::option::option_def_group group
 283     = make_compile_options_def_group (&options);
 284   gdb::option::process_options
 285     (&args, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR,
 286      group);
 287
 288   enum compile_i_scope_types scope
 289     = options.raw ? COMPILE_I_RAW_SCOPE : COMPILE_I_SIMPLE_SCOPE;
 290
 291   args = skip_spaces (args);
 292
 293   /* After processing options, check whether we have a filename.  */
 294   if (args == nullptr || args[0] == '\0')
 295     error (_("You must provide a filename for this command."));
 296
 297   args = skip_spaces (args);
 298   gdb::unique_xmalloc_ptr<char> abspath = gdb_abspath (args);
 299   std::string buffer = string_printf ("#include \"%s\"\n", abspath.get ());
 300   eval_compile_command (NULL, buffer.c_str (), scope, NULL);
 301 }
 302
 303 /* Completer for the "compile file" command.  */
 304
 305 static void
 306 compile_file_command_completer (struct cmd_list_element *ignore,
 307                                 completion_tracker &tracker,
 308                                 const char *text, const char *word)
 309 {
 310   const gdb::option::option_def_group group
 311     = make_compile_options_def_group (nullptr);
 312   if (gdb::option::complete_options
 313       (tracker, &text, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR, group))
 314     return;
 315
 316   word = advance_to_filename_complete_word_point (tracker, text);
 317   filename_completer (ignore, tracker, text, word);
 318 }
 319
 320 /* Handle the input from the 'compile code' command.  The
 321    "compile code" command is used to evaluate an expression that may
 322    contain calls to the GCC compiler.  The language expected in this
 323    compile command is the language currently set in GDB.  */
 324
 325 static void
 326 compile_code_command (const char *args, int from_tty)
 327 {
 328   scoped_restore save_async = make_scoped_restore (&current_ui->async, 0);
 329
 330   compile_options options;
 331
 332   const gdb::option::option_def_group group
 333     = make_compile_options_def_group (&options);
 334   gdb::option::process_options
 335     (&args, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR, group);
 336
 337   enum compile_i_scope_types scope
 338     = options.raw ? COMPILE_I_RAW_SCOPE : COMPILE_I_SIMPLE_SCOPE;
 339
 340   if (args && *args)
 341     eval_compile_command (NULL, args, scope, NULL);
 342   else
 343     {
 344       counted_command_line l = get_command_line (compile_control, "");
 345
 346       l->control_u.compile.scope = scope;
 347       execute_control_command_untraced (l.get ());
 348     }
 349 }
 350
 351 /* Completer for the "compile code" command.  */
 352
 353 static void
 354 compile_code_command_completer (struct cmd_list_element *ignore,
 355                                 completion_tracker &tracker,
 356                                 const char *text, const char *word)
 357 {
 358   const gdb::option::option_def_group group
 359     = make_compile_options_def_group (nullptr);
 360   if (gdb::option::complete_options
 361       (tracker, &text, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR, group))
 362     return;
 363
 364   word = advance_to_expression_complete_word_point (tracker, text);
 365   symbol_completer (ignore, tracker, text, word);
 366 }
 367
 368 /* Callback for compile_print_command.  */
 369
 370 void
 371 compile_print_value (struct value *val, void *data_voidp)
 372 {
 373   const value_print_options *print_opts = (value_print_options *) data_voidp;
 374
 375   print_value (val, *print_opts);
 376 }
 377
 378 /* Handle the input from the 'compile print' command.  The "compile
 379    print" command is used to evaluate and print an expression that may
 380    contain calls to the GCC compiler.  The language expected in this
 381    compile command is the language currently set in GDB.  */
 382
 383 static void
 384 compile_print_command (const char *arg, int from_tty)
 385 {
 386   enum compile_i_scope_types scope = COMPILE_I_PRINT_ADDRESS_SCOPE;
 387   value_print_options print_opts;
 388
 389   scoped_restore save_async = make_scoped_restore (&current_ui->async, 0);
 390
 391   get_user_print_options (&print_opts);
 392   /* Override global settings with explicit options, if any.  */
 393   auto group = make_value_print_options_def_group (&print_opts);
 394   gdb::option::process_options
 395     (&arg, gdb::option::PROCESS_OPTIONS_REQUIRE_DELIMITER, group);
 396
 397   print_command_parse_format (&arg, "compile print", &print_opts);
 398
 399   /* Passing &PRINT_OPTS as SCOPE_DATA is safe as do_module_cleanup
 400      will not touch the stale pointer if compile_object_run has
 401      already quit.  */
 402
 403   if (arg && *arg)
 404     eval_compile_command (NULL, arg, scope, &print_opts);
 405   else
 406     {
 407       counted_command_line l = get_command_line (compile_control, "");
 408
 409       l->control_u.compile.scope = scope;
 410       l->control_u.compile.scope_data = &print_opts;
 411       execute_control_command_untraced (l.get ());
 412     }
 413 }
 414
 415 /* A cleanup function to remove a directory and all its contents.  */
 416
 417 static void
 418 do_rmdir (void *arg)
 419 {
 420   const char *dir = (const char *) arg;
 421   char *zap;
 422   int wstat;
 423
 424   gdb_assert (startswith (dir, TMP_PREFIX));
 425   zap = concat ("rm -rf ", dir, (char *) NULL);
 426   wstat = system (zap);
 427   if (wstat == -1 || !WIFEXITED (wstat) || WEXITSTATUS (wstat) != 0)
 428     warning (_("Could not remove temporary directory %s"), dir);
 429   XDELETEVEC (zap);
 430 }
 431
 432 /* Return the name of the temporary directory to use for .o files, and
 433    arrange for the directory to be removed at shutdown.  */
 434
 435 static const char *
 436 get_compile_file_tempdir (void)
 437 {
 438   static char *tempdir_name;
 439
 440 #define TEMPLATE TMP_PREFIX "XXXXXX"
 441   char tname[sizeof (TEMPLATE)];
 442
 443   if (tempdir_name != NULL)
 444     return tempdir_name;
 445
 446   strcpy (tname, TEMPLATE);
 447 #undef TEMPLATE
 448   tempdir_name = mkdtemp (tname);
 449   if (tempdir_name == NULL)
 450     perror_with_name (_("Could not make temporary directory"));
 451
 452   tempdir_name = xstrdup (tempdir_name);
 453   make_final_cleanup (do_rmdir, tempdir_name);
 454   return tempdir_name;
 455 }
 456
 457 /* Compute the names of source and object files to use.  */
 458
 459 static compile_file_names
 460 get_new_file_names ()
 461 {
 462   static int seq;
 463   const char *dir = get_compile_file_tempdir ();
 464
 465   ++seq;
 466
 467   return compile_file_names (string_printf ("%s%sout%d.c",
 468                                             dir, SLASH_STRING, seq),
 469                              string_printf ("%s%sout%d.o",
 470                                             dir, SLASH_STRING, seq));
 471 }
 472
 473 /* Get the block and PC at which to evaluate an expression.  */
 474
 475 static const struct block *
 476 get_expr_block_and_pc (CORE_ADDR *pc)
 477 {
 478   const struct block *block = get_selected_block (pc);
 479
 480   if (block == NULL)
 481     {
 482       struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 483
 484       if (cursal.symtab)
 485         block = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (cursal.symtab),
 486                                    STATIC_BLOCK);
 487       if (block != NULL)
 488         *pc = BLOCK_ENTRY_PC (block);
 489     }
 490   else
 491     *pc = BLOCK_ENTRY_PC (block);
 492
 493   return block;
 494 }
 495
 496 /* String for 'set compile-args' and 'show compile-args'.  */
 497 static char *compile_args;
 498
 499 /* Parsed form of COMPILE_ARGS.  */
 500 static gdb_argv compile_args_argv;
 501
 502 /* Implement 'set compile-args'.  */
 503
 504 static void
 505 set_compile_args (const char *args, int from_tty, struct cmd_list_element *c)
 506 {
 507   compile_args_argv = gdb_argv (compile_args);
 508 }
 509
 510 /* Implement 'show compile-args'.  */
 511
 512 static void
 513 show_compile_args (struct ui_file *file, int from_tty,
 514                    struct cmd_list_element *c, const char *value)
 515 {
 516   fprintf_filtered (file, _("Compile command command-line arguments "
 517                             "are \"%s\".\n"),
 518                     value);
 519 }
 520
 521 /* String for 'set compile-gcc' and 'show compile-gcc'.  */
 522 static char *compile_gcc;
 523
 524 /* Implement 'show compile-gcc'.  */
 525
 526 static void
 527 show_compile_gcc (struct ui_file *file, int from_tty,
 528                   struct cmd_list_element *c, const char *value)
 529 {
 530   fprintf_filtered (file, _("Compile command GCC driver filename is \"%s\".\n"),
 531                     value);
 532 }
 533
 534 /* Return DW_AT_producer parsed for get_selected_frame () (if any).
 535    Return NULL otherwise.
 536
 537    GCC already filters its command-line arguments only for the suitable ones to
 538    put into DW_AT_producer - see GCC function gen_producer_string.  */
 539
 540 static const char *
 541 get_selected_pc_producer_options (void)
 542 {
 543   CORE_ADDR pc = get_frame_pc (get_selected_frame (NULL));
 544   struct compunit_symtab *symtab = find_pc_compunit_symtab (pc);
 545   const char *cs;
 546
 547   if (symtab == NULL || symtab->producer == NULL
 548       || !startswith (symtab->producer, "GNU "))
 549     return NULL;
 550
 551   cs = symtab->producer;
 552   while (*cs != 0 && *cs != '-')
 553     cs = skip_spaces (skip_to_space (cs));
 554   if (*cs != '-')
 555     return NULL;
 556   return cs;
 557 }
 558
 559 /* Filter out unwanted options from ARGV.  */
 560
 561 static void
 562 filter_args (char **argv)
 563 {
 564   char **destv;
 565
 566   for (destv = argv; *argv != NULL; argv++)
 567     {
 568       /* -fpreprocessed may get in commonly from ccache.  */
 569       if (strcmp (*argv, "-fpreprocessed") == 0)
 570         {
 571           xfree (*argv);
 572           continue;
 573         }
 574       *destv++ = *argv;
 575     }
 576   *destv = NULL;
 577 }
 578
 579 /* Produce final vector of GCC compilation options.
 580
 581    The first element of the combined argument vector are arguments
 582    relating to the target size ("-m64", "-m32" etc.).  These are
 583    sourced from the inferior's architecture.
 584
 585    The second element of the combined argument vector are arguments
 586    stored in the inferior DW_AT_producer section.  If these are stored
 587    in the inferior (there is no guarantee that they are), they are
 588    added to the vector.
 589
 590    The third element of the combined argument vector are argument
 591    supplied by the language implementation provided by
 592    compile-{lang}-support.  These contain language specific arguments.
 593
 594    The final element of the combined argument vector are arguments
 595    supplied by the "set compile-args" command.  These are always
 596    appended last so as to override any of the arguments automatically
 597    generated above.  */
 598
 599 static gdb_argv
 600 get_args (const compile_instance *compiler, struct gdbarch *gdbarch)
 601 {
 602   const char *cs_producer_options;
 603
 604   gdb_argv result (gdbarch_gcc_target_options (gdbarch).c_str ());
 605
 606   cs_producer_options = get_selected_pc_producer_options ();
 607   if (cs_producer_options != NULL)
 608     {
 609       gdb_argv argv_producer (cs_producer_options);
 610       filter_args (argv_producer.get ());
 611
 612       result.append (std::move (argv_producer));
 613     }
 614
 615   result.append (gdb_argv (compiler->gcc_target_options ().c_str ()));
 616   result.append (compile_args_argv);
 617
 618   return result;
 619 }
 620
 621 /* A helper function suitable for use as the "print_callback" in the
 622    compiler object.  */
 623
 624 static void
 625 print_callback (void *ignore, const char *message)
 626 {
 627   fputs_filtered (message, gdb_stderr);
 628 }
 629
 630 /* Process the compilation request.  On success it returns the object
 631    and source file names.  On an error condition, error () is
 632    called.  */
 633
 634 static compile_file_names
 635 compile_to_object (struct command_line *cmd, const char *cmd_string,
 636                    enum compile_i_scope_types scope)
 637 {
 638   const struct block *expr_block;
 639   CORE_ADDR trash_pc, expr_pc;
 640   int ok;
 641   struct gdbarch *gdbarch = get_current_arch ();
 642   std::string triplet_rx;
 643
 644   if (!target_has_execution ())
 645     error (_("The program must be running for the compile command to "\
 646              "work."));
 647
 648   expr_block = get_expr_block_and_pc (&trash_pc);
 649   expr_pc = get_frame_address_in_block (get_selected_frame (NULL));
 650
 651   /* Set up instance and context for the compiler.  */
 652   std::unique_ptr <compile_instance> compiler
 653                         (current_language->get_compile_instance ());
 654   if (compiler == nullptr)
 655     error (_("No compiler support for language %s."),
 656            current_language->name ());
 657   compiler->set_print_callback (print_callback, NULL);
 658   compiler->set_scope (scope);
 659   compiler->set_block (expr_block);
 660
 661   /* From the provided expression, build a scope to pass to the
 662      compiler.  */
 663
 664   string_file input_buf;
 665   const char *input;
 666
 667   if (cmd != NULL)
 668     {
 669       struct command_line *iter;
 670
 671       for (iter = cmd->body_list_0.get (); iter; iter = iter->next)
 672         {
 673           input_buf.puts (iter->line);
 674           input_buf.puts ("\n");
 675         }
 676
 677       input = input_buf.c_str ();
 678     }
 679   else if (cmd_string != NULL)
 680     input = cmd_string;
 681   else
 682     error (_("Neither a simple expression, or a multi-line specified."));
 683
 684   std::string code
 685     = current_language->compute_program (compiler.get (), input, gdbarch,
 686                                          expr_block, expr_pc);
 687   if (compile_debug)
 688     fprintf_unfiltered (gdb_stdlog, "debug output:\n\n%s", code.c_str ());
 689
 690   compiler->set_verbose (compile_debug);
 691
 692   if (compile_gcc[0] != 0)
 693     {
 694       if (compiler->version () < GCC_FE_VERSION_1)
 695         error (_("Command 'set compile-gcc' requires GCC version 6 or higher "
 696                  "(libcc1 interface version 1 or higher)"));
 697
 698       compiler->set_driver_filename (compile_gcc);
 699     }
 700   else
 701     {
 702       const char *os_rx = osabi_triplet_regexp (gdbarch_osabi (gdbarch));
 703       const char *arch_rx = gdbarch_gnu_triplet_regexp (gdbarch);
 704
 705       /* Allow triplets with or without vendor set.  */
 706       triplet_rx = std::string (arch_rx) + "(-[^-]*)?-";
 707       if (os_rx != nullptr)
 708         triplet_rx += os_rx;
 709       compiler->set_triplet_regexp (triplet_rx.c_str ());
 710     }
 711
 712   /* Set compiler command-line arguments.  */
 713   gdb_argv argv_holder = get_args (compiler.get (), gdbarch);
 714   int argc = argv_holder.count ();
 715   char **argv = argv_holder.get ();
 716
 717   gdb::unique_xmalloc_ptr<char> error_message
 718     = compiler->set_arguments (argc, argv, triplet_rx.c_str ());
 719
 720   if (error_message != NULL)
 721     error ("%s", error_message.get ());
 722
 723   if (compile_debug)
 724     {
 725       int argi;
 726
 727       fprintf_unfiltered (gdb_stdlog, "Passing %d compiler options:\n", argc);
 728       for (argi = 0; argi < argc; argi++)
 729         fprintf_unfiltered (gdb_stdlog, "Compiler option %d: <%s>\n",
 730                             argi, argv[argi]);
 731     }
 732
 733   compile_file_names fnames = get_new_file_names ();
 734
 735   gdb::optional<gdb::unlinker> source_remover;
 736
 737   {
 738     gdb_file_up src = gdb_fopen_cloexec (fnames.source_file (), "w");
 739     if (src == NULL)
 740       perror_with_name (_("Could not open source file for writing"));
 741
 742     source_remover.emplace (fnames.source_file ());
 743
 744     if (fputs (code.c_str (), src.get ()) == EOF)
 745       perror_with_name (_("Could not write to source file"));
 746   }
 747
 748   if (compile_debug)
 749     fprintf_unfiltered (gdb_stdlog, "source file produced: %s\n\n",
 750                         fnames.source_file ());
 751
 752   /* Call the compiler and start the compilation process.  */
 753   compiler->set_source_file (fnames.source_file ());
 754   ok = compiler->compile (fnames.object_file (), compile_debug);
 755   if (!ok)
 756     error (_("Compilation failed."));
 757
 758   if (compile_debug)
 759     fprintf_unfiltered (gdb_stdlog, "object file produced: %s\n\n",
 760                         fnames.object_file ());
 761
 762   /* Keep the source file.  */
 763   source_remover->keep ();
 764   return fnames;
 765 }
 766
 767 /* The "compile" prefix command.  */
 768
 769 static void
 770 compile_command (const char *args, int from_tty)
 771 {
 772   /* If a sub-command is not specified to the compile prefix command,
 773      assume it is a direct code compilation.  */
 774   compile_code_command (args, from_tty);
 775 }
 776
 777 /* See compile.h.  */
 778
 779 void
 780 eval_compile_command (struct command_line *cmd, const char *cmd_string,
 781                       enum compile_i_scope_types scope, void *scope_data)
 782 {
 783   compile_file_names fnames = compile_to_object (cmd, cmd_string, scope);
 784
 785   gdb::unlinker object_remover (fnames.object_file ());
 786   gdb::unlinker source_remover (fnames.source_file ());
 787
 788   compile_module_up compile_module = compile_object_load (fnames, scope,
 789                                                           scope_data);
 790   if (compile_module == NULL)
 791     {
 792       gdb_assert (scope == COMPILE_I_PRINT_ADDRESS_SCOPE);
 793       eval_compile_command (cmd, cmd_string,
 794                             COMPILE_I_PRINT_VALUE_SCOPE, scope_data);
 795       return;
 796     }
 797
 798   /* Keep the files.  */
 799   source_remover.keep ();
 800   object_remover.keep ();
 801
 802   compile_object_run (std::move (compile_module));
 803 }
 804
 805 /* See compile/compile-internal.h.  */
 806
 807 std::string
 808 compile_register_name_mangled (struct gdbarch *gdbarch, int regnum)
 809 {
 810   const char *regname = gdbarch_register_name (gdbarch, regnum);
 811
 812   return string_printf ("__%s", regname);
 813 }
 814
 815 /* See compile/compile-internal.h.  */
 816
 817 int
 818 compile_register_name_demangle (struct gdbarch *gdbarch,
 819                                  const char *regname)
 820 {
 821   int regnum;
 822
 823   if (regname[0] != '_' || regname[1] != '_')
 824     error (_("Invalid register name \"%s\"."), regname);
 825   regname += 2;
 826
 827   for (regnum = 0; regnum < gdbarch_num_regs (gdbarch); regnum++)
 828     if (strcmp (regname, gdbarch_register_name (gdbarch, regnum)) == 0)
 829       return regnum;
 830
 831   error (_("Cannot find gdbarch register \"%s\"."), regname);
 832 }
 833
 834 /* Forwards to the plug-in.  */
 835
 836 #define FORWARD(OP,...) (m_gcc_fe->ops->OP (m_gcc_fe, ##__VA_ARGS__))
 837
 838 /* See compile-internal.h.  */
 839
 840 void
 841 compile_instance::set_print_callback
 842   (void (*print_function) (void *, const char *), void *datum)
 843 {
 844   FORWARD (set_print_callback, print_function, datum);
 845 }
 846
 847 /* See compile-internal.h.  */
 848
 849 unsigned int
 850 compile_instance::version () const
 851 {
 852   return m_gcc_fe->ops->version;
 853 }
 854
 855 /* See compile-internal.h.  */
 856
 857 void
 858 compile_instance::set_verbose (int level)
 859 {
 860   if (version () >= GCC_FE_VERSION_1)
 861     FORWARD (set_verbose, level);
 862 }
 863
 864 /* See compile-internal.h.  */
 865
 866 void
 867 compile_instance::set_driver_filename (const char *filename)
 868 {
 869   if (version () >= GCC_FE_VERSION_1)
 870     FORWARD (set_driver_filename, filename);
 871 }
 872
 873 /* See compile-internal.h.  */
 874
 875 void
 876 compile_instance::set_triplet_regexp (const char *regexp)
 877 {
 878   if (version () >= GCC_FE_VERSION_1)
 879     FORWARD (set_triplet_regexp, regexp);
 880 }
 881
 882 /* See compile-internal.h.  */
 883
 884 gdb::unique_xmalloc_ptr<char>
 885 compile_instance::set_arguments (int argc, char **argv, const char *regexp)
 886 {
 887   if (version () >= GCC_FE_VERSION_1)
 888     return gdb::unique_xmalloc_ptr<char> (FORWARD (set_arguments, argc, argv));
 889   else
 890     return gdb::unique_xmalloc_ptr<char> (FORWARD (set_arguments_v0, regexp,
 891                                                    argc, argv));
 892 }
 893
 894 /* See compile-internal.h.  */
 895
 896 void
 897 compile_instance::set_source_file (const char *filename)
 898 {
 899   FORWARD (set_source_file, filename);
 900 }
 901
 902 /* See compile-internal.h.  */
 903
 904 bool
 905 compile_instance::compile (const char *filename, int verbose_level)
 906 {
 907   if (version () >= GCC_FE_VERSION_1)
 908     return FORWARD (compile, filename);
 909   else
 910     return FORWARD (compile_v0, filename, verbose_level);
 911 }
 912
 913 #undef FORWARD
 914
 915 /* See compile.h.  */
 916 cmd_list_element *compile_cmd_element = nullptr;
 917
 918 void _initialize_compile ();
 919 void
 920 _initialize_compile ()
 921 {
 922   struct cmd_list_element *c = NULL;
 923
 924   compile_cmd_element = add_prefix_cmd ("compile", class_obscure,
 925                                         compile_command, _("\
 926 Command to compile source code and inject it into the inferior."),
 927                   &compile_command_list, "compile ", 1, &cmdlist);
 928   add_com_alias ("expression", "compile", class_obscure, 0);
 929
 930   const auto compile_opts = make_compile_options_def_group (nullptr);
 931
 932   static const std::string compile_code_help
 933     = gdb::option::build_help (_("\
 934 Compile, inject, and execute code.\n\
 935 \n\
 936 Usage: compile code [OPTION]... [CODE]\n\
 937 \n\
 938 Options:\n\
 939 %OPTIONS%\n\
 940 \n\
 941 The source code may be specified as a simple one line expression, e.g.:\n\
 942 \n\
 943     compile code printf(\"Hello world\\n\");\n\
 944 \n\
 945 Alternatively, you can type a multiline expression by invoking\n\
 946 this command with no argument.  GDB will then prompt for the\n\
 947 expression interactively; type a line containing \"end\" to\n\
 948 indicate the end of the expression."),
 949                                compile_opts);
 950
 951   c = add_cmd ("code", class_obscure, compile_code_command,
 952                compile_code_help.c_str (),
 953                &compile_command_list);
 954   set_cmd_completer_handle_brkchars (c, compile_code_command_completer);
 955
 956 static const std::string compile_file_help
 957     = gdb::option::build_help (_("\
 958 Evaluate a file containing source code.\n\
 959 \n\
 960 Usage: compile file [OPTION].. [FILENAME]\n\
 961 \n\
 962 Options:\n\
 963 %OPTIONS%"),
 964                                compile_opts);
 965
 966   c = add_cmd ("file", class_obscure, compile_file_command,
 967                compile_file_help.c_str (),
 968                &compile_command_list);
 969   set_cmd_completer_handle_brkchars (c, compile_file_command_completer);
 970
 971   const auto compile_print_opts = make_value_print_options_def_group (nullptr);
 972
 973   static const std::string compile_print_help
 974     = gdb::option::build_help (_("\
 975 Evaluate EXPR by using the compiler and print result.\n\
 976 \n\
 977 Usage: compile print [[OPTION]... --] [/FMT] [EXPR]\n\
 978 \n\
 979 Options:\n\
 980 %OPTIONS%\n\
 981 \n\
 982 Note: because this command accepts arbitrary expressions, if you\n\
 983 specify any command option, you must use a double dash (\"--\")\n\
 984 to mark the end of option processing.  E.g.: \"compile print -o -- myobj\".\n\
 985 \n\
 986 The expression may be specified on the same line as the command, e.g.:\n\
 987 \n\
 988     compile print i\n\
 989 \n\
 990 Alternatively, you can type a multiline expression by invoking\n\
 991 this command with no argument.  GDB will then prompt for the\n\
 992 expression interactively; type a line containing \"end\" to\n\
 993 indicate the end of the expression.\n\
 994 \n\
 995 EXPR may be preceded with /FMT, where FMT is a format letter\n\
 996 but no count or size letter (see \"x\" command)."),
 997                                compile_print_opts);
 998
 999   c = add_cmd ("print", class_obscure, compile_print_command,
1000                compile_print_help.c_str (),
1001                &compile_command_list);
1002   set_cmd_completer_handle_brkchars (c, print_command_completer);
1003
1004   add_setshow_boolean_cmd ("compile", class_maintenance, &compile_debug, _("\
1005 Set compile command debugging."), _("\
1006 Show compile command debugging."), _("\
1007 When on, compile command debugging is enabled."),
1008                            NULL, show_compile_debug,
1009                            &setdebuglist, &showdebuglist);
1010
1011   add_setshow_string_cmd ("compile-args", class_support,
1012                           &compile_args,
1013                           _("Set compile command GCC command-line arguments."),
1014                           _("Show compile command GCC command-line arguments."),
1015                           _("\
1016 Use options like -I (include file directory) or ABI settings.\n\
1017 String quoting is parsed like in shell, for example:\n\
1018   -mno-align-double \"-I/dir with a space/include\""),
1019                           set_compile_args, show_compile_args, &setlist, &showlist);
1020
1021   /* Override flags possibly coming from DW_AT_producer.  */
1022   compile_args = xstrdup ("-O0 -gdwarf-4"
1023   /* We use -fPIE Otherwise GDB would need to reserve space large enough for
1024      any object file in the inferior in advance to get the final address when
1025      to link the object file to and additionally the default system linker
1026      script would need to be modified so that one can specify there the
1027      absolute target address.
1028      -fPIC is not used at is would require from GDB to generate .got.  */
1029                          " -fPIE"
1030   /* We want warnings, except for some commonly happening for GDB commands.  */
1031                          " -Wall "
1032                          " -Wno-unused-but-set-variable"
1033                          " -Wno-unused-variable"
1034   /* Override CU's possible -fstack-protector-strong.  */
1035                          " -fno-stack-protector"
1036   );
1037   set_compile_args (compile_args, 0, NULL);
1038
1039   add_setshow_optional_filename_cmd ("compile-gcc", class_support,
1040                                      &compile_gcc,
1041                                      _("Set compile command "
1042                                        "GCC driver filename."),
1043                                      _("Show compile command "
1044                                        "GCC driver filename."),
1045                                      _("\
1046 It should be absolute filename of the gcc executable.\n\
1047 If empty the default target triplet will be searched in $PATH."),
1048                                      NULL, show_compile_gcc, &setlist,
1049                                      &showlist);
1050   compile_gcc = xstrdup ("");
1051 }