dwarf-aux.c 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905
  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. #include <stdbool.h>
  20. #include "util.h"
  21. #include "debug.h"
  22. #include "dwarf-aux.h"
  23. /**
  24. * cu_find_realpath - Find the realpath of the target file
  25. * @cu_die: A DIE(dwarf information entry) of CU(compilation Unit)
  26. * @fname: The tail filename of the target file
  27. *
  28. * Find the real(long) path of @fname in @cu_die.
  29. */
  30. const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname)
  31. {
  32. Dwarf_Files *files;
  33. size_t nfiles, i;
  34. const char *src = NULL;
  35. int ret;
  36. if (!fname)
  37. return NULL;
  38. ret = dwarf_getsrcfiles(cu_die, &files, &nfiles);
  39. if (ret != 0)
  40. return NULL;
  41. for (i = 0; i < nfiles; i++) {
  42. src = dwarf_filesrc(files, i, NULL, NULL);
  43. if (strtailcmp(src, fname) == 0)
  44. break;
  45. }
  46. if (i == nfiles)
  47. return NULL;
  48. return src;
  49. }
  50. /**
  51. * cu_get_comp_dir - Get the path of compilation directory
  52. * @cu_die: a CU DIE
  53. *
  54. * Get the path of compilation directory of given @cu_die.
  55. * Since this depends on DW_AT_comp_dir, older gcc will not
  56. * embedded it. In that case, this returns NULL.
  57. */
  58. const char *cu_get_comp_dir(Dwarf_Die *cu_die)
  59. {
  60. Dwarf_Attribute attr;
  61. if (dwarf_attr(cu_die, DW_AT_comp_dir, &attr) == NULL)
  62. return NULL;
  63. return dwarf_formstring(&attr);
  64. }
  65. /**
  66. * cu_find_lineinfo - Get a line number and file name for given address
  67. * @cu_die: a CU DIE
  68. * @addr: An address
  69. * @fname: a pointer which returns the file name string
  70. * @lineno: a pointer which returns the line number
  71. *
  72. * Find a line number and file name for @addr in @cu_die.
  73. */
  74. int cu_find_lineinfo(Dwarf_Die *cu_die, unsigned long addr,
  75. const char **fname, int *lineno)
  76. {
  77. Dwarf_Line *line;
  78. Dwarf_Addr laddr;
  79. line = dwarf_getsrc_die(cu_die, (Dwarf_Addr)addr);
  80. if (line && dwarf_lineaddr(line, &laddr) == 0 &&
  81. addr == (unsigned long)laddr && dwarf_lineno(line, lineno) == 0) {
  82. *fname = dwarf_linesrc(line, NULL, NULL);
  83. if (!*fname)
  84. /* line number is useless without filename */
  85. *lineno = 0;
  86. }
  87. return *lineno ?: -ENOENT;
  88. }
  89. static int __die_find_inline_cb(Dwarf_Die *die_mem, void *data);
  90. /**
  91. * cu_walk_functions_at - Walk on function DIEs at given address
  92. * @cu_die: A CU DIE
  93. * @addr: An address
  94. * @callback: A callback which called with found DIEs
  95. * @data: A user data
  96. *
  97. * Walk on function DIEs at given @addr in @cu_die. Passed DIEs
  98. * should be subprogram or inlined-subroutines.
  99. */
  100. int cu_walk_functions_at(Dwarf_Die *cu_die, Dwarf_Addr addr,
  101. int (*callback)(Dwarf_Die *, void *), void *data)
  102. {
  103. Dwarf_Die die_mem;
  104. Dwarf_Die *sc_die;
  105. int ret = -ENOENT;
  106. /* Inlined function could be recursive. Trace it until fail */
  107. for (sc_die = die_find_realfunc(cu_die, addr, &die_mem);
  108. sc_die != NULL;
  109. sc_die = die_find_child(sc_die, __die_find_inline_cb, &addr,
  110. &die_mem)) {
  111. ret = callback(sc_die, data);
  112. if (ret)
  113. break;
  114. }
  115. return ret;
  116. }
  117. /**
  118. * die_compare_name - Compare diename and tname
  119. * @dw_die: a DIE
  120. * @tname: a string of target name
  121. *
  122. * Compare the name of @dw_die and @tname. Return false if @dw_die has no name.
  123. */
  124. bool die_compare_name(Dwarf_Die *dw_die, const char *tname)
  125. {
  126. const char *name;
  127. name = dwarf_diename(dw_die);
  128. return name ? (strcmp(tname, name) == 0) : false;
  129. }
  130. /**
  131. * die_get_call_lineno - Get callsite line number of inline-function instance
  132. * @in_die: a DIE of an inlined function instance
  133. *
  134. * Get call-site line number of @in_die. This means from where the inline
  135. * function is called.
  136. */
  137. int die_get_call_lineno(Dwarf_Die *in_die)
  138. {
  139. Dwarf_Attribute attr;
  140. Dwarf_Word ret;
  141. if (!dwarf_attr(in_die, DW_AT_call_line, &attr))
  142. return -ENOENT;
  143. dwarf_formudata(&attr, &ret);
  144. return (int)ret;
  145. }
  146. /**
  147. * die_get_type - Get type DIE
  148. * @vr_die: a DIE of a variable
  149. * @die_mem: where to store a type DIE
  150. *
  151. * Get a DIE of the type of given variable (@vr_die), and store
  152. * it to die_mem. Return NULL if fails to get a type DIE.
  153. */
  154. Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
  155. {
  156. Dwarf_Attribute attr;
  157. if (dwarf_attr_integrate(vr_die, DW_AT_type, &attr) &&
  158. dwarf_formref_die(&attr, die_mem))
  159. return die_mem;
  160. else
  161. return NULL;
  162. }
  163. /* Get a type die, but skip qualifiers */
  164. static Dwarf_Die *__die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
  165. {
  166. int tag;
  167. do {
  168. vr_die = die_get_type(vr_die, die_mem);
  169. if (!vr_die)
  170. break;
  171. tag = dwarf_tag(vr_die);
  172. } while (tag == DW_TAG_const_type ||
  173. tag == DW_TAG_restrict_type ||
  174. tag == DW_TAG_volatile_type ||
  175. tag == DW_TAG_shared_type);
  176. return vr_die;
  177. }
  178. /**
  179. * die_get_real_type - Get a type die, but skip qualifiers and typedef
  180. * @vr_die: a DIE of a variable
  181. * @die_mem: where to store a type DIE
  182. *
  183. * Get a DIE of the type of given variable (@vr_die), and store
  184. * it to die_mem. Return NULL if fails to get a type DIE.
  185. * If the type is qualifiers (e.g. const) or typedef, this skips it
  186. * and tries to find real type (structure or basic types, e.g. int).
  187. */
  188. Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
  189. {
  190. do {
  191. vr_die = __die_get_real_type(vr_die, die_mem);
  192. } while (vr_die && dwarf_tag(vr_die) == DW_TAG_typedef);
  193. return vr_die;
  194. }
  195. /* Get attribute and translate it as a udata */
  196. static int die_get_attr_udata(Dwarf_Die *tp_die, unsigned int attr_name,
  197. Dwarf_Word *result)
  198. {
  199. Dwarf_Attribute attr;
  200. if (dwarf_attr(tp_die, attr_name, &attr) == NULL ||
  201. dwarf_formudata(&attr, result) != 0)
  202. return -ENOENT;
  203. return 0;
  204. }
  205. /* Get attribute and translate it as a sdata */
  206. static int die_get_attr_sdata(Dwarf_Die *tp_die, unsigned int attr_name,
  207. Dwarf_Sword *result)
  208. {
  209. Dwarf_Attribute attr;
  210. if (dwarf_attr(tp_die, attr_name, &attr) == NULL ||
  211. dwarf_formsdata(&attr, result) != 0)
  212. return -ENOENT;
  213. return 0;
  214. }
  215. /**
  216. * die_is_signed_type - Check whether a type DIE is signed or not
  217. * @tp_die: a DIE of a type
  218. *
  219. * Get the encoding of @tp_die and return true if the encoding
  220. * is signed.
  221. */
  222. bool die_is_signed_type(Dwarf_Die *tp_die)
  223. {
  224. Dwarf_Word ret;
  225. if (die_get_attr_udata(tp_die, DW_AT_encoding, &ret))
  226. return false;
  227. return (ret == DW_ATE_signed_char || ret == DW_ATE_signed ||
  228. ret == DW_ATE_signed_fixed);
  229. }
  230. /**
  231. * die_is_func_def - Ensure that this DIE is a subprogram and definition
  232. * @dw_die: a DIE
  233. *
  234. * Ensure that this DIE is a subprogram and NOT a declaration. This
  235. * returns true if @dw_die is a function definition.
  236. **/
  237. bool die_is_func_def(Dwarf_Die *dw_die)
  238. {
  239. Dwarf_Attribute attr;
  240. return (dwarf_tag(dw_die) == DW_TAG_subprogram &&
  241. dwarf_attr(dw_die, DW_AT_declaration, &attr) == NULL);
  242. }
  243. /**
  244. * die_is_func_instance - Ensure that this DIE is an instance of a subprogram
  245. * @dw_die: a DIE
  246. *
  247. * Ensure that this DIE is an instance (which has an entry address).
  248. * This returns true if @dw_die is a function instance. If not, you need to
  249. * call die_walk_instances() to find actual instances.
  250. **/
  251. bool die_is_func_instance(Dwarf_Die *dw_die)
  252. {
  253. Dwarf_Addr tmp;
  254. /* Actually gcc optimizes non-inline as like as inlined */
  255. return !dwarf_func_inline(dw_die) && dwarf_entrypc(dw_die, &tmp) == 0;
  256. }
  257. /**
  258. * die_get_data_member_location - Get the data-member offset
  259. * @mb_die: a DIE of a member of a data structure
  260. * @offs: The offset of the member in the data structure
  261. *
  262. * Get the offset of @mb_die in the data structure including @mb_die, and
  263. * stores result offset to @offs. If any error occurs this returns errno.
  264. */
  265. int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs)
  266. {
  267. Dwarf_Attribute attr;
  268. Dwarf_Op *expr;
  269. size_t nexpr;
  270. int ret;
  271. if (dwarf_attr(mb_die, DW_AT_data_member_location, &attr) == NULL)
  272. return -ENOENT;
  273. if (dwarf_formudata(&attr, offs) != 0) {
  274. /* DW_AT_data_member_location should be DW_OP_plus_uconst */
  275. ret = dwarf_getlocation(&attr, &expr, &nexpr);
  276. if (ret < 0 || nexpr == 0)
  277. return -ENOENT;
  278. if (expr[0].atom != DW_OP_plus_uconst || nexpr != 1) {
  279. pr_debug("Unable to get offset:Unexpected OP %x (%zd)\n",
  280. expr[0].atom, nexpr);
  281. return -ENOTSUP;
  282. }
  283. *offs = (Dwarf_Word)expr[0].number;
  284. }
  285. return 0;
  286. }
  287. /* Get the call file index number in CU DIE */
  288. static int die_get_call_fileno(Dwarf_Die *in_die)
  289. {
  290. Dwarf_Sword idx;
  291. if (die_get_attr_sdata(in_die, DW_AT_call_file, &idx) == 0)
  292. return (int)idx;
  293. else
  294. return -ENOENT;
  295. }
  296. /* Get the declared file index number in CU DIE */
  297. static int die_get_decl_fileno(Dwarf_Die *pdie)
  298. {
  299. Dwarf_Sword idx;
  300. if (die_get_attr_sdata(pdie, DW_AT_decl_file, &idx) == 0)
  301. return (int)idx;
  302. else
  303. return -ENOENT;
  304. }
  305. /**
  306. * die_get_call_file - Get callsite file name of inlined function instance
  307. * @in_die: a DIE of an inlined function instance
  308. *
  309. * Get call-site file name of @in_die. This means from which file the inline
  310. * function is called.
  311. */
  312. const char *die_get_call_file(Dwarf_Die *in_die)
  313. {
  314. Dwarf_Die cu_die;
  315. Dwarf_Files *files;
  316. int idx;
  317. idx = die_get_call_fileno(in_die);
  318. if (idx < 0 || !dwarf_diecu(in_die, &cu_die, NULL, NULL) ||
  319. dwarf_getsrcfiles(&cu_die, &files, NULL) != 0)
  320. return NULL;
  321. return dwarf_filesrc(files, idx, NULL, NULL);
  322. }
  323. /**
  324. * die_find_child - Generic DIE search function in DIE tree
  325. * @rt_die: a root DIE
  326. * @callback: a callback function
  327. * @data: a user data passed to the callback function
  328. * @die_mem: a buffer for result DIE
  329. *
  330. * Trace DIE tree from @rt_die and call @callback for each child DIE.
  331. * If @callback returns DIE_FIND_CB_END, this stores the DIE into
  332. * @die_mem and returns it. If @callback returns DIE_FIND_CB_CONTINUE,
  333. * this continues to trace the tree. Optionally, @callback can return
  334. * DIE_FIND_CB_CHILD and DIE_FIND_CB_SIBLING, those means trace only
  335. * the children and trace only the siblings respectively.
  336. * Returns NULL if @callback can't find any appropriate DIE.
  337. */
  338. Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
  339. int (*callback)(Dwarf_Die *, void *),
  340. void *data, Dwarf_Die *die_mem)
  341. {
  342. Dwarf_Die child_die;
  343. int ret;
  344. ret = dwarf_child(rt_die, die_mem);
  345. if (ret != 0)
  346. return NULL;
  347. do {
  348. ret = callback(die_mem, data);
  349. if (ret == DIE_FIND_CB_END)
  350. return die_mem;
  351. if ((ret & DIE_FIND_CB_CHILD) &&
  352. die_find_child(die_mem, callback, data, &child_die)) {
  353. memcpy(die_mem, &child_die, sizeof(Dwarf_Die));
  354. return die_mem;
  355. }
  356. } while ((ret & DIE_FIND_CB_SIBLING) &&
  357. dwarf_siblingof(die_mem, die_mem) == 0);
  358. return NULL;
  359. }
  360. struct __addr_die_search_param {
  361. Dwarf_Addr addr;
  362. Dwarf_Die *die_mem;
  363. };
  364. /* die_find callback for non-inlined function search */
  365. static int __die_search_func_cb(Dwarf_Die *fn_die, void *data)
  366. {
  367. struct __addr_die_search_param *ad = data;
  368. /*
  369. * Since a declaration entry doesn't has given pc, this always returns
  370. * function definition entry.
  371. */
  372. if (dwarf_tag(fn_die) == DW_TAG_subprogram &&
  373. dwarf_haspc(fn_die, ad->addr)) {
  374. memcpy(ad->die_mem, fn_die, sizeof(Dwarf_Die));
  375. return DWARF_CB_ABORT;
  376. }
  377. return DWARF_CB_OK;
  378. }
  379. /**
  380. * die_find_realfunc - Search a non-inlined function at given address
  381. * @cu_die: a CU DIE which including @addr
  382. * @addr: target address
  383. * @die_mem: a buffer for result DIE
  384. *
  385. * Search a non-inlined function DIE which includes @addr. Stores the
  386. * DIE to @die_mem and returns it if found. Returns NULL if failed.
  387. */
  388. Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
  389. Dwarf_Die *die_mem)
  390. {
  391. struct __addr_die_search_param ad;
  392. ad.addr = addr;
  393. ad.die_mem = die_mem;
  394. /* dwarf_getscopes can't find subprogram. */
  395. if (!dwarf_getfuncs(cu_die, __die_search_func_cb, &ad, 0))
  396. return NULL;
  397. else
  398. return die_mem;
  399. }
  400. /* die_find callback for inline function search */
  401. static int __die_find_inline_cb(Dwarf_Die *die_mem, void *data)
  402. {
  403. Dwarf_Addr *addr = data;
  404. if (dwarf_tag(die_mem) == DW_TAG_inlined_subroutine &&
  405. dwarf_haspc(die_mem, *addr))
  406. return DIE_FIND_CB_END;
  407. return DIE_FIND_CB_CONTINUE;
  408. }
  409. /**
  410. * die_find_top_inlinefunc - Search the top inlined function at given address
  411. * @sp_die: a subprogram DIE which including @addr
  412. * @addr: target address
  413. * @die_mem: a buffer for result DIE
  414. *
  415. * Search an inlined function DIE which includes @addr. Stores the
  416. * DIE to @die_mem and returns it if found. Returns NULL if failed.
  417. * Even if several inlined functions are expanded recursively, this
  418. * doesn't trace it down, and returns the topmost one.
  419. */
  420. Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
  421. Dwarf_Die *die_mem)
  422. {
  423. return die_find_child(sp_die, __die_find_inline_cb, &addr, die_mem);
  424. }
  425. /**
  426. * die_find_inlinefunc - Search an inlined function at given address
  427. * @sp_die: a subprogram DIE which including @addr
  428. * @addr: target address
  429. * @die_mem: a buffer for result DIE
  430. *
  431. * Search an inlined function DIE which includes @addr. Stores the
  432. * DIE to @die_mem and returns it if found. Returns NULL if failed.
  433. * If several inlined functions are expanded recursively, this trace
  434. * it down and returns deepest one.
  435. */
  436. Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
  437. Dwarf_Die *die_mem)
  438. {
  439. Dwarf_Die tmp_die;
  440. sp_die = die_find_child(sp_die, __die_find_inline_cb, &addr, &tmp_die);
  441. if (!sp_die)
  442. return NULL;
  443. /* Inlined function could be recursive. Trace it until fail */
  444. while (sp_die) {
  445. memcpy(die_mem, sp_die, sizeof(Dwarf_Die));
  446. sp_die = die_find_child(sp_die, __die_find_inline_cb, &addr,
  447. &tmp_die);
  448. }
  449. return die_mem;
  450. }
  451. struct __instance_walk_param {
  452. void *addr;
  453. int (*callback)(Dwarf_Die *, void *);
  454. void *data;
  455. int retval;
  456. };
  457. static int __die_walk_instances_cb(Dwarf_Die *inst, void *data)
  458. {
  459. struct __instance_walk_param *iwp = data;
  460. Dwarf_Attribute attr_mem;
  461. Dwarf_Die origin_mem;
  462. Dwarf_Attribute *attr;
  463. Dwarf_Die *origin;
  464. int tmp;
  465. attr = dwarf_attr(inst, DW_AT_abstract_origin, &attr_mem);
  466. if (attr == NULL)
  467. return DIE_FIND_CB_CONTINUE;
  468. origin = dwarf_formref_die(attr, &origin_mem);
  469. if (origin == NULL || origin->addr != iwp->addr)
  470. return DIE_FIND_CB_CONTINUE;
  471. /* Ignore redundant instances */
  472. if (dwarf_tag(inst) == DW_TAG_inlined_subroutine) {
  473. dwarf_decl_line(origin, &tmp);
  474. if (die_get_call_lineno(inst) == tmp) {
  475. tmp = die_get_decl_fileno(origin);
  476. if (die_get_call_fileno(inst) == tmp)
  477. return DIE_FIND_CB_CONTINUE;
  478. }
  479. }
  480. iwp->retval = iwp->callback(inst, iwp->data);
  481. return (iwp->retval) ? DIE_FIND_CB_END : DIE_FIND_CB_CONTINUE;
  482. }
  483. /**
  484. * die_walk_instances - Walk on instances of given DIE
  485. * @or_die: an abstract original DIE
  486. * @callback: a callback function which is called with instance DIE
  487. * @data: user data
  488. *
  489. * Walk on the instances of give @in_die. @in_die must be an inlined function
  490. * declartion. This returns the return value of @callback if it returns
  491. * non-zero value, or -ENOENT if there is no instance.
  492. */
  493. int die_walk_instances(Dwarf_Die *or_die, int (*callback)(Dwarf_Die *, void *),
  494. void *data)
  495. {
  496. Dwarf_Die cu_die;
  497. Dwarf_Die die_mem;
  498. struct __instance_walk_param iwp = {
  499. .addr = or_die->addr,
  500. .callback = callback,
  501. .data = data,
  502. .retval = -ENOENT,
  503. };
  504. if (dwarf_diecu(or_die, &cu_die, NULL, NULL) == NULL)
  505. return -ENOENT;
  506. die_find_child(&cu_die, __die_walk_instances_cb, &iwp, &die_mem);
  507. return iwp.retval;
  508. }
  509. /* Line walker internal parameters */
  510. struct __line_walk_param {
  511. bool recursive;
  512. line_walk_callback_t callback;
  513. void *data;
  514. int retval;
  515. };
  516. static int __die_walk_funclines_cb(Dwarf_Die *in_die, void *data)
  517. {
  518. struct __line_walk_param *lw = data;
  519. Dwarf_Addr addr = 0;
  520. const char *fname;
  521. int lineno;
  522. if (dwarf_tag(in_die) == DW_TAG_inlined_subroutine) {
  523. fname = die_get_call_file(in_die);
  524. lineno = die_get_call_lineno(in_die);
  525. if (fname && lineno > 0 && dwarf_entrypc(in_die, &addr) == 0) {
  526. lw->retval = lw->callback(fname, lineno, addr, lw->data);
  527. if (lw->retval != 0)
  528. return DIE_FIND_CB_END;
  529. }
  530. }
  531. if (!lw->recursive)
  532. /* Don't need to search recursively */
  533. return DIE_FIND_CB_SIBLING;
  534. if (addr) {
  535. fname = dwarf_decl_file(in_die);
  536. if (fname && dwarf_decl_line(in_die, &lineno) == 0) {
  537. lw->retval = lw->callback(fname, lineno, addr, lw->data);
  538. if (lw->retval != 0)
  539. return DIE_FIND_CB_END;
  540. }
  541. }
  542. /* Continue to search nested inlined function call-sites */
  543. return DIE_FIND_CB_CONTINUE;
  544. }
  545. /* Walk on lines of blocks included in given DIE */
  546. static int __die_walk_funclines(Dwarf_Die *sp_die, bool recursive,
  547. line_walk_callback_t callback, void *data)
  548. {
  549. struct __line_walk_param lw = {
  550. .recursive = recursive,
  551. .callback = callback,
  552. .data = data,
  553. .retval = 0,
  554. };
  555. Dwarf_Die die_mem;
  556. Dwarf_Addr addr;
  557. const char *fname;
  558. int lineno;
  559. /* Handle function declaration line */
  560. fname = dwarf_decl_file(sp_die);
  561. if (fname && dwarf_decl_line(sp_die, &lineno) == 0 &&
  562. dwarf_entrypc(sp_die, &addr) == 0) {
  563. lw.retval = callback(fname, lineno, addr, data);
  564. if (lw.retval != 0)
  565. goto done;
  566. }
  567. die_find_child(sp_die, __die_walk_funclines_cb, &lw, &die_mem);
  568. done:
  569. return lw.retval;
  570. }
  571. static int __die_walk_culines_cb(Dwarf_Die *sp_die, void *data)
  572. {
  573. struct __line_walk_param *lw = data;
  574. lw->retval = __die_walk_funclines(sp_die, true, lw->callback, lw->data);
  575. if (lw->retval != 0)
  576. return DWARF_CB_ABORT;
  577. return DWARF_CB_OK;
  578. }
  579. /**
  580. * die_walk_lines - Walk on lines inside given DIE
  581. * @rt_die: a root DIE (CU, subprogram or inlined_subroutine)
  582. * @callback: callback routine
  583. * @data: user data
  584. *
  585. * Walk on all lines inside given @rt_die and call @callback on each line.
  586. * If the @rt_die is a function, walk only on the lines inside the function,
  587. * otherwise @rt_die must be a CU DIE.
  588. * Note that this walks not only dwarf line list, but also function entries
  589. * and inline call-site.
  590. */
  591. int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data)
  592. {
  593. Dwarf_Lines *lines;
  594. Dwarf_Line *line;
  595. Dwarf_Addr addr;
  596. const char *fname;
  597. int lineno, ret = 0;
  598. Dwarf_Die die_mem, *cu_die;
  599. size_t nlines, i;
  600. /* Get the CU die */
  601. if (dwarf_tag(rt_die) != DW_TAG_compile_unit)
  602. cu_die = dwarf_diecu(rt_die, &die_mem, NULL, NULL);
  603. else
  604. cu_die = rt_die;
  605. if (!cu_die) {
  606. pr_debug2("Failed to get CU from given DIE.\n");
  607. return -EINVAL;
  608. }
  609. /* Get lines list in the CU */
  610. if (dwarf_getsrclines(cu_die, &lines, &nlines) != 0) {
  611. pr_debug2("Failed to get source lines on this CU.\n");
  612. return -ENOENT;
  613. }
  614. pr_debug2("Get %zd lines from this CU\n", nlines);
  615. /* Walk on the lines on lines list */
  616. for (i = 0; i < nlines; i++) {
  617. line = dwarf_onesrcline(lines, i);
  618. if (line == NULL ||
  619. dwarf_lineno(line, &lineno) != 0 ||
  620. dwarf_lineaddr(line, &addr) != 0) {
  621. pr_debug2("Failed to get line info. "
  622. "Possible error in debuginfo.\n");
  623. continue;
  624. }
  625. /* Filter lines based on address */
  626. if (rt_die != cu_die)
  627. /*
  628. * Address filtering
  629. * The line is included in given function, and
  630. * no inline block includes it.
  631. */
  632. if (!dwarf_haspc(rt_die, addr) ||
  633. die_find_inlinefunc(rt_die, addr, &die_mem))
  634. continue;
  635. /* Get source line */
  636. fname = dwarf_linesrc(line, NULL, NULL);
  637. ret = callback(fname, lineno, addr, data);
  638. if (ret != 0)
  639. return ret;
  640. }
  641. /*
  642. * Dwarf lines doesn't include function declarations and inlined
  643. * subroutines. We have to check functions list or given function.
  644. */
  645. if (rt_die != cu_die)
  646. /*
  647. * Don't need walk functions recursively, because nested
  648. * inlined functions don't have lines of the specified DIE.
  649. */
  650. ret = __die_walk_funclines(rt_die, false, callback, data);
  651. else {
  652. struct __line_walk_param param = {
  653. .callback = callback,
  654. .data = data,
  655. .retval = 0,
  656. };
  657. dwarf_getfuncs(cu_die, __die_walk_culines_cb, &param, 0);
  658. ret = param.retval;
  659. }
  660. return ret;
  661. }
  662. struct __find_variable_param {
  663. const char *name;
  664. Dwarf_Addr addr;
  665. };
  666. static int __die_find_variable_cb(Dwarf_Die *die_mem, void *data)
  667. {
  668. struct __find_variable_param *fvp = data;
  669. Dwarf_Attribute attr;
  670. int tag;
  671. tag = dwarf_tag(die_mem);
  672. if ((tag == DW_TAG_formal_parameter ||
  673. tag == DW_TAG_variable) &&
  674. die_compare_name(die_mem, fvp->name) &&
  675. /* Does the DIE have location information or external instance? */
  676. (dwarf_attr(die_mem, DW_AT_external, &attr) ||
  677. dwarf_attr(die_mem, DW_AT_location, &attr)))
  678. return DIE_FIND_CB_END;
  679. if (dwarf_haspc(die_mem, fvp->addr))
  680. return DIE_FIND_CB_CONTINUE;
  681. else
  682. return DIE_FIND_CB_SIBLING;
  683. }
  684. /**
  685. * die_find_variable_at - Find a given name variable at given address
  686. * @sp_die: a function DIE
  687. * @name: variable name
  688. * @addr: address
  689. * @die_mem: a buffer for result DIE
  690. *
  691. * Find a variable DIE called @name at @addr in @sp_die.
  692. */
  693. Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
  694. Dwarf_Addr addr, Dwarf_Die *die_mem)
  695. {
  696. struct __find_variable_param fvp = { .name = name, .addr = addr};
  697. return die_find_child(sp_die, __die_find_variable_cb, (void *)&fvp,
  698. die_mem);
  699. }
  700. static int __die_find_member_cb(Dwarf_Die *die_mem, void *data)
  701. {
  702. const char *name = data;
  703. if (dwarf_tag(die_mem) == DW_TAG_member) {
  704. if (die_compare_name(die_mem, name))
  705. return DIE_FIND_CB_END;
  706. else if (!dwarf_diename(die_mem)) { /* Unnamed structure */
  707. Dwarf_Die type_die, tmp_die;
  708. if (die_get_type(die_mem, &type_die) &&
  709. die_find_member(&type_die, name, &tmp_die))
  710. return DIE_FIND_CB_END;
  711. }
  712. }
  713. return DIE_FIND_CB_SIBLING;
  714. }
  715. /**
  716. * die_find_member - Find a given name member in a data structure
  717. * @st_die: a data structure type DIE
  718. * @name: member name
  719. * @die_mem: a buffer for result DIE
  720. *
  721. * Find a member DIE called @name in @st_die.
  722. */
  723. Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
  724. Dwarf_Die *die_mem)
  725. {
  726. return die_find_child(st_die, __die_find_member_cb, (void *)name,
  727. die_mem);
  728. }
  729. /**
  730. * die_get_typename - Get the name of given variable DIE
  731. * @vr_die: a variable DIE
  732. * @buf: a buffer for result type name
  733. * @len: a max-length of @buf
  734. *
  735. * Get the name of @vr_die and stores it to @buf. Return the actual length
  736. * of type name if succeeded. Return -E2BIG if @len is not enough long, and
  737. * Return -ENOENT if failed to find type name.
  738. * Note that the result will stores typedef name if possible, and stores
  739. * "*(function_type)" if the type is a function pointer.
  740. */
  741. int die_get_typename(Dwarf_Die *vr_die, char *buf, int len)
  742. {
  743. Dwarf_Die type;
  744. int tag, ret, ret2;
  745. const char *tmp = "";
  746. if (__die_get_real_type(vr_die, &type) == NULL)
  747. return -ENOENT;
  748. tag = dwarf_tag(&type);
  749. if (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)
  750. tmp = "*";
  751. else if (tag == DW_TAG_subroutine_type) {
  752. /* Function pointer */
  753. ret = snprintf(buf, len, "(function_type)");
  754. return (ret >= len) ? -E2BIG : ret;
  755. } else {
  756. if (!dwarf_diename(&type))
  757. return -ENOENT;
  758. if (tag == DW_TAG_union_type)
  759. tmp = "union ";
  760. else if (tag == DW_TAG_structure_type)
  761. tmp = "struct ";
  762. else if (tag == DW_TAG_enumeration_type)
  763. tmp = "enum ";
  764. /* Write a base name */
  765. ret = snprintf(buf, len, "%s%s", tmp, dwarf_diename(&type));
  766. return (ret >= len) ? -E2BIG : ret;
  767. }
  768. ret = die_get_typename(&type, buf, len);
  769. if (ret > 0) {
  770. ret2 = snprintf(buf + ret, len - ret, "%s", tmp);
  771. ret = (ret2 >= len - ret) ? -E2BIG : ret2 + ret;
  772. }
  773. return ret;
  774. }
  775. /**
  776. * die_get_varname - Get the name and type of given variable DIE
  777. * @vr_die: a variable DIE
  778. * @buf: a buffer for type and variable name
  779. * @len: the max-length of @buf
  780. *
  781. * Get the name and type of @vr_die and stores it in @buf as "type\tname".
  782. */
  783. int die_get_varname(Dwarf_Die *vr_die, char *buf, int len)
  784. {
  785. int ret, ret2;
  786. ret = die_get_typename(vr_die, buf, len);
  787. if (ret < 0) {
  788. pr_debug("Failed to get type, make it unknown.\n");
  789. ret = snprintf(buf, len, "(unknown_type)");
  790. }
  791. if (ret > 0) {
  792. ret2 = snprintf(buf + ret, len - ret, "\t%s",
  793. dwarf_diename(vr_die));
  794. ret = (ret2 >= len - ret) ? -E2BIG : ret2 + ret;
  795. }
  796. return ret;
  797. }