probe-finder.c 45 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813
  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. Dwarf_Frame *frame = NULL;
  589. size_t nops;
  590. int ret;
  591. if (!sc_die) {
  592. pr_err("Caller must pass a scope DIE. Program error.\n");
  593. return -EINVAL;
  594. }
  595. /* If not a real subprogram, find a real one */
  596. if (!die_is_func_def(sc_die)) {
  597. if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
  598. if (die_find_tailfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
  599. pr_warning("Ignoring tail call from %s\n",
  600. dwarf_diename(&pf->sp_die));
  601. return 0;
  602. } else {
  603. pr_warning("Failed to find probe point in any "
  604. "functions.\n");
  605. return -ENOENT;
  606. }
  607. }
  608. } else
  609. memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
  610. /* Get the frame base attribute/ops from subprogram */
  611. dwarf_attr(&pf->sp_die, DW_AT_frame_base, &fb_attr);
  612. ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
  613. if (ret <= 0 || nops == 0) {
  614. pf->fb_ops = NULL;
  615. #if _ELFUTILS_PREREQ(0, 142)
  616. } else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
  617. (pf->cfi_eh != NULL || pf->cfi_dbg != NULL)) {
  618. if ((dwarf_cfi_addrframe(pf->cfi_eh, pf->addr, &frame) != 0 &&
  619. (dwarf_cfi_addrframe(pf->cfi_dbg, pf->addr, &frame) != 0)) ||
  620. dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
  621. pr_warning("Failed to get call frame on 0x%jx\n",
  622. (uintmax_t)pf->addr);
  623. free(frame);
  624. return -ENOENT;
  625. }
  626. #endif
  627. }
  628. /* Call finder's callback handler */
  629. ret = pf->callback(sc_die, pf);
  630. /* Since *pf->fb_ops can be a part of frame. we should free it here. */
  631. free(frame);
  632. pf->fb_ops = NULL;
  633. return ret;
  634. }
  635. struct find_scope_param {
  636. const char *function;
  637. const char *file;
  638. int line;
  639. int diff;
  640. Dwarf_Die *die_mem;
  641. bool found;
  642. };
  643. static int find_best_scope_cb(Dwarf_Die *fn_die, void *data)
  644. {
  645. struct find_scope_param *fsp = data;
  646. const char *file;
  647. int lno;
  648. /* Skip if declared file name does not match */
  649. if (fsp->file) {
  650. file = dwarf_decl_file(fn_die);
  651. if (!file || strcmp(fsp->file, file) != 0)
  652. return 0;
  653. }
  654. /* If the function name is given, that's what user expects */
  655. if (fsp->function) {
  656. if (die_match_name(fn_die, fsp->function)) {
  657. memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
  658. fsp->found = true;
  659. return 1;
  660. }
  661. } else {
  662. /* With the line number, find the nearest declared DIE */
  663. dwarf_decl_line(fn_die, &lno);
  664. if (lno < fsp->line && fsp->diff > fsp->line - lno) {
  665. /* Keep a candidate and continue */
  666. fsp->diff = fsp->line - lno;
  667. memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
  668. fsp->found = true;
  669. }
  670. }
  671. return 0;
  672. }
  673. /* Find an appropriate scope fits to given conditions */
  674. static Dwarf_Die *find_best_scope(struct probe_finder *pf, Dwarf_Die *die_mem)
  675. {
  676. struct find_scope_param fsp = {
  677. .function = pf->pev->point.function,
  678. .file = pf->fname,
  679. .line = pf->lno,
  680. .diff = INT_MAX,
  681. .die_mem = die_mem,
  682. .found = false,
  683. };
  684. cu_walk_functions_at(&pf->cu_die, pf->addr, find_best_scope_cb, &fsp);
  685. return fsp.found ? die_mem : NULL;
  686. }
  687. static int probe_point_line_walker(const char *fname, int lineno,
  688. Dwarf_Addr addr, void *data)
  689. {
  690. struct probe_finder *pf = data;
  691. Dwarf_Die *sc_die, die_mem;
  692. int ret;
  693. if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
  694. return 0;
  695. pf->addr = addr;
  696. sc_die = find_best_scope(pf, &die_mem);
  697. if (!sc_die) {
  698. pr_warning("Failed to find scope of probe point.\n");
  699. return -ENOENT;
  700. }
  701. ret = call_probe_finder(sc_die, pf);
  702. /* Continue if no error, because the line will be in inline function */
  703. return ret < 0 ? ret : 0;
  704. }
  705. /* Find probe point from its line number */
  706. static int find_probe_point_by_line(struct probe_finder *pf)
  707. {
  708. return die_walk_lines(&pf->cu_die, probe_point_line_walker, pf);
  709. }
  710. /* Find lines which match lazy pattern */
  711. static int find_lazy_match_lines(struct intlist *list,
  712. const char *fname, const char *pat)
  713. {
  714. FILE *fp;
  715. char *line = NULL;
  716. size_t line_len;
  717. ssize_t len;
  718. int count = 0, linenum = 1;
  719. char sbuf[STRERR_BUFSIZE];
  720. fp = fopen(fname, "r");
  721. if (!fp) {
  722. pr_warning("Failed to open %s: %s\n", fname,
  723. strerror_r(errno, sbuf, sizeof(sbuf)));
  724. return -errno;
  725. }
  726. while ((len = getline(&line, &line_len, fp)) > 0) {
  727. if (line[len - 1] == '\n')
  728. line[len - 1] = '\0';
  729. if (strlazymatch(line, pat)) {
  730. intlist__add(list, linenum);
  731. count++;
  732. }
  733. linenum++;
  734. }
  735. if (ferror(fp))
  736. count = -errno;
  737. free(line);
  738. fclose(fp);
  739. if (count == 0)
  740. pr_debug("No matched lines found in %s.\n", fname);
  741. return count;
  742. }
  743. static int probe_point_lazy_walker(const char *fname, int lineno,
  744. Dwarf_Addr addr, void *data)
  745. {
  746. struct probe_finder *pf = data;
  747. Dwarf_Die *sc_die, die_mem;
  748. int ret;
  749. if (!intlist__has_entry(pf->lcache, lineno) ||
  750. strtailcmp(fname, pf->fname) != 0)
  751. return 0;
  752. pr_debug("Probe line found: line:%d addr:0x%llx\n",
  753. lineno, (unsigned long long)addr);
  754. pf->addr = addr;
  755. pf->lno = lineno;
  756. sc_die = find_best_scope(pf, &die_mem);
  757. if (!sc_die) {
  758. pr_warning("Failed to find scope of probe point.\n");
  759. return -ENOENT;
  760. }
  761. ret = call_probe_finder(sc_die, pf);
  762. /*
  763. * Continue if no error, because the lazy pattern will match
  764. * to other lines
  765. */
  766. return ret < 0 ? ret : 0;
  767. }
  768. /* Find probe points from lazy pattern */
  769. static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
  770. {
  771. int ret = 0;
  772. char *fpath;
  773. if (intlist__empty(pf->lcache)) {
  774. const char *comp_dir;
  775. comp_dir = cu_get_comp_dir(&pf->cu_die);
  776. ret = get_real_path(pf->fname, comp_dir, &fpath);
  777. if (ret < 0) {
  778. pr_warning("Failed to find source file path.\n");
  779. return ret;
  780. }
  781. /* Matching lazy line pattern */
  782. ret = find_lazy_match_lines(pf->lcache, fpath,
  783. pf->pev->point.lazy_line);
  784. free(fpath);
  785. if (ret <= 0)
  786. return ret;
  787. }
  788. return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
  789. }
  790. static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
  791. {
  792. struct probe_finder *pf = data;
  793. struct perf_probe_point *pp = &pf->pev->point;
  794. Dwarf_Addr addr;
  795. int ret;
  796. if (pp->lazy_line)
  797. ret = find_probe_point_lazy(in_die, pf);
  798. else {
  799. /* Get probe address */
  800. if (dwarf_entrypc(in_die, &addr) != 0) {
  801. pr_warning("Failed to get entry address of %s.\n",
  802. dwarf_diename(in_die));
  803. return -ENOENT;
  804. }
  805. pf->addr = addr;
  806. pf->addr += pp->offset;
  807. pr_debug("found inline addr: 0x%jx\n",
  808. (uintmax_t)pf->addr);
  809. ret = call_probe_finder(in_die, pf);
  810. }
  811. return ret;
  812. }
  813. /* Callback parameter with return value for libdw */
  814. struct dwarf_callback_param {
  815. void *data;
  816. int retval;
  817. };
  818. /* Search function from function name */
  819. static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
  820. {
  821. struct dwarf_callback_param *param = data;
  822. struct probe_finder *pf = param->data;
  823. struct perf_probe_point *pp = &pf->pev->point;
  824. /* Check tag and diename */
  825. if (!die_is_func_def(sp_die) ||
  826. !die_match_name(sp_die, pp->function))
  827. return DWARF_CB_OK;
  828. /* Check declared file */
  829. if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
  830. return DWARF_CB_OK;
  831. pr_debug("Matched function: %s\n", dwarf_diename(sp_die));
  832. pf->fname = dwarf_decl_file(sp_die);
  833. if (pp->line) { /* Function relative line */
  834. dwarf_decl_line(sp_die, &pf->lno);
  835. pf->lno += pp->line;
  836. param->retval = find_probe_point_by_line(pf);
  837. } else if (die_is_func_instance(sp_die)) {
  838. /* Instances always have the entry address */
  839. dwarf_entrypc(sp_die, &pf->addr);
  840. /* Real function */
  841. if (pp->lazy_line)
  842. param->retval = find_probe_point_lazy(sp_die, pf);
  843. else {
  844. pf->addr += pp->offset;
  845. /* TODO: Check the address in this function */
  846. param->retval = call_probe_finder(sp_die, pf);
  847. }
  848. } else if (!probe_conf.no_inlines) {
  849. /* Inlined function: search instances */
  850. param->retval = die_walk_instances(sp_die,
  851. probe_point_inline_cb, (void *)pf);
  852. /* This could be a non-existed inline definition */
  853. if (param->retval == -ENOENT && strisglob(pp->function))
  854. param->retval = 0;
  855. }
  856. /* We need to find other candidates */
  857. if (strisglob(pp->function) && param->retval >= 0) {
  858. param->retval = 0; /* We have to clear the result */
  859. return DWARF_CB_OK;
  860. }
  861. return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
  862. }
  863. static int find_probe_point_by_func(struct probe_finder *pf)
  864. {
  865. struct dwarf_callback_param _param = {.data = (void *)pf,
  866. .retval = 0};
  867. dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
  868. return _param.retval;
  869. }
  870. struct pubname_callback_param {
  871. char *function;
  872. char *file;
  873. Dwarf_Die *cu_die;
  874. Dwarf_Die *sp_die;
  875. int found;
  876. };
  877. static int pubname_search_cb(Dwarf *dbg, Dwarf_Global *gl, void *data)
  878. {
  879. struct pubname_callback_param *param = data;
  880. if (dwarf_offdie(dbg, gl->die_offset, param->sp_die)) {
  881. if (dwarf_tag(param->sp_die) != DW_TAG_subprogram)
  882. return DWARF_CB_OK;
  883. if (die_match_name(param->sp_die, param->function)) {
  884. if (!dwarf_offdie(dbg, gl->cu_offset, param->cu_die))
  885. return DWARF_CB_OK;
  886. if (param->file &&
  887. strtailcmp(param->file, dwarf_decl_file(param->sp_die)))
  888. return DWARF_CB_OK;
  889. param->found = 1;
  890. return DWARF_CB_ABORT;
  891. }
  892. }
  893. return DWARF_CB_OK;
  894. }
  895. static int debuginfo__find_probe_location(struct debuginfo *dbg,
  896. struct probe_finder *pf)
  897. {
  898. struct perf_probe_point *pp = &pf->pev->point;
  899. Dwarf_Off off, noff;
  900. size_t cuhl;
  901. Dwarf_Die *diep;
  902. int ret = 0;
  903. off = 0;
  904. pf->lcache = intlist__new(NULL);
  905. if (!pf->lcache)
  906. return -ENOMEM;
  907. /* Fastpath: lookup by function name from .debug_pubnames section */
  908. if (pp->function && !strisglob(pp->function)) {
  909. struct pubname_callback_param pubname_param = {
  910. .function = pp->function,
  911. .file = pp->file,
  912. .cu_die = &pf->cu_die,
  913. .sp_die = &pf->sp_die,
  914. .found = 0,
  915. };
  916. struct dwarf_callback_param probe_param = {
  917. .data = pf,
  918. };
  919. dwarf_getpubnames(dbg->dbg, pubname_search_cb,
  920. &pubname_param, 0);
  921. if (pubname_param.found) {
  922. ret = probe_point_search_cb(&pf->sp_die, &probe_param);
  923. if (ret)
  924. goto found;
  925. }
  926. }
  927. /* Loop on CUs (Compilation Unit) */
  928. while (!dwarf_nextcu(dbg->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
  929. /* Get the DIE(Debugging Information Entry) of this CU */
  930. diep = dwarf_offdie(dbg->dbg, off + cuhl, &pf->cu_die);
  931. if (!diep)
  932. continue;
  933. /* Check if target file is included. */
  934. if (pp->file)
  935. pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
  936. else
  937. pf->fname = NULL;
  938. if (!pp->file || pf->fname) {
  939. if (pp->function)
  940. ret = find_probe_point_by_func(pf);
  941. else if (pp->lazy_line)
  942. ret = find_probe_point_lazy(&pf->cu_die, pf);
  943. else {
  944. pf->lno = pp->line;
  945. ret = find_probe_point_by_line(pf);
  946. }
  947. if (ret < 0)
  948. break;
  949. }
  950. off = noff;
  951. }
  952. found:
  953. intlist__delete(pf->lcache);
  954. pf->lcache = NULL;
  955. return ret;
  956. }
  957. /* Find probe points from debuginfo */
  958. static int debuginfo__find_probes(struct debuginfo *dbg,
  959. struct probe_finder *pf)
  960. {
  961. int ret = 0;
  962. #if _ELFUTILS_PREREQ(0, 142)
  963. Elf *elf;
  964. GElf_Ehdr ehdr;
  965. GElf_Shdr shdr;
  966. if (pf->cfi_eh || pf->cfi_dbg)
  967. return debuginfo__find_probe_location(dbg, pf);
  968. /* Get the call frame information from this dwarf */
  969. elf = dwarf_getelf(dbg->dbg);
  970. if (elf == NULL)
  971. return -EINVAL;
  972. if (gelf_getehdr(elf, &ehdr) == NULL)
  973. return -EINVAL;
  974. if (elf_section_by_name(elf, &ehdr, &shdr, ".eh_frame", NULL) &&
  975. shdr.sh_type == SHT_PROGBITS)
  976. pf->cfi_eh = dwarf_getcfi_elf(elf);
  977. pf->cfi_dbg = dwarf_getcfi(dbg->dbg);
  978. #endif
  979. ret = debuginfo__find_probe_location(dbg, pf);
  980. return ret;
  981. }
  982. struct local_vars_finder {
  983. struct probe_finder *pf;
  984. struct perf_probe_arg *args;
  985. bool vars;
  986. int max_args;
  987. int nargs;
  988. int ret;
  989. };
  990. /* Collect available variables in this scope */
  991. static int copy_variables_cb(Dwarf_Die *die_mem, void *data)
  992. {
  993. struct local_vars_finder *vf = data;
  994. struct probe_finder *pf = vf->pf;
  995. int tag;
  996. tag = dwarf_tag(die_mem);
  997. if (tag == DW_TAG_formal_parameter ||
  998. (tag == DW_TAG_variable && vf->vars)) {
  999. if (convert_variable_location(die_mem, vf->pf->addr,
  1000. vf->pf->fb_ops, &pf->sp_die,
  1001. NULL) == 0) {
  1002. vf->args[vf->nargs].var = (char *)dwarf_diename(die_mem);
  1003. if (vf->args[vf->nargs].var == NULL) {
  1004. vf->ret = -ENOMEM;
  1005. return DIE_FIND_CB_END;
  1006. }
  1007. pr_debug(" %s", vf->args[vf->nargs].var);
  1008. vf->nargs++;
  1009. }
  1010. }
  1011. if (dwarf_haspc(die_mem, vf->pf->addr))
  1012. return DIE_FIND_CB_CONTINUE;
  1013. else
  1014. return DIE_FIND_CB_SIBLING;
  1015. }
  1016. static int expand_probe_args(Dwarf_Die *sc_die, struct probe_finder *pf,
  1017. struct perf_probe_arg *args)
  1018. {
  1019. Dwarf_Die die_mem;
  1020. int i;
  1021. int n = 0;
  1022. struct local_vars_finder vf = {.pf = pf, .args = args, .vars = false,
  1023. .max_args = MAX_PROBE_ARGS, .ret = 0};
  1024. for (i = 0; i < pf->pev->nargs; i++) {
  1025. /* var never be NULL */
  1026. if (strcmp(pf->pev->args[i].var, PROBE_ARG_VARS) == 0)
  1027. vf.vars = true;
  1028. else if (strcmp(pf->pev->args[i].var, PROBE_ARG_PARAMS) != 0) {
  1029. /* Copy normal argument */
  1030. args[n] = pf->pev->args[i];
  1031. n++;
  1032. continue;
  1033. }
  1034. pr_debug("Expanding %s into:", pf->pev->args[i].var);
  1035. vf.nargs = n;
  1036. /* Special local variables */
  1037. die_find_child(sc_die, copy_variables_cb, (void *)&vf,
  1038. &die_mem);
  1039. pr_debug(" (%d)\n", vf.nargs - n);
  1040. if (vf.ret < 0)
  1041. return vf.ret;
  1042. n = vf.nargs;
  1043. }
  1044. return n;
  1045. }
  1046. /* Add a found probe point into trace event list */
  1047. static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
  1048. {
  1049. struct trace_event_finder *tf =
  1050. container_of(pf, struct trace_event_finder, pf);
  1051. struct perf_probe_point *pp = &pf->pev->point;
  1052. struct probe_trace_event *tev;
  1053. struct perf_probe_arg *args = NULL;
  1054. int ret, i;
  1055. /* Check number of tevs */
  1056. if (tf->ntevs == tf->max_tevs) {
  1057. pr_warning("Too many( > %d) probe point found.\n",
  1058. tf->max_tevs);
  1059. return -ERANGE;
  1060. }
  1061. tev = &tf->tevs[tf->ntevs++];
  1062. /* Trace point should be converted from subprogram DIE */
  1063. ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
  1064. pp->retprobe, pp->function, &tev->point);
  1065. if (ret < 0)
  1066. goto end;
  1067. tev->point.realname = strdup(dwarf_diename(sc_die));
  1068. if (!tev->point.realname) {
  1069. ret = -ENOMEM;
  1070. goto end;
  1071. }
  1072. pr_debug("Probe point found: %s+%lu\n", tev->point.symbol,
  1073. tev->point.offset);
  1074. /* Expand special probe argument if exist */
  1075. args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
  1076. if (args == NULL) {
  1077. ret = -ENOMEM;
  1078. goto end;
  1079. }
  1080. ret = expand_probe_args(sc_die, pf, args);
  1081. if (ret < 0)
  1082. goto end;
  1083. tev->nargs = ret;
  1084. tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
  1085. if (tev->args == NULL) {
  1086. ret = -ENOMEM;
  1087. goto end;
  1088. }
  1089. /* Find each argument */
  1090. for (i = 0; i < tev->nargs; i++) {
  1091. pf->pvar = &args[i];
  1092. pf->tvar = &tev->args[i];
  1093. /* Variable should be found from scope DIE */
  1094. ret = find_variable(sc_die, pf);
  1095. if (ret != 0)
  1096. break;
  1097. }
  1098. end:
  1099. if (ret) {
  1100. clear_probe_trace_event(tev);
  1101. tf->ntevs--;
  1102. }
  1103. free(args);
  1104. return ret;
  1105. }
  1106. /* Find probe_trace_events specified by perf_probe_event from debuginfo */
  1107. int debuginfo__find_trace_events(struct debuginfo *dbg,
  1108. struct perf_probe_event *pev,
  1109. struct probe_trace_event **tevs)
  1110. {
  1111. struct trace_event_finder tf = {
  1112. .pf = {.pev = pev, .callback = add_probe_trace_event},
  1113. .max_tevs = probe_conf.max_probes, .mod = dbg->mod};
  1114. int ret, i;
  1115. /* Allocate result tevs array */
  1116. *tevs = zalloc(sizeof(struct probe_trace_event) * tf.max_tevs);
  1117. if (*tevs == NULL)
  1118. return -ENOMEM;
  1119. tf.tevs = *tevs;
  1120. tf.ntevs = 0;
  1121. ret = debuginfo__find_probes(dbg, &tf.pf);
  1122. if (ret < 0) {
  1123. for (i = 0; i < tf.ntevs; i++)
  1124. clear_probe_trace_event(&tf.tevs[i]);
  1125. zfree(tevs);
  1126. return ret;
  1127. }
  1128. return (ret < 0) ? ret : tf.ntevs;
  1129. }
  1130. /* Collect available variables in this scope */
  1131. static int collect_variables_cb(Dwarf_Die *die_mem, void *data)
  1132. {
  1133. struct available_var_finder *af = data;
  1134. struct variable_list *vl;
  1135. int tag, ret;
  1136. vl = &af->vls[af->nvls - 1];
  1137. tag = dwarf_tag(die_mem);
  1138. if (tag == DW_TAG_formal_parameter ||
  1139. tag == DW_TAG_variable) {
  1140. ret = convert_variable_location(die_mem, af->pf.addr,
  1141. af->pf.fb_ops, &af->pf.sp_die,
  1142. NULL);
  1143. if (ret == 0 || ret == -ERANGE) {
  1144. int ret2;
  1145. bool externs = !af->child;
  1146. struct strbuf buf;
  1147. strbuf_init(&buf, 64);
  1148. if (probe_conf.show_location_range) {
  1149. if (!externs) {
  1150. if (ret)
  1151. strbuf_add(&buf, "[INV]\t", 6);
  1152. else
  1153. strbuf_add(&buf, "[VAL]\t", 6);
  1154. } else
  1155. strbuf_add(&buf, "[EXT]\t", 6);
  1156. }
  1157. ret2 = die_get_varname(die_mem, &buf);
  1158. if (!ret2 && probe_conf.show_location_range &&
  1159. !externs) {
  1160. strbuf_addch(&buf, '\t');
  1161. ret2 = die_get_var_range(&af->pf.sp_die,
  1162. die_mem, &buf);
  1163. }
  1164. pr_debug("Add new var: %s\n", buf.buf);
  1165. if (ret2 == 0) {
  1166. strlist__add(vl->vars,
  1167. strbuf_detach(&buf, NULL));
  1168. }
  1169. strbuf_release(&buf);
  1170. }
  1171. }
  1172. if (af->child && dwarf_haspc(die_mem, af->pf.addr))
  1173. return DIE_FIND_CB_CONTINUE;
  1174. else
  1175. return DIE_FIND_CB_SIBLING;
  1176. }
  1177. /* Add a found vars into available variables list */
  1178. static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
  1179. {
  1180. struct available_var_finder *af =
  1181. container_of(pf, struct available_var_finder, pf);
  1182. struct perf_probe_point *pp = &pf->pev->point;
  1183. struct variable_list *vl;
  1184. Dwarf_Die die_mem;
  1185. int ret;
  1186. /* Check number of tevs */
  1187. if (af->nvls == af->max_vls) {
  1188. pr_warning("Too many( > %d) probe point found.\n", af->max_vls);
  1189. return -ERANGE;
  1190. }
  1191. vl = &af->vls[af->nvls++];
  1192. /* Trace point should be converted from subprogram DIE */
  1193. ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
  1194. pp->retprobe, pp->function, &vl->point);
  1195. if (ret < 0)
  1196. return ret;
  1197. pr_debug("Probe point found: %s+%lu\n", vl->point.symbol,
  1198. vl->point.offset);
  1199. /* Find local variables */
  1200. vl->vars = strlist__new(NULL, NULL);
  1201. if (vl->vars == NULL)
  1202. return -ENOMEM;
  1203. af->child = true;
  1204. die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
  1205. /* Find external variables */
  1206. if (!probe_conf.show_ext_vars)
  1207. goto out;
  1208. /* Don't need to search child DIE for external vars. */
  1209. af->child = false;
  1210. die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
  1211. out:
  1212. if (strlist__empty(vl->vars)) {
  1213. strlist__delete(vl->vars);
  1214. vl->vars = NULL;
  1215. }
  1216. return ret;
  1217. }
  1218. /*
  1219. * Find available variables at given probe point
  1220. * Return the number of found probe points. Return 0 if there is no
  1221. * matched probe point. Return <0 if an error occurs.
  1222. */
  1223. int debuginfo__find_available_vars_at(struct debuginfo *dbg,
  1224. struct perf_probe_event *pev,
  1225. struct variable_list **vls)
  1226. {
  1227. struct available_var_finder af = {
  1228. .pf = {.pev = pev, .callback = add_available_vars},
  1229. .mod = dbg->mod,
  1230. .max_vls = probe_conf.max_probes};
  1231. int ret;
  1232. /* Allocate result vls array */
  1233. *vls = zalloc(sizeof(struct variable_list) * af.max_vls);
  1234. if (*vls == NULL)
  1235. return -ENOMEM;
  1236. af.vls = *vls;
  1237. af.nvls = 0;
  1238. ret = debuginfo__find_probes(dbg, &af.pf);
  1239. if (ret < 0) {
  1240. /* Free vlist for error */
  1241. while (af.nvls--) {
  1242. zfree(&af.vls[af.nvls].point.symbol);
  1243. strlist__delete(af.vls[af.nvls].vars);
  1244. }
  1245. zfree(vls);
  1246. return ret;
  1247. }
  1248. return (ret < 0) ? ret : af.nvls;
  1249. }
  1250. /* For the kernel module, we need a special code to get a DIE */
  1251. static int debuginfo__get_text_offset(struct debuginfo *dbg, Dwarf_Addr *offs)
  1252. {
  1253. int n, i;
  1254. Elf32_Word shndx;
  1255. Elf_Scn *scn;
  1256. Elf *elf;
  1257. GElf_Shdr mem, *shdr;
  1258. const char *p;
  1259. elf = dwfl_module_getelf(dbg->mod, &dbg->bias);
  1260. if (!elf)
  1261. return -EINVAL;
  1262. /* Get the number of relocations */
  1263. n = dwfl_module_relocations(dbg->mod);
  1264. if (n < 0)
  1265. return -ENOENT;
  1266. /* Search the relocation related .text section */
  1267. for (i = 0; i < n; i++) {
  1268. p = dwfl_module_relocation_info(dbg->mod, i, &shndx);
  1269. if (strcmp(p, ".text") == 0) {
  1270. /* OK, get the section header */
  1271. scn = elf_getscn(elf, shndx);
  1272. if (!scn)
  1273. return -ENOENT;
  1274. shdr = gelf_getshdr(scn, &mem);
  1275. if (!shdr)
  1276. return -ENOENT;
  1277. *offs = shdr->sh_addr;
  1278. }
  1279. }
  1280. return 0;
  1281. }
  1282. /* Reverse search */
  1283. int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
  1284. struct perf_probe_point *ppt)
  1285. {
  1286. Dwarf_Die cudie, spdie, indie;
  1287. Dwarf_Addr _addr = 0, baseaddr = 0;
  1288. const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
  1289. int baseline = 0, lineno = 0, ret = 0;
  1290. bool reloc = false;
  1291. retry:
  1292. /* Find cu die */
  1293. if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr, &cudie)) {
  1294. if (!reloc && debuginfo__get_text_offset(dbg, &baseaddr) == 0) {
  1295. addr += baseaddr;
  1296. reloc = true;
  1297. goto retry;
  1298. }
  1299. pr_warning("Failed to find debug information for address %lx\n",
  1300. addr);
  1301. ret = -EINVAL;
  1302. goto end;
  1303. }
  1304. /* Find a corresponding line (filename and lineno) */
  1305. cu_find_lineinfo(&cudie, addr, &fname, &lineno);
  1306. /* Don't care whether it failed or not */
  1307. /* Find a corresponding function (name, baseline and baseaddr) */
  1308. if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
  1309. /* Get function entry information */
  1310. func = basefunc = dwarf_diename(&spdie);
  1311. if (!func ||
  1312. dwarf_entrypc(&spdie, &baseaddr) != 0 ||
  1313. dwarf_decl_line(&spdie, &baseline) != 0) {
  1314. lineno = 0;
  1315. goto post;
  1316. }
  1317. fname = dwarf_decl_file(&spdie);
  1318. if (addr == (unsigned long)baseaddr) {
  1319. /* Function entry - Relative line number is 0 */
  1320. lineno = baseline;
  1321. goto post;
  1322. }
  1323. /* Track down the inline functions step by step */
  1324. while (die_find_top_inlinefunc(&spdie, (Dwarf_Addr)addr,
  1325. &indie)) {
  1326. /* There is an inline function */
  1327. if (dwarf_entrypc(&indie, &_addr) == 0 &&
  1328. _addr == addr) {
  1329. /*
  1330. * addr is at an inline function entry.
  1331. * In this case, lineno should be the call-site
  1332. * line number. (overwrite lineinfo)
  1333. */
  1334. lineno = die_get_call_lineno(&indie);
  1335. fname = die_get_call_file(&indie);
  1336. break;
  1337. } else {
  1338. /*
  1339. * addr is in an inline function body.
  1340. * Since lineno points one of the lines
  1341. * of the inline function, baseline should
  1342. * be the entry line of the inline function.
  1343. */
  1344. tmp = dwarf_diename(&indie);
  1345. if (!tmp ||
  1346. dwarf_decl_line(&indie, &baseline) != 0)
  1347. break;
  1348. func = tmp;
  1349. spdie = indie;
  1350. }
  1351. }
  1352. /* Verify the lineno and baseline are in a same file */
  1353. tmp = dwarf_decl_file(&spdie);
  1354. if (!tmp || strcmp(tmp, fname) != 0)
  1355. lineno = 0;
  1356. }
  1357. post:
  1358. /* Make a relative line number or an offset */
  1359. if (lineno)
  1360. ppt->line = lineno - baseline;
  1361. else if (basefunc) {
  1362. ppt->offset = addr - (unsigned long)baseaddr;
  1363. func = basefunc;
  1364. }
  1365. /* Duplicate strings */
  1366. if (func) {
  1367. ppt->function = strdup(func);
  1368. if (ppt->function == NULL) {
  1369. ret = -ENOMEM;
  1370. goto end;
  1371. }
  1372. }
  1373. if (fname) {
  1374. ppt->file = strdup(fname);
  1375. if (ppt->file == NULL) {
  1376. zfree(&ppt->function);
  1377. ret = -ENOMEM;
  1378. goto end;
  1379. }
  1380. }
  1381. end:
  1382. if (ret == 0 && (fname || func))
  1383. ret = 1; /* Found a point */
  1384. return ret;
  1385. }
  1386. /* Add a line and store the src path */
  1387. static int line_range_add_line(const char *src, unsigned int lineno,
  1388. struct line_range *lr)
  1389. {
  1390. /* Copy source path */
  1391. if (!lr->path) {
  1392. lr->path = strdup(src);
  1393. if (lr->path == NULL)
  1394. return -ENOMEM;
  1395. }
  1396. return intlist__add(lr->line_list, lineno);
  1397. }
  1398. static int line_range_walk_cb(const char *fname, int lineno,
  1399. Dwarf_Addr addr __maybe_unused,
  1400. void *data)
  1401. {
  1402. struct line_finder *lf = data;
  1403. int err;
  1404. if ((strtailcmp(fname, lf->fname) != 0) ||
  1405. (lf->lno_s > lineno || lf->lno_e < lineno))
  1406. return 0;
  1407. err = line_range_add_line(fname, lineno, lf->lr);
  1408. if (err < 0 && err != -EEXIST)
  1409. return err;
  1410. return 0;
  1411. }
  1412. /* Find line range from its line number */
  1413. static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
  1414. {
  1415. int ret;
  1416. ret = die_walk_lines(sp_die ?: &lf->cu_die, line_range_walk_cb, lf);
  1417. /* Update status */
  1418. if (ret >= 0)
  1419. if (!intlist__empty(lf->lr->line_list))
  1420. ret = lf->found = 1;
  1421. else
  1422. ret = 0; /* Lines are not found */
  1423. else {
  1424. zfree(&lf->lr->path);
  1425. }
  1426. return ret;
  1427. }
  1428. static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
  1429. {
  1430. int ret = find_line_range_by_line(in_die, data);
  1431. /*
  1432. * We have to check all instances of inlined function, because
  1433. * some execution paths can be optimized out depends on the
  1434. * function argument of instances. However, if an error occurs,
  1435. * it should be handled by the caller.
  1436. */
  1437. return ret < 0 ? ret : 0;
  1438. }
  1439. /* Search function definition from function name */
  1440. static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
  1441. {
  1442. struct dwarf_callback_param *param = data;
  1443. struct line_finder *lf = param->data;
  1444. struct line_range *lr = lf->lr;
  1445. /* Check declared file */
  1446. if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
  1447. return DWARF_CB_OK;
  1448. if (die_is_func_def(sp_die) &&
  1449. die_match_name(sp_die, lr->function)) {
  1450. lf->fname = dwarf_decl_file(sp_die);
  1451. dwarf_decl_line(sp_die, &lr->offset);
  1452. pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
  1453. lf->lno_s = lr->offset + lr->start;
  1454. if (lf->lno_s < 0) /* Overflow */
  1455. lf->lno_s = INT_MAX;
  1456. lf->lno_e = lr->offset + lr->end;
  1457. if (lf->lno_e < 0) /* Overflow */
  1458. lf->lno_e = INT_MAX;
  1459. pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
  1460. lr->start = lf->lno_s;
  1461. lr->end = lf->lno_e;
  1462. if (!die_is_func_instance(sp_die))
  1463. param->retval = die_walk_instances(sp_die,
  1464. line_range_inline_cb, lf);
  1465. else
  1466. param->retval = find_line_range_by_line(sp_die, lf);
  1467. return DWARF_CB_ABORT;
  1468. }
  1469. return DWARF_CB_OK;
  1470. }
  1471. static int find_line_range_by_func(struct line_finder *lf)
  1472. {
  1473. struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
  1474. dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
  1475. return param.retval;
  1476. }
  1477. int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
  1478. {
  1479. struct line_finder lf = {.lr = lr, .found = 0};
  1480. int ret = 0;
  1481. Dwarf_Off off = 0, noff;
  1482. size_t cuhl;
  1483. Dwarf_Die *diep;
  1484. const char *comp_dir;
  1485. /* Fastpath: lookup by function name from .debug_pubnames section */
  1486. if (lr->function) {
  1487. struct pubname_callback_param pubname_param = {
  1488. .function = lr->function, .file = lr->file,
  1489. .cu_die = &lf.cu_die, .sp_die = &lf.sp_die, .found = 0};
  1490. struct dwarf_callback_param line_range_param = {
  1491. .data = (void *)&lf, .retval = 0};
  1492. dwarf_getpubnames(dbg->dbg, pubname_search_cb,
  1493. &pubname_param, 0);
  1494. if (pubname_param.found) {
  1495. line_range_search_cb(&lf.sp_die, &line_range_param);
  1496. if (lf.found)
  1497. goto found;
  1498. }
  1499. }
  1500. /* Loop on CUs (Compilation Unit) */
  1501. while (!lf.found && ret >= 0) {
  1502. if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
  1503. NULL, NULL, NULL) != 0)
  1504. break;
  1505. /* Get the DIE(Debugging Information Entry) of this CU */
  1506. diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
  1507. if (!diep)
  1508. continue;
  1509. /* Check if target file is included. */
  1510. if (lr->file)
  1511. lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
  1512. else
  1513. lf.fname = 0;
  1514. if (!lr->file || lf.fname) {
  1515. if (lr->function)
  1516. ret = find_line_range_by_func(&lf);
  1517. else {
  1518. lf.lno_s = lr->start;
  1519. lf.lno_e = lr->end;
  1520. ret = find_line_range_by_line(NULL, &lf);
  1521. }
  1522. }
  1523. off = noff;
  1524. }
  1525. found:
  1526. /* Store comp_dir */
  1527. if (lf.found) {
  1528. comp_dir = cu_get_comp_dir(&lf.cu_die);
  1529. if (comp_dir) {
  1530. lr->comp_dir = strdup(comp_dir);
  1531. if (!lr->comp_dir)
  1532. ret = -ENOMEM;
  1533. }
  1534. }
  1535. pr_debug("path: %s\n", lr->path);
  1536. return (ret < 0) ? ret : lf.found;
  1537. }
  1538. /*
  1539. * Find a src file from a DWARF tag path. Prepend optional source path prefix
  1540. * and chop off leading directories that do not exist. Result is passed back as
  1541. * a newly allocated path on success.
  1542. * Return 0 if file was found and readable, -errno otherwise.
  1543. */
  1544. int get_real_path(const char *raw_path, const char *comp_dir,
  1545. char **new_path)
  1546. {
  1547. const char *prefix = symbol_conf.source_prefix;
  1548. if (!prefix) {
  1549. if (raw_path[0] != '/' && comp_dir)
  1550. /* If not an absolute path, try to use comp_dir */
  1551. prefix = comp_dir;
  1552. else {
  1553. if (access(raw_path, R_OK) == 0) {
  1554. *new_path = strdup(raw_path);
  1555. return *new_path ? 0 : -ENOMEM;
  1556. } else
  1557. return -errno;
  1558. }
  1559. }
  1560. *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
  1561. if (!*new_path)
  1562. return -ENOMEM;
  1563. for (;;) {
  1564. sprintf(*new_path, "%s/%s", prefix, raw_path);
  1565. if (access(*new_path, R_OK) == 0)
  1566. return 0;
  1567. if (!symbol_conf.source_prefix) {
  1568. /* In case of searching comp_dir, don't retry */
  1569. zfree(new_path);
  1570. return -errno;
  1571. }
  1572. switch (errno) {
  1573. case ENAMETOOLONG:
  1574. case ENOENT:
  1575. case EROFS:
  1576. case EFAULT:
  1577. raw_path = strchr(++raw_path, '/');
  1578. if (!raw_path) {
  1579. zfree(new_path);
  1580. return -ENOENT;
  1581. }
  1582. continue;
  1583. default:
  1584. zfree(new_path);
  1585. return -errno;
  1586. }
  1587. }
  1588. }