tools/perf/util/dwarf-aux.c

   1 /*
   2  * dwarf-aux.c : libdw auxiliary interfaces
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  *
  18  */
  19
  20 #include <stdbool.h>
  21 #include "util.h"
  22 #include "debug.h"
  23 #include "dwarf-aux.h"
  24
  25 /**
  26  * cu_find_realpath - Find the realpath of the target file
  27  * @cu_die: A DIE(dwarf information entry) of CU(compilation Unit)
  28  * @fname:  The tail filename of the target file
  29  *
  30  * Find the real(long) path of @fname in @cu_die.
  31  */
  32 const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname)
  33 {
  34         Dwarf_Files *files;
  35         size_t nfiles, i;
  36         const char *src = NULL;
  37         int ret;
  38
  39         if (!fname)
  40                 return NULL;
  41
  42         ret = dwarf_getsrcfiles(cu_die, &files, &nfiles);
  43         if (ret != 0)
  44                 return NULL;
  45
  46         for (i = 0; i < nfiles; i++) {
  47                 src = dwarf_filesrc(files, i, NULL, NULL);
  48                 if (strtailcmp(src, fname) == 0)
  49                         break;
  50         }
  51         if (i == nfiles)
  52                 return NULL;
  53         return src;
  54 }
  55
  56 /**
  57  * cu_get_comp_dir - Get the path of compilation directory
  58  * @cu_die: a CU DIE
  59  *
  60  * Get the path of compilation directory of given @cu_die.
  61  * Since this depends on DW_AT_comp_dir, older gcc will not
  62  * embedded it. In that case, this returns NULL.
  63  */
  64 const char *cu_get_comp_dir(Dwarf_Die *cu_die)
  65 {
  66         Dwarf_Attribute attr;
  67         if (dwarf_attr(cu_die, DW_AT_comp_dir, &attr) == NULL)
  68                 return NULL;
  69         return dwarf_formstring(&attr);
  70 }
  71
  72 /**
  73  * cu_find_lineinfo - Get a line number and file name for given address
  74  * @cu_die: a CU DIE
  75  * @addr: An address
  76  * @fname: a pointer which returns the file name string
  77  * @lineno: a pointer which returns the line number
  78  *
  79  * Find a line number and file name for @addr in @cu_die.
  80  */
  81 int cu_find_lineinfo(Dwarf_Die *cu_die, unsigned long addr,
  82                     const char **fname, int *lineno)
  83 {
  84         Dwarf_Line *line;
  85         Dwarf_Addr laddr;
  86
  87         line = dwarf_getsrc_die(cu_die, (Dwarf_Addr)addr);
  88         if (line && dwarf_lineaddr(line, &laddr) == 0 &&
  89             addr == (unsigned long)laddr && dwarf_lineno(line, lineno) == 0) {
  90                 *fname = dwarf_linesrc(line, NULL, NULL);
  91                 if (!*fname)
  92                         /* line number is useless without filename */
  93                         *lineno = 0;
  94         }
  95
  96         return *lineno ?: -ENOENT;
  97 }
  98
  99 static int __die_find_inline_cb(Dwarf_Die *die_mem, void *data);
 100
 101 /**
 102  * cu_walk_functions_at - Walk on function DIEs at given address
 103  * @cu_die: A CU DIE
 104  * @addr: An address
 105  * @callback: A callback which called with found DIEs
 106  * @data: A user data
 107  *
 108  * Walk on function DIEs at given @addr in @cu_die. Passed DIEs
 109  * should be subprogram or inlined-subroutines.
 110  */
 111 int cu_walk_functions_at(Dwarf_Die *cu_die, Dwarf_Addr addr,
 112                     int (*callback)(Dwarf_Die *, void *), void *data)
 113 {
 114         Dwarf_Die die_mem;
 115         Dwarf_Die *sc_die;
 116         int ret = -ENOENT;
 117
 118         /* Inlined function could be recursive. Trace it until fail */
 119         for (sc_die = die_find_realfunc(cu_die, addr, &die_mem);
 120              sc_die != NULL;
 121              sc_die = die_find_child(sc_die, __die_find_inline_cb, &addr,
 122                                      &die_mem)) {
 123                 ret = callback(sc_die, data);
 124                 if (ret)
 125                         break;
 126         }
 127
 128         return ret;
 129
 130 }
 131
 132 /**
 133  * die_compare_name - Compare diename and tname
 134  * @dw_die: a DIE
 135  * @tname: a string of target name
 136  *
 137  * Compare the name of @dw_die and @tname. Return false if @dw_die has no name.
 138  */
 139 bool die_compare_name(Dwarf_Die *dw_die, const char *tname)
 140 {
 141         const char *name;
 142
 143         name = dwarf_diename(dw_die);
 144         return name ? (strcmp(tname, name) == 0) : false;
 145 }
 146
 147 /**
 148  * die_match_name - Match diename and glob
 149  * @dw_die: a DIE
 150  * @glob: a string of target glob pattern
 151  *
 152  * Glob matching the name of @dw_die and @glob. Return false if matching fail.
 153  */
 154 bool die_match_name(Dwarf_Die *dw_die, const char *glob)
 155 {
 156         const char *name;
 157
 158         name = dwarf_diename(dw_die);
 159         return name ? strglobmatch(name, glob) : false;
 160 }
 161
 162 /**
 163  * die_get_call_lineno - Get callsite line number of inline-function instance
 164  * @in_die: a DIE of an inlined function instance
 165  *
 166  * Get call-site line number of @in_die. This means from where the inline
 167  * function is called.
 168  */
 169 int die_get_call_lineno(Dwarf_Die *in_die)
 170 {
 171         Dwarf_Attribute attr;
 172         Dwarf_Word ret;
 173
 174         if (!dwarf_attr(in_die, DW_AT_call_line, &attr))
 175                 return -ENOENT;
 176
 177         dwarf_formudata(&attr, &ret);
 178         return (int)ret;
 179 }
 180
 181 /**
 182  * die_get_type - Get type DIE
 183  * @vr_die: a DIE of a variable
 184  * @die_mem: where to store a type DIE
 185  *
 186  * Get a DIE of the type of given variable (@vr_die), and store
 187  * it to die_mem. Return NULL if fails to get a type DIE.
 188  */
 189 Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
 190 {
 191         Dwarf_Attribute attr;
 192
 193         if (dwarf_attr_integrate(vr_die, DW_AT_type, &attr) &&
 194             dwarf_formref_die(&attr, die_mem))
 195                 return die_mem;
 196         else
 197                 return NULL;
 198 }
 199
 200 /* Get a type die, but skip qualifiers */
 201 static Dwarf_Die *__die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
 202 {
 203         int tag;
 204
 205         do {
 206                 vr_die = die_get_type(vr_die, die_mem);
 207                 if (!vr_die)
 208                         break;
 209                 tag = dwarf_tag(vr_die);
 210         } while (tag == DW_TAG_const_type ||
 211                  tag == DW_TAG_restrict_type ||
 212                  tag == DW_TAG_volatile_type ||
 213                  tag == DW_TAG_shared_type);
 214
 215         return vr_die;
 216 }
 217
 218 /**
 219  * die_get_real_type - Get a type die, but skip qualifiers and typedef
 220  * @vr_die: a DIE of a variable
 221  * @die_mem: where to store a type DIE
 222  *
 223  * Get a DIE of the type of given variable (@vr_die), and store
 224  * it to die_mem. Return NULL if fails to get a type DIE.
 225  * If the type is qualifiers (e.g. const) or typedef, this skips it
 226  * and tries to find real type (structure or basic types, e.g. int).
 227  */
 228 Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
 229 {
 230         do {
 231                 vr_die = __die_get_real_type(vr_die, die_mem);
 232         } while (vr_die && dwarf_tag(vr_die) == DW_TAG_typedef);
 233
 234         return vr_die;
 235 }
 236
 237 /* Get attribute and translate it as a udata */
 238 static int die_get_attr_udata(Dwarf_Die *tp_die, unsigned int attr_name,
 239                               Dwarf_Word *result)
 240 {
 241         Dwarf_Attribute attr;
 242
 243         if (dwarf_attr(tp_die, attr_name, &attr) == NULL ||
 244             dwarf_formudata(&attr, result) != 0)
 245                 return -ENOENT;
 246
 247         return 0;
 248 }
 249
 250 /* Get attribute and translate it as a sdata */
 251 static int die_get_attr_sdata(Dwarf_Die *tp_die, unsigned int attr_name,
 252                               Dwarf_Sword *result)
 253 {
 254         Dwarf_Attribute attr;
 255
 256         if (dwarf_attr(tp_die, attr_name, &attr) == NULL ||
 257             dwarf_formsdata(&attr, result) != 0)
 258                 return -ENOENT;
 259
 260         return 0;
 261 }
 262
 263 /**
 264  * die_is_signed_type - Check whether a type DIE is signed or not
 265  * @tp_die: a DIE of a type
 266  *
 267  * Get the encoding of @tp_die and return true if the encoding
 268  * is signed.
 269  */
 270 bool die_is_signed_type(Dwarf_Die *tp_die)
 271 {
 272         Dwarf_Word ret;
 273
 274         if (die_get_attr_udata(tp_die, DW_AT_encoding, &ret))
 275                 return false;
 276
 277         return (ret == DW_ATE_signed_char || ret == DW_ATE_signed ||
 278                 ret == DW_ATE_signed_fixed);
 279 }
 280
 281 /**
 282  * die_is_func_def - Ensure that this DIE is a subprogram and definition
 283  * @dw_die: a DIE
 284  *
 285  * Ensure that this DIE is a subprogram and NOT a declaration. This
 286  * returns true if @dw_die is a function definition.
 287  **/
 288 bool die_is_func_def(Dwarf_Die *dw_die)
 289 {
 290         Dwarf_Attribute attr;
 291
 292         return (dwarf_tag(dw_die) == DW_TAG_subprogram &&
 293                 dwarf_attr(dw_die, DW_AT_declaration, &attr) == NULL);
 294 }
 295
 296 /**
 297  * die_entrypc - Returns entry PC (the lowest address) of a DIE
 298  * @dw_die: a DIE
 299  * @addr: where to store entry PC
 300  *
 301  * Since dwarf_entrypc() does not return entry PC if the DIE has only address
 302  * range, we have to use this to retrieve the lowest address from the address
 303  * range attribute.
 304  */
 305 int die_entrypc(Dwarf_Die *dw_die, Dwarf_Addr *addr)
 306 {
 307         Dwarf_Addr base, end;
 308         Dwarf_Attribute attr;
 309
 310         if (!addr)
 311                 return -EINVAL;
 312
 313         if (dwarf_entrypc(dw_die, addr) == 0)
 314                 return 0;
 315
 316         /*
 317          *  Since the dwarf_ranges() will return 0 if there is no
 318          * DW_AT_ranges attribute, we should check it first.
 319          */
 320         if (!dwarf_attr(dw_die, DW_AT_ranges, &attr))
 321                 return -ENOENT;
 322
 323         return dwarf_ranges(dw_die, 0, &base, addr, &end) < 0 ? -ENOENT : 0;
 324 }
 325
 326 /**
 327  * die_is_func_instance - Ensure that this DIE is an instance of a subprogram
 328  * @dw_die: a DIE
 329  *
 330  * Ensure that this DIE is an instance (which has an entry address).
 331  * This returns true if @dw_die is a function instance. If not, the @dw_die
 332  * must be a prototype. You can use die_walk_instances() to find actual
 333  * instances.
 334  **/
 335 bool die_is_func_instance(Dwarf_Die *dw_die)
 336 {
 337         Dwarf_Addr tmp;
 338         Dwarf_Attribute attr_mem;
 339         int tag = dwarf_tag(dw_die);
 340
 341         if (tag != DW_TAG_subprogram &&
 342             tag != DW_TAG_inlined_subroutine)
 343                 return false;
 344
 345         return dwarf_entrypc(dw_die, &tmp) == 0 ||
 346                 dwarf_attr(dw_die, DW_AT_ranges, &attr_mem) != NULL;
 347 }
 348
 349 /**
 350  * die_get_data_member_location - Get the data-member offset
 351  * @mb_die: a DIE of a member of a data structure
 352  * @offs: The offset of the member in the data structure
 353  *
 354  * Get the offset of @mb_die in the data structure including @mb_die, and
 355  * stores result offset to @offs. If any error occurs this returns errno.
 356  */
 357 int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs)
 358 {
 359         Dwarf_Attribute attr;
 360         Dwarf_Op *expr;
 361         size_t nexpr;
 362         int ret;
 363
 364         if (dwarf_attr(mb_die, DW_AT_data_member_location, &attr) == NULL)
 365                 return -ENOENT;
 366
 367         if (dwarf_formudata(&attr, offs) != 0) {
 368                 /* DW_AT_data_member_location should be DW_OP_plus_uconst */
 369                 ret = dwarf_getlocation(&attr, &expr, &nexpr);
 370                 if (ret < 0 || nexpr == 0)
 371                         return -ENOENT;
 372
 373                 if (expr[0].atom != DW_OP_plus_uconst || nexpr != 1) {
 374                         pr_debug("Unable to get offset:Unexpected OP %x (%zd)\n",
 375                                  expr[0].atom, nexpr);
 376                         return -ENOTSUP;
 377                 }
 378                 *offs = (Dwarf_Word)expr[0].number;
 379         }
 380         return 0;
 381 }
 382
 383 /* Get the call file index number in CU DIE */
 384 static int die_get_call_fileno(Dwarf_Die *in_die)
 385 {
 386         Dwarf_Sword idx;
 387
 388         if (die_get_attr_sdata(in_die, DW_AT_call_file, &idx) == 0)
 389                 return (int)idx;
 390         else
 391                 return -ENOENT;
 392 }
 393
 394 /* Get the declared file index number in CU DIE */
 395 static int die_get_decl_fileno(Dwarf_Die *pdie)
 396 {
 397         Dwarf_Sword idx;
 398
 399         if (die_get_attr_sdata(pdie, DW_AT_decl_file, &idx) == 0)
 400                 return (int)idx;
 401         else
 402                 return -ENOENT;
 403 }
 404
 405 /**
 406  * die_get_call_file - Get callsite file name of inlined function instance
 407  * @in_die: a DIE of an inlined function instance
 408  *
 409  * Get call-site file name of @in_die. This means from which file the inline
 410  * function is called.
 411  */
 412 const char *die_get_call_file(Dwarf_Die *in_die)
 413 {
 414         Dwarf_Die cu_die;
 415         Dwarf_Files *files;
 416         int idx;
 417
 418         idx = die_get_call_fileno(in_die);
 419         if (idx < 0 || !dwarf_diecu(in_die, &cu_die, NULL, NULL) ||
 420             dwarf_getsrcfiles(&cu_die, &files, NULL) != 0)
 421                 return NULL;
 422
 423         return dwarf_filesrc(files, idx, NULL, NULL);
 424 }
 425
 426
 427 /**
 428  * die_find_child - Generic DIE search function in DIE tree
 429  * @rt_die: a root DIE
 430  * @callback: a callback function
 431  * @data: a user data passed to the callback function
 432  * @die_mem: a buffer for result DIE
 433  *
 434  * Trace DIE tree from @rt_die and call @callback for each child DIE.
 435  * If @callback returns DIE_FIND_CB_END, this stores the DIE into
 436  * @die_mem and returns it. If @callback returns DIE_FIND_CB_CONTINUE,
 437  * this continues to trace the tree. Optionally, @callback can return
 438  * DIE_FIND_CB_CHILD and DIE_FIND_CB_SIBLING, those means trace only
 439  * the children and trace only the siblings respectively.
 440  * Returns NULL if @callback can't find any appropriate DIE.
 441  */
 442 Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
 443                           int (*callback)(Dwarf_Die *, void *),
 444                           void *data, Dwarf_Die *die_mem)
 445 {
 446         Dwarf_Die child_die;
 447         int ret;
 448
 449         ret = dwarf_child(rt_die, die_mem);
 450         if (ret != 0)
 451                 return NULL;
 452
 453         do {
 454                 ret = callback(die_mem, data);
 455                 if (ret == DIE_FIND_CB_END)
 456                         return die_mem;
 457
 458                 if ((ret & DIE_FIND_CB_CHILD) &&
 459                     die_find_child(die_mem, callback, data, &child_die)) {
 460                         memcpy(die_mem, &child_die, sizeof(Dwarf_Die));
 461                         return die_mem;
 462                 }
 463         } while ((ret & DIE_FIND_CB_SIBLING) &&
 464                  dwarf_siblingof(die_mem, die_mem) == 0);
 465
 466         return NULL;
 467 }
 468
 469 struct __addr_die_search_param {
 470         Dwarf_Addr      addr;
 471         Dwarf_Die       *die_mem;
 472 };
 473
 474 static int __die_search_func_tail_cb(Dwarf_Die *fn_die, void *data)
 475 {
 476         struct __addr_die_search_param *ad = data;
 477         Dwarf_Addr addr = 0;
 478
 479         if (dwarf_tag(fn_die) == DW_TAG_subprogram &&
 480             !dwarf_highpc(fn_die, &addr) &&
 481             addr == ad->addr) {
 482                 memcpy(ad->die_mem, fn_die, sizeof(Dwarf_Die));
 483                 return DWARF_CB_ABORT;
 484         }
 485         return DWARF_CB_OK;
 486 }
 487
 488 /**
 489  * die_find_tailfunc - Search for a non-inlined function with tail call at
 490  * given address
 491  * @cu_die: a CU DIE which including @addr
 492  * @addr: target address
 493  * @die_mem: a buffer for result DIE
 494  *
 495  * Search for a non-inlined function DIE with tail call at @addr. Stores the
 496  * DIE to @die_mem and returns it if found. Returns NULL if failed.
 497  */
 498 Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
 499                                     Dwarf_Die *die_mem)
 500 {
 501         struct __addr_die_search_param ad;
 502         ad.addr = addr;
 503         ad.die_mem = die_mem;
 504         /* dwarf_getscopes can't find subprogram. */
 505         if (!dwarf_getfuncs(cu_die, __die_search_func_tail_cb, &ad, 0))
 506                 return NULL;
 507         else
 508                 return die_mem;
 509 }
 510
 511 /* die_find callback for non-inlined function search */
 512 static int __die_search_func_cb(Dwarf_Die *fn_die, void *data)
 513 {
 514         struct __addr_die_search_param *ad = data;
 515
 516         /*
 517          * Since a declaration entry doesn't has given pc, this always returns
 518          * function definition entry.
 519          */
 520         if (dwarf_tag(fn_die) == DW_TAG_subprogram &&
 521             dwarf_haspc(fn_die, ad->addr)) {
 522                 memcpy(ad->die_mem, fn_die, sizeof(Dwarf_Die));
 523                 return DWARF_CB_ABORT;
 524         }
 525         return DWARF_CB_OK;
 526 }
 527
 528 /**
 529  * die_find_realfunc - Search a non-inlined function at given address
 530  * @cu_die: a CU DIE which including @addr
 531  * @addr: target address
 532  * @die_mem: a buffer for result DIE
 533  *
 534  * Search a non-inlined function DIE which includes @addr. Stores the
 535  * DIE to @die_mem and returns it if found. Returns NULL if failed.
 536  */
 537 Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
 538                                     Dwarf_Die *die_mem)
 539 {
 540         struct __addr_die_search_param ad;
 541         ad.addr = addr;
 542         ad.die_mem = die_mem;
 543         /* dwarf_getscopes can't find subprogram. */
 544         if (!dwarf_getfuncs(cu_die, __die_search_func_cb, &ad, 0))
 545                 return NULL;
 546         else
 547                 return die_mem;
 548 }
 549
 550 /* die_find callback for inline function search */
 551 static int __die_find_inline_cb(Dwarf_Die *die_mem, void *data)
 552 {
 553         Dwarf_Addr *addr = data;
 554
 555         if (dwarf_tag(die_mem) == DW_TAG_inlined_subroutine &&
 556             dwarf_haspc(die_mem, *addr))
 557                 return DIE_FIND_CB_END;
 558
 559         return DIE_FIND_CB_CONTINUE;
 560 }
 561
 562 /**
 563  * die_find_top_inlinefunc - Search the top inlined function at given address
 564  * @sp_die: a subprogram DIE which including @addr
 565  * @addr: target address
 566  * @die_mem: a buffer for result DIE
 567  *
 568  * Search an inlined function DIE which includes @addr. Stores the
 569  * DIE to @die_mem and returns it if found. Returns NULL if failed.
 570  * Even if several inlined functions are expanded recursively, this
 571  * doesn't trace it down, and returns the topmost one.
 572  */
 573 Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
 574                                    Dwarf_Die *die_mem)
 575 {
 576         return die_find_child(sp_die, __die_find_inline_cb, &addr, die_mem);
 577 }
 578
 579 /**
 580  * die_find_inlinefunc - Search an inlined function at given address
 581  * @sp_die: a subprogram DIE which including @addr
 582  * @addr: target address
 583  * @die_mem: a buffer for result DIE
 584  *
 585  * Search an inlined function DIE which includes @addr. Stores the
 586  * DIE to @die_mem and returns it if found. Returns NULL if failed.
 587  * If several inlined functions are expanded recursively, this trace
 588  * it down and returns deepest one.
 589  */
 590 Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
 591                                Dwarf_Die *die_mem)
 592 {
 593         Dwarf_Die tmp_die;
 594
 595         sp_die = die_find_child(sp_die, __die_find_inline_cb, &addr, &tmp_die);
 596         if (!sp_die)
 597                 return NULL;
 598
 599         /* Inlined function could be recursive. Trace it until fail */
 600         while (sp_die) {
 601                 memcpy(die_mem, sp_die, sizeof(Dwarf_Die));
 602                 sp_die = die_find_child(sp_die, __die_find_inline_cb, &addr,
 603                                         &tmp_die);
 604         }
 605
 606         return die_mem;
 607 }
 608
 609 struct __instance_walk_param {
 610         void    *addr;
 611         int     (*callback)(Dwarf_Die *, void *);
 612         void    *data;
 613         int     retval;
 614 };
 615
 616 static int __die_walk_instances_cb(Dwarf_Die *inst, void *data)
 617 {
 618         struct __instance_walk_param *iwp = data;
 619         Dwarf_Attribute attr_mem;
 620         Dwarf_Die origin_mem;
 621         Dwarf_Attribute *attr;
 622         Dwarf_Die *origin;
 623         int tmp;
 624
 625         if (!die_is_func_instance(inst))
 626                 return DIE_FIND_CB_CONTINUE;
 627
 628         attr = dwarf_attr(inst, DW_AT_abstract_origin, &attr_mem);
 629         if (attr == NULL)
 630                 return DIE_FIND_CB_CONTINUE;
 631
 632         origin = dwarf_formref_die(attr, &origin_mem);
 633         if (origin == NULL || origin->addr != iwp->addr)
 634                 return DIE_FIND_CB_CONTINUE;
 635
 636         /* Ignore redundant instances */
 637         if (dwarf_tag(inst) == DW_TAG_inlined_subroutine) {
 638                 dwarf_decl_line(origin, &tmp);
 639                 if (die_get_call_lineno(inst) == tmp) {
 640                         tmp = die_get_decl_fileno(origin);
 641                         if (die_get_call_fileno(inst) == tmp)
 642                                 return DIE_FIND_CB_CONTINUE;
 643                 }
 644         }
 645
 646         iwp->retval = iwp->callback(inst, iwp->data);
 647
 648         return (iwp->retval) ? DIE_FIND_CB_END : DIE_FIND_CB_CONTINUE;
 649 }
 650
 651 /**
 652  * die_walk_instances - Walk on instances of given DIE
 653  * @or_die: an abstract original DIE
 654  * @callback: a callback function which is called with instance DIE
 655  * @data: user data
 656  *
 657  * Walk on the instances of give @in_die. @in_die must be an inlined function
 658  * declartion. This returns the return value of @callback if it returns
 659  * non-zero value, or -ENOENT if there is no instance.
 660  */
 661 int die_walk_instances(Dwarf_Die *or_die, int (*callback)(Dwarf_Die *, void *),
 662                        void *data)
 663 {
 664         Dwarf_Die cu_die;
 665         Dwarf_Die die_mem;
 666         struct __instance_walk_param iwp = {
 667                 .addr = or_die->addr,
 668                 .callback = callback,
 669                 .data = data,
 670                 .retval = -ENOENT,
 671         };
 672
 673         if (dwarf_diecu(or_die, &cu_die, NULL, NULL) == NULL)
 674                 return -ENOENT;
 675
 676         die_find_child(&cu_die, __die_walk_instances_cb, &iwp, &die_mem);
 677
 678         return iwp.retval;
 679 }
 680
 681 /* Line walker internal parameters */
 682 struct __line_walk_param {
 683         bool recursive;
 684         line_walk_callback_t callback;
 685         void *data;
 686         int retval;
 687 };
 688
 689 static int __die_walk_funclines_cb(Dwarf_Die *in_die, void *data)
 690 {
 691         struct __line_walk_param *lw = data;
 692         Dwarf_Addr addr = 0;
 693         const char *fname;
 694         int lineno;
 695
 696         if (dwarf_tag(in_die) == DW_TAG_inlined_subroutine) {
 697                 fname = die_get_call_file(in_die);
 698                 lineno = die_get_call_lineno(in_die);
 699                 if (fname && lineno > 0 && die_entrypc(in_die, &addr) == 0) {
 700                         lw->retval = lw->callback(fname, lineno, addr, lw->data);
 701                         if (lw->retval != 0)
 702                                 return DIE_FIND_CB_END;
 703                 }
 704                 if (!lw->recursive)
 705                         return DIE_FIND_CB_SIBLING;
 706         }
 707
 708         if (addr) {
 709                 fname = dwarf_decl_file(in_die);
 710                 if (fname && dwarf_decl_line(in_die, &lineno) == 0) {
 711                         lw->retval = lw->callback(fname, lineno, addr, lw->data);
 712                         if (lw->retval != 0)
 713                                 return DIE_FIND_CB_END;
 714                 }
 715         }
 716
 717         /* Continue to search nested inlined function call-sites */
 718         return DIE_FIND_CB_CONTINUE;
 719 }
 720
 721 /* Walk on lines of blocks included in given DIE */
 722 static int __die_walk_funclines(Dwarf_Die *sp_die, bool recursive,
 723                                 line_walk_callback_t callback, void *data)
 724 {
 725         struct __line_walk_param lw = {
 726                 .recursive = recursive,
 727                 .callback = callback,
 728                 .data = data,
 729                 .retval = 0,
 730         };
 731         Dwarf_Die die_mem;
 732         Dwarf_Addr addr;
 733         const char *fname;
 734         int lineno;
 735
 736         /* Handle function declaration line */
 737         fname = dwarf_decl_file(sp_die);
 738         if (fname && dwarf_decl_line(sp_die, &lineno) == 0 &&
 739             die_entrypc(sp_die, &addr) == 0) {
 740                 lw.retval = callback(fname, lineno, addr, data);
 741                 if (lw.retval != 0)
 742                         goto done;
 743         }
 744         die_find_child(sp_die, __die_walk_funclines_cb, &lw, &die_mem);
 745 done:
 746         return lw.retval;
 747 }
 748
 749 static int __die_walk_culines_cb(Dwarf_Die *sp_die, void *data)
 750 {
 751         struct __line_walk_param *lw = data;
 752
 753         /*
 754          * Since inlined function can include another inlined function in
 755          * the same file, we need to walk in it recursively.
 756          */
 757         lw->retval = __die_walk_funclines(sp_die, true, lw->callback, lw->data);
 758         if (lw->retval != 0)
 759                 return DWARF_CB_ABORT;
 760
 761         return DWARF_CB_OK;
 762 }
 763
 764 /**
 765  * die_walk_lines - Walk on lines inside given DIE
 766  * @rt_die: a root DIE (CU, subprogram or inlined_subroutine)
 767  * @callback: callback routine
 768  * @data: user data
 769  *
 770  * Walk on all lines inside given @rt_die and call @callback on each line.
 771  * If the @rt_die is a function, walk only on the lines inside the function,
 772  * otherwise @rt_die must be a CU DIE.
 773  * Note that this walks not only dwarf line list, but also function entries
 774  * and inline call-site.
 775  */
 776 int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data)
 777 {
 778         Dwarf_Lines *lines;
 779         Dwarf_Line *line;
 780         Dwarf_Addr addr;
 781         const char *fname, *decf = NULL, *inf = NULL;
 782         int lineno, ret = 0;
 783         int decl = 0, inl;
 784         Dwarf_Die die_mem, *cu_die;
 785         size_t nlines, i;
 786         bool flag;
 787
 788         /* Get the CU die */
 789         if (dwarf_tag(rt_die) != DW_TAG_compile_unit) {
 790                 cu_die = dwarf_diecu(rt_die, &die_mem, NULL, NULL);
 791                 dwarf_decl_line(rt_die, &decl);
 792                 decf = dwarf_decl_file(rt_die);
 793         } else
 794                 cu_die = rt_die;
 795         if (!cu_die) {
 796                 pr_debug2("Failed to get CU from given DIE.\n");
 797                 return -EINVAL;
 798         }
 799
 800         /* Get lines list in the CU */
 801         if (dwarf_getsrclines(cu_die, &lines, &nlines) != 0) {
 802                 pr_debug2("Failed to get source lines on this CU.\n");
 803                 return -ENOENT;
 804         }
 805         pr_debug2("Get %zd lines from this CU\n", nlines);
 806
 807         /* Walk on the lines on lines list */
 808         for (i = 0; i < nlines; i++) {
 809                 line = dwarf_onesrcline(lines, i);
 810                 if (line == NULL ||
 811                     dwarf_lineno(line, &lineno) != 0 ||
 812                     dwarf_lineaddr(line, &addr) != 0) {
 813                         pr_debug2("Failed to get line info. "
 814                                   "Possible error in debuginfo.\n");
 815                         continue;
 816                 }
 817                 /* Skip end-of-sequence */
 818                 if (dwarf_lineendsequence(line, &flag) != 0 || flag)
 819                         continue;
 820                 /* Skip Non statement line-info */
 821                 if (dwarf_linebeginstatement(line, &flag) != 0 || !flag)
 822                         continue;
 823                 /* Filter lines based on address */
 824                 if (rt_die != cu_die) {
 825                         /*
 826                          * Address filtering
 827                          * The line is included in given function, and
 828                          * no inline block includes it.
 829                          */
 830                         if (!dwarf_haspc(rt_die, addr))
 831                                 continue;
 832
 833                         if (die_find_inlinefunc(rt_die, addr, &die_mem)) {
 834                                 /* Call-site check */
 835                                 inf = die_get_call_file(&die_mem);
 836                                 if ((inf && !strcmp(inf, decf)) &&
 837                                     die_get_call_lineno(&die_mem) == lineno)
 838                                         goto found;
 839
 840                                 dwarf_decl_line(&die_mem, &inl);
 841                                 if (inl != decl ||
 842                                     decf != dwarf_decl_file(&die_mem))
 843                                         continue;
 844                         }
 845                 }
 846 found:
 847                 /* Get source line */
 848                 fname = dwarf_linesrc(line, NULL, NULL);
 849
 850                 ret = callback(fname, lineno, addr, data);
 851                 if (ret != 0)
 852                         return ret;
 853         }
 854
 855         /*
 856          * Dwarf lines doesn't include function declarations and inlined
 857          * subroutines. We have to check functions list or given function.
 858          */
 859         if (rt_die != cu_die)
 860                 /*
 861                  * Don't need walk inlined functions recursively, because
 862                  * inner inlined functions don't have the lines of the
 863                  * specified function.
 864                  */
 865                 ret = __die_walk_funclines(rt_die, false, callback, data);
 866         else {
 867                 struct __line_walk_param param = {
 868                         .callback = callback,
 869                         .data = data,
 870                         .retval = 0,
 871                 };
 872                 dwarf_getfuncs(cu_die, __die_walk_culines_cb, &param, 0);
 873                 ret = param.retval;
 874         }
 875
 876         return ret;
 877 }
 878
 879 struct __find_variable_param {
 880         const char *name;
 881         Dwarf_Addr addr;
 882 };
 883
 884 static int __die_find_variable_cb(Dwarf_Die *die_mem, void *data)
 885 {
 886         struct __find_variable_param *fvp = data;
 887         Dwarf_Attribute attr;
 888         int tag;
 889
 890         tag = dwarf_tag(die_mem);
 891         if ((tag == DW_TAG_formal_parameter ||
 892              tag == DW_TAG_variable) &&
 893             die_compare_name(die_mem, fvp->name) &&
 894         /* Does the DIE have location information or external instance? */
 895             (dwarf_attr(die_mem, DW_AT_external, &attr) ||
 896              dwarf_attr(die_mem, DW_AT_location, &attr)))
 897                 return DIE_FIND_CB_END;
 898         if (dwarf_haspc(die_mem, fvp->addr))
 899                 return DIE_FIND_CB_CONTINUE;
 900         else
 901                 return DIE_FIND_CB_SIBLING;
 902 }
 903
 904 /**
 905  * die_find_variable_at - Find a given name variable at given address
 906  * @sp_die: a function DIE
 907  * @name: variable name
 908  * @addr: address
 909  * @die_mem: a buffer for result DIE
 910  *
 911  * Find a variable DIE called @name at @addr in @sp_die.
 912  */
 913 Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
 914                                 Dwarf_Addr addr, Dwarf_Die *die_mem)
 915 {
 916         struct __find_variable_param fvp = { .name = name, .addr = addr};
 917
 918         return die_find_child(sp_die, __die_find_variable_cb, (void *)&fvp,
 919                               die_mem);
 920 }
 921
 922 static int __die_find_member_cb(Dwarf_Die *die_mem, void *data)
 923 {
 924         const char *name = data;
 925
 926         if (dwarf_tag(die_mem) == DW_TAG_member) {
 927                 if (die_compare_name(die_mem, name))
 928                         return DIE_FIND_CB_END;
 929                 else if (!dwarf_diename(die_mem)) {     /* Unnamed structure */
 930                         Dwarf_Die type_die, tmp_die;
 931                         if (die_get_type(die_mem, &type_die) &&
 932                             die_find_member(&type_die, name, &tmp_die))
 933                                 return DIE_FIND_CB_END;
 934                 }
 935         }
 936         return DIE_FIND_CB_SIBLING;
 937 }
 938
 939 /**
 940  * die_find_member - Find a given name member in a data structure
 941  * @st_die: a data structure type DIE
 942  * @name: member name
 943  * @die_mem: a buffer for result DIE
 944  *
 945  * Find a member DIE called @name in @st_die.
 946  */
 947 Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
 948                            Dwarf_Die *die_mem)
 949 {
 950         return die_find_child(st_die, __die_find_member_cb, (void *)name,
 951                               die_mem);
 952 }
 953
 954 /**
 955  * die_get_typename - Get the name of given variable DIE
 956  * @vr_die: a variable DIE
 957  * @buf: a strbuf for result type name
 958  *
 959  * Get the name of @vr_die and stores it to @buf. Return 0 if succeeded.
 960  * and Return -ENOENT if failed to find type name.
 961  * Note that the result will stores typedef name if possible, and stores
 962  * "*(function_type)" if the type is a function pointer.
 963  */
 964 int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf)
 965 {
 966         Dwarf_Die type;
 967         int tag, ret;
 968         const char *tmp = "";
 969
 970         if (__die_get_real_type(vr_die, &type) == NULL)
 971                 return -ENOENT;
 972
 973         tag = dwarf_tag(&type);
 974         if (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)
 975                 tmp = "*";
 976         else if (tag == DW_TAG_subroutine_type) {
 977                 /* Function pointer */
 978                 strbuf_addf(buf, "(function_type)");
 979                 return 0;
 980         } else {
 981                 if (!dwarf_diename(&type))
 982                         return -ENOENT;
 983                 if (tag == DW_TAG_union_type)
 984                         tmp = "union ";
 985                 else if (tag == DW_TAG_structure_type)
 986                         tmp = "struct ";
 987                 else if (tag == DW_TAG_enumeration_type)
 988                         tmp = "enum ";
 989                 /* Write a base name */
 990                 strbuf_addf(buf, "%s%s", tmp, dwarf_diename(&type));
 991                 return 0;
 992         }
 993         ret = die_get_typename(&type, buf);
 994         if (ret == 0)
 995                 strbuf_addf(buf, "%s", tmp);
 996
 997         return ret;
 998 }
 999
