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 "gdbsupport/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 int regnum = user_reg_map_name_to_regnum (gdbarch, regname.c_str (),
768 /* Is this a valid register name? */
770 error (_("Invalid register name `%s' on expression `%s'."),
771 regname.c_str (), p->saved_arg);
773 /* Check if there's any special treatment that the arch-specific
774 code would like to perform on the register name. */
775 if (gdbarch_stap_adjust_register_p (gdbarch))
777 std::string newregname
778 = gdbarch_stap_adjust_register (gdbarch, p, regname, regnum);
780 if (regname != newregname)
782 /* This is just a check we perform to make sure that the
783 arch-dependent code has provided us with a valid
785 regnum = user_reg_map_name_to_regnum (gdbarch, newregname.c_str (),
789 internal_error (__FILE__, __LINE__,
790 _("Invalid register name '%s' after replacing it"
791 " (previous name was '%s')"),
792 newregname.c_str (), regname.c_str ());
794 regname = newregname;
798 write_exp_elt_opcode (&p->pstate, OP_REGISTER);
799 str.ptr = regname.c_str ();
800 str.length = regname.size ();
801 write_exp_string (&p->pstate, str);
802 write_exp_elt_opcode (&p->pstate, OP_REGISTER);
807 write_exp_elt_opcode (&p->pstate, BINOP_ADD);
809 /* Casting to the expected type. */
810 write_exp_elt_opcode (&p->pstate, UNOP_CAST);
811 write_exp_elt_type (&p->pstate, lookup_pointer_type (p->arg_type));
812 write_exp_elt_opcode (&p->pstate, UNOP_CAST);
814 write_exp_elt_opcode (&p->pstate, UNOP_IND);
817 /* Getting rid of the register name suffix. */
818 if (stap_check_register_suffix (gdbarch, p->arg, ®_suffix))
819 p->arg += strlen (reg_suffix);
821 error (_("Missing register name suffix on expression `%s'."),
824 /* Getting rid of the register indirection suffix. */
827 if (stap_check_register_indirection_suffix (gdbarch, p->arg,
829 p->arg += strlen (reg_ind_suffix);
831 error (_("Missing indirection suffix on expression `%s'."),
836 /* This function is responsible for parsing a single operand.
838 A single operand can be:
840 - an unary operation (e.g., `-5', `~2', or even with subexpressions
842 - a register displacement, which will be treated as a register
843 operand (e.g., `-4(%eax)' on x86)
844 - a numeric constant, or
845 - a register operand (see function `stap_parse_register_operand')
847 The function also calls special-handling functions to deal with
848 unrecognized operands, allowing arch-specific parsers to be
852 stap_parse_single_operand (struct stap_parse_info *p)
854 struct gdbarch *gdbarch = p->gdbarch;
855 const char *int_prefix = NULL;
857 /* We first try to parse this token as a "special token". */
858 if (gdbarch_stap_parse_special_token_p (gdbarch)
859 && (gdbarch_stap_parse_special_token (gdbarch, p) != 0))
861 /* If the return value of the above function is not zero,
862 it means it successfully parsed the special token.
864 If it is NULL, we try to parse it using our method. */
868 if (*p->arg == '-' || *p->arg == '~' || *p->arg == '+')
871 /* We use this variable to do a lookahead. */
872 const char *tmp = p->arg;
873 bool has_digit = false;
875 /* Skipping signal. */
878 /* This is an unary operation. Here is a list of allowed tokens
882 - number (from register displacement)
883 - subexpression (beginning with `(')
885 We handle the register displacement here, and the other cases
887 if (p->inside_paren_p)
888 tmp = skip_spaces (tmp);
890 while (isdigit (*tmp))
892 /* We skip the digit here because we are only interested in
893 knowing what kind of unary operation this is. The digit
894 will be handled by one of the functions that will be
895 called below ('stap_parse_argument_conditionally' or
896 'stap_parse_register_operand'). */
901 if (has_digit && stap_is_register_indirection_prefix (gdbarch, tmp,
904 /* If we are here, it means it is a displacement. The only
905 operations allowed here are `-' and `+'. */
906 if (c != '-' && c != '+')
907 error (_("Invalid operator `%c' for register displacement "
908 "on expression `%s'."), c, p->saved_arg);
910 stap_parse_register_operand (p);
914 /* This is not a displacement. We skip the operator, and
915 deal with it when the recursion returns. */
917 stap_parse_argument_conditionally (p);
919 write_exp_elt_opcode (&p->pstate, UNOP_NEG);
921 write_exp_elt_opcode (&p->pstate, UNOP_COMPLEMENT);
924 else if (isdigit (*p->arg))
926 /* A temporary variable, needed for lookahead. */
927 const char *tmp = p->arg;
931 /* We can be dealing with a numeric constant, or with a register
933 number = strtol (tmp, &endp, 10);
936 if (p->inside_paren_p)
937 tmp = skip_spaces (tmp);
939 /* If "stap_is_integer_prefix" returns true, it means we can
940 accept integers without a prefix here. But we also need to
941 check whether the next token (i.e., "tmp") is not a register
942 indirection prefix. */
943 if (stap_is_integer_prefix (gdbarch, p->arg, NULL)
944 && !stap_is_register_indirection_prefix (gdbarch, tmp, NULL))
946 const char *int_suffix;
948 /* We are dealing with a numeric constant. */
949 write_exp_elt_opcode (&p->pstate, OP_LONG);
950 write_exp_elt_type (&p->pstate,
951 builtin_type (gdbarch)->builtin_long);
952 write_exp_elt_longcst (&p->pstate, number);
953 write_exp_elt_opcode (&p->pstate, OP_LONG);
957 if (stap_check_integer_suffix (gdbarch, p->arg, &int_suffix))
958 p->arg += strlen (int_suffix);
960 error (_("Invalid constant suffix on expression `%s'."),
963 else if (stap_is_register_indirection_prefix (gdbarch, tmp, NULL))
964 stap_parse_register_operand (p);
966 error (_("Unknown numeric token on expression `%s'."),
969 else if (stap_is_integer_prefix (gdbarch, p->arg, &int_prefix))
971 /* We are dealing with a numeric constant. */
974 const char *int_suffix;
976 p->arg += strlen (int_prefix);
977 number = strtol (p->arg, &endp, 10);
980 write_exp_elt_opcode (&p->pstate, OP_LONG);
981 write_exp_elt_type (&p->pstate, builtin_type (gdbarch)->builtin_long);
982 write_exp_elt_longcst (&p->pstate, number);
983 write_exp_elt_opcode (&p->pstate, OP_LONG);
985 if (stap_check_integer_suffix (gdbarch, p->arg, &int_suffix))
986 p->arg += strlen (int_suffix);
988 error (_("Invalid constant suffix on expression `%s'."),
991 else if (stap_is_register_prefix (gdbarch, p->arg, NULL)
992 || stap_is_register_indirection_prefix (gdbarch, p->arg, NULL))
993 stap_parse_register_operand (p);
995 error (_("Operator `%c' not recognized on expression `%s'."),
996 *p->arg, p->saved_arg);
999 /* This function parses an argument conditionally, based on single or
1000 non-single operands. A non-single operand would be a parenthesized
1001 expression (e.g., `(2 + 1)'), and a single operand is anything that
1002 starts with `-', `~', `+' (i.e., unary operators), a digit, or
1003 something recognized by `gdbarch_stap_is_single_operand'. */
1006 stap_parse_argument_conditionally (struct stap_parse_info *p)
1008 gdb_assert (gdbarch_stap_is_single_operand_p (p->gdbarch));
1010 if (*p->arg == '-' || *p->arg == '~' || *p->arg == '+' /* Unary. */
1011 || isdigit (*p->arg)
1012 || gdbarch_stap_is_single_operand (p->gdbarch, p->arg))
1013 stap_parse_single_operand (p);
1014 else if (*p->arg == '(')
1016 /* We are dealing with a parenthesized operand. It means we
1017 have to parse it as it was a separate expression, without
1018 left-side or precedence. */
1020 p->arg = skip_spaces (p->arg);
1021 ++p->inside_paren_p;
1023 stap_parse_argument_1 (p, 0, STAP_OPERAND_PREC_NONE);
1025 --p->inside_paren_p;
1027 error (_("Missign close-paren on expression `%s'."),
1031 if (p->inside_paren_p)
1032 p->arg = skip_spaces (p->arg);
1035 error (_("Cannot parse expression `%s'."), p->saved_arg);
1038 /* Helper function for `stap_parse_argument'. Please, see its comments to
1039 better understand what this function does. */
1042 stap_parse_argument_1 (struct stap_parse_info *p, bool has_lhs,
1043 enum stap_operand_prec prec)
1045 /* This is an operator-precedence parser.
1047 We work with left- and right-sides of expressions, and
1048 parse them depending on the precedence of the operators
1051 gdb_assert (p->arg != NULL);
1053 if (p->inside_paren_p)
1054 p->arg = skip_spaces (p->arg);
1058 /* We were called without a left-side, either because this is the
1059 first call, or because we were called to parse a parenthesized
1060 expression. It doesn't really matter; we have to parse the
1061 left-side in order to continue the process. */
1062 stap_parse_argument_conditionally (p);
1065 /* Start to parse the right-side, and to "join" left and right sides
1066 depending on the operation specified.
1068 This loop shall continue until we run out of characters in the input,
1069 or until we find a close-parenthesis, which means that we've reached
1070 the end of a sub-expression. */
1071 while (*p->arg != '\0' && *p->arg != ')' && !isspace (*p->arg))
1073 const char *tmp_exp_buf;
1074 enum exp_opcode opcode;
1075 enum stap_operand_prec cur_prec;
1077 if (!stap_is_operator (p->arg))
1078 error (_("Invalid operator `%c' on expression `%s'."), *p->arg,
1081 /* We have to save the current value of the expression buffer because
1082 the `stap_get_opcode' modifies it in order to get the current
1083 operator. If this operator's precedence is lower than PREC, we
1084 should return and not advance the expression buffer pointer. */
1085 tmp_exp_buf = p->arg;
1086 opcode = stap_get_opcode (&tmp_exp_buf);
1088 cur_prec = stap_get_operator_prec (opcode);
1089 if (cur_prec < prec)
1091 /* If the precedence of the operator that we are seeing now is
1092 lower than the precedence of the first operator seen before
1093 this parsing process began, it means we should stop parsing
1098 p->arg = tmp_exp_buf;
1099 if (p->inside_paren_p)
1100 p->arg = skip_spaces (p->arg);
1102 /* Parse the right-side of the expression. */
1103 stap_parse_argument_conditionally (p);
1105 /* While we still have operators, try to parse another
1106 right-side, but using the current right-side as a left-side. */
1107 while (*p->arg != '\0' && stap_is_operator (p->arg))
1109 enum exp_opcode lookahead_opcode;
1110 enum stap_operand_prec lookahead_prec;
1112 /* Saving the current expression buffer position. The explanation
1113 is the same as above. */
1114 tmp_exp_buf = p->arg;
1115 lookahead_opcode = stap_get_opcode (&tmp_exp_buf);
1116 lookahead_prec = stap_get_operator_prec (lookahead_opcode);
1118 if (lookahead_prec <= prec)
1120 /* If we are dealing with an operator whose precedence is lower
1121 than the first one, just abandon the attempt. */
1125 /* Parse the right-side of the expression, but since we already
1126 have a left-side at this point, set `has_lhs' to 1. */
1127 stap_parse_argument_1 (p, 1, lookahead_prec);
1130 write_exp_elt_opcode (&p->pstate, opcode);
1134 /* Parse a probe's argument.
1138 LP = literal integer prefix
1139 LS = literal integer suffix
1141 RP = register prefix
1142 RS = register suffix
1144 RIP = register indirection prefix
1145 RIS = register indirection suffix
1147 This routine assumes that arguments' tokens are of the form:
1150 - [RP] REGISTER [RS]
1151 - [RIP] [RP] REGISTER [RS] [RIS]
1152 - If we find a number without LP, we try to parse it as a literal integer
1153 constant (if LP == NULL), or as a register displacement.
1154 - We count parenthesis, and only skip whitespaces if we are inside them.
1155 - If we find an operator, we skip it.
1157 This function can also call a special function that will try to match
1158 unknown tokens. It will return the expression_up generated from
1159 parsing the argument. */
1161 static expression_up
1162 stap_parse_argument (const char **arg, struct type *atype,
1163 struct gdbarch *gdbarch)
1165 /* We need to initialize the expression buffer, in order to begin
1166 our parsing efforts. We use language_c here because we may need
1167 to do pointer arithmetics. */
1168 struct stap_parse_info p (*arg, atype, language_def (language_c),
1171 stap_parse_argument_1 (&p, 0, STAP_OPERAND_PREC_NONE);
1173 gdb_assert (p.inside_paren_p == 0);
1175 /* Casting the final expression to the appropriate type. */
1176 write_exp_elt_opcode (&p.pstate, UNOP_CAST);
1177 write_exp_elt_type (&p.pstate, atype);
1178 write_exp_elt_opcode (&p.pstate, UNOP_CAST);
1180 p.arg = skip_spaces (p.arg);
1183 return p.pstate.release ();
1186 /* Implementation of 'parse_arguments' method. */
1189 stap_probe::parse_arguments (struct gdbarch *gdbarch)
1193 gdb_assert (!m_have_parsed_args);
1194 cur = m_unparsed_args_text;
1195 m_have_parsed_args = true;
1197 if (cur == NULL || *cur == '\0' || *cur == ':')
1200 while (*cur != '\0')
1202 enum stap_arg_bitness bitness;
1203 bool got_minus = false;
1205 /* We expect to find something like:
1209 Where `N' can be [+,-][1,2,4,8]. This is not mandatory, so
1210 we check it here. If we don't find it, go to the next
1212 if ((cur[0] == '-' && isdigit (cur[1]) && cur[2] == '@')
1213 || (isdigit (cur[0]) && cur[1] == '@'))
1217 /* Discard the `-'. */
1222 /* Defining the bitness. */
1226 bitness = (got_minus ? STAP_ARG_BITNESS_8BIT_SIGNED
1227 : STAP_ARG_BITNESS_8BIT_UNSIGNED);
1231 bitness = (got_minus ? STAP_ARG_BITNESS_16BIT_SIGNED
1232 : STAP_ARG_BITNESS_16BIT_UNSIGNED);
1236 bitness = (got_minus ? STAP_ARG_BITNESS_32BIT_SIGNED
1237 : STAP_ARG_BITNESS_32BIT_UNSIGNED);
1241 bitness = (got_minus ? STAP_ARG_BITNESS_64BIT_SIGNED
1242 : STAP_ARG_BITNESS_64BIT_UNSIGNED);
1247 /* We have an error, because we don't expect anything
1248 except 1, 2, 4 and 8. */
1249 warning (_("unrecognized bitness %s%c' for probe `%s'"),
1250 got_minus ? "`-" : "`", *cur,
1251 this->get_name ().c_str ());
1255 /* Discard the number and the `@' sign. */
1259 bitness = STAP_ARG_BITNESS_UNDEFINED;
1262 = stap_get_expected_argument_type (gdbarch, bitness,
1263 this->get_name ().c_str ());
1265 expression_up expr = stap_parse_argument (&cur, atype, gdbarch);
1267 if (stap_expression_debug)
1268 dump_raw_expression (expr.get (), gdb_stdlog,
1269 "before conversion to prefix form");
1271 prefixify_expression (expr.get ());
1273 if (stap_expression_debug)
1274 dump_prefix_expression (expr.get (), gdb_stdlog);
1276 m_parsed_args.emplace_back (bitness, atype, std::move (expr));
1278 /* Start it over again. */
1279 cur = skip_spaces (cur);
1283 /* Helper function to relocate an address. */
1286 relocate_address (CORE_ADDR address, struct objfile *objfile)
1288 return address + ANOFFSET (objfile->section_offsets,
1289 SECT_OFF_DATA (objfile));
1292 /* Implementation of the get_relocated_address method. */
1295 stap_probe::get_relocated_address (struct objfile *objfile)
1297 return relocate_address (this->get_address (), objfile);
1300 /* Given PROBE, returns the number of arguments present in that probe's
1304 stap_probe::get_argument_count (struct frame_info *frame)
1306 struct gdbarch *gdbarch = get_frame_arch (frame);
1308 if (!m_have_parsed_args)
1310 if (this->can_evaluate_arguments ())
1311 this->parse_arguments (gdbarch);
1314 static bool have_warned_stap_incomplete = false;
1316 if (!have_warned_stap_incomplete)
1319 "The SystemTap SDT probe support is not fully implemented on this target;\n"
1320 "you will not be able to inspect the arguments of the probes.\n"
1321 "Please report a bug against GDB requesting a port to this target."));
1322 have_warned_stap_incomplete = true;
1325 /* Marking the arguments as "already parsed". */
1326 m_have_parsed_args = true;
1330 gdb_assert (m_have_parsed_args);
1331 return m_parsed_args.size ();
1334 /* Return true if OP is a valid operator inside a probe argument, or
1338 stap_is_operator (const char *op)
1363 /* We didn't find any operator. */
1370 /* Implement the `can_evaluate_arguments' method. */
1373 stap_probe::can_evaluate_arguments () const
1375 struct gdbarch *gdbarch = this->get_gdbarch ();
1377 /* For SystemTap probes, we have to guarantee that the method
1378 stap_is_single_operand is defined on gdbarch. If it is not, then it
1379 means that argument evaluation is not implemented on this target. */
1380 return gdbarch_stap_is_single_operand_p (gdbarch);
1383 /* Evaluate the probe's argument N (indexed from 0), returning a value
1384 corresponding to it. Assertion is thrown if N does not exist. */
1387 stap_probe::evaluate_argument (unsigned n, struct frame_info *frame)
1389 struct stap_probe_arg *arg;
1391 struct gdbarch *gdbarch = get_frame_arch (frame);
1393 arg = this->get_arg_by_number (n, gdbarch);
1394 return evaluate_subexp_standard (arg->atype, arg->aexpr.get (), &pos,
1398 /* Compile the probe's argument N (indexed from 0) to agent expression.
1399 Assertion is thrown if N does not exist. */
1402 stap_probe::compile_to_ax (struct agent_expr *expr, struct axs_value *value,
1405 struct stap_probe_arg *arg;
1406 union exp_element *pc;
1408 arg = this->get_arg_by_number (n, expr->gdbarch);
1410 pc = arg->aexpr->elts;
1411 gen_expr (arg->aexpr.get (), &pc, expr, value);
1413 require_rvalue (expr, value);
1414 value->type = arg->atype;
1418 /* Set or clear a SystemTap semaphore. ADDRESS is the semaphore's
1419 address. SET is zero if the semaphore should be cleared, or one if
1420 it should be set. This is a helper function for
1421 'stap_probe::set_semaphore' and 'stap_probe::clear_semaphore'. */
1424 stap_modify_semaphore (CORE_ADDR address, int set, struct gdbarch *gdbarch)
1426 gdb_byte bytes[sizeof (LONGEST)];
1427 /* The ABI specifies "unsigned short". */
1428 struct type *type = builtin_type (gdbarch)->builtin_unsigned_short;
1434 /* Swallow errors. */
1435 if (target_read_memory (address, bytes, TYPE_LENGTH (type)) != 0)
1437 warning (_("Could not read the value of a SystemTap semaphore."));
1441 value = extract_unsigned_integer (bytes, TYPE_LENGTH (type),
1442 gdbarch_byte_order (gdbarch));
1443 /* Note that we explicitly don't worry about overflow or
1450 store_unsigned_integer (bytes, TYPE_LENGTH (type),
1451 gdbarch_byte_order (gdbarch), value);
1453 if (target_write_memory (address, bytes, TYPE_LENGTH (type)) != 0)
1454 warning (_("Could not write the value of a SystemTap semaphore."));
1457 /* Implementation of the 'set_semaphore' method.
1459 SystemTap semaphores act as reference counters, so calls to this
1460 function must be paired with calls to 'clear_semaphore'.
1462 This function and 'clear_semaphore' race with another tool
1463 changing the probes, but that is too rare to care. */
1466 stap_probe::set_semaphore (struct objfile *objfile, struct gdbarch *gdbarch)
1468 stap_modify_semaphore (relocate_address (m_sem_addr, objfile), 1, gdbarch);
1471 /* Implementation of the 'clear_semaphore' method. */
1474 stap_probe::clear_semaphore (struct objfile *objfile, struct gdbarch *gdbarch)
1476 stap_modify_semaphore (relocate_address (m_sem_addr, objfile), 0, gdbarch);
1479 /* Implementation of the 'get_static_ops' method. */
1481 const static_probe_ops *
1482 stap_probe::get_static_ops () const
1484 return &stap_static_probe_ops;
1487 /* Implementation of the 'gen_info_probes_table_values' method. */
1489 std::vector<const char *>
1490 stap_probe::gen_info_probes_table_values () const
1492 const char *val = NULL;
1494 if (m_sem_addr != 0)
1495 val = print_core_address (this->get_gdbarch (), m_sem_addr);
1497 return std::vector<const char *> { val };
1500 /* Helper function that parses the information contained in a
1501 SystemTap's probe. Basically, the information consists in:
1503 - Probe's PC address;
1504 - Link-time section address of `.stapsdt.base' section;
1505 - Link-time address of the semaphore variable, or ZERO if the
1506 probe doesn't have an associated semaphore;
1507 - Probe's provider name;
1509 - Probe's argument format. */
1512 handle_stap_probe (struct objfile *objfile, struct sdt_note *el,
1513 std::vector<std::unique_ptr<probe>> *probesp,
1516 bfd *abfd = objfile->obfd;
1517 int size = bfd_get_arch_size (abfd) / 8;
1518 struct gdbarch *gdbarch = get_objfile_arch (objfile);
1519 struct type *ptr_type = builtin_type (gdbarch)->builtin_data_ptr;
1521 /* Provider and the name of the probe. */
1522 const char *provider = (const char *) &el->data[3 * size];
1523 const char *name = ((const char *)
1524 memchr (provider, '\0',
1525 (char *) el->data + el->size - provider));
1526 /* Making sure there is a name. */
1529 complaint (_("corrupt probe name when reading `%s'"),
1530 objfile_name (objfile));
1532 /* There is no way to use a probe without a name or a provider, so
1533 returning here makes sense. */
1539 /* Retrieving the probe's address. */
1540 CORE_ADDR address = extract_typed_address (&el->data[0], ptr_type);
1542 /* Link-time sh_addr of `.stapsdt.base' section. */
1543 CORE_ADDR base_ref = extract_typed_address (&el->data[size], ptr_type);
1545 /* Semaphore address. */
1546 CORE_ADDR sem_addr = extract_typed_address (&el->data[2 * size], ptr_type);
1548 address += base - base_ref;
1550 sem_addr += base - base_ref;
1552 /* Arguments. We can only extract the argument format if there is a valid
1553 name for this probe. */
1554 const char *probe_args = ((const char*)
1556 (char *) el->data + el->size - name));
1558 if (probe_args != NULL)
1561 if (probe_args == NULL
1562 || (memchr (probe_args, '\0', (char *) el->data + el->size - name)
1563 != el->data + el->size - 1))
1565 complaint (_("corrupt probe argument when reading `%s'"),
1566 objfile_name (objfile));
1567 /* If the argument string is NULL, it means some problem happened with
1568 it. So we return. */
1572 stap_probe *ret = new stap_probe (std::string (name), std::string (provider),
1573 address, gdbarch, sem_addr, probe_args);
1575 /* Successfully created probe. */
1576 probesp->emplace_back (ret);
1579 /* Helper function which tries to find the base address of the SystemTap
1580 base section named STAP_BASE_SECTION_NAME. */
1583 get_stap_base_address_1 (bfd *abfd, asection *sect, void *obj)
1585 asection **ret = (asection **) obj;
1587 if ((sect->flags & (SEC_DATA | SEC_ALLOC | SEC_HAS_CONTENTS))
1588 && sect->name && !strcmp (sect->name, STAP_BASE_SECTION_NAME))
1592 /* Helper function which iterates over every section in the BFD file,
1593 trying to find the base address of the SystemTap base section.
1594 Returns 1 if found (setting BASE to the proper value), zero otherwise. */
1597 get_stap_base_address (bfd *obfd, bfd_vma *base)
1599 asection *ret = NULL;
1601 bfd_map_over_sections (obfd, get_stap_base_address_1, (void *) &ret);
1605 complaint (_("could not obtain base address for "
1606 "SystemTap section on objfile `%s'."),
1617 /* Implementation of the 'is_linespec' method. */
1620 stap_static_probe_ops::is_linespec (const char **linespecp) const
1622 static const char *const keywords[] = { "-pstap", "-probe-stap", NULL };
1624 return probe_is_linespec_by_keyword (linespecp, keywords);
1627 /* Implementation of the 'get_probes' method. */
1630 stap_static_probe_ops::get_probes
1631 (std::vector<std::unique_ptr<probe>> *probesp,
1632 struct objfile *objfile) const
1634 /* If we are here, then this is the first time we are parsing the
1635 SystemTap probe's information. We basically have to count how many
1636 probes the objfile has, and then fill in the necessary information
1638 bfd *obfd = objfile->obfd;
1640 struct sdt_note *iter;
1641 unsigned save_probesp_len = probesp->size ();
1643 if (objfile->separate_debug_objfile_backlink != NULL)
1645 /* This is a .debug file, not the objfile itself. */
1649 if (elf_tdata (obfd)->sdt_note_head == NULL)
1651 /* There isn't any probe here. */
1655 if (!get_stap_base_address (obfd, &base))
1657 /* There was an error finding the base address for the section.
1658 Just return NULL. */
1662 /* Parsing each probe's information. */
1663 for (iter = elf_tdata (obfd)->sdt_note_head;
1667 /* We first have to handle all the information about the
1668 probe which is present in the section. */
1669 handle_stap_probe (objfile, iter, probesp, base);
1672 if (save_probesp_len == probesp->size ())
1674 /* If we are here, it means we have failed to parse every known
1676 complaint (_("could not parse SystemTap probe(s) from inferior"));
1681 /* Implementation of the type_name method. */
1684 stap_static_probe_ops::type_name () const
1689 /* Implementation of the 'gen_info_probes_table_header' method. */
1691 std::vector<struct info_probe_column>
1692 stap_static_probe_ops::gen_info_probes_table_header () const
1694 struct info_probe_column stap_probe_column;
1696 stap_probe_column.field_name = "semaphore";
1697 stap_probe_column.print_name = _("Semaphore");
1699 return std::vector<struct info_probe_column> { stap_probe_column };
1702 /* Implementation of the `info probes stap' command. */
1705 info_probes_stap_command (const char *arg, int from_tty)
1707 info_probes_for_spops (arg, from_tty, &stap_static_probe_ops);
1711 _initialize_stap_probe (void)
1713 all_static_probe_ops.push_back (&stap_static_probe_ops);
1715 add_setshow_zuinteger_cmd ("stap-expression", class_maintenance,
1716 &stap_expression_debug,
1717 _("Set SystemTap expression debugging."),
1718 _("Show SystemTap expression debugging."),
1719 _("When non-zero, the internal representation "
1720 "of SystemTap expressions will be printed."),
1722 show_stapexpressiondebug,
1723 &setdebuglist, &showdebuglist);
1725 add_cmd ("stap", class_info, info_probes_stap_command,
1727 Show information about SystemTap static probes.\n\
1728 Usage: info probes stap [PROVIDER [NAME [OBJECT]]]\n\
1729 Each argument is a regular expression, used to select probes.\n\
1730 PROVIDER matches probe provider names.\n\
1731 NAME matches the probe names.\n\
1732 OBJECT matches the executable or shared library name."),
1733 info_probes_cmdlist_get ());