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"
25 #include "arch-utils.h"
28 #include "filenames.h"
32 #include "complaints.h"
33 #include "cli/cli-utils.h"
35 #include "user-regs.h"
36 #include "parser-defs.h"
42 /* The name of the SystemTap section where we will find information about
45 #define STAP_BASE_SECTION_NAME ".stapsdt.base"
47 /* Should we display debug information for the probe's argument expression
50 static unsigned int stap_expression_debug
= 0;
52 /* The various possibilities of bitness defined for a probe's argument.
56 - STAP_ARG_BITNESS_UNDEFINED: The user hasn't specified the bitness.
57 - STAP_ARG_BITNESS_8BIT_UNSIGNED: argument string starts with `1@'.
58 - STAP_ARG_BITNESS_8BIT_SIGNED: argument string starts with `-1@'.
59 - STAP_ARG_BITNESS_16BIT_UNSIGNED: argument string starts with `2@'.
60 - STAP_ARG_BITNESS_16BIT_SIGNED: argument string starts with `-2@'.
61 - STAP_ARG_BITNESS_32BIT_UNSIGNED: argument string starts with `4@'.
62 - STAP_ARG_BITNESS_32BIT_SIGNED: argument string starts with `-4@'.
63 - STAP_ARG_BITNESS_64BIT_UNSIGNED: argument string starts with `8@'.
64 - STAP_ARG_BITNESS_64BIT_SIGNED: argument string starts with `-8@'. */
68 STAP_ARG_BITNESS_UNDEFINED
,
69 STAP_ARG_BITNESS_8BIT_UNSIGNED
,
70 STAP_ARG_BITNESS_8BIT_SIGNED
,
71 STAP_ARG_BITNESS_16BIT_UNSIGNED
,
72 STAP_ARG_BITNESS_16BIT_SIGNED
,
73 STAP_ARG_BITNESS_32BIT_UNSIGNED
,
74 STAP_ARG_BITNESS_32BIT_SIGNED
,
75 STAP_ARG_BITNESS_64BIT_UNSIGNED
,
76 STAP_ARG_BITNESS_64BIT_SIGNED
,
79 /* The following structure represents a single argument for the probe. */
83 /* Constructor for stap_probe_arg. */
84 stap_probe_arg (enum stap_arg_bitness bitness_
, struct type
*atype_
,
85 expression_up
&&aexpr_
)
86 : bitness (bitness_
), atype (atype_
), aexpr (std::move (aexpr_
))
89 /* The bitness of this argument. */
90 enum stap_arg_bitness bitness
;
92 /* The corresponding `struct type *' to the bitness. */
95 /* The argument converted to an internal GDB expression. */
99 /* Class that implements the static probe methods for "stap" probes. */
101 class stap_static_probe_ops
: public static_probe_ops
105 bool is_linespec (const char **linespecp
) const override
;
108 void get_probes (std::vector
<std::unique_ptr
<probe
>> *probesp
,
109 struct objfile
*objfile
) const override
;
112 const char *type_name () const override
;
115 std::vector
<struct info_probe_column
> gen_info_probes_table_header
119 /* SystemTap static_probe_ops. */
121 const stap_static_probe_ops stap_static_probe_ops
{};
123 class stap_probe
: public probe
126 /* Constructor for stap_probe. */
127 stap_probe (std::string
&&name_
, std::string
&&provider_
, CORE_ADDR address_
,
128 struct gdbarch
*arch_
, CORE_ADDR sem_addr
, const char *args_text
)
129 : probe (std::move (name_
), std::move (provider_
), address_
, arch_
),
130 m_sem_addr (sem_addr
),
131 m_have_parsed_args (false), m_unparsed_args_text (args_text
)
135 CORE_ADDR
get_relocated_address (struct objfile
*objfile
) override
;
138 unsigned get_argument_count (struct gdbarch
*gdbarch
) override
;
141 bool can_evaluate_arguments () const override
;
144 struct value
*evaluate_argument (unsigned n
,
145 struct frame_info
*frame
) override
;
148 void compile_to_ax (struct agent_expr
*aexpr
,
149 struct axs_value
*axs_value
,
150 unsigned n
) override
;
153 void set_semaphore (struct objfile
*objfile
,
154 struct gdbarch
*gdbarch
) override
;
157 void clear_semaphore (struct objfile
*objfile
,
158 struct gdbarch
*gdbarch
) override
;
161 const static_probe_ops
*get_static_ops () const override
;
164 std::vector
<const char *> gen_info_probes_table_values () const override
;
166 /* Return argument N of probe.
168 If the probe's arguments have not been parsed yet, parse them. If
169 there are no arguments, throw an exception (error). Otherwise,
170 return the requested argument. */
171 struct stap_probe_arg
*get_arg_by_number (unsigned n
,
172 struct gdbarch
*gdbarch
)
174 if (!m_have_parsed_args
)
175 this->parse_arguments (gdbarch
);
177 gdb_assert (m_have_parsed_args
);
178 if (m_parsed_args
.empty ())
179 internal_error (__FILE__
, __LINE__
,
180 _("Probe '%s' apparently does not have arguments, but \n"
181 "GDB is requesting its argument number %u anyway. "
182 "This should not happen. Please report this bug."),
183 this->get_name ().c_str (), n
);
185 if (n
> m_parsed_args
.size ())
186 internal_error (__FILE__
, __LINE__
,
187 _("Probe '%s' has %d arguments, but GDB is requesting\n"
188 "argument %u. This should not happen. Please\n"
190 this->get_name ().c_str (),
191 (int) m_parsed_args
.size (), n
);
193 return &m_parsed_args
[n
];
196 /* Function which parses an argument string from the probe,
197 correctly splitting the arguments and storing their information
200 Consider the following argument string (x86 syntax):
204 We have two arguments, `%eax' and `$10', both with 32-bit
205 unsigned bitness. This function basically handles them, properly
206 filling some structures with this information. */
207 void parse_arguments (struct gdbarch
*gdbarch
);
210 /* If the probe has a semaphore associated, then this is the value of
211 it, relative to SECT_OFF_DATA. */
212 CORE_ADDR m_sem_addr
;
214 /* True if the arguments have been parsed. */
215 bool m_have_parsed_args
;
217 /* The text version of the probe's arguments, unparsed. */
218 const char *m_unparsed_args_text
;
220 /* Information about each argument. This is an array of `stap_probe_arg',
221 with each entry representing one argument. This is only valid if
222 M_ARGS_PARSED is true. */
223 std::vector
<struct stap_probe_arg
> m_parsed_args
;
226 /* When parsing the arguments, we have to establish different precedences
227 for the various kinds of asm operators. This enumeration represents those
230 This logic behind this is available at
231 <http://sourceware.org/binutils/docs/as/Infix-Ops.html#Infix-Ops>, or using
232 the command "info '(as)Infix Ops'". */
234 enum stap_operand_prec
236 /* Lowest precedence, used for non-recognized operands or for the beginning
237 of the parsing process. */
238 STAP_OPERAND_PREC_NONE
= 0,
240 /* Precedence of logical OR. */
241 STAP_OPERAND_PREC_LOGICAL_OR
,
243 /* Precedence of logical AND. */
244 STAP_OPERAND_PREC_LOGICAL_AND
,
246 /* Precedence of additive (plus, minus) and comparative (equal, less,
247 greater-than, etc) operands. */
248 STAP_OPERAND_PREC_ADD_CMP
,
250 /* Precedence of bitwise operands (bitwise OR, XOR, bitwise AND,
252 STAP_OPERAND_PREC_BITWISE
,
254 /* Precedence of multiplicative operands (multiplication, division,
255 remainder, left shift and right shift). */
256 STAP_OPERAND_PREC_MUL
259 static void stap_parse_argument_1 (struct stap_parse_info
*p
, bool has_lhs
,
260 enum stap_operand_prec prec
);
262 static void stap_parse_argument_conditionally (struct stap_parse_info
*p
);
264 /* Returns true if *S is an operator, false otherwise. */
266 static bool stap_is_operator (const char *op
);
269 show_stapexpressiondebug (struct ui_file
*file
, int from_tty
,
270 struct cmd_list_element
*c
, const char *value
)
272 fprintf_filtered (file
, _("SystemTap Probe expression debugging is %s.\n"),
276 /* Returns the operator precedence level of OP, or STAP_OPERAND_PREC_NONE
277 if the operator code was not recognized. */
279 static enum stap_operand_prec
280 stap_get_operator_prec (enum exp_opcode op
)
284 case BINOP_LOGICAL_OR
:
285 return STAP_OPERAND_PREC_LOGICAL_OR
;
287 case BINOP_LOGICAL_AND
:
288 return STAP_OPERAND_PREC_LOGICAL_AND
;
298 return STAP_OPERAND_PREC_ADD_CMP
;
300 case BINOP_BITWISE_IOR
:
301 case BINOP_BITWISE_AND
:
302 case BINOP_BITWISE_XOR
:
303 case UNOP_LOGICAL_NOT
:
304 return STAP_OPERAND_PREC_BITWISE
;
311 return STAP_OPERAND_PREC_MUL
;
314 return STAP_OPERAND_PREC_NONE
;
318 /* Given S, read the operator in it. Return the EXP_OPCODE which
319 represents the operator detected, or throw an error if no operator
322 static enum exp_opcode
323 stap_get_opcode (const char **s
)
378 op
= BINOP_BITWISE_IOR
;
382 op
= BINOP_LOGICAL_OR
;
387 op
= BINOP_BITWISE_AND
;
391 op
= BINOP_LOGICAL_AND
;
396 op
= BINOP_BITWISE_XOR
;
400 op
= UNOP_LOGICAL_NOT
;
412 gdb_assert (**s
== '=');
417 error (_("Invalid opcode in expression `%s' for SystemTap"
424 /* Given the bitness of the argument, represented by B, return the
425 corresponding `struct type *', or throw an error if B is
429 stap_get_expected_argument_type (struct gdbarch
*gdbarch
,
430 enum stap_arg_bitness b
,
431 const char *probe_name
)
435 case STAP_ARG_BITNESS_UNDEFINED
:
436 if (gdbarch_addr_bit (gdbarch
) == 32)
437 return builtin_type (gdbarch
)->builtin_uint32
;
439 return builtin_type (gdbarch
)->builtin_uint64
;
441 case STAP_ARG_BITNESS_8BIT_UNSIGNED
:
442 return builtin_type (gdbarch
)->builtin_uint8
;
444 case STAP_ARG_BITNESS_8BIT_SIGNED
:
445 return builtin_type (gdbarch
)->builtin_int8
;
447 case STAP_ARG_BITNESS_16BIT_UNSIGNED
:
448 return builtin_type (gdbarch
)->builtin_uint16
;
450 case STAP_ARG_BITNESS_16BIT_SIGNED
:
451 return builtin_type (gdbarch
)->builtin_int16
;
453 case STAP_ARG_BITNESS_32BIT_SIGNED
:
454 return builtin_type (gdbarch
)->builtin_int32
;
456 case STAP_ARG_BITNESS_32BIT_UNSIGNED
:
457 return builtin_type (gdbarch
)->builtin_uint32
;
459 case STAP_ARG_BITNESS_64BIT_SIGNED
:
460 return builtin_type (gdbarch
)->builtin_int64
;
462 case STAP_ARG_BITNESS_64BIT_UNSIGNED
:
463 return builtin_type (gdbarch
)->builtin_uint64
;
466 error (_("Undefined bitness for probe '%s'."), probe_name
);
471 /* Helper function to check for a generic list of prefixes. GDBARCH
472 is the current gdbarch being used. S is the expression being
473 analyzed. If R is not NULL, it will be used to return the found
474 prefix. PREFIXES is the list of expected prefixes.
476 This function does a case-insensitive match.
478 Return true if any prefix has been found, false otherwise. */
481 stap_is_generic_prefix (struct gdbarch
*gdbarch
, const char *s
,
482 const char **r
, const char *const *prefixes
)
484 const char *const *p
;
486 if (prefixes
== NULL
)
494 for (p
= prefixes
; *p
!= NULL
; ++p
)
495 if (strncasecmp (s
, *p
, strlen (*p
)) == 0)
506 /* Return true if S points to a register prefix, false otherwise. For
507 a description of the arguments, look at stap_is_generic_prefix. */
510 stap_is_register_prefix (struct gdbarch
*gdbarch
, const char *s
,
513 const char *const *t
= gdbarch_stap_register_prefixes (gdbarch
);
515 return stap_is_generic_prefix (gdbarch
, s
, r
, t
);
518 /* Return true if S points to a register indirection prefix, false
519 otherwise. For a description of the arguments, look at
520 stap_is_generic_prefix. */
523 stap_is_register_indirection_prefix (struct gdbarch
*gdbarch
, const char *s
,
526 const char *const *t
= gdbarch_stap_register_indirection_prefixes (gdbarch
);
528 return stap_is_generic_prefix (gdbarch
, s
, r
, t
);
531 /* Return true if S points to an integer prefix, false otherwise. For
532 a description of the arguments, look at stap_is_generic_prefix.
534 This function takes care of analyzing whether we are dealing with
535 an expected integer prefix, or, if there is no integer prefix to be
536 expected, whether we are dealing with a digit. It does a
537 case-insensitive match. */
540 stap_is_integer_prefix (struct gdbarch
*gdbarch
, const char *s
,
543 const char *const *t
= gdbarch_stap_integer_prefixes (gdbarch
);
544 const char *const *p
;
548 /* A NULL value here means that integers do not have a prefix.
549 We just check for a digit then. */
553 return isdigit (*s
) > 0;
556 for (p
= t
; *p
!= NULL
; ++p
)
558 size_t len
= strlen (*p
);
560 if ((len
== 0 && isdigit (*s
))
561 || (len
> 0 && strncasecmp (s
, *p
, len
) == 0))
563 /* Integers may or may not have a prefix. The "len == 0"
564 check covers the case when integers do not have a prefix
565 (therefore, we just check if we have a digit). The call
566 to "strncasecmp" covers the case when they have a
578 /* Helper function to check for a generic list of suffixes. If we are
579 not expecting any suffixes, then it just returns 1. If we are
580 expecting at least one suffix, then it returns true if a suffix has
581 been found, false otherwise. GDBARCH is the current gdbarch being
582 used. S is the expression being analyzed. If R is not NULL, it
583 will be used to return the found suffix. SUFFIXES is the list of
584 expected suffixes. This function does a case-insensitive
588 stap_generic_check_suffix (struct gdbarch
*gdbarch
, const char *s
,
589 const char **r
, const char *const *suffixes
)
591 const char *const *p
;
594 if (suffixes
== NULL
)
602 for (p
= suffixes
; *p
!= NULL
; ++p
)
603 if (strncasecmp (s
, *p
, strlen (*p
)) == 0)
615 /* Return true if S points to an integer suffix, false otherwise. For
616 a description of the arguments, look at
617 stap_generic_check_suffix. */
620 stap_check_integer_suffix (struct gdbarch
*gdbarch
, const char *s
,
623 const char *const *p
= gdbarch_stap_integer_suffixes (gdbarch
);
625 return stap_generic_check_suffix (gdbarch
, s
, r
, p
);
628 /* Return true if S points to a register suffix, false otherwise. For
629 a description of the arguments, look at
630 stap_generic_check_suffix. */
633 stap_check_register_suffix (struct gdbarch
*gdbarch
, const char *s
,
636 const char *const *p
= gdbarch_stap_register_suffixes (gdbarch
);
638 return stap_generic_check_suffix (gdbarch
, s
, r
, p
);
641 /* Return true if S points to a register indirection suffix, false
642 otherwise. For a description of the arguments, look at
643 stap_generic_check_suffix. */
646 stap_check_register_indirection_suffix (struct gdbarch
*gdbarch
, const char *s
,
649 const char *const *p
= gdbarch_stap_register_indirection_suffixes (gdbarch
);
651 return stap_generic_check_suffix (gdbarch
, s
, r
, p
);
654 /* Function responsible for parsing a register operand according to
655 SystemTap parlance. Assuming:
659 RIP = register indirection prefix
660 RIS = register indirection suffix
662 Then a register operand can be:
664 [RIP] [RP] REGISTER [RS] [RIS]
666 This function takes care of a register's indirection, displacement and
667 direct access. It also takes into consideration the fact that some
668 registers are named differently inside and outside GDB, e.g., PPC's
669 general-purpose registers are represented by integers in the assembly
670 language (e.g., `15' is the 15th general-purpose register), but inside
671 GDB they have a prefix (the letter `r') appended. */
674 stap_parse_register_operand (struct stap_parse_info
*p
)
676 /* Simple flag to indicate whether we have seen a minus signal before
678 bool got_minus
= false;
679 /* Flags to indicate whether this register access is being displaced and/or
682 bool indirect_p
= false;
683 struct gdbarch
*gdbarch
= p
->gdbarch
;
684 /* Needed to generate the register name as a part of an expression. */
686 /* Variables used to extract the register name from the probe's
689 const char *gdb_reg_prefix
= gdbarch_stap_gdb_register_prefix (gdbarch
);
690 const char *gdb_reg_suffix
= gdbarch_stap_gdb_register_suffix (gdbarch
);
691 const char *reg_prefix
;
692 const char *reg_ind_prefix
;
693 const char *reg_suffix
;
694 const char *reg_ind_suffix
;
696 /* Checking for a displacement argument. */
699 /* If it's a plus sign, we don't need to do anything, just advance the
703 else if (*p
->arg
== '-')
709 if (isdigit (*p
->arg
))
711 /* The value of the displacement. */
716 displacement
= strtol (p
->arg
, &endp
, 10);
719 /* Generating the expression for the displacement. */
720 write_exp_elt_opcode (&p
->pstate
, OP_LONG
);
721 write_exp_elt_type (&p
->pstate
, builtin_type (gdbarch
)->builtin_long
);
722 write_exp_elt_longcst (&p
->pstate
, displacement
);
723 write_exp_elt_opcode (&p
->pstate
, OP_LONG
);
725 write_exp_elt_opcode (&p
->pstate
, UNOP_NEG
);
728 /* Getting rid of register indirection prefix. */
729 if (stap_is_register_indirection_prefix (gdbarch
, p
->arg
, ®_ind_prefix
))
732 p
->arg
+= strlen (reg_ind_prefix
);
735 if (disp_p
&& !indirect_p
)
736 error (_("Invalid register displacement syntax on expression `%s'."),
739 /* Getting rid of register prefix. */
740 if (stap_is_register_prefix (gdbarch
, p
->arg
, ®_prefix
))
741 p
->arg
+= strlen (reg_prefix
);
743 /* Now we should have only the register name. Let's extract it and get
744 the associated number. */
747 /* We assume the register name is composed by letters and numbers. */
748 while (isalnum (*p
->arg
))
751 std::string
regname (start
, p
->arg
- start
);
753 /* We only add the GDB's register prefix/suffix if we are dealing with
754 a numeric register. */
755 if (isdigit (*start
))
757 if (gdb_reg_prefix
!= NULL
)
758 regname
= gdb_reg_prefix
+ regname
;
760 if (gdb_reg_suffix
!= NULL
)
761 regname
+= gdb_reg_suffix
;
764 int regnum
= user_reg_map_name_to_regnum (gdbarch
, regname
.c_str (),
767 /* Is this a valid register name? */
769 error (_("Invalid register name `%s' on expression `%s'."),
770 regname
.c_str (), p
->saved_arg
);
772 /* Check if there's any special treatment that the arch-specific
773 code would like to perform on the register name. */
774 if (gdbarch_stap_adjust_register_p (gdbarch
))
776 std::string newregname
777 = gdbarch_stap_adjust_register (gdbarch
, p
, regname
, regnum
);
779 if (regname
!= newregname
)
781 /* This is just a check we perform to make sure that the
782 arch-dependent code has provided us with a valid
784 regnum
= user_reg_map_name_to_regnum (gdbarch
, newregname
.c_str (),
788 internal_error (__FILE__
, __LINE__
,
789 _("Invalid register name '%s' after replacing it"
790 " (previous name was '%s')"),
791 newregname
.c_str (), regname
.c_str ());
793 regname
= newregname
;
797 write_exp_elt_opcode (&p
->pstate
, OP_REGISTER
);
798 str
.ptr
= regname
.c_str ();
799 str
.length
= regname
.size ();
800 write_exp_string (&p
->pstate
, str
);
801 write_exp_elt_opcode (&p
->pstate
, OP_REGISTER
);
806 write_exp_elt_opcode (&p
->pstate
, BINOP_ADD
);
808 /* Casting to the expected type. */
809 write_exp_elt_opcode (&p
->pstate
, UNOP_CAST
);
810 write_exp_elt_type (&p
->pstate
, lookup_pointer_type (p
->arg_type
));
811 write_exp_elt_opcode (&p
->pstate
, UNOP_CAST
);
813 write_exp_elt_opcode (&p
->pstate
, UNOP_IND
);
816 /* Getting rid of the register name suffix. */
817 if (stap_check_register_suffix (gdbarch
, p
->arg
, ®_suffix
))
818 p
->arg
+= strlen (reg_suffix
);
820 error (_("Missing register name suffix on expression `%s'."),
823 /* Getting rid of the register indirection suffix. */
826 if (stap_check_register_indirection_suffix (gdbarch
, p
->arg
,
828 p
->arg
+= strlen (reg_ind_suffix
);
830 error (_("Missing indirection suffix on expression `%s'."),
835 /* This function is responsible for parsing a single operand.
837 A single operand can be:
839 - an unary operation (e.g., `-5', `~2', or even with subexpressions
841 - a register displacement, which will be treated as a register
842 operand (e.g., `-4(%eax)' on x86)
843 - a numeric constant, or
844 - a register operand (see function `stap_parse_register_operand')
846 The function also calls special-handling functions to deal with
847 unrecognized operands, allowing arch-specific parsers to be
851 stap_parse_single_operand (struct stap_parse_info
*p
)
853 struct gdbarch
*gdbarch
= p
->gdbarch
;
854 const char *int_prefix
= NULL
;
856 /* We first try to parse this token as a "special token". */
857 if (gdbarch_stap_parse_special_token_p (gdbarch
)
858 && (gdbarch_stap_parse_special_token (gdbarch
, p
) != 0))
860 /* If the return value of the above function is not zero,
861 it means it successfully parsed the special token.
863 If it is NULL, we try to parse it using our method. */
867 if (*p
->arg
== '-' || *p
->arg
== '~' || *p
->arg
== '+')
870 /* We use this variable to do a lookahead. */
871 const char *tmp
= p
->arg
;
872 bool has_digit
= false;
874 /* Skipping signal. */
877 /* This is an unary operation. Here is a list of allowed tokens
881 - number (from register displacement)
882 - subexpression (beginning with `(')
884 We handle the register displacement here, and the other cases
886 if (p
->inside_paren_p
)
887 tmp
= skip_spaces (tmp
);
889 while (isdigit (*tmp
))
891 /* We skip the digit here because we are only interested in
892 knowing what kind of unary operation this is. The digit
893 will be handled by one of the functions that will be
894 called below ('stap_parse_argument_conditionally' or
895 'stap_parse_register_operand'). */
900 if (has_digit
&& stap_is_register_indirection_prefix (gdbarch
, tmp
,
903 /* If we are here, it means it is a displacement. The only
904 operations allowed here are `-' and `+'. */
905 if (c
!= '-' && c
!= '+')
906 error (_("Invalid operator `%c' for register displacement "
907 "on expression `%s'."), c
, p
->saved_arg
);
909 stap_parse_register_operand (p
);
913 /* This is not a displacement. We skip the operator, and
914 deal with it when the recursion returns. */
916 stap_parse_argument_conditionally (p
);
918 write_exp_elt_opcode (&p
->pstate
, UNOP_NEG
);
920 write_exp_elt_opcode (&p
->pstate
, UNOP_COMPLEMENT
);
923 else if (isdigit (*p
->arg
))
925 /* A temporary variable, needed for lookahead. */
926 const char *tmp
= p
->arg
;
930 /* We can be dealing with a numeric constant, or with a register
932 number
= strtol (tmp
, &endp
, 10);
935 if (p
->inside_paren_p
)
936 tmp
= skip_spaces (tmp
);
938 /* If "stap_is_integer_prefix" returns true, it means we can
939 accept integers without a prefix here. But we also need to
940 check whether the next token (i.e., "tmp") is not a register
941 indirection prefix. */
942 if (stap_is_integer_prefix (gdbarch
, p
->arg
, NULL
)
943 && !stap_is_register_indirection_prefix (gdbarch
, tmp
, NULL
))
945 const char *int_suffix
;
947 /* We are dealing with a numeric constant. */
948 write_exp_elt_opcode (&p
->pstate
, OP_LONG
);
949 write_exp_elt_type (&p
->pstate
,
950 builtin_type (gdbarch
)->builtin_long
);
951 write_exp_elt_longcst (&p
->pstate
, number
);
952 write_exp_elt_opcode (&p
->pstate
, OP_LONG
);
956 if (stap_check_integer_suffix (gdbarch
, p
->arg
, &int_suffix
))
957 p
->arg
+= strlen (int_suffix
);
959 error (_("Invalid constant suffix on expression `%s'."),
962 else if (stap_is_register_indirection_prefix (gdbarch
, tmp
, NULL
))
963 stap_parse_register_operand (p
);
965 error (_("Unknown numeric token on expression `%s'."),
968 else if (stap_is_integer_prefix (gdbarch
, p
->arg
, &int_prefix
))
970 /* We are dealing with a numeric constant. */
973 const char *int_suffix
;
975 p
->arg
+= strlen (int_prefix
);
976 number
= strtol (p
->arg
, &endp
, 10);
979 write_exp_elt_opcode (&p
->pstate
, OP_LONG
);
980 write_exp_elt_type (&p
->pstate
, builtin_type (gdbarch
)->builtin_long
);
981 write_exp_elt_longcst (&p
->pstate
, number
);
982 write_exp_elt_opcode (&p
->pstate
, OP_LONG
);
984 if (stap_check_integer_suffix (gdbarch
, p
->arg
, &int_suffix
))
985 p
->arg
+= strlen (int_suffix
);
987 error (_("Invalid constant suffix on expression `%s'."),
990 else if (stap_is_register_prefix (gdbarch
, p
->arg
, NULL
)
991 || stap_is_register_indirection_prefix (gdbarch
, p
->arg
, NULL
))
992 stap_parse_register_operand (p
);
994 error (_("Operator `%c' not recognized on expression `%s'."),
995 *p
->arg
, p
->saved_arg
);
998 /* This function parses an argument conditionally, based on single or
999 non-single operands. A non-single operand would be a parenthesized
1000 expression (e.g., `(2 + 1)'), and a single operand is anything that
1001 starts with `-', `~', `+' (i.e., unary operators), a digit, or
1002 something recognized by `gdbarch_stap_is_single_operand'. */
1005 stap_parse_argument_conditionally (struct stap_parse_info
*p
)
1007 gdb_assert (gdbarch_stap_is_single_operand_p (p
->gdbarch
));
1009 if (*p
->arg
== '-' || *p
->arg
== '~' || *p
->arg
== '+' /* Unary. */
1010 || isdigit (*p
->arg
)
1011 || gdbarch_stap_is_single_operand (p
->gdbarch
, p
->arg
))
1012 stap_parse_single_operand (p
);
1013 else if (*p
->arg
== '(')
1015 /* We are dealing with a parenthesized operand. It means we
1016 have to parse it as it was a separate expression, without
1017 left-side or precedence. */
1019 p
->arg
= skip_spaces (p
->arg
);
1020 ++p
->inside_paren_p
;
1022 stap_parse_argument_1 (p
, 0, STAP_OPERAND_PREC_NONE
);
1024 --p
->inside_paren_p
;
1026 error (_("Missign close-paren on expression `%s'."),
1030 if (p
->inside_paren_p
)
1031 p
->arg
= skip_spaces (p
->arg
);
1034 error (_("Cannot parse expression `%s'."), p
->saved_arg
);
1037 /* Helper function for `stap_parse_argument'. Please, see its comments to
1038 better understand what this function does. */
1041 stap_parse_argument_1 (struct stap_parse_info
*p
, bool has_lhs
,
1042 enum stap_operand_prec prec
)
1044 /* This is an operator-precedence parser.
1046 We work with left- and right-sides of expressions, and
1047 parse them depending on the precedence of the operators
1050 gdb_assert (p
->arg
!= NULL
);
1052 if (p
->inside_paren_p
)
1053 p
->arg
= skip_spaces (p
->arg
);
1057 /* We were called without a left-side, either because this is the
1058 first call, or because we were called to parse a parenthesized
1059 expression. It doesn't really matter; we have to parse the
1060 left-side in order to continue the process. */
1061 stap_parse_argument_conditionally (p
);
1064 /* Start to parse the right-side, and to "join" left and right sides
1065 depending on the operation specified.
1067 This loop shall continue until we run out of characters in the input,
1068 or until we find a close-parenthesis, which means that we've reached
1069 the end of a sub-expression. */
1070 while (*p
->arg
!= '\0' && *p
->arg
!= ')' && !isspace (*p
->arg
))
1072 const char *tmp_exp_buf
;
1073 enum exp_opcode opcode
;
1074 enum stap_operand_prec cur_prec
;
1076 if (!stap_is_operator (p
->arg
))
1077 error (_("Invalid operator `%c' on expression `%s'."), *p
->arg
,
1080 /* We have to save the current value of the expression buffer because
1081 the `stap_get_opcode' modifies it in order to get the current
1082 operator. If this operator's precedence is lower than PREC, we
1083 should return and not advance the expression buffer pointer. */
1084 tmp_exp_buf
= p
->arg
;
1085 opcode
= stap_get_opcode (&tmp_exp_buf
);
1087 cur_prec
= stap_get_operator_prec (opcode
);
1088 if (cur_prec
< prec
)
1090 /* If the precedence of the operator that we are seeing now is
1091 lower than the precedence of the first operator seen before
1092 this parsing process began, it means we should stop parsing
1097 p
->arg
= tmp_exp_buf
;
1098 if (p
->inside_paren_p
)
1099 p
->arg
= skip_spaces (p
->arg
);
1101 /* Parse the right-side of the expression. */
1102 stap_parse_argument_conditionally (p
);
1104 /* While we still have operators, try to parse another
1105 right-side, but using the current right-side as a left-side. */
1106 while (*p
->arg
!= '\0' && stap_is_operator (p
->arg
))
1108 enum exp_opcode lookahead_opcode
;
1109 enum stap_operand_prec lookahead_prec
;
1111 /* Saving the current expression buffer position. The explanation
1112 is the same as above. */
1113 tmp_exp_buf
= p
->arg
;
1114 lookahead_opcode
= stap_get_opcode (&tmp_exp_buf
);
1115 lookahead_prec
= stap_get_operator_prec (lookahead_opcode
);
1117 if (lookahead_prec
<= prec
)
1119 /* If we are dealing with an operator whose precedence is lower
1120 than the first one, just abandon the attempt. */
1124 /* Parse the right-side of the expression, but since we already
1125 have a left-side at this point, set `has_lhs' to 1. */
1126 stap_parse_argument_1 (p
, 1, lookahead_prec
);
1129 write_exp_elt_opcode (&p
->pstate
, opcode
);
1133 /* Parse a probe's argument.
1137 LP = literal integer prefix
1138 LS = literal integer suffix
1140 RP = register prefix
1141 RS = register suffix
1143 RIP = register indirection prefix
1144 RIS = register indirection suffix
1146 This routine assumes that arguments' tokens are of the form:
1149 - [RP] REGISTER [RS]
1150 - [RIP] [RP] REGISTER [RS] [RIS]
1151 - If we find a number without LP, we try to parse it as a literal integer
1152 constant (if LP == NULL), or as a register displacement.
1153 - We count parenthesis, and only skip whitespaces if we are inside them.
1154 - If we find an operator, we skip it.
1156 This function can also call a special function that will try to match
1157 unknown tokens. It will return the expression_up generated from
1158 parsing the argument. */
1160 static expression_up
1161 stap_parse_argument (const char **arg
, struct type
*atype
,
1162 struct gdbarch
*gdbarch
)
1164 /* We need to initialize the expression buffer, in order to begin
1165 our parsing efforts. We use language_c here because we may need
1166 to do pointer arithmetics. */
1167 struct stap_parse_info
p (*arg
, atype
, language_def (language_c
),
1170 stap_parse_argument_1 (&p
, 0, STAP_OPERAND_PREC_NONE
);
1172 gdb_assert (p
.inside_paren_p
== 0);
1174 /* Casting the final expression to the appropriate type. */
1175 write_exp_elt_opcode (&p
.pstate
, UNOP_CAST
);
1176 write_exp_elt_type (&p
.pstate
, atype
);
1177 write_exp_elt_opcode (&p
.pstate
, UNOP_CAST
);
1179 p
.arg
= skip_spaces (p
.arg
);
1182 return p
.pstate
.release ();
1185 /* Implementation of 'parse_arguments' method. */
1188 stap_probe::parse_arguments (struct gdbarch
*gdbarch
)
1192 gdb_assert (!m_have_parsed_args
);
1193 cur
= m_unparsed_args_text
;
1194 m_have_parsed_args
= true;
1196 if (cur
== NULL
|| *cur
== '\0' || *cur
== ':')
1199 while (*cur
!= '\0')
1201 enum stap_arg_bitness bitness
;
1202 bool got_minus
= false;
1204 /* We expect to find something like:
1208 Where `N' can be [+,-][1,2,4,8]. This is not mandatory, so
1209 we check it here. If we don't find it, go to the next
1211 if ((cur
[0] == '-' && isdigit (cur
[1]) && cur
[2] == '@')
1212 || (isdigit (cur
[0]) && cur
[1] == '@'))
1216 /* Discard the `-'. */
1221 /* Defining the bitness. */
1225 bitness
= (got_minus
? STAP_ARG_BITNESS_8BIT_SIGNED
1226 : STAP_ARG_BITNESS_8BIT_UNSIGNED
);
1230 bitness
= (got_minus
? STAP_ARG_BITNESS_16BIT_SIGNED
1231 : STAP_ARG_BITNESS_16BIT_UNSIGNED
);
1235 bitness
= (got_minus
? STAP_ARG_BITNESS_32BIT_SIGNED
1236 : STAP_ARG_BITNESS_32BIT_UNSIGNED
);
1240 bitness
= (got_minus
? STAP_ARG_BITNESS_64BIT_SIGNED
1241 : STAP_ARG_BITNESS_64BIT_UNSIGNED
);
1246 /* We have an error, because we don't expect anything
1247 except 1, 2, 4 and 8. */
1248 warning (_("unrecognized bitness %s%c' for probe `%s'"),
1249 got_minus
? "`-" : "`", *cur
,
1250 this->get_name ().c_str ());
1254 /* Discard the number and the `@' sign. */
1258 bitness
= STAP_ARG_BITNESS_UNDEFINED
;
1261 = stap_get_expected_argument_type (gdbarch
, bitness
,
1262 this->get_name ().c_str ());
1264 expression_up expr
= stap_parse_argument (&cur
, atype
, gdbarch
);
1266 if (stap_expression_debug
)
1267 dump_raw_expression (expr
.get (), gdb_stdlog
,
1268 "before conversion to prefix form");
1270 prefixify_expression (expr
.get ());
1272 if (stap_expression_debug
)
1273 dump_prefix_expression (expr
.get (), gdb_stdlog
);
1275 m_parsed_args
.emplace_back (bitness
, atype
, std::move (expr
));
1277 /* Start it over again. */
1278 cur
= skip_spaces (cur
);
1282 /* Helper function to relocate an address. */
1285 relocate_address (CORE_ADDR address
, struct objfile
*objfile
)
1287 return address
+ ANOFFSET (objfile
->section_offsets
,
1288 SECT_OFF_DATA (objfile
));
1291 /* Implementation of the get_relocated_address method. */
1294 stap_probe::get_relocated_address (struct objfile
*objfile
)
1296 return relocate_address (this->get_address (), objfile
);
1299 /* Given PROBE, returns the number of arguments present in that probe's
1303 stap_probe::get_argument_count (struct gdbarch
*gdbarch
)
1305 if (!m_have_parsed_args
)
1307 if (this->can_evaluate_arguments ())
1308 this->parse_arguments (gdbarch
);
1311 static bool have_warned_stap_incomplete
= false;
1313 if (!have_warned_stap_incomplete
)
1316 "The SystemTap SDT probe support is not fully implemented on this target;\n"
1317 "you will not be able to inspect the arguments of the probes.\n"
1318 "Please report a bug against GDB requesting a port to this target."));
1319 have_warned_stap_incomplete
= true;
1322 /* Marking the arguments as "already parsed". */
1323 m_have_parsed_args
= true;
1327 gdb_assert (m_have_parsed_args
);
1328 return m_parsed_args
.size ();
1331 /* Return true if OP is a valid operator inside a probe argument, or
1335 stap_is_operator (const char *op
)
1360 /* We didn't find any operator. */
1367 /* Implement the `can_evaluate_arguments' method. */
1370 stap_probe::can_evaluate_arguments () const
1372 struct gdbarch
*gdbarch
= this->get_gdbarch ();
1374 /* For SystemTap probes, we have to guarantee that the method
1375 stap_is_single_operand is defined on gdbarch. If it is not, then it
1376 means that argument evaluation is not implemented on this target. */
1377 return gdbarch_stap_is_single_operand_p (gdbarch
);
1380 /* Evaluate the probe's argument N (indexed from 0), returning a value
1381 corresponding to it. Assertion is thrown if N does not exist. */
1384 stap_probe::evaluate_argument (unsigned n
, struct frame_info
*frame
)
1386 struct stap_probe_arg
*arg
;
1388 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1390 arg
= this->get_arg_by_number (n
, gdbarch
);
1391 return evaluate_subexp_standard (arg
->atype
, arg
->aexpr
.get (), &pos
,
1395 /* Compile the probe's argument N (indexed from 0) to agent expression.
1396 Assertion is thrown if N does not exist. */
1399 stap_probe::compile_to_ax (struct agent_expr
*expr
, struct axs_value
*value
,
1402 struct stap_probe_arg
*arg
;
1403 union exp_element
*pc
;
1405 arg
= this->get_arg_by_number (n
, expr
->gdbarch
);
1407 pc
= arg
->aexpr
->elts
;
1408 gen_expr (arg
->aexpr
.get (), &pc
, expr
, value
);
1410 require_rvalue (expr
, value
);
1411 value
->type
= arg
->atype
;
1415 /* Set or clear a SystemTap semaphore. ADDRESS is the semaphore's
1416 address. SET is zero if the semaphore should be cleared, or one if
1417 it should be set. This is a helper function for
1418 'stap_probe::set_semaphore' and 'stap_probe::clear_semaphore'. */
1421 stap_modify_semaphore (CORE_ADDR address
, int set
, struct gdbarch
*gdbarch
)
1423 gdb_byte bytes
[sizeof (LONGEST
)];
1424 /* The ABI specifies "unsigned short". */
1425 struct type
*type
= builtin_type (gdbarch
)->builtin_unsigned_short
;
1431 /* Swallow errors. */
1432 if (target_read_memory (address
, bytes
, TYPE_LENGTH (type
)) != 0)
1434 warning (_("Could not read the value of a SystemTap semaphore."));
1438 enum bfd_endian byte_order
= type_byte_order (type
);
1439 value
= extract_unsigned_integer (bytes
, TYPE_LENGTH (type
), byte_order
);
1440 /* Note that we explicitly don't worry about overflow or
1447 store_unsigned_integer (bytes
, TYPE_LENGTH (type
), byte_order
, value
);
1449 if (target_write_memory (address
, bytes
, TYPE_LENGTH (type
)) != 0)
1450 warning (_("Could not write the value of a SystemTap semaphore."));
1453 /* Implementation of the 'set_semaphore' method.
1455 SystemTap semaphores act as reference counters, so calls to this
1456 function must be paired with calls to 'clear_semaphore'.
1458 This function and 'clear_semaphore' race with another tool
1459 changing the probes, but that is too rare to care. */
1462 stap_probe::set_semaphore (struct objfile
*objfile
, struct gdbarch
*gdbarch
)
1464 stap_modify_semaphore (relocate_address (m_sem_addr
, objfile
), 1, gdbarch
);
1467 /* Implementation of the 'clear_semaphore' method. */
1470 stap_probe::clear_semaphore (struct objfile
*objfile
, struct gdbarch
*gdbarch
)
1472 stap_modify_semaphore (relocate_address (m_sem_addr
, objfile
), 0, gdbarch
);
1475 /* Implementation of the 'get_static_ops' method. */
1477 const static_probe_ops
*
1478 stap_probe::get_static_ops () const
1480 return &stap_static_probe_ops
;
1483 /* Implementation of the 'gen_info_probes_table_values' method. */
1485 std::vector
<const char *>
1486 stap_probe::gen_info_probes_table_values () const
1488 const char *val
= NULL
;
1490 if (m_sem_addr
!= 0)
1491 val
= print_core_address (this->get_gdbarch (), m_sem_addr
);
1493 return std::vector
<const char *> { val
};
1496 /* Helper function that parses the information contained in a
1497 SystemTap's probe. Basically, the information consists in:
1499 - Probe's PC address;
1500 - Link-time section address of `.stapsdt.base' section;
1501 - Link-time address of the semaphore variable, or ZERO if the
1502 probe doesn't have an associated semaphore;
1503 - Probe's provider name;
1505 - Probe's argument format. */
1508 handle_stap_probe (struct objfile
*objfile
, struct sdt_note
*el
,
1509 std::vector
<std::unique_ptr
<probe
>> *probesp
,
1512 bfd
*abfd
= objfile
->obfd
;
1513 int size
= bfd_get_arch_size (abfd
) / 8;
1514 struct gdbarch
*gdbarch
= get_objfile_arch (objfile
);
1515 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_data_ptr
;
1517 /* Provider and the name of the probe. */
1518 const char *provider
= (const char *) &el
->data
[3 * size
];
1519 const char *name
= ((const char *)
1520 memchr (provider
, '\0',
1521 (char *) el
->data
+ el
->size
- provider
));
1522 /* Making sure there is a name. */
1525 complaint (_("corrupt probe name when reading `%s'"),
1526 objfile_name (objfile
));
1528 /* There is no way to use a probe without a name or a provider, so
1529 returning here makes sense. */
1535 /* Retrieving the probe's address. */
1536 CORE_ADDR address
= extract_typed_address (&el
->data
[0], ptr_type
);
1538 /* Link-time sh_addr of `.stapsdt.base' section. */
1539 CORE_ADDR base_ref
= extract_typed_address (&el
->data
[size
], ptr_type
);
1541 /* Semaphore address. */
1542 CORE_ADDR sem_addr
= extract_typed_address (&el
->data
[2 * size
], ptr_type
);
1544 address
+= base
- base_ref
;
1546 sem_addr
+= base
- base_ref
;
1548 /* Arguments. We can only extract the argument format if there is a valid
1549 name for this probe. */
1550 const char *probe_args
= ((const char*)
1552 (char *) el
->data
+ el
->size
- name
));
1554 if (probe_args
!= NULL
)
1557 if (probe_args
== NULL
1558 || (memchr (probe_args
, '\0', (char *) el
->data
+ el
->size
- name
)
1559 != el
->data
+ el
->size
- 1))
1561 complaint (_("corrupt probe argument when reading `%s'"),
1562 objfile_name (objfile
));
1563 /* If the argument string is NULL, it means some problem happened with
1564 it. So we return. */
1568 stap_probe
*ret
= new stap_probe (std::string (name
), std::string (provider
),
1569 address
, gdbarch
, sem_addr
, probe_args
);
1571 /* Successfully created probe. */
1572 probesp
->emplace_back (ret
);
1575 /* Helper function which tries to find the base address of the SystemTap
1576 base section named STAP_BASE_SECTION_NAME. */
1579 get_stap_base_address_1 (bfd
*abfd
, asection
*sect
, void *obj
)
1581 asection
**ret
= (asection
**) obj
;
1583 if ((sect
->flags
& (SEC_DATA
| SEC_ALLOC
| SEC_HAS_CONTENTS
))
1584 && sect
->name
&& !strcmp (sect
->name
, STAP_BASE_SECTION_NAME
))
1588 /* Helper function which iterates over every section in the BFD file,
1589 trying to find the base address of the SystemTap base section.
1590 Returns 1 if found (setting BASE to the proper value), zero otherwise. */
1593 get_stap_base_address (bfd
*obfd
, bfd_vma
*base
)
1595 asection
*ret
= NULL
;
1597 bfd_map_over_sections (obfd
, get_stap_base_address_1
, (void *) &ret
);
1601 complaint (_("could not obtain base address for "
1602 "SystemTap section on objfile `%s'."),
1613 /* Implementation of the 'is_linespec' method. */
1616 stap_static_probe_ops::is_linespec (const char **linespecp
) const
1618 static const char *const keywords
[] = { "-pstap", "-probe-stap", NULL
};
1620 return probe_is_linespec_by_keyword (linespecp
, keywords
);
1623 /* Implementation of the 'get_probes' method. */
1626 stap_static_probe_ops::get_probes
1627 (std::vector
<std::unique_ptr
<probe
>> *probesp
,
1628 struct objfile
*objfile
) const
1630 /* If we are here, then this is the first time we are parsing the
1631 SystemTap probe's information. We basically have to count how many
1632 probes the objfile has, and then fill in the necessary information
1634 bfd
*obfd
= objfile
->obfd
;
1636 struct sdt_note
*iter
;
1637 unsigned save_probesp_len
= probesp
->size ();
1639 if (objfile
->separate_debug_objfile_backlink
!= NULL
)
1641 /* This is a .debug file, not the objfile itself. */
1645 if (elf_tdata (obfd
)->sdt_note_head
== NULL
)
1647 /* There isn't any probe here. */
1651 if (!get_stap_base_address (obfd
, &base
))
1653 /* There was an error finding the base address for the section.
1654 Just return NULL. */
1658 /* Parsing each probe's information. */
1659 for (iter
= elf_tdata (obfd
)->sdt_note_head
;
1663 /* We first have to handle all the information about the
1664 probe which is present in the section. */
1665 handle_stap_probe (objfile
, iter
, probesp
, base
);
1668 if (save_probesp_len
== probesp
->size ())
1670 /* If we are here, it means we have failed to parse every known
1672 complaint (_("could not parse SystemTap probe(s) from inferior"));
1677 /* Implementation of the type_name method. */
1680 stap_static_probe_ops::type_name () const
1685 /* Implementation of the 'gen_info_probes_table_header' method. */
1687 std::vector
<struct info_probe_column
>
1688 stap_static_probe_ops::gen_info_probes_table_header () const
1690 struct info_probe_column stap_probe_column
;
1692 stap_probe_column
.field_name
= "semaphore";
1693 stap_probe_column
.print_name
= _("Semaphore");
1695 return std::vector
<struct info_probe_column
> { stap_probe_column
};
1698 /* Implementation of the `info probes stap' command. */
1701 info_probes_stap_command (const char *arg
, int from_tty
)
1703 info_probes_for_spops (arg
, from_tty
, &stap_static_probe_ops
);
1707 _initialize_stap_probe (void)
1709 all_static_probe_ops
.push_back (&stap_static_probe_ops
);
1711 add_setshow_zuinteger_cmd ("stap-expression", class_maintenance
,
1712 &stap_expression_debug
,
1713 _("Set SystemTap expression debugging."),
1714 _("Show SystemTap expression debugging."),
1715 _("When non-zero, the internal representation "
1716 "of SystemTap expressions will be printed."),
1718 show_stapexpressiondebug
,
1719 &setdebuglist
, &showdebuglist
);
1721 add_cmd ("stap", class_info
, info_probes_stap_command
,
1723 Show information about SystemTap static probes.\n\
1724 Usage: info probes stap [PROVIDER [NAME [OBJECT]]]\n\
1725 Each argument is a regular expression, used to select probes.\n\
1726 PROVIDER matches probe provider names.\n\
1727 NAME matches the probe names.\n\
1728 OBJECT matches the executable or shared library name."),
1729 info_probes_cmdlist_get ());