1000 /**
1001  * die_get_varname - Get the name and type of given variable DIE
1002  * @vr_die: a variable DIE
1003  * @buf: a strbuf for type and variable name
1004  *
1005  * Get the name and type of @vr_die and stores it in @buf as "type\tname".
1006  */
1007 int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf)
1008 {
1009         int ret;
1010
1011         ret = die_get_typename(vr_die, buf);
1012         if (ret < 0) {
1013                 pr_debug("Failed to get type, make it unknown.\n");
1014                 strbuf_addf(buf, "(unknown_type)");
1015         }
1016
1017         strbuf_addf(buf, "\t%s", dwarf_diename(vr_die));
1018
1019         return 0;
1020 }
1021
1022 /**
1023  * die_get_var_innermost_scope - Get innermost scope range of given variable DIE
1024  * @sp_die: a subprogram DIE
1025  * @vr_die: a variable DIE
1026  * @buf: a strbuf for variable byte offset range
1027  *
1028  * Get the innermost scope range of @vr_die and stores it in @buf as
1029  * "@<function_name+[NN-NN,NN-NN]>".
1030  */
1031 static int die_get_var_innermost_scope(Dwarf_Die *sp_die, Dwarf_Die *vr_die,
1032                                 struct strbuf *buf)
1033 {
1034         Dwarf_Die *scopes;
1035         int count;
1036         size_t offset = 0;
1037         Dwarf_Addr base;
1038         Dwarf_Addr start, end;
1039         Dwarf_Addr entry;
1040         int ret;
1041         bool first = true;
1042         const char *name;
1043
1044         ret = die_entrypc(sp_die, &entry);
1045         if (ret)
1046                 return ret;
1047
1048         name = dwarf_diename(sp_die);
1049         if (!name)
1050                 return -ENOENT;
1051
1052         count = dwarf_getscopes_die(vr_die, &scopes);
1053
1054         /* (*SCOPES)[1] is the DIE for the scope containing that scope */
1055         if (count <= 1) {
1056                 ret = -EINVAL;
1057                 goto out;
1058         }
1059
1060         while ((offset = dwarf_ranges(&scopes[1], offset, &base,
1061                                 &start, &end)) > 0) {
1062                 start -= entry;
1063                 end -= entry;
1064
1065                 if (first) {
1066                         strbuf_addf(buf, "@<%s+[%" PRIu64 "-%" PRIu64,
1067                                 name, start, end);
1068                         first = false;
1069                 } else {
1070                         strbuf_addf(buf, ",%" PRIu64 "-%" PRIu64,
1071                                 start, end);
1072                 }
1073         }
1074
1075         if (!first)
1076                 strbuf_addf(buf, "]>");
1077
1078 out:
1079         free(scopes);
1080         return ret;
1081 }
1082
1083 /**
1084  * die_get_var_range - Get byte offset range of given variable DIE
1085  * @sp_die: a subprogram DIE
1086  * @vr_die: a variable DIE
1087  * @buf: a strbuf for type and variable name and byte offset range
1088  *
1089  * Get the byte offset range of @vr_die and stores it in @buf as
1090  * "@<function_name+[NN-NN,NN-NN]>".
1091  */
1092 int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf)
1093 {
1094         int ret = 0;
1095         Dwarf_Addr base;
1096         Dwarf_Addr start, end;
1097         Dwarf_Addr entry;
1098         Dwarf_Op *op;
1099         size_t nops;
1100         size_t offset = 0;
1101         Dwarf_Attribute attr;
1102         bool first = true;
1103         const char *name;
1104
1105         ret = die_entrypc(sp_die, &entry);
1106         if (ret)
1107                 return ret;
1108
1109         name = dwarf_diename(sp_die);
1110         if (!name)
1111                 return -ENOENT;
1112
1113         if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
1114                 return -EINVAL;
1115
1116         while ((offset = dwarf_getlocations(
1117                                 &attr, offset, &base,
1118                                 &start, &end, &op, &nops)) > 0) {
1119                 if (start == 0) {
1120                         /* Single Location Descriptions */
1121                         ret = die_get_var_innermost_scope(sp_die, vr_die, buf);
1122                         return ret;
1123                 }
1124
1125                 /* Location Lists */
1126                 start -= entry;
1127                 end -= entry;
1128                 if (first) {
1129                         strbuf_addf(buf, "@<%s+[%" PRIu64 "-%" PRIu64,
1130                                 name, start, end);
1131                         first = false;
1132                 } else {
1133                         strbuf_addf(buf, ",%" PRIu64 "-%" PRIu64,
1134                                 start, end);
1135                 }
1136         }
1137
1138         if (!first)
1139                 strbuf_addf(buf, "]>");
1140
1141         return ret;
1142 }