X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=gdb%2Fextension.h;h=47839ea50beb7dc3257b9cf1c571038a572a267e;hb=0d02e70b197c786f26175b9a73f94e01d14abdab;hp=a53f0a7c6ef85104188aa471dfcbc19a7cf6706b;hpb=32d0add0a654c1204ab71dc8a55d9374538c4b33;p=binutils-gdb.git diff --git a/gdb/extension.h b/gdb/extension.h index a53f0a7c6ef..47839ea50be 100644 --- a/gdb/extension.h +++ b/gdb/extension.h @@ -1,6 +1,6 @@ /* Interface between gdb and its extension languages. - Copyright (C) 2014-2015 Free Software Foundation, Inc. + Copyright (C) 2014-2022 Free Software Foundation, Inc. This file is part of GDB. @@ -21,7 +21,8 @@ #define EXTENSION_H #include "mi/mi-cmds.h" /* For PRINT_NO_VALUES, etc. */ -#include "common/vec.h" +#include "gdbsupport/array-view.h" +#include "gdbsupport/gdb_optional.h" struct breakpoint; struct command_line; @@ -48,6 +49,12 @@ typedef void objfile_script_sourcer_func (const struct extension_language_defn *, struct objfile *, FILE *stream, const char *filename); +/* A function to execute a script for an objfile. + Any exceptions are not caught, and are passed to the caller. */ +typedef void objfile_script_executor_func + (const struct extension_language_defn *, + struct objfile *, const char *name, const char *script); + /* Enum of each extension(/scripting) language. */ enum extension_language @@ -70,32 +77,36 @@ enum ext_lang_bt_status succeeded. */ EXT_LANG_BT_OK = 1, - /* Return when the frame filter process is complete, and all - operations have succeeded. */ - EXT_LANG_BT_COMPLETED = 2, - /* Return when the frame filter process is complete, but there were no filter registered and enabled to process. */ - EXT_LANG_BT_NO_FILTERS = 3 + EXT_LANG_BT_NO_FILTERS = 2 }; /* Flags to pass to apply_extlang_frame_filter. */ -enum frame_filter_flags +enum frame_filter_flag { /* Set this flag if frame level is to be printed. */ - PRINT_LEVEL = 1, + PRINT_LEVEL = 1 << 0, /* Set this flag if frame information is to be printed. */ - PRINT_FRAME_INFO = 2, + PRINT_FRAME_INFO = 1 << 1, /* Set this flag if frame arguments are to be printed. */ - PRINT_ARGS = 4, + PRINT_ARGS = 1 << 2, /* Set this flag if frame locals are to be printed. */ - PRINT_LOCALS = 8, + PRINT_LOCALS = 1 << 3, + + /* Set this flag if a "More frames" message is to be printed. */ + PRINT_MORE_FRAMES = 1 << 4, + + /* Set this flag if elided frames should not be printed. */ + PRINT_HIDE = 1 << 5, }; +DEF_ENUM_FLAGS_TYPE (enum frame_filter_flag, frame_filter_flags); + /* A choice of the different frame argument printing strategies that can occur in different cases of frame filter instantiation. */ @@ -114,7 +125,10 @@ enum ext_lang_frame_args CLI_SCALAR_VALUES, /* Print all values for arguments when invoked from the CLI. */ - CLI_ALL_VALUES + CLI_ALL_VALUES, + + /* Only indicate the presence of arguments when invoked from the CLI. */ + CLI_PRESENCE }; /* The possible results of @@ -136,30 +150,84 @@ enum ext_lang_bp_stop struct ext_lang_type_printers { + ext_lang_type_printers (); + ~ext_lang_type_printers (); + + DISABLE_COPY_AND_ASSIGN (ext_lang_type_printers); + /* Type-printers from Python. */ - void *py_type_printers; + void *py_type_printers = nullptr; +}; + +/* The return code for some API calls. */ + +enum ext_lang_rc +{ + /* The operation completed successfully. */ + EXT_LANG_RC_OK, + + /* The operation was not performed (e.g., no pretty-printer). */ + EXT_LANG_RC_NOP, + + /* There was an error (e.g., Python error while printing a value). + When an error occurs no further extension languages are tried. + This is to preserve existing behaviour, and because it's convenient + for Python developers. + Note: This is different than encountering a memory error trying to read + a value for pretty-printing. Here we're referring to, e.g., programming + errors that trigger an exception in the extension language. */ + EXT_LANG_RC_ERROR }; /* A type which holds its extension language specific xmethod worker data. */ struct xmethod_worker { - /* The language the xmethod worker is implemented in. */ - const struct extension_language_defn *extlang; + xmethod_worker (const extension_language_defn *extlang) + : m_extlang (extlang) + {} + + virtual ~xmethod_worker () = default; + + /* Invoke the xmethod encapsulated in this worker and return the result. + The method is invoked on OBJ with arguments in the ARGS array. */ + + virtual value *invoke (value *obj, gdb::array_view args) = 0; - /* The extension language specific data for this xmethod worker. */ - void *data; + /* Return the arg types of the xmethod encapsulated in this worker. + The type of the 'this' object is returned as the first element of + the vector. */ - /* The TYPE_CODE_XMETHOD value corresponding to this worker. - Always use value_of_xmethod to access it. */ - struct value *value; + std::vector get_arg_types (); + + /* Return the type of the result of the xmethod encapsulated in this worker. + OBJECT and ARGS are the same as for invoke. */ + + type *get_result_type (value *object, gdb::array_view args); + +private: + + /* Return the types of the arguments the method takes. The types + are returned in TYPE_ARGS, one per argument. */ + + virtual enum ext_lang_rc do_get_arg_types + (std::vector *type_args) = 0; + + /* Fetch the type of the result of the method implemented by this + worker. OBJECT and ARGS are the same as for the invoked method. + The result type is stored in *RESULT_TYPE. */ + + virtual enum ext_lang_rc do_get_result_type + (struct value *obj, gdb::array_view args, + struct type **result_type_ptr) = 0; + + /* The language the xmethod worker is implemented in. */ + + const extension_language_defn *m_extlang; }; -typedef struct xmethod_worker *xmethod_worker_ptr; -DEF_VEC_P (xmethod_worker_ptr); -typedef VEC (xmethod_worker_ptr) xmethod_worker_vec; +typedef std::unique_ptr xmethod_worker_up; - /* The interface for gdb's own extension(/scripting) language. */ extern const struct extension_language_defn extension_language_gdb; @@ -197,33 +265,34 @@ extern script_sourcer_func *ext_lang_script_sourcer extern objfile_script_sourcer_func *ext_lang_objfile_script_sourcer (const struct extension_language_defn *); -extern int ext_lang_auto_load_enabled (const struct extension_language_defn *); +extern objfile_script_executor_func *ext_lang_objfile_script_executor + (const struct extension_language_defn *); + +/* Return true if auto-loading of EXTLANG scripts is enabled. + False is returned if support for this language isn't compiled in. */ + +extern bool ext_lang_auto_load_enabled (const struct extension_language_defn *); /* Wrappers for each extension language API function that iterate over all extension languages. */ -extern void finish_ext_lang_initialization (void); +extern void ext_lang_initialization (void); extern void eval_ext_lang_from_control_command (struct command_line *cmd); extern void auto_load_ext_lang_scripts_for_objfile (struct objfile *); -extern struct ext_lang_type_printers *start_ext_lang_type_printers (void); - extern char *apply_ext_lang_type_printers (struct ext_lang_type_printers *, struct type *); -extern void free_ext_lang_type_printers (struct ext_lang_type_printers *); - extern int apply_ext_lang_val_pretty_printer - (struct type *type, const gdb_byte *valaddr, - int embedded_offset, CORE_ADDR address, - struct ui_file *stream, int recurse, - const struct value *val, const struct value_print_options *options, + (struct value *value, struct ui_file *stream, int recurse, + const struct value_print_options *options, const struct language_defn *language); extern enum ext_lang_bt_status apply_ext_lang_frame_filter - (struct frame_info *frame, int flags, enum ext_lang_frame_args args_type, + (struct frame_info *frame, frame_filter_flags flags, + enum ext_lang_frame_args args_type, struct ui_out *out, int frame_low, int frame_high); extern void preserve_ext_lang_values (struct objfile *, htab_t copied_types); @@ -233,22 +302,45 @@ extern const struct extension_language_defn *get_breakpoint_cond_ext_lang extern int breakpoint_ext_lang_cond_says_stop (struct breakpoint *); -extern struct value *invoke_xmethod (struct xmethod_worker *, - struct value *, - struct value **, int nargs); +/* If a method with name METHOD_NAME is to be invoked on an object of type + TYPE, then all extension languages are searched for implementations of + methods with name METHOD_NAME. All matches found are appended to the WORKERS + vector. */ + +extern void get_matching_xmethod_workers + (struct type *type, const char *method_name, + std::vector *workers); + +/* Try to colorize some source code. FILENAME is the name of the file + holding the code. CONTENTS is the source code itself. This will + either a colorized (using ANSI terminal escapes) version of the + source code, or an empty value if colorizing could not be done. */ + +extern gdb::optional ext_lang_colorize + (const std::string &filename, const std::string &contents); -extern struct xmethod_worker *clone_xmethod_worker (struct xmethod_worker *); +/* Try to colorize a single line of disassembler output, CONTENT for + GDBARCH. This will return either a colorized (using ANSI terminal + escapes) version of CONTENT, or an empty value if colorizing could not + be done. */ -extern struct xmethod_worker *new_xmethod_worker - (const struct extension_language_defn *extlang, void *data); +extern gdb::optional ext_lang_colorize_disasm + (const std::string &content, gdbarch *gdbarch); -extern void free_xmethod_worker (struct xmethod_worker *); +/* Calls extension_language_ops::print_insn for each extension language, + returning the result from the first extension language that returns a + non-empty result (any further extension languages are not then called). -extern void free_xmethod_worker_vec (void *vec); + All arguments are forwarded to extension_language_ops::print_insn, see + that function for a full description. */ -extern xmethod_worker_vec *get_matching_xmethod_workers - (struct type *, const char *); +extern gdb::optional ext_lang_print_insn + (struct gdbarch *gdbarch, CORE_ADDR address, struct disassemble_info *info); -extern struct type **get_xmethod_arg_types (struct xmethod_worker *, int *); +#if GDB_SELF_TEST +namespace selftests { +extern void (*hook_set_active_ext_lang) (); +} +#endif #endif /* EXTENSION_H */