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