2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2008 Nokia Corporation
7 * This software was developed by Attilio Rao for the IPSO project under
8 * contract to Nokia Corporation.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice unmodified, this list of conditions, and the following
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #include <sys/cdefs.h>
34 #include <sys/param.h>
35 #include <sys/queue.h>
45 /* NB: Make sure FNBUFF is as large as LNBUFF, otherwise it could overflow */
49 #define TMPNAME "pmcannotate.XXXXXX"
51 #define FATAL(ptr, x ...) do { \
53 general_deleteall(); \
56 fprintf(stderr, ##x); \
62 #define PERCSAMP(x) ((x) * 100 / totalsamples)
65 TAILQ_ENTRY(entry) en_iter;
74 TAILQ_ENTRY(aggent) ag_fiter;
82 static struct aggent *agg_create(const char *name, u_int nsamples,
83 uintptr_t start, uintptr_t end);
84 static void agg_destroy(struct aggent *agg) __unused;
85 static void asmparse(FILE *fp);
86 static int cparse(FILE *fp);
87 static void entry_acqref(struct entry *entry);
88 static struct entry *entry_create(const char *name, uintptr_t pc,
89 uintptr_t start, uintptr_t end);
90 static void entry_destroy(struct entry *entry) __unused;
91 static void fqueue_compact(float th);
92 static void fqueue_deleteall(void);
93 static struct aggent *fqueue_findent_by_name(const char *name);
94 static int fqueue_getall(const char *bin, char *temp, int asmf);
95 static int fqueue_insertent(struct entry *entry);
96 static int fqueue_insertgen(void);
97 static void general_deleteall(void);
98 static struct entry *general_findent(uintptr_t pc);
99 static void general_insertent(struct entry *entry);
100 static void general_printasm(FILE *fp, struct aggent *agg);
101 static int general_printc(FILE *fp, struct aggent *agg);
102 static int printblock(FILE *fp, struct aggent *agg);
103 static void usage(const char *progname) __dead2;
105 static TAILQ_HEAD(, entry) mainlst = TAILQ_HEAD_INITIALIZER(mainlst);
106 static TAILQ_HEAD(, aggent) fqueue = TAILQ_HEAD_INITIALIZER(fqueue);
109 * Use a float value in order to automatically promote operations
110 * to return a float value rather than use casts.
112 static float totalsamples;
115 * Identifies a string cointaining objdump's assembly printout.
118 isasminline(const char *str)
123 if (sscanf(str, " %p%n", &ptr, &nbytes) != 1)
125 if (str[nbytes] != ':' || isspace(str[nbytes + 1]) == 0)
131 * Identifies a string containing objdump's assembly printout
132 * for a new function.
135 newfunction(const char *str)
143 if (sscanf(str, "%p <%[^>:]>:%n", &ptr, fname, &nbytes) != 2)
149 * Create a new first-level aggregation object for a specified
152 static struct aggent *
153 agg_create(const char *name, u_int nsamples, uintptr_t start, uintptr_t end)
157 agg = calloc(1, sizeof(struct aggent));
160 agg->ag_name = strdup(name);
161 if (agg->ag_name == NULL) {
165 agg->ag_nsamples = nsamples;
166 agg->ag_ostart = start;
172 * Destroy a first-level aggregation object for a specified
176 agg_destroy(struct aggent *agg)
184 * Analyze the "objdump -d" output, locate functions and start
185 * printing out the assembly functions content.
186 * We do not use newfunction() because we actually need the
187 * function name in available form, but the heurstic used is
193 char buffer[LNBUFF], fname[FNBUFF];
197 while (fgets(buffer, LNBUFF, fp) != NULL) {
198 if (isspace(buffer[0]))
200 if (sscanf(buffer, "%p <%[^>:]>:", &ptr, fname) != 2)
202 agg = fqueue_findent_by_name(fname);
205 agg->ag_offset = ftell(fp);
208 TAILQ_FOREACH(agg, &fqueue, ag_fiter) {
209 if (fseek(fp, agg->ag_offset, SEEK_SET) == -1)
211 printf("Profile trace for function: %s() [%.2f%%]\n",
212 agg->ag_name, PERCSAMP(agg->ag_nsamples));
213 general_printasm(fp, agg);
219 * Analyze the "objdump -S" output, locate functions and start
220 * printing out the C functions content.
221 * We do not use newfunction() because we actually need the
222 * function name in available form, but the heurstic used is
224 * In order to maintain the printout sorted, on the first pass it
225 * simply stores the file offsets in order to fastly moved later
226 * (when the file is hot-cached also) when the real printout will
232 char buffer[LNBUFF], fname[FNBUFF];
236 while (fgets(buffer, LNBUFF, fp) != NULL) {
237 if (isspace(buffer[0]))
239 if (sscanf(buffer, "%p <%[^>:]>:", &ptr, fname) != 2)
241 agg = fqueue_findent_by_name(fname);
244 agg->ag_offset = ftell(fp);
247 TAILQ_FOREACH(agg, &fqueue, ag_fiter) {
248 if (fseek(fp, agg->ag_offset, SEEK_SET) == -1)
250 printf("Profile trace for function: %s() [%.2f%%]\n",
251 agg->ag_name, PERCSAMP(agg->ag_nsamples));
252 if (general_printc(fp, agg) == -1)
260 * Bump the number of samples for any raw entry.
263 entry_acqref(struct entry *entry)
266 entry->en_nsamples++;
270 * Create a new raw entry object for a specified function.
272 static struct entry *
273 entry_create(const char *name, uintptr_t pc, uintptr_t start, uintptr_t end)
277 obj = calloc(1, sizeof(struct entry));
280 obj->en_name = strdup(name);
281 if (obj->en_name == NULL) {
286 obj->en_ostart = start;
288 obj->en_nsamples = 1;
293 * Destroy a raw entry object for a specified function.
296 entry_destroy(struct entry *entry)
299 free(entry->en_name);
304 * Specify a lower bound in percentage and drop from the
305 * first-level aggregation queue all the objects with a
309 fqueue_compact(float th)
312 struct aggent *agg, *tmpagg;
314 if (totalsamples == 0)
317 /* Revert the percentage calculation. */
318 thi = th * totalsamples / 100;
319 TAILQ_FOREACH_SAFE(agg, &fqueue, ag_fiter, tmpagg)
320 if (agg->ag_nsamples < thi)
321 TAILQ_REMOVE(&fqueue, agg, ag_fiter);
325 * Flush the first-level aggregates queue.
328 fqueue_deleteall(void)
332 while (TAILQ_EMPTY(&fqueue) == 0) {
333 agg = TAILQ_FIRST(&fqueue);
334 TAILQ_REMOVE(&fqueue, agg, ag_fiter);
339 * Insert a raw entry into the aggregations queue.
340 * If the respective first-level aggregation object
341 * does not exist create it and maintain it sorted
342 * in respect of the number of samples.
345 fqueue_insertent(struct entry *entry)
347 struct aggent *obj, *tmp;
351 TAILQ_FOREACH(obj, &fqueue, ag_fiter)
352 if (!strcmp(obj->ag_name, entry->en_name)) {
354 obj->ag_nsamples += entry->en_nsamples;
359 * If the first-level aggregation object already exists,
360 * just aggregate the samples and, if needed, resort
364 TAILQ_REMOVE(&fqueue, obj, ag_fiter);
366 TAILQ_FOREACH(tmp, &fqueue, ag_fiter)
367 if (obj->ag_nsamples > tmp->ag_nsamples) {
372 TAILQ_INSERT_BEFORE(tmp, obj, ag_fiter);
374 TAILQ_INSERT_TAIL(&fqueue, obj, ag_fiter);
379 * If the first-level aggregation object does not
380 * exist, create it and put in the sorted queue.
381 * If this is the first object, we need to set the
384 obj = agg_create(entry->en_name, entry->en_nsamples, entry->en_ostart,
388 if (TAILQ_EMPTY(&fqueue) != 0) {
389 TAILQ_INSERT_HEAD(&fqueue, obj, ag_fiter);
392 TAILQ_FOREACH(tmp, &fqueue, ag_fiter)
393 if (obj->ag_nsamples > tmp->ag_nsamples) {
398 TAILQ_INSERT_BEFORE(tmp, obj, ag_fiter);
400 TAILQ_INSERT_TAIL(&fqueue, obj, ag_fiter);
405 * Lookup a first-level aggregation object by name.
407 static struct aggent *
408 fqueue_findent_by_name(const char *name)
412 TAILQ_FOREACH(obj, &fqueue, ag_fiter)
413 if (!strcmp(obj->ag_name, name))
419 * Return the number of object in the first-level aggregations queue.
422 fqueue_getall(const char *bin, char *temp, int asmf)
424 char tmpf[MAXPATHLEN * 2 + 50];
426 uintptr_t start, end;
428 if (mkstemp(temp) == -1)
430 TAILQ_FOREACH(agg, &fqueue, ag_fiter) {
431 bzero(tmpf, sizeof(tmpf));
432 start = agg->ag_ostart;
436 snprintf(tmpf, sizeof(tmpf),
437 "objdump --start-address=%p "
438 "--stop-address=%p -d %s >> %s", (void *)start,
439 (void *)end, bin, temp);
441 snprintf(tmpf, sizeof(tmpf),
442 "objdump --start-address=%p "
443 "--stop-address=%p -S %s >> %s", (void *)start,
444 (void *)end, bin, temp);
445 if (system(tmpf) != 0)
452 * Insert all the raw entries present in the general queue
453 * into the first-level aggregations queue.
456 fqueue_insertgen(void)
460 TAILQ_FOREACH(obj, &mainlst, en_iter)
461 if (fqueue_insertent(obj) == -1)
467 * Flush the raw entries general queue.
470 general_deleteall(void)
474 while (TAILQ_EMPTY(&mainlst) == 0) {
475 obj = TAILQ_FIRST(&mainlst);
476 TAILQ_REMOVE(&mainlst, obj, en_iter);
481 * Lookup a raw entry by the PC.
483 static struct entry *
484 general_findent(uintptr_t pc)
488 TAILQ_FOREACH(obj, &mainlst, en_iter)
489 if (obj->en_pc == pc)
495 * Insert a new raw entry in the general queue.
498 general_insertent(struct entry *entry)
501 TAILQ_INSERT_TAIL(&mainlst, entry, en_iter);
505 * Printout the body of an "objdump -d" assembly function.
506 * It does simply stops when a new function is encountered,
507 * bringing back the file position in order to not mess up
508 * subsequent analysis.
509 * C lines and others not recognized are simply skipped.
512 general_printasm(FILE *fp, struct aggent *agg)
519 while (fgets(buffer, LNBUFF, fp) != NULL) {
520 if ((nbytes = newfunction(buffer)) != 0) {
521 fseek(fp, nbytes * -1, SEEK_CUR);
524 if (!isasminline(buffer))
526 if (sscanf(buffer, " %p:", &ptr) != 1)
528 obj = general_findent((uintptr_t)ptr);
530 printf("\t| %s", buffer);
532 printf("%.2f%%\t| %s",
533 (float)obj->en_nsamples * 100 / agg->ag_nsamples,
539 * Printout the body of an "objdump -S" function.
540 * It does simply stops when a new function is encountered,
541 * bringing back the file position in order to not mess up
542 * subsequent analysis.
543 * It expect from the starting to the end to find, always, valid blocks
544 * (see below for an explanation of the "block" concept).
547 general_printc(FILE *fp, struct aggent *agg)
551 while (fgets(buffer, LNBUFF, fp) != NULL) {
552 fseek(fp, strlen(buffer) * -1, SEEK_CUR);
553 if (newfunction(buffer) != 0)
555 if (printblock(fp, agg) == -1)
562 * Printout a single block inside an "objdump -S" function.
563 * The block is composed of a first part in C and subsequent translation
565 * This code also operates a second-level aggregation packing together
566 * samples relative to PCs into a (lower bottom) block with their
567 * C (higher half) counterpart.
570 printblock(FILE *fp, struct aggent *agg)
576 int done, nbytes, sentinel;
580 * We expect the first thing of the block is C code, so simply give
581 * up if asm line is found.
586 if (fgets(buffer, LNBUFF, fp) == NULL)
588 if (isasminline(buffer) != 0)
591 nbytes = newfunction(buffer);
593 if (fseek(fp, nbytes * -1, SEEK_CUR) == -1)
600 * If the sentinel is not set, it means it did not match any
601 * "high half" for this code so simply give up.
602 * Operates the second-level aggregation.
608 if (sscanf(buffer, " %p:", &ptr) != 1)
610 obj = general_findent((uintptr_t)ptr);
612 tnsamples += obj->en_nsamples;
613 } while (fgets(buffer, LNBUFF, fp) != NULL && isasminline(buffer) != 0);
615 /* Rewind to the start of the block in order to start the printout. */
616 if (fseek(fp, lstart, SEEK_SET) == -1)
619 /* Again the high half of the block rappresenting the C part. */
621 while (fgets(buffer, LNBUFF, fp) != NULL && isasminline(buffer) == 0) {
622 if (tnsamples == 0 || done != 0)
623 printf("\t| %s", buffer);
626 printf("%.2f%%\t| %s",
627 (float)tnsamples * 100 / agg->ag_nsamples, buffer);
632 * Again the low half of the block rappresenting the asm
636 if (fgets(buffer, LNBUFF, fp) == NULL)
638 if (isasminline(buffer) == 0)
640 nbytes = newfunction(buffer);
642 if (fseek(fp, nbytes * -1, SEEK_CUR) == -1)
647 if (fseek(fp, strlen(buffer) * -1, SEEK_CUR) == -1)
653 * Helper printout functions.
656 usage(const char *progname)
660 "usage: %s [-a] [-h] [-k kfile] [-l lb] pmcraw.out binary\n",
666 main(int argc, char *argv[])
668 char buffer[LNBUFF], fname[FNBUFF];
669 char *tbfl, *tofl, *tmpdir;
670 char tmpf[MAXPATHLEN * 2 + 50];
672 char *bin, *exec, *kfile, *ofile;
675 void *ptr, *hstart, *hend;
676 uintptr_t tmppc, ostart, oend;
685 while ((cget = getopt(argc, argv, "ahl:k:")) != -1)
694 limit = (float)atof(optarg);
708 if (access(bin, R_OK | F_OK) == -1)
709 FATAL(exec, "%s: Impossible to locate the binary file\n",
711 if (access(ofile, R_OK | F_OK) == -1)
712 FATAL(exec, "%s: Impossible to locate the pmcstat file\n",
714 if (kfile != NULL && access(kfile, R_OK | F_OK) == -1)
715 FATAL(exec, "%s: Impossible to locate the kernel file\n",
718 bzero(tmpf, sizeof(tmpf));
719 tmpdir = getenv("TMPDIR");
720 if (tmpdir == NULL) {
721 asprintf(&tbfl, "%s/%s", _PATH_TMP, TMPNAME);
722 asprintf(&tofl, "%s/%s", _PATH_TMP, TMPNAME);
724 asprintf(&tbfl, "%s/%s", tmpdir, TMPNAME);
725 asprintf(&tofl, "%s/%s", tmpdir, TMPNAME);
727 if (tofl == NULL || tbfl == NULL)
728 FATAL(exec, "%s: Cannot create tempfile templates\n",
730 if (mkstemp(tofl) == -1)
731 FATAL(exec, "%s: Impossible to create the tmp file\n",
734 snprintf(tmpf, sizeof(tmpf), "pmcstat -k %s -R %s -m %s",
737 snprintf(tmpf, sizeof(tmpf), "pmcstat -R %s -m %s", ofile,
739 if (system(tmpf) != 0)
740 FATAL(exec, "%s: Impossible to create the tmp file\n",
743 gfp = fopen(tofl, "r");
745 FATAL(exec, "%s: Impossible to open the map file\n",
749 * Make the collection of raw entries from a pmcstat mapped file.
750 * The heuristic here wants strings in the form:
751 * "addr funcname startfaddr endfaddr".
753 while (fgets(buffer, LNBUFF, gfp) != NULL) {
754 if (isspace(buffer[0]))
756 if (sscanf(buffer, "%p %s %p %p\n", &ptr, fname,
757 &hstart, &hend) != 4)
759 "%s: Invalid scan of function in the map file\n",
761 ostart = (uintptr_t)hstart;
762 oend = (uintptr_t)hend;
763 tmppc = (uintptr_t)ptr;
765 obj = general_findent(tmppc);
770 obj = entry_create(fname, tmppc, ostart, oend);
773 "%s: Impossible to create a new object\n", exec);
774 general_insertent(obj);
776 if (fclose(gfp) == EOF)
777 FATAL(exec, "%s: Impossible to close the filedesc\n",
779 if (remove(tofl) == -1)
780 FATAL(exec, "%s: Impossible to remove the tmpfile\n",
784 * Remove the loose end objects and feed the first-level aggregation
787 if (fqueue_insertgen() == -1)
788 FATAL(exec, "%s: Impossible to generate an analysis\n",
790 fqueue_compact(limit);
791 if (fqueue_getall(bin, tbfl, asmsrc) == -1)
792 FATAL(exec, "%s: Impossible to create the tmp file\n",
795 bfp = fopen(tbfl, "r");
797 FATAL(exec, "%s: Impossible to open the binary file\n",
802 else if (cparse(bfp) == -1)
803 FATAL(NULL, "%s: Invalid format for the C file\n", exec);
804 if (fclose(bfp) == EOF)
805 FATAL(exec, "%s: Impossible to close the filedesc\n",
807 if (remove(tbfl) == -1)
808 FATAL(exec, "%s: Impossible to remove the tmpfile\n",