1 /* Interface between gdb and its extension languages.
3 Copyright (C) 2014-2024 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/>. */
20 /* Note: With few exceptions, external functions and variables in this file
21 have "ext_lang" in the name, and no other symbol in gdb does. */
25 #include "auto-load.h"
26 #include "breakpoint.h"
27 #include "event-top.h"
28 #include "extension.h"
29 #include "extension-priv.h"
30 #include "observable.h"
31 #include "cli/cli-script.h"
32 #include "python/python.h"
33 #include "guile/guile.h"
37 static script_sourcer_func source_gdb_script
;
38 static objfile_script_sourcer_func source_gdb_objfile_script
;
40 /* GDB's own scripting language.
41 This exists, in part, to support auto-loading ${prog}-gdb.gdb scripts. */
43 static const struct extension_language_script_ops
44 extension_language_gdb_script_ops
=
47 source_gdb_objfile_script
,
48 NULL
, /* objfile_script_executor */
49 auto_load_gdb_scripts_enabled
52 const struct extension_language_defn extension_language_gdb
=
58 /* We fall back to interpreting a script as a GDB script if it doesn't
59 match the other scripting languages, but for consistency's sake
60 give it a formal suffix. */
64 /* cli_control_type: This is never used: GDB's own scripting language
65 has a variety of control types (if, while, etc.). */
68 &extension_language_gdb_script_ops
,
70 /* The rest of the extension language interface isn't supported by GDB's own
71 extension/scripting language. */
75 /* NULL-terminated table of all external (non-native) extension languages.
77 The order of appearance in the table is important.
78 When multiple extension languages provide the same feature, for example
79 a pretty-printer for a particular type, which one gets used?
80 The algorithm employed here is "the first one wins". For example, in
81 the case of pretty-printers this means the first one to provide a
82 pretty-printed value is the one that is used. This algorithm is employed
85 static const std::array
<const extension_language_defn
*, 2> extension_languages
87 /* To preserve existing behaviour, python should always appear first. */
88 &extension_language_python
,
89 &extension_language_guile
,
92 /* Return a pointer to the struct extension_language_defn object of
93 extension language LANG.
94 This always returns a non-NULL pointer, even if support for the language
95 is not compiled into this copy of GDB. */
97 const struct extension_language_defn
*
98 get_ext_lang_defn (enum extension_language lang
)
100 gdb_assert (lang
!= EXT_LANG_NONE
);
102 if (lang
== EXT_LANG_GDB
)
103 return &extension_language_gdb
;
105 for (const struct extension_language_defn
*extlang
: extension_languages
)
107 if (extlang
->language
== lang
)
111 gdb_assert_not_reached ("unable to find extension_language_defn");
114 /* Return TRUE if FILE has extension EXTENSION. */
117 has_extension (const char *file
, const char *extension
)
119 int file_len
= strlen (file
);
120 int extension_len
= strlen (extension
);
122 return (file_len
> extension_len
123 && strcmp (&file
[file_len
- extension_len
], extension
) == 0);
126 /* Return the extension language of FILE, or NULL if
127 the extension language of FILE is not recognized.
128 This is done by looking at the file's suffix. */
130 const struct extension_language_defn
*
131 get_ext_lang_of_file (const char *file
)
133 if (has_extension (file
, extension_language_gdb
.suffix
))
134 return &extension_language_gdb
;
136 for (const struct extension_language_defn
*extlang
: extension_languages
)
138 if (has_extension (file
, extlang
->suffix
))
145 /* Return non-zero if support for the specified extension language
149 ext_lang_present_p (const struct extension_language_defn
*extlang
)
151 return extlang
->script_ops
!= NULL
;
154 /* Return non-zero if the specified extension language has successfully
158 ext_lang_initialized_p (const struct extension_language_defn
*extlang
)
160 if (extlang
->ops
!= NULL
)
162 /* This method is required. */
163 gdb_assert (extlang
->ops
->initialized
!= NULL
);
164 return extlang
->ops
->initialized (extlang
);
170 /* Throw an error indicating EXTLANG is not supported in this copy of GDB. */
173 throw_ext_lang_unsupported (const struct extension_language_defn
*extlang
)
175 error (_("Scripting in the \"%s\" language is not supported"
176 " in this copy of GDB."),
177 ext_lang_capitalized_name (extlang
));
180 /* Methods for GDB's own extension/scripting language. */
182 /* The extension_language_script_ops.script_sourcer "method". */
185 source_gdb_script (const struct extension_language_defn
*extlang
,
186 FILE *stream
, const char *file
)
188 script_from_file (stream
, file
);
191 /* The extension_language_script_ops.objfile_script_sourcer "method". */
194 source_gdb_objfile_script (const struct extension_language_defn
*extlang
,
195 struct objfile
*objfile
,
196 FILE *stream
, const char *file
)
198 script_from_file (stream
, file
);
201 /* Accessors for "public" attributes of struct extension_language. */
203 /* Return the "name" field of EXTLANG. */
206 ext_lang_name (const struct extension_language_defn
*extlang
)
208 return extlang
->name
;
211 /* Return the "capitalized_name" field of EXTLANG. */
214 ext_lang_capitalized_name (const struct extension_language_defn
*extlang
)
216 return extlang
->capitalized_name
;
219 /* Return the "suffix" field of EXTLANG. */
222 ext_lang_suffix (const struct extension_language_defn
*extlang
)
224 return extlang
->suffix
;
227 /* Return the "auto_load_suffix" field of EXTLANG. */
230 ext_lang_auto_load_suffix (const struct extension_language_defn
*extlang
)
232 return extlang
->auto_load_suffix
;
235 /* extension_language_script_ops wrappers. */
237 /* Return the script "sourcer" function for EXTLANG.
238 This is the function that loads and processes a script.
239 If support for this language isn't compiled in, NULL is returned. */
241 script_sourcer_func
*
242 ext_lang_script_sourcer (const struct extension_language_defn
*extlang
)
244 if (extlang
->script_ops
== NULL
)
247 /* The extension language is required to implement this function. */
248 gdb_assert (extlang
->script_ops
->script_sourcer
!= NULL
);
250 return extlang
->script_ops
->script_sourcer
;
253 /* Return the objfile script "sourcer" function for EXTLANG.
254 This is the function that loads and processes a script for a particular
256 If support for this language isn't compiled in, NULL is returned. */
258 objfile_script_sourcer_func
*
259 ext_lang_objfile_script_sourcer (const struct extension_language_defn
*extlang
)
261 if (extlang
->script_ops
== NULL
)
264 /* The extension language is required to implement this function. */
265 gdb_assert (extlang
->script_ops
->objfile_script_sourcer
!= NULL
);
267 return extlang
->script_ops
->objfile_script_sourcer
;
270 /* Return the objfile script "executor" function for EXTLANG.
271 This is the function that executes a script for a particular objfile.
272 If support for this language isn't compiled in, NULL is returned.
273 The extension language is not required to implement this function. */
275 objfile_script_executor_func
*
276 ext_lang_objfile_script_executor
277 (const struct extension_language_defn
*extlang
)
279 if (extlang
->script_ops
== NULL
)
282 return extlang
->script_ops
->objfile_script_executor
;
285 /* See extension.h. */
288 ext_lang_auto_load_enabled (const struct extension_language_defn
*extlang
)
290 if (extlang
->script_ops
== NULL
)
293 /* The extension language is required to implement this function. */
294 gdb_assert (extlang
->script_ops
->auto_load_enabled
!= NULL
);
296 return extlang
->script_ops
->auto_load_enabled (extlang
);
300 /* RAII class used to temporarily return SIG to its default handler. */
303 struct scoped_default_signal
305 scoped_default_signal ()
306 { m_old_sig_handler
= signal (SIG
, SIG_DFL
); }
308 ~scoped_default_signal ()
309 { signal (SIG
, m_old_sig_handler
); }
311 DISABLE_COPY_AND_ASSIGN (scoped_default_signal
);
314 /* The previous signal handler that needs to be restored. */
315 sighandler_t m_old_sig_handler
;
318 /* Class to temporarily return SIGINT to its default handler. */
320 using scoped_default_sigint
= scoped_default_signal
<SIGINT
>;
322 /* Functions that iterate over all extension languages.
323 These only iterate over external extension languages, not including
324 GDB's own extension/scripting language, unless otherwise indicated. */
326 /* Wrapper to call the extension_language_ops.initialize "method" for each
327 compiled-in extension language. */
330 ext_lang_initialization (void)
332 for (const struct extension_language_defn
*extlang
: extension_languages
)
334 if (extlang
->ops
!= nullptr
335 && extlang
->ops
->initialize
!= NULL
)
337 scoped_default_sigint set_sigint_to_default_handler
;
338 extlang
->ops
->initialize (extlang
);
343 /* See extension.h. */
348 for (const struct extension_language_defn
*extlang
: extension_languages
)
350 if (extlang
->ops
!= nullptr && extlang
->ops
->shutdown
!= nullptr)
351 extlang
->ops
->shutdown (extlang
);
355 /* Invoke the appropriate extension_language_ops.eval_from_control_command
356 method to perform CMD, which is a list of commands in an extension language.
358 This function is what implements, for example:
367 eval_ext_lang_from_control_command (struct command_line
*cmd
)
369 for (const struct extension_language_defn
*extlang
: extension_languages
)
371 if (extlang
->cli_control_type
== cmd
->control_type
)
373 if (extlang
->ops
!= NULL
374 && extlang
->ops
->eval_from_control_command
!= NULL
)
376 extlang
->ops
->eval_from_control_command (extlang
, cmd
);
379 /* The requested extension language is not supported in this GDB. */
380 throw_ext_lang_unsupported (extlang
);
384 gdb_assert_not_reached ("unknown extension language in command_line");
387 /* Search for and load scripts for OBJFILE written in extension languages.
388 This includes GDB's own scripting language.
390 This function is what implements the loading of OBJFILE-gdb.py and
394 auto_load_ext_lang_scripts_for_objfile (struct objfile
*objfile
)
396 const struct extension_language_defn
*gdb
= &extension_language_gdb
;
397 if (ext_lang_auto_load_enabled (gdb
))
398 auto_load_objfile_script (objfile
, gdb
);
400 for (const struct extension_language_defn
*extlang
: extension_languages
)
402 if (extlang
->ops
!= nullptr
403 && ext_lang_auto_load_enabled (extlang
))
404 auto_load_objfile_script (objfile
, extlang
);
408 /* Interface to type pretty-printers implemented in an extension language. */
410 /* Call this at the start when preparing to pretty-print a type.
411 The result is a pointer to an opaque object (to the caller) to be passed
412 to apply_ext_lang_type_printers and free_ext_lang_type_printers.
414 We don't know in advance which extension language will provide a
415 pretty-printer for the type, so all are initialized. */
417 ext_lang_type_printers::ext_lang_type_printers ()
419 for (const struct extension_language_defn
*extlang
: extension_languages
)
421 if (extlang
->ops
!= nullptr
422 && extlang
->ops
->start_type_printers
!= NULL
)
423 extlang
->ops
->start_type_printers (extlang
, this);
427 /* Iteratively try the type pretty-printers specified by PRINTERS
428 according to the standard search order (specified by extension_languages),
429 returning the result of the first one that succeeds.
430 If there was an error, or if no printer succeeds, then NULL is returned. */
432 gdb::unique_xmalloc_ptr
<char>
433 apply_ext_lang_type_printers (struct ext_lang_type_printers
*printers
,
436 for (const struct extension_language_defn
*extlang
: extension_languages
)
438 gdb::unique_xmalloc_ptr
<char> result
;
441 if (extlang
->ops
== nullptr
442 || extlang
->ops
->apply_type_printers
== NULL
)
444 rc
= extlang
->ops
->apply_type_printers (extlang
, printers
, type
,
449 gdb_assert (result
!= nullptr);
451 case EXT_LANG_RC_ERROR
:
453 case EXT_LANG_RC_NOP
:
456 gdb_assert_not_reached ("bad return from apply_type_printers");
463 ext_lang_type_printers::~ext_lang_type_printers ()
465 for (const struct extension_language_defn
*extlang
: extension_languages
)
467 if (extlang
->ops
!= nullptr
468 && extlang
->ops
->free_type_printers
!= NULL
)
469 extlang
->ops
->free_type_printers (extlang
, this);
473 /* Try to pretty-print a value onto stdio stream STREAM according to
474 OPTIONS. VAL is the object to print. Returns non-zero if the
475 value was successfully pretty-printed.
477 Extension languages are tried in the order specified by
478 extension_languages. The first one to provide a pretty-printed
481 If an error is encountered in a pretty-printer, no further extension
483 Note: This is different than encountering a memory error trying to read a
484 value for pretty-printing. Here we're referring to, e.g., programming
485 errors that trigger an exception in the extension language. */
488 apply_ext_lang_val_pretty_printer (struct value
*val
,
489 struct ui_file
*stream
, int recurse
,
490 const struct value_print_options
*options
,
491 const struct language_defn
*language
)
493 for (const struct extension_language_defn
*extlang
: extension_languages
)
497 if (extlang
->ops
== nullptr
498 || extlang
->ops
->apply_val_pretty_printer
== NULL
)
500 rc
= extlang
->ops
->apply_val_pretty_printer (extlang
, val
, stream
,
501 recurse
, options
, language
);
506 case EXT_LANG_RC_ERROR
:
508 case EXT_LANG_RC_NOP
:
511 gdb_assert_not_reached ("bad return from apply_val_pretty_printer");
518 /* GDB access to the "frame filter" feature.
519 FRAME is the source frame to start frame-filter invocation. FLAGS is an
520 integer holding the flags for printing. The following elements of
521 the FRAME_FILTER_FLAGS enum denotes the make-up of FLAGS:
522 PRINT_LEVEL is a flag indicating whether to print the frame's
523 relative level in the output. PRINT_FRAME_INFO is a flag that
524 indicates whether this function should print the frame
525 information, PRINT_ARGS is a flag that indicates whether to print
526 frame arguments, and PRINT_LOCALS, likewise, with frame local
527 variables. ARGS_TYPE is an enumerator describing the argument
528 format, OUT is the output stream to print. FRAME_LOW is the
529 beginning of the slice of frames to print, and FRAME_HIGH is the
530 upper limit of the frames to count. Returns EXT_LANG_BT_ERROR on error,
531 or EXT_LANG_BT_COMPLETED on success.
533 Extension languages are tried in the order specified by
534 extension_languages. The first one to provide a filter "wins".
535 If there is an error (EXT_LANG_BT_ERROR) it is reported immediately
536 rather than trying filters in other extension languages. */
538 enum ext_lang_bt_status
539 apply_ext_lang_frame_filter (const frame_info_ptr
&frame
,
540 frame_filter_flags flags
,
541 enum ext_lang_frame_args args_type
,
543 int frame_low
, int frame_high
)
545 for (const struct extension_language_defn
*extlang
: extension_languages
)
547 enum ext_lang_bt_status status
;
549 if (extlang
->ops
== nullptr
550 || extlang
->ops
->apply_frame_filter
== NULL
)
552 status
= extlang
->ops
->apply_frame_filter (extlang
, frame
, flags
,
554 frame_low
, frame_high
);
555 /* We use the filters from the first extension language that has
556 applicable filters. Also, an error is reported immediately
557 rather than continue trying. */
558 if (status
!= EXT_LANG_BT_NO_FILTERS
)
562 return EXT_LANG_BT_NO_FILTERS
;
565 /* Update values held by the extension language when OBJFILE is discarded.
566 New global types must be created for every such value, which must then be
567 updated to use the new types.
568 The function typically just iterates over all appropriate values and
569 calls preserve_one_value for each one.
570 COPIED_TYPES is used to prevent cycles / duplicates and is passed to
571 preserve_one_value. */
574 preserve_ext_lang_values (struct objfile
*objfile
, htab_t copied_types
)
576 for (const struct extension_language_defn
*extlang
: extension_languages
)
578 if (extlang
->ops
!= nullptr
579 && extlang
->ops
->preserve_values
!= NULL
)
580 extlang
->ops
->preserve_values (extlang
, objfile
, copied_types
);
584 /* If there is a stop condition implemented in an extension language for
585 breakpoint B, return a pointer to the extension language's definition.
586 Otherwise return NULL.
587 If SKIP_LANG is not EXT_LANG_NONE, skip checking this language.
588 This is for the case where we're setting a new condition: Only one
589 condition is allowed, so when setting a condition for any particular
590 extension language, we need to check if any other extension language
591 already has a condition set. */
593 const struct extension_language_defn
*
594 get_breakpoint_cond_ext_lang (struct breakpoint
*b
,
595 enum extension_language skip_lang
)
597 for (const struct extension_language_defn
*extlang
: extension_languages
)
599 if (extlang
->ops
!= nullptr
600 && extlang
->language
!= skip_lang
601 && extlang
->ops
->breakpoint_has_cond
!= NULL
602 && extlang
->ops
->breakpoint_has_cond (extlang
, b
))
609 /* Return whether a stop condition for breakpoint B says to stop.
610 True is also returned if there is no stop condition for B. */
613 breakpoint_ext_lang_cond_says_stop (struct breakpoint
*b
)
615 enum ext_lang_bp_stop stop
= EXT_LANG_BP_STOP_UNSET
;
617 for (const struct extension_language_defn
*extlang
: extension_languages
)
619 /* There is a rule that a breakpoint can have at most one of any of a
620 CLI or extension language condition. However, Python hacks in "finish
621 breakpoints" on top of the "stop" check, so we have to call this for
622 every language, even if we could first determine whether a "stop"
624 if (extlang
->ops
!= nullptr
625 && extlang
->ops
->breakpoint_cond_says_stop
!= NULL
)
627 enum ext_lang_bp_stop this_stop
628 = extlang
->ops
->breakpoint_cond_says_stop (extlang
, b
);
630 if (this_stop
!= EXT_LANG_BP_STOP_UNSET
)
632 /* Even though we have to check every extension language, only
633 one of them can return yes/no (because only one of them
634 can have a "stop" condition). */
635 gdb_assert (stop
== EXT_LANG_BP_STOP_UNSET
);
641 return stop
!= EXT_LANG_BP_STOP_NO
;
644 /* ^C/SIGINT support.
645 This requires cooperation with the extension languages so the support
652 /* DAP needs a way to interrupt the main thread, so we added
653 gdb.interrupt. However, as this can run from any thread, we need
654 locking for the current extension language. If threading is not
655 available, DAP will not start.
657 This lock is held for accesses to quit_flag, active_ext_lang, and
658 cooperative_sigint_handling_disabled. */
659 static std::recursive_mutex ext_lang_mutex
;
661 #endif /* CXX_STD_THREAD */
663 /* This flag tracks quit requests when we haven't called out to an
664 extension language. it also holds quit requests when we transition to
665 an extension language that doesn't have cooperative SIGINT handling. */
666 static bool quit_flag
;
668 /* The current extension language we've called out to, or
669 extension_language_gdb if there isn't one.
670 This must be set everytime we call out to an extension language, and reset
671 to the previous value when it returns. Note that the previous value may
672 be a different (or the same) extension language. */
673 static const struct extension_language_defn
*active_ext_lang
674 = &extension_language_gdb
;
676 /* Install a SIGINT handler. */
679 install_ext_sigint_handler (const struct signal_handler
*handler_state
)
681 gdb_assert (handler_state
->handler_saved
);
683 install_sigint_handler (handler_state
->handler
);
686 /* Install GDB's SIGINT handler, storing the previous version in *PREVIOUS.
687 As a simple optimization, if the previous version was GDB's SIGINT handler
688 then mark the previous handler as not having been saved, and thus it won't
692 install_gdb_sigint_handler (struct signal_handler
*previous
)
694 /* Save here to simplify comparison. */
695 sighandler_t handle_sigint_for_compare
= handle_sigint
;
697 previous
->handler
= install_sigint_handler (handle_sigint
);
698 if (previous
->handler
!= handle_sigint_for_compare
)
699 previous
->handler_saved
= 1;
701 previous
->handler_saved
= 0;
705 namespace selftests
{
706 void (*hook_set_active_ext_lang
) () = nullptr;
710 /* True if cooperative SIGINT handling is disabled. This is needed so
711 that calls to set_active_ext_lang do not re-enable cooperative
712 handling, which if enabled would make set_quit_flag store the
713 SIGINT in an extension language. */
714 static bool cooperative_sigint_handling_disabled
= false;
716 scoped_disable_cooperative_sigint_handling::scoped_disable_cooperative_sigint_handling ()
719 std::lock_guard
guard (ext_lang_mutex
);
720 #endif /* CXX_STD_THREAD */
722 /* Force the active extension language to the GDB scripting
723 language. This ensures that a previously saved SIGINT is moved
724 to the quit_flag global, as well as ensures that future SIGINTs
725 are also saved in the global. */
726 m_prev_active_ext_lang_state
727 = set_active_ext_lang (&extension_language_gdb
);
729 /* Set the "cooperative SIGINT handling disabled" global flag, so
730 that a future call to set_active_ext_lang does not re-enable
732 m_prev_cooperative_sigint_handling_disabled
733 = cooperative_sigint_handling_disabled
;
734 cooperative_sigint_handling_disabled
= true;
737 scoped_disable_cooperative_sigint_handling::~scoped_disable_cooperative_sigint_handling ()
740 std::lock_guard
guard (ext_lang_mutex
);
741 #endif /* CXX_STD_THREAD */
743 cooperative_sigint_handling_disabled
= m_prev_cooperative_sigint_handling_disabled
;
744 restore_active_ext_lang (m_prev_active_ext_lang_state
);
747 /* Set the currently active extension language to NOW_ACTIVE.
748 The result is a pointer to a malloc'd block of memory to pass to
749 restore_active_ext_lang.
751 N.B. This function must be called every time we call out to an extension
752 language, and the result must be passed to restore_active_ext_lang
755 If there is a pending SIGINT it is "moved" to the now active extension
756 language, if it supports cooperative SIGINT handling (i.e., it provides
757 {clear,set,check}_quit_flag methods). If the extension language does not
758 support cooperative SIGINT handling, then the SIGINT is left queued and
759 we require the non-cooperative extension language to call check_quit_flag
760 at appropriate times.
761 It is important for the extension language to call check_quit_flag if it
762 installs its own SIGINT handler to prevent the situation where a SIGINT
763 is queued on entry, extension language code runs for a "long" time possibly
764 serving one or more SIGINTs, and then returns. Upon return, if
765 check_quit_flag is not called, the original SIGINT will be thrown.
766 Non-cooperative extension languages are free to install their own SIGINT
767 handler but the original must be restored upon return, either itself
768 or via restore_active_ext_lang.
770 If cooperative SIGINT handling is force-disabled (e.g., we're in
771 the middle of handling an inferior event), then we don't actually
772 record NOW_ACTIVE as the current active extension language, so that
773 set_quit_flag saves the SIGINT in the global quit flag instead of
774 in the extension language. The caller does not need to concern
775 itself about this, though. The currently active extension language
776 concept only exists for cooperative SIGINT handling. */
778 struct active_ext_lang_state
*
779 set_active_ext_lang (const struct extension_language_defn
*now_active
)
782 std::lock_guard
guard (ext_lang_mutex
);
783 #endif /* CXX_STD_THREAD */
786 if (selftests::hook_set_active_ext_lang
)
787 selftests::hook_set_active_ext_lang ();
790 /* If cooperative SIGINT handling was previously force-disabled,
791 make sure to not re-enable it (as NOW_ACTIVE could be a language
792 that supports cooperative SIGINT handling). */
793 if (cooperative_sigint_handling_disabled
)
795 /* Ensure set_quit_flag saves SIGINT in the quit_flag
797 gdb_assert (active_ext_lang
->ops
== nullptr
798 || active_ext_lang
->ops
->check_quit_flag
== nullptr);
800 /* The only thing the caller can do with the result is pass it
801 to restore_active_ext_lang, which expects NULL when
802 cooperative SIGINT handling is disabled. */
806 struct active_ext_lang_state
*previous
807 = XCNEW (struct active_ext_lang_state
);
809 previous
->ext_lang
= active_ext_lang
;
810 previous
->sigint_handler
.handler_saved
= 0;
811 active_ext_lang
= now_active
;
813 if (target_terminal::is_ours ())
815 /* If the newly active extension language uses cooperative SIGINT
816 handling then ensure GDB's SIGINT handler is installed. */
817 if (now_active
->language
== EXT_LANG_GDB
818 || now_active
->ops
->check_quit_flag
!= NULL
)
819 install_gdb_sigint_handler (&previous
->sigint_handler
);
821 /* If there's a SIGINT recorded in the cooperative extension languages,
822 move it to the new language, or save it in GDB's global flag if the
823 newly active extension language doesn't use cooperative SIGINT
825 if (check_quit_flag ())
832 /* Restore active extension language from PREVIOUS. */
835 restore_active_ext_lang (struct active_ext_lang_state
*previous
)
838 std::lock_guard
guard (ext_lang_mutex
);
839 #endif /* CXX_STD_THREAD */
841 if (cooperative_sigint_handling_disabled
)
843 /* See set_active_ext_lang. */
844 gdb_assert (previous
== nullptr);
848 active_ext_lang
= previous
->ext_lang
;
850 if (target_terminal::is_ours ())
852 /* Restore the previous SIGINT handler if one was saved. */
853 if (previous
->sigint_handler
.handler_saved
)
854 install_ext_sigint_handler (&previous
->sigint_handler
);
856 /* If there's a SIGINT recorded in the cooperative extension languages,
857 move it to the new language, or save it in GDB's global flag if the
858 newly active extension language doesn't use cooperative SIGINT
860 if (check_quit_flag ())
866 /* See extension.h. */
872 std::lock_guard
guard (ext_lang_mutex
);
873 #endif /* CXX_STD_THREAD */
875 if (active_ext_lang
->ops
!= NULL
876 && active_ext_lang
->ops
->set_quit_flag
!= NULL
)
877 active_ext_lang
->ops
->set_quit_flag (active_ext_lang
);
882 /* Now wake up the event loop, or any interruptible_select. Do
883 this after setting the flag, because signals on Windows
884 actually run on a separate thread, and thus otherwise the
885 main code could be woken up and find quit_flag still
887 quit_serial_event_set ();
891 /* See extension.h. */
897 std::lock_guard
guard (ext_lang_mutex
);
898 #endif /* CXX_STD_THREAD */
902 for (const struct extension_language_defn
*extlang
: extension_languages
)
904 if (extlang
->ops
!= nullptr
905 && extlang
->ops
->check_quit_flag
!= NULL
)
906 if (extlang
->ops
->check_quit_flag (extlang
))
910 /* This is written in a particular way to avoid races. */
913 /* No longer need to wake up the event loop or any
914 interruptible_select. The caller handles the quit
916 quit_serial_event_clear ();
924 /* See extension.h. */
927 get_matching_xmethod_workers (struct type
*type
, const char *method_name
,
928 std::vector
<xmethod_worker_up
> *workers
)
930 for (const struct extension_language_defn
*extlang
: extension_languages
)
934 /* If an extension language does not support xmethods, ignore
936 if (extlang
->ops
== nullptr
937 || extlang
->ops
->get_matching_xmethod_workers
== NULL
)
940 rc
= extlang
->ops
->get_matching_xmethod_workers (extlang
,
943 if (rc
== EXT_LANG_RC_ERROR
)
944 error (_("Error while looking for matching xmethod workers "
945 "defined in %s."), extlang
->capitalized_name
);
949 /* See extension.h. */
952 xmethod_worker::get_arg_types ()
954 std::vector
<type
*> type_array
;
956 ext_lang_rc rc
= do_get_arg_types (&type_array
);
957 if (rc
== EXT_LANG_RC_ERROR
)
958 error (_("Error while looking for arg types of a xmethod worker "
959 "defined in %s."), m_extlang
->capitalized_name
);
964 /* See extension.h. */
967 xmethod_worker::get_result_type (value
*object
, gdb::array_view
<value
*> args
)
971 ext_lang_rc rc
= do_get_result_type (object
, args
, &result_type
);
972 if (rc
== EXT_LANG_RC_ERROR
)
974 error (_("Error while fetching result type of an xmethod worker "
975 "defined in %s."), m_extlang
->capitalized_name
);
981 /* See extension.h. */
983 std::optional
<std::string
>
984 ext_lang_colorize (const std::string
&filename
, const std::string
&contents
)
986 std::optional
<std::string
> result
;
988 for (const struct extension_language_defn
*extlang
: extension_languages
)
990 if (extlang
->ops
== nullptr
991 || extlang
->ops
->colorize
== nullptr)
993 result
= extlang
->ops
->colorize (filename
, contents
);
994 if (result
.has_value ())
1001 /* See extension.h. */
1003 std::optional
<std::string
>
1004 ext_lang_colorize_disasm (const std::string
&content
, gdbarch
*gdbarch
)
1006 std::optional
<std::string
> result
;
1008 for (const struct extension_language_defn
*extlang
: extension_languages
)
1010 if (extlang
->ops
== nullptr
1011 || extlang
->ops
->colorize_disasm
== nullptr)
1013 result
= extlang
->ops
->colorize_disasm (content
, gdbarch
);
1014 if (result
.has_value ())
1021 /* See extension.h. */
1024 ext_lang_print_insn (struct gdbarch
*gdbarch
, CORE_ADDR address
,
1025 struct disassemble_info
*info
)
1027 for (const struct extension_language_defn
*extlang
: extension_languages
)
1029 if (extlang
->ops
== nullptr
1030 || extlang
->ops
->print_insn
== nullptr)
1032 std::optional
<int> length
1033 = extlang
->ops
->print_insn (gdbarch
, address
, info
);
1034 if (length
.has_value ())
1041 /* See extension.h. */
1043 ext_lang_missing_debuginfo_result
1044 ext_lang_handle_missing_debuginfo (struct objfile
*objfile
)
1046 for (const struct extension_language_defn
*extlang
: extension_languages
)
1048 if (extlang
->ops
== nullptr
1049 || extlang
->ops
->handle_missing_debuginfo
== nullptr)
1051 ext_lang_missing_debuginfo_result result
1052 = extlang
->ops
->handle_missing_debuginfo (extlang
, objfile
);
1053 if (!result
.filename ().empty () || result
.try_again ())
1060 /* Called via an observer before gdb prints its prompt.
1061 Iterate over the extension languages giving them a chance to
1062 change the prompt. The first one to change the prompt wins,
1063 and no further languages are tried. */
1066 ext_lang_before_prompt (const char *current_gdb_prompt
)
1068 for (const struct extension_language_defn
*extlang
: extension_languages
)
1070 enum ext_lang_rc rc
;
1072 if (extlang
->ops
== nullptr
1073 || extlang
->ops
->before_prompt
== NULL
)
1075 rc
= extlang
->ops
->before_prompt (extlang
, current_gdb_prompt
);
1078 case EXT_LANG_RC_OK
:
1079 case EXT_LANG_RC_ERROR
:
1081 case EXT_LANG_RC_NOP
:
1084 gdb_assert_not_reached ("bad return from before_prompt");
1089 void _initialize_extension ();
1091 _initialize_extension ()
1093 gdb::observers::before_prompt
.attach (ext_lang_before_prompt
, "extension");