probe-finder.c 43 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739
  1. /*
  2. * probe-finder.c : C expression to kprobe event converter
  3. *
  4. * Written by Masami Hiramatsu <mhiramat@redhat.com>
  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 2 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, write to the Free Software
  18. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19. *
  20. */
  21. #include <sys/utsname.h>
  22. #include <sys/types.h>
  23. #include <sys/stat.h>
  24. #include <fcntl.h>
  25. #include <errno.h>
  26. #include <stdio.h>
  27. #include <unistd.h>
  28. #include <stdlib.h>
  29. #include <string.h>
  30. #include <stdarg.h>
  31. #include <dwarf-regs.h>
  32. #include <linux/bitops.h>
  33. #include "event.h"
  34. #include "dso.h"
  35. #include "debug.h"
  36. #include "intlist.h"
  37. #include "util.h"
  38. #include "symbol.h"
  39. #include "probe-finder.h"
  40. /* Kprobe tracer basic type is up to u64 */
  41. #define MAX_BASIC_TYPE_BITS 64
  42. /* Dwarf FL wrappers */
  43. static char *debuginfo_path; /* Currently dummy */
  44. static const Dwfl_Callbacks offline_callbacks = {
  45. .find_debuginfo = dwfl_standard_find_debuginfo,
  46. .debuginfo_path = &debuginfo_path,
  47. .section_address = dwfl_offline_section_address,
  48. /* We use this table for core files too. */
  49. .find_elf = dwfl_build_id_find_elf,
  50. };
  51. /* Get a Dwarf from offline image */
  52. static int debuginfo__init_offline_dwarf(struct debuginfo *dbg,
  53. const char *path)
  54. {
  55. int fd;
  56. fd = open(path, O_RDONLY);
  57. if (fd < 0)
  58. return fd;
  59. dbg->dwfl = dwfl_begin(&offline_callbacks);
  60. if (!dbg->dwfl)
  61. goto error;
  62. dbg->mod = dwfl_report_offline(dbg->dwfl, "", "", fd);
  63. if (!dbg->mod)
  64. goto error;
  65. dbg->dbg = dwfl_module_getdwarf(dbg->mod, &dbg->bias);
  66. if (!dbg->dbg)
  67. goto error;
  68. return 0;
  69. error:
  70. if (dbg->dwfl)
  71. dwfl_end(dbg->dwfl);
  72. else
  73. close(fd);
  74. memset(dbg, 0, sizeof(*dbg));
  75. return -ENOENT;
  76. }
  77. static struct debuginfo *__debuginfo__new(const char *path)
  78. {
  79. struct debuginfo *dbg = zalloc(sizeof(*dbg));
  80. if (!dbg)
  81. return NULL;
  82. if (debuginfo__init_offline_dwarf(dbg, path) < 0)
  83. zfree(&dbg);
  84. if (dbg)
  85. pr_debug("Open Debuginfo file: %s\n", path);
  86. return dbg;
  87. }
  88. enum dso_binary_type distro_dwarf_types[] = {
  89. DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
  90. DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
  91. DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
  92. DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
  93. DSO_BINARY_TYPE__NOT_FOUND,
  94. };
  95. struct debuginfo *debuginfo__new(const char *path)
  96. {
  97. enum dso_binary_type *type;
  98. char buf[PATH_MAX], nil = '\0';
  99. struct dso *dso;
  100. struct debuginfo *dinfo = NULL;
  101. /* Try to open distro debuginfo files */
  102. dso = dso__new(path);
  103. if (!dso)
  104. goto out;
  105. for (type = distro_dwarf_types;
  106. !dinfo && *type != DSO_BINARY_TYPE__NOT_FOUND;
  107. type++) {
  108. if (dso__read_binary_type_filename(dso, *type, &nil,
  109. buf, PATH_MAX) < 0)
  110. continue;
  111. dinfo = __debuginfo__new(buf);
  112. }
  113. dso__put(dso);
  114. out:
  115. /* if failed to open all distro debuginfo, open given binary */
  116. return dinfo ? : __debuginfo__new(path);
  117. }
  118. void debuginfo__delete(struct debuginfo *dbg)
  119. {
  120. if (dbg) {
  121. if (dbg->dwfl)
  122. dwfl_end(dbg->dwfl);
  123. free(dbg);
  124. }
  125. }
  126. /*
  127. * Probe finder related functions
  128. */
  129. static struct probe_trace_arg_ref *alloc_trace_arg_ref(long offs)
  130. {
  131. struct probe_trace_arg_ref *ref;
  132. ref = zalloc(sizeof(struct probe_trace_arg_ref));
  133. if (ref != NULL)
  134. ref->offset = offs;
  135. return ref;
  136. }
  137. /*
  138. * Convert a location into trace_arg.
  139. * If tvar == NULL, this just checks variable can be converted.
  140. * If fentry == true and vr_die is a parameter, do huristic search
  141. * for the location fuzzed by function entry mcount.
  142. */
  143. static int convert_variable_location(Dwarf_Die *vr_die, Dwarf_Addr addr,
  144. Dwarf_Op *fb_ops, Dwarf_Die *sp_die,
  145. struct probe_trace_arg *tvar)
  146. {
  147. Dwarf_Attribute attr;
  148. Dwarf_Addr tmp = 0;
  149. Dwarf_Op *op;
  150. size_t nops;
  151. unsigned int regn;
  152. Dwarf_Word offs = 0;
  153. bool ref = false;
  154. const char *regs;
  155. int ret, ret2 = 0;
  156. if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
  157. goto static_var;
  158. /* TODO: handle more than 1 exprs */
  159. if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
  160. return -EINVAL; /* Broken DIE ? */
  161. if (dwarf_getlocation_addr(&attr, addr, &op, &nops, 1) <= 0) {
  162. ret = dwarf_entrypc(sp_die, &tmp);
  163. if (ret)
  164. return -ENOENT;
  165. if (probe_conf.show_location_range &&
  166. (dwarf_tag(vr_die) == DW_TAG_variable)) {
  167. ret2 = -ERANGE;
  168. } else if (addr != tmp ||
  169. dwarf_tag(vr_die) != DW_TAG_formal_parameter) {
  170. return -ENOENT;
  171. }
  172. ret = dwarf_highpc(sp_die, &tmp);
  173. if (ret)
  174. return -ENOENT;
  175. /*
  176. * This is fuzzed by fentry mcount. We try to find the
  177. * parameter location at the earliest address.
  178. */
  179. for (addr += 1; addr <= tmp; addr++) {
  180. if (dwarf_getlocation_addr(&attr, addr, &op,
  181. &nops, 1) > 0)
  182. goto found;
  183. }
  184. return -ENOENT;
  185. }
  186. found:
  187. if (nops == 0)
  188. /* TODO: Support const_value */
  189. return -ENOENT;
  190. if (op->atom == DW_OP_addr) {
  191. static_var:
  192. if (!tvar)
  193. return ret2;
  194. /* Static variables on memory (not stack), make @varname */
  195. ret = strlen(dwarf_diename(vr_die));
  196. tvar->value = zalloc(ret + 2);
  197. if (tvar->value == NULL)
  198. return -ENOMEM;
  199. snprintf(tvar->value, ret + 2, "@%s", dwarf_diename(vr_die));
  200. tvar->ref = alloc_trace_arg_ref((long)offs);
  201. if (tvar->ref == NULL)
  202. return -ENOMEM;
  203. return ret2;
  204. }
  205. /* If this is based on frame buffer, set the offset */
  206. if (op->atom == DW_OP_fbreg) {
  207. if (fb_ops == NULL)
  208. return -ENOTSUP;
  209. ref = true;
  210. offs = op->number;
  211. op = &fb_ops[0];
  212. }
  213. if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
  214. regn = op->atom - DW_OP_breg0;
  215. offs += op->number;
  216. ref = true;
  217. } else if (op->atom >= DW_OP_reg0 && op->atom <= DW_OP_reg31) {
  218. regn = op->atom - DW_OP_reg0;
  219. } else if (op->atom == DW_OP_bregx) {
  220. regn = op->number;
  221. offs += op->number2;
  222. ref = true;
  223. } else if (op->atom == DW_OP_regx) {
  224. regn = op->number;
  225. } else {
  226. pr_debug("DW_OP %x is not supported.\n", op->atom);
  227. return -ENOTSUP;
  228. }
  229. if (!tvar)
  230. return ret2;
  231. regs = get_arch_regstr(regn);
  232. if (!regs) {
  233. /* This should be a bug in DWARF or this tool */
  234. pr_warning("Mapping for the register number %u "
  235. "missing on this architecture.\n", regn);
  236. return -ENOTSUP;
  237. }
  238. tvar->value = strdup(regs);
  239. if (tvar->value == NULL)
  240. return -ENOMEM;
  241. if (ref) {
  242. tvar->ref = alloc_trace_arg_ref((long)offs);
  243. if (tvar->ref == NULL)
  244. return -ENOMEM;
  245. }
  246. return ret2;
  247. }
  248. #define BYTES_TO_BITS(nb) ((nb) * BITS_PER_LONG / sizeof(long))
  249. static int convert_variable_type(Dwarf_Die *vr_die,
  250. struct probe_trace_arg *tvar,
  251. const char *cast)
  252. {
  253. struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
  254. Dwarf_Die type;
  255. char buf[16];
  256. char sbuf[STRERR_BUFSIZE];
  257. int bsize, boffs, total;
  258. int ret;
  259. /* TODO: check all types */
  260. if (cast && strcmp(cast, "string") != 0) {
  261. /* Non string type is OK */
  262. tvar->type = strdup(cast);
  263. return (tvar->type == NULL) ? -ENOMEM : 0;
  264. }
  265. bsize = dwarf_bitsize(vr_die);
  266. if (bsize > 0) {
  267. /* This is a bitfield */
  268. boffs = dwarf_bitoffset(vr_die);
  269. total = dwarf_bytesize(vr_die);
  270. if (boffs < 0 || total < 0)
  271. return -ENOENT;
  272. ret = snprintf(buf, 16, "b%d@%d/%zd", bsize, boffs,
  273. BYTES_TO_BITS(total));
  274. goto formatted;
  275. }
  276. if (die_get_real_type(vr_die, &type) == NULL) {
  277. pr_warning("Failed to get a type information of %s.\n",
  278. dwarf_diename(vr_die));
  279. return -ENOENT;
  280. }
  281. pr_debug("%s type is %s.\n",
  282. dwarf_diename(vr_die), dwarf_diename(&type));
  283. if (cast && strcmp(cast, "string") == 0) { /* String type */
  284. ret = dwarf_tag(&type);
  285. if (ret != DW_TAG_pointer_type &&
  286. ret != DW_TAG_array_type) {
  287. pr_warning("Failed to cast into string: "
  288. "%s(%s) is not a pointer nor array.\n",
  289. dwarf_diename(vr_die), dwarf_diename(&type));
  290. return -EINVAL;
  291. }
  292. if (die_get_real_type(&type, &type) == NULL) {
  293. pr_warning("Failed to get a type"
  294. " information.\n");
  295. return -ENOENT;
  296. }
  297. if (ret == DW_TAG_pointer_type) {
  298. while (*ref_ptr)
  299. ref_ptr = &(*ref_ptr)->next;
  300. /* Add new reference with offset +0 */
  301. *ref_ptr = zalloc(sizeof(struct probe_trace_arg_ref));
  302. if (*ref_ptr == NULL) {
  303. pr_warning("Out of memory error\n");
  304. return -ENOMEM;
  305. }
  306. }
  307. if (!die_compare_name(&type, "char") &&
  308. !die_compare_name(&type, "unsigned char")) {
  309. pr_warning("Failed to cast into string: "
  310. "%s is not (unsigned) char *.\n",
  311. dwarf_diename(vr_die));
  312. return -EINVAL;
  313. }
  314. tvar->type = strdup(cast);
  315. return (tvar->type == NULL) ? -ENOMEM : 0;
  316. }
  317. ret = dwarf_bytesize(&type);
  318. if (ret <= 0)
  319. /* No size ... try to use default type */
  320. return 0;
  321. ret = BYTES_TO_BITS(ret);
  322. /* Check the bitwidth */
  323. if (ret > MAX_BASIC_TYPE_BITS) {
  324. pr_info("%s exceeds max-bitwidth. Cut down to %d bits.\n",
  325. dwarf_diename(&type), MAX_BASIC_TYPE_BITS);
  326. ret = MAX_BASIC_TYPE_BITS;
  327. }
  328. ret = snprintf(buf, 16, "%c%d",
  329. die_is_signed_type(&type) ? 's' : 'u', ret);
  330. formatted:
  331. if (ret < 0 || ret >= 16) {
  332. if (ret >= 16)
  333. ret = -E2BIG;
  334. pr_warning("Failed to convert variable type: %s\n",
  335. strerror_r(-ret, sbuf, sizeof(sbuf)));
  336. return ret;
  337. }
  338. tvar->type = strdup(buf);
  339. if (tvar->type == NULL)
  340. return -ENOMEM;
  341. return 0;
  342. }
  343. static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
  344. struct perf_probe_arg_field *field,
  345. struct probe_trace_arg_ref **ref_ptr,
  346. Dwarf_Die *die_mem)
  347. {
  348. struct probe_trace_arg_ref *ref = *ref_ptr;
  349. Dwarf_Die type;
  350. Dwarf_Word offs;
  351. int ret, tag;
  352. pr_debug("converting %s in %s\n", field->name, varname);
  353. if (die_get_real_type(vr_die, &type) == NULL) {
  354. pr_warning("Failed to get the type of %s.\n", varname);
  355. return -ENOENT;
  356. }
  357. pr_debug2("Var real type: (%x)\n", (unsigned)dwarf_dieoffset(&type));
  358. tag = dwarf_tag(&type);
  359. if (field->name[0] == '[' &&
  360. (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)) {
  361. if (field->next)
  362. /* Save original type for next field */
  363. memcpy(die_mem, &type, sizeof(*die_mem));
  364. /* Get the type of this array */
  365. if (die_get_real_type(&type, &type) == NULL) {
  366. pr_warning("Failed to get the type of %s.\n", varname);
  367. return -ENOENT;
  368. }
  369. pr_debug2("Array real type: (%x)\n",
  370. (unsigned)dwarf_dieoffset(&type));
  371. if (tag == DW_TAG_pointer_type) {
  372. ref = zalloc(sizeof(struct probe_trace_arg_ref));
  373. if (ref == NULL)
  374. return -ENOMEM;
  375. if (*ref_ptr)
  376. (*ref_ptr)->next = ref;
  377. else
  378. *ref_ptr = ref;
  379. }
  380. ref->offset += dwarf_bytesize(&type) * field->index;
  381. if (!field->next)
  382. /* Save vr_die for converting types */
  383. memcpy(die_mem, vr_die, sizeof(*die_mem));
  384. goto next;
  385. } else if (tag == DW_TAG_pointer_type) {
  386. /* Check the pointer and dereference */
  387. if (!field->ref) {
  388. pr_err("Semantic error: %s must be referred by '->'\n",
  389. field->name);
  390. return -EINVAL;
  391. }
  392. /* Get the type pointed by this pointer */
  393. if (die_get_real_type(&type, &type) == NULL) {
  394. pr_warning("Failed to get the type of %s.\n", varname);
  395. return -ENOENT;
  396. }
  397. /* Verify it is a data structure */
  398. tag = dwarf_tag(&type);
  399. if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
  400. pr_warning("%s is not a data structure nor an union.\n",
  401. varname);
  402. return -EINVAL;
  403. }
  404. ref = zalloc(sizeof(struct probe_trace_arg_ref));
  405. if (ref == NULL)
  406. return -ENOMEM;
  407. if (*ref_ptr)
  408. (*ref_ptr)->next = ref;
  409. else
  410. *ref_ptr = ref;
  411. } else {
  412. /* Verify it is a data structure */
  413. if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
  414. pr_warning("%s is not a data structure nor an union.\n",
  415. varname);
  416. return -EINVAL;
  417. }
  418. if (field->name[0] == '[') {
  419. pr_err("Semantic error: %s is not a pointer"
  420. " nor array.\n", varname);
  421. return -EINVAL;
  422. }
  423. /* While prcessing unnamed field, we don't care about this */
  424. if (field->ref && dwarf_diename(vr_die)) {
  425. pr_err("Semantic error: %s must be referred by '.'\n",
  426. field->name);
  427. return -EINVAL;
  428. }
  429. if (!ref) {
  430. pr_warning("Structure on a register is not "
  431. "supported yet.\n");
  432. return -ENOTSUP;
  433. }
  434. }
  435. if (die_find_member(&type, field->name, die_mem) == NULL) {
  436. pr_warning("%s(type:%s) has no member %s.\n", varname,
  437. dwarf_diename(&type), field->name);
  438. return -EINVAL;
  439. }
  440. /* Get the offset of the field */
  441. if (tag == DW_TAG_union_type) {
  442. offs = 0;
  443. } else {
  444. ret = die_get_data_member_location(die_mem, &offs);
  445. if (ret < 0) {
  446. pr_warning("Failed to get the offset of %s.\n",
  447. field->name);
  448. return ret;
  449. }
  450. }
  451. ref->offset += (long)offs;
  452. /* If this member is unnamed, we need to reuse this field */
  453. if (!dwarf_diename(die_mem))
  454. return convert_variable_fields(die_mem, varname, field,
  455. &ref, die_mem);
  456. next:
  457. /* Converting next field */
  458. if (field->next)
  459. return convert_variable_fields(die_mem, field->name,
  460. field->next, &ref, die_mem);
  461. else
  462. return 0;
  463. }
  464. /* Show a variables in kprobe event format */
  465. static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
  466. {
  467. Dwarf_Die die_mem;
  468. int ret;
  469. pr_debug("Converting variable %s into trace event.\n",
  470. dwarf_diename(vr_die));
  471. ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
  472. &pf->sp_die, pf->tvar);
  473. if (ret == -ENOENT || ret == -EINVAL) {
  474. pr_err("Failed to find the location of the '%s' variable at this address.\n"
  475. " Perhaps it has been optimized out.\n"
  476. " Use -V with the --range option to show '%s' location range.\n",
  477. pf->pvar->var, pf->pvar->var);
  478. } else if (ret == -ENOTSUP)
  479. pr_err("Sorry, we don't support this variable location yet.\n");
  480. else if (ret == 0 && pf->pvar->field) {
  481. ret = convert_variable_fields(vr_die, pf->pvar->var,
  482. pf->pvar->field, &pf->tvar->ref,
  483. &die_mem);
  484. vr_die = &die_mem;
  485. }
  486. if (ret == 0)
  487. ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
  488. /* *expr will be cached in libdw. Don't free it. */
  489. return ret;
  490. }
  491. /* Find a variable in a scope DIE */
  492. static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
  493. {
  494. Dwarf_Die vr_die;
  495. char buf[32], *ptr;
  496. int ret = 0;
  497. /* Copy raw parameters */
  498. if (!is_c_varname(pf->pvar->var))
  499. return copy_to_probe_trace_arg(pf->tvar, pf->pvar);
  500. if (pf->pvar->name)
  501. pf->tvar->name = strdup(pf->pvar->name);
  502. else {
  503. ret = synthesize_perf_probe_arg(pf->pvar, buf, 32);
  504. if (ret < 0)
  505. return ret;
  506. ptr = strchr(buf, ':'); /* Change type separator to _ */
  507. if (ptr)
  508. *ptr = '_';
  509. pf->tvar->name = strdup(buf);
  510. }
  511. if (pf->tvar->name == NULL)
  512. return -ENOMEM;
  513. pr_debug("Searching '%s' variable in context.\n", pf->pvar->var);
  514. /* Search child die for local variables and parameters. */
  515. if (!die_find_variable_at(sc_die, pf->pvar->var, pf->addr, &vr_die)) {
  516. /* Search again in global variables */
  517. if (!die_find_variable_at(&pf->cu_die, pf->pvar->var,
  518. 0, &vr_die)) {
  519. pr_warning("Failed to find '%s' in this function.\n",
  520. pf->pvar->var);
  521. ret = -ENOENT;
  522. }
  523. }
  524. if (ret >= 0)
  525. ret = convert_variable(&vr_die, pf);
  526. return ret;
  527. }
  528. /* Convert subprogram DIE to trace point */
  529. static int convert_to_trace_point(Dwarf_Die *sp_die, Dwfl_Module *mod,
  530. Dwarf_Addr paddr, bool retprobe,
  531. struct probe_trace_point *tp)
  532. {
  533. Dwarf_Addr eaddr, highaddr;
  534. GElf_Sym sym;
  535. const char *symbol;
  536. /* Verify the address is correct */
  537. if (dwarf_entrypc(sp_die, &eaddr) != 0) {
  538. pr_warning("Failed to get entry address of %s\n",
  539. dwarf_diename(sp_die));
  540. return -ENOENT;
  541. }
  542. if (dwarf_highpc(sp_die, &highaddr) != 0) {
  543. pr_warning("Failed to get end address of %s\n",
  544. dwarf_diename(sp_die));
  545. return -ENOENT;
  546. }
  547. if (paddr > highaddr) {
  548. pr_warning("Offset specified is greater than size of %s\n",
  549. dwarf_diename(sp_die));
  550. return -EINVAL;
  551. }
  552. symbol = dwarf_diename(sp_die);
  553. if (!symbol) {
  554. /* Try to get the symbol name from symtab */
  555. symbol = dwfl_module_addrsym(mod, paddr, &sym, NULL);
  556. if (!symbol) {
  557. pr_warning("Failed to find symbol at 0x%lx\n",
  558. (unsigned long)paddr);
  559. return -ENOENT;
  560. }
  561. eaddr = sym.st_value;
  562. }
  563. tp->offset = (unsigned long)(paddr - eaddr);
  564. tp->address = (unsigned long)paddr;
  565. tp->symbol = strdup(symbol);
  566. if (!tp->symbol)
  567. return -ENOMEM;
  568. /* Return probe must be on the head of a subprogram */
  569. if (retprobe) {
  570. if (eaddr != paddr) {
  571. pr_warning("Return probe must be on the head of"
  572. " a real function.\n");
  573. return -EINVAL;
  574. }
  575. tp->retprobe = true;
  576. }
  577. return 0;
  578. }
  579. /* Call probe_finder callback with scope DIE */
  580. static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
  581. {
  582. Dwarf_Attribute fb_attr;
  583. size_t nops;
  584. int ret;
  585. if (!sc_die) {
  586. pr_err("Caller must pass a scope DIE. Program error.\n");
  587. return -EINVAL;
  588. }
  589. /* If not a real subprogram, find a real one */
  590. if (!die_is_func_def(sc_die)) {
  591. if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
  592. if (die_find_tailfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
  593. pr_warning("Ignoring tail call from %s\n",
  594. dwarf_diename(&pf->sp_die));
  595. return 0;
  596. } else {
  597. pr_warning("Failed to find probe point in any "
  598. "functions.\n");
  599. return -ENOENT;
  600. }
  601. }
  602. } else
  603. memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
  604. /* Get the frame base attribute/ops from subprogram */
  605. dwarf_attr(&pf->sp_die, DW_AT_frame_base, &fb_attr);
  606. ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
  607. if (ret <= 0 || nops == 0) {
  608. pf->fb_ops = NULL;
  609. #if _ELFUTILS_PREREQ(0, 142)
  610. } else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
  611. pf->cfi != NULL) {
  612. Dwarf_Frame *frame;
  613. if (dwarf_cfi_addrframe(pf->cfi, pf->addr, &frame) != 0 ||
  614. dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
  615. pr_warning("Failed to get call frame on 0x%jx\n",
  616. (uintmax_t)pf->addr);
  617. return -ENOENT;
  618. }
  619. #endif
  620. }
  621. /* Call finder's callback handler */
  622. ret = pf->callback(sc_die, pf);
  623. /* *pf->fb_ops will be cached in libdw. Don't free it. */
  624. pf->fb_ops = NULL;
  625. return ret;
  626. }
  627. struct find_scope_param {
  628. const char *function;
  629. const char *file;
  630. int line;
  631. int diff;
  632. Dwarf_Die *die_mem;
  633. bool found;
  634. };
  635. static int find_best_scope_cb(Dwarf_Die *fn_die, void *data)
  636. {
  637. struct find_scope_param *fsp = data;
  638. const char *file;
  639. int lno;
  640. /* Skip if declared file name does not match */
  641. if (fsp->file) {
  642. file = dwarf_decl_file(fn_die);
  643. if (!file || strcmp(fsp->file, file) != 0)
  644. return 0;
  645. }
  646. /* If the function name is given, that's what user expects */
  647. if (fsp->function) {
  648. if (die_match_name(fn_die, fsp->function)) {
  649. memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
  650. fsp->found = true;
  651. return 1;
  652. }
  653. } else {
  654. /* With the line number, find the nearest declared DIE */
  655. dwarf_decl_line(fn_die, &lno);
  656. if (lno < fsp->line && fsp->diff > fsp->line - lno) {
  657. /* Keep a candidate and continue */
  658. fsp->diff = fsp->line - lno;
  659. memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
  660. fsp->found = true;
  661. }
  662. }
  663. return 0;
  664. }
  665. /* Find an appropriate scope fits to given conditions */
  666. static Dwarf_Die *find_best_scope(struct probe_finder *pf, Dwarf_Die *die_mem)
  667. {
  668. struct find_scope_param fsp = {
  669. .function = pf->pev->point.function,
  670. .file = pf->fname,
  671. .line = pf->lno,
  672. .diff = INT_MAX,
  673. .die_mem = die_mem,
  674. .found = false,
  675. };
  676. cu_walk_functions_at(&pf->cu_die, pf->addr, find_best_scope_cb, &fsp);
  677. return fsp.found ? die_mem : NULL;
  678. }
  679. static int probe_point_line_walker(const char *fname, int lineno,
  680. Dwarf_Addr addr, void *data)
  681. {
  682. struct probe_finder *pf = data;
  683. Dwarf_Die *sc_die, die_mem;
  684. int ret;
  685. if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
  686. return 0;
  687. pf->addr = addr;
  688. sc_die = find_best_scope(pf, &die_mem);
  689. if (!sc_die) {
  690. pr_warning("Failed to find scope of probe point.\n");
  691. return -ENOENT;
  692. }
  693. ret = call_probe_finder(sc_die, pf);
  694. /* Continue if no error, because the line will be in inline function */
  695. return ret < 0 ? ret : 0;
  696. }
  697. /* Find probe point from its line number */
  698. static int find_probe_point_by_line(struct probe_finder *pf)
  699. {
  700. return die_walk_lines(&pf->cu_die, probe_point_line_walker, pf);
  701. }
  702. /* Find lines which match lazy pattern */
  703. static int find_lazy_match_lines(struct intlist *list,
  704. const char *fname, const char *pat)
  705. {
  706. FILE *fp;
  707. char *line = NULL;
  708. size_t line_len;
  709. ssize_t len;
  710. int count = 0, linenum = 1;
  711. char sbuf[STRERR_BUFSIZE];
  712. fp = fopen(fname, "r");
  713. if (!fp) {
  714. pr_warning("Failed to open %s: %s\n", fname,
  715. strerror_r(errno, sbuf, sizeof(sbuf)));
  716. return -errno;
  717. }
  718. while ((len = getline(&line, &line_len, fp)) > 0) {
  719. if (line[len - 1] == '\n')
  720. line[len - 1] = '\0';
  721. if (strlazymatch(line, pat)) {
  722. intlist__add(list, linenum);
  723. count++;
  724. }
  725. linenum++;
  726. }
  727. if (ferror(fp))
  728. count = -errno;
  729. free(line);
  730. fclose(fp);
  731. if (count == 0)
  732. pr_debug("No matched lines found in %s.\n", fname);
  733. return count;
  734. }
  735. static int probe_point_lazy_walker(const char *fname, int lineno,
  736. Dwarf_Addr addr, void *data)
  737. {
  738. struct probe_finder *pf = data;
  739. Dwarf_Die *sc_die, die_mem;
  740. int ret;
  741. if (!intlist__has_entry(pf->lcache, lineno) ||
  742. strtailcmp(fname, pf->fname) != 0)
  743. return 0;
  744. pr_debug("Probe line found: line:%d addr:0x%llx\n",
  745. lineno, (unsigned long long)addr);
  746. pf->addr = addr;
  747. pf->lno = lineno;
  748. sc_die = find_best_scope(pf, &die_mem);
  749. if (!sc_die) {
  750. pr_warning("Failed to find scope of probe point.\n");
  751. return -ENOENT;
  752. }
  753. ret = call_probe_finder(sc_die, pf);
  754. /*
  755. * Continue if no error, because the lazy pattern will match
  756. * to other lines
  757. */
  758. return ret < 0 ? ret : 0;
  759. }
  760. /* Find probe points from lazy pattern */
  761. static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
  762. {
  763. int ret = 0;
  764. char *fpath;
  765. if (intlist__empty(pf->lcache)) {
  766. const char *comp_dir;
  767. comp_dir = cu_get_comp_dir(&pf->cu_die);
  768. ret = get_real_path(pf->fname, comp_dir, &fpath);
  769. if (ret < 0) {
  770. pr_warning("Failed to find source file path.\n");
  771. return ret;
  772. }
  773. /* Matching lazy line pattern */
  774. ret = find_lazy_match_lines(pf->lcache, fpath,
  775. pf->pev->point.lazy_line);
  776. free(fpath);
  777. if (ret <= 0)
  778. return ret;
  779. }
  780. return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
  781. }
  782. static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
  783. {
  784. struct probe_finder *pf = data;
  785. struct perf_probe_point *pp = &pf->pev->point;
  786. Dwarf_Addr addr;
  787. int ret;
  788. if (pp->lazy_line)
  789. ret = find_probe_point_lazy(in_die, pf);
  790. else {
  791. /* Get probe address */
  792. if (dwarf_entrypc(in_die, &addr) != 0) {
  793. pr_warning("Failed to get entry address of %s.\n",
  794. dwarf_diename(in_die));
  795. return -ENOENT;
  796. }
  797. pf->addr = addr;
  798. pf->addr += pp->offset;
  799. pr_debug("found inline addr: 0x%jx\n",
  800. (uintmax_t)pf->addr);
  801. ret = call_probe_finder(in_die, pf);
  802. }
  803. return ret;
  804. }
  805. /* Callback parameter with return value for libdw */
  806. struct dwarf_callback_param {
  807. void *data;
  808. int retval;
  809. };
  810. /* Search function from function name */
  811. static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
  812. {
  813. struct dwarf_callback_param *param = data;
  814. struct probe_finder *pf = param->data;
  815. struct perf_probe_point *pp = &pf->pev->point;
  816. /* Check tag and diename */
  817. if (!die_is_func_def(sp_die) ||
  818. !die_match_name(sp_die, pp->function))
  819. return DWARF_CB_OK;
  820. /* Check declared file */
  821. if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
  822. return DWARF_CB_OK;
  823. pr_debug("Matched function: %s\n", dwarf_diename(sp_die));
  824. pf->fname = dwarf_decl_file(sp_die);
  825. if (pp->line) { /* Function relative line */
  826. dwarf_decl_line(sp_die, &pf->lno);
  827. pf->lno += pp->line;
  828. param->retval = find_probe_point_by_line(pf);
  829. } else if (die_is_func_instance(sp_die)) {
  830. /* Instances always have the entry address */
  831. dwarf_entrypc(sp_die, &pf->addr);
  832. /* Real function */
  833. if (pp->lazy_line)
  834. param->retval = find_probe_point_lazy(sp_die, pf);
  835. else {
  836. pf->addr += pp->offset;
  837. /* TODO: Check the address in this function */
  838. param->retval = call_probe_finder(sp_die, pf);
  839. }
  840. } else if (!probe_conf.no_inlines) {
  841. /* Inlined function: search instances */
  842. param->retval = die_walk_instances(sp_die,
  843. probe_point_inline_cb, (void *)pf);
  844. /* This could be a non-existed inline definition */
  845. if (param->retval == -ENOENT && strisglob(pp->function))
  846. param->retval = 0;
  847. }
  848. /* We need to find other candidates */
  849. if (strisglob(pp->function) && param->retval >= 0) {
  850. param->retval = 0; /* We have to clear the result */
  851. return DWARF_CB_OK;
  852. }
  853. return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
  854. }
  855. static int find_probe_point_by_func(struct probe_finder *pf)
  856. {
  857. struct dwarf_callback_param _param = {.data = (void *)pf,
  858. .retval = 0};
  859. dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
  860. return _param.retval;
  861. }
  862. struct pubname_callback_param {
  863. char *function;
  864. char *file;
  865. Dwarf_Die *cu_die;
  866. Dwarf_Die *sp_die;
  867. int found;
  868. };
  869. static int pubname_search_cb(Dwarf *dbg, Dwarf_Global *gl, void *data)
  870. {
  871. struct pubname_callback_param *param = data;
  872. if (dwarf_offdie(dbg, gl->die_offset, param->sp_die)) {
  873. if (dwarf_tag(param->sp_die) != DW_TAG_subprogram)
  874. return DWARF_CB_OK;
  875. if (die_match_name(param->sp_die, param->function)) {
  876. if (!dwarf_offdie(dbg, gl->cu_offset, param->cu_die))
  877. return DWARF_CB_OK;
  878. if (param->file &&
  879. strtailcmp(param->file, dwarf_decl_file(param->sp_die)))
  880. return DWARF_CB_OK;
  881. param->found = 1;
  882. return DWARF_CB_ABORT;
  883. }
  884. }
  885. return DWARF_CB_OK;
  886. }
  887. /* Find probe points from debuginfo */
  888. static int debuginfo__find_probes(struct debuginfo *dbg,
  889. struct probe_finder *pf)
  890. {
  891. struct perf_probe_point *pp = &pf->pev->point;
  892. Dwarf_Off off, noff;
  893. size_t cuhl;
  894. Dwarf_Die *diep;
  895. int ret = 0;
  896. #if _ELFUTILS_PREREQ(0, 142)
  897. Elf *elf;
  898. GElf_Ehdr ehdr;
  899. GElf_Shdr shdr;
  900. /* Get the call frame information from this dwarf */
  901. elf = dwarf_getelf(dbg->dbg);
  902. if (elf == NULL)
  903. return -EINVAL;
  904. if (gelf_getehdr(elf, &ehdr) == NULL)
  905. return -EINVAL;
  906. if (elf_section_by_name(elf, &ehdr, &shdr, ".eh_frame", NULL) &&
  907. shdr.sh_type == SHT_PROGBITS) {
  908. pf->cfi = dwarf_getcfi_elf(elf);
  909. } else {
  910. pf->cfi = dwarf_getcfi(dbg->dbg);
  911. }
  912. #endif
  913. off = 0;
  914. pf->lcache = intlist__new(NULL);
  915. if (!pf->lcache)
  916. return -ENOMEM;
  917. /* Fastpath: lookup by function name from .debug_pubnames section */
  918. if (pp->function && !strisglob(pp->function)) {
  919. struct pubname_callback_param pubname_param = {
  920. .function = pp->function,
  921. .file = pp->file,
  922. .cu_die = &pf->cu_die,
  923. .sp_die = &pf->sp_die,
  924. .found = 0,
  925. };
  926. struct dwarf_callback_param probe_param = {
  927. .data = pf,
  928. };
  929. dwarf_getpubnames(dbg->dbg, pubname_search_cb,
  930. &pubname_param, 0);
  931. if (pubname_param.found) {
  932. ret = probe_point_search_cb(&pf->sp_die, &probe_param);
  933. if (ret)
  934. goto found;
  935. }
  936. }
  937. /* Loop on CUs (Compilation Unit) */
  938. while (!dwarf_nextcu(dbg->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
  939. /* Get the DIE(Debugging Information Entry) of this CU */
  940. diep = dwarf_offdie(dbg->dbg, off + cuhl, &pf->cu_die);
  941. if (!diep)
  942. continue;
  943. /* Check if target file is included. */
  944. if (pp->file)
  945. pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
  946. else
  947. pf->fname = NULL;
  948. if (!pp->file || pf->fname) {
  949. if (pp->function)
  950. ret = find_probe_point_by_func(pf);
  951. else if (pp->lazy_line)
  952. ret = find_probe_point_lazy(&pf->cu_die, pf);
  953. else {
  954. pf->lno = pp->line;
  955. ret = find_probe_point_by_line(pf);
  956. }
  957. if (ret < 0)
  958. break;
  959. }
  960. off = noff;
  961. }
  962. found:
  963. intlist__delete(pf->lcache);
  964. pf->lcache = NULL;
  965. return ret;
  966. }
  967. struct local_vars_finder {
  968. struct probe_finder *pf;
  969. struct perf_probe_arg *args;
  970. bool vars;
  971. int max_args;
  972. int nargs;
  973. int ret;
  974. };
  975. /* Collect available variables in this scope */
  976. static int copy_variables_cb(Dwarf_Die *die_mem, void *data)
  977. {
  978. struct local_vars_finder *vf = data;
  979. struct probe_finder *pf = vf->pf;
  980. int tag;
  981. tag = dwarf_tag(die_mem);
  982. if (tag == DW_TAG_formal_parameter ||
  983. (tag == DW_TAG_variable && vf->vars)) {
  984. if (convert_variable_location(die_mem, vf->pf->addr,
  985. vf->pf->fb_ops, &pf->sp_die,
  986. NULL) == 0) {
  987. vf->args[vf->nargs].var = (char *)dwarf_diename(die_mem);
  988. if (vf->args[vf->nargs].var == NULL) {
  989. vf->ret = -ENOMEM;
  990. return DIE_FIND_CB_END;
  991. }
  992. pr_debug(" %s", vf->args[vf->nargs].var);
  993. vf->nargs++;
  994. }
  995. }
  996. if (dwarf_haspc(die_mem, vf->pf->addr))
  997. return DIE_FIND_CB_CONTINUE;
  998. else
  999. return DIE_FIND_CB_SIBLING;
  1000. }
  1001. static int expand_probe_args(Dwarf_Die *sc_die, struct probe_finder *pf,
  1002. struct perf_probe_arg *args)
  1003. {
  1004. Dwarf_Die die_mem;
  1005. int i;
  1006. int n = 0;
  1007. struct local_vars_finder vf = {.pf = pf, .args = args, .vars = false,
  1008. .max_args = MAX_PROBE_ARGS, .ret = 0};
  1009. for (i = 0; i < pf->pev->nargs; i++) {
  1010. /* var never be NULL */
  1011. if (strcmp(pf->pev->args[i].var, PROBE_ARG_VARS) == 0)
  1012. vf.vars = true;
  1013. else if (strcmp(pf->pev->args[i].var, PROBE_ARG_PARAMS) != 0) {
  1014. /* Copy normal argument */
  1015. args[n] = pf->pev->args[i];
  1016. n++;
  1017. continue;
  1018. }
  1019. pr_debug("Expanding %s into:", pf->pev->args[i].var);
  1020. vf.nargs = n;
  1021. /* Special local variables */
  1022. die_find_child(sc_die, copy_variables_cb, (void *)&vf,
  1023. &die_mem);
  1024. pr_debug(" (%d)\n", vf.nargs - n);
  1025. if (vf.ret < 0)
  1026. return vf.ret;
  1027. n = vf.nargs;
  1028. }
  1029. return n;
  1030. }
  1031. /* Add a found probe point into trace event list */
  1032. static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
  1033. {
  1034. struct trace_event_finder *tf =
  1035. container_of(pf, struct trace_event_finder, pf);
  1036. struct probe_trace_event *tev;
  1037. struct perf_probe_arg *args;
  1038. int ret, i;
  1039. /* Check number of tevs */
  1040. if (tf->ntevs == tf->max_tevs) {
  1041. pr_warning("Too many( > %d) probe point found.\n",
  1042. tf->max_tevs);
  1043. return -ERANGE;
  1044. }
  1045. tev = &tf->tevs[tf->ntevs++];
  1046. /* Trace point should be converted from subprogram DIE */
  1047. ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
  1048. pf->pev->point.retprobe, &tev->point);
  1049. if (ret < 0)
  1050. return ret;
  1051. tev->point.realname = strdup(dwarf_diename(sc_die));
  1052. if (!tev->point.realname)
  1053. return -ENOMEM;
  1054. pr_debug("Probe point found: %s+%lu\n", tev->point.symbol,
  1055. tev->point.offset);
  1056. /* Expand special probe argument if exist */
  1057. args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
  1058. if (args == NULL)
  1059. return -ENOMEM;
  1060. ret = expand_probe_args(sc_die, pf, args);
  1061. if (ret < 0)
  1062. goto end;
  1063. tev->nargs = ret;
  1064. tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
  1065. if (tev->args == NULL) {
  1066. ret = -ENOMEM;
  1067. goto end;
  1068. }
  1069. /* Find each argument */
  1070. for (i = 0; i < tev->nargs; i++) {
  1071. pf->pvar = &args[i];
  1072. pf->tvar = &tev->args[i];
  1073. /* Variable should be found from scope DIE */
  1074. ret = find_variable(sc_die, pf);
  1075. if (ret != 0)
  1076. break;
  1077. }
  1078. end:
  1079. free(args);
  1080. return ret;
  1081. }
  1082. /* Find probe_trace_events specified by perf_probe_event from debuginfo */
  1083. int debuginfo__find_trace_events(struct debuginfo *dbg,
  1084. struct perf_probe_event *pev,
  1085. struct probe_trace_event **tevs)
  1086. {
  1087. struct trace_event_finder tf = {
  1088. .pf = {.pev = pev, .callback = add_probe_trace_event},
  1089. .max_tevs = probe_conf.max_probes, .mod = dbg->mod};
  1090. int ret;
  1091. /* Allocate result tevs array */
  1092. *tevs = zalloc(sizeof(struct probe_trace_event) * tf.max_tevs);
  1093. if (*tevs == NULL)
  1094. return -ENOMEM;
  1095. tf.tevs = *tevs;
  1096. tf.ntevs = 0;
  1097. ret = debuginfo__find_probes(dbg, &tf.pf);
  1098. if (ret < 0) {
  1099. zfree(tevs);
  1100. return ret;
  1101. }
  1102. return (ret < 0) ? ret : tf.ntevs;
  1103. }
  1104. /* Collect available variables in this scope */
  1105. static int collect_variables_cb(Dwarf_Die *die_mem, void *data)
  1106. {
  1107. struct available_var_finder *af = data;
  1108. struct variable_list *vl;
  1109. int tag, ret;
  1110. vl = &af->vls[af->nvls - 1];
  1111. tag = dwarf_tag(die_mem);
  1112. if (tag == DW_TAG_formal_parameter ||
  1113. tag == DW_TAG_variable) {
  1114. ret = convert_variable_location(die_mem, af->pf.addr,
  1115. af->pf.fb_ops, &af->pf.sp_die,
  1116. NULL);
  1117. if (ret == 0 || ret == -ERANGE) {
  1118. int ret2;
  1119. bool externs = !af->child;
  1120. struct strbuf buf;
  1121. strbuf_init(&buf, 64);
  1122. if (probe_conf.show_location_range) {
  1123. if (!externs) {
  1124. if (ret)
  1125. strbuf_addf(&buf, "[INV]\t");
  1126. else
  1127. strbuf_addf(&buf, "[VAL]\t");
  1128. } else
  1129. strbuf_addf(&buf, "[EXT]\t");
  1130. }
  1131. ret2 = die_get_varname(die_mem, &buf);
  1132. if (!ret2 && probe_conf.show_location_range &&
  1133. !externs) {
  1134. strbuf_addf(&buf, "\t");
  1135. ret2 = die_get_var_range(&af->pf.sp_die,
  1136. die_mem, &buf);
  1137. }
  1138. pr_debug("Add new var: %s\n", buf.buf);
  1139. if (ret2 == 0) {
  1140. strlist__add(vl->vars,
  1141. strbuf_detach(&buf, NULL));
  1142. }
  1143. strbuf_release(&buf);
  1144. }
  1145. }
  1146. if (af->child && dwarf_haspc(die_mem, af->pf.addr))
  1147. return DIE_FIND_CB_CONTINUE;
  1148. else
  1149. return DIE_FIND_CB_SIBLING;
  1150. }
  1151. /* Add a found vars into available variables list */
  1152. static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
  1153. {
  1154. struct available_var_finder *af =
  1155. container_of(pf, struct available_var_finder, pf);
  1156. struct variable_list *vl;
  1157. Dwarf_Die die_mem;
  1158. int ret;
  1159. /* Check number of tevs */
  1160. if (af->nvls == af->max_vls) {
  1161. pr_warning("Too many( > %d) probe point found.\n", af->max_vls);
  1162. return -ERANGE;
  1163. }
  1164. vl = &af->vls[af->nvls++];
  1165. /* Trace point should be converted from subprogram DIE */
  1166. ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
  1167. pf->pev->point.retprobe, &vl->point);
  1168. if (ret < 0)
  1169. return ret;
  1170. pr_debug("Probe point found: %s+%lu\n", vl->point.symbol,
  1171. vl->point.offset);
  1172. /* Find local variables */
  1173. vl->vars = strlist__new(NULL, NULL);
  1174. if (vl->vars == NULL)
  1175. return -ENOMEM;
  1176. af->child = true;
  1177. die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
  1178. /* Find external variables */
  1179. if (!probe_conf.show_ext_vars)
  1180. goto out;
  1181. /* Don't need to search child DIE for external vars. */
  1182. af->child = false;
  1183. die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
  1184. out:
  1185. if (strlist__empty(vl->vars)) {
  1186. strlist__delete(vl->vars);
  1187. vl->vars = NULL;
  1188. }
  1189. return ret;
  1190. }
  1191. /*
  1192. * Find available variables at given probe point
  1193. * Return the number of found probe points. Return 0 if there is no
  1194. * matched probe point. Return <0 if an error occurs.
  1195. */
  1196. int debuginfo__find_available_vars_at(struct debuginfo *dbg,
  1197. struct perf_probe_event *pev,
  1198. struct variable_list **vls)
  1199. {
  1200. struct available_var_finder af = {
  1201. .pf = {.pev = pev, .callback = add_available_vars},
  1202. .mod = dbg->mod,
  1203. .max_vls = probe_conf.max_probes};
  1204. int ret;
  1205. /* Allocate result vls array */
  1206. *vls = zalloc(sizeof(struct variable_list) * af.max_vls);
  1207. if (*vls == NULL)
  1208. return -ENOMEM;
  1209. af.vls = *vls;
  1210. af.nvls = 0;
  1211. ret = debuginfo__find_probes(dbg, &af.pf);
  1212. if (ret < 0) {
  1213. /* Free vlist for error */
  1214. while (af.nvls--) {
  1215. zfree(&af.vls[af.nvls].point.symbol);
  1216. strlist__delete(af.vls[af.nvls].vars);
  1217. }
  1218. zfree(vls);
  1219. return ret;
  1220. }
  1221. return (ret < 0) ? ret : af.nvls;
  1222. }
  1223. /* Reverse search */
  1224. int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
  1225. struct perf_probe_point *ppt)
  1226. {
  1227. Dwarf_Die cudie, spdie, indie;
  1228. Dwarf_Addr _addr = 0, baseaddr = 0;
  1229. const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
  1230. int baseline = 0, lineno = 0, ret = 0;
  1231. /* Find cu die */
  1232. if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr, &cudie)) {
  1233. pr_warning("Failed to find debug information for address %lx\n",
  1234. addr);
  1235. ret = -EINVAL;
  1236. goto end;
  1237. }
  1238. /* Find a corresponding line (filename and lineno) */
  1239. cu_find_lineinfo(&cudie, addr, &fname, &lineno);
  1240. /* Don't care whether it failed or not */
  1241. /* Find a corresponding function (name, baseline and baseaddr) */
  1242. if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
  1243. /* Get function entry information */
  1244. func = basefunc = dwarf_diename(&spdie);
  1245. if (!func ||
  1246. dwarf_entrypc(&spdie, &baseaddr) != 0 ||
  1247. dwarf_decl_line(&spdie, &baseline) != 0) {
  1248. lineno = 0;
  1249. goto post;
  1250. }
  1251. fname = dwarf_decl_file(&spdie);
  1252. if (addr == (unsigned long)baseaddr) {
  1253. /* Function entry - Relative line number is 0 */
  1254. lineno = baseline;
  1255. goto post;
  1256. }
  1257. /* Track down the inline functions step by step */
  1258. while (die_find_top_inlinefunc(&spdie, (Dwarf_Addr)addr,
  1259. &indie)) {
  1260. /* There is an inline function */
  1261. if (dwarf_entrypc(&indie, &_addr) == 0 &&
  1262. _addr == addr) {
  1263. /*
  1264. * addr is at an inline function entry.
  1265. * In this case, lineno should be the call-site
  1266. * line number. (overwrite lineinfo)
  1267. */
  1268. lineno = die_get_call_lineno(&indie);
  1269. fname = die_get_call_file(&indie);
  1270. break;
  1271. } else {
  1272. /*
  1273. * addr is in an inline function body.
  1274. * Since lineno points one of the lines
  1275. * of the inline function, baseline should
  1276. * be the entry line of the inline function.
  1277. */
  1278. tmp = dwarf_diename(&indie);
  1279. if (!tmp ||
  1280. dwarf_decl_line(&indie, &baseline) != 0)
  1281. break;
  1282. func = tmp;
  1283. spdie = indie;
  1284. }
  1285. }
  1286. /* Verify the lineno and baseline are in a same file */
  1287. tmp = dwarf_decl_file(&spdie);
  1288. if (!tmp || strcmp(tmp, fname) != 0)
  1289. lineno = 0;
  1290. }
  1291. post:
  1292. /* Make a relative line number or an offset */
  1293. if (lineno)
  1294. ppt->line = lineno - baseline;
  1295. else if (basefunc) {
  1296. ppt->offset = addr - (unsigned long)baseaddr;
  1297. func = basefunc;
  1298. }
  1299. /* Duplicate strings */
  1300. if (func) {
  1301. ppt->function = strdup(func);
  1302. if (ppt->function == NULL) {
  1303. ret = -ENOMEM;
  1304. goto end;
  1305. }
  1306. }
  1307. if (fname) {
  1308. ppt->file = strdup(fname);
  1309. if (ppt->file == NULL) {
  1310. zfree(&ppt->function);
  1311. ret = -ENOMEM;
  1312. goto end;
  1313. }
  1314. }
  1315. end:
  1316. if (ret == 0 && (fname || func))
  1317. ret = 1; /* Found a point */
  1318. return ret;
  1319. }
  1320. /* Add a line and store the src path */
  1321. static int line_range_add_line(const char *src, unsigned int lineno,
  1322. struct line_range *lr)
  1323. {
  1324. /* Copy source path */
  1325. if (!lr->path) {
  1326. lr->path = strdup(src);
  1327. if (lr->path == NULL)
  1328. return -ENOMEM;
  1329. }
  1330. return intlist__add(lr->line_list, lineno);
  1331. }
  1332. static int line_range_walk_cb(const char *fname, int lineno,
  1333. Dwarf_Addr addr __maybe_unused,
  1334. void *data)
  1335. {
  1336. struct line_finder *lf = data;
  1337. int err;
  1338. if ((strtailcmp(fname, lf->fname) != 0) ||
  1339. (lf->lno_s > lineno || lf->lno_e < lineno))
  1340. return 0;
  1341. err = line_range_add_line(fname, lineno, lf->lr);
  1342. if (err < 0 && err != -EEXIST)
  1343. return err;
  1344. return 0;
  1345. }
  1346. /* Find line range from its line number */
  1347. static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
  1348. {
  1349. int ret;
  1350. ret = die_walk_lines(sp_die ?: &lf->cu_die, line_range_walk_cb, lf);
  1351. /* Update status */
  1352. if (ret >= 0)
  1353. if (!intlist__empty(lf->lr->line_list))
  1354. ret = lf->found = 1;
  1355. else
  1356. ret = 0; /* Lines are not found */
  1357. else {
  1358. zfree(&lf->lr->path);
  1359. }
  1360. return ret;
  1361. }
  1362. static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
  1363. {
  1364. int ret = find_line_range_by_line(in_die, data);
  1365. /*
  1366. * We have to check all instances of inlined function, because
  1367. * some execution paths can be optimized out depends on the
  1368. * function argument of instances. However, if an error occurs,
  1369. * it should be handled by the caller.
  1370. */
  1371. return ret < 0 ? ret : 0;
  1372. }
  1373. /* Search function definition from function name */
  1374. static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
  1375. {
  1376. struct dwarf_callback_param *param = data;
  1377. struct line_finder *lf = param->data;
  1378. struct line_range *lr = lf->lr;
  1379. /* Check declared file */
  1380. if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
  1381. return DWARF_CB_OK;
  1382. if (die_is_func_def(sp_die) &&
  1383. die_match_name(sp_die, lr->function)) {
  1384. lf->fname = dwarf_decl_file(sp_die);
  1385. dwarf_decl_line(sp_die, &lr->offset);
  1386. pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
  1387. lf->lno_s = lr->offset + lr->start;
  1388. if (lf->lno_s < 0) /* Overflow */
  1389. lf->lno_s = INT_MAX;
  1390. lf->lno_e = lr->offset + lr->end;
  1391. if (lf->lno_e < 0) /* Overflow */
  1392. lf->lno_e = INT_MAX;
  1393. pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
  1394. lr->start = lf->lno_s;
  1395. lr->end = lf->lno_e;
  1396. if (!die_is_func_instance(sp_die))
  1397. param->retval = die_walk_instances(sp_die,
  1398. line_range_inline_cb, lf);
  1399. else
  1400. param->retval = find_line_range_by_line(sp_die, lf);
  1401. return DWARF_CB_ABORT;
  1402. }
  1403. return DWARF_CB_OK;
  1404. }
  1405. static int find_line_range_by_func(struct line_finder *lf)
  1406. {
  1407. struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
  1408. dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
  1409. return param.retval;
  1410. }
  1411. int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
  1412. {
  1413. struct line_finder lf = {.lr = lr, .found = 0};
  1414. int ret = 0;
  1415. Dwarf_Off off = 0, noff;
  1416. size_t cuhl;
  1417. Dwarf_Die *diep;
  1418. const char *comp_dir;
  1419. /* Fastpath: lookup by function name from .debug_pubnames section */
  1420. if (lr->function) {
  1421. struct pubname_callback_param pubname_param = {
  1422. .function = lr->function, .file = lr->file,
  1423. .cu_die = &lf.cu_die, .sp_die = &lf.sp_die, .found = 0};
  1424. struct dwarf_callback_param line_range_param = {
  1425. .data = (void *)&lf, .retval = 0};
  1426. dwarf_getpubnames(dbg->dbg, pubname_search_cb,
  1427. &pubname_param, 0);
  1428. if (pubname_param.found) {
  1429. line_range_search_cb(&lf.sp_die, &line_range_param);
  1430. if (lf.found)
  1431. goto found;
  1432. }
  1433. }
  1434. /* Loop on CUs (Compilation Unit) */
  1435. while (!lf.found && ret >= 0) {
  1436. if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
  1437. NULL, NULL, NULL) != 0)
  1438. break;
  1439. /* Get the DIE(Debugging Information Entry) of this CU */
  1440. diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
  1441. if (!diep)
  1442. continue;
  1443. /* Check if target file is included. */
  1444. if (lr->file)
  1445. lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
  1446. else
  1447. lf.fname = 0;
  1448. if (!lr->file || lf.fname) {
  1449. if (lr->function)
  1450. ret = find_line_range_by_func(&lf);
  1451. else {
  1452. lf.lno_s = lr->start;
  1453. lf.lno_e = lr->end;
  1454. ret = find_line_range_by_line(NULL, &lf);
  1455. }
  1456. }
  1457. off = noff;
  1458. }
  1459. found:
  1460. /* Store comp_dir */
  1461. if (lf.found) {
  1462. comp_dir = cu_get_comp_dir(&lf.cu_die);
  1463. if (comp_dir) {
  1464. lr->comp_dir = strdup(comp_dir);
  1465. if (!lr->comp_dir)
  1466. ret = -ENOMEM;
  1467. }
  1468. }
  1469. pr_debug("path: %s\n", lr->path);
  1470. return (ret < 0) ? ret : lf.found;
  1471. }
  1472. /*
  1473. * Find a src file from a DWARF tag path. Prepend optional source path prefix
  1474. * and chop off leading directories that do not exist. Result is passed back as
  1475. * a newly allocated path on success.
  1476. * Return 0 if file was found and readable, -errno otherwise.
  1477. */
  1478. int get_real_path(const char *raw_path, const char *comp_dir,
  1479. char **new_path)
  1480. {
  1481. const char *prefix = symbol_conf.source_prefix;
  1482. if (!prefix) {
  1483. if (raw_path[0] != '/' && comp_dir)
  1484. /* If not an absolute path, try to use comp_dir */
  1485. prefix = comp_dir;
  1486. else {
  1487. if (access(raw_path, R_OK) == 0) {
  1488. *new_path = strdup(raw_path);
  1489. return *new_path ? 0 : -ENOMEM;
  1490. } else
  1491. return -errno;
  1492. }
  1493. }
  1494. *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
  1495. if (!*new_path)
  1496. return -ENOMEM;
  1497. for (;;) {
  1498. sprintf(*new_path, "%s/%s", prefix, raw_path);
  1499. if (access(*new_path, R_OK) == 0)
  1500. return 0;
  1501. if (!symbol_conf.source_prefix) {
  1502. /* In case of searching comp_dir, don't retry */
  1503. zfree(new_path);
  1504. return -errno;
  1505. }
  1506. switch (errno) {
  1507. case ENAMETOOLONG:
  1508. case ENOENT:
  1509. case EROFS:
  1510. case EFAULT:
  1511. raw_path = strchr(++raw_path, '/');
  1512. if (!raw_path) {
  1513. zfree(new_path);
  1514. return -ENOENT;
  1515. }
  1516. continue;
  1517. default:
  1518. zfree(new_path);
  1519. return -errno;
  1520. }
  1521. }
  1522. }