Slightly improve logic of some operations on stap-probe.c
[deliverable/binutils-gdb.git] / gdb / stap-probe.c
1 /* SystemTap probe support for GDB.
2
3 Copyright (C) 2012-2019 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
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.
11
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.
16
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/>. */
19
20 #include "defs.h"
21 #include "stap-probe.h"
22 #include "probe.h"
23 #include "common/vec.h"
24 #include "ui-out.h"
25 #include "objfiles.h"
26 #include "arch-utils.h"
27 #include "command.h"
28 #include "gdbcmd.h"
29 #include "filenames.h"
30 #include "value.h"
31 #include "ax.h"
32 #include "ax-gdb.h"
33 #include "complaints.h"
34 #include "cli/cli-utils.h"
35 #include "linespec.h"
36 #include "user-regs.h"
37 #include "parser-defs.h"
38 #include "language.h"
39 #include "elf-bfd.h"
40
41 #include <ctype.h>
42
43 /* The name of the SystemTap section where we will find information about
44 the probes. */
45
46 #define STAP_BASE_SECTION_NAME ".stapsdt.base"
47
48 /* Should we display debug information for the probe's argument expression
49 parsing? */
50
51 static unsigned int stap_expression_debug = 0;
52
53 /* The various possibilities of bitness defined for a probe's argument.
54
55 The relationship is:
56
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@'. */
66
67 enum stap_arg_bitness
68 {
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,
78 };
79
80 /* The following structure represents a single argument for the probe. */
81
82 struct stap_probe_arg
83 {
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_))
88 {}
89
90 /* The bitness of this argument. */
91 enum stap_arg_bitness bitness;
92
93 /* The corresponding `struct type *' to the bitness. */
94 struct type *atype;
95
96 /* The argument converted to an internal GDB expression. */
97 expression_up aexpr;
98 };
99
100 /* Class that implements the static probe methods for "stap" probes. */
101
102 class stap_static_probe_ops : public static_probe_ops
103 {
104 public:
105 /* See probe.h. */
106 bool is_linespec (const char **linespecp) const override;
107
108 /* See probe.h. */
109 void get_probes (std::vector<std::unique_ptr<probe>> *probesp,
110 struct objfile *objfile) const override;
111
112 /* See probe.h. */
113 const char *type_name () const override;
114
115 /* See probe.h. */
116 std::vector<struct info_probe_column> gen_info_probes_table_header
117 () const override;
118 };
119
120 /* SystemTap static_probe_ops. */
121
122 const stap_static_probe_ops stap_static_probe_ops {};
123
124 class stap_probe : public probe
125 {
126 public:
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)
133 {}
134
135 /* See probe.h. */
136 CORE_ADDR get_relocated_address (struct objfile *objfile) override;
137
138 /* See probe.h. */
139 unsigned get_argument_count (struct frame_info *frame) override;
140
141 /* See probe.h. */
142 bool can_evaluate_arguments () const override;
143
144 /* See probe.h. */
145 struct value *evaluate_argument (unsigned n,
146 struct frame_info *frame) override;
147
148 /* See probe.h. */
149 void compile_to_ax (struct agent_expr *aexpr,
150 struct axs_value *axs_value,
151 unsigned n) override;
152
153 /* See probe.h. */
154 void set_semaphore (struct objfile *objfile,
155 struct gdbarch *gdbarch) override;
156
157 /* See probe.h. */
158 void clear_semaphore (struct objfile *objfile,
159 struct gdbarch *gdbarch) override;
160
161 /* See probe.h. */
162 const static_probe_ops *get_static_ops () const override;
163
164 /* See probe.h. */
165 std::vector<const char *> gen_info_probes_table_values () const override;
166
167 /* Return argument N of probe.
168
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)
174 {
175 if (!m_have_parsed_args)
176 this->parse_arguments (gdbarch);
177
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);
185
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"
190 "report this bug."),
191 this->get_name ().c_str (),
192 (int) m_parsed_args.size (), n);
193
194 return &m_parsed_args[n];
195 }
196
197 /* Function which parses an argument string from the probe,
198 correctly splitting the arguments and storing their information
199 in properly ways.
200
201 Consider the following argument string (x86 syntax):
202
203 `4@%eax 4@$10'
204
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);
209
210 private:
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;
214
215 /* True if the arguments have been parsed. */
216 bool m_have_parsed_args;
217
218 /* The text version of the probe's arguments, unparsed. */
219 const char *m_unparsed_args_text;
220
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;
225 };
226
227 /* When parsing the arguments, we have to establish different precedences
228 for the various kinds of asm operators. This enumeration represents those
229 precedences.
230
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'". */
234
235 enum stap_operand_prec
236 {
237 /* Lowest precedence, used for non-recognized operands or for the beginning
238 of the parsing process. */
239 STAP_OPERAND_PREC_NONE = 0,
240
241 /* Precedence of logical OR. */
242 STAP_OPERAND_PREC_LOGICAL_OR,
243
244 /* Precedence of logical AND. */
245 STAP_OPERAND_PREC_LOGICAL_AND,
246
247 /* Precedence of additive (plus, minus) and comparative (equal, less,
248 greater-than, etc) operands. */
249 STAP_OPERAND_PREC_ADD_CMP,
250
251 /* Precedence of bitwise operands (bitwise OR, XOR, bitwise AND,
252 logical NOT). */
253 STAP_OPERAND_PREC_BITWISE,
254
255 /* Precedence of multiplicative operands (multiplication, division,
256 remainder, left shift and right shift). */
257 STAP_OPERAND_PREC_MUL
258 };
259
260 static void stap_parse_argument_1 (struct stap_parse_info *p, bool has_lhs,
261 enum stap_operand_prec prec);
262
263 static void stap_parse_argument_conditionally (struct stap_parse_info *p);
264
265 /* Returns true if *S is an operator, false otherwise. */
266
267 static bool stap_is_operator (const char *op);
268
269 static void
270 show_stapexpressiondebug (struct ui_file *file, int from_tty,
271 struct cmd_list_element *c, const char *value)
272 {
273 fprintf_filtered (file, _("SystemTap Probe expression debugging is %s.\n"),
274 value);
275 }
276
277 /* Returns the operator precedence level of OP, or STAP_OPERAND_PREC_NONE
278 if the operator code was not recognized. */
279
280 static enum stap_operand_prec
281 stap_get_operator_prec (enum exp_opcode op)
282 {
283 switch (op)
284 {
285 case BINOP_LOGICAL_OR:
286 return STAP_OPERAND_PREC_LOGICAL_OR;
287
288 case BINOP_LOGICAL_AND:
289 return STAP_OPERAND_PREC_LOGICAL_AND;
290
291 case BINOP_ADD:
292 case BINOP_SUB:
293 case BINOP_EQUAL:
294 case BINOP_NOTEQUAL:
295 case BINOP_LESS:
296 case BINOP_LEQ:
297 case BINOP_GTR:
298 case BINOP_GEQ:
299 return STAP_OPERAND_PREC_ADD_CMP;
300
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;
306
307 case BINOP_MUL:
308 case BINOP_DIV:
309 case BINOP_REM:
310 case BINOP_LSH:
311 case BINOP_RSH:
312 return STAP_OPERAND_PREC_MUL;
313
314 default:
315 return STAP_OPERAND_PREC_NONE;
316 }
317 }
318
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
321 was found. */
322
323 static enum exp_opcode
324 stap_get_opcode (const char **s)
325 {
326 const char c = **s;
327 enum exp_opcode op;
328
329 *s += 1;
330
331 switch (c)
332 {
333 case '*':
334 op = BINOP_MUL;
335 break;
336
337 case '/':
338 op = BINOP_DIV;
339 break;
340
341 case '%':
342 op = BINOP_REM;
343 break;
344
345 case '<':
346 op = BINOP_LESS;
347 if (**s == '<')
348 {
349 *s += 1;
350 op = BINOP_LSH;
351 }
352 else if (**s == '=')
353 {
354 *s += 1;
355 op = BINOP_LEQ;
356 }
357 else if (**s == '>')
358 {
359 *s += 1;
360 op = BINOP_NOTEQUAL;
361 }
362 break;
363
364 case '>':
365 op = BINOP_GTR;
366 if (**s == '>')
367 {
368 *s += 1;
369 op = BINOP_RSH;
370 }
371 else if (**s == '=')
372 {
373 *s += 1;
374 op = BINOP_GEQ;
375 }
376 break;
377
378 case '|':
379 op = BINOP_BITWISE_IOR;
380 if (**s == '|')
381 {
382 *s += 1;
383 op = BINOP_LOGICAL_OR;
384 }
385 break;
386
387 case '&':
388 op = BINOP_BITWISE_AND;
389 if (**s == '&')
390 {
391 *s += 1;
392 op = BINOP_LOGICAL_AND;
393 }
394 break;
395
396 case '^':
397 op = BINOP_BITWISE_XOR;
398 break;
399
400 case '!':
401 op = UNOP_LOGICAL_NOT;
402 break;
403
404 case '+':
405 op = BINOP_ADD;
406 break;
407
408 case '-':
409 op = BINOP_SUB;
410 break;
411
412 case '=':
413 gdb_assert (**s == '=');
414 op = BINOP_EQUAL;
415 break;
416
417 default:
418 error (_("Invalid opcode in expression `%s' for SystemTap"
419 "probe"), *s);
420 }
421
422 return op;
423 }
424
425 /* Given the bitness of the argument, represented by B, return the
426 corresponding `struct type *', or throw an error if B is
427 unknown. */
428
429 static struct type *
430 stap_get_expected_argument_type (struct gdbarch *gdbarch,
431 enum stap_arg_bitness b,
432 const char *probe_name)
433 {
434 switch (b)
435 {
436 case STAP_ARG_BITNESS_UNDEFINED:
437 if (gdbarch_addr_bit (gdbarch) == 32)
438 return builtin_type (gdbarch)->builtin_uint32;
439 else
440 return builtin_type (gdbarch)->builtin_uint64;
441
442 case STAP_ARG_BITNESS_8BIT_UNSIGNED:
443 return builtin_type (gdbarch)->builtin_uint8;
444
445 case STAP_ARG_BITNESS_8BIT_SIGNED:
446 return builtin_type (gdbarch)->builtin_int8;
447
448 case STAP_ARG_BITNESS_16BIT_UNSIGNED:
449 return builtin_type (gdbarch)->builtin_uint16;
450
451 case STAP_ARG_BITNESS_16BIT_SIGNED:
452 return builtin_type (gdbarch)->builtin_int16;
453
454 case STAP_ARG_BITNESS_32BIT_SIGNED:
455 return builtin_type (gdbarch)->builtin_int32;
456
457 case STAP_ARG_BITNESS_32BIT_UNSIGNED:
458 return builtin_type (gdbarch)->builtin_uint32;
459
460 case STAP_ARG_BITNESS_64BIT_SIGNED:
461 return builtin_type (gdbarch)->builtin_int64;
462
463 case STAP_ARG_BITNESS_64BIT_UNSIGNED:
464 return builtin_type (gdbarch)->builtin_uint64;
465
466 default:
467 error (_("Undefined bitness for probe '%s'."), probe_name);
468 break;
469 }
470 }
471
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.
476
477 This function does a case-insensitive match.
478
479 Return true if any prefix has been found, false otherwise. */
480
481 static bool
482 stap_is_generic_prefix (struct gdbarch *gdbarch, const char *s,
483 const char **r, const char *const *prefixes)
484 {
485 const char *const *p;
486
487 if (prefixes == NULL)
488 {
489 if (r != NULL)
490 *r = "";
491
492 return true;
493 }
494
495 for (p = prefixes; *p != NULL; ++p)
496 if (strncasecmp (s, *p, strlen (*p)) == 0)
497 {
498 if (r != NULL)
499 *r = *p;
500
501 return true;
502 }
503
504 return false;
505 }
506
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. */
509
510 static bool
511 stap_is_register_prefix (struct gdbarch *gdbarch, const char *s,
512 const char **r)
513 {
514 const char *const *t = gdbarch_stap_register_prefixes (gdbarch);
515
516 return stap_is_generic_prefix (gdbarch, s, r, t);
517 }
518
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. */
522
523 static bool
524 stap_is_register_indirection_prefix (struct gdbarch *gdbarch, const char *s,
525 const char **r)
526 {
527 const char *const *t = gdbarch_stap_register_indirection_prefixes (gdbarch);
528
529 return stap_is_generic_prefix (gdbarch, s, r, t);
530 }
531
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.
534
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. */
539
540 static bool
541 stap_is_integer_prefix (struct gdbarch *gdbarch, const char *s,
542 const char **r)
543 {
544 const char *const *t = gdbarch_stap_integer_prefixes (gdbarch);
545 const char *const *p;
546
547 if (t == NULL)
548 {
549 /* A NULL value here means that integers do not have a prefix.
550 We just check for a digit then. */
551 if (r != NULL)
552 *r = "";
553
554 return isdigit (*s) > 0;
555 }
556
557 for (p = t; *p != NULL; ++p)
558 {
559 size_t len = strlen (*p);
560
561 if ((len == 0 && isdigit (*s))
562 || (len > 0 && strncasecmp (s, *p, len) == 0))
563 {
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
568 prefix. */
569 if (r != NULL)
570 *r = *p;
571
572 return true;
573 }
574 }
575
576 return false;
577 }
578
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
586 match. */
587
588 static bool
589 stap_generic_check_suffix (struct gdbarch *gdbarch, const char *s,
590 const char **r, const char *const *suffixes)
591 {
592 const char *const *p;
593 bool found = false;
594
595 if (suffixes == NULL)
596 {
597 if (r != NULL)
598 *r = "";
599
600 return true;
601 }
602
603 for (p = suffixes; *p != NULL; ++p)
604 if (strncasecmp (s, *p, strlen (*p)) == 0)
605 {
606 if (r != NULL)
607 *r = *p;
608
609 found = true;
610 break;
611 }
612
613 return found;
614 }
615
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. */
619
620 static bool
621 stap_check_integer_suffix (struct gdbarch *gdbarch, const char *s,
622 const char **r)
623 {
624 const char *const *p = gdbarch_stap_integer_suffixes (gdbarch);
625
626 return stap_generic_check_suffix (gdbarch, s, r, p);
627 }
628
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. */
632
633 static bool
634 stap_check_register_suffix (struct gdbarch *gdbarch, const char *s,
635 const char **r)
636 {
637 const char *const *p = gdbarch_stap_register_suffixes (gdbarch);
638
639 return stap_generic_check_suffix (gdbarch, s, r, p);
640 }
641
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. */
645
646 static bool
647 stap_check_register_indirection_suffix (struct gdbarch *gdbarch, const char *s,
648 const char **r)
649 {
650 const char *const *p = gdbarch_stap_register_indirection_suffixes (gdbarch);
651
652 return stap_generic_check_suffix (gdbarch, s, r, p);
653 }
654
655 /* Function responsible for parsing a register operand according to
656 SystemTap parlance. Assuming:
657
658 RP = register prefix
659 RS = register suffix
660 RIP = register indirection prefix
661 RIS = register indirection suffix
662
663 Then a register operand can be:
664
665 [RIP] [RP] REGISTER [RS] [RIS]
666
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. */
673
674 static void
675 stap_parse_register_operand (struct stap_parse_info *p)
676 {
677 /* Simple flag to indicate whether we have seen a minus signal before
678 certain number. */
679 bool got_minus = false;
680 /* Flags to indicate whether this register access is being displaced and/or
681 indirected. */
682 bool disp_p = false;
683 bool indirect_p = false;
684 struct gdbarch *gdbarch = p->gdbarch;
685 /* Needed to generate the register name as a part of an expression. */
686 struct stoken str;
687 /* Variables used to extract the register name from the probe's
688 argument. */
689 const char *start;
690 char *regname;
691 int len;
692 const char *gdb_reg_prefix = gdbarch_stap_gdb_register_prefix (gdbarch);
693 int gdb_reg_prefix_len = gdb_reg_prefix ? strlen (gdb_reg_prefix) : 0;
694 const char *gdb_reg_suffix = gdbarch_stap_gdb_register_suffix (gdbarch);
695 int gdb_reg_suffix_len = gdb_reg_suffix ? strlen (gdb_reg_suffix) : 0;
696 const char *reg_prefix;
697 const char *reg_ind_prefix;
698 const char *reg_suffix;
699 const char *reg_ind_suffix;
700
701 /* Checking for a displacement argument. */
702 if (*p->arg == '+')
703 {
704 /* If it's a plus sign, we don't need to do anything, just advance the
705 pointer. */
706 ++p->arg;
707 }
708 else if (*p->arg == '-')
709 {
710 got_minus = true;
711 ++p->arg;
712 }
713
714 if (isdigit (*p->arg))
715 {
716 /* The value of the displacement. */
717 long displacement;
718 char *endp;
719
720 disp_p = true;
721 displacement = strtol (p->arg, &endp, 10);
722 p->arg = endp;
723
724 /* Generating the expression for the displacement. */
725 write_exp_elt_opcode (&p->pstate, OP_LONG);
726 write_exp_elt_type (&p->pstate, builtin_type (gdbarch)->builtin_long);
727 write_exp_elt_longcst (&p->pstate, displacement);
728 write_exp_elt_opcode (&p->pstate, OP_LONG);
729 if (got_minus)
730 write_exp_elt_opcode (&p->pstate, UNOP_NEG);
731 }
732
733 /* Getting rid of register indirection prefix. */
734 if (stap_is_register_indirection_prefix (gdbarch, p->arg, &reg_ind_prefix))
735 {
736 indirect_p = true;
737 p->arg += strlen (reg_ind_prefix);
738 }
739
740 if (disp_p && !indirect_p)
741 error (_("Invalid register displacement syntax on expression `%s'."),
742 p->saved_arg);
743
744 /* Getting rid of register prefix. */
745 if (stap_is_register_prefix (gdbarch, p->arg, &reg_prefix))
746 p->arg += strlen (reg_prefix);
747
748 /* Now we should have only the register name. Let's extract it and get
749 the associated number. */
750 start = p->arg;
751
752 /* We assume the register name is composed by letters and numbers. */
753 while (isalnum (*p->arg))
754 ++p->arg;
755
756 len = p->arg - start;
757
758 regname = (char *) alloca (len + gdb_reg_prefix_len + gdb_reg_suffix_len + 1);
759 regname[0] = '\0';
760
761 /* We only add the GDB's register prefix/suffix if we are dealing with
762 a numeric register. */
763 if (gdb_reg_prefix && isdigit (*start))
764 {
765 strncpy (regname, gdb_reg_prefix, gdb_reg_prefix_len);
766 strncpy (regname + gdb_reg_prefix_len, start, len);
767
768 if (gdb_reg_suffix)
769 strncpy (regname + gdb_reg_prefix_len + len,
770 gdb_reg_suffix, gdb_reg_suffix_len);
771
772 len += gdb_reg_prefix_len + gdb_reg_suffix_len;
773 }
774 else
775 strncpy (regname, start, len);
776
777 regname[len] = '\0';
778
779 /* Is this a valid register name? */
780 if (user_reg_map_name_to_regnum (gdbarch, regname, len) == -1)
781 error (_("Invalid register name `%s' on expression `%s'."),
782 regname, p->saved_arg);
783
784 write_exp_elt_opcode (&p->pstate, OP_REGISTER);
785 str.ptr = regname;
786 str.length = len;
787 write_exp_string (&p->pstate, str);
788 write_exp_elt_opcode (&p->pstate, OP_REGISTER);
789
790 if (indirect_p)
791 {
792 if (disp_p)
793 write_exp_elt_opcode (&p->pstate, BINOP_ADD);
794
795 /* Casting to the expected type. */
796 write_exp_elt_opcode (&p->pstate, UNOP_CAST);
797 write_exp_elt_type (&p->pstate, lookup_pointer_type (p->arg_type));
798 write_exp_elt_opcode (&p->pstate, UNOP_CAST);
799
800 write_exp_elt_opcode (&p->pstate, UNOP_IND);
801 }
802
803 /* Getting rid of the register name suffix. */
804 if (stap_check_register_suffix (gdbarch, p->arg, &reg_suffix))
805 p->arg += strlen (reg_suffix);
806 else
807 error (_("Missing register name suffix on expression `%s'."),
808 p->saved_arg);
809
810 /* Getting rid of the register indirection suffix. */
811 if (indirect_p)
812 {
813 if (stap_check_register_indirection_suffix (gdbarch, p->arg,
814 &reg_ind_suffix))
815 p->arg += strlen (reg_ind_suffix);
816 else
817 error (_("Missing indirection suffix on expression `%s'."),
818 p->saved_arg);
819 }
820 }
821
822 /* This function is responsible for parsing a single operand.
823
824 A single operand can be:
825
826 - an unary operation (e.g., `-5', `~2', or even with subexpressions
827 like `-(2 + 1)')
828 - a register displacement, which will be treated as a register
829 operand (e.g., `-4(%eax)' on x86)
830 - a numeric constant, or
831 - a register operand (see function `stap_parse_register_operand')
832
833 The function also calls special-handling functions to deal with
834 unrecognized operands, allowing arch-specific parsers to be
835 created. */
836
837 static void
838 stap_parse_single_operand (struct stap_parse_info *p)
839 {
840 struct gdbarch *gdbarch = p->gdbarch;
841 const char *int_prefix = NULL;
842
843 /* We first try to parse this token as a "special token". */
844 if (gdbarch_stap_parse_special_token_p (gdbarch)
845 && (gdbarch_stap_parse_special_token (gdbarch, p) != 0))
846 {
847 /* If the return value of the above function is not zero,
848 it means it successfully parsed the special token.
849
850 If it is NULL, we try to parse it using our method. */
851 return;
852 }
853
854 if (*p->arg == '-' || *p->arg == '~' || *p->arg == '+')
855 {
856 char c = *p->arg;
857 /* We use this variable to do a lookahead. */
858 const char *tmp = p->arg;
859 bool has_digit = false;
860
861 /* Skipping signal. */
862 ++tmp;
863
864 /* This is an unary operation. Here is a list of allowed tokens
865 here:
866
867 - numeric literal;
868 - number (from register displacement)
869 - subexpression (beginning with `(')
870
871 We handle the register displacement here, and the other cases
872 recursively. */
873 if (p->inside_paren_p)
874 tmp = skip_spaces (tmp);
875
876 while (isdigit (*tmp))
877 {
878 /* We skip the digit here because we are only interested in
879 knowing what kind of unary operation this is. The digit
880 will be handled by one of the functions that will be
881 called below ('stap_parse_argument_conditionally' or
882 'stap_parse_register_operand'). */
883 ++tmp;
884 has_digit = true;
885 }
886
887 if (has_digit && stap_is_register_indirection_prefix (gdbarch, tmp,
888 NULL))
889 {
890 /* If we are here, it means it is a displacement. The only
891 operations allowed here are `-' and `+'. */
892 if (c != '-' && c != '+')
893 error (_("Invalid operator `%c' for register displacement "
894 "on expression `%s'."), c, p->saved_arg);
895
896 stap_parse_register_operand (p);
897 }
898 else
899 {
900 /* This is not a displacement. We skip the operator, and
901 deal with it when the recursion returns. */
902 ++p->arg;
903 stap_parse_argument_conditionally (p);
904 if (c == '-')
905 write_exp_elt_opcode (&p->pstate, UNOP_NEG);
906 else if (c == '~')
907 write_exp_elt_opcode (&p->pstate, UNOP_COMPLEMENT);
908 }
909 }
910 else if (isdigit (*p->arg))
911 {
912 /* A temporary variable, needed for lookahead. */
913 const char *tmp = p->arg;
914 char *endp;
915 long number;
916
917 /* We can be dealing with a numeric constant, or with a register
918 displacement. */
919 number = strtol (tmp, &endp, 10);
920 tmp = endp;
921
922 if (p->inside_paren_p)
923 tmp = skip_spaces (tmp);
924
925 /* If "stap_is_integer_prefix" returns true, it means we can
926 accept integers without a prefix here. But we also need to
927 check whether the next token (i.e., "tmp") is not a register
928 indirection prefix. */
929 if (stap_is_integer_prefix (gdbarch, p->arg, NULL)
930 && !stap_is_register_indirection_prefix (gdbarch, tmp, NULL))
931 {
932 const char *int_suffix;
933
934 /* We are dealing with a numeric constant. */
935 write_exp_elt_opcode (&p->pstate, OP_LONG);
936 write_exp_elt_type (&p->pstate,
937 builtin_type (gdbarch)->builtin_long);
938 write_exp_elt_longcst (&p->pstate, number);
939 write_exp_elt_opcode (&p->pstate, OP_LONG);
940
941 p->arg = tmp;
942
943 if (stap_check_integer_suffix (gdbarch, p->arg, &int_suffix))
944 p->arg += strlen (int_suffix);
945 else
946 error (_("Invalid constant suffix on expression `%s'."),
947 p->saved_arg);
948 }
949 else if (stap_is_register_indirection_prefix (gdbarch, tmp, NULL))
950 stap_parse_register_operand (p);
951 else
952 error (_("Unknown numeric token on expression `%s'."),
953 p->saved_arg);
954 }
955 else if (stap_is_integer_prefix (gdbarch, p->arg, &int_prefix))
956 {
957 /* We are dealing with a numeric constant. */
958 long number;
959 char *endp;
960 const char *int_suffix;
961
962 p->arg += strlen (int_prefix);
963 number = strtol (p->arg, &endp, 10);
964 p->arg = endp;
965
966 write_exp_elt_opcode (&p->pstate, OP_LONG);
967 write_exp_elt_type (&p->pstate, builtin_type (gdbarch)->builtin_long);
968 write_exp_elt_longcst (&p->pstate, number);
969 write_exp_elt_opcode (&p->pstate, OP_LONG);
970
971 if (stap_check_integer_suffix (gdbarch, p->arg, &int_suffix))
972 p->arg += strlen (int_suffix);
973 else
974 error (_("Invalid constant suffix on expression `%s'."),
975 p->saved_arg);
976 }
977 else if (stap_is_register_prefix (gdbarch, p->arg, NULL)
978 || stap_is_register_indirection_prefix (gdbarch, p->arg, NULL))
979 stap_parse_register_operand (p);
980 else
981 error (_("Operator `%c' not recognized on expression `%s'."),
982 *p->arg, p->saved_arg);
983 }
984
985 /* This function parses an argument conditionally, based on single or
986 non-single operands. A non-single operand would be a parenthesized
987 expression (e.g., `(2 + 1)'), and a single operand is anything that
988 starts with `-', `~', `+' (i.e., unary operators), a digit, or
989 something recognized by `gdbarch_stap_is_single_operand'. */
990
991 static void
992 stap_parse_argument_conditionally (struct stap_parse_info *p)
993 {
994 gdb_assert (gdbarch_stap_is_single_operand_p (p->gdbarch));
995
996 if (*p->arg == '-' || *p->arg == '~' || *p->arg == '+' /* Unary. */
997 || isdigit (*p->arg)
998 || gdbarch_stap_is_single_operand (p->gdbarch, p->arg))
999 stap_parse_single_operand (p);
1000 else if (*p->arg == '(')
1001 {
1002 /* We are dealing with a parenthesized operand. It means we
1003 have to parse it as it was a separate expression, without
1004 left-side or precedence. */
1005 ++p->arg;
1006 p->arg = skip_spaces (p->arg);
1007 ++p->inside_paren_p;
1008
1009 stap_parse_argument_1 (p, 0, STAP_OPERAND_PREC_NONE);
1010
1011 --p->inside_paren_p;
1012 if (*p->arg != ')')
1013 error (_("Missign close-paren on expression `%s'."),
1014 p->saved_arg);
1015
1016 ++p->arg;
1017 if (p->inside_paren_p)
1018 p->arg = skip_spaces (p->arg);
1019 }
1020 else
1021 error (_("Cannot parse expression `%s'."), p->saved_arg);
1022 }
1023
1024 /* Helper function for `stap_parse_argument'. Please, see its comments to
1025 better understand what this function does. */
1026
1027 static void
1028 stap_parse_argument_1 (struct stap_parse_info *p, bool has_lhs,
1029 enum stap_operand_prec prec)
1030 {
1031 /* This is an operator-precedence parser.
1032
1033 We work with left- and right-sides of expressions, and
1034 parse them depending on the precedence of the operators
1035 we find. */
1036
1037 gdb_assert (p->arg != NULL);
1038
1039 if (p->inside_paren_p)
1040 p->arg = skip_spaces (p->arg);
1041
1042 if (!has_lhs)
1043 {
1044 /* We were called without a left-side, either because this is the
1045 first call, or because we were called to parse a parenthesized
1046 expression. It doesn't really matter; we have to parse the
1047 left-side in order to continue the process. */
1048 stap_parse_argument_conditionally (p);
1049 }
1050
1051 /* Start to parse the right-side, and to "join" left and right sides
1052 depending on the operation specified.
1053
1054 This loop shall continue until we run out of characters in the input,
1055 or until we find a close-parenthesis, which means that we've reached
1056 the end of a sub-expression. */
1057 while (*p->arg != '\0' && *p->arg != ')' && !isspace (*p->arg))
1058 {
1059 const char *tmp_exp_buf;
1060 enum exp_opcode opcode;
1061 enum stap_operand_prec cur_prec;
1062
1063 if (!stap_is_operator (p->arg))
1064 error (_("Invalid operator `%c' on expression `%s'."), *p->arg,
1065 p->saved_arg);
1066
1067 /* We have to save the current value of the expression buffer because
1068 the `stap_get_opcode' modifies it in order to get the current
1069 operator. If this operator's precedence is lower than PREC, we
1070 should return and not advance the expression buffer pointer. */
1071 tmp_exp_buf = p->arg;
1072 opcode = stap_get_opcode (&tmp_exp_buf);
1073
1074 cur_prec = stap_get_operator_prec (opcode);
1075 if (cur_prec < prec)
1076 {
1077 /* If the precedence of the operator that we are seeing now is
1078 lower than the precedence of the first operator seen before
1079 this parsing process began, it means we should stop parsing
1080 and return. */
1081 break;
1082 }
1083
1084 p->arg = tmp_exp_buf;
1085 if (p->inside_paren_p)
1086 p->arg = skip_spaces (p->arg);
1087
1088 /* Parse the right-side of the expression. */
1089 stap_parse_argument_conditionally (p);
1090
1091 /* While we still have operators, try to parse another
1092 right-side, but using the current right-side as a left-side. */
1093 while (*p->arg != '\0' && stap_is_operator (p->arg))
1094 {
1095 enum exp_opcode lookahead_opcode;
1096 enum stap_operand_prec lookahead_prec;
1097
1098 /* Saving the current expression buffer position. The explanation
1099 is the same as above. */
1100 tmp_exp_buf = p->arg;
1101 lookahead_opcode = stap_get_opcode (&tmp_exp_buf);
1102 lookahead_prec = stap_get_operator_prec (lookahead_opcode);
1103
1104 if (lookahead_prec <= prec)
1105 {
1106 /* If we are dealing with an operator whose precedence is lower
1107 than the first one, just abandon the attempt. */
1108 break;
1109 }
1110
1111 /* Parse the right-side of the expression, but since we already
1112 have a left-side at this point, set `has_lhs' to 1. */
1113 stap_parse_argument_1 (p, 1, lookahead_prec);
1114 }
1115
1116 write_exp_elt_opcode (&p->pstate, opcode);
1117 }
1118 }
1119
1120 /* Parse a probe's argument.
1121
1122 Assuming that:
1123
1124 LP = literal integer prefix
1125 LS = literal integer suffix
1126
1127 RP = register prefix
1128 RS = register suffix
1129
1130 RIP = register indirection prefix
1131 RIS = register indirection suffix
1132
1133 This routine assumes that arguments' tokens are of the form:
1134
1135 - [LP] NUMBER [LS]
1136 - [RP] REGISTER [RS]
1137 - [RIP] [RP] REGISTER [RS] [RIS]
1138 - If we find a number without LP, we try to parse it as a literal integer
1139 constant (if LP == NULL), or as a register displacement.
1140 - We count parenthesis, and only skip whitespaces if we are inside them.
1141 - If we find an operator, we skip it.
1142
1143 This function can also call a special function that will try to match
1144 unknown tokens. It will return the expression_up generated from
1145 parsing the argument. */
1146
1147 static expression_up
1148 stap_parse_argument (const char **arg, struct type *atype,
1149 struct gdbarch *gdbarch)
1150 {
1151 /* We need to initialize the expression buffer, in order to begin
1152 our parsing efforts. We use language_c here because we may need
1153 to do pointer arithmetics. */
1154 struct stap_parse_info p (*arg, atype, language_def (language_c),
1155 gdbarch);
1156
1157 stap_parse_argument_1 (&p, 0, STAP_OPERAND_PREC_NONE);
1158
1159 gdb_assert (p.inside_paren_p == 0);
1160
1161 /* Casting the final expression to the appropriate type. */
1162 write_exp_elt_opcode (&p.pstate, UNOP_CAST);
1163 write_exp_elt_type (&p.pstate, atype);
1164 write_exp_elt_opcode (&p.pstate, UNOP_CAST);
1165
1166 p.arg = skip_spaces (p.arg);
1167 *arg = p.arg;
1168
1169 return p.pstate.release ();
1170 }
1171
1172 /* Implementation of 'parse_arguments' method. */
1173
1174 void
1175 stap_probe::parse_arguments (struct gdbarch *gdbarch)
1176 {
1177 const char *cur;
1178
1179 gdb_assert (!m_have_parsed_args);
1180 cur = m_unparsed_args_text;
1181 m_have_parsed_args = true;
1182
1183 if (cur == NULL || *cur == '\0' || *cur == ':')
1184 return;
1185
1186 while (*cur != '\0')
1187 {
1188 enum stap_arg_bitness bitness;
1189 bool got_minus = false;
1190
1191 /* We expect to find something like:
1192
1193 N@OP
1194
1195 Where `N' can be [+,-][1,2,4,8]. This is not mandatory, so
1196 we check it here. If we don't find it, go to the next
1197 state. */
1198 if ((cur[0] == '-' && isdigit (cur[1]) && cur[2] == '@')
1199 || (isdigit (cur[0]) && cur[1] == '@'))
1200 {
1201 if (*cur == '-')
1202 {
1203 /* Discard the `-'. */
1204 ++cur;
1205 got_minus = true;
1206 }
1207
1208 /* Defining the bitness. */
1209 switch (*cur)
1210 {
1211 case '1':
1212 bitness = (got_minus ? STAP_ARG_BITNESS_8BIT_SIGNED
1213 : STAP_ARG_BITNESS_8BIT_UNSIGNED);
1214 break;
1215
1216 case '2':
1217 bitness = (got_minus ? STAP_ARG_BITNESS_16BIT_SIGNED
1218 : STAP_ARG_BITNESS_16BIT_UNSIGNED);
1219 break;
1220
1221 case '4':
1222 bitness = (got_minus ? STAP_ARG_BITNESS_32BIT_SIGNED
1223 : STAP_ARG_BITNESS_32BIT_UNSIGNED);
1224 break;
1225
1226 case '8':
1227 bitness = (got_minus ? STAP_ARG_BITNESS_64BIT_SIGNED
1228 : STAP_ARG_BITNESS_64BIT_UNSIGNED);
1229 break;
1230
1231 default:
1232 {
1233 /* We have an error, because we don't expect anything
1234 except 1, 2, 4 and 8. */
1235 warning (_("unrecognized bitness %s%c' for probe `%s'"),
1236 got_minus ? "`-" : "`", *cur,
1237 this->get_name ().c_str ());
1238 return;
1239 }
1240 }
1241 /* Discard the number and the `@' sign. */
1242 cur += 2;
1243 }
1244 else
1245 bitness = STAP_ARG_BITNESS_UNDEFINED;
1246
1247 struct type *atype
1248 = stap_get_expected_argument_type (gdbarch, bitness,
1249 this->get_name ().c_str ());
1250
1251 expression_up expr = stap_parse_argument (&cur, atype, gdbarch);
1252
1253 if (stap_expression_debug)
1254 dump_raw_expression (expr.get (), gdb_stdlog,
1255 "before conversion to prefix form");
1256
1257 prefixify_expression (expr.get ());
1258
1259 if (stap_expression_debug)
1260 dump_prefix_expression (expr.get (), gdb_stdlog);
1261
1262 m_parsed_args.emplace_back (bitness, atype, std::move (expr));
1263
1264 /* Start it over again. */
1265 cur = skip_spaces (cur);
1266 }
1267 }
1268
1269 /* Helper function to relocate an address. */
1270
1271 static CORE_ADDR
1272 relocate_address (CORE_ADDR address, struct objfile *objfile)
1273 {
1274 return address + ANOFFSET (objfile->section_offsets,
1275 SECT_OFF_DATA (objfile));
1276 }
1277
1278 /* Implementation of the get_relocated_address method. */
1279
1280 CORE_ADDR
1281 stap_probe::get_relocated_address (struct objfile *objfile)
1282 {
1283 return relocate_address (this->get_address (), objfile);
1284 }
1285
1286 /* Given PROBE, returns the number of arguments present in that probe's
1287 argument string. */
1288
1289 unsigned
1290 stap_probe::get_argument_count (struct frame_info *frame)
1291 {
1292 struct gdbarch *gdbarch = get_frame_arch (frame);
1293
1294 if (!m_have_parsed_args)
1295 {
1296 if (this->can_evaluate_arguments ())
1297 this->parse_arguments (gdbarch);
1298 else
1299 {
1300 static bool have_warned_stap_incomplete = false;
1301
1302 if (!have_warned_stap_incomplete)
1303 {
1304 warning (_(
1305 "The SystemTap SDT probe support is not fully implemented on this target;\n"
1306 "you will not be able to inspect the arguments of the probes.\n"
1307 "Please report a bug against GDB requesting a port to this target."));
1308 have_warned_stap_incomplete = true;
1309 }
1310
1311 /* Marking the arguments as "already parsed". */
1312 m_have_parsed_args = true;
1313 }
1314 }
1315
1316 gdb_assert (m_have_parsed_args);
1317 return m_parsed_args.size ();
1318 }
1319
1320 /* Return true if OP is a valid operator inside a probe argument, or
1321 false otherwise. */
1322
1323 static bool
1324 stap_is_operator (const char *op)
1325 {
1326 bool ret = true;
1327
1328 switch (*op)
1329 {
1330 case '*':
1331 case '/':
1332 case '%':
1333 case '^':
1334 case '!':
1335 case '+':
1336 case '-':
1337 case '<':
1338 case '>':
1339 case '|':
1340 case '&':
1341 break;
1342
1343 case '=':
1344 if (op[1] != '=')
1345 ret = false;
1346 break;
1347
1348 default:
1349 /* We didn't find any operator. */
1350 ret = false;
1351 }
1352
1353 return ret;
1354 }
1355
1356 /* Implement the `can_evaluate_arguments' method. */
1357
1358 bool
1359 stap_probe::can_evaluate_arguments () const
1360 {
1361 struct gdbarch *gdbarch = this->get_gdbarch ();
1362
1363 /* For SystemTap probes, we have to guarantee that the method
1364 stap_is_single_operand is defined on gdbarch. If it is not, then it
1365 means that argument evaluation is not implemented on this target. */
1366 return gdbarch_stap_is_single_operand_p (gdbarch);
1367 }
1368
1369 /* Evaluate the probe's argument N (indexed from 0), returning a value
1370 corresponding to it. Assertion is thrown if N does not exist. */
1371
1372 struct value *
1373 stap_probe::evaluate_argument (unsigned n, struct frame_info *frame)
1374 {
1375 struct stap_probe_arg *arg;
1376 int pos = 0;
1377 struct gdbarch *gdbarch = get_frame_arch (frame);
1378
1379 arg = this->get_arg_by_number (n, gdbarch);
1380 return evaluate_subexp_standard (arg->atype, arg->aexpr.get (), &pos,
1381 EVAL_NORMAL);
1382 }
1383
1384 /* Compile the probe's argument N (indexed from 0) to agent expression.
1385 Assertion is thrown if N does not exist. */
1386
1387 void
1388 stap_probe::compile_to_ax (struct agent_expr *expr, struct axs_value *value,
1389 unsigned n)
1390 {
1391 struct stap_probe_arg *arg;
1392 union exp_element *pc;
1393
1394 arg = this->get_arg_by_number (n, expr->gdbarch);
1395
1396 pc = arg->aexpr->elts;
1397 gen_expr (arg->aexpr.get (), &pc, expr, value);
1398
1399 require_rvalue (expr, value);
1400 value->type = arg->atype;
1401 }
1402 \f
1403
1404 /* Set or clear a SystemTap semaphore. ADDRESS is the semaphore's
1405 address. SET is zero if the semaphore should be cleared, or one if
1406 it should be set. This is a helper function for
1407 'stap_probe::set_semaphore' and 'stap_probe::clear_semaphore'. */
1408
1409 static void
1410 stap_modify_semaphore (CORE_ADDR address, int set, struct gdbarch *gdbarch)
1411 {
1412 gdb_byte bytes[sizeof (LONGEST)];
1413 /* The ABI specifies "unsigned short". */
1414 struct type *type = builtin_type (gdbarch)->builtin_unsigned_short;
1415 ULONGEST value;
1416
1417 if (address == 0)
1418 return;
1419
1420 /* Swallow errors. */
1421 if (target_read_memory (address, bytes, TYPE_LENGTH (type)) != 0)
1422 {
1423 warning (_("Could not read the value of a SystemTap semaphore."));
1424 return;
1425 }
1426
1427 value = extract_unsigned_integer (bytes, TYPE_LENGTH (type),
1428 gdbarch_byte_order (gdbarch));
1429 /* Note that we explicitly don't worry about overflow or
1430 underflow. */
1431 if (set)
1432 ++value;
1433 else
1434 --value;
1435
1436 store_unsigned_integer (bytes, TYPE_LENGTH (type),
1437 gdbarch_byte_order (gdbarch), value);
1438
1439 if (target_write_memory (address, bytes, TYPE_LENGTH (type)) != 0)
1440 warning (_("Could not write the value of a SystemTap semaphore."));
1441 }
1442
1443 /* Implementation of the 'set_semaphore' method.
1444
1445 SystemTap semaphores act as reference counters, so calls to this
1446 function must be paired with calls to 'clear_semaphore'.
1447
1448 This function and 'clear_semaphore' race with another tool
1449 changing the probes, but that is too rare to care. */
1450
1451 void
1452 stap_probe::set_semaphore (struct objfile *objfile, struct gdbarch *gdbarch)
1453 {
1454 stap_modify_semaphore (relocate_address (m_sem_addr, objfile), 1, gdbarch);
1455 }
1456
1457 /* Implementation of the 'clear_semaphore' method. */
1458
1459 void
1460 stap_probe::clear_semaphore (struct objfile *objfile, struct gdbarch *gdbarch)
1461 {
1462 stap_modify_semaphore (relocate_address (m_sem_addr, objfile), 0, gdbarch);
1463 }
1464
1465 /* Implementation of the 'get_static_ops' method. */
1466
1467 const static_probe_ops *
1468 stap_probe::get_static_ops () const
1469 {
1470 return &stap_static_probe_ops;
1471 }
1472
1473 /* Implementation of the 'gen_info_probes_table_values' method. */
1474
1475 std::vector<const char *>
1476 stap_probe::gen_info_probes_table_values () const
1477 {
1478 const char *val = NULL;
1479
1480 if (m_sem_addr != 0)
1481 val = print_core_address (this->get_gdbarch (), m_sem_addr);
1482
1483 return std::vector<const char *> { val };
1484 }
1485
1486 /* Helper function that parses the information contained in a
1487 SystemTap's probe. Basically, the information consists in:
1488
1489 - Probe's PC address;
1490 - Link-time section address of `.stapsdt.base' section;
1491 - Link-time address of the semaphore variable, or ZERO if the
1492 probe doesn't have an associated semaphore;
1493 - Probe's provider name;
1494 - Probe's name;
1495 - Probe's argument format. */
1496
1497 static void
1498 handle_stap_probe (struct objfile *objfile, struct sdt_note *el,
1499 std::vector<std::unique_ptr<probe>> *probesp,
1500 CORE_ADDR base)
1501 {
1502 bfd *abfd = objfile->obfd;
1503 int size = bfd_get_arch_size (abfd) / 8;
1504 struct gdbarch *gdbarch = get_objfile_arch (objfile);
1505 struct type *ptr_type = builtin_type (gdbarch)->builtin_data_ptr;
1506
1507 /* Provider and the name of the probe. */
1508 const char *provider = (const char *) &el->data[3 * size];
1509 const char *name = ((const char *)
1510 memchr (provider, '\0',
1511 (char *) el->data + el->size - provider));
1512 /* Making sure there is a name. */
1513 if (name == NULL)
1514 {
1515 complaint (_("corrupt probe name when "
1516 "reading `%s'"),
1517 objfile_name (objfile));
1518
1519 /* There is no way to use a probe without a name or a provider, so
1520 returning zero here makes sense. */
1521 return;
1522 }
1523 else
1524 ++name;
1525
1526 /* Retrieving the probe's address. */
1527 CORE_ADDR address = extract_typed_address (&el->data[0], ptr_type);
1528
1529 /* Link-time sh_addr of `.stapsdt.base' section. */
1530 CORE_ADDR base_ref = extract_typed_address (&el->data[size], ptr_type);
1531
1532 /* Semaphore address. */
1533 CORE_ADDR sem_addr = extract_typed_address (&el->data[2 * size], ptr_type);
1534
1535 address += base - base_ref;
1536 if (sem_addr != 0)
1537 sem_addr += base - base_ref;
1538
1539 /* Arguments. We can only extract the argument format if there is a valid
1540 name for this probe. */
1541 const char *probe_args = ((const char*)
1542 memchr (name, '\0',
1543 (char *) el->data + el->size - name));
1544
1545 if (probe_args != NULL)
1546 ++probe_args;
1547
1548 if (probe_args == NULL
1549 || (memchr (probe_args, '\0', (char *) el->data + el->size - name)
1550 != el->data + el->size - 1))
1551 {
1552 complaint (_("corrupt probe argument when "
1553 "reading `%s'"),
1554 objfile_name (objfile));
1555 /* If the argument string is NULL, it means some problem happened with
1556 it. So we return 0. */
1557 return;
1558 }
1559
1560 stap_probe *ret = new stap_probe (std::string (name), std::string (provider),
1561 address, gdbarch, sem_addr, probe_args);
1562
1563 /* Successfully created probe. */
1564 probesp->emplace_back (ret);
1565 }
1566
1567 /* Helper function which tries to find the base address of the SystemTap
1568 base section named STAP_BASE_SECTION_NAME. */
1569
1570 static void
1571 get_stap_base_address_1 (bfd *abfd, asection *sect, void *obj)
1572 {
1573 asection **ret = (asection **) obj;
1574
1575 if ((sect->flags & (SEC_DATA | SEC_ALLOC | SEC_HAS_CONTENTS))
1576 && sect->name && !strcmp (sect->name, STAP_BASE_SECTION_NAME))
1577 *ret = sect;
1578 }
1579
1580 /* Helper function which iterates over every section in the BFD file,
1581 trying to find the base address of the SystemTap base section.
1582 Returns 1 if found (setting BASE to the proper value), zero otherwise. */
1583
1584 static int
1585 get_stap_base_address (bfd *obfd, bfd_vma *base)
1586 {
1587 asection *ret = NULL;
1588
1589 bfd_map_over_sections (obfd, get_stap_base_address_1, (void *) &ret);
1590
1591 if (ret == NULL)
1592 {
1593 complaint (_("could not obtain base address for "
1594 "SystemTap section on objfile `%s'."),
1595 obfd->filename);
1596 return 0;
1597 }
1598
1599 if (base != NULL)
1600 *base = ret->vma;
1601
1602 return 1;
1603 }
1604
1605 /* Implementation of the 'is_linespec' method. */
1606
1607 bool
1608 stap_static_probe_ops::is_linespec (const char **linespecp) const
1609 {
1610 static const char *const keywords[] = { "-pstap", "-probe-stap", NULL };
1611
1612 return probe_is_linespec_by_keyword (linespecp, keywords);
1613 }
1614
1615 /* Implementation of the 'get_probes' method. */
1616
1617 void
1618 stap_static_probe_ops::get_probes
1619 (std::vector<std::unique_ptr<probe>> *probesp,
1620 struct objfile *objfile) const
1621 {
1622 /* If we are here, then this is the first time we are parsing the
1623 SystemTap probe's information. We basically have to count how many
1624 probes the objfile has, and then fill in the necessary information
1625 for each one. */
1626 bfd *obfd = objfile->obfd;
1627 bfd_vma base;
1628 struct sdt_note *iter;
1629 unsigned save_probesp_len = probesp->size ();
1630
1631 if (objfile->separate_debug_objfile_backlink != NULL)
1632 {
1633 /* This is a .debug file, not the objfile itself. */
1634 return;
1635 }
1636
1637 if (elf_tdata (obfd)->sdt_note_head == NULL)
1638 {
1639 /* There isn't any probe here. */
1640 return;
1641 }
1642
1643 if (!get_stap_base_address (obfd, &base))
1644 {
1645 /* There was an error finding the base address for the section.
1646 Just return NULL. */
1647 return;
1648 }
1649
1650 /* Parsing each probe's information. */
1651 for (iter = elf_tdata (obfd)->sdt_note_head;
1652 iter != NULL;
1653 iter = iter->next)
1654 {
1655 /* We first have to handle all the information about the
1656 probe which is present in the section. */
1657 handle_stap_probe (objfile, iter, probesp, base);
1658 }
1659
1660 if (save_probesp_len == probesp->size ())
1661 {
1662 /* If we are here, it means we have failed to parse every known
1663 probe. */
1664 complaint (_("could not parse SystemTap probe(s) "
1665 "from inferior"));
1666 return;
1667 }
1668 }
1669
1670 /* Implementation of the type_name method. */
1671
1672 const char *
1673 stap_static_probe_ops::type_name () const
1674 {
1675 return "stap";
1676 }
1677
1678 /* Implementation of the 'gen_info_probes_table_header' method. */
1679
1680 std::vector<struct info_probe_column>
1681 stap_static_probe_ops::gen_info_probes_table_header () const
1682 {
1683 struct info_probe_column stap_probe_column;
1684
1685 stap_probe_column.field_name = "semaphore";
1686 stap_probe_column.print_name = _("Semaphore");
1687
1688 return std::vector<struct info_probe_column> { stap_probe_column };
1689 }
1690
1691 /* Implementation of the `info probes stap' command. */
1692
1693 static void
1694 info_probes_stap_command (const char *arg, int from_tty)
1695 {
1696 info_probes_for_spops (arg, from_tty, &stap_static_probe_ops);
1697 }
1698
1699 void
1700 _initialize_stap_probe (void)
1701 {
1702 all_static_probe_ops.push_back (&stap_static_probe_ops);
1703
1704 add_setshow_zuinteger_cmd ("stap-expression", class_maintenance,
1705 &stap_expression_debug,
1706 _("Set SystemTap expression debugging."),
1707 _("Show SystemTap expression debugging."),
1708 _("When non-zero, the internal representation "
1709 "of SystemTap expressions will be printed."),
1710 NULL,
1711 show_stapexpressiondebug,
1712 &setdebuglist, &showdebuglist);
1713
1714 add_cmd ("stap", class_info, info_probes_stap_command,
1715 _("\
1716 Show information about SystemTap static probes.\n\
1717 Usage: info probes stap [PROVIDER [NAME [OBJECT]]]\n\
1718 Each argument is a regular expression, used to select probes.\n\
1719 PROVIDER matches probe provider names.\n\
1720 NAME matches the probe names.\n\
1721 OBJECT matches the executable or shared library name."),
1722 info_probes_cmdlist_get ());
1723
1724 }
This page took 0.091969 seconds and 5 git commands to generate.