1 /* SystemTap probe support for GDB.
3 Copyright (C) 2012-2018 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"
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<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, int has_lhs,
261 enum stap_operand_prec prec);
263 static void stap_parse_argument_conditionally (struct stap_parse_info *p);
265 /* Returns 1 if *S is an operator, zero otherwise. */
267 static int 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 and fills the OP pointer with its code.
320 Return 1 on success, zero if the operator was not recognized. */
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 *'. */
428 stap_get_expected_argument_type (struct gdbarch *gdbarch,
429 enum stap_arg_bitness b,
430 const char *probe_name)
434 case STAP_ARG_BITNESS_UNDEFINED:
435 if (gdbarch_addr_bit (gdbarch) == 32)
436 return builtin_type (gdbarch)->builtin_uint32;
438 return builtin_type (gdbarch)->builtin_uint64;
440 case STAP_ARG_BITNESS_8BIT_UNSIGNED:
441 return builtin_type (gdbarch)->builtin_uint8;
443 case STAP_ARG_BITNESS_8BIT_SIGNED:
444 return builtin_type (gdbarch)->builtin_int8;
446 case STAP_ARG_BITNESS_16BIT_UNSIGNED:
447 return builtin_type (gdbarch)->builtin_uint16;
449 case STAP_ARG_BITNESS_16BIT_SIGNED:
450 return builtin_type (gdbarch)->builtin_int16;
452 case STAP_ARG_BITNESS_32BIT_SIGNED:
453 return builtin_type (gdbarch)->builtin_int32;
455 case STAP_ARG_BITNESS_32BIT_UNSIGNED:
456 return builtin_type (gdbarch)->builtin_uint32;
458 case STAP_ARG_BITNESS_64BIT_SIGNED:
459 return builtin_type (gdbarch)->builtin_int64;
461 case STAP_ARG_BITNESS_64BIT_UNSIGNED:
462 return builtin_type (gdbarch)->builtin_uint64;
465 error (_("Undefined bitness for probe '%s'."), probe_name);
470 /* Helper function to check for a generic list of prefixes. GDBARCH
471 is the current gdbarch being used. S is the expression being
472 analyzed. If R is not NULL, it will be used to return the found
473 prefix. PREFIXES is the list of expected prefixes.
475 This function does a case-insensitive match.
477 Return 1 if any prefix has been found, zero otherwise. */
480 stap_is_generic_prefix (struct gdbarch *gdbarch, const char *s,
481 const char **r, const char *const *prefixes)
483 const char *const *p;
485 if (prefixes == NULL)
493 for (p = prefixes; *p != NULL; ++p)
494 if (strncasecmp (s, *p, strlen (*p)) == 0)
505 /* Return 1 if S points to a register prefix, zero otherwise. For a
506 description of the arguments, look at stap_is_generic_prefix. */
509 stap_is_register_prefix (struct gdbarch *gdbarch, const char *s,
512 const char *const *t = gdbarch_stap_register_prefixes (gdbarch);
514 return stap_is_generic_prefix (gdbarch, s, r, t);
517 /* Return 1 if S points to a register indirection prefix, zero
518 otherwise. For a description of the arguments, look at
519 stap_is_generic_prefix. */
522 stap_is_register_indirection_prefix (struct gdbarch *gdbarch, const char *s,
525 const char *const *t = gdbarch_stap_register_indirection_prefixes (gdbarch);
527 return stap_is_generic_prefix (gdbarch, s, r, t);
530 /* Return 1 if S points to an integer prefix, zero otherwise. For a
531 description of the arguments, look at stap_is_generic_prefix.
533 This function takes care of analyzing whether we are dealing with
534 an expected integer prefix, or, if there is no integer prefix to be
535 expected, whether we are dealing with a digit. It does a
536 case-insensitive match. */
539 stap_is_integer_prefix (struct gdbarch *gdbarch, const char *s,
542 const char *const *t = gdbarch_stap_integer_prefixes (gdbarch);
543 const char *const *p;
547 /* A NULL value here means that integers do not have a prefix.
548 We just check for a digit then. */
555 for (p = t; *p != NULL; ++p)
557 size_t len = strlen (*p);
559 if ((len == 0 && isdigit (*s))
560 || (len > 0 && strncasecmp (s, *p, len) == 0))
562 /* Integers may or may not have a prefix. The "len == 0"
563 check covers the case when integers do not have a prefix
564 (therefore, we just check if we have a digit). The call
565 to "strncasecmp" covers the case when they have a
577 /* Helper function to check for a generic list of suffixes. If we are
578 not expecting any suffixes, then it just returns 1. If we are
579 expecting at least one suffix, then it returns 1 if a suffix has
580 been found, zero otherwise. GDBARCH is the current gdbarch being
581 used. S is the expression being analyzed. If R is not NULL, it
582 will be used to return the found suffix. SUFFIXES is the list of
583 expected suffixes. This function does a case-insensitive
587 stap_generic_check_suffix (struct gdbarch *gdbarch, const char *s,
588 const char **r, const char *const *suffixes)
590 const char *const *p;
593 if (suffixes == NULL)
601 for (p = suffixes; *p != NULL; ++p)
602 if (strncasecmp (s, *p, strlen (*p)) == 0)
614 /* Return 1 if S points to an integer suffix, zero otherwise. For a
615 description of the arguments, look at
616 stap_generic_check_suffix. */
619 stap_check_integer_suffix (struct gdbarch *gdbarch, const char *s,
622 const char *const *p = gdbarch_stap_integer_suffixes (gdbarch);
624 return stap_generic_check_suffix (gdbarch, s, r, p);
627 /* Return 1 if S points to a register suffix, zero otherwise. For a
628 description of the arguments, look at
629 stap_generic_check_suffix. */
632 stap_check_register_suffix (struct gdbarch *gdbarch, const char *s,
635 const char *const *p = gdbarch_stap_register_suffixes (gdbarch);
637 return stap_generic_check_suffix (gdbarch, s, r, p);
640 /* Return 1 if S points to a register indirection suffix, zero
641 otherwise. For a description of the arguments, look at
642 stap_generic_check_suffix. */
645 stap_check_register_indirection_suffix (struct gdbarch *gdbarch, const char *s,
648 const char *const *p = gdbarch_stap_register_indirection_suffixes (gdbarch);
650 return stap_generic_check_suffix (gdbarch, s, r, p);
653 /* Function responsible for parsing a register operand according to
654 SystemTap parlance. Assuming:
658 RIP = register indirection prefix
659 RIS = register indirection suffix
661 Then a register operand can be:
663 [RIP] [RP] REGISTER [RS] [RIS]
665 This function takes care of a register's indirection, displacement and
666 direct access. It also takes into consideration the fact that some
667 registers are named differently inside and outside GDB, e.g., PPC's
668 general-purpose registers are represented by integers in the assembly
669 language (e.g., `15' is the 15th general-purpose register), but inside
670 GDB they have a prefix (the letter `r') appended. */
673 stap_parse_register_operand (struct stap_parse_info *p)
675 /* Simple flag to indicate whether we have seen a minus signal before
678 /* Flags to indicate whether this register access is being displaced and/or
680 int disp_p = 0, indirect_p = 0;
681 struct gdbarch *gdbarch = p->gdbarch;
682 /* Needed to generate the register name as a part of an expression. */
684 /* Variables used to extract the register name from the probe's
689 const char *gdb_reg_prefix = gdbarch_stap_gdb_register_prefix (gdbarch);
690 int gdb_reg_prefix_len = gdb_reg_prefix ? strlen (gdb_reg_prefix) : 0;
691 const char *gdb_reg_suffix = gdbarch_stap_gdb_register_suffix (gdbarch);
692 int gdb_reg_suffix_len = gdb_reg_suffix ? strlen (gdb_reg_suffix) : 0;
693 const char *reg_prefix;
694 const char *reg_ind_prefix;
695 const char *reg_suffix;
696 const char *reg_ind_suffix;
698 /* Checking for a displacement argument. */
701 /* If it's a plus sign, we don't need to do anything, just advance the
712 if (isdigit (*p->arg))
714 /* The value of the displacement. */
719 displacement = strtol (p->arg, &endp, 10);
722 /* Generating the expression for the displacement. */
723 write_exp_elt_opcode (&p->pstate, OP_LONG);
724 write_exp_elt_type (&p->pstate, builtin_type (gdbarch)->builtin_long);
725 write_exp_elt_longcst (&p->pstate, displacement);
726 write_exp_elt_opcode (&p->pstate, OP_LONG);
728 write_exp_elt_opcode (&p->pstate, UNOP_NEG);
731 /* Getting rid of register indirection prefix. */
732 if (stap_is_register_indirection_prefix (gdbarch, p->arg, ®_ind_prefix))
735 p->arg += strlen (reg_ind_prefix);
738 if (disp_p && !indirect_p)
739 error (_("Invalid register displacement syntax on expression `%s'."),
742 /* Getting rid of register prefix. */
743 if (stap_is_register_prefix (gdbarch, p->arg, ®_prefix))
744 p->arg += strlen (reg_prefix);
746 /* Now we should have only the register name. Let's extract it and get
747 the associated number. */
750 /* We assume the register name is composed by letters and numbers. */
751 while (isalnum (*p->arg))
754 len = p->arg - start;
756 regname = (char *) alloca (len + gdb_reg_prefix_len + gdb_reg_suffix_len + 1);
759 /* We only add the GDB's register prefix/suffix if we are dealing with
760 a numeric register. */
761 if (gdb_reg_prefix && isdigit (*start))
763 strncpy (regname, gdb_reg_prefix, gdb_reg_prefix_len);
764 strncpy (regname + gdb_reg_prefix_len, start, len);
767 strncpy (regname + gdb_reg_prefix_len + len,
768 gdb_reg_suffix, gdb_reg_suffix_len);
770 len += gdb_reg_prefix_len + gdb_reg_suffix_len;
773 strncpy (regname, start, len);
777 /* Is this a valid register name? */
778 if (user_reg_map_name_to_regnum (gdbarch, regname, len) == -1)
779 error (_("Invalid register name `%s' on expression `%s'."),
780 regname, p->saved_arg);
782 write_exp_elt_opcode (&p->pstate, OP_REGISTER);
785 write_exp_string (&p->pstate, str);
786 write_exp_elt_opcode (&p->pstate, OP_REGISTER);
791 write_exp_elt_opcode (&p->pstate, BINOP_ADD);
793 /* Casting to the expected type. */
794 write_exp_elt_opcode (&p->pstate, UNOP_CAST);
795 write_exp_elt_type (&p->pstate, lookup_pointer_type (p->arg_type));
796 write_exp_elt_opcode (&p->pstate, UNOP_CAST);
798 write_exp_elt_opcode (&p->pstate, UNOP_IND);
801 /* Getting rid of the register name suffix. */
802 if (stap_check_register_suffix (gdbarch, p->arg, ®_suffix))
803 p->arg += strlen (reg_suffix);
805 error (_("Missing register name suffix on expression `%s'."),
808 /* Getting rid of the register indirection suffix. */
811 if (stap_check_register_indirection_suffix (gdbarch, p->arg,
813 p->arg += strlen (reg_ind_suffix);
815 error (_("Missing indirection suffix on expression `%s'."),
820 /* This function is responsible for parsing a single operand.
822 A single operand can be:
824 - an unary operation (e.g., `-5', `~2', or even with subexpressions
826 - a register displacement, which will be treated as a register
827 operand (e.g., `-4(%eax)' on x86)
828 - a numeric constant, or
829 - a register operand (see function `stap_parse_register_operand')
831 The function also calls special-handling functions to deal with
832 unrecognized operands, allowing arch-specific parsers to be
836 stap_parse_single_operand (struct stap_parse_info *p)
838 struct gdbarch *gdbarch = p->gdbarch;
839 const char *int_prefix = NULL;
841 /* We first try to parse this token as a "special token". */
842 if (gdbarch_stap_parse_special_token_p (gdbarch))
843 if (gdbarch_stap_parse_special_token (gdbarch, p) != 0)
845 /* If the return value of the above function is not zero,
846 it means it successfully parsed the special token.
848 If it is NULL, we try to parse it using our method. */
852 if (*p->arg == '-' || *p->arg == '~' || *p->arg == '+')
855 /* We use this variable to do a lookahead. */
856 const char *tmp = p->arg;
859 /* Skipping signal. */
862 /* This is an unary operation. Here is a list of allowed tokens
866 - number (from register displacement)
867 - subexpression (beginning with `(')
869 We handle the register displacement here, and the other cases
871 if (p->inside_paren_p)
872 tmp = skip_spaces (tmp);
874 while (isdigit (*tmp))
876 /* We skip the digit here because we are only interested in
877 knowing what kind of unary operation this is. The digit
878 will be handled by one of the functions that will be
879 called below ('stap_parse_argument_conditionally' or
880 'stap_parse_register_operand'). */
885 if (has_digit && stap_is_register_indirection_prefix (gdbarch, tmp,
888 /* If we are here, it means it is a displacement. The only
889 operations allowed here are `-' and `+'. */
891 error (_("Invalid operator `%c' for register displacement "
892 "on expression `%s'."), c, p->saved_arg);
894 stap_parse_register_operand (p);
898 /* This is not a displacement. We skip the operator, and
899 deal with it when the recursion returns. */
901 stap_parse_argument_conditionally (p);
903 write_exp_elt_opcode (&p->pstate, UNOP_NEG);
905 write_exp_elt_opcode (&p->pstate, UNOP_COMPLEMENT);
908 else if (isdigit (*p->arg))
910 /* A temporary variable, needed for lookahead. */
911 const char *tmp = p->arg;
915 /* We can be dealing with a numeric constant, or with a register
917 number = strtol (tmp, &endp, 10);
920 if (p->inside_paren_p)
921 tmp = skip_spaces (tmp);
923 /* If "stap_is_integer_prefix" returns true, it means we can
924 accept integers without a prefix here. But we also need to
925 check whether the next token (i.e., "tmp") is not a register
926 indirection prefix. */
927 if (stap_is_integer_prefix (gdbarch, p->arg, NULL)
928 && !stap_is_register_indirection_prefix (gdbarch, tmp, NULL))
930 const char *int_suffix;
932 /* We are dealing with a numeric constant. */
933 write_exp_elt_opcode (&p->pstate, OP_LONG);
934 write_exp_elt_type (&p->pstate,
935 builtin_type (gdbarch)->builtin_long);
936 write_exp_elt_longcst (&p->pstate, number);
937 write_exp_elt_opcode (&p->pstate, OP_LONG);
941 if (stap_check_integer_suffix (gdbarch, p->arg, &int_suffix))
942 p->arg += strlen (int_suffix);
944 error (_("Invalid constant suffix on expression `%s'."),
947 else if (stap_is_register_indirection_prefix (gdbarch, tmp, NULL))
948 stap_parse_register_operand (p);
950 error (_("Unknown numeric token on expression `%s'."),
953 else if (stap_is_integer_prefix (gdbarch, p->arg, &int_prefix))
955 /* We are dealing with a numeric constant. */
958 const char *int_suffix;
960 p->arg += strlen (int_prefix);
961 number = strtol (p->arg, &endp, 10);
964 write_exp_elt_opcode (&p->pstate, OP_LONG);
965 write_exp_elt_type (&p->pstate, builtin_type (gdbarch)->builtin_long);
966 write_exp_elt_longcst (&p->pstate, number);
967 write_exp_elt_opcode (&p->pstate, OP_LONG);
969 if (stap_check_integer_suffix (gdbarch, p->arg, &int_suffix))
970 p->arg += strlen (int_suffix);
972 error (_("Invalid constant suffix on expression `%s'."),
975 else if (stap_is_register_prefix (gdbarch, p->arg, NULL)
976 || stap_is_register_indirection_prefix (gdbarch, p->arg, NULL))
977 stap_parse_register_operand (p);
979 error (_("Operator `%c' not recognized on expression `%s'."),
980 *p->arg, p->saved_arg);
983 /* This function parses an argument conditionally, based on single or
984 non-single operands. A non-single operand would be a parenthesized
985 expression (e.g., `(2 + 1)'), and a single operand is anything that
986 starts with `-', `~', `+' (i.e., unary operators), a digit, or
987 something recognized by `gdbarch_stap_is_single_operand'. */
990 stap_parse_argument_conditionally (struct stap_parse_info *p)
992 gdb_assert (gdbarch_stap_is_single_operand_p (p->gdbarch));
994 if (*p->arg == '-' || *p->arg == '~' || *p->arg == '+' /* Unary. */
996 || gdbarch_stap_is_single_operand (p->gdbarch, p->arg))
997 stap_parse_single_operand (p);
998 else if (*p->arg == '(')
1000 /* We are dealing with a parenthesized operand. It means we
1001 have to parse it as it was a separate expression, without
1002 left-side or precedence. */
1004 p->arg = skip_spaces (p->arg);
1005 ++p->inside_paren_p;
1007 stap_parse_argument_1 (p, 0, STAP_OPERAND_PREC_NONE);
1009 --p->inside_paren_p;
1011 error (_("Missign close-paren on expression `%s'."),
1015 if (p->inside_paren_p)
1016 p->arg = skip_spaces (p->arg);
1019 error (_("Cannot parse expression `%s'."), p->saved_arg);
1022 /* Helper function for `stap_parse_argument'. Please, see its comments to
1023 better understand what this function does. */
1026 stap_parse_argument_1 (struct stap_parse_info *p, int has_lhs,
1027 enum stap_operand_prec prec)
1029 /* This is an operator-precedence parser.
1031 We work with left- and right-sides of expressions, and
1032 parse them depending on the precedence of the operators
1035 gdb_assert (p->arg != NULL);
1037 if (p->inside_paren_p)
1038 p->arg = skip_spaces (p->arg);
1042 /* We were called without a left-side, either because this is the
1043 first call, or because we were called to parse a parenthesized
1044 expression. It doesn't really matter; we have to parse the
1045 left-side in order to continue the process. */
1046 stap_parse_argument_conditionally (p);
1049 /* Start to parse the right-side, and to "join" left and right sides
1050 depending on the operation specified.
1052 This loop shall continue until we run out of characters in the input,
1053 or until we find a close-parenthesis, which means that we've reached
1054 the end of a sub-expression. */
1055 while (*p->arg != '\0' && *p->arg != ')' && !isspace (*p->arg))
1057 const char *tmp_exp_buf;
1058 enum exp_opcode opcode;
1059 enum stap_operand_prec cur_prec;
1061 if (!stap_is_operator (p->arg))
1062 error (_("Invalid operator `%c' on expression `%s'."), *p->arg,
1065 /* We have to save the current value of the expression buffer because
1066 the `stap_get_opcode' modifies it in order to get the current
1067 operator. If this operator's precedence is lower than PREC, we
1068 should return and not advance the expression buffer pointer. */
1069 tmp_exp_buf = p->arg;
1070 opcode = stap_get_opcode (&tmp_exp_buf);
1072 cur_prec = stap_get_operator_prec (opcode);
1073 if (cur_prec < prec)
1075 /* If the precedence of the operator that we are seeing now is
1076 lower than the precedence of the first operator seen before
1077 this parsing process began, it means we should stop parsing
1082 p->arg = tmp_exp_buf;
1083 if (p->inside_paren_p)
1084 p->arg = skip_spaces (p->arg);
1086 /* Parse the right-side of the expression. */
1087 stap_parse_argument_conditionally (p);
1089 /* While we still have operators, try to parse another
1090 right-side, but using the current right-side as a left-side. */
1091 while (*p->arg != '\0' && stap_is_operator (p->arg))
1093 enum exp_opcode lookahead_opcode;
1094 enum stap_operand_prec lookahead_prec;
1096 /* Saving the current expression buffer position. The explanation
1097 is the same as above. */
1098 tmp_exp_buf = p->arg;
1099 lookahead_opcode = stap_get_opcode (&tmp_exp_buf);
1100 lookahead_prec = stap_get_operator_prec (lookahead_opcode);
1102 if (lookahead_prec <= prec)
1104 /* If we are dealing with an operator whose precedence is lower
1105 than the first one, just abandon the attempt. */
1109 /* Parse the right-side of the expression, but since we already
1110 have a left-side at this point, set `has_lhs' to 1. */
1111 stap_parse_argument_1 (p, 1, lookahead_prec);
1114 write_exp_elt_opcode (&p->pstate, opcode);
1118 /* Parse a probe's argument.
1122 LP = literal integer prefix
1123 LS = literal integer suffix
1125 RP = register prefix
1126 RS = register suffix
1128 RIP = register indirection prefix
1129 RIS = register indirection suffix
1131 This routine assumes that arguments' tokens are of the form:
1134 - [RP] REGISTER [RS]
1135 - [RIP] [RP] REGISTER [RS] [RIS]
1136 - If we find a number without LP, we try to parse it as a literal integer
1137 constant (if LP == NULL), or as a register displacement.
1138 - We count parenthesis, and only skip whitespaces if we are inside them.
1139 - If we find an operator, we skip it.
1141 This function can also call a special function that will try to match
1142 unknown tokens. It will return the expression_up generated from
1143 parsing the argument. */
1145 static expression_up
1146 stap_parse_argument (const char **arg, struct type *atype,
1147 struct gdbarch *gdbarch)
1149 /* We need to initialize the expression buffer, in order to begin
1150 our parsing efforts. We use language_c here because we may need
1151 to do pointer arithmetics. */
1152 struct stap_parse_info p (*arg, atype, 10, language_def (language_c),
1155 stap_parse_argument_1 (&p, 0, STAP_OPERAND_PREC_NONE);
1157 gdb_assert (p.inside_paren_p == 0);
1159 /* Casting the final expression to the appropriate type. */
1160 write_exp_elt_opcode (&p.pstate, UNOP_CAST);
1161 write_exp_elt_type (&p.pstate, atype);
1162 write_exp_elt_opcode (&p.pstate, UNOP_CAST);
1164 p.arg = skip_spaces (p.arg);
1167 return p.pstate.release ();
1170 /* Implementation of 'parse_arguments' method. */
1173 stap_probe::parse_arguments (struct gdbarch *gdbarch)
1177 gdb_assert (!m_have_parsed_args);
1178 cur = m_unparsed_args_text;
1179 m_have_parsed_args = true;
1181 if (cur == NULL || *cur == '\0' || *cur == ':')
1184 while (*cur != '\0')
1186 enum stap_arg_bitness bitness;
1187 bool got_minus = false;
1189 /* We expect to find something like:
1193 Where `N' can be [+,-][1,2,4,8]. This is not mandatory, so
1194 we check it here. If we don't find it, go to the next
1196 if ((cur[0] == '-' && isdigit (cur[1]) && cur[2] == '@')
1197 || (isdigit (cur[0]) && cur[1] == '@'))
1201 /* Discard the `-'. */
1206 /* Defining the bitness. */
1210 bitness = (got_minus ? STAP_ARG_BITNESS_8BIT_SIGNED
1211 : STAP_ARG_BITNESS_8BIT_UNSIGNED);
1215 bitness = (got_minus ? STAP_ARG_BITNESS_16BIT_SIGNED
1216 : STAP_ARG_BITNESS_16BIT_UNSIGNED);
1220 bitness = (got_minus ? STAP_ARG_BITNESS_32BIT_SIGNED
1221 : STAP_ARG_BITNESS_32BIT_UNSIGNED);
1225 bitness = (got_minus ? STAP_ARG_BITNESS_64BIT_SIGNED
1226 : STAP_ARG_BITNESS_64BIT_UNSIGNED);
1231 /* We have an error, because we don't expect anything
1232 except 1, 2, 4 and 8. */
1233 warning (_("unrecognized bitness %s%c' for probe `%s'"),
1234 got_minus ? "`-" : "`", *cur,
1235 this->get_name ().c_str ());
1239 /* Discard the number and the `@' sign. */
1243 bitness = STAP_ARG_BITNESS_UNDEFINED;
1246 = stap_get_expected_argument_type (gdbarch, bitness,
1247 this->get_name ().c_str ());
1249 expression_up expr = stap_parse_argument (&cur, atype, gdbarch);
1251 if (stap_expression_debug)
1252 dump_raw_expression (expr.get (), gdb_stdlog,
1253 "before conversion to prefix form");
1255 prefixify_expression (expr.get ());
1257 if (stap_expression_debug)
1258 dump_prefix_expression (expr.get (), gdb_stdlog);
1260 m_parsed_args.emplace_back (bitness, atype, std::move (expr));
1262 /* Start it over again. */
1263 cur = skip_spaces (cur);
1267 /* Helper function to relocate an address. */
1270 relocate_address (CORE_ADDR address, struct objfile *objfile)
1272 return address + ANOFFSET (objfile->section_offsets,
1273 SECT_OFF_DATA (objfile));
1276 /* Implementation of the get_relocated_address method. */
1279 stap_probe::get_relocated_address (struct objfile *objfile)
1281 return relocate_address (this->get_address (), objfile);
1284 /* Given PROBE, returns the number of arguments present in that probe's
1288 stap_probe::get_argument_count (struct frame_info *frame)
1290 struct gdbarch *gdbarch = get_frame_arch (frame);
1292 if (!m_have_parsed_args)
1294 if (this->can_evaluate_arguments ())
1295 this->parse_arguments (gdbarch);
1298 static int have_warned_stap_incomplete = 0;
1300 if (!have_warned_stap_incomplete)
1303 "The SystemTap SDT probe support is not fully implemented on this target;\n"
1304 "you will not be able to inspect the arguments of the probes.\n"
1305 "Please report a bug against GDB requesting a port to this target."));
1306 have_warned_stap_incomplete = 1;
1309 /* Marking the arguments as "already parsed". */
1310 m_have_parsed_args = true;
1314 gdb_assert (m_have_parsed_args);
1315 return m_parsed_args.size ();
1318 /* Return 1 if OP is a valid operator inside a probe argument, or zero
1322 stap_is_operator (const char *op)
1347 /* We didn't find any operator. */
1354 /* Implement the `can_evaluate_arguments' method. */
1357 stap_probe::can_evaluate_arguments () const
1359 struct gdbarch *gdbarch = this->get_gdbarch ();
1361 /* For SystemTap probes, we have to guarantee that the method
1362 stap_is_single_operand is defined on gdbarch. If it is not, then it
1363 means that argument evaluation is not implemented on this target. */
1364 return gdbarch_stap_is_single_operand_p (gdbarch);
1367 /* Evaluate the probe's argument N (indexed from 0), returning a value
1368 corresponding to it. Assertion is thrown if N does not exist. */
1371 stap_probe::evaluate_argument (unsigned n, struct frame_info *frame)
1373 struct stap_probe_arg *arg;
1375 struct gdbarch *gdbarch = get_frame_arch (frame);
1377 arg = this->get_arg_by_number (n, gdbarch);
1378 return evaluate_subexp_standard (arg->atype, arg->aexpr.get (), &pos,
1382 /* Compile the probe's argument N (indexed from 0) to agent expression.
1383 Assertion is thrown if N does not exist. */
1386 stap_probe::compile_to_ax (struct agent_expr *expr, struct axs_value *value,
1389 struct stap_probe_arg *arg;
1390 union exp_element *pc;
1392 arg = this->get_arg_by_number (n, expr->gdbarch);
1394 pc = arg->aexpr->elts;
1395 gen_expr (arg->aexpr.get (), &pc, expr, value);
1397 require_rvalue (expr, value);
1398 value->type = arg->atype;
1402 /* Set or clear a SystemTap semaphore. ADDRESS is the semaphore's
1403 address. SET is zero if the semaphore should be cleared, or one if
1404 it should be set. This is a helper function for
1405 'stap_probe::set_semaphore' and 'stap_probe::clear_semaphore'. */
1408 stap_modify_semaphore (CORE_ADDR address, int set, struct gdbarch *gdbarch)
1410 gdb_byte bytes[sizeof (LONGEST)];
1411 /* The ABI specifies "unsigned short". */
1412 struct type *type = builtin_type (gdbarch)->builtin_unsigned_short;
1418 /* Swallow errors. */
1419 if (target_read_memory (address, bytes, TYPE_LENGTH (type)) != 0)
1421 warning (_("Could not read the value of a SystemTap semaphore."));
1425 value = extract_unsigned_integer (bytes, TYPE_LENGTH (type),
1426 gdbarch_byte_order (gdbarch));
1427 /* Note that we explicitly don't worry about overflow or
1434 store_unsigned_integer (bytes, TYPE_LENGTH (type),
1435 gdbarch_byte_order (gdbarch), value);
1437 if (target_write_memory (address, bytes, TYPE_LENGTH (type)) != 0)
1438 warning (_("Could not write the value of a SystemTap semaphore."));
1441 /* Implementation of the 'set_semaphore' method.
1443 SystemTap semaphores act as reference counters, so calls to this
1444 function must be paired with calls to 'clear_semaphore'.
1446 This function and 'clear_semaphore' race with another tool
1447 changing the probes, but that is too rare to care. */
1450 stap_probe::set_semaphore (struct objfile *objfile, struct gdbarch *gdbarch)
1452 stap_modify_semaphore (relocate_address (m_sem_addr, objfile), 1, gdbarch);
1455 /* Implementation of the 'clear_semaphore' method. */
1458 stap_probe::clear_semaphore (struct objfile *objfile, struct gdbarch *gdbarch)
1460 stap_modify_semaphore (relocate_address (m_sem_addr, objfile), 0, gdbarch);
1463 /* Implementation of the 'get_static_ops' method. */
1465 const static_probe_ops *
1466 stap_probe::get_static_ops () const
1468 return &stap_static_probe_ops;
1471 /* Implementation of the 'gen_info_probes_table_values' method. */
1473 std::vector<const char *>
1474 stap_probe::gen_info_probes_table_values () const
1476 const char *val = NULL;
1478 if (m_sem_addr != 0)
1479 val = print_core_address (this->get_gdbarch (), m_sem_addr);
1481 return std::vector<const char *> { val };
1484 /* Helper function that parses the information contained in a
1485 SystemTap's probe. Basically, the information consists in:
1487 - Probe's PC address;
1488 - Link-time section address of `.stapsdt.base' section;
1489 - Link-time address of the semaphore variable, or ZERO if the
1490 probe doesn't have an associated semaphore;
1491 - Probe's provider name;
1493 - Probe's argument format
1495 This function returns 1 if the handling was successful, and zero
1499 handle_stap_probe (struct objfile *objfile, struct sdt_note *el,
1500 std::vector<probe *> *probesp, CORE_ADDR base)
1502 bfd *abfd = objfile->obfd;
1503 int size = bfd_get_arch_size (abfd) / 8;
1504 struct gdbarch *gdbarch = get_objfile_arch (objfile);
1505 struct type *ptr_type = builtin_type (gdbarch)->builtin_data_ptr;
1507 /* Provider and the name of the probe. */
1508 const char *provider = (const char *) &el->data[3 * size];
1509 const char *name = ((const char *)
1510 memchr (provider, '\0',
1511 (char *) el->data + el->size - provider));
1512 /* Making sure there is a name. */
1515 complaint (_("corrupt probe name when "
1517 objfile_name (objfile));
1519 /* There is no way to use a probe without a name or a provider, so
1520 returning zero here makes sense. */
1526 /* Retrieving the probe's address. */
1527 CORE_ADDR address = extract_typed_address (&el->data[0], ptr_type);
1529 /* Link-time sh_addr of `.stapsdt.base' section. */
1530 CORE_ADDR base_ref = extract_typed_address (&el->data[size], ptr_type);
1532 /* Semaphore address. */
1533 CORE_ADDR sem_addr = extract_typed_address (&el->data[2 * size], ptr_type);
1535 address += base - base_ref;
1537 sem_addr += base - base_ref;
1539 /* Arguments. We can only extract the argument format if there is a valid
1540 name for this probe. */
1541 const char *probe_args = ((const char*)
1543 (char *) el->data + el->size - name));
1545 if (probe_args != NULL)
1548 if (probe_args == NULL
1549 || (memchr (probe_args, '\0', (char *) el->data + el->size - name)
1550 != el->data + el->size - 1))
1552 complaint (_("corrupt probe argument when "
1554 objfile_name (objfile));
1555 /* If the argument string is NULL, it means some problem happened with
1556 it. So we return 0. */
1560 stap_probe *ret = new stap_probe (std::string (name), std::string (provider),
1561 address, gdbarch, sem_addr, probe_args);
1563 /* Successfully created probe. */
1564 probesp->push_back (ret);
1567 /* Helper function which tries to find the base address of the SystemTap
1568 base section named STAP_BASE_SECTION_NAME. */
1571 get_stap_base_address_1 (bfd *abfd, asection *sect, void *obj)
1573 asection **ret = (asection **) obj;
1575 if ((sect->flags & (SEC_DATA | SEC_ALLOC | SEC_HAS_CONTENTS))
1576 && sect->name && !strcmp (sect->name, STAP_BASE_SECTION_NAME))
1580 /* Helper function which iterates over every section in the BFD file,
1581 trying to find the base address of the SystemTap base section.
1582 Returns 1 if found (setting BASE to the proper value), zero otherwise. */
1585 get_stap_base_address (bfd *obfd, bfd_vma *base)
1587 asection *ret = NULL;
1589 bfd_map_over_sections (obfd, get_stap_base_address_1, (void *) &ret);
1593 complaint (_("could not obtain base address for "
1594 "SystemTap section on objfile `%s'."),
1605 /* Implementation of the 'is_linespec' method. */
1608 stap_static_probe_ops::is_linespec (const char **linespecp) const
1610 static const char *const keywords[] = { "-pstap", "-probe-stap", NULL };
1612 return probe_is_linespec_by_keyword (linespecp, keywords);
1615 /* Implementation of the 'get_probes' method. */
1618 stap_static_probe_ops::get_probes (std::vector<probe *> *probesp,
1619 struct objfile *objfile) const
1621 /* If we are here, then this is the first time we are parsing the
1622 SystemTap probe's information. We basically have to count how many
1623 probes the objfile has, and then fill in the necessary information
1625 bfd *obfd = objfile->obfd;
1627 struct sdt_note *iter;
1628 unsigned save_probesp_len = probesp->size ();
1630 if (objfile->separate_debug_objfile_backlink != NULL)
1632 /* This is a .debug file, not the objfile itself. */
1636 if (elf_tdata (obfd)->sdt_note_head == NULL)
1638 /* There isn't any probe here. */
1642 if (!get_stap_base_address (obfd, &base))
1644 /* There was an error finding the base address for the section.
1645 Just return NULL. */
1649 /* Parsing each probe's information. */
1650 for (iter = elf_tdata (obfd)->sdt_note_head;
1654 /* We first have to handle all the information about the
1655 probe which is present in the section. */
1656 handle_stap_probe (objfile, iter, probesp, base);
1659 if (save_probesp_len == probesp->size ())
1661 /* If we are here, it means we have failed to parse every known
1663 complaint (_("could not parse SystemTap probe(s) "
1669 /* Implementation of the type_name method. */
1672 stap_static_probe_ops::type_name () const
1677 /* Implementation of the 'gen_info_probes_table_header' method. */
1679 std::vector<struct info_probe_column>
1680 stap_static_probe_ops::gen_info_probes_table_header () const
1682 struct info_probe_column stap_probe_column;
1684 stap_probe_column.field_name = "semaphore";
1685 stap_probe_column.print_name = _("Semaphore");
1687 return std::vector<struct info_probe_column> { stap_probe_column };
1690 /* Implementation of the `info probes stap' command. */
1693 info_probes_stap_command (const char *arg, int from_tty)
1695 info_probes_for_spops (arg, from_tty, &stap_static_probe_ops);
1699 _initialize_stap_probe (void)
1701 all_static_probe_ops.push_back (&stap_static_probe_ops);
1703 add_setshow_zuinteger_cmd ("stap-expression", class_maintenance,
1704 &stap_expression_debug,
1705 _("Set SystemTap expression debugging."),
1706 _("Show SystemTap expression debugging."),
1707 _("When non-zero, the internal representation "
1708 "of SystemTap expressions will be printed."),
1710 show_stapexpressiondebug,
1711 &setdebuglist, &showdebuglist);
1713 add_cmd ("stap", class_info, info_probes_stap_command,
1715 Show information about SystemTap static probes.\n\
1716 Usage: info probes stap [PROVIDER [NAME [OBJECT]]]\n\
1717 Each argument is a regular expression, used to select probes.\n\
1718 PROVIDER matches probe provider names.\n\
1719 NAME matches the probe names.\n\
1720 OBJECT matches the executable or shared library name."),
1721 info_probes_cmdlist_get ());