gdb/location.c

   1 /* Data structures and API for event locations in GDB.
   2    Copyright (C) 2013-2016 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #include "defs.h"
  20 #include "gdb_assert.h"
  21 #include "location.h"
  22 #include "symtab.h"
  23 #include "language.h"
  24 #include "linespec.h"
  25 #include "cli/cli-utils.h"
  26 #include "probe.h"
  27
  28 #include <ctype.h>
  29 #include <string.h>
  30
  31 /* An event location used to set a stop event in the inferior.
  32    This structure is an amalgam of the various ways
  33    to specify where a stop event should be set.  */
  34
  35 struct event_location
  36 {
  37   /* The type of this breakpoint specification.  */
  38   enum event_location_type type;
  39 #define EL_TYPE(P) (P)->type
  40
  41   union
  42   {
  43     /* A generic "this is a string specification" for a location.
  44        This representation is used by both "normal" linespecs and
  45        probes.  */
  46     char *addr_string;
  47 #define EL_LINESPEC(P) ((P)->u.addr_string)
  48 #define EL_PROBE(P) ((P)->u.addr_string)
  49
  50     /* An address in the inferior.  */
  51     CORE_ADDR address;
  52 #define EL_ADDRESS(P) (P)->u.address
  53
  54     /* An explicit location.  */
  55     struct explicit_location explicit_loc;
  56 #define EL_EXPLICIT(P) (&((P)->u.explicit_loc))
  57   } u;
  58
  59   /* Cached string representation of this location.  This is used, e.g., to
  60      save stop event locations to file.  Malloc'd.  */
  61   char *as_string;
  62 #define EL_STRING(P) ((P)->as_string)
  63 };
  64
  65 /* See description in location.h.  */
  66
  67 enum event_location_type
  68 event_location_type (const struct event_location *location)
  69 {
  70   return EL_TYPE (location);
  71 }
  72
  73 /* See description in location.h.  */
  74
  75 void
  76 initialize_explicit_location (struct explicit_location *explicit_loc)
  77 {
  78   memset (explicit_loc, 0, sizeof (struct explicit_location));
  79   explicit_loc->line_offset.sign = LINE_OFFSET_UNKNOWN;
  80 }
  81
  82 /* See description in location.h.  */
  83
  84 struct event_location *
  85 new_linespec_location (char **linespec)
  86 {
  87   struct event_location *location;
  88
  89   location = XCNEW (struct event_location);
  90   EL_TYPE (location) = LINESPEC_LOCATION;
  91   if (*linespec != NULL)
  92     {
  93       char *p;
  94       char *orig = *linespec;
  95
  96       linespec_lex_to_end (linespec);
  97       p = remove_trailing_whitespace (orig, *linespec);
  98       if ((p - orig) > 0)
  99         EL_LINESPEC (location) = savestring (orig, p - orig);
 100     }
 101   return location;
 102 }
 103
 104 /* See description in location.h.  */
 105
 106 const char *
 107 get_linespec_location (const struct event_location *location)
 108 {
 109   gdb_assert (EL_TYPE (location) == LINESPEC_LOCATION);
 110   return EL_LINESPEC (location);
 111 }
 112
 113 /* See description in location.h.  */
 114
 115 struct event_location *
 116 new_address_location (CORE_ADDR addr, const char *addr_string,
 117                       int addr_string_len)
 118 {
 119   struct event_location *location;
 120
 121   location = XCNEW (struct event_location);
 122   EL_TYPE (location) = ADDRESS_LOCATION;
 123   EL_ADDRESS (location) = addr;
 124   if (addr_string != NULL)
 125     EL_STRING (location) = xstrndup (addr_string, addr_string_len);
 126   return location;
 127 }
 128
 129 /* See description in location.h.  */
 130
 131 CORE_ADDR
 132 get_address_location (const struct event_location *location)
 133 {
 134   gdb_assert (EL_TYPE (location) == ADDRESS_LOCATION);
 135   return EL_ADDRESS (location);
 136 }
 137
 138 /* See description in location.h.  */
 139
 140 const char *
 141 get_address_string_location (const struct event_location *location)
 142 {
 143   gdb_assert (EL_TYPE (location) == ADDRESS_LOCATION);
 144   return EL_STRING (location);
 145 }
 146
 147 /* See description in location.h.  */
 148
 149 struct event_location *
 150 new_probe_location (const char *probe)
 151 {
 152   struct event_location *location;
 153
 154   location = XCNEW (struct event_location);
 155   EL_TYPE (location) = PROBE_LOCATION;
 156   if (probe != NULL)
 157     EL_PROBE (location) = xstrdup (probe);
 158   return location;
 159 }
 160
 161 /* See description in location.h.  */
 162
 163 const char *
 164 get_probe_location (const struct event_location *location)
 165 {
 166   gdb_assert (EL_TYPE (location) == PROBE_LOCATION);
 167   return EL_PROBE (location);
 168 }
 169
 170 /* See description in location.h.  */
 171
 172 struct event_location *
 173 new_explicit_location (const struct explicit_location *explicit_loc)
 174 {
 175   struct event_location tmp;
 176
 177   memset (&tmp, 0, sizeof (struct event_location));
 178   EL_TYPE (&tmp) = EXPLICIT_LOCATION;
 179   initialize_explicit_location (EL_EXPLICIT (&tmp));
 180   if (explicit_loc != NULL)
 181     {
 182       if (explicit_loc->source_filename != NULL)
 183         {
 184           EL_EXPLICIT (&tmp)->source_filename
 185             = explicit_loc->source_filename;
 186         }
 187
 188       if (explicit_loc->function_name != NULL)
 189         EL_EXPLICIT (&tmp)->function_name
 190           = explicit_loc->function_name;
 191
 192       if (explicit_loc->label_name != NULL)
 193         EL_EXPLICIT (&tmp)->label_name = explicit_loc->label_name;
 194
 195       if (explicit_loc->line_offset.sign != LINE_OFFSET_UNKNOWN)
 196         EL_EXPLICIT (&tmp)->line_offset = explicit_loc->line_offset;
 197     }
 198
 199   return copy_event_location (&tmp);
 200 }
 201
 202 /* See description in location.h.  */
 203
 204 struct explicit_location *
 205 get_explicit_location (struct event_location *location)
 206 {
 207   gdb_assert (EL_TYPE (location) == EXPLICIT_LOCATION);
 208   return EL_EXPLICIT (location);
 209 }
 210
 211 /* See description in location.h.  */
 212
 213 const struct explicit_location *
 214 get_explicit_location_const (const struct event_location *location)
 215 {
 216   gdb_assert (EL_TYPE (location) == EXPLICIT_LOCATION);
 217   return EL_EXPLICIT (location);
 218 }
 219
 220 /* This convenience function returns a malloc'd string which
 221    represents the location in EXPLICIT_LOC.
 222
 223    AS_LINESPEC is non-zero if this string should be a linespec.
 224    Otherwise it will be output in explicit form.  */
 225
 226 static char *
 227 explicit_to_string_internal (int as_linespec,
 228                              const struct explicit_location *explicit_loc)
 229 {
 230   struct ui_file *buf;
 231   char space, *result;
 232   int need_space = 0;
 233   struct cleanup *cleanup;
 234
 235   space = as_linespec ? ':' : ' ';
 236   buf = mem_fileopen ();
 237   cleanup = make_cleanup_ui_file_delete (buf);
 238
 239   if (explicit_loc->source_filename != NULL)
 240     {
 241       if (!as_linespec)
 242         fputs_unfiltered ("-source ", buf);
 243       fputs_unfiltered (explicit_loc->source_filename, buf);
 244       need_space = 1;
 245     }
 246
 247   if (explicit_loc->function_name != NULL)
 248     {
 249       if (need_space)
 250         fputc_unfiltered (space, buf);
 251       if (!as_linespec)
 252         fputs_unfiltered ("-function ", buf);
 253       fputs_unfiltered (explicit_loc->function_name, buf);
 254       need_space = 1;
 255     }
 256
 257   if (explicit_loc->label_name != NULL)
 258     {
 259       if (need_space)
 260         fputc_unfiltered (space, buf);
 261       if (!as_linespec)
 262         fputs_unfiltered ("-label ", buf);
 263       fputs_unfiltered (explicit_loc->label_name, buf);
 264       need_space = 1;
 265     }
 266
 267   if (explicit_loc->line_offset.sign != LINE_OFFSET_UNKNOWN)
 268     {
 269       if (need_space)
 270         fputc_unfiltered (space, buf);
 271       if (!as_linespec)
 272         fputs_unfiltered ("-line ", buf);
 273       fprintf_filtered (buf, "%s%d",
 274                         (explicit_loc->line_offset.sign == LINE_OFFSET_NONE ? ""
 275                          : (explicit_loc->line_offset.sign
 276                             == LINE_OFFSET_PLUS ? "+" : "-")),
 277                         explicit_loc->line_offset.offset);
 278     }
 279
 280   result = ui_file_xstrdup (buf, NULL);
 281   do_cleanups (cleanup);
 282   return result;
 283 }
 284
 285 /* See description in location.h.  */
 286
 287 char *
 288 explicit_location_to_string (const struct explicit_location *explicit_loc)
 289 {
 290   return explicit_to_string_internal (0, explicit_loc);
 291 }
 292
 293 /* See description in location.h.  */
 294
 295 char *
 296 explicit_location_to_linespec (const struct explicit_location *explicit_loc)
 297 {
 298   return explicit_to_string_internal (1, explicit_loc);
 299 }
 300
 301 /* See description in location.h.  */
 302
 303 struct event_location *
 304 copy_event_location (const struct event_location *src)
 305 {
 306   struct event_location *dst;
 307
 308   dst = XCNEW (struct event_location);
 309   EL_TYPE (dst) = EL_TYPE (src);
 310   if (EL_STRING (src) != NULL)
 311     EL_STRING (dst) = xstrdup (EL_STRING (src));
 312
 313   switch (EL_TYPE (src))
 314     {
 315     case LINESPEC_LOCATION:
 316       if (EL_LINESPEC (src) != NULL)
 317         EL_LINESPEC (dst) = xstrdup (EL_LINESPEC (src));
 318       break;
 319
 320     case ADDRESS_LOCATION:
 321       EL_ADDRESS (dst) = EL_ADDRESS (src);
 322       break;
 323
 324     case EXPLICIT_LOCATION:
 325       if (EL_EXPLICIT (src)->source_filename != NULL)
 326         EL_EXPLICIT (dst)->source_filename
 327           = xstrdup (EL_EXPLICIT (src)->source_filename);
 328
 329       if (EL_EXPLICIT (src)->function_name != NULL)
 330         EL_EXPLICIT (dst)->function_name
 331           = xstrdup (EL_EXPLICIT (src)->function_name);
 332
 333       if (EL_EXPLICIT (src)->label_name != NULL)
 334         EL_EXPLICIT (dst)->label_name = xstrdup (EL_EXPLICIT (src)->label_name);
 335
 336       EL_EXPLICIT (dst)->line_offset = EL_EXPLICIT (src)->line_offset;
 337       break;
 338
 339
 340     case PROBE_LOCATION:
 341       if (EL_PROBE (src) != NULL)
 342         EL_PROBE (dst) = xstrdup (EL_PROBE (src));
 343       break;
 344
 345     default:
 346       gdb_assert_not_reached ("unknown event location type");
 347     }
 348
 349   return dst;
 350 }
 351
 352 /* A cleanup function for struct event_location.  */
 353
 354 static void
 355 delete_event_location_cleanup (void *data)
 356 {
 357   struct event_location *location = (struct event_location *) data;
 358
 359   delete_event_location (location);
 360 }
 361
 362 /* See description in location.h.  */
 363
 364 struct cleanup *
 365 make_cleanup_delete_event_location (struct event_location *location)
 366 {
 367   return make_cleanup (delete_event_location_cleanup, location);
 368 }
 369
 370 /* See description in location.h.  */
 371
 372 void
 373 delete_event_location (struct event_location *location)
 374 {
 375   if (location != NULL)
 376     {
 377       xfree (EL_STRING (location));
 378
 379       switch (EL_TYPE (location))
 380         {
 381         case LINESPEC_LOCATION:
 382           xfree (EL_LINESPEC (location));
 383           break;
 384
 385         case ADDRESS_LOCATION:
 386           /* Nothing to do.  */
 387           break;
 388
 389         case EXPLICIT_LOCATION:
 390           xfree (EL_EXPLICIT (location)->source_filename);
 391           xfree (EL_EXPLICIT (location)->function_name);
 392           xfree (EL_EXPLICIT (location)->label_name);
 393           break;
 394
 395         case PROBE_LOCATION:
 396           xfree (EL_PROBE (location));
 397           break;
 398
 399         default:
 400           gdb_assert_not_reached ("unknown event location type");
 401         }
 402
 403       xfree (location);
 404     }
 405 }
 406
 407 /* See description in location.h.  */
 408
 409 const char *
 410 event_location_to_string (struct event_location *location)
 411 {
 412   if (EL_STRING (location) == NULL)
 413     {
 414       switch (EL_TYPE (location))
 415         {
 416         case LINESPEC_LOCATION:
 417           if (EL_LINESPEC (location) != NULL)
 418             EL_STRING (location) = xstrdup (EL_LINESPEC (location));
 419           break;
 420
 421         case ADDRESS_LOCATION:
 422           EL_STRING (location)
 423             = xstrprintf ("*%s",
 424                           core_addr_to_string (EL_ADDRESS (location)));
 425           break;
 426
 427         case EXPLICIT_LOCATION:
 428           EL_STRING (location)
 429             = explicit_location_to_string (EL_EXPLICIT (location));
 430           break;
 431
 432         case PROBE_LOCATION:
 433           EL_STRING (location) = xstrdup (EL_PROBE (location));
 434           break;
 435
 436         default:
 437           gdb_assert_not_reached ("unknown event location type");
 438         }
 439     }
 440
 441   return EL_STRING (location);
 442 }
 443
 444 /* A lexer for explicit locations.  This function will advance INP
 445    past any strings that it lexes.  Returns a malloc'd copy of the
 446    lexed string or NULL if no lexing was done.  */
 447
 448 static char *
 449 explicit_location_lex_one (const char **inp,
 450                            const struct language_defn *language)
 451 {
 452   const char *start = *inp;
 453
 454   if (*start == '\0')
 455     return NULL;
 456
 457   /* If quoted, skip to the ending quote.  */
 458   if (strchr (get_gdb_linespec_parser_quote_characters (), *start))
 459     {
 460       char quote_char = *start;
 461
 462       /* If the input is not an Ada operator, skip to the matching
 463          closing quote and return the string.  */
 464       if (!(language->la_language == language_ada
 465             && quote_char == '\"' && is_ada_operator (start)))
 466         {
 467           const char *end = find_toplevel_char (start + 1, quote_char);
 468
 469           if (end == NULL)
 470             error (_("Unmatched quote, %s."), start);
 471           *inp = end + 1;
 472           return savestring (start + 1, *inp - start - 2);
 473         }
 474     }
 475
 476   /* If the input starts with '-' or '+', the string ends with the next
 477      whitespace or comma.  */
 478   if (*start == '-' || *start == '+')
 479     {
 480       while (*inp[0] != '\0' && *inp[0] != ',' && !isspace (*inp[0]))
 481         ++(*inp);
 482     }
 483   else
 484     {
 485       /* Handle numbers first, stopping at the next whitespace or ','.  */
 486       while (isdigit (*inp[0]))
 487         ++(*inp);
 488       if (*inp[0] == '\0' || isspace (*inp[0]) || *inp[0] == ',')
 489         return savestring (start, *inp - start);
 490
 491       /* Otherwise stop at the next occurrence of whitespace, '\0',
 492          keyword, or ','.  */
 493       *inp = start;
 494       while ((*inp)[0]
 495              && (*inp)[0] != ','
 496              && !(isspace ((*inp)[0])
 497                   || linespec_lexer_lex_keyword (&(*inp)[1])))
 498         {
 499           /* Special case: C++ operator,.  */
 500           if (language->la_language == language_cplus
 501               && strncmp (*inp, "operator", 8)
 502               && (*inp)[9] == ',')
 503             (*inp) += 9;
 504           ++(*inp);
 505         }
 506     }
 507
 508   if (*inp - start > 0)
 509     return savestring (start, *inp - start);
 510
 511   return NULL;
 512 }
 513
 514 /* See description in location.h.  */
 515
 516 struct event_location *
 517 string_to_explicit_location (const char **argp,
 518                              const struct language_defn *language,
 519                              int dont_throw)
 520 {
 521   struct cleanup *cleanup;
 522   struct event_location *location;
 523
 524   /* It is assumed that input beginning with '-' and a non-digit
 525      character is an explicit location.  */
 526   if (argp == NULL
 527       || *argp == '\0'
 528       || *argp[0] != '-'
 529       || !isalpha ((*argp)[1]))
 530     return NULL;
 531
 532   location = new_explicit_location (NULL);
 533   cleanup = make_cleanup_delete_event_location (location);
 534
 535   /* Process option/argument pairs.  dprintf_command
 536      requires that processing stop on ','.  */
 537   while ((*argp)[0] != '\0' && (*argp)[0] != ',')
 538     {
 539       int len;
 540       char *opt, *oarg;
 541       const char *start;
 542       struct cleanup *opt_cleanup, *oarg_cleanup;
 543
 544       /* If *ARGP starts with a keyword, stop processing
 545          options.  */
 546       if (linespec_lexer_lex_keyword (*argp) != NULL)
 547         break;
 548
 549       /* Mark the start of the string in case we need to rewind.  */
 550       start = *argp;
 551
 552       /* Get the option string.  */
 553       opt = explicit_location_lex_one (argp, language);
 554       opt_cleanup = make_cleanup (xfree, opt);
 555
 556       *argp = skip_spaces_const (*argp);
 557
 558       /* Get the argument string.  */
 559       oarg = explicit_location_lex_one (argp, language);
 560       oarg_cleanup = make_cleanup (xfree, oarg);
 561       *argp = skip_spaces_const (*argp);
 562
 563       /* Use the length of the option to allow abbreviations.  */
 564       len = strlen (opt);
 565
 566       /* All options have a required argument.  Checking for this required
 567          argument is deferred until later.  */
 568       if (strncmp (opt, "-source", len) == 0)
 569         EL_EXPLICIT (location)->source_filename = oarg;
 570       else if (strncmp (opt, "-function", len) == 0)
 571         EL_EXPLICIT (location)->function_name = oarg;
 572       else if (strncmp (opt, "-line", len) == 0)
 573         {
 574           if (oarg != NULL)
 575             {
 576               EL_EXPLICIT (location)->line_offset
 577                 = linespec_parse_line_offset (oarg);
 578               do_cleanups (oarg_cleanup);
 579               do_cleanups (opt_cleanup);
 580               continue;
 581             }
 582         }
 583       else if (strncmp (opt, "-label", len) == 0)
 584         EL_EXPLICIT (location)->label_name = oarg;
 585       /* Only emit an "invalid argument" error for options
 586          that look like option strings.  */
 587       else if (opt[0] == '-' && !isdigit (opt[1]))
 588         {
 589           if (!dont_throw)
 590             error (_("invalid explicit location argument, \"%s\""), opt);
 591         }
 592       else
 593         {
 594           /* End of the explicit location specification.
 595              Stop parsing and return whatever explicit location was
 596              parsed.  */
 597           *argp = start;
 598           discard_cleanups (oarg_cleanup);
 599           do_cleanups (opt_cleanup);
 600           discard_cleanups (cleanup);
 601           return location;
 602         }
 603
 604       /* It's a little lame to error after the fact, but in this
 605          case, it provides a much better user experience to issue
 606          the "invalid argument" error before any missing
 607          argument error.  */
 608       if (oarg == NULL && !dont_throw)
 609         error (_("missing argument for \"%s\""), opt);
 610
 611       /* The option/argument pair was successfully processed;
 612          oarg belongs to the explicit location, and opt should
 613          be freed.  */
 614       discard_cleanups (oarg_cleanup);
 615       do_cleanups (opt_cleanup);
 616     }
 617
 618   /* One special error check:  If a source filename was given
 619      without offset, function, or label, issue an error.  */
 620   if (EL_EXPLICIT (location)->source_filename != NULL
 621       && EL_EXPLICIT (location)->function_name == NULL
 622       && EL_EXPLICIT (location)->label_name == NULL
 623       && (EL_EXPLICIT (location)->line_offset.sign == LINE_OFFSET_UNKNOWN)
 624       && !dont_throw)
 625     {
 626       error (_("Source filename requires function, label, or "
 627                "line offset."));
 628     }
 629
 630   discard_cleanups (cleanup);
 631   return location;
 632 }
 633
 634 /* See description in location.h.  */
 635
 636 struct event_location *
 637 string_to_event_location (char **stringp,
 638                           const struct language_defn *language)
 639 {
 640   struct event_location *location;
 641
 642   /* First, check if the string is an address location.  */
 643   if (*stringp != NULL && **stringp == '*')
 644     {
 645       const char *arg, *orig;
 646       CORE_ADDR addr;
 647
 648       orig = arg = *stringp;
 649       addr = linespec_expression_to_pc (&arg);
 650       location = new_address_location (addr, orig, arg - orig);
 651       *stringp += arg - orig;
 652     }
 653   else
 654     {
 655       const char *cs;
 656
 657       /* Next, try the input as a probe spec.  */
 658       cs = *stringp;
 659       if (cs != NULL && probe_linespec_to_ops (&cs) != NULL)
 660         {
 661           location = new_probe_location (*stringp);
 662           *stringp += strlen (*stringp);
 663         }
 664       else
 665         {
 666           const char *arg, *orig;
 667
 668           /* Next, try an explicit location.  */
 669           orig = arg = *stringp;
 670           location = string_to_explicit_location (&arg, language, 0);
 671           if (location != NULL)
 672             {
 673               /* It was a valid explicit location.  Advance STRINGP to
 674                  the end of input.  */
 675               *stringp += arg - orig;
 676             }
 677           else
 678             {
 679               /* Everything else is a linespec.  */
 680               location = new_linespec_location (stringp);
 681             }
 682         }
 683     }
 684
 685   return location;
 686 }
 687
 688 /* See description in location.h.  */
 689
 690 int
 691 event_location_empty_p (const struct event_location *location)
 692 {
 693   switch (EL_TYPE (location))
 694     {
 695     case LINESPEC_LOCATION:
 696       /* Linespecs are never "empty."  (NULL is a valid linespec)  */
 697       return 0;
 698
 699     case ADDRESS_LOCATION:
 700       return 0;
 701
 702     case EXPLICIT_LOCATION:
 703       return (EL_EXPLICIT (location) == NULL
 704               || (EL_EXPLICIT (location)->source_filename == NULL
 705                   && EL_EXPLICIT (location)->function_name == NULL
 706                   && EL_EXPLICIT (location)->label_name == NULL
 707                   && (EL_EXPLICIT (location)->line_offset.sign
 708                       == LINE_OFFSET_UNKNOWN)));
 709
 710     case PROBE_LOCATION:
 711       return EL_PROBE (location) == NULL;
 712
 713     default:
 714       gdb_assert_not_reached ("unknown event location type");
 715     }
 716 }
 717
 718 /* See description in location.h.  */
 719
 720 void
 721 set_event_location_string (struct event_location *location,
 722                            const char *string)
 723 {
 724   xfree (EL_STRING (location));
 725   EL_STRING (location) = string == NULL ?  NULL : xstrdup (string);
 726 }