1 /* SystemTap probe support for GDB.
3 Copyright (C) 2012-2019 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/>. */
21 #include "stap-probe.h"
23 #include "common/vec.h"
26 #include "arch-utils.h"
29 #include "filenames.h"
33 #include "complaints.h"
34 #include "cli/cli-utils.h"
36 #include "user-regs.h"
37 #include "parser-defs.h"
43 /* The name of the SystemTap section where we will find information about
46 #define STAP_BASE_SECTION_NAME ".stapsdt.base"
48 /* Should we display debug information for the probe's argument expression
51 static unsigned int stap_expression_debug
= 0;
53 /* The various possibilities of bitness defined for a probe's argument.
57 - STAP_ARG_BITNESS_UNDEFINED: The user hasn't specified the bitness.
58 - STAP_ARG_BITNESS_8BIT_UNSIGNED: argument string starts with `1@'.
59 - STAP_ARG_BITNESS_8BIT_SIGNED: argument string starts with `-1@'.
60 - STAP_ARG_BITNESS_16BIT_UNSIGNED: argument string starts with `2@'.
61 - STAP_ARG_BITNESS_16BIT_SIGNED: argument string starts with `-2@'.
62 - STAP_ARG_BITNESS_32BIT_UNSIGNED: argument string starts with `4@'.
63 - STAP_ARG_BITNESS_32BIT_SIGNED: argument string starts with `-4@'.
64 - STAP_ARG_BITNESS_64BIT_UNSIGNED: argument string starts with `8@'.
65 - STAP_ARG_BITNESS_64BIT_SIGNED: argument string starts with `-8@'. */
69 STAP_ARG_BITNESS_UNDEFINED
,
70 STAP_ARG_BITNESS_8BIT_UNSIGNED
,
71 STAP_ARG_BITNESS_8BIT_SIGNED
,
72 STAP_ARG_BITNESS_16BIT_UNSIGNED
,
73 STAP_ARG_BITNESS_16BIT_SIGNED
,
74 STAP_ARG_BITNESS_32BIT_UNSIGNED
,
75 STAP_ARG_BITNESS_32BIT_SIGNED
,
76 STAP_ARG_BITNESS_64BIT_UNSIGNED
,
77 STAP_ARG_BITNESS_64BIT_SIGNED
,
80 /* The following structure represents a single argument for the probe. */
84 /* Constructor for stap_probe_arg. */
85 stap_probe_arg (enum stap_arg_bitness bitness_
, struct type
*atype_
,
86 expression_up
&&aexpr_
)
87 : bitness (bitness_
), atype (atype_
), aexpr (std::move (aexpr_
))
90 /* The bitness of this argument. */
91 enum stap_arg_bitness bitness
;
93 /* The corresponding `struct type *' to the bitness. */
96 /* The argument converted to an internal GDB expression. */
100 /* Class that implements the static probe methods for "stap" probes. */
102 class stap_static_probe_ops
: public static_probe_ops
106 bool is_linespec (const char **linespecp
) const override
;
109 void get_probes (std::vector
<std::unique_ptr
<probe
>> *probesp
,
110 struct objfile
*objfile
) const override
;
113 const char *type_name () const override
;
116 std::vector
<struct info_probe_column
> gen_info_probes_table_header
120 /* SystemTap static_probe_ops. */
122 const stap_static_probe_ops stap_static_probe_ops
{};
124 class stap_probe
: public probe
127 /* Constructor for stap_probe. */
128 stap_probe (std::string
&&name_
, std::string
&&provider_
, CORE_ADDR address_
,
129 struct gdbarch
*arch_
, CORE_ADDR sem_addr
, const char *args_text
)
130 : probe (std::move (name_
), std::move (provider_
), address_
, arch_
),
131 m_sem_addr (sem_addr
),
132 m_have_parsed_args (false), m_unparsed_args_text (args_text
)
136 CORE_ADDR
get_relocated_address (struct objfile
*objfile
) override
;
139 unsigned get_argument_count (struct frame_info
*frame
) override
;
142 bool can_evaluate_arguments () const override
;
145 struct value
*evaluate_argument (unsigned n
,
146 struct frame_info
*frame
) override
;
149 void compile_to_ax (struct agent_expr
*aexpr
,
150 struct axs_value
*axs_value
,
151 unsigned n
) override
;
154 void set_semaphore (struct objfile
*objfile
,
155 struct gdbarch
*gdbarch
) override
;
158 void clear_semaphore (struct objfile
*objfile
,
159 struct gdbarch
*gdbarch
) override
;
162 const static_probe_ops
*get_static_ops () const override
;
165 std::vector
<const char *> gen_info_probes_table_values () const override
;
167 /* Return argument N of probe.
169 If the probe's arguments have not been parsed yet, parse them. If
170 there are no arguments, throw an exception (error). Otherwise,
171 return the requested argument. */
172 struct stap_probe_arg
*get_arg_by_number (unsigned n
,
173 struct gdbarch
*gdbarch
)
175 if (!m_have_parsed_args
)
176 this->parse_arguments (gdbarch
);
178 gdb_assert (m_have_parsed_args
);
179 if (m_parsed_args
.empty ())
180 internal_error (__FILE__
, __LINE__
,
181 _("Probe '%s' apparently does not have arguments, but \n"
182 "GDB is requesting its argument number %u anyway. "
183 "This should not happen. Please report this bug."),
184 this->get_name ().c_str (), n
);
186 if (n
> m_parsed_args
.size ())
187 internal_error (__FILE__
, __LINE__
,
188 _("Probe '%s' has %d arguments, but GDB is requesting\n"
189 "argument %u. This should not happen. Please\n"
191 this->get_name ().c_str (),
192 (int) m_parsed_args
.size (), n
);
194 return &m_parsed_args
[n
];
197 /* Function which parses an argument string from the probe,
198 correctly splitting the arguments and storing their information
201 Consider the following argument string (x86 syntax):
205 We have two arguments, `%eax' and `$10', both with 32-bit
206 unsigned bitness. This function basically handles them, properly
207 filling some structures with this information. */
208 void parse_arguments (struct gdbarch
*gdbarch
);
211 /* If the probe has a semaphore associated, then this is the value of
212 it, relative to SECT_OFF_DATA. */
213 CORE_ADDR m_sem_addr
;
215 /* True if the arguments have been parsed. */
216 bool m_have_parsed_args
;
218 /* The text version of the probe's arguments, unparsed. */
219 const char *m_unparsed_args_text
;
221 /* Information about each argument. This is an array of `stap_probe_arg',
222 with each entry representing one argument. This is only valid if
223 M_ARGS_PARSED is true. */
224 std::vector
<struct stap_probe_arg
> m_parsed_args
;
227 /* When parsing the arguments, we have to establish different precedences
228 for the various kinds of asm operators. This enumeration represents those
231 This logic behind this is available at
232 <http://sourceware.org/binutils/docs/as/Infix-Ops.html#Infix-Ops>, or using
233 the command "info '(as)Infix Ops'". */
235 enum stap_operand_prec
237 /* Lowest precedence, used for non-recognized operands or for the beginning
238 of the parsing process. */
239 STAP_OPERAND_PREC_NONE
= 0,
241 /* Precedence of logical OR. */
242 STAP_OPERAND_PREC_LOGICAL_OR
,
244 /* Precedence of logical AND. */
245 STAP_OPERAND_PREC_LOGICAL_AND
,
247 /* Precedence of additive (plus, minus) and comparative (equal, less,
248 greater-than, etc) operands. */
249 STAP_OPERAND_PREC_ADD_CMP
,
251 /* Precedence of bitwise operands (bitwise OR, XOR, bitwise AND,
253 STAP_OPERAND_PREC_BITWISE
,
255 /* Precedence of multiplicative operands (multiplication, division,
256 remainder, left shift and right shift). */
257 STAP_OPERAND_PREC_MUL
260 static void stap_parse_argument_1 (struct stap_parse_info
*p
, bool has_lhs
,
261 enum stap_operand_prec prec
);
263 static void stap_parse_argument_conditionally (struct stap_parse_info
*p
);
265 /* Returns true if *S is an operator, false otherwise. */
267 static bool stap_is_operator (const char *op
);
270 show_stapexpressiondebug (struct ui_file
*file
, int from_tty
,
271 struct cmd_list_element
*c
, const char *value
)
273 fprintf_filtered (file
, _("SystemTap Probe expression debugging is %s.\n"),
277 /* Returns the operator precedence level of OP, or STAP_OPERAND_PREC_NONE
278 if the operator code was not recognized. */
280 static enum stap_operand_prec
281 stap_get_operator_prec (enum exp_opcode op
)
285 case BINOP_LOGICAL_OR
:
286 return STAP_OPERAND_PREC_LOGICAL_OR
;
288 case BINOP_LOGICAL_AND
:
289 return STAP_OPERAND_PREC_LOGICAL_AND
;
299 return STAP_OPERAND_PREC_ADD_CMP
;
301 case BINOP_BITWISE_IOR
:
302 case BINOP_BITWISE_AND
:
303 case BINOP_BITWISE_XOR
:
304 case UNOP_LOGICAL_NOT
:
305 return STAP_OPERAND_PREC_BITWISE
;
312 return STAP_OPERAND_PREC_MUL
;
315 return STAP_OPERAND_PREC_NONE
;
319 /* Given S, read the operator in it. Return the EXP_OPCODE which
320 represents the operator detected, or throw an error if no operator
323 static enum exp_opcode
324 stap_get_opcode (const char **s
)
379 op
= BINOP_BITWISE_IOR
;
383 op
= BINOP_LOGICAL_OR
;
388 op
= BINOP_BITWISE_AND
;
392 op
= BINOP_LOGICAL_AND
;
397 op
= BINOP_BITWISE_XOR
;
401 op
= UNOP_LOGICAL_NOT
;
413 gdb_assert (**s
== '=');
418 error (_("Invalid opcode in expression `%s' for SystemTap"
425 /* Given the bitness of the argument, represented by B, return the
426 corresponding `struct type *', or throw an error if B is
430 stap_get_expected_argument_type (struct gdbarch
*gdbarch
,
431 enum stap_arg_bitness b
,
432 const char *probe_name
)
436 case STAP_ARG_BITNESS_UNDEFINED
:
437 if (gdbarch_addr_bit (gdbarch
) == 32)
438 return builtin_type (gdbarch
)->builtin_uint32
;
440 return builtin_type (gdbarch
)->builtin_uint64
;
442 case STAP_ARG_BITNESS_8BIT_UNSIGNED
:
443 return builtin_type (gdbarch
)->builtin_uint8
;
445 case STAP_ARG_BITNESS_8BIT_SIGNED
:
446 return builtin_type (gdbarch
)->builtin_int8
;
448 case STAP_ARG_BITNESS_16BIT_UNSIGNED
:
449 return builtin_type (gdbarch
)->builtin_uint16
;
451 case STAP_ARG_BITNESS_16BIT_SIGNED
:
452 return builtin_type (gdbarch
)->builtin_int16
;
454 case STAP_ARG_BITNESS_32BIT_SIGNED
:
455 return builtin_type (gdbarch
)->builtin_int32
;
457 case STAP_ARG_BITNESS_32BIT_UNSIGNED
:
458 return builtin_type (gdbarch
)->builtin_uint32
;
460 case STAP_ARG_BITNESS_64BIT_SIGNED
:
461 return builtin_type (gdbarch
)->builtin_int64
;
463 case STAP_ARG_BITNESS_64BIT_UNSIGNED
:
464 return builtin_type (gdbarch
)->builtin_uint64
;
467 error (_("Undefined bitness for probe '%s'."), probe_name
);
472 /* Helper function to check for a generic list of prefixes. GDBARCH
473 is the current gdbarch being used. S is the expression being
474 analyzed. If R is not NULL, it will be used to return the found
475 prefix. PREFIXES is the list of expected prefixes.
477 This function does a case-insensitive match.
479 Return true if any prefix has been found, false otherwise. */
482 stap_is_generic_prefix (struct gdbarch
*gdbarch
, const char *s
,
483 const char **r
, const char *const *prefixes
)
485 const char *const *p
;
487 if (prefixes
== NULL
)
495 for (p
= prefixes
; *p
!= NULL
; ++p
)
496 if (strncasecmp (s
, *p
, strlen (*p
)) == 0)
507 /* Return true if S points to a register prefix, false otherwise. For
508 a description of the arguments, look at stap_is_generic_prefix. */
511 stap_is_register_prefix (struct gdbarch
*gdbarch
, const char *s
,
514 const char *const *t
= gdbarch_stap_register_prefixes (gdbarch
);
516 return stap_is_generic_prefix (gdbarch
, s
, r
, t
);
519 /* Return true if S points to a register indirection prefix, false
520 otherwise. For a description of the arguments, look at
521 stap_is_generic_prefix. */
524 stap_is_register_indirection_prefix (struct gdbarch
*gdbarch
, const char *s
,
527 const char *const *t
= gdbarch_stap_register_indirection_prefixes (gdbarch
);
529 return stap_is_generic_prefix (gdbarch
, s
, r
, t
);
532 /* Return true if S points to an integer prefix, false otherwise. For
533 a description of the arguments, look at stap_is_generic_prefix.
535 This function takes care of analyzing whether we are dealing with
536 an expected integer prefix, or, if there is no integer prefix to be
537 expected, whether we are dealing with a digit. It does a
538 case-insensitive match. */
541 stap_is_integer_prefix (struct gdbarch
*gdbarch
, const char *s
,
544 const char *const *t
= gdbarch_stap_integer_prefixes (gdbarch
);
545 const char *const *p
;
549 /* A NULL value here means that integers do not have a prefix.
550 We just check for a digit then. */
554 return isdigit (*s
) > 0;
557 for (p
= t
; *p
!= NULL
; ++p
)
559 size_t len
= strlen (*p
);
561 if ((len
== 0 && isdigit (*s
))
562 || (len
> 0 && strncasecmp (s
, *p
, len
) == 0))
564 /* Integers may or may not have a prefix. The "len == 0"
565 check covers the case when integers do not have a prefix
566 (therefore, we just check if we have a digit). The call
567 to "strncasecmp" covers the case when they have a
579 /* Helper function to check for a generic list of suffixes. If we are
580 not expecting any suffixes, then it just returns 1. If we are
581 expecting at least one suffix, then it returns true if a suffix has
582 been found, false otherwise. GDBARCH is the current gdbarch being
583 used. S is the expression being analyzed. If R is not NULL, it
584 will be used to return the found suffix. SUFFIXES is the list of
585 expected suffixes. This function does a case-insensitive
589 stap_generic_check_suffix (struct gdbarch
*gdbarch
, const char *s
,
590 const char **r
, const char *const *suffixes
)
592 const char *const *p
;
595 if (suffixes
== NULL
)
603 for (p
= suffixes
; *p
!= NULL
; ++p
)
604 if (strncasecmp (s
, *p
, strlen (*p
)) == 0)
616 /* Return true if S points to an integer suffix, false otherwise. For
617 a description of the arguments, look at
618 stap_generic_check_suffix. */
621 stap_check_integer_suffix (struct gdbarch
*gdbarch
, const char *s
,
624 const char *const *p
= gdbarch_stap_integer_suffixes (gdbarch
);
626 return stap_generic_check_suffix (gdbarch
, s
, r
, p
);
629 /* Return true if S points to a register suffix, false otherwise. For
630 a description of the arguments, look at
631 stap_generic_check_suffix. */
634 stap_check_register_suffix (struct gdbarch
*gdbarch
, const char *s
,
637 const char *const *p
= gdbarch_stap_register_suffixes (gdbarch
);
639 return stap_generic_check_suffix (gdbarch
, s
, r
, p
);
642 /* Return true if S points to a register indirection suffix, false
643 otherwise. For a description of the arguments, look at
644 stap_generic_check_suffix. */
647 stap_check_register_indirection_suffix (struct gdbarch
*gdbarch
, const char *s
,
650 const char *const *p
= gdbarch_stap_register_indirection_suffixes (gdbarch
);
652 return stap_generic_check_suffix (gdbarch
, s
, r
, p
);
655 /* Function responsible for parsing a register operand according to
656 SystemTap parlance. Assuming:
660 RIP = register indirection prefix
661 RIS = register indirection suffix
663 Then a register operand can be:
665 [RIP] [RP] REGISTER [RS] [RIS]
667 This function takes care of a register's indirection, displacement and
668 direct access. It also takes into consideration the fact that some
669 registers are named differently inside and outside GDB, e.g., PPC's
670 general-purpose registers are represented by integers in the assembly
671 language (e.g., `15' is the 15th general-purpose register), but inside
672 GDB they have a prefix (the letter `r') appended. */
675 stap_parse_register_operand (struct stap_parse_info
*p
)
677 /* Simple flag to indicate whether we have seen a minus signal before
679 bool got_minus
= false;
680 /* Flags to indicate whether this register access is being displaced and/or
683 bool indirect_p
= false;
684 struct gdbarch
*gdbarch
= p
->gdbarch
;
685 /* Needed to generate the register name as a part of an expression. */
687 /* Variables used to extract the register name from the probe's
690 const char *gdb_reg_prefix
= gdbarch_stap_gdb_register_prefix (gdbarch
);
691 const char *gdb_reg_suffix
= gdbarch_stap_gdb_register_suffix (gdbarch
);
692 const char *reg_prefix
;
693 const char *reg_ind_prefix
;
694 const char *reg_suffix
;
695 const char *reg_ind_suffix
;
697 /* Checking for a displacement argument. */
700 /* If it's a plus sign, we don't need to do anything, just advance the
704 else if (*p
->arg
== '-')
710 if (isdigit (*p
->arg
))
712 /* The value of the displacement. */
717 displacement
= strtol (p
->arg
, &endp
, 10);
720 /* Generating the expression for the displacement. */
721 write_exp_elt_opcode (&p
->pstate
, OP_LONG
);
722 write_exp_elt_type (&p
->pstate
, builtin_type (gdbarch
)->builtin_long
);
723 write_exp_elt_longcst (&p
->pstate
, displacement
);
724 write_exp_elt_opcode (&p
->pstate
, OP_LONG
);
726 write_exp_elt_opcode (&p
->pstate
, UNOP_NEG
);
729 /* Getting rid of register indirection prefix. */
730 if (stap_is_register_indirection_prefix (gdbarch
, p
->arg
, ®_ind_prefix
))
733 p
->arg
+= strlen (reg_ind_prefix
);
736 if (disp_p
&& !indirect_p
)
737 error (_("Invalid register displacement syntax on expression `%s'."),
740 /* Getting rid of register prefix. */
741 if (stap_is_register_prefix (gdbarch
, p
->arg
, ®_prefix
))
742 p
->arg
+= strlen (reg_prefix
);
744 /* Now we should have only the register name. Let's extract it and get
745 the associated number. */
748 /* We assume the register name is composed by letters and numbers. */
749 while (isalnum (*p
->arg
))
752 std::string
regname (start
, p
->arg
- start
);
754 /* We only add the GDB's register prefix/suffix if we are dealing with
755 a numeric register. */
756 if (isdigit (*start
))
758 if (gdb_reg_prefix
!= NULL
)
759 regname
= gdb_reg_prefix
+ regname
;
761 if (gdb_reg_suffix
!= NULL
)
762 regname
+= gdb_reg_suffix
;
765 /* Is this a valid register name? */
766 if (user_reg_map_name_to_regnum (gdbarch
,
768 regname
.size ()) == -1)
769 error (_("Invalid register name `%s' on expression `%s'."),
770 regname
.c_str (), p
->saved_arg
);
772 write_exp_elt_opcode (&p
->pstate
, OP_REGISTER
);
773 str
.ptr
= regname
.c_str ();
774 str
.length
= regname
.size ();
775 write_exp_string (&p
->pstate
, str
);
776 write_exp_elt_opcode (&p
->pstate
, OP_REGISTER
);
781 write_exp_elt_opcode (&p
->pstate
, BINOP_ADD
);
783 /* Casting to the expected type. */
784 write_exp_elt_opcode (&p
->pstate
, UNOP_CAST
);
785 write_exp_elt_type (&p
->pstate
, lookup_pointer_type (p
->arg_type
));
786 write_exp_elt_opcode (&p
->pstate
, UNOP_CAST
);
788 write_exp_elt_opcode (&p
->pstate
, UNOP_IND
);
791 /* Getting rid of the register name suffix. */
792 if (stap_check_register_suffix (gdbarch
, p
->arg
, ®_suffix
))
793 p
->arg
+= strlen (reg_suffix
);
795 error (_("Missing register name suffix on expression `%s'."),
798 /* Getting rid of the register indirection suffix. */
801 if (stap_check_register_indirection_suffix (gdbarch
, p
->arg
,
803 p
->arg
+= strlen (reg_ind_suffix
);
805 error (_("Missing indirection suffix on expression `%s'."),
810 /* This function is responsible for parsing a single operand.
812 A single operand can be:
814 - an unary operation (e.g., `-5', `~2', or even with subexpressions
816 - a register displacement, which will be treated as a register
817 operand (e.g., `-4(%eax)' on x86)
818 - a numeric constant, or
819 - a register operand (see function `stap_parse_register_operand')
821 The function also calls special-handling functions to deal with
822 unrecognized operands, allowing arch-specific parsers to be
826 stap_parse_single_operand (struct stap_parse_info
*p
)
828 struct gdbarch
*gdbarch
= p
->gdbarch
;
829 const char *int_prefix
= NULL
;
831 /* We first try to parse this token as a "special token". */
832 if (gdbarch_stap_parse_special_token_p (gdbarch
)
833 && (gdbarch_stap_parse_special_token (gdbarch
, p
) != 0))
835 /* If the return value of the above function is not zero,
836 it means it successfully parsed the special token.
838 If it is NULL, we try to parse it using our method. */
842 if (*p
->arg
== '-' || *p
->arg
== '~' || *p
->arg
== '+')
845 /* We use this variable to do a lookahead. */
846 const char *tmp
= p
->arg
;
847 bool has_digit
= false;
849 /* Skipping signal. */
852 /* This is an unary operation. Here is a list of allowed tokens
856 - number (from register displacement)
857 - subexpression (beginning with `(')
859 We handle the register displacement here, and the other cases
861 if (p
->inside_paren_p
)
862 tmp
= skip_spaces (tmp
);
864 while (isdigit (*tmp
))
866 /* We skip the digit here because we are only interested in
867 knowing what kind of unary operation this is. The digit
868 will be handled by one of the functions that will be
869 called below ('stap_parse_argument_conditionally' or
870 'stap_parse_register_operand'). */
875 if (has_digit
&& stap_is_register_indirection_prefix (gdbarch
, tmp
,
878 /* If we are here, it means it is a displacement. The only
879 operations allowed here are `-' and `+'. */
880 if (c
!= '-' && c
!= '+')
881 error (_("Invalid operator `%c' for register displacement "
882 "on expression `%s'."), c
, p
->saved_arg
);
884 stap_parse_register_operand (p
);
888 /* This is not a displacement. We skip the operator, and
889 deal with it when the recursion returns. */
891 stap_parse_argument_conditionally (p
);
893 write_exp_elt_opcode (&p
->pstate
, UNOP_NEG
);
895 write_exp_elt_opcode (&p
->pstate
, UNOP_COMPLEMENT
);
898 else if (isdigit (*p
->arg
))
900 /* A temporary variable, needed for lookahead. */
901 const char *tmp
= p
->arg
;
905 /* We can be dealing with a numeric constant, or with a register
907 number
= strtol (tmp
, &endp
, 10);
910 if (p
->inside_paren_p
)
911 tmp
= skip_spaces (tmp
);
913 /* If "stap_is_integer_prefix" returns true, it means we can
914 accept integers without a prefix here. But we also need to
915 check whether the next token (i.e., "tmp") is not a register
916 indirection prefix. */
917 if (stap_is_integer_prefix (gdbarch
, p
->arg
, NULL
)
918 && !stap_is_register_indirection_prefix (gdbarch
, tmp
, NULL
))
920 const char *int_suffix
;
922 /* We are dealing with a numeric constant. */
923 write_exp_elt_opcode (&p
->pstate
, OP_LONG
);
924 write_exp_elt_type (&p
->pstate
,
925 builtin_type (gdbarch
)->builtin_long
);
926 write_exp_elt_longcst (&p
->pstate
, number
);
927 write_exp_elt_opcode (&p
->pstate
, OP_LONG
);
931 if (stap_check_integer_suffix (gdbarch
, p
->arg
, &int_suffix
))
932 p
->arg
+= strlen (int_suffix
);
934 error (_("Invalid constant suffix on expression `%s'."),
937 else if (stap_is_register_indirection_prefix (gdbarch
, tmp
, NULL
))
938 stap_parse_register_operand (p
);
940 error (_("Unknown numeric token on expression `%s'."),
943 else if (stap_is_integer_prefix (gdbarch
, p
->arg
, &int_prefix
))
945 /* We are dealing with a numeric constant. */
948 const char *int_suffix
;
950 p
->arg
+= strlen (int_prefix
);
951 number
= strtol (p
->arg
, &endp
, 10);
954 write_exp_elt_opcode (&p
->pstate
, OP_LONG
);
955 write_exp_elt_type (&p
->pstate
, builtin_type (gdbarch
)->builtin_long
);
956 write_exp_elt_longcst (&p
->pstate
, number
);
957 write_exp_elt_opcode (&p
->pstate
, OP_LONG
);
959 if (stap_check_integer_suffix (gdbarch
, p
->arg
, &int_suffix
))
960 p
->arg
+= strlen (int_suffix
);
962 error (_("Invalid constant suffix on expression `%s'."),
965 else if (stap_is_register_prefix (gdbarch
, p
->arg
, NULL
)
966 || stap_is_register_indirection_prefix (gdbarch
, p
->arg
, NULL
))
967 stap_parse_register_operand (p
);
969 error (_("Operator `%c' not recognized on expression `%s'."),
970 *p
->arg
, p
->saved_arg
);
973 /* This function parses an argument conditionally, based on single or
974 non-single operands. A non-single operand would be a parenthesized
975 expression (e.g., `(2 + 1)'), and a single operand is anything that
976 starts with `-', `~', `+' (i.e., unary operators), a digit, or
977 something recognized by `gdbarch_stap_is_single_operand'. */
980 stap_parse_argument_conditionally (struct stap_parse_info
*p
)
982 gdb_assert (gdbarch_stap_is_single_operand_p (p
->gdbarch
));
984 if (*p
->arg
== '-' || *p
->arg
== '~' || *p
->arg
== '+' /* Unary. */
986 || gdbarch_stap_is_single_operand (p
->gdbarch
, p
->arg
))
987 stap_parse_single_operand (p
);
988 else if (*p
->arg
== '(')
990 /* We are dealing with a parenthesized operand. It means we
991 have to parse it as it was a separate expression, without
992 left-side or precedence. */
994 p
->arg
= skip_spaces (p
->arg
);
997 stap_parse_argument_1 (p
, 0, STAP_OPERAND_PREC_NONE
);
1001 error (_("Missign close-paren on expression `%s'."),
1005 if (p
->inside_paren_p
)
1006 p
->arg
= skip_spaces (p
->arg
);
1009 error (_("Cannot parse expression `%s'."), p
->saved_arg
);
1012 /* Helper function for `stap_parse_argument'. Please, see its comments to
1013 better understand what this function does. */
1016 stap_parse_argument_1 (struct stap_parse_info
*p
, bool has_lhs
,
1017 enum stap_operand_prec prec
)
1019 /* This is an operator-precedence parser.
1021 We work with left- and right-sides of expressions, and
1022 parse them depending on the precedence of the operators
1025 gdb_assert (p
->arg
!= NULL
);
1027 if (p
->inside_paren_p
)
1028 p
->arg
= skip_spaces (p
->arg
);
1032 /* We were called without a left-side, either because this is the
1033 first call, or because we were called to parse a parenthesized
1034 expression. It doesn't really matter; we have to parse the
1035 left-side in order to continue the process. */
1036 stap_parse_argument_conditionally (p
);
1039 /* Start to parse the right-side, and to "join" left and right sides
1040 depending on the operation specified.
1042 This loop shall continue until we run out of characters in the input,
1043 or until we find a close-parenthesis, which means that we've reached
1044 the end of a sub-expression. */
1045 while (*p
->arg
!= '\0' && *p
->arg
!= ')' && !isspace (*p
->arg
))
1047 const char *tmp_exp_buf
;
1048 enum exp_opcode opcode
;
1049 enum stap_operand_prec cur_prec
;
1051 if (!stap_is_operator (p
->arg
))
1052 error (_("Invalid operator `%c' on expression `%s'."), *p
->arg
,
1055 /* We have to save the current value of the expression buffer because
1056 the `stap_get_opcode' modifies it in order to get the current
1057 operator. If this operator's precedence is lower than PREC, we
1058 should return and not advance the expression buffer pointer. */
1059 tmp_exp_buf
= p
->arg
;
1060 opcode
= stap_get_opcode (&tmp_exp_buf
);
1062 cur_prec
= stap_get_operator_prec (opcode
);
1063 if (cur_prec
< prec
)
1065 /* If the precedence of the operator that we are seeing now is
1066 lower than the precedence of the first operator seen before
1067 this parsing process began, it means we should stop parsing
1072 p
->arg
= tmp_exp_buf
;
1073 if (p
->inside_paren_p
)
1074 p
->arg
= skip_spaces (p
->arg
);
1076 /* Parse the right-side of the expression. */
1077 stap_parse_argument_conditionally (p
);
1079 /* While we still have operators, try to parse another
1080 right-side, but using the current right-side as a left-side. */
1081 while (*p
->arg
!= '\0' && stap_is_operator (p
->arg
))
1083 enum exp_opcode lookahead_opcode
;
1084 enum stap_operand_prec lookahead_prec
;
1086 /* Saving the current expression buffer position. The explanation
1087 is the same as above. */
1088 tmp_exp_buf
= p
->arg
;
1089 lookahead_opcode
= stap_get_opcode (&tmp_exp_buf
);
1090 lookahead_prec
= stap_get_operator_prec (lookahead_opcode
);
1092 if (lookahead_prec
<= prec
)
1094 /* If we are dealing with an operator whose precedence is lower
1095 than the first one, just abandon the attempt. */
1099 /* Parse the right-side of the expression, but since we already
1100 have a left-side at this point, set `has_lhs' to 1. */
1101 stap_parse_argument_1 (p
, 1, lookahead_prec
);
1104 write_exp_elt_opcode (&p
->pstate
, opcode
);
1108 /* Parse a probe's argument.
1112 LP = literal integer prefix
1113 LS = literal integer suffix
1115 RP = register prefix
1116 RS = register suffix
1118 RIP = register indirection prefix
1119 RIS = register indirection suffix
1121 This routine assumes that arguments' tokens are of the form:
1124 - [RP] REGISTER [RS]
1125 - [RIP] [RP] REGISTER [RS] [RIS]
1126 - If we find a number without LP, we try to parse it as a literal integer
1127 constant (if LP == NULL), or as a register displacement.
1128 - We count parenthesis, and only skip whitespaces if we are inside them.
1129 - If we find an operator, we skip it.
1131 This function can also call a special function that will try to match
1132 unknown tokens. It will return the expression_up generated from
1133 parsing the argument. */
1135 static expression_up
1136 stap_parse_argument (const char **arg
, struct type
*atype
,
1137 struct gdbarch
*gdbarch
)
1139 /* We need to initialize the expression buffer, in order to begin
1140 our parsing efforts. We use language_c here because we may need
1141 to do pointer arithmetics. */
1142 struct stap_parse_info
p (*arg
, atype
, language_def (language_c
),
1145 stap_parse_argument_1 (&p
, 0, STAP_OPERAND_PREC_NONE
);
1147 gdb_assert (p
.inside_paren_p
== 0);
1149 /* Casting the final expression to the appropriate type. */
1150 write_exp_elt_opcode (&p
.pstate
, UNOP_CAST
);
1151 write_exp_elt_type (&p
.pstate
, atype
);
1152 write_exp_elt_opcode (&p
.pstate
, UNOP_CAST
);
1154 p
.arg
= skip_spaces (p
.arg
);
1157 return p
.pstate
.release ();
1160 /* Implementation of 'parse_arguments' method. */
1163 stap_probe::parse_arguments (struct gdbarch
*gdbarch
)
1167 gdb_assert (!m_have_parsed_args
);
1168 cur
= m_unparsed_args_text
;
1169 m_have_parsed_args
= true;
1171 if (cur
== NULL
|| *cur
== '\0' || *cur
== ':')
1174 while (*cur
!= '\0')
1176 enum stap_arg_bitness bitness
;
1177 bool got_minus
= false;
1179 /* We expect to find something like:
1183 Where `N' can be [+,-][1,2,4,8]. This is not mandatory, so
1184 we check it here. If we don't find it, go to the next
1186 if ((cur
[0] == '-' && isdigit (cur
[1]) && cur
[2] == '@')
1187 || (isdigit (cur
[0]) && cur
[1] == '@'))
1191 /* Discard the `-'. */
1196 /* Defining the bitness. */
1200 bitness
= (got_minus
? STAP_ARG_BITNESS_8BIT_SIGNED
1201 : STAP_ARG_BITNESS_8BIT_UNSIGNED
);
1205 bitness
= (got_minus
? STAP_ARG_BITNESS_16BIT_SIGNED
1206 : STAP_ARG_BITNESS_16BIT_UNSIGNED
);
1210 bitness
= (got_minus
? STAP_ARG_BITNESS_32BIT_SIGNED
1211 : STAP_ARG_BITNESS_32BIT_UNSIGNED
);
1215 bitness
= (got_minus
? STAP_ARG_BITNESS_64BIT_SIGNED
1216 : STAP_ARG_BITNESS_64BIT_UNSIGNED
);
1221 /* We have an error, because we don't expect anything
1222 except 1, 2, 4 and 8. */
1223 warning (_("unrecognized bitness %s%c' for probe `%s'"),
1224 got_minus
? "`-" : "`", *cur
,
1225 this->get_name ().c_str ());
1229 /* Discard the number and the `@' sign. */
1233 bitness
= STAP_ARG_BITNESS_UNDEFINED
;
1236 = stap_get_expected_argument_type (gdbarch
, bitness
,
1237 this->get_name ().c_str ());
1239 expression_up expr
= stap_parse_argument (&cur
, atype
, gdbarch
);
1241 if (stap_expression_debug
)
1242 dump_raw_expression (expr
.get (), gdb_stdlog
,
1243 "before conversion to prefix form");
1245 prefixify_expression (expr
.get ());
1247 if (stap_expression_debug
)
1248 dump_prefix_expression (expr
.get (), gdb_stdlog
);
1250 m_parsed_args
.emplace_back (bitness
, atype
, std::move (expr
));
1252 /* Start it over again. */
1253 cur
= skip_spaces (cur
);
1257 /* Helper function to relocate an address. */
1260 relocate_address (CORE_ADDR address
, struct objfile
*objfile
)
1262 return address
+ ANOFFSET (objfile
->section_offsets
,
1263 SECT_OFF_DATA (objfile
));
1266 /* Implementation of the get_relocated_address method. */
1269 stap_probe::get_relocated_address (struct objfile
*objfile
)
1271 return relocate_address (this->get_address (), objfile
);
1274 /* Given PROBE, returns the number of arguments present in that probe's
1278 stap_probe::get_argument_count (struct frame_info
*frame
)
1280 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1282 if (!m_have_parsed_args
)
1284 if (this->can_evaluate_arguments ())
1285 this->parse_arguments (gdbarch
);
1288 static bool have_warned_stap_incomplete
= false;
1290 if (!have_warned_stap_incomplete
)
1293 "The SystemTap SDT probe support is not fully implemented on this target;\n"
1294 "you will not be able to inspect the arguments of the probes.\n"
1295 "Please report a bug against GDB requesting a port to this target."));
1296 have_warned_stap_incomplete
= true;
1299 /* Marking the arguments as "already parsed". */
1300 m_have_parsed_args
= true;
1304 gdb_assert (m_have_parsed_args
);
1305 return m_parsed_args
.size ();
1308 /* Return true if OP is a valid operator inside a probe argument, or
1312 stap_is_operator (const char *op
)
1337 /* We didn't find any operator. */
1344 /* Implement the `can_evaluate_arguments' method. */
1347 stap_probe::can_evaluate_arguments () const
1349 struct gdbarch
*gdbarch
= this->get_gdbarch ();
1351 /* For SystemTap probes, we have to guarantee that the method
1352 stap_is_single_operand is defined on gdbarch. If it is not, then it
1353 means that argument evaluation is not implemented on this target. */
1354 return gdbarch_stap_is_single_operand_p (gdbarch
);
1357 /* Evaluate the probe's argument N (indexed from 0), returning a value
1358 corresponding to it. Assertion is thrown if N does not exist. */
1361 stap_probe::evaluate_argument (unsigned n
, struct frame_info
*frame
)
1363 struct stap_probe_arg
*arg
;
1365 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1367 arg
= this->get_arg_by_number (n
, gdbarch
);
1368 return evaluate_subexp_standard (arg
->atype
, arg
->aexpr
.get (), &pos
,
1372 /* Compile the probe's argument N (indexed from 0) to agent expression.
1373 Assertion is thrown if N does not exist. */
1376 stap_probe::compile_to_ax (struct agent_expr
*expr
, struct axs_value
*value
,
1379 struct stap_probe_arg
*arg
;
1380 union exp_element
*pc
;
1382 arg
= this->get_arg_by_number (n
, expr
->gdbarch
);
1384 pc
= arg
->aexpr
->elts
;
1385 gen_expr (arg
->aexpr
.get (), &pc
, expr
, value
);
1387 require_rvalue (expr
, value
);
1388 value
->type
= arg
->atype
;
1392 /* Set or clear a SystemTap semaphore. ADDRESS is the semaphore's
1393 address. SET is zero if the semaphore should be cleared, or one if
1394 it should be set. This is a helper function for
1395 'stap_probe::set_semaphore' and 'stap_probe::clear_semaphore'. */
1398 stap_modify_semaphore (CORE_ADDR address
, int set
, struct gdbarch
*gdbarch
)
1400 gdb_byte bytes
[sizeof (LONGEST
)];
1401 /* The ABI specifies "unsigned short". */
1402 struct type
*type
= builtin_type (gdbarch
)->builtin_unsigned_short
;
1408 /* Swallow errors. */
1409 if (target_read_memory (address
, bytes
, TYPE_LENGTH (type
)) != 0)
1411 warning (_("Could not read the value of a SystemTap semaphore."));
1415 value
= extract_unsigned_integer (bytes
, TYPE_LENGTH (type
),
1416 gdbarch_byte_order (gdbarch
));
1417 /* Note that we explicitly don't worry about overflow or
1424 store_unsigned_integer (bytes
, TYPE_LENGTH (type
),
1425 gdbarch_byte_order (gdbarch
), value
);
1427 if (target_write_memory (address
, bytes
, TYPE_LENGTH (type
)) != 0)
1428 warning (_("Could not write the value of a SystemTap semaphore."));
1431 /* Implementation of the 'set_semaphore' method.
1433 SystemTap semaphores act as reference counters, so calls to this
1434 function must be paired with calls to 'clear_semaphore'.
1436 This function and 'clear_semaphore' race with another tool
1437 changing the probes, but that is too rare to care. */
1440 stap_probe::set_semaphore (struct objfile
*objfile
, struct gdbarch
*gdbarch
)
1442 stap_modify_semaphore (relocate_address (m_sem_addr
, objfile
), 1, gdbarch
);
1445 /* Implementation of the 'clear_semaphore' method. */
1448 stap_probe::clear_semaphore (struct objfile
*objfile
, struct gdbarch
*gdbarch
)
1450 stap_modify_semaphore (relocate_address (m_sem_addr
, objfile
), 0, gdbarch
);
1453 /* Implementation of the 'get_static_ops' method. */
1455 const static_probe_ops
*
1456 stap_probe::get_static_ops () const
1458 return &stap_static_probe_ops
;
1461 /* Implementation of the 'gen_info_probes_table_values' method. */
1463 std::vector
<const char *>
1464 stap_probe::gen_info_probes_table_values () const
1466 const char *val
= NULL
;
1468 if (m_sem_addr
!= 0)
1469 val
= print_core_address (this->get_gdbarch (), m_sem_addr
);
1471 return std::vector
<const char *> { val
};
1474 /* Helper function that parses the information contained in a
1475 SystemTap's probe. Basically, the information consists in:
1477 - Probe's PC address;
1478 - Link-time section address of `.stapsdt.base' section;
1479 - Link-time address of the semaphore variable, or ZERO if the
1480 probe doesn't have an associated semaphore;
1481 - Probe's provider name;
1483 - Probe's argument format. */
1486 handle_stap_probe (struct objfile
*objfile
, struct sdt_note
*el
,
1487 std::vector
<std::unique_ptr
<probe
>> *probesp
,
1490 bfd
*abfd
= objfile
->obfd
;
1491 int size
= bfd_get_arch_size (abfd
) / 8;
1492 struct gdbarch
*gdbarch
= get_objfile_arch (objfile
);
1493 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_data_ptr
;
1495 /* Provider and the name of the probe. */
1496 const char *provider
= (const char *) &el
->data
[3 * size
];
1497 const char *name
= ((const char *)
1498 memchr (provider
, '\0',
1499 (char *) el
->data
+ el
->size
- provider
));
1500 /* Making sure there is a name. */
1503 complaint (_("corrupt probe name when reading `%s'"),
1504 objfile_name (objfile
));
1506 /* There is no way to use a probe without a name or a provider, so
1507 returning here makes sense. */
1513 /* Retrieving the probe's address. */
1514 CORE_ADDR address
= extract_typed_address (&el
->data
[0], ptr_type
);
1516 /* Link-time sh_addr of `.stapsdt.base' section. */
1517 CORE_ADDR base_ref
= extract_typed_address (&el
->data
[size
], ptr_type
);
1519 /* Semaphore address. */
1520 CORE_ADDR sem_addr
= extract_typed_address (&el
->data
[2 * size
], ptr_type
);
1522 address
+= base
- base_ref
;
1524 sem_addr
+= base
- base_ref
;
1526 /* Arguments. We can only extract the argument format if there is a valid
1527 name for this probe. */
1528 const char *probe_args
= ((const char*)
1530 (char *) el
->data
+ el
->size
- name
));
1532 if (probe_args
!= NULL
)
1535 if (probe_args
== NULL
1536 || (memchr (probe_args
, '\0', (char *) el
->data
+ el
->size
- name
)
1537 != el
->data
+ el
->size
- 1))
1539 complaint (_("corrupt probe argument when reading `%s'"),
1540 objfile_name (objfile
));
1541 /* If the argument string is NULL, it means some problem happened with
1542 it. So we return. */
1546 stap_probe
*ret
= new stap_probe (std::string (name
), std::string (provider
),
1547 address
, gdbarch
, sem_addr
, probe_args
);
1549 /* Successfully created probe. */
1550 probesp
->emplace_back (ret
);
1553 /* Helper function which tries to find the base address of the SystemTap
1554 base section named STAP_BASE_SECTION_NAME. */
1557 get_stap_base_address_1 (bfd
*abfd
, asection
*sect
, void *obj
)
1559 asection
**ret
= (asection
**) obj
;
1561 if ((sect
->flags
& (SEC_DATA
| SEC_ALLOC
| SEC_HAS_CONTENTS
))
1562 && sect
->name
&& !strcmp (sect
->name
, STAP_BASE_SECTION_NAME
))
1566 /* Helper function which iterates over every section in the BFD file,
1567 trying to find the base address of the SystemTap base section.
1568 Returns 1 if found (setting BASE to the proper value), zero otherwise. */
1571 get_stap_base_address (bfd
*obfd
, bfd_vma
*base
)
1573 asection
*ret
= NULL
;
1575 bfd_map_over_sections (obfd
, get_stap_base_address_1
, (void *) &ret
);
1579 complaint (_("could not obtain base address for "
1580 "SystemTap section on objfile `%s'."),
1591 /* Implementation of the 'is_linespec' method. */
1594 stap_static_probe_ops::is_linespec (const char **linespecp
) const
1596 static const char *const keywords
[] = { "-pstap", "-probe-stap", NULL
};
1598 return probe_is_linespec_by_keyword (linespecp
, keywords
);
1601 /* Implementation of the 'get_probes' method. */
1604 stap_static_probe_ops::get_probes
1605 (std::vector
<std::unique_ptr
<probe
>> *probesp
,
1606 struct objfile
*objfile
) const
1608 /* If we are here, then this is the first time we are parsing the
1609 SystemTap probe's information. We basically have to count how many
1610 probes the objfile has, and then fill in the necessary information
1612 bfd
*obfd
= objfile
->obfd
;
1614 struct sdt_note
*iter
;
1615 unsigned save_probesp_len
= probesp
->size ();
1617 if (objfile
->separate_debug_objfile_backlink
!= NULL
)
1619 /* This is a .debug file, not the objfile itself. */
1623 if (elf_tdata (obfd
)->sdt_note_head
== NULL
)
1625 /* There isn't any probe here. */
1629 if (!get_stap_base_address (obfd
, &base
))
1631 /* There was an error finding the base address for the section.
1632 Just return NULL. */
1636 /* Parsing each probe's information. */
1637 for (iter
= elf_tdata (obfd
)->sdt_note_head
;
1641 /* We first have to handle all the information about the
1642 probe which is present in the section. */
1643 handle_stap_probe (objfile
, iter
, probesp
, base
);
1646 if (save_probesp_len
== probesp
->size ())
1648 /* If we are here, it means we have failed to parse every known
1650 complaint (_("could not parse SystemTap probe(s) from inferior"));
1655 /* Implementation of the type_name method. */
1658 stap_static_probe_ops::type_name () const
1663 /* Implementation of the 'gen_info_probes_table_header' method. */
1665 std::vector
<struct info_probe_column
>
1666 stap_static_probe_ops::gen_info_probes_table_header () const
1668 struct info_probe_column stap_probe_column
;
1670 stap_probe_column
.field_name
= "semaphore";
1671 stap_probe_column
.print_name
= _("Semaphore");
1673 return std::vector
<struct info_probe_column
> { stap_probe_column
};
1676 /* Implementation of the `info probes stap' command. */
1679 info_probes_stap_command (const char *arg
, int from_tty
)
1681 info_probes_for_spops (arg
, from_tty
, &stap_static_probe_ops
);
1685 _initialize_stap_probe (void)
1687 all_static_probe_ops
.push_back (&stap_static_probe_ops
);
1689 add_setshow_zuinteger_cmd ("stap-expression", class_maintenance
,
1690 &stap_expression_debug
,
1691 _("Set SystemTap expression debugging."),
1692 _("Show SystemTap expression debugging."),
1693 _("When non-zero, the internal representation "
1694 "of SystemTap expressions will be printed."),
1696 show_stapexpressiondebug
,
1697 &setdebuglist
, &showdebuglist
);
1699 add_cmd ("stap", class_info
, info_probes_stap_command
,
1701 Show information about SystemTap static probes.\n\
1702 Usage: info probes stap [PROVIDER [NAME [OBJECT]]]\n\
1703 Each argument is a regular expression, used to select probes.\n\
1704 PROVIDER matches probe provider names.\n\
1705 NAME matches the probe names.\n\
1706 OBJECT matches the executable or shared library name."),
1707 info_probes_cmdlist_get ());