Add translations for various sub-directories
[binutils-gdb.git] / gdb / stap-probe.c
blob38ea199edd766c603ceb8251a2ec96fa7d10b0cf
1 /* SystemTap probe support for GDB.
3 Copyright (C) 2012-2024 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "stap-probe.h"
21 #include "extract-store-integer.h"
22 #include "probe.h"
23 #include "ui-out.h"
24 #include "objfiles.h"
25 #include "arch-utils.h"
26 #include "command.h"
27 #include "cli/cli-cmds.h"
28 #include "filenames.h"
29 #include "value.h"
30 #include "ax.h"
31 #include "ax-gdb.h"
32 #include "complaints.h"
33 #include "cli/cli-utils.h"
34 #include "linespec.h"
35 #include "user-regs.h"
36 #include "parser-defs.h"
37 #include "language.h"
38 #include "elf-bfd.h"
39 #include "expop.h"
40 #include <unordered_map>
42 #include <ctype.h>
44 /* The name of the SystemTap section where we will find information about
45 the probes. */
47 #define STAP_BASE_SECTION_NAME ".stapsdt.base"
49 /* Should we display debug information for the probe's argument expression
50 parsing? */
52 static unsigned int stap_expression_debug = 0;
54 /* The various possibilities of bitness defined for a probe's argument.
56 The relationship is:
58 - STAP_ARG_BITNESS_UNDEFINED: The user hasn't specified the bitness.
59 - STAP_ARG_BITNESS_8BIT_UNSIGNED: argument string starts with `1@'.
60 - STAP_ARG_BITNESS_8BIT_SIGNED: argument string starts with `-1@'.
61 - STAP_ARG_BITNESS_16BIT_UNSIGNED: argument string starts with `2@'.
62 - STAP_ARG_BITNESS_16BIT_SIGNED: argument string starts with `-2@'.
63 - STAP_ARG_BITNESS_32BIT_UNSIGNED: argument string starts with `4@'.
64 - STAP_ARG_BITNESS_32BIT_SIGNED: argument string starts with `-4@'.
65 - STAP_ARG_BITNESS_64BIT_UNSIGNED: argument string starts with `8@'.
66 - STAP_ARG_BITNESS_64BIT_SIGNED: argument string starts with `-8@'. */
68 enum stap_arg_bitness
70 STAP_ARG_BITNESS_UNDEFINED,
71 STAP_ARG_BITNESS_8BIT_UNSIGNED,
72 STAP_ARG_BITNESS_8BIT_SIGNED,
73 STAP_ARG_BITNESS_16BIT_UNSIGNED,
74 STAP_ARG_BITNESS_16BIT_SIGNED,
75 STAP_ARG_BITNESS_32BIT_UNSIGNED,
76 STAP_ARG_BITNESS_32BIT_SIGNED,
77 STAP_ARG_BITNESS_64BIT_UNSIGNED,
78 STAP_ARG_BITNESS_64BIT_SIGNED,
81 /* The following structure represents a single argument for the probe. */
83 struct stap_probe_arg
85 /* Constructor for stap_probe_arg. */
86 stap_probe_arg (enum stap_arg_bitness bitness_, struct type *atype_,
87 expression_up &&aexpr_)
88 : bitness (bitness_), atype (atype_), aexpr (std::move (aexpr_))
91 /* The bitness of this argument. */
92 enum stap_arg_bitness bitness;
94 /* The corresponding `struct type *' to the bitness. */
95 struct type *atype;
97 /* The argument converted to an internal GDB expression. */
98 expression_up aexpr;
101 /* Class that implements the static probe methods for "stap" probes. */
103 class stap_static_probe_ops : public static_probe_ops
105 public:
106 /* We need a user-provided constructor to placate some compilers.
107 See PR build/24937. */
108 stap_static_probe_ops ()
112 /* See probe.h. */
113 bool is_linespec (const char **linespecp) const override;
115 /* See probe.h. */
116 void get_probes (std::vector<std::unique_ptr<probe>> *probesp,
117 struct objfile *objfile) const override;
119 /* See probe.h. */
120 const char *type_name () const override;
122 /* See probe.h. */
123 std::vector<struct info_probe_column> gen_info_probes_table_header
124 () const override;
127 /* SystemTap static_probe_ops. */
129 const stap_static_probe_ops stap_static_probe_ops {};
131 class stap_probe : public probe
133 public:
134 /* Constructor for stap_probe. */
135 stap_probe (std::string &&name_, std::string &&provider_, CORE_ADDR address_,
136 struct gdbarch *arch_, CORE_ADDR sem_addr, const char *args_text)
137 : probe (std::move (name_), std::move (provider_), address_, arch_),
138 m_sem_addr (sem_addr),
139 m_have_parsed_args (false), m_unparsed_args_text (args_text)
142 /* See probe.h. */
143 CORE_ADDR get_relocated_address (struct objfile *objfile) override;
145 /* See probe.h. */
146 unsigned get_argument_count (struct gdbarch *gdbarch) override;
148 /* See probe.h. */
149 bool can_evaluate_arguments () const override;
151 /* See probe.h. */
152 struct value *evaluate_argument (unsigned n,
153 const frame_info_ptr &frame) override;
155 /* See probe.h. */
156 void compile_to_ax (struct agent_expr *aexpr,
157 struct axs_value *axs_value,
158 unsigned n) override;
160 /* See probe.h. */
161 void set_semaphore (struct objfile *objfile,
162 struct gdbarch *gdbarch) override;
164 /* See probe.h. */
165 void clear_semaphore (struct objfile *objfile,
166 struct gdbarch *gdbarch) override;
168 /* See probe.h. */
169 const static_probe_ops *get_static_ops () const override;
171 /* See probe.h. */
172 std::vector<const char *> gen_info_probes_table_values () const override;
174 /* Return argument N of probe.
176 If the probe's arguments have not been parsed yet, parse them. If
177 there are no arguments, throw an exception (error). Otherwise,
178 return the requested argument. */
179 struct stap_probe_arg *get_arg_by_number (unsigned n,
180 struct gdbarch *gdbarch)
182 if (!m_have_parsed_args)
183 this->parse_arguments (gdbarch);
185 gdb_assert (m_have_parsed_args);
186 if (m_parsed_args.empty ())
187 internal_error (_("Probe '%s' apparently does not have arguments, but \n"
188 "GDB is requesting its argument number %u anyway. "
189 "This should not happen. Please report this bug."),
190 this->get_name ().c_str (), n);
192 if (n > m_parsed_args.size ())
193 internal_error (_("Probe '%s' has %d arguments, but GDB is requesting\n"
194 "argument %u. This should not happen. Please\n"
195 "report this bug."),
196 this->get_name ().c_str (),
197 (int) m_parsed_args.size (), n);
199 return &m_parsed_args[n];
202 /* Function which parses an argument string from the probe,
203 correctly splitting the arguments and storing their information
204 in properly ways.
206 Consider the following argument string (x86 syntax):
208 `4@%eax 4@$10'
210 We have two arguments, `%eax' and `$10', both with 32-bit
211 unsigned bitness. This function basically handles them, properly
212 filling some structures with this information. */
213 void parse_arguments (struct gdbarch *gdbarch);
215 private:
216 /* If the probe has a semaphore associated, then this is the value of
217 it, relative to SECT_OFF_DATA. */
218 CORE_ADDR m_sem_addr;
220 /* True if the arguments have been parsed. */
221 bool m_have_parsed_args;
223 /* The text version of the probe's arguments, unparsed. */
224 const char *m_unparsed_args_text;
226 /* Information about each argument. This is an array of `stap_probe_arg',
227 with each entry representing one argument. This is only valid if
228 M_ARGS_PARSED is true. */
229 std::vector<struct stap_probe_arg> m_parsed_args;
232 /* When parsing the arguments, we have to establish different precedences
233 for the various kinds of asm operators. This enumeration represents those
234 precedences.
236 This logic behind this is available at
237 <http://sourceware.org/binutils/docs/as/Infix-Ops.html#Infix-Ops>, or using
238 the command "info '(as)Infix Ops'". */
240 enum stap_operand_prec
242 /* Lowest precedence, used for non-recognized operands or for the beginning
243 of the parsing process. */
244 STAP_OPERAND_PREC_NONE = 0,
246 /* Precedence of logical OR. */
247 STAP_OPERAND_PREC_LOGICAL_OR,
249 /* Precedence of logical AND. */
250 STAP_OPERAND_PREC_LOGICAL_AND,
252 /* Precedence of additive (plus, minus) and comparative (equal, less,
253 greater-than, etc) operands. */
254 STAP_OPERAND_PREC_ADD_CMP,
256 /* Precedence of bitwise operands (bitwise OR, XOR, bitwise AND,
257 logical NOT). */
258 STAP_OPERAND_PREC_BITWISE,
260 /* Precedence of multiplicative operands (multiplication, division,
261 remainder, left shift and right shift). */
262 STAP_OPERAND_PREC_MUL
265 static expr::operation_up stap_parse_argument_1 (struct stap_parse_info *p,
266 expr::operation_up &&lhs,
267 enum stap_operand_prec prec)
268 ATTRIBUTE_UNUSED_RESULT;
270 static expr::operation_up stap_parse_argument_conditionally
271 (struct stap_parse_info *p) ATTRIBUTE_UNUSED_RESULT;
273 /* Returns true if *S is an operator, false otherwise. */
275 static bool stap_is_operator (const char *op);
277 static void
278 show_stapexpressiondebug (struct ui_file *file, int from_tty,
279 struct cmd_list_element *c, const char *value)
281 gdb_printf (file, _("SystemTap Probe expression debugging is %s.\n"),
282 value);
285 /* Returns the operator precedence level of OP, or STAP_OPERAND_PREC_NONE
286 if the operator code was not recognized. */
288 static enum stap_operand_prec
289 stap_get_operator_prec (enum exp_opcode op)
291 switch (op)
293 case BINOP_LOGICAL_OR:
294 return STAP_OPERAND_PREC_LOGICAL_OR;
296 case BINOP_LOGICAL_AND:
297 return STAP_OPERAND_PREC_LOGICAL_AND;
299 case BINOP_ADD:
300 case BINOP_SUB:
301 case BINOP_EQUAL:
302 case BINOP_NOTEQUAL:
303 case BINOP_LESS:
304 case BINOP_LEQ:
305 case BINOP_GTR:
306 case BINOP_GEQ:
307 return STAP_OPERAND_PREC_ADD_CMP;
309 case BINOP_BITWISE_IOR:
310 case BINOP_BITWISE_AND:
311 case BINOP_BITWISE_XOR:
312 case UNOP_LOGICAL_NOT:
313 return STAP_OPERAND_PREC_BITWISE;
315 case BINOP_MUL:
316 case BINOP_DIV:
317 case BINOP_REM:
318 case BINOP_LSH:
319 case BINOP_RSH:
320 return STAP_OPERAND_PREC_MUL;
322 default:
323 return STAP_OPERAND_PREC_NONE;
327 /* Given S, read the operator in it. Return the EXP_OPCODE which
328 represents the operator detected, or throw an error if no operator
329 was found. */
331 static enum exp_opcode
332 stap_get_opcode (const char **s)
334 const char c = **s;
335 enum exp_opcode op;
337 *s += 1;
339 switch (c)
341 case '*':
342 op = BINOP_MUL;
343 break;
345 case '/':
346 op = BINOP_DIV;
347 break;
349 case '%':
350 op = BINOP_REM;
351 break;
353 case '<':
354 op = BINOP_LESS;
355 if (**s == '<')
357 *s += 1;
358 op = BINOP_LSH;
360 else if (**s == '=')
362 *s += 1;
363 op = BINOP_LEQ;
365 else if (**s == '>')
367 *s += 1;
368 op = BINOP_NOTEQUAL;
370 break;
372 case '>':
373 op = BINOP_GTR;
374 if (**s == '>')
376 *s += 1;
377 op = BINOP_RSH;
379 else if (**s == '=')
381 *s += 1;
382 op = BINOP_GEQ;
384 break;
386 case '|':
387 op = BINOP_BITWISE_IOR;
388 if (**s == '|')
390 *s += 1;
391 op = BINOP_LOGICAL_OR;
393 break;
395 case '&':
396 op = BINOP_BITWISE_AND;
397 if (**s == '&')
399 *s += 1;
400 op = BINOP_LOGICAL_AND;
402 break;
404 case '^':
405 op = BINOP_BITWISE_XOR;
406 break;
408 case '!':
409 op = UNOP_LOGICAL_NOT;
410 break;
412 case '+':
413 op = BINOP_ADD;
414 break;
416 case '-':
417 op = BINOP_SUB;
418 break;
420 case '=':
421 gdb_assert (**s == '=');
422 op = BINOP_EQUAL;
423 break;
425 default:
426 error (_("Invalid opcode in expression `%s' for SystemTap"
427 "probe"), *s);
430 return op;
433 typedef expr::operation_up binop_maker_ftype (expr::operation_up &&,
434 expr::operation_up &&);
435 /* Map from an expression opcode to a function that can create a
436 binary operation of that type. */
437 static std::unordered_map<exp_opcode, binop_maker_ftype *> stap_maker_map;
439 /* Helper function to create a binary operation. */
440 static expr::operation_up
441 stap_make_binop (enum exp_opcode opcode, expr::operation_up &&lhs,
442 expr::operation_up &&rhs)
444 auto iter = stap_maker_map.find (opcode);
445 gdb_assert (iter != stap_maker_map.end ());
446 return iter->second (std::move (lhs), std::move (rhs));
449 /* Given the bitness of the argument, represented by B, return the
450 corresponding `struct type *', or throw an error if B is
451 unknown. */
453 static struct type *
454 stap_get_expected_argument_type (struct gdbarch *gdbarch,
455 enum stap_arg_bitness b,
456 const char *probe_name)
458 switch (b)
460 case STAP_ARG_BITNESS_UNDEFINED:
461 if (gdbarch_addr_bit (gdbarch) == 32)
462 return builtin_type (gdbarch)->builtin_uint32;
463 else
464 return builtin_type (gdbarch)->builtin_uint64;
466 case STAP_ARG_BITNESS_8BIT_UNSIGNED:
467 return builtin_type (gdbarch)->builtin_uint8;
469 case STAP_ARG_BITNESS_8BIT_SIGNED:
470 return builtin_type (gdbarch)->builtin_int8;
472 case STAP_ARG_BITNESS_16BIT_UNSIGNED:
473 return builtin_type (gdbarch)->builtin_uint16;
475 case STAP_ARG_BITNESS_16BIT_SIGNED:
476 return builtin_type (gdbarch)->builtin_int16;
478 case STAP_ARG_BITNESS_32BIT_SIGNED:
479 return builtin_type (gdbarch)->builtin_int32;
481 case STAP_ARG_BITNESS_32BIT_UNSIGNED:
482 return builtin_type (gdbarch)->builtin_uint32;
484 case STAP_ARG_BITNESS_64BIT_SIGNED:
485 return builtin_type (gdbarch)->builtin_int64;
487 case STAP_ARG_BITNESS_64BIT_UNSIGNED:
488 return builtin_type (gdbarch)->builtin_uint64;
490 default:
491 error (_("Undefined bitness for probe '%s'."), probe_name);
492 break;
496 /* Helper function to check for a generic list of prefixes. GDBARCH
497 is the current gdbarch being used. S is the expression being
498 analyzed. If R is not NULL, it will be used to return the found
499 prefix. PREFIXES is the list of expected prefixes.
501 This function does a case-insensitive match.
503 Return true if any prefix has been found, false otherwise. */
505 static bool
506 stap_is_generic_prefix (struct gdbarch *gdbarch, const char *s,
507 const char **r, const char *const *prefixes)
509 const char *const *p;
511 if (prefixes == NULL)
513 if (r != NULL)
514 *r = "";
516 return true;
519 for (p = prefixes; *p != NULL; ++p)
520 if (strncasecmp (s, *p, strlen (*p)) == 0)
522 if (r != NULL)
523 *r = *p;
525 return true;
528 return false;
531 /* Return true if S points to a register prefix, false otherwise. For
532 a description of the arguments, look at stap_is_generic_prefix. */
534 static bool
535 stap_is_register_prefix (struct gdbarch *gdbarch, const char *s,
536 const char **r)
538 const char *const *t = gdbarch_stap_register_prefixes (gdbarch);
540 return stap_is_generic_prefix (gdbarch, s, r, t);
543 /* Return true if S points to a register indirection prefix, false
544 otherwise. For a description of the arguments, look at
545 stap_is_generic_prefix. */
547 static bool
548 stap_is_register_indirection_prefix (struct gdbarch *gdbarch, const char *s,
549 const char **r)
551 const char *const *t = gdbarch_stap_register_indirection_prefixes (gdbarch);
553 return stap_is_generic_prefix (gdbarch, s, r, t);
556 /* Return true if S points to an integer prefix, false otherwise. For
557 a description of the arguments, look at stap_is_generic_prefix.
559 This function takes care of analyzing whether we are dealing with
560 an expected integer prefix, or, if there is no integer prefix to be
561 expected, whether we are dealing with a digit. It does a
562 case-insensitive match. */
564 static bool
565 stap_is_integer_prefix (struct gdbarch *gdbarch, const char *s,
566 const char **r)
568 const char *const *t = gdbarch_stap_integer_prefixes (gdbarch);
569 const char *const *p;
571 if (t == NULL)
573 /* A NULL value here means that integers do not have a prefix.
574 We just check for a digit then. */
575 if (r != NULL)
576 *r = "";
578 return isdigit (*s) > 0;
581 for (p = t; *p != NULL; ++p)
583 size_t len = strlen (*p);
585 if ((len == 0 && isdigit (*s))
586 || (len > 0 && strncasecmp (s, *p, len) == 0))
588 /* Integers may or may not have a prefix. The "len == 0"
589 check covers the case when integers do not have a prefix
590 (therefore, we just check if we have a digit). The call
591 to "strncasecmp" covers the case when they have a
592 prefix. */
593 if (r != NULL)
594 *r = *p;
596 return true;
600 return false;
603 /* Helper function to check for a generic list of suffixes. If we are
604 not expecting any suffixes, then it just returns 1. If we are
605 expecting at least one suffix, then it returns true if a suffix has
606 been found, false otherwise. GDBARCH is the current gdbarch being
607 used. S is the expression being analyzed. If R is not NULL, it
608 will be used to return the found suffix. SUFFIXES is the list of
609 expected suffixes. This function does a case-insensitive
610 match. */
612 static bool
613 stap_generic_check_suffix (struct gdbarch *gdbarch, const char *s,
614 const char **r, const char *const *suffixes)
616 const char *const *p;
617 bool found = false;
619 if (suffixes == NULL)
621 if (r != NULL)
622 *r = "";
624 return true;
627 for (p = suffixes; *p != NULL; ++p)
628 if (strncasecmp (s, *p, strlen (*p)) == 0)
630 if (r != NULL)
631 *r = *p;
633 found = true;
634 break;
637 return found;
640 /* Return true if S points to an integer suffix, false otherwise. For
641 a description of the arguments, look at
642 stap_generic_check_suffix. */
644 static bool
645 stap_check_integer_suffix (struct gdbarch *gdbarch, const char *s,
646 const char **r)
648 const char *const *p = gdbarch_stap_integer_suffixes (gdbarch);
650 return stap_generic_check_suffix (gdbarch, s, r, p);
653 /* Return true if S points to a register suffix, false otherwise. For
654 a description of the arguments, look at
655 stap_generic_check_suffix. */
657 static bool
658 stap_check_register_suffix (struct gdbarch *gdbarch, const char *s,
659 const char **r)
661 const char *const *p = gdbarch_stap_register_suffixes (gdbarch);
663 return stap_generic_check_suffix (gdbarch, s, r, p);
666 /* Return true if S points to a register indirection suffix, false
667 otherwise. For a description of the arguments, look at
668 stap_generic_check_suffix. */
670 static bool
671 stap_check_register_indirection_suffix (struct gdbarch *gdbarch, const char *s,
672 const char **r)
674 const char *const *p = gdbarch_stap_register_indirection_suffixes (gdbarch);
676 return stap_generic_check_suffix (gdbarch, s, r, p);
679 /* Function responsible for parsing a register operand according to
680 SystemTap parlance. Assuming:
682 RP = register prefix
683 RS = register suffix
684 RIP = register indirection prefix
685 RIS = register indirection suffix
687 Then a register operand can be:
689 [RIP] [RP] REGISTER [RS] [RIS]
691 This function takes care of a register's indirection, displacement and
692 direct access. It also takes into consideration the fact that some
693 registers are named differently inside and outside GDB, e.g., PPC's
694 general-purpose registers are represented by integers in the assembly
695 language (e.g., `15' is the 15th general-purpose register), but inside
696 GDB they have a prefix (the letter `r') appended. */
698 static expr::operation_up
699 stap_parse_register_operand (struct stap_parse_info *p)
701 /* Simple flag to indicate whether we have seen a minus signal before
702 certain number. */
703 bool got_minus = false;
704 /* Flag to indicate whether this register access is being
705 indirected. */
706 bool indirect_p = false;
707 struct gdbarch *gdbarch = p->gdbarch;
708 /* Variables used to extract the register name from the probe's
709 argument. */
710 const char *start;
711 const char *gdb_reg_prefix = gdbarch_stap_gdb_register_prefix (gdbarch);
712 const char *gdb_reg_suffix = gdbarch_stap_gdb_register_suffix (gdbarch);
713 const char *reg_prefix;
714 const char *reg_ind_prefix;
715 const char *reg_suffix;
716 const char *reg_ind_suffix;
718 using namespace expr;
720 /* Checking for a displacement argument. */
721 if (*p->arg == '+')
723 /* If it's a plus sign, we don't need to do anything, just advance the
724 pointer. */
725 ++p->arg;
727 else if (*p->arg == '-')
729 got_minus = true;
730 ++p->arg;
733 struct type *long_type = builtin_type (gdbarch)->builtin_long;
734 operation_up disp_op;
735 if (isdigit (*p->arg))
737 /* The value of the displacement. */
738 long displacement;
739 char *endp;
741 displacement = strtol (p->arg, &endp, 10);
742 p->arg = endp;
744 /* Generating the expression for the displacement. */
745 if (got_minus)
746 displacement = -displacement;
747 disp_op = make_operation<long_const_operation> (long_type, displacement);
750 /* Getting rid of register indirection prefix. */
751 if (stap_is_register_indirection_prefix (gdbarch, p->arg, &reg_ind_prefix))
753 indirect_p = true;
754 p->arg += strlen (reg_ind_prefix);
757 if (disp_op != nullptr && !indirect_p)
758 error (_("Invalid register displacement syntax on expression `%s'."),
759 p->saved_arg);
761 /* Getting rid of register prefix. */
762 if (stap_is_register_prefix (gdbarch, p->arg, &reg_prefix))
763 p->arg += strlen (reg_prefix);
765 /* Now we should have only the register name. Let's extract it and get
766 the associated number. */
767 start = p->arg;
769 /* We assume the register name is composed by letters and numbers. */
770 while (isalnum (*p->arg))
771 ++p->arg;
773 std::string regname (start, p->arg - start);
775 /* We only add the GDB's register prefix/suffix if we are dealing with
776 a numeric register. */
777 if (isdigit (*start))
779 if (gdb_reg_prefix != NULL)
780 regname = gdb_reg_prefix + regname;
782 if (gdb_reg_suffix != NULL)
783 regname += gdb_reg_suffix;
786 int regnum = user_reg_map_name_to_regnum (gdbarch, regname.c_str (),
787 regname.size ());
789 /* Is this a valid register name? */
790 if (regnum == -1)
791 error (_("Invalid register name `%s' on expression `%s'."),
792 regname.c_str (), p->saved_arg);
794 /* Check if there's any special treatment that the arch-specific
795 code would like to perform on the register name. */
796 if (gdbarch_stap_adjust_register_p (gdbarch))
798 std::string newregname
799 = gdbarch_stap_adjust_register (gdbarch, p, regname, regnum);
801 if (regname != newregname)
803 /* This is just a check we perform to make sure that the
804 arch-dependent code has provided us with a valid
805 register name. */
806 regnum = user_reg_map_name_to_regnum (gdbarch, newregname.c_str (),
807 newregname.size ());
809 if (regnum == -1)
810 internal_error (_("Invalid register name '%s' after replacing it"
811 " (previous name was '%s')"),
812 newregname.c_str (), regname.c_str ());
814 regname = std::move (newregname);
818 operation_up reg = make_operation<register_operation> (std::move (regname));
820 /* If the argument has been placed into a vector register then (for most
821 architectures), the type of this register will be a union of arrays.
822 As a result, attempting to cast from the register type to the scalar
823 argument type will not be possible (GDB will throw an error during
824 expression evaluation).
826 The solution is to extract the scalar type from the value contents of
827 the entire register value. */
828 if (!is_scalar_type (gdbarch_register_type (gdbarch, regnum)))
830 gdb_assert (is_scalar_type (p->arg_type));
831 reg = make_operation<unop_extract_operation> (std::move (reg),
832 p->arg_type);
835 if (indirect_p)
837 if (disp_op != nullptr)
838 reg = make_operation<add_operation> (std::move (disp_op),
839 std::move (reg));
841 /* Casting to the expected type. */
842 struct type *arg_ptr_type = lookup_pointer_type (p->arg_type);
843 reg = make_operation<unop_cast_operation> (std::move (reg),
844 arg_ptr_type);
845 reg = make_operation<unop_ind_operation> (std::move (reg));
848 /* Getting rid of the register name suffix. */
849 if (stap_check_register_suffix (gdbarch, p->arg, &reg_suffix))
850 p->arg += strlen (reg_suffix);
851 else
852 error (_("Missing register name suffix on expression `%s'."),
853 p->saved_arg);
855 /* Getting rid of the register indirection suffix. */
856 if (indirect_p)
858 if (stap_check_register_indirection_suffix (gdbarch, p->arg,
859 &reg_ind_suffix))
860 p->arg += strlen (reg_ind_suffix);
861 else
862 error (_("Missing indirection suffix on expression `%s'."),
863 p->saved_arg);
866 return reg;
869 /* This function is responsible for parsing a single operand.
871 A single operand can be:
873 - an unary operation (e.g., `-5', `~2', or even with subexpressions
874 like `-(2 + 1)')
875 - a register displacement, which will be treated as a register
876 operand (e.g., `-4(%eax)' on x86)
877 - a numeric constant, or
878 - a register operand (see function `stap_parse_register_operand')
880 The function also calls special-handling functions to deal with
881 unrecognized operands, allowing arch-specific parsers to be
882 created. */
884 static expr::operation_up
885 stap_parse_single_operand (struct stap_parse_info *p)
887 struct gdbarch *gdbarch = p->gdbarch;
888 const char *int_prefix = NULL;
890 using namespace expr;
892 /* We first try to parse this token as a "special token". */
893 if (gdbarch_stap_parse_special_token_p (gdbarch))
895 operation_up token = gdbarch_stap_parse_special_token (gdbarch, p);
896 if (token != nullptr)
897 return token;
900 struct type *long_type = builtin_type (gdbarch)->builtin_long;
901 operation_up result;
902 if (*p->arg == '-' || *p->arg == '~' || *p->arg == '+' || *p->arg == '!')
904 char c = *p->arg;
905 /* We use this variable to do a lookahead. */
906 const char *tmp = p->arg;
907 bool has_digit = false;
909 /* Skipping signal. */
910 ++tmp;
912 /* This is an unary operation. Here is a list of allowed tokens
913 here:
915 - numeric literal;
916 - number (from register displacement)
917 - subexpression (beginning with `(')
919 We handle the register displacement here, and the other cases
920 recursively. */
921 if (p->inside_paren_p)
922 tmp = skip_spaces (tmp);
924 while (isdigit (*tmp))
926 /* We skip the digit here because we are only interested in
927 knowing what kind of unary operation this is. The digit
928 will be handled by one of the functions that will be
929 called below ('stap_parse_argument_conditionally' or
930 'stap_parse_register_operand'). */
931 ++tmp;
932 has_digit = true;
935 if (has_digit && stap_is_register_indirection_prefix (gdbarch, tmp,
936 NULL))
938 /* If we are here, it means it is a displacement. The only
939 operations allowed here are `-' and `+'. */
940 if (c != '-' && c != '+')
941 error (_("Invalid operator `%c' for register displacement "
942 "on expression `%s'."), c, p->saved_arg);
944 result = stap_parse_register_operand (p);
946 else
948 /* This is not a displacement. We skip the operator, and
949 deal with it when the recursion returns. */
950 ++p->arg;
951 result = stap_parse_argument_conditionally (p);
952 if (c == '-')
953 result = make_operation<unary_neg_operation> (std::move (result));
954 else if (c == '~')
955 result = (make_operation<unary_complement_operation>
956 (std::move (result)));
957 else if (c == '!')
958 result = (make_operation<unary_logical_not_operation>
959 (std::move (result)));
962 else if (isdigit (*p->arg))
964 /* A temporary variable, needed for lookahead. */
965 const char *tmp = p->arg;
966 char *endp;
967 long number;
969 /* We can be dealing with a numeric constant, or with a register
970 displacement. */
971 number = strtol (tmp, &endp, 10);
972 tmp = endp;
974 if (p->inside_paren_p)
975 tmp = skip_spaces (tmp);
977 /* If "stap_is_integer_prefix" returns true, it means we can
978 accept integers without a prefix here. But we also need to
979 check whether the next token (i.e., "tmp") is not a register
980 indirection prefix. */
981 if (stap_is_integer_prefix (gdbarch, p->arg, NULL)
982 && !stap_is_register_indirection_prefix (gdbarch, tmp, NULL))
984 const char *int_suffix;
986 /* We are dealing with a numeric constant. */
987 result = make_operation<long_const_operation> (long_type, number);
989 p->arg = tmp;
991 if (stap_check_integer_suffix (gdbarch, p->arg, &int_suffix))
992 p->arg += strlen (int_suffix);
993 else
994 error (_("Invalid constant suffix on expression `%s'."),
995 p->saved_arg);
997 else if (stap_is_register_indirection_prefix (gdbarch, tmp, NULL))
998 result = stap_parse_register_operand (p);
999 else
1000 error (_("Unknown numeric token on expression `%s'."),
1001 p->saved_arg);
1003 else if (stap_is_integer_prefix (gdbarch, p->arg, &int_prefix))
1005 /* We are dealing with a numeric constant. */
1006 long number;
1007 char *endp;
1008 const char *int_suffix;
1010 p->arg += strlen (int_prefix);
1011 number = strtol (p->arg, &endp, 10);
1012 p->arg = endp;
1014 result = make_operation<long_const_operation> (long_type, number);
1016 if (stap_check_integer_suffix (gdbarch, p->arg, &int_suffix))
1017 p->arg += strlen (int_suffix);
1018 else
1019 error (_("Invalid constant suffix on expression `%s'."),
1020 p->saved_arg);
1022 else if (stap_is_register_prefix (gdbarch, p->arg, NULL)
1023 || stap_is_register_indirection_prefix (gdbarch, p->arg, NULL))
1024 result = stap_parse_register_operand (p);
1025 else
1026 error (_("Operator `%c' not recognized on expression `%s'."),
1027 *p->arg, p->saved_arg);
1029 return result;
1032 /* This function parses an argument conditionally, based on single or
1033 non-single operands. A non-single operand would be a parenthesized
1034 expression (e.g., `(2 + 1)'), and a single operand is anything that
1035 starts with `-', `~', `+' (i.e., unary operators), a digit, or
1036 something recognized by `gdbarch_stap_is_single_operand'. */
1038 static expr::operation_up
1039 stap_parse_argument_conditionally (struct stap_parse_info *p)
1041 gdb_assert (gdbarch_stap_is_single_operand_p (p->gdbarch));
1043 expr::operation_up result;
1044 if (*p->arg == '-' || *p->arg == '~' || *p->arg == '+' || *p->arg == '!'
1045 || isdigit (*p->arg)
1046 || gdbarch_stap_is_single_operand (p->gdbarch, p->arg))
1047 result = stap_parse_single_operand (p);
1048 else if (*p->arg == '(')
1050 /* We are dealing with a parenthesized operand. It means we
1051 have to parse it as it was a separate expression, without
1052 left-side or precedence. */
1053 ++p->arg;
1054 p->arg = skip_spaces (p->arg);
1055 ++p->inside_paren_p;
1057 result = stap_parse_argument_1 (p, {}, STAP_OPERAND_PREC_NONE);
1059 p->arg = skip_spaces (p->arg);
1060 if (*p->arg != ')')
1061 error (_("Missing close-parenthesis on expression `%s'."),
1062 p->saved_arg);
1064 --p->inside_paren_p;
1065 ++p->arg;
1066 if (p->inside_paren_p)
1067 p->arg = skip_spaces (p->arg);
1069 else
1070 error (_("Cannot parse expression `%s'."), p->saved_arg);
1072 return result;
1075 /* Helper function for `stap_parse_argument'. Please, see its comments to
1076 better understand what this function does. */
1078 static expr::operation_up ATTRIBUTE_UNUSED_RESULT
1079 stap_parse_argument_1 (struct stap_parse_info *p,
1080 expr::operation_up &&lhs_in,
1081 enum stap_operand_prec prec)
1083 /* This is an operator-precedence parser.
1085 We work with left- and right-sides of expressions, and
1086 parse them depending on the precedence of the operators
1087 we find. */
1089 gdb_assert (p->arg != NULL);
1091 if (p->inside_paren_p)
1092 p->arg = skip_spaces (p->arg);
1094 using namespace expr;
1095 operation_up lhs = std::move (lhs_in);
1096 if (lhs == nullptr)
1098 /* We were called without a left-side, either because this is the
1099 first call, or because we were called to parse a parenthesized
1100 expression. It doesn't really matter; we have to parse the
1101 left-side in order to continue the process. */
1102 lhs = stap_parse_argument_conditionally (p);
1105 if (p->inside_paren_p)
1106 p->arg = skip_spaces (p->arg);
1108 /* Start to parse the right-side, and to "join" left and right sides
1109 depending on the operation specified.
1111 This loop shall continue until we run out of characters in the input,
1112 or until we find a close-parenthesis, which means that we've reached
1113 the end of a sub-expression. */
1114 while (*p->arg != '\0' && *p->arg != ')' && !isspace (*p->arg))
1116 const char *tmp_exp_buf;
1117 enum exp_opcode opcode;
1118 enum stap_operand_prec cur_prec;
1120 if (!stap_is_operator (p->arg))
1121 error (_("Invalid operator `%c' on expression `%s'."), *p->arg,
1122 p->saved_arg);
1124 /* We have to save the current value of the expression buffer because
1125 the `stap_get_opcode' modifies it in order to get the current
1126 operator. If this operator's precedence is lower than PREC, we
1127 should return and not advance the expression buffer pointer. */
1128 tmp_exp_buf = p->arg;
1129 opcode = stap_get_opcode (&tmp_exp_buf);
1131 cur_prec = stap_get_operator_prec (opcode);
1132 if (cur_prec < prec)
1134 /* If the precedence of the operator that we are seeing now is
1135 lower than the precedence of the first operator seen before
1136 this parsing process began, it means we should stop parsing
1137 and return. */
1138 break;
1141 p->arg = tmp_exp_buf;
1142 if (p->inside_paren_p)
1143 p->arg = skip_spaces (p->arg);
1145 /* Parse the right-side of the expression.
1147 We save whether the right-side is a parenthesized
1148 subexpression because, if it is, we will have to finish
1149 processing this part of the expression before continuing. */
1150 bool paren_subexp = *p->arg == '(';
1152 operation_up rhs = stap_parse_argument_conditionally (p);
1153 if (p->inside_paren_p)
1154 p->arg = skip_spaces (p->arg);
1155 if (paren_subexp)
1157 lhs = stap_make_binop (opcode, std::move (lhs), std::move (rhs));
1158 continue;
1161 /* While we still have operators, try to parse another
1162 right-side, but using the current right-side as a left-side. */
1163 while (*p->arg != '\0' && stap_is_operator (p->arg))
1165 enum exp_opcode lookahead_opcode;
1166 enum stap_operand_prec lookahead_prec;
1168 /* Saving the current expression buffer position. The explanation
1169 is the same as above. */
1170 tmp_exp_buf = p->arg;
1171 lookahead_opcode = stap_get_opcode (&tmp_exp_buf);
1172 lookahead_prec = stap_get_operator_prec (lookahead_opcode);
1174 if (lookahead_prec <= prec)
1176 /* If we are dealing with an operator whose precedence is lower
1177 than the first one, just abandon the attempt. */
1178 break;
1181 /* Parse the right-side of the expression, using the current
1182 right-hand-side as the left-hand-side of the new
1183 subexpression. */
1184 rhs = stap_parse_argument_1 (p, std::move (rhs), lookahead_prec);
1185 if (p->inside_paren_p)
1186 p->arg = skip_spaces (p->arg);
1189 lhs = stap_make_binop (opcode, std::move (lhs), std::move (rhs));
1192 return lhs;
1195 /* Parse a probe's argument.
1197 Assuming that:
1199 LP = literal integer prefix
1200 LS = literal integer suffix
1202 RP = register prefix
1203 RS = register suffix
1205 RIP = register indirection prefix
1206 RIS = register indirection suffix
1208 This routine assumes that arguments' tokens are of the form:
1210 - [LP] NUMBER [LS]
1211 - [RP] REGISTER [RS]
1212 - [RIP] [RP] REGISTER [RS] [RIS]
1213 - If we find a number without LP, we try to parse it as a literal integer
1214 constant (if LP == NULL), or as a register displacement.
1215 - We count parenthesis, and only skip whitespaces if we are inside them.
1216 - If we find an operator, we skip it.
1218 This function can also call a special function that will try to match
1219 unknown tokens. It will return the expression_up generated from
1220 parsing the argument. */
1222 static expression_up
1223 stap_parse_argument (const char **arg, struct type *atype,
1224 struct gdbarch *gdbarch)
1226 /* We need to initialize the expression buffer, in order to begin
1227 our parsing efforts. We use language_c here because we may need
1228 to do pointer arithmetics. */
1229 struct stap_parse_info p (*arg, atype, language_def (language_c),
1230 gdbarch);
1232 using namespace expr;
1233 operation_up result = stap_parse_argument_1 (&p, {}, STAP_OPERAND_PREC_NONE);
1235 gdb_assert (p.inside_paren_p == 0);
1237 /* Casting the final expression to the appropriate type. */
1238 result = make_operation<unop_cast_operation> (std::move (result), atype);
1239 p.pstate.set_operation (std::move (result));
1241 p.arg = skip_spaces (p.arg);
1242 *arg = p.arg;
1244 return p.pstate.release ();
1247 /* Implementation of 'parse_arguments' method. */
1249 void
1250 stap_probe::parse_arguments (struct gdbarch *gdbarch)
1252 const char *cur;
1254 gdb_assert (!m_have_parsed_args);
1255 cur = m_unparsed_args_text;
1256 m_have_parsed_args = true;
1258 if (cur == NULL || *cur == '\0' || *cur == ':')
1259 return;
1261 while (*cur != '\0')
1263 enum stap_arg_bitness bitness;
1264 bool got_minus = false;
1266 /* We expect to find something like:
1268 N@OP
1270 Where `N' can be [+,-][1,2,4,8]. This is not mandatory, so
1271 we check it here. If we don't find it, go to the next
1272 state. */
1273 if ((cur[0] == '-' && isdigit (cur[1]) && cur[2] == '@')
1274 || (isdigit (cur[0]) && cur[1] == '@'))
1276 if (*cur == '-')
1278 /* Discard the `-'. */
1279 ++cur;
1280 got_minus = true;
1283 /* Defining the bitness. */
1284 switch (*cur)
1286 case '1':
1287 bitness = (got_minus ? STAP_ARG_BITNESS_8BIT_SIGNED
1288 : STAP_ARG_BITNESS_8BIT_UNSIGNED);
1289 break;
1291 case '2':
1292 bitness = (got_minus ? STAP_ARG_BITNESS_16BIT_SIGNED
1293 : STAP_ARG_BITNESS_16BIT_UNSIGNED);
1294 break;
1296 case '4':
1297 bitness = (got_minus ? STAP_ARG_BITNESS_32BIT_SIGNED
1298 : STAP_ARG_BITNESS_32BIT_UNSIGNED);
1299 break;
1301 case '8':
1302 bitness = (got_minus ? STAP_ARG_BITNESS_64BIT_SIGNED
1303 : STAP_ARG_BITNESS_64BIT_UNSIGNED);
1304 break;
1306 default:
1308 /* We have an error, because we don't expect anything
1309 except 1, 2, 4 and 8. */
1310 warning (_("unrecognized bitness %s%c' for probe `%s'"),
1311 got_minus ? "`-" : "`", *cur,
1312 this->get_name ().c_str ());
1313 return;
1316 /* Discard the number and the `@' sign. */
1317 cur += 2;
1319 else
1320 bitness = STAP_ARG_BITNESS_UNDEFINED;
1322 struct type *atype
1323 = stap_get_expected_argument_type (gdbarch, bitness,
1324 this->get_name ().c_str ());
1326 expression_up expr = stap_parse_argument (&cur, atype, gdbarch);
1328 if (stap_expression_debug)
1329 expr->dump (gdb_stdlog);
1331 m_parsed_args.emplace_back (bitness, atype, std::move (expr));
1333 /* Start it over again. */
1334 cur = skip_spaces (cur);
1338 /* Helper function to relocate an address. */
1340 static CORE_ADDR
1341 relocate_address (CORE_ADDR address, struct objfile *objfile)
1343 return address + objfile->text_section_offset ();
1346 /* Implementation of the get_relocated_address method. */
1348 CORE_ADDR
1349 stap_probe::get_relocated_address (struct objfile *objfile)
1351 return relocate_address (this->get_address (), objfile);
1354 /* Given PROBE, returns the number of arguments present in that probe's
1355 argument string. */
1357 unsigned
1358 stap_probe::get_argument_count (struct gdbarch *gdbarch)
1360 if (!m_have_parsed_args)
1362 if (this->can_evaluate_arguments ())
1363 this->parse_arguments (gdbarch);
1364 else
1366 static bool have_warned_stap_incomplete = false;
1368 if (!have_warned_stap_incomplete)
1370 warning (_(
1371 "The SystemTap SDT probe support is not fully implemented on this target;\n"
1372 "you will not be able to inspect the arguments of the probes.\n"
1373 "Please report a bug against GDB requesting a port to this target."));
1374 have_warned_stap_incomplete = true;
1377 /* Marking the arguments as "already parsed". */
1378 m_have_parsed_args = true;
1382 gdb_assert (m_have_parsed_args);
1383 return m_parsed_args.size ();
1386 /* Return true if OP is a valid operator inside a probe argument, or
1387 false otherwise. */
1389 static bool
1390 stap_is_operator (const char *op)
1392 bool ret = true;
1394 switch (*op)
1396 case '*':
1397 case '/':
1398 case '%':
1399 case '^':
1400 case '!':
1401 case '+':
1402 case '-':
1403 case '<':
1404 case '>':
1405 case '|':
1406 case '&':
1407 break;
1409 case '=':
1410 if (op[1] != '=')
1411 ret = false;
1412 break;
1414 default:
1415 /* We didn't find any operator. */
1416 ret = false;
1419 return ret;
1422 /* Implement the `can_evaluate_arguments' method. */
1424 bool
1425 stap_probe::can_evaluate_arguments () const
1427 struct gdbarch *gdbarch = this->get_gdbarch ();
1429 /* For SystemTap probes, we have to guarantee that the method
1430 stap_is_single_operand is defined on gdbarch. If it is not, then it
1431 means that argument evaluation is not implemented on this target. */
1432 return gdbarch_stap_is_single_operand_p (gdbarch);
1435 /* Evaluate the probe's argument N (indexed from 0), returning a value
1436 corresponding to it. Assertion is thrown if N does not exist. */
1438 struct value *
1439 stap_probe::evaluate_argument (unsigned n, const frame_info_ptr &frame)
1441 struct stap_probe_arg *arg;
1442 struct gdbarch *gdbarch = get_frame_arch (frame);
1444 arg = this->get_arg_by_number (n, gdbarch);
1445 return arg->aexpr->evaluate (arg->atype);
1448 /* Compile the probe's argument N (indexed from 0) to agent expression.
1449 Assertion is thrown if N does not exist. */
1451 void
1452 stap_probe::compile_to_ax (struct agent_expr *expr, struct axs_value *value,
1453 unsigned n)
1455 struct stap_probe_arg *arg;
1457 arg = this->get_arg_by_number (n, expr->gdbarch);
1459 arg->aexpr->op->generate_ax (arg->aexpr.get (), expr, value);
1461 require_rvalue (expr, value);
1462 value->type = arg->atype;
1466 /* Set or clear a SystemTap semaphore. ADDRESS is the semaphore's
1467 address. SET is zero if the semaphore should be cleared, or one if
1468 it should be set. This is a helper function for
1469 'stap_probe::set_semaphore' and 'stap_probe::clear_semaphore'. */
1471 static void
1472 stap_modify_semaphore (CORE_ADDR address, int set, struct gdbarch *gdbarch)
1474 gdb_byte bytes[sizeof (LONGEST)];
1475 /* The ABI specifies "unsigned short". */
1476 struct type *type = builtin_type (gdbarch)->builtin_unsigned_short;
1477 ULONGEST value;
1479 /* Swallow errors. */
1480 if (target_read_memory (address, bytes, type->length ()) != 0)
1482 warning (_("Could not read the value of a SystemTap semaphore."));
1483 return;
1486 enum bfd_endian byte_order = type_byte_order (type);
1487 value = extract_unsigned_integer (bytes, type->length (), byte_order);
1488 /* Note that we explicitly don't worry about overflow or
1489 underflow. */
1490 if (set)
1491 ++value;
1492 else
1493 --value;
1495 store_unsigned_integer (bytes, type->length (), byte_order, value);
1497 if (target_write_memory (address, bytes, type->length ()) != 0)
1498 warning (_("Could not write the value of a SystemTap semaphore."));
1501 /* Implementation of the 'set_semaphore' method.
1503 SystemTap semaphores act as reference counters, so calls to this
1504 function must be paired with calls to 'clear_semaphore'.
1506 This function and 'clear_semaphore' race with another tool
1507 changing the probes, but that is too rare to care. */
1509 void
1510 stap_probe::set_semaphore (struct objfile *objfile, struct gdbarch *gdbarch)
1512 if (m_sem_addr == 0)
1513 return;
1514 stap_modify_semaphore (relocate_address (m_sem_addr, objfile), 1, gdbarch);
1517 /* Implementation of the 'clear_semaphore' method. */
1519 void
1520 stap_probe::clear_semaphore (struct objfile *objfile, struct gdbarch *gdbarch)
1522 if (m_sem_addr == 0)
1523 return;
1524 stap_modify_semaphore (relocate_address (m_sem_addr, objfile), 0, gdbarch);
1527 /* Implementation of the 'get_static_ops' method. */
1529 const static_probe_ops *
1530 stap_probe::get_static_ops () const
1532 return &stap_static_probe_ops;
1535 /* Implementation of the 'gen_info_probes_table_values' method. */
1537 std::vector<const char *>
1538 stap_probe::gen_info_probes_table_values () const
1540 const char *val = NULL;
1542 if (m_sem_addr != 0)
1543 val = print_core_address (this->get_gdbarch (), m_sem_addr);
1545 return std::vector<const char *> { val };
1548 /* Helper function that parses the information contained in a
1549 SystemTap's probe. Basically, the information consists in:
1551 - Probe's PC address;
1552 - Link-time section address of `.stapsdt.base' section;
1553 - Link-time address of the semaphore variable, or ZERO if the
1554 probe doesn't have an associated semaphore;
1555 - Probe's provider name;
1556 - Probe's name;
1557 - Probe's argument format. */
1559 static void
1560 handle_stap_probe (struct objfile *objfile, struct sdt_note *el,
1561 std::vector<std::unique_ptr<probe>> *probesp,
1562 CORE_ADDR base)
1564 bfd *abfd = objfile->obfd.get ();
1565 int size = bfd_get_arch_size (abfd) / 8;
1566 struct gdbarch *gdbarch = objfile->arch ();
1567 struct type *ptr_type = builtin_type (gdbarch)->builtin_data_ptr;
1569 /* Provider and the name of the probe. */
1570 const char *provider = (const char *) &el->data[3 * size];
1571 const char *name = ((const char *)
1572 memchr (provider, '\0',
1573 (char *) el->data + el->size - provider));
1574 /* Making sure there is a name. */
1575 if (name == NULL)
1577 complaint (_("corrupt probe name when reading `%s'"),
1578 objfile_name (objfile));
1580 /* There is no way to use a probe without a name or a provider, so
1581 returning here makes sense. */
1582 return;
1584 else
1585 ++name;
1587 /* Retrieving the probe's address. */
1588 CORE_ADDR address = extract_typed_address (&el->data[0], ptr_type);
1590 /* Link-time sh_addr of `.stapsdt.base' section. */
1591 CORE_ADDR base_ref = extract_typed_address (&el->data[size], ptr_type);
1593 /* Semaphore address. */
1594 CORE_ADDR sem_addr = extract_typed_address (&el->data[2 * size], ptr_type);
1596 address += base - base_ref;
1597 if (sem_addr != 0)
1598 sem_addr += base - base_ref;
1600 /* Arguments. We can only extract the argument format if there is a valid
1601 name for this probe. */
1602 const char *probe_args = ((const char*)
1603 memchr (name, '\0',
1604 (char *) el->data + el->size - name));
1606 if (probe_args != NULL)
1607 ++probe_args;
1609 if (probe_args == NULL
1610 || (memchr (probe_args, '\0', (char *) el->data + el->size - name)
1611 != el->data + el->size - 1))
1613 complaint (_("corrupt probe argument when reading `%s'"),
1614 objfile_name (objfile));
1615 /* If the argument string is NULL, it means some problem happened with
1616 it. So we return. */
1617 return;
1620 if (ignore_probe_p (provider, name, objfile_name (objfile), "SystemTap"))
1621 return;
1623 stap_probe *ret = new stap_probe (std::string (name), std::string (provider),
1624 address, gdbarch, sem_addr, probe_args);
1626 /* Successfully created probe. */
1627 probesp->emplace_back (ret);
1630 /* Helper function which iterates over every section in the BFD file,
1631 trying to find the base address of the SystemTap base section.
1632 Returns 1 if found (setting BASE to the proper value), zero otherwise. */
1634 static int
1635 get_stap_base_address (bfd *obfd, bfd_vma *base)
1637 asection *ret = NULL;
1639 for (asection *sect : gdb_bfd_sections (obfd))
1640 if ((sect->flags & (SEC_DATA | SEC_ALLOC | SEC_HAS_CONTENTS))
1641 && sect->name && !strcmp (sect->name, STAP_BASE_SECTION_NAME))
1642 ret = sect;
1644 if (ret == NULL)
1646 complaint (_("could not obtain base address for "
1647 "SystemTap section on objfile `%s'."),
1648 bfd_get_filename (obfd));
1649 return 0;
1652 if (base != NULL)
1653 *base = ret->vma;
1655 return 1;
1658 /* Implementation of the 'is_linespec' method. */
1660 bool
1661 stap_static_probe_ops::is_linespec (const char **linespecp) const
1663 static const char *const keywords[] = { "-pstap", "-probe-stap", NULL };
1665 return probe_is_linespec_by_keyword (linespecp, keywords);
1668 /* Implementation of the 'get_probes' method. */
1670 void
1671 stap_static_probe_ops::get_probes
1672 (std::vector<std::unique_ptr<probe>> *probesp,
1673 struct objfile *objfile) const
1675 /* If we are here, then this is the first time we are parsing the
1676 SystemTap probe's information. We basically have to count how many
1677 probes the objfile has, and then fill in the necessary information
1678 for each one. */
1679 bfd *obfd = objfile->obfd.get ();
1680 bfd_vma base;
1681 struct sdt_note *iter;
1682 unsigned save_probesp_len = probesp->size ();
1684 if (objfile->separate_debug_objfile_backlink != NULL)
1686 /* This is a .debug file, not the objfile itself. */
1687 return;
1690 if (elf_tdata (obfd)->sdt_note_head == NULL)
1692 /* There isn't any probe here. */
1693 return;
1696 if (!get_stap_base_address (obfd, &base))
1698 /* There was an error finding the base address for the section.
1699 Just return NULL. */
1700 return;
1703 /* Parsing each probe's information. */
1704 for (iter = elf_tdata (obfd)->sdt_note_head;
1705 iter != NULL;
1706 iter = iter->next)
1708 /* We first have to handle all the information about the
1709 probe which is present in the section. */
1710 handle_stap_probe (objfile, iter, probesp, base);
1713 if (save_probesp_len == probesp->size ())
1715 /* If we are here, it means we have failed to parse every known
1716 probe. */
1717 complaint (_("could not parse SystemTap probe(s) from inferior"));
1718 return;
1722 /* Implementation of the type_name method. */
1724 const char *
1725 stap_static_probe_ops::type_name () const
1727 return "stap";
1730 /* Implementation of the 'gen_info_probes_table_header' method. */
1732 std::vector<struct info_probe_column>
1733 stap_static_probe_ops::gen_info_probes_table_header () const
1735 struct info_probe_column stap_probe_column;
1737 stap_probe_column.field_name = "semaphore";
1738 stap_probe_column.print_name = _("Semaphore");
1740 return std::vector<struct info_probe_column> { stap_probe_column };
1743 /* Implementation of the `info probes stap' command. */
1745 static void
1746 info_probes_stap_command (const char *arg, int from_tty)
1748 info_probes_for_spops (arg, from_tty, &stap_static_probe_ops);
1751 void _initialize_stap_probe ();
1752 void
1753 _initialize_stap_probe ()
1755 all_static_probe_ops.push_back (&stap_static_probe_ops);
1757 add_setshow_zuinteger_cmd ("stap-expression", class_maintenance,
1758 &stap_expression_debug,
1759 _("Set SystemTap expression debugging."),
1760 _("Show SystemTap expression debugging."),
1761 _("\
1762 When non-zero, the internal representation of SystemTap expressions\n\
1763 will be printed."),
1764 NULL,
1765 show_stapexpressiondebug,
1766 &setdebuglist, &showdebuglist);
1768 add_cmd ("stap", class_info, info_probes_stap_command,
1769 _("\
1770 Show information about SystemTap static probes.\n\
1771 Usage: info probes stap [PROVIDER [NAME [OBJECT]]]\n\
1772 Each argument is a regular expression, used to select probes.\n\
1773 PROVIDER matches probe provider names.\n\
1774 NAME matches the probe names.\n\
1775 OBJECT matches the executable or shared library name."),
1776 info_probes_cmdlist_get ());
1779 using namespace expr;
1780 stap_maker_map[BINOP_ADD] = make_operation<add_operation>;
1781 stap_maker_map[BINOP_BITWISE_AND] = make_operation<bitwise_and_operation>;
1782 stap_maker_map[BINOP_BITWISE_IOR] = make_operation<bitwise_ior_operation>;
1783 stap_maker_map[BINOP_BITWISE_XOR] = make_operation<bitwise_xor_operation>;
1784 stap_maker_map[BINOP_DIV] = make_operation<div_operation>;
1785 stap_maker_map[BINOP_EQUAL] = make_operation<equal_operation>;
1786 stap_maker_map[BINOP_GEQ] = make_operation<geq_operation>;
1787 stap_maker_map[BINOP_GTR] = make_operation<gtr_operation>;
1788 stap_maker_map[BINOP_LEQ] = make_operation<leq_operation>;
1789 stap_maker_map[BINOP_LESS] = make_operation<less_operation>;
1790 stap_maker_map[BINOP_LOGICAL_AND] = make_operation<logical_and_operation>;
1791 stap_maker_map[BINOP_LOGICAL_OR] = make_operation<logical_or_operation>;
1792 stap_maker_map[BINOP_LSH] = make_operation<lsh_operation>;
1793 stap_maker_map[BINOP_MUL] = make_operation<mul_operation>;
1794 stap_maker_map[BINOP_NOTEQUAL] = make_operation<notequal_operation>;
1795 stap_maker_map[BINOP_REM] = make_operation<rem_operation>;
1796 stap_maker_map[BINOP_RSH] = make_operation<rsh_operation>;
1797 stap_maker_map[BINOP_SUB] = make_operation<sub_operation>;