probe-finder.c 44 KB

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