diff options
author | Doug Evans <xdje42@gmail.com> | 2015-01-31 12:01:13 -0800 |
---|---|---|
committer | Doug Evans <xdje42@gmail.com> | 2015-01-31 12:01:13 -0800 |
commit | 9f0500621b6a4908986394eb0fac151ef097f520 (patch) | |
tree | 36c8a7d7cb12d9cfe5afff2949ede1a252a91b48 /gdb/doc | |
parent | 312809f8838911dabff84d7ad3ccf341307d2b19 (diff) | |
download | gdb-9f0500621b6a4908986394eb0fac151ef097f520.zip gdb-9f0500621b6a4908986394eb0fac151ef097f520.tar.gz gdb-9f0500621b6a4908986394eb0fac151ef097f520.tar.bz2 |
Add support for inlining scripts into .debug_gdb_scripts.
include/gdb/ChangeLog:
* section-scripts.h: Remove "future extension" comment.
(SECTION_SCRIPT_ID_PYTHON_TEXT): New macro.
(SECTION_SCRIPT_ID_SCHEME_TEXT): New macro.
gdb/ChangeLog:
* NEWS: Mention inlined scripts in .debug_gdb_scripts section.
* auto-load.c: #include ctype.h.
(struct auto_load_pspace_info): Replace member loaded_scripts with
new members loaded_script_files, loaded_script_texts.
(auto_load_pspace_data_cleanup): Update.
(init_loaded_scripts_info): Update.
(get_auto_load_pspace_data_for_loading): Update.
(maybe_add_script_file): Renamed from maybe_add_script. All callers
updated.
(maybe_add_script_text): New function.
(clear_section_scripts): Update.
(source_script_file, execute_script_contents): New functions.
(source_section_scripts): Add support for
SECTION_SCRIPT_ID_PYTHON_TEXT, SECTION_SCRIPT_ID_GUILE_TEXT.
(print_scripts): New function.
(auto_load_info_scripts): Also print inlined scripts.
(maybe_print_unsupported_script_warning): Renamed from
unsupported_script_warning_print. All callers updated.
(maybe_print_script_not_found_warning): Renamed from
script_not_found_warning_print. All callers updated.
* extension-priv.h (struct extension_language_script_ops): New member
objfile_script_executor.
* extension.c (ext_lang_objfile_script_executor): New function.
* extension.h (objfile_script_executor_func): New typedef.
(ext_lang_objfile_script_executor): Declare.
* guile/guile-internal.h (gdbscm_execute_objfile_script): Declare.
* guile/guile.c (guile_extension_script_ops): Update.
* guile/scm-objfile.c (gdbscm_execute_objfile_script): New function.
* python/python.c (python_extension_script_ops): Update.
(gdbpy_execute_objfile_script): New function.
gdb/doc/ChangeLog:
* gdb.texinfo (dotdebug_gdb_scripts section): Update docs to
distinguish script files vs inlined scripts.
* python.texi (Python Auto-loading): Ditto.
gdb/testsuite/ChangeLog:
* gdb.guile/scm-section-script.c: Add duplicate inlined section script
entries. Duplicate file section script entries.
* gdb.guile/scm-section-script.exp: Add tests for duplicate entries,
inlined entries. Add test for safe-path rejection.
* gdb.python/py-section-script.c: Add duplicate inlined section script
entries. Duplicate file section script entries.
* gdb.python/py-section-script.exp: Add tests for duplicate entries,
inlined entries. Add test for safe-path rejection.
Diffstat (limited to 'gdb/doc')
-rw-r--r-- | gdb/doc/ChangeLog | 6 | ||||
-rw-r--r-- | gdb/doc/gdb.texinfo | 63 | ||||
-rw-r--r-- | gdb/doc/python.texi | 7 |
3 files changed, 67 insertions, 9 deletions
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog index 82197b1..1dac8c6 100644 --- a/gdb/doc/ChangeLog +++ b/gdb/doc/ChangeLog @@ -1,3 +1,9 @@ +2015-01-31 Doug Evans <xdje42@gmail.com> + + * gdb.texinfo (dotdebug_gdb_scripts section): Update docs to + distinguish script files vs inlined scripts. + * python.texi (Python Auto-loading): Ditto. + 2015-01-30 Doug Evans <dje@google.com> * gdb.texinfo (Symbols) <info source>: Output now contains producer diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 2e58a53..61a317c 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -23977,17 +23977,29 @@ is evaluated more than once. For systems using file formats like ELF and COFF, when @value{GDBN} loads a new object file it will look for a special section named @code{.debug_gdb_scripts}. -If this section exists, its contents is a list of NUL-terminated names -of scripts to load. Each entry begins with a non-NULL prefix byte that -specifies the kind of entry, typically the extension language. +If this section exists, its contents is a list of null-terminated entries +specifying scripts to load. Each entry begins with a non-null prefix byte that +specifies the kind of entry, typically the extension language and whether the +script is in a file or inlined in @code{.debug_gdb_scripts}. -@value{GDBN} will look for each specified script file first in the -current directory and then along the source search path +The following entries are supported: + +@table @code +@item SECTION_SCRIPT_ID_PYTHON_FILE = 1 +@item SECTION_SCRIPT_ID_SCHEME_FILE = 3 +@item SECTION_SCRIPT_ID_PYTHON_TEXT = 4 +@item SECTION_SCRIPT_ID_SCHEME_TEXT = 6 +@end table + +@subsubsection Script File Entries + +If the entry specifies a file, @value{GDBN} will look for the file first +in the current directory and then along the source search path (@pxref{Source Path, ,Specifying Source Directories}), except that @file{$cdir} is not searched, since the compilation directory is not relevant to scripts. -Entries can be placed in section @code{.debug_gdb_scripts} with, +File entries can be placed in section @code{.debug_gdb_scripts} with, for example, this GCC macro for Python scripts. @example @@ -24019,6 +24031,45 @@ using this header will get a reference to the specified script, and with the use of @code{"MS"} attributes on the section, the linker will remove duplicates. +@subsubsection Script Text Entries + +Script text entries allow to put the executable script in the entry +itself instead of loading it from a file. +The first line of the entry, everything after the prefix byte and up to +the first newline (@code{0xa}) character, is the script name, and must not +contain any kind of space character, e.g., spaces or tabs. +The rest of the entry, up to the trailing null byte, is the script to +execute in the specified language. The name needs to be unique among +all script names, as @value{GDBN} executes each script only once based +on its name. + +Here is an example from file @file{py-section-script.c} in the @value{GDBN} +testsuite. + +@example +#include "symcat.h" +#include "gdb/section-scripts.h" +asm( +".pushsection \".debug_gdb_scripts\", \"MS\",@@progbits,1\n" +".byte " XSTRING (SECTION_SCRIPT_ID_PYTHON_TEXT) "\n" +".ascii \"gdb.inlined-script\\n\"\n" +".ascii \"class test_cmd (gdb.Command):\\n\"\n" +".ascii \" def __init__ (self):\\n\"\n" +".ascii \" super (test_cmd, self).__init__ (" + "\\\"test-cmd\\\", gdb.COMMAND_OBSCURE)\\n\"\n" +".ascii \" def invoke (self, arg, from_tty):\\n\"\n" +".ascii \" print (\\\"test-cmd output, arg = %s\\\" % arg)\\n\"\n" +".ascii \"test_cmd ()\\n\"\n" +".byte 0\n" +".popsection\n" +); +@end example + +Loading of inlined scripts requires a properly configured +@code{auto-load safe-path} (@pxref{Auto-loading safe path}). +The path to specify in @code{auto-load safe-path} is the path of the file +containing the @code{.debug_gdb_scripts} section. + @node Which flavor to choose? @subsection Which flavor to choose? diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index 7c04af7..d725eb0 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -4754,8 +4754,9 @@ Show whether auto-loading of Python scripts is enabled or disabled. Print the list of all Python scripts that @value{GDBN} auto-loaded. Also printed is the list of Python scripts that were mentioned in -the @code{.debug_gdb_scripts} section and were not found -(@pxref{dotdebug_gdb_scripts section}). +the @code{.debug_gdb_scripts} section and were either not found +(@pxref{dotdebug_gdb_scripts section}) or were not auto-loaded due to +@code{auto-load safe-path} rejection (@pxref{Auto-loading}). This is useful because their names are not printed when @value{GDBN} tries to load them and fails. There may be many of them, and printing an error message for each one is problematic. @@ -4773,7 +4774,7 @@ No my-foo-pretty-printers.py @end smallexample @end table -When reading an auto-loaded file, @value{GDBN} sets the +When reading an auto-loaded file or script, @value{GDBN} sets the @dfn{current objfile}. This is available via the @code{gdb.current_objfile} function (@pxref{Objfiles In Python}). This can be useful for registering objfile-specific pretty-printers and frame-filters. |