1 /* SystemTap probe support for GDB.
3 Copyright (C) 2012-2013 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "stap-probe.h"
26 #include "arch-utils.h"
29 #include "filenames.h"
31 #include "exceptions.h"
34 #include "complaints.h"
35 #include "cli/cli-utils.h"
37 #include "user-regs.h"
38 #include "parser-defs.h"
44 /* The name of the SystemTap section where we will find information about
47 #define STAP_BASE_SECTION_NAME ".stapsdt.base"
49 /* Forward declaration. */
51 static const struct probe_ops stap_probe_ops;
53 /* Should we display debug information for the probe's argument expression
56 static unsigned int stap_expression_debug = 0;
58 /* The various possibilities of bitness defined for a probe's argument.
62 - STAP_ARG_BITNESS_UNDEFINED: The user hasn't specified the bitness.
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@'. */
70 STAP_ARG_BITNESS_UNDEFINED,
71 STAP_ARG_BITNESS_32BIT_UNSIGNED,
72 STAP_ARG_BITNESS_32BIT_SIGNED,
73 STAP_ARG_BITNESS_64BIT_UNSIGNED,
74 STAP_ARG_BITNESS_64BIT_SIGNED,
77 /* The following structure represents a single argument for the probe. */
81 /* The bitness of this argument. */
82 enum stap_arg_bitness bitness;
84 /* The corresponding `struct type *' to the bitness. */
87 /* The argument converted to an internal GDB expression. */
88 struct expression *aexpr;
91 typedef struct stap_probe_arg stap_probe_arg_s;
92 DEF_VEC_O (stap_probe_arg_s);
96 /* Generic information about the probe. This shall be the first element
97 of this struct, in order to maintain binary compatibility with the
98 `struct probe' and be able to fully abstract it. */
101 /* If the probe has a semaphore associated, then this is the value of
105 unsigned int args_parsed : 1;
110 /* Information about each argument. This is an array of `stap_probe_arg',
111 with each entry representing one argument. */
112 VEC (stap_probe_arg_s) *vec;
117 /* When parsing the arguments, we have to establish different precedences
118 for the various kinds of asm operators. This enumeration represents those
121 This logic behind this is available at
122 <http://sourceware.org/binutils/docs/as/Infix-Ops.html#Infix-Ops>, or using
123 the command "info '(as)Infix Ops'". */
125 enum stap_operand_prec
127 /* Lowest precedence, used for non-recognized operands or for the beginning
128 of the parsing process. */
129 STAP_OPERAND_PREC_NONE = 0,
131 /* Precedence of logical OR. */
132 STAP_OPERAND_PREC_LOGICAL_OR,
134 /* Precedence of logical AND. */
135 STAP_OPERAND_PREC_LOGICAL_AND,
137 /* Precedence of additive (plus, minus) and comparative (equal, less,
138 greater-than, etc) operands. */
139 STAP_OPERAND_PREC_ADD_CMP,
141 /* Precedence of bitwise operands (bitwise OR, XOR, bitwise AND,
143 STAP_OPERAND_PREC_BITWISE,
145 /* Precedence of multiplicative operands (multiplication, division,
146 remainder, left shift and right shift). */
147 STAP_OPERAND_PREC_MUL
150 static void stap_parse_argument_1 (struct stap_parse_info *p, int has_lhs,
151 enum stap_operand_prec prec);
153 static void stap_parse_argument_conditionally (struct stap_parse_info *p);
155 /* Returns 1 if *S is an operator, zero otherwise. */
157 static int stap_is_operator (const char *op);
160 show_stapexpressiondebug (struct ui_file *file, int from_tty,
161 struct cmd_list_element *c, const char *value)
163 fprintf_filtered (file, _("SystemTap Probe expression debugging is %s.\n"),
167 /* Returns the operator precedence level of OP, or STAP_OPERAND_PREC_NONE
168 if the operator code was not recognized. */
170 static enum stap_operand_prec
171 stap_get_operator_prec (enum exp_opcode op)
175 case BINOP_LOGICAL_OR:
176 return STAP_OPERAND_PREC_LOGICAL_OR;
178 case BINOP_LOGICAL_AND:
179 return STAP_OPERAND_PREC_LOGICAL_AND;
189 return STAP_OPERAND_PREC_ADD_CMP;
191 case BINOP_BITWISE_IOR:
192 case BINOP_BITWISE_AND:
193 case BINOP_BITWISE_XOR:
194 case UNOP_LOGICAL_NOT:
195 return STAP_OPERAND_PREC_BITWISE;
202 return STAP_OPERAND_PREC_MUL;
205 return STAP_OPERAND_PREC_NONE;
209 /* Given S, read the operator in it and fills the OP pointer with its code.
210 Return 1 on success, zero if the operator was not recognized. */
212 static enum exp_opcode
213 stap_get_opcode (const char **s)
268 op = BINOP_BITWISE_IOR;
272 op = BINOP_LOGICAL_OR;
277 op = BINOP_BITWISE_AND;
281 op = BINOP_LOGICAL_AND;
286 op = BINOP_BITWISE_XOR;
290 op = UNOP_LOGICAL_NOT;
302 gdb_assert (**s == '=');
307 internal_error (__FILE__, __LINE__,
308 _("Invalid opcode in expression `%s' for SystemTap"
315 /* Given the bitness of the argument, represented by B, return the
316 corresponding `struct type *'. */
319 stap_get_expected_argument_type (struct gdbarch *gdbarch,
320 enum stap_arg_bitness b)
324 case STAP_ARG_BITNESS_UNDEFINED:
325 if (gdbarch_addr_bit (gdbarch) == 32)
326 return builtin_type (gdbarch)->builtin_uint32;
328 return builtin_type (gdbarch)->builtin_uint64;
330 case STAP_ARG_BITNESS_32BIT_SIGNED:
331 return builtin_type (gdbarch)->builtin_int32;
333 case STAP_ARG_BITNESS_32BIT_UNSIGNED:
334 return builtin_type (gdbarch)->builtin_uint32;
336 case STAP_ARG_BITNESS_64BIT_SIGNED:
337 return builtin_type (gdbarch)->builtin_int64;
339 case STAP_ARG_BITNESS_64BIT_UNSIGNED:
340 return builtin_type (gdbarch)->builtin_uint64;
343 internal_error (__FILE__, __LINE__,
344 _("Undefined bitness for probe."));
349 /* Function responsible for parsing a register operand according to
350 SystemTap parlance. Assuming:
354 RIP = register indirection prefix
355 RIS = register indirection suffix
357 Then a register operand can be:
359 [RIP] [RP] REGISTER [RS] [RIS]
361 This function takes care of a register's indirection, displacement and
362 direct access. It also takes into consideration the fact that some
363 registers are named differently inside and outside GDB, e.g., PPC's
364 general-purpose registers are represented by integers in the assembly
365 language (e.g., `15' is the 15th general-purpose register), but inside
366 GDB they have a prefix (the letter `r') appended. */
369 stap_parse_register_operand (struct stap_parse_info *p)
371 /* Simple flag to indicate whether we have seen a minus signal before
375 /* Flags to indicate whether this register access is being displaced and/or
377 int disp_p = 0, indirect_p = 0;
378 struct gdbarch *gdbarch = p->gdbarch;
380 /* Needed to generate the register name as a part of an expression. */
383 /* Variables used to extract the register name from the probe's
389 /* Prefixes for the parser. */
390 const char *reg_prefix = gdbarch_stap_register_prefix (gdbarch);
391 const char *reg_ind_prefix
392 = gdbarch_stap_register_indirection_prefix (gdbarch);
393 const char *gdb_reg_prefix = gdbarch_stap_gdb_register_prefix (gdbarch);
394 int reg_prefix_len = reg_prefix ? strlen (reg_prefix) : 0;
395 int reg_ind_prefix_len = reg_ind_prefix ? strlen (reg_ind_prefix) : 0;
396 int gdb_reg_prefix_len = gdb_reg_prefix ? strlen (gdb_reg_prefix) : 0;
398 /* Suffixes for the parser. */
399 const char *reg_suffix = gdbarch_stap_register_suffix (gdbarch);
400 const char *reg_ind_suffix
401 = gdbarch_stap_register_indirection_suffix (gdbarch);
402 const char *gdb_reg_suffix = gdbarch_stap_gdb_register_suffix (gdbarch);
403 int reg_suffix_len = reg_suffix ? strlen (reg_suffix) : 0;
404 int reg_ind_suffix_len = reg_ind_suffix ? strlen (reg_ind_suffix) : 0;
405 int gdb_reg_suffix_len = gdb_reg_suffix ? strlen (gdb_reg_suffix) : 0;
407 /* Checking for a displacement argument. */
410 /* If it's a plus sign, we don't need to do anything, just advance the
421 if (isdigit (*p->arg))
423 /* The value of the displacement. */
428 displacement = strtol (p->arg, &endp, 10);
431 /* Generating the expression for the displacement. */
432 write_exp_elt_opcode (OP_LONG);
433 write_exp_elt_type (builtin_type (gdbarch)->builtin_long);
434 write_exp_elt_longcst (displacement);
435 write_exp_elt_opcode (OP_LONG);
437 write_exp_elt_opcode (UNOP_NEG);
440 /* Getting rid of register indirection prefix. */
442 && strncmp (p->arg, reg_ind_prefix, reg_ind_prefix_len) == 0)
445 p->arg += reg_ind_prefix_len;
448 if (disp_p && !indirect_p)
449 error (_("Invalid register displacement syntax on expression `%s'."),
452 /* Getting rid of register prefix. */
453 if (reg_prefix && strncmp (p->arg, reg_prefix, reg_prefix_len) == 0)
454 p->arg += reg_prefix_len;
456 /* Now we should have only the register name. Let's extract it and get
457 the associated number. */
460 /* We assume the register name is composed by letters and numbers. */
461 while (isalnum (*p->arg))
464 len = p->arg - start;
466 regname = alloca (len + gdb_reg_prefix_len + gdb_reg_suffix_len + 1);
469 /* We only add the GDB's register prefix/suffix if we are dealing with
470 a numeric register. */
471 if (gdb_reg_prefix && isdigit (*start))
473 strncpy (regname, gdb_reg_prefix, gdb_reg_prefix_len);
474 strncpy (regname + gdb_reg_prefix_len, start, len);
477 strncpy (regname + gdb_reg_prefix_len + len,
478 gdb_reg_suffix, gdb_reg_suffix_len);
480 len += gdb_reg_prefix_len + gdb_reg_suffix_len;
483 strncpy (regname, start, len);
487 /* Is this a valid register name? */
488 if (user_reg_map_name_to_regnum (gdbarch, regname, len) == -1)
489 error (_("Invalid register name `%s' on expression `%s'."),
490 regname, p->saved_arg);
492 write_exp_elt_opcode (OP_REGISTER);
495 write_exp_string (str);
496 write_exp_elt_opcode (OP_REGISTER);
501 write_exp_elt_opcode (BINOP_ADD);
503 /* Casting to the expected type. */
504 write_exp_elt_opcode (UNOP_CAST);
505 write_exp_elt_type (lookup_pointer_type (p->arg_type));
506 write_exp_elt_opcode (UNOP_CAST);
508 write_exp_elt_opcode (UNOP_IND);
511 /* Getting rid of the register name suffix. */
514 if (strncmp (p->arg, reg_suffix, reg_suffix_len) != 0)
515 error (_("Missing register name suffix `%s' on expression `%s'."),
516 reg_suffix, p->saved_arg);
518 p->arg += reg_suffix_len;
521 /* Getting rid of the register indirection suffix. */
522 if (indirect_p && reg_ind_suffix)
524 if (strncmp (p->arg, reg_ind_suffix, reg_ind_suffix_len) != 0)
525 error (_("Missing indirection suffix `%s' on expression `%s'."),
526 reg_ind_suffix, p->saved_arg);
528 p->arg += reg_ind_suffix_len;
532 /* This function is responsible for parsing a single operand.
534 A single operand can be:
536 - an unary operation (e.g., `-5', `~2', or even with subexpressions
538 - a register displacement, which will be treated as a register
539 operand (e.g., `-4(%eax)' on x86)
540 - a numeric constant, or
541 - a register operand (see function `stap_parse_register_operand')
543 The function also calls special-handling functions to deal with
544 unrecognized operands, allowing arch-specific parsers to be
548 stap_parse_single_operand (struct stap_parse_info *p)
550 struct gdbarch *gdbarch = p->gdbarch;
552 /* Prefixes for the parser. */
553 const char *const_prefix = gdbarch_stap_integer_prefix (gdbarch);
554 const char *reg_prefix = gdbarch_stap_register_prefix (gdbarch);
555 const char *reg_ind_prefix
556 = gdbarch_stap_register_indirection_prefix (gdbarch);
557 int const_prefix_len = const_prefix ? strlen (const_prefix) : 0;
558 int reg_prefix_len = reg_prefix ? strlen (reg_prefix) : 0;
559 int reg_ind_prefix_len = reg_ind_prefix ? strlen (reg_ind_prefix) : 0;
561 /* Suffixes for the parser. */
562 const char *const_suffix = gdbarch_stap_integer_suffix (gdbarch);
563 int const_suffix_len = const_suffix ? strlen (const_suffix) : 0;
565 /* We first try to parse this token as a "special token". */
566 if (gdbarch_stap_parse_special_token_p (gdbarch))
568 int ret = gdbarch_stap_parse_special_token (gdbarch, p);
572 /* If the return value of the above function is not zero,
573 it means it successfully parsed the special token.
575 If it is NULL, we try to parse it using our method. */
580 if (*p->arg == '-' || *p->arg == '~' || *p->arg == '+')
585 /* We use this variable to do a lookahead. */
586 const char *tmp = p->arg;
590 /* This is an unary operation. Here is a list of allowed tokens
594 - number (from register displacement)
595 - subexpression (beginning with `(')
597 We handle the register displacement here, and the other cases
599 if (p->inside_paren_p)
600 tmp = skip_spaces_const (tmp);
606 number = strtol (tmp, &endp, 10);
611 || strncmp (tmp, reg_ind_prefix, reg_ind_prefix_len) != 0)
613 /* This is not a displacement. We skip the operator, and deal
616 stap_parse_argument_conditionally (p);
618 write_exp_elt_opcode (UNOP_NEG);
620 write_exp_elt_opcode (UNOP_COMPLEMENT);
624 /* If we are here, it means it is a displacement. The only
625 operations allowed here are `-' and `+'. */
627 error (_("Invalid operator `%c' for register displacement "
628 "on expression `%s'."), c, p->saved_arg);
630 stap_parse_register_operand (p);
633 else if (isdigit (*p->arg))
635 /* A temporary variable, needed for lookahead. */
636 const char *tmp = p->arg;
640 /* We can be dealing with a numeric constant (if `const_prefix' is
641 NULL), or with a register displacement. */
642 number = strtol (tmp, &endp, 10);
645 if (p->inside_paren_p)
646 tmp = skip_spaces_const (tmp);
647 if (!const_prefix && reg_ind_prefix
648 && strncmp (tmp, reg_ind_prefix, reg_ind_prefix_len) != 0)
650 /* We are dealing with a numeric constant. */
651 write_exp_elt_opcode (OP_LONG);
652 write_exp_elt_type (builtin_type (gdbarch)->builtin_long);
653 write_exp_elt_longcst (number);
654 write_exp_elt_opcode (OP_LONG);
660 if (strncmp (p->arg, const_suffix, const_suffix_len) == 0)
661 p->arg += const_suffix_len;
663 error (_("Invalid constant suffix on expression `%s'."),
667 else if (reg_ind_prefix
668 && strncmp (tmp, reg_ind_prefix, reg_ind_prefix_len) == 0)
669 stap_parse_register_operand (p);
671 error (_("Unknown numeric token on expression `%s'."),
674 else if (const_prefix
675 && strncmp (p->arg, const_prefix, const_prefix_len) == 0)
677 /* We are dealing with a numeric constant. */
681 p->arg += const_prefix_len;
682 number = strtol (p->arg, &endp, 10);
685 write_exp_elt_opcode (OP_LONG);
686 write_exp_elt_type (builtin_type (gdbarch)->builtin_long);
687 write_exp_elt_longcst (number);
688 write_exp_elt_opcode (OP_LONG);
692 if (strncmp (p->arg, const_suffix, const_suffix_len) == 0)
693 p->arg += const_suffix_len;
695 error (_("Invalid constant suffix on expression `%s'."),
700 && strncmp (p->arg, reg_prefix, reg_prefix_len) == 0)
702 && strncmp (p->arg, reg_ind_prefix, reg_ind_prefix_len) == 0))
703 stap_parse_register_operand (p);
705 error (_("Operator `%c' not recognized on expression `%s'."),
706 *p->arg, p->saved_arg);
709 /* This function parses an argument conditionally, based on single or
710 non-single operands. A non-single operand would be a parenthesized
711 expression (e.g., `(2 + 1)'), and a single operand is anything that
712 starts with `-', `~', `+' (i.e., unary operators), a digit, or
713 something recognized by `gdbarch_stap_is_single_operand'. */
716 stap_parse_argument_conditionally (struct stap_parse_info *p)
718 if (*p->arg == '-' || *p->arg == '~' || *p->arg == '+' /* Unary. */
720 || gdbarch_stap_is_single_operand (p->gdbarch, p->arg))
721 stap_parse_single_operand (p);
722 else if (*p->arg == '(')
724 /* We are dealing with a parenthesized operand. It means we
725 have to parse it as it was a separate expression, without
726 left-side or precedence. */
728 p->arg = skip_spaces_const (p->arg);
731 stap_parse_argument_1 (p, 0, STAP_OPERAND_PREC_NONE);
735 error (_("Missign close-paren on expression `%s'."),
739 if (p->inside_paren_p)
740 p->arg = skip_spaces_const (p->arg);
743 error (_("Cannot parse expression `%s'."), p->saved_arg);
746 /* Helper function for `stap_parse_argument'. Please, see its comments to
747 better understand what this function does. */
750 stap_parse_argument_1 (struct stap_parse_info *p, int has_lhs,
751 enum stap_operand_prec prec)
753 /* This is an operator-precedence parser.
755 We work with left- and right-sides of expressions, and
756 parse them depending on the precedence of the operators
759 if (p->inside_paren_p)
760 p->arg = skip_spaces_const (p->arg);
764 /* We were called without a left-side, either because this is the
765 first call, or because we were called to parse a parenthesized
766 expression. It doesn't really matter; we have to parse the
767 left-side in order to continue the process. */
768 stap_parse_argument_conditionally (p);
771 /* Start to parse the right-side, and to "join" left and right sides
772 depending on the operation specified.
774 This loop shall continue until we run out of characters in the input,
775 or until we find a close-parenthesis, which means that we've reached
776 the end of a sub-expression. */
777 while (p->arg && *p->arg && *p->arg != ')' && !isspace (*p->arg))
779 const char *tmp_exp_buf;
780 enum exp_opcode opcode;
781 enum stap_operand_prec cur_prec;
783 if (!stap_is_operator (p->arg))
784 error (_("Invalid operator `%c' on expression `%s'."), *p->arg,
787 /* We have to save the current value of the expression buffer because
788 the `stap_get_opcode' modifies it in order to get the current
789 operator. If this operator's precedence is lower than PREC, we
790 should return and not advance the expression buffer pointer. */
791 tmp_exp_buf = p->arg;
792 opcode = stap_get_opcode (&tmp_exp_buf);
794 cur_prec = stap_get_operator_prec (opcode);
797 /* If the precedence of the operator that we are seeing now is
798 lower than the precedence of the first operator seen before
799 this parsing process began, it means we should stop parsing
804 p->arg = tmp_exp_buf;
805 if (p->inside_paren_p)
806 p->arg = skip_spaces_const (p->arg);
808 /* Parse the right-side of the expression. */
809 stap_parse_argument_conditionally (p);
811 /* While we still have operators, try to parse another
812 right-side, but using the current right-side as a left-side. */
813 while (*p->arg && stap_is_operator (p->arg))
815 enum exp_opcode lookahead_opcode;
816 enum stap_operand_prec lookahead_prec;
818 /* Saving the current expression buffer position. The explanation
819 is the same as above. */
820 tmp_exp_buf = p->arg;
821 lookahead_opcode = stap_get_opcode (&tmp_exp_buf);
822 lookahead_prec = stap_get_operator_prec (lookahead_opcode);
824 if (lookahead_prec <= prec)
826 /* If we are dealing with an operator whose precedence is lower
827 than the first one, just abandon the attempt. */
831 /* Parse the right-side of the expression, but since we already
832 have a left-side at this point, set `has_lhs' to 1. */
833 stap_parse_argument_1 (p, 1, lookahead_prec);
836 write_exp_elt_opcode (opcode);
840 /* Parse a probe's argument.
844 LP = literal integer prefix
845 LS = literal integer suffix
850 RIP = register indirection prefix
851 RIS = register indirection suffix
853 This routine assumes that arguments' tokens are of the form:
857 - [RIP] [RP] REGISTER [RS] [RIS]
858 - If we find a number without LP, we try to parse it as a literal integer
859 constant (if LP == NULL), or as a register displacement.
860 - We count parenthesis, and only skip whitespaces if we are inside them.
861 - If we find an operator, we skip it.
863 This function can also call a special function that will try to match
864 unknown tokens. It will return 1 if the argument has been parsed
865 successfully, or zero otherwise. */
867 static struct expression *
868 stap_parse_argument (const char **arg, struct type *atype,
869 struct gdbarch *gdbarch)
871 struct stap_parse_info p;
872 struct cleanup *back_to;
874 /* We need to initialize the expression buffer, in order to begin
875 our parsing efforts. The language here does not matter, since we
876 are using our own parser. */
877 initialize_expout (10, current_language, gdbarch);
878 back_to = make_cleanup (free_current_contents, &expout);
884 p.inside_paren_p = 0;
886 stap_parse_argument_1 (&p, 0, STAP_OPERAND_PREC_NONE);
888 discard_cleanups (back_to);
890 gdb_assert (p.inside_paren_p == 0);
892 /* Casting the final expression to the appropriate type. */
893 write_exp_elt_opcode (UNOP_CAST);
894 write_exp_elt_type (atype);
895 write_exp_elt_opcode (UNOP_CAST);
897 reallocate_expout ();
899 p.arg = skip_spaces_const (p.arg);
905 /* Function which parses an argument string from PROBE, correctly splitting
906 the arguments and storing their information in properly ways.
908 Consider the following argument string (x86 syntax):
912 We have two arguments, `%eax' and `$10', both with 32-bit unsigned bitness.
913 This function basically handles them, properly filling some structures with
917 stap_parse_probe_arguments (struct stap_probe *probe)
920 struct gdbarch *gdbarch = get_objfile_arch (probe->p.objfile);
922 gdb_assert (!probe->args_parsed);
923 cur = probe->args_u.text;
924 probe->args_parsed = 1;
925 probe->args_u.vec = NULL;
927 if (!cur || !*cur || *cur == ':')
932 struct stap_probe_arg arg;
933 enum stap_arg_bitness b;
935 struct expression *expr;
937 memset (&arg, 0, sizeof (arg));
939 /* We expect to find something like:
943 Where `N' can be [+,-][4,8]. This is not mandatory, so
944 we check it here. If we don't find it, go to the next
946 if ((*cur == '-' && cur[1] && cur[2] != '@')
948 arg.bitness = STAP_ARG_BITNESS_UNDEFINED;
953 /* Discard the `-'. */
959 b = (got_minus ? STAP_ARG_BITNESS_32BIT_SIGNED
960 : STAP_ARG_BITNESS_32BIT_UNSIGNED);
961 else if (*cur == '8')
962 b = (got_minus ? STAP_ARG_BITNESS_64BIT_SIGNED
963 : STAP_ARG_BITNESS_64BIT_UNSIGNED);
966 /* We have an error, because we don't expect anything
968 complaint (&symfile_complaints,
969 _("unrecognized bitness `%c' for probe `%s'"),
970 *cur, probe->p.name);
975 arg.atype = stap_get_expected_argument_type (gdbarch, b);
977 /* Discard the number and the `@' sign. */
981 expr = stap_parse_argument (&cur, arg.atype, gdbarch);
983 if (stap_expression_debug)
984 dump_raw_expression (expr, gdb_stdlog,
985 "before conversion to prefix form");
987 prefixify_expression (expr);
989 if (stap_expression_debug)
990 dump_prefix_expression (expr, gdb_stdlog);
994 /* Start it over again. */
995 cur = skip_spaces_const (cur);
997 VEC_safe_push (stap_probe_arg_s, probe->args_u.vec, &arg);
1001 /* Given PROBE, returns the number of arguments present in that probe's
1005 stap_get_probe_argument_count (struct probe *probe_generic)
1007 struct stap_probe *probe = (struct stap_probe *) probe_generic;
1009 gdb_assert (probe_generic->pops == &stap_probe_ops);
1011 if (!probe->args_parsed)
1013 if (probe_generic->pops->can_evaluate_probe_arguments (probe_generic))
1014 stap_parse_probe_arguments (probe);
1017 static int have_warned_stap_incomplete = 0;
1019 if (!have_warned_stap_incomplete)
1022 "The SystemTap SDT probe support is not fully implemented on this target;\n"
1023 "you will not be able to inspect the arguments of the probes.\n"
1024 "Please report a bug against GDB requesting a port to this target."));
1025 have_warned_stap_incomplete = 1;
1028 /* Marking the arguments as "already parsed". */
1029 probe->args_u.vec = NULL;
1030 probe->args_parsed = 1;
1034 gdb_assert (probe->args_parsed);
1035 return VEC_length (stap_probe_arg_s, probe->args_u.vec);
1038 /* Return 1 if OP is a valid operator inside a probe argument, or zero
1042 stap_is_operator (const char *op)
1067 /* We didn't find any operator. */
1074 static struct stap_probe_arg *
1075 stap_get_arg (struct stap_probe *probe, unsigned n)
1077 if (!probe->args_parsed)
1078 stap_parse_probe_arguments (probe);
1080 return VEC_index (stap_probe_arg_s, probe->args_u.vec, n);
1083 /* Implement the `can_evaluate_probe_arguments' method of probe_ops. */
1086 stap_can_evaluate_probe_arguments (struct probe *probe_generic)
1088 struct stap_probe *stap_probe = (struct stap_probe *) probe_generic;
1089 struct gdbarch *gdbarch = get_objfile_arch (stap_probe->p.objfile);
1091 /* For SystemTap probes, we have to guarantee that the method
1092 stap_is_single_operand is defined on gdbarch. If it is not, then it
1093 means that argument evaluation is not implemented on this target. */
1094 return gdbarch_stap_is_single_operand_p (gdbarch);
1097 /* Evaluate the probe's argument N (indexed from 0), returning a value
1098 corresponding to it. Assertion is thrown if N does not exist. */
1100 static struct value *
1101 stap_evaluate_probe_argument (struct probe *probe_generic, unsigned n)
1103 struct stap_probe *stap_probe = (struct stap_probe *) probe_generic;
1104 struct stap_probe_arg *arg;
1107 gdb_assert (probe_generic->pops == &stap_probe_ops);
1109 arg = stap_get_arg (stap_probe, n);
1110 return evaluate_subexp_standard (arg->atype, arg->aexpr, &pos, EVAL_NORMAL);
1113 /* Compile the probe's argument N (indexed from 0) to agent expression.
1114 Assertion is thrown if N does not exist. */
1117 stap_compile_to_ax (struct probe *probe_generic, struct agent_expr *expr,
1118 struct axs_value *value, unsigned n)
1120 struct stap_probe *stap_probe = (struct stap_probe *) probe_generic;
1121 struct stap_probe_arg *arg;
1122 union exp_element *pc;
1124 gdb_assert (probe_generic->pops == &stap_probe_ops);
1126 arg = stap_get_arg (stap_probe, n);
1128 pc = arg->aexpr->elts;
1129 gen_expr (arg->aexpr, &pc, expr, value);
1131 require_rvalue (expr, value);
1132 value->type = arg->atype;
1135 /* Destroy (free) the data related to PROBE. PROBE memory itself is not feed
1136 as it is allocated from OBJFILE_OBSTACK. */
1139 stap_probe_destroy (struct probe *probe_generic)
1141 struct stap_probe *probe = (struct stap_probe *) probe_generic;
1143 gdb_assert (probe_generic->pops == &stap_probe_ops);
1145 if (probe->args_parsed)
1147 struct stap_probe_arg *arg;
1150 for (ix = 0; VEC_iterate (stap_probe_arg_s, probe->args_u.vec, ix, arg);
1153 VEC_free (stap_probe_arg_s, probe->args_u.vec);
1159 /* This is called to compute the value of one of the $_probe_arg*
1160 convenience variables. */
1162 static struct value *
1163 compute_probe_arg (struct gdbarch *arch, struct internalvar *ivar,
1166 struct frame_info *frame = get_selected_frame (_("No frame selected"));
1167 CORE_ADDR pc = get_frame_pc (frame);
1168 int sel = (int) (uintptr_t) data;
1169 struct probe *pc_probe;
1170 const struct sym_probe_fns *pc_probe_fns;
1173 /* SEL == -1 means "_probe_argc". */
1174 gdb_assert (sel >= -1);
1176 pc_probe = find_probe_by_pc (pc);
1177 if (pc_probe == NULL)
1178 error (_("No SystemTap probe at PC %s"), core_addr_to_string (pc));
1180 gdb_assert (pc_probe->objfile != NULL);
1181 gdb_assert (pc_probe->objfile->sf != NULL);
1182 gdb_assert (pc_probe->objfile->sf->sym_probe_fns != NULL);
1184 pc_probe_fns = pc_probe->objfile->sf->sym_probe_fns;
1186 n_args = pc_probe_fns->sym_get_probe_argument_count (pc_probe);
1188 return value_from_longest (builtin_type (arch)->builtin_int, n_args);
1191 error (_("Invalid probe argument %d -- probe has %u arguments available"),
1194 return pc_probe_fns->sym_evaluate_probe_argument (pc_probe, sel);
1197 /* This is called to compile one of the $_probe_arg* convenience
1198 variables into an agent expression. */
1201 compile_probe_arg (struct internalvar *ivar, struct agent_expr *expr,
1202 struct axs_value *value, void *data)
1204 CORE_ADDR pc = expr->scope;
1205 int sel = (int) (uintptr_t) data;
1206 struct probe *pc_probe;
1207 const struct sym_probe_fns *pc_probe_fns;
1210 /* SEL == -1 means "_probe_argc". */
1211 gdb_assert (sel >= -1);
1213 pc_probe = find_probe_by_pc (pc);
1214 if (pc_probe == NULL)
1215 error (_("No SystemTap probe at PC %s"), core_addr_to_string (pc));
1217 gdb_assert (pc_probe->objfile != NULL);
1218 gdb_assert (pc_probe->objfile->sf != NULL);
1219 gdb_assert (pc_probe->objfile->sf->sym_probe_fns != NULL);
1221 pc_probe_fns = pc_probe->objfile->sf->sym_probe_fns;
1223 n_args = pc_probe_fns->sym_get_probe_argument_count (pc_probe);
1227 value->kind = axs_rvalue;
1228 value->type = builtin_type (expr->gdbarch)->builtin_int;
1229 ax_const_l (expr, n_args);
1233 gdb_assert (sel >= 0);
1235 error (_("Invalid probe argument %d -- probe has %d arguments available"),
1238 pc_probe_fns->sym_compile_to_ax (pc_probe, expr, value, sel);
1243 /* Set or clear a SystemTap semaphore. ADDRESS is the semaphore's
1244 address. SET is zero if the semaphore should be cleared, or one
1245 if it should be set. This is a helper function for `stap_semaphore_down'
1246 and `stap_semaphore_up'. */
1249 stap_modify_semaphore (CORE_ADDR address, int set, struct gdbarch *gdbarch)
1251 gdb_byte bytes[sizeof (LONGEST)];
1252 /* The ABI specifies "unsigned short". */
1253 struct type *type = builtin_type (gdbarch)->builtin_unsigned_short;
1259 /* Swallow errors. */
1260 if (target_read_memory (address, bytes, TYPE_LENGTH (type)) != 0)
1262 warning (_("Could not read the value of a SystemTap semaphore."));
1266 value = extract_unsigned_integer (bytes, TYPE_LENGTH (type),
1267 gdbarch_byte_order (gdbarch));
1268 /* Note that we explicitly don't worry about overflow or
1275 store_unsigned_integer (bytes, TYPE_LENGTH (type),
1276 gdbarch_byte_order (gdbarch), value);
1278 if (target_write_memory (address, bytes, TYPE_LENGTH (type)) != 0)
1279 warning (_("Could not write the value of a SystemTap semaphore."));
1282 /* Set a SystemTap semaphore. SEM is the semaphore's address. Semaphores
1283 act as reference counters, so calls to this function must be paired with
1284 calls to `stap_semaphore_down'.
1286 This function and `stap_semaphore_down' race with another tool changing
1287 the probes, but that is too rare to care. */
1290 stap_set_semaphore (struct probe *probe_generic, struct gdbarch *gdbarch)
1292 struct stap_probe *probe = (struct stap_probe *) probe_generic;
1294 gdb_assert (probe_generic->pops == &stap_probe_ops);
1296 stap_modify_semaphore (probe->sem_addr, 1, gdbarch);
1299 /* Clear a SystemTap semaphore. SEM is the semaphore's address. */
1302 stap_clear_semaphore (struct probe *probe_generic, struct gdbarch *gdbarch)
1304 struct stap_probe *probe = (struct stap_probe *) probe_generic;
1306 gdb_assert (probe_generic->pops == &stap_probe_ops);
1308 stap_modify_semaphore (probe->sem_addr, 0, gdbarch);
1311 /* Implementation of `$_probe_arg*' set of variables. */
1313 static const struct internalvar_funcs probe_funcs =
1320 /* Helper function that parses the information contained in a
1321 SystemTap's probe. Basically, the information consists in:
1323 - Probe's PC address;
1324 - Link-time section address of `.stapsdt.base' section;
1325 - Link-time address of the semaphore variable, or ZERO if the
1326 probe doesn't have an associated semaphore;
1327 - Probe's provider name;
1329 - Probe's argument format
1331 This function returns 1 if the handling was successful, and zero
1335 handle_stap_probe (struct objfile *objfile, struct sdt_note *el,
1336 VEC (probe_p) **probesp, CORE_ADDR base)
1338 bfd *abfd = objfile->obfd;
1339 int size = bfd_get_arch_size (abfd) / 8;
1340 struct gdbarch *gdbarch = get_objfile_arch (objfile);
1341 struct type *ptr_type = builtin_type (gdbarch)->builtin_data_ptr;
1343 const char *probe_args = NULL;
1344 struct stap_probe *ret;
1346 ret = obstack_alloc (&objfile->objfile_obstack, sizeof (*ret));
1347 ret->p.pops = &stap_probe_ops;
1348 ret->p.objfile = objfile;
1350 /* Provider and the name of the probe. */
1351 ret->p.provider = (char *) &el->data[3 * size];
1352 ret->p.name = memchr (ret->p.provider, '\0',
1353 (char *) el->data + el->size - ret->p.provider);
1354 /* Making sure there is a name. */
1357 complaint (&symfile_complaints, _("corrupt probe name when "
1358 "reading `%s'"), objfile->name);
1360 /* There is no way to use a probe without a name or a provider, so
1361 returning zero here makes sense. */
1367 /* Retrieving the probe's address. */
1368 ret->p.address = extract_typed_address (&el->data[0], ptr_type);
1370 /* Link-time sh_addr of `.stapsdt.base' section. */
1371 base_ref = extract_typed_address (&el->data[size], ptr_type);
1373 /* Semaphore address. */
1374 ret->sem_addr = extract_typed_address (&el->data[2 * size], ptr_type);
1376 ret->p.address += (ANOFFSET (objfile->section_offsets,
1377 SECT_OFF_TEXT (objfile))
1380 ret->sem_addr += (ANOFFSET (objfile->section_offsets,
1381 SECT_OFF_DATA (objfile))
1384 /* Arguments. We can only extract the argument format if there is a valid
1385 name for this probe. */
1386 probe_args = memchr (ret->p.name, '\0',
1387 (char *) el->data + el->size - ret->p.name);
1389 if (probe_args != NULL)
1392 if (probe_args == NULL || (memchr (probe_args, '\0',
1393 (char *) el->data + el->size - ret->p.name)
1394 != el->data + el->size - 1))
1396 complaint (&symfile_complaints, _("corrupt probe argument when "
1397 "reading `%s'"), objfile->name);
1398 /* If the argument string is NULL, it means some problem happened with
1399 it. So we return 0. */
1403 ret->args_parsed = 0;
1404 ret->args_u.text = (void *) probe_args;
1406 /* Successfully created probe. */
1407 VEC_safe_push (probe_p, *probesp, (struct probe *) ret);
1410 /* Helper function which tries to find the base address of the SystemTap
1411 base section named STAP_BASE_SECTION_NAME. */
1414 get_stap_base_address_1 (bfd *abfd, asection *sect, void *obj)
1416 asection **ret = obj;
1418 if ((sect->flags & (SEC_DATA | SEC_ALLOC | SEC_HAS_CONTENTS))
1419 && sect->name && !strcmp (sect->name, STAP_BASE_SECTION_NAME))
1423 /* Helper function which iterates over every section in the BFD file,
1424 trying to find the base address of the SystemTap base section.
1425 Returns 1 if found (setting BASE to the proper value), zero otherwise. */
1428 get_stap_base_address (bfd *obfd, bfd_vma *base)
1430 asection *ret = NULL;
1432 bfd_map_over_sections (obfd, get_stap_base_address_1, (void *) &ret);
1436 complaint (&symfile_complaints, _("could not obtain base address for "
1437 "SystemTap section on objfile `%s'."),
1448 /* Helper function for `elf_get_probes', which gathers information about all
1449 SystemTap probes from OBJFILE. */
1452 stap_get_probes (VEC (probe_p) **probesp, struct objfile *objfile)
1454 /* If we are here, then this is the first time we are parsing the
1455 SystemTap probe's information. We basically have to count how many
1456 probes the objfile has, and then fill in the necessary information
1458 bfd *obfd = objfile->obfd;
1460 struct sdt_note *iter;
1461 unsigned save_probesp_len = VEC_length (probe_p, *probesp);
1463 if (objfile->separate_debug_objfile_backlink != NULL)
1465 /* This is a .debug file, not the objfile itself. */
1469 if (!elf_tdata (obfd)->sdt_note_head)
1471 /* There isn't any probe here. */
1475 if (!get_stap_base_address (obfd, &base))
1477 /* There was an error finding the base address for the section.
1478 Just return NULL. */
1482 /* Parsing each probe's information. */
1483 for (iter = elf_tdata (obfd)->sdt_note_head; iter; iter = iter->next)
1485 /* We first have to handle all the information about the
1486 probe which is present in the section. */
1487 handle_stap_probe (objfile, iter, probesp, base);
1490 if (save_probesp_len == VEC_length (probe_p, *probesp))
1492 /* If we are here, it means we have failed to parse every known
1494 complaint (&symfile_complaints, _("could not parse SystemTap probe(s) "
1501 stap_relocate (struct probe *probe_generic, CORE_ADDR delta)
1503 struct stap_probe *probe = (struct stap_probe *) probe_generic;
1505 gdb_assert (probe_generic->pops == &stap_probe_ops);
1507 probe->p.address += delta;
1508 if (probe->sem_addr)
1509 probe->sem_addr += delta;
1513 stap_probe_is_linespec (const char **linespecp)
1515 static const char *const keywords[] = { "-pstap", "-probe-stap", NULL };
1517 return probe_is_linespec_by_keyword (linespecp, keywords);
1521 stap_gen_info_probes_table_header (VEC (info_probe_column_s) **heads)
1523 info_probe_column_s stap_probe_column;
1525 stap_probe_column.field_name = "semaphore";
1526 stap_probe_column.print_name = _("Semaphore");
1528 VEC_safe_push (info_probe_column_s, *heads, &stap_probe_column);
1532 stap_gen_info_probes_table_values (struct probe *probe_generic,
1533 VEC (const_char_ptr) **ret)
1535 struct stap_probe *probe = (struct stap_probe *) probe_generic;
1536 struct gdbarch *gdbarch;
1537 const char *val = NULL;
1539 gdb_assert (probe_generic->pops == &stap_probe_ops);
1541 gdbarch = get_objfile_arch (probe->p.objfile);
1543 if (probe->sem_addr)
1544 val = print_core_address (gdbarch, probe->sem_addr);
1546 VEC_safe_push (const_char_ptr, *ret, val);
1549 /* SystemTap probe_ops. */
1551 static const struct probe_ops stap_probe_ops =
1553 stap_probe_is_linespec,
1556 stap_get_probe_argument_count,
1557 stap_can_evaluate_probe_arguments,
1558 stap_evaluate_probe_argument,
1561 stap_clear_semaphore,
1563 stap_gen_info_probes_table_header,
1564 stap_gen_info_probes_table_values,
1567 /* Implementation of the `info probes stap' command. */
1570 info_probes_stap_command (char *arg, int from_tty)
1572 info_probes_for_ops (arg, from_tty, &stap_probe_ops);
1575 void _initialize_stap_probe (void);
1578 _initialize_stap_probe (void)
1580 VEC_safe_push (probe_ops_cp, all_probe_ops, &stap_probe_ops);
1582 add_setshow_zuinteger_cmd ("stap-expression", class_maintenance,
1583 &stap_expression_debug,
1584 _("Set SystemTap expression debugging."),
1585 _("Show SystemTap expression debugging."),
1586 _("When non-zero, the internal representation "
1587 "of SystemTap expressions will be printed."),
1589 show_stapexpressiondebug,
1590 &setdebuglist, &showdebuglist);
1592 create_internalvar_type_lazy ("_probe_argc", &probe_funcs,
1593 (void *) (uintptr_t) -1);
1594 create_internalvar_type_lazy ("_probe_arg0", &probe_funcs,
1595 (void *) (uintptr_t) 0);
1596 create_internalvar_type_lazy ("_probe_arg1", &probe_funcs,
1597 (void *) (uintptr_t) 1);
1598 create_internalvar_type_lazy ("_probe_arg2", &probe_funcs,
1599 (void *) (uintptr_t) 2);
1600 create_internalvar_type_lazy ("_probe_arg3", &probe_funcs,
1601 (void *) (uintptr_t) 3);
1602 create_internalvar_type_lazy ("_probe_arg4", &probe_funcs,
1603 (void *) (uintptr_t) 4);
1604 create_internalvar_type_lazy ("_probe_arg5", &probe_funcs,
1605 (void *) (uintptr_t) 5);
1606 create_internalvar_type_lazy ("_probe_arg6", &probe_funcs,
1607 (void *) (uintptr_t) 6);
1608 create_internalvar_type_lazy ("_probe_arg7", &probe_funcs,
1609 (void *) (uintptr_t) 7);
1610 create_internalvar_type_lazy ("_probe_arg8", &probe_funcs,
1611 (void *) (uintptr_t) 8);
1612 create_internalvar_type_lazy ("_probe_arg9", &probe_funcs,
1613 (void *) (uintptr_t) 9);
1614 create_internalvar_type_lazy ("_probe_arg10", &probe_funcs,
1615 (void *) (uintptr_t) 10);
1616 create_internalvar_type_lazy ("_probe_arg11", &probe_funcs,
1617 (void *) (uintptr_t) 11);
1619 add_cmd ("stap", class_info, info_probes_stap_command,
1621 Show information about SystemTap static probes.\n\
1622 Usage: info probes stap [PROVIDER [NAME [OBJECT]]]\n\
1623 Each argument is a regular expression, used to select probes.\n\
1624 PROVIDER matches probe provider names.\n\
1625 NAME matches the probe names.\n\
1626 OBJECT matches the executable or shared library name."),
1627 info_probes_cmdlist_get ());