1 /* General Compile and inject code
3 Copyright (C) 2014-2017 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "cli/cli-script.h"
25 #include "cli/cli-utils.h"
26 #include "completer.h"
29 #include "compile-internal.h"
30 #include "compile-object-load.h"
31 #include "compile-object-run.h"
36 #include "arch-utils.h"
37 #include "filestuff.h"
42 #include "common/gdb_optional.h"
43 #include "common/gdb_unlinker.h"
47 /* Initial filename for temporary files. */
49 #define TMP_PREFIX "/tmp/gdbobj-"
51 /* Hold "compile" commands. */
53 static struct cmd_list_element
*compile_command_list
;
55 /* Debug flag for "compile" commands. */
59 /* Implement "show debug compile". */
62 show_compile_debug (struct ui_file
*file
, int from_tty
,
63 struct cmd_list_element
*c
, const char *value
)
65 fprintf_filtered (file
, _("Compile debugging is %s.\n"), value
);
70 /* Check *ARG for a "-raw" or "-r" argument. Return 0 if not seen.
71 Return 1 if seen and update *ARG. */
74 check_raw_argument (char **arg
)
76 *arg
= skip_spaces (*arg
);
79 && (check_for_argument (arg
, "-raw", sizeof ("-raw") - 1)
80 || check_for_argument (arg
, "-r", sizeof ("-r") - 1)))
85 /* Handle the input from the 'compile file' command. The "compile
86 file" command is used to evaluate an expression contained in a file
87 that may contain calls to the GCC compiler. */
90 compile_file_command (char *arg
, int from_tty
)
92 enum compile_i_scope_types scope
= COMPILE_I_SIMPLE_SCOPE
;
94 struct cleanup
*cleanup
;
96 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
98 /* Check the user did not just <enter> after command. */
100 error (_("You must provide a filename for this command."));
102 /* Check if a raw (-r|-raw) argument is provided. */
103 if (arg
!= NULL
&& check_raw_argument (&arg
))
105 scope
= COMPILE_I_RAW_SCOPE
;
106 arg
= skip_spaces (arg
);
109 /* After processing arguments, check there is a filename at the end
112 error (_("You must provide a filename with the raw option set."));
115 error (_("Unknown argument specified."));
117 arg
= skip_spaces (arg
);
118 arg
= gdb_abspath (arg
);
119 cleanup
= make_cleanup (xfree
, arg
);
120 buffer
= xstrprintf ("#include \"%s\"\n", arg
);
121 make_cleanup (xfree
, buffer
);
122 eval_compile_command (NULL
, buffer
, scope
, NULL
);
123 do_cleanups (cleanup
);
126 /* Handle the input from the 'compile code' command. The
127 "compile code" command is used to evaluate an expression that may
128 contain calls to the GCC compiler. The language expected in this
129 compile command is the language currently set in GDB. */
132 compile_code_command (char *arg
, int from_tty
)
134 enum compile_i_scope_types scope
= COMPILE_I_SIMPLE_SCOPE
;
136 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
138 if (arg
!= NULL
&& check_raw_argument (&arg
))
140 scope
= COMPILE_I_RAW_SCOPE
;
141 arg
= skip_spaces (arg
);
144 arg
= skip_spaces (arg
);
146 if (arg
!= NULL
&& !check_for_argument (&arg
, "--", sizeof ("--") - 1))
149 error (_("Unknown argument specified."));
153 eval_compile_command (NULL
, arg
, scope
, NULL
);
156 command_line_up l
= get_command_line (compile_control
, "");
158 l
->control_u
.compile
.scope
= scope
;
159 execute_control_command_untraced (l
.get ());
163 /* Callback for compile_print_command. */
166 compile_print_value (struct value
*val
, void *data_voidp
)
168 const struct format_data
*fmtp
= (const struct format_data
*) data_voidp
;
170 print_value (val
, fmtp
);
173 /* Handle the input from the 'compile print' command. The "compile
174 print" command is used to evaluate and print an expression that may
175 contain calls to the GCC compiler. The language expected in this
176 compile command is the language currently set in GDB. */
179 compile_print_command (char *arg_param
, int from_tty
)
181 const char *arg
= arg_param
;
182 enum compile_i_scope_types scope
= COMPILE_I_PRINT_ADDRESS_SCOPE
;
183 struct format_data fmt
;
185 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
187 /* Passing &FMT as SCOPE_DATA is safe as do_module_cleanup will not
188 touch the stale pointer if compile_object_run has already quit. */
189 print_command_parse_format (&arg
, "compile print", &fmt
);
192 eval_compile_command (NULL
, arg
, scope
, &fmt
);
195 command_line_up l
= get_command_line (compile_control
, "");
197 l
->control_u
.compile
.scope
= scope
;
198 l
->control_u
.compile
.scope_data
= &fmt
;
199 execute_control_command_untraced (l
.get ());
203 /* A cleanup function to remove a directory and all its contents. */
208 const char *dir
= (const char *) arg
;
212 gdb_assert (startswith (dir
, TMP_PREFIX
));
213 zap
= concat ("rm -rf ", dir
, (char *) NULL
);
214 wstat
= system (zap
);
215 if (wstat
== -1 || !WIFEXITED (wstat
) || WEXITSTATUS (wstat
) != 0)
216 warning (_("Could not remove temporary directory %s"), dir
);
220 /* Return the name of the temporary directory to use for .o files, and
221 arrange for the directory to be removed at shutdown. */
224 get_compile_file_tempdir (void)
226 static char *tempdir_name
;
228 #define TEMPLATE TMP_PREFIX "XXXXXX"
229 char tname
[sizeof (TEMPLATE
)];
231 if (tempdir_name
!= NULL
)
234 strcpy (tname
, TEMPLATE
);
237 tempdir_name
= mkdtemp (tname
);
239 error (_("Command not supported on this host."));
241 if (tempdir_name
== NULL
)
242 perror_with_name (_("Could not make temporary directory"));
244 tempdir_name
= xstrdup (tempdir_name
);
245 make_final_cleanup (do_rmdir
, tempdir_name
);
249 /* Compute the names of source and object files to use. */
251 static compile_file_names
252 get_new_file_names ()
255 const char *dir
= get_compile_file_tempdir ();
259 return compile_file_names (string_printf ("%s%sout%d.c",
260 dir
, SLASH_STRING
, seq
),
261 string_printf ("%s%sout%d.o",
262 dir
, SLASH_STRING
, seq
));
265 /* Get the block and PC at which to evaluate an expression. */
267 static const struct block
*
268 get_expr_block_and_pc (CORE_ADDR
*pc
)
270 const struct block
*block
= get_selected_block (pc
);
274 struct symtab_and_line cursal
= get_current_source_symtab_and_line ();
277 block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (cursal
.symtab
),
280 *pc
= BLOCK_START (block
);
283 *pc
= BLOCK_START (block
);
288 /* Call buildargv (via gdb_argv), set its result for S into *ARGVP but
289 calculate also the number of parsed arguments into *ARGCP. If
290 buildargv has returned NULL then *ARGCP is set to zero. */
293 build_argc_argv (const char *s
, int *argcp
, char ***argvp
)
297 *argcp
= args
.count ();
298 *argvp
= args
.release ();
301 /* String for 'set compile-args' and 'show compile-args'. */
302 static char *compile_args
;
304 /* Parsed form of COMPILE_ARGS. COMPILE_ARGS_ARGV is NULL terminated. */
305 static int compile_args_argc
;
306 static char **compile_args_argv
;
308 /* Implement 'set compile-args'. */
311 set_compile_args (char *args
, int from_tty
, struct cmd_list_element
*c
)
313 freeargv (compile_args_argv
);
314 build_argc_argv (compile_args
, &compile_args_argc
, &compile_args_argv
);
317 /* Implement 'show compile-args'. */
320 show_compile_args (struct ui_file
*file
, int from_tty
,
321 struct cmd_list_element
*c
, const char *value
)
323 fprintf_filtered (file
, _("Compile command command-line arguments "
328 /* Append ARGC and ARGV (as parsed by build_argc_argv) to *ARGCP and *ARGVP.
329 ARGCP+ARGVP can be zero+NULL and also ARGC+ARGV can be zero+NULL. */
332 append_args (int *argcp
, char ***argvp
, int argc
, char **argv
)
336 *argvp
= XRESIZEVEC (char *, *argvp
, (*argcp
+ argc
+ 1));
338 for (argi
= 0; argi
< argc
; argi
++)
339 (*argvp
)[(*argcp
)++] = xstrdup (argv
[argi
]);
340 (*argvp
)[(*argcp
)] = NULL
;
343 /* Return DW_AT_producer parsed for get_selected_frame () (if any).
344 Return NULL otherwise.
346 GCC already filters its command-line arguments only for the suitable ones to
347 put into DW_AT_producer - see GCC function gen_producer_string. */
350 get_selected_pc_producer_options (void)
352 CORE_ADDR pc
= get_frame_pc (get_selected_frame (NULL
));
353 struct compunit_symtab
*symtab
= find_pc_compunit_symtab (pc
);
356 if (symtab
== NULL
|| symtab
->producer
== NULL
357 || !startswith (symtab
->producer
, "GNU "))
360 cs
= symtab
->producer
;
361 while (*cs
!= 0 && *cs
!= '-')
362 cs
= skip_spaces_const (skip_to_space_const (cs
));
368 /* Filter out unwanted options from *ARGCP and ARGV. */
371 filter_args (int *argcp
, char **argv
)
375 for (destv
= argv
; *argv
!= NULL
; argv
++)
377 /* -fpreprocessed may get in commonly from ccache. */
378 if (strcmp (*argv
, "-fpreprocessed") == 0)
389 /* Produce final vector of GCC compilation options. First element is target
390 size ("-m64", "-m32" etc.), optionally followed by DW_AT_producer options
391 and then compile-args string GDB variable. */
394 get_args (const struct compile_instance
*compiler
, struct gdbarch
*gdbarch
,
395 int *argcp
, char ***argvp
)
397 const char *cs_producer_options
;
399 char **argv_compiler
;
401 build_argc_argv (gdbarch_gcc_target_options (gdbarch
),
404 cs_producer_options
= get_selected_pc_producer_options ();
405 if (cs_producer_options
!= NULL
)
408 char **argv_producer
;
410 build_argc_argv (cs_producer_options
, &argc_producer
, &argv_producer
);
411 filter_args (&argc_producer
, argv_producer
);
412 append_args (argcp
, argvp
, argc_producer
, argv_producer
);
413 freeargv (argv_producer
);
416 build_argc_argv (compiler
->gcc_target_options
,
417 &argc_compiler
, &argv_compiler
);
418 append_args (argcp
, argvp
, argc_compiler
, argv_compiler
);
419 freeargv (argv_compiler
);
421 append_args (argcp
, argvp
, compile_args_argc
, compile_args_argv
);
424 /* A cleanup function to destroy a gdb_gcc_instance. */
427 cleanup_compile_instance (void *arg
)
429 struct compile_instance
*inst
= (struct compile_instance
*) arg
;
431 inst
->destroy (inst
);
434 /* A helper function suitable for use as the "print_callback" in the
438 print_callback (void *ignore
, const char *message
)
440 fputs_filtered (message
, gdb_stderr
);
443 /* Process the compilation request. On success it returns the object
444 and source file names. On an error condition, error () is
447 static compile_file_names
448 compile_to_object (struct command_line
*cmd
, const char *cmd_string
,
449 enum compile_i_scope_types scope
)
451 struct compile_instance
*compiler
;
452 struct cleanup
*cleanup
;
453 const struct block
*expr_block
;
454 CORE_ADDR trash_pc
, expr_pc
;
459 struct gdbarch
*gdbarch
= get_current_arch ();
465 if (!target_has_execution
)
466 error (_("The program must be running for the compile command to "\
469 expr_block
= get_expr_block_and_pc (&trash_pc
);
470 expr_pc
= get_frame_address_in_block (get_selected_frame (NULL
));
472 /* Set up instance and context for the compiler. */
473 if (current_language
->la_get_compile_instance
== NULL
)
474 error (_("No compiler support for language %s."),
475 current_language
->la_name
);
476 compiler
= current_language
->la_get_compile_instance ();
477 cleanup
= make_cleanup (cleanup_compile_instance
, compiler
);
479 compiler
->fe
->ops
->set_print_callback (compiler
->fe
, print_callback
, NULL
);
481 compiler
->scope
= scope
;
482 compiler
->block
= expr_block
;
484 /* From the provided expression, build a scope to pass to the
487 string_file input_buf
;
492 struct command_line
*iter
;
494 for (iter
= cmd
->body_list
[0]; iter
; iter
= iter
->next
)
496 input_buf
.puts (iter
->line
);
497 input_buf
.puts ("\n");
500 input
= input_buf
.c_str ();
502 else if (cmd_string
!= NULL
)
505 error (_("Neither a simple expression, or a multi-line specified."));
508 = current_language
->la_compute_program (compiler
, input
, gdbarch
,
509 expr_block
, expr_pc
);
511 fprintf_unfiltered (gdb_stdlog
, "debug output:\n\n%s", code
.c_str ());
513 os_rx
= osabi_triplet_regexp (gdbarch_osabi (gdbarch
));
514 arch_rx
= gdbarch_gnu_triplet_regexp (gdbarch
);
516 /* Allow triplets with or without vendor set. */
517 triplet_rx
= concat (arch_rx
, "(-[^-]*)?-", os_rx
, (char *) NULL
);
518 make_cleanup (xfree
, triplet_rx
);
520 /* Set compiler command-line arguments. */
521 get_args (compiler
, gdbarch
, &argc
, &argv
);
522 gdb_argv
argv_holder (argv
);
524 error_message
= compiler
->fe
->ops
->set_arguments (compiler
->fe
, triplet_rx
,
526 if (error_message
!= NULL
)
528 make_cleanup (xfree
, error_message
);
529 error ("%s", error_message
);
536 fprintf_unfiltered (gdb_stdlog
, "Passing %d compiler options:\n", argc
);
537 for (argi
= 0; argi
< argc
; argi
++)
538 fprintf_unfiltered (gdb_stdlog
, "Compiler option %d: <%s>\n",
542 compile_file_names fnames
= get_new_file_names ();
544 gdb::optional
<gdb::unlinker
> source_remover
;
547 gdb_file_up src
= gdb_fopen_cloexec (fnames
.source_file (), "w");
549 perror_with_name (_("Could not open source file for writing"));
551 source_remover
.emplace (fnames
.source_file ());
553 if (fputs (code
.c_str (), src
.get ()) == EOF
)
554 perror_with_name (_("Could not write to source file"));
558 fprintf_unfiltered (gdb_stdlog
, "source file produced: %s\n\n",
559 fnames
.source_file ());
561 /* Call the compiler and start the compilation process. */
562 compiler
->fe
->ops
->set_source_file (compiler
->fe
, fnames
.source_file ());
564 if (!compiler
->fe
->ops
->compile (compiler
->fe
, fnames
.object_file (),
566 error (_("Compilation failed."));
569 fprintf_unfiltered (gdb_stdlog
, "object file produced: %s\n\n",
570 fnames
.object_file ());
572 /* Keep the source file. */
573 source_remover
->keep ();
575 do_cleanups (cleanup
);
580 /* The "compile" prefix command. */
583 compile_command (char *args
, int from_tty
)
585 /* If a sub-command is not specified to the compile prefix command,
586 assume it is a direct code compilation. */
587 compile_code_command (args
, from_tty
);
593 eval_compile_command (struct command_line
*cmd
, const char *cmd_string
,
594 enum compile_i_scope_types scope
, void *scope_data
)
596 struct compile_module
*compile_module
;
598 compile_file_names fnames
= compile_to_object (cmd
, cmd_string
, scope
);
600 gdb::unlinker
object_remover (fnames
.object_file ());
601 gdb::unlinker
source_remover (fnames
.source_file ());
603 compile_module
= compile_object_load (fnames
, scope
, scope_data
);
604 if (compile_module
== NULL
)
606 gdb_assert (scope
== COMPILE_I_PRINT_ADDRESS_SCOPE
);
607 eval_compile_command (cmd
, cmd_string
,
608 COMPILE_I_PRINT_VALUE_SCOPE
, scope_data
);
612 /* Keep the files. */
613 source_remover
.keep ();
614 object_remover
.keep ();
616 compile_object_run (compile_module
);
619 /* See compile/compile-internal.h. */
622 compile_register_name_mangled (struct gdbarch
*gdbarch
, int regnum
)
624 const char *regname
= gdbarch_register_name (gdbarch
, regnum
);
626 return xstrprintf ("__%s", regname
);
629 /* See compile/compile-internal.h. */
632 compile_register_name_demangle (struct gdbarch
*gdbarch
,
637 if (regname
[0] != '_' || regname
[1] != '_')
638 error (_("Invalid register name \"%s\"."), regname
);
641 for (regnum
= 0; regnum
< gdbarch_num_regs (gdbarch
); regnum
++)
642 if (strcmp (regname
, gdbarch_register_name (gdbarch
, regnum
)) == 0)
645 error (_("Cannot find gdbarch register \"%s\"."), regname
);
648 extern initialize_file_ftype _initialize_compile
;
651 _initialize_compile (void)
653 struct cmd_list_element
*c
= NULL
;
655 add_prefix_cmd ("compile", class_obscure
, compile_command
,
657 Command to compile source code and inject it into the inferior."),
658 &compile_command_list
, "compile ", 1, &cmdlist
);
659 add_com_alias ("expression", "compile", class_obscure
, 0);
661 add_cmd ("code", class_obscure
, compile_code_command
,
663 Compile, inject, and execute code.\n\
665 Usage: compile code [-r|-raw] [--] [CODE]\n\
666 -r|-raw: Suppress automatic 'void _gdb_expr () { CODE }' wrapping.\n\
667 --: Do not parse any options beyond this delimiter. All text to the\n\
668 right will be treated as source code.\n\
670 The source code may be specified as a simple one line expression, e.g.:\n\
672 compile code printf(\"Hello world\\n\");\n\
674 Alternatively, you can type a multiline expression by invoking\n\
675 this command with no argument. GDB will then prompt for the\n\
676 expression interactively; type a line containing \"end\" to\n\
677 indicate the end of the expression."),
678 &compile_command_list
);
680 c
= add_cmd ("file", class_obscure
, compile_file_command
,
682 Evaluate a file containing source code.\n\
684 Usage: compile file [-r|-raw] [filename]\n\
685 -r|-raw: Suppress automatic 'void _gdb_expr () { CODE }' wrapping."),
686 &compile_command_list
);
687 set_cmd_completer (c
, filename_completer
);
689 add_cmd ("print", class_obscure
, compile_print_command
,
691 Evaluate EXPR by using the compiler and print result.\n\
693 Usage: compile print[/FMT] [EXPR]\n\
695 The expression may be specified on the same line as the command, e.g.:\n\
699 Alternatively, you can type a multiline expression by invoking\n\
700 this command with no argument. GDB will then prompt for the\n\
701 expression interactively; type a line containing \"end\" to\n\
702 indicate the end of the expression.\n\
704 EXPR may be preceded with /FMT, where FMT is a format letter\n\
705 but no count or size letter (see \"x\" command)."),
706 &compile_command_list
);
708 add_setshow_boolean_cmd ("compile", class_maintenance
, &compile_debug
, _("\
709 Set compile command debugging."), _("\
710 Show compile command debugging."), _("\
711 When on, compile command debugging is enabled."),
712 NULL
, show_compile_debug
,
713 &setdebuglist
, &showdebuglist
);
715 add_setshow_string_cmd ("compile-args", class_support
,
717 _("Set compile command GCC command-line arguments"),
718 _("Show compile command GCC command-line arguments"),
720 Use options like -I (include file directory) or ABI settings.\n\
721 String quoting is parsed like in shell, for example:\n\
722 -mno-align-double \"-I/dir with a space/include\""),
723 set_compile_args
, show_compile_args
, &setlist
, &showlist
);
725 /* Override flags possibly coming from DW_AT_producer. */
726 compile_args
= xstrdup ("-O0 -gdwarf-4"
727 /* We use -fPIE Otherwise GDB would need to reserve space large enough for
728 any object file in the inferior in advance to get the final address when
729 to link the object file to and additionally the default system linker
730 script would need to be modified so that one can specify there the
731 absolute target address.
732 -fPIC is not used at is would require from GDB to generate .got. */
734 /* We want warnings, except for some commonly happening for GDB commands. */
736 " -Wno-implicit-function-declaration"
737 " -Wno-unused-but-set-variable"
738 " -Wno-unused-variable"
739 /* Override CU's possible -fstack-protector-strong. */
740 " -fno-stack-protector"
742 set_compile_args (compile_args
, 0, NULL
);