2 * Copyright (c) 2008 Nokia Corporation
5 * This software was developed by Attilio Rao for the IPSO project under
6 * contract to Nokia Corporation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice unmodified, this list of conditions, and the following
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/queue.h>
47 #define TMPPATH "/tmp/pmcannotate.XXXXXX"
49 #define FATAL(ptr, x ...) do { \
51 general_deleteall(); \
54 fprintf(stderr, ##x); \
60 #define PERCSAMP(x) ((x) * 100 / totalsamples)
63 TAILQ_ENTRY(entry) en_iter;
72 TAILQ_ENTRY(aggent) ag_fiter;
80 static struct aggent *agg_create(const char *name, u_int nsamples,
81 uintptr_t start, uintptr_t end);
82 static void agg_destroy(struct aggent *agg) __unused;
83 static void asmparse(FILE *fp);
84 static int cparse(FILE *fp);
85 static void entry_acqref(struct entry *entry);
86 static struct entry *entry_create(const char *name, uintptr_t pc,
87 uintptr_t start, uintptr_t end);
88 static void entry_destroy(struct entry *entry) __unused;
89 static void fqueue_compact(float th);
90 static void fqueue_deleteall(void);
91 static struct aggent *fqueue_findent_by_name(const char *name);
92 static int fqueue_getall(const char *bin, char *temp, int asmf);
93 static int fqueue_insertent(struct entry *entry);
94 static int fqueue_insertgen(void);
95 static void general_deleteall(void);
96 static struct entry *general_findent(uintptr_t pc);
97 static void general_insertent(struct entry *entry);
98 static void general_printasm(FILE *fp, struct aggent *agg);
99 static int general_printc(FILE *fp, struct aggent *agg);
100 static int printblock(FILE *fp, struct aggent *agg);
101 static void usage(const char *progname) __dead2;
103 static TAILQ_HEAD(, entry) mainlst = TAILQ_HEAD_INITIALIZER(mainlst);
104 static TAILQ_HEAD(, aggent) fqueue = TAILQ_HEAD_INITIALIZER(fqueue);
107 * Use a float value in order to automatically promote operations
108 * to return a float value rather than use casts.
110 static float totalsamples;
113 * Identifies a string cointaining objdump's assembly printout.
116 isasminline(const char *str)
121 if (sscanf(str, " %p%n", &ptr, &nbytes) != 1)
123 if (str[nbytes] != ':' || isspace(str[nbytes + 1]) == 0)
129 * Identifies a string containing objdump's assembly printout
130 * for a new function.
133 newfunction(const char *str)
141 if (sscanf(str, "%p <%[^>:]>:%n", &ptr, fname, &nbytes) != 2)
147 * Create a new first-level aggregation object for a specified
150 static struct aggent *
151 agg_create(const char *name, u_int nsamples, uintptr_t start, uintptr_t end)
155 agg = calloc(1, sizeof(struct aggent));
158 agg->ag_name = strdup(name);
159 if (agg->ag_name == NULL) {
163 agg->ag_nsamples = nsamples;
164 agg->ag_ostart = start;
170 * Destroy a first-level aggregation object for a specified
174 agg_destroy(struct aggent *agg)
182 * Analyze the "objdump -d" output, locate functions and start
183 * printing out the assembly functions content.
184 * We do not use newfunction() because we actually need the
185 * function name in available form, but the heurstic used is
191 char buffer[LNBUFF], fname[FNBUFF];
195 while (fgets(buffer, LNBUFF, fp) != NULL) {
196 if (isspace(buffer[0]))
198 if (sscanf(buffer, "%p <%[^>:]>:", &ptr, fname) != 2)
200 agg = fqueue_findent_by_name(fname);
203 agg->ag_offset = ftell(fp);
206 TAILQ_FOREACH(agg, &fqueue, ag_fiter) {
207 if (fseek(fp, agg->ag_offset, SEEK_SET) == -1)
209 printf("Profile trace for function: %s() [%.2f%%]\n",
210 agg->ag_name, PERCSAMP(agg->ag_nsamples));
211 general_printasm(fp, agg);
217 * Analyze the "objdump -S" output, locate functions and start
218 * printing out the C functions content.
219 * We do not use newfunction() because we actually need the
220 * function name in available form, but the heurstic used is
222 * In order to maintain the printout sorted, on the first pass it
223 * simply stores the file offsets in order to fastly moved later
224 * (when the file is hot-cached also) when the real printout will
230 char buffer[LNBUFF], fname[FNBUFF];
234 while (fgets(buffer, LNBUFF, fp) != NULL) {
235 if (isspace(buffer[0]))
237 if (sscanf(buffer, "%p <%[^>:]>:", &ptr, fname) != 2)
239 agg = fqueue_findent_by_name(fname);
242 agg->ag_offset = ftell(fp);
245 TAILQ_FOREACH(agg, &fqueue, ag_fiter) {
246 if (fseek(fp, agg->ag_offset, SEEK_SET) == -1)
248 printf("Profile trace for function: %s() [%.2f%%]\n",
249 agg->ag_name, PERCSAMP(agg->ag_nsamples));
250 if (general_printc(fp, agg) == -1)
258 * Bump the number of samples for any raw entry.
261 entry_acqref(struct entry *entry)
264 entry->en_nsamples++;
268 * Create a new raw entry object for a specified function.
270 static struct entry *
271 entry_create(const char *name, uintptr_t pc, uintptr_t start, uintptr_t end)
275 obj = calloc(1, sizeof(struct entry));
278 obj->en_name = strdup(name);
279 if (obj->en_name == NULL) {
284 obj->en_ostart = start;
286 obj->en_nsamples = 1;
291 * Destroy a raw entry object for a specified function.
294 entry_destroy(struct entry *entry)
297 free(entry->en_name);
302 * Specify a lower bound in percentage and drop from the
303 * first-level aggregation queue all the objects with a
307 fqueue_compact(float th)
310 struct aggent *agg, *tmpagg;
312 if (totalsamples == 0)
315 /* Revert the percentage calculation. */
316 thi = th * totalsamples / 100;
317 TAILQ_FOREACH_SAFE(agg, &fqueue, ag_fiter, tmpagg)
318 if (agg->ag_nsamples < thi)
319 TAILQ_REMOVE(&fqueue, agg, ag_fiter);
323 * Flush the first-level aggregates queue.
326 fqueue_deleteall(void)
330 while (TAILQ_EMPTY(&fqueue) == 0) {
331 agg = TAILQ_FIRST(&fqueue);
332 TAILQ_REMOVE(&fqueue, agg, ag_fiter);
337 * Insert a raw entry into the aggregations queue.
338 * If the respective first-level aggregation object
339 * does not exist create it and maintain it sorted
340 * in respect of the number of samples.
343 fqueue_insertent(struct entry *entry)
345 struct aggent *obj, *tmp;
349 TAILQ_FOREACH(obj, &fqueue, ag_fiter)
350 if (!strcmp(obj->ag_name, entry->en_name)) {
352 obj->ag_nsamples += entry->en_nsamples;
357 * If the first-level aggregation object already exists,
358 * just aggregate the samples and, if needed, resort
362 TAILQ_REMOVE(&fqueue, obj, ag_fiter);
364 TAILQ_FOREACH(tmp, &fqueue, ag_fiter)
365 if (obj->ag_nsamples > tmp->ag_nsamples) {
370 TAILQ_INSERT_BEFORE(tmp, obj, ag_fiter);
372 TAILQ_INSERT_TAIL(&fqueue, obj, ag_fiter);
377 * If the first-level aggregation object does not
378 * exist, create it and put in the sorted queue.
379 * If this is the first object, we need to set the
382 obj = agg_create(entry->en_name, entry->en_nsamples, entry->en_ostart,
386 if (TAILQ_EMPTY(&fqueue) != 0) {
387 TAILQ_INSERT_HEAD(&fqueue, obj, ag_fiter);
390 TAILQ_FOREACH(tmp, &fqueue, ag_fiter)
391 if (obj->ag_nsamples > tmp->ag_nsamples) {
396 TAILQ_INSERT_BEFORE(tmp, obj, ag_fiter);
398 TAILQ_INSERT_TAIL(&fqueue, obj, ag_fiter);
403 * Lookup a first-level aggregation object by name.
405 static struct aggent *
406 fqueue_findent_by_name(const char *name)
410 TAILQ_FOREACH(obj, &fqueue, ag_fiter)
411 if (!strcmp(obj->ag_name, name))
417 * Return the number of object in the first-level aggregations queue.
420 fqueue_getall(const char *bin, char *temp, int asmf)
422 char tmpf[MAXPATHLEN * 2 + 50];
424 uintptr_t start, end;
426 if (mkstemp(temp) == -1)
428 TAILQ_FOREACH(agg, &fqueue, ag_fiter) {
429 bzero(tmpf, sizeof(tmpf));
430 start = agg->ag_ostart;
434 * Fix-up the end address in order to show it in the objdump's
439 snprintf(tmpf, sizeof(tmpf),
440 "objdump --start-address=%p "
441 "--stop-address=%p -d %s >> %s", (void *)start,
442 (void *)end, bin, temp);
444 snprintf(tmpf, sizeof(tmpf),
445 "objdump --start-address=%p "
446 "--stop-address=%p -S %s >> %s", (void *)start,
447 (void *)end, bin, temp);
448 if (system(tmpf) != 0)
455 * Insert all the raw entries present in the general queue
456 * into the first-level aggregations queue.
459 fqueue_insertgen(void)
463 TAILQ_FOREACH(obj, &mainlst, en_iter)
464 if (fqueue_insertent(obj) == -1)
470 * Flush the raw entries general queue.
473 general_deleteall(void)
477 while (TAILQ_EMPTY(&mainlst) == 0) {
478 obj = TAILQ_FIRST(&mainlst);
479 TAILQ_REMOVE(&mainlst, obj, en_iter);
484 * Lookup a raw entry by the PC.
486 static struct entry *
487 general_findent(uintptr_t pc)
491 TAILQ_FOREACH(obj, &mainlst, en_iter)
492 if (obj->en_pc == pc)
498 * Insert a new raw entry in the general queue.
501 general_insertent(struct entry *entry)
504 TAILQ_INSERT_TAIL(&mainlst, entry, en_iter);
508 * Printout the body of an "objdump -d" assembly function.
509 * It does simply stops when a new function is encountered,
510 * bringing back the file position in order to not mess up
511 * subsequent analysis.
512 * C lines and others not recognized are simply skipped.
515 general_printasm(FILE *fp, struct aggent *agg)
522 while (fgets(buffer, LNBUFF, fp) != NULL) {
523 if ((nbytes = newfunction(buffer)) != 0) {
524 fseek(fp, nbytes * -1, SEEK_CUR);
527 if (!isasminline(buffer))
529 if (sscanf(buffer, " %p:", &ptr) != 1)
531 obj = general_findent((uintptr_t)ptr);
533 printf("\t| %s", buffer);
535 printf("%.2f%%\t| %s",
536 (float)obj->en_nsamples * 100 / agg->ag_nsamples,
542 * Printout the body of an "objdump -S" function.
543 * It does simply stops when a new function is encountered,
544 * bringing back the file position in order to not mess up
545 * subsequent analysis.
546 * It expect from the starting to the end to find, always, valid blocks
547 * (see below for an explanation of the "block" concept).
550 general_printc(FILE *fp, struct aggent *agg)
554 while (fgets(buffer, LNBUFF, fp) != NULL) {
555 fseek(fp, strlen(buffer) * -1, SEEK_CUR);
556 if (newfunction(buffer) != 0)
558 if (printblock(fp, agg) == -1)
565 * Printout a single block inside an "objdump -S" function.
566 * The block is composed of a first part in C and subsequent translation
568 * This code also operates a second-level aggregation packing together
569 * samples relative to PCs into a (lower bottom) block with their
570 * C (higher half) counterpart.
573 printblock(FILE *fp, struct aggent *agg)
579 int done, nbytes, sentinel;
583 * We expect the first thing of the block is C code, so simply give
584 * up if asm line is found.
589 if (fgets(buffer, LNBUFF, fp) == NULL)
591 if (isasminline(buffer) != 0)
594 nbytes = newfunction(buffer);
596 if (fseek(fp, nbytes * -1, SEEK_CUR) == -1)
603 * If the sentinel is not set, it means it did not match any
604 * "high half" for this code so simply give up.
605 * Operates the second-level aggregation.
611 if (sscanf(buffer, " %p:", &ptr) != 1)
613 obj = general_findent((uintptr_t)ptr);
615 tnsamples += obj->en_nsamples;
616 } while (fgets(buffer, LNBUFF, fp) != NULL && isasminline(buffer) != 0);
618 /* Rewind to the start of the block in order to start the printout. */
619 if (fseek(fp, lstart, SEEK_SET) == -1)
622 /* Again the high half of the block rappresenting the C part. */
624 while (fgets(buffer, LNBUFF, fp) != NULL && isasminline(buffer) == 0) {
625 if (tnsamples == 0 || done != 0)
626 printf("\t| %s", buffer);
629 printf("%.2f%%\t| %s",
630 (float)tnsamples * 100 / agg->ag_nsamples, buffer);
635 * Again the low half of the block rappresenting the asm
639 if (fgets(buffer, LNBUFF, fp) == NULL)
641 if (isasminline(buffer) == 0)
643 nbytes = newfunction(buffer);
645 if (fseek(fp, nbytes * -1, SEEK_CUR) == -1)
650 if (fseek(fp, strlen(buffer) * -1, SEEK_CUR) == -1)
656 * Helper printout functions.
659 usage(const char *progname)
663 "usage: %s [-a] [-h] [-k kfile] [-l lb] pmcraw.out binary\n",
669 main(int argc, char *argv[])
671 char buffer[LNBUFF], fname[FNBUFF], tbfl[] = TMPPATH, tofl[] = TMPPATH;
672 char tmpf[MAXPATHLEN * 2 + 50];
674 char *bin, *exec, *kfile, *ofile;
677 void *ptr, *hstart, *hend;
678 uintptr_t tmppc, ostart, oend;
687 while ((cget = getopt(argc, argv, "ahl:k:")) != -1)
696 limit = (float)atof(optarg);
710 if (access(bin, R_OK | F_OK) == -1)
711 FATAL(exec, "%s: Impossible to locate the binary file\n",
713 if (access(ofile, R_OK | F_OK) == -1)
714 FATAL(exec, "%s: Impossible to locate the pmcstat file\n",
716 if (kfile != NULL && access(kfile, R_OK | F_OK) == -1)
717 FATAL(exec, "%s: Impossible to locate the kernel file\n",
720 bzero(tmpf, sizeof(tmpf));
721 if (mkstemp(tofl) == -1)
722 FATAL(exec, "%s: Impossible to create the tmp file\n",
725 snprintf(tmpf, sizeof(tmpf), "pmcstat -k %s -R %s -m %s",
728 snprintf(tmpf, sizeof(tmpf), "pmcstat -R %s -m %s", ofile,
730 if (system(tmpf) != 0)
731 FATAL(exec, "%s: Impossible to create the tmp file\n",
734 gfp = fopen(tofl, "r");
736 FATAL(exec, "%s: Impossible to open the map file\n",
740 * Make the collection of raw entries from a pmcstat mapped file.
741 * The heuristic here wants strings in the form:
742 * "addr funcname startfaddr endfaddr".
744 while (fgets(buffer, LNBUFF, gfp) != NULL) {
745 if (isspace(buffer[0]))
747 if (sscanf(buffer, "%p %s %p %p\n", &ptr, fname,
748 &hstart, &hend) != 4)
750 "%s: Invalid scan of function in the map file\n",
752 ostart = (uintptr_t)hstart;
753 oend = (uintptr_t)hend;
754 tmppc = (uintptr_t)ptr;
756 obj = general_findent(tmppc);
761 obj = entry_create(fname, tmppc, ostart, oend);
764 "%s: Impossible to create a new object\n", exec);
765 general_insertent(obj);
767 if (fclose(gfp) == EOF)
768 FATAL(exec, "%s: Impossible to close the filedesc\n",
770 if (remove(tofl) == -1)
771 FATAL(exec, "%s: Impossible to remove the tmpfile\n",
775 * Remove the loose end objects and feed the first-level aggregation
778 if (fqueue_insertgen() == -1)
779 FATAL(exec, "%s: Impossible to generate an analysis\n",
781 fqueue_compact(limit);
782 if (fqueue_getall(bin, tbfl, asmsrc) == -1)
783 FATAL(exec, "%s: Impossible to create the tmp file\n",
786 bfp = fopen(tbfl, "r");
788 FATAL(exec, "%s: Impossible to open the binary file\n",
793 else if (cparse(bfp) == -1)
794 FATAL(NULL, "%s: Invalid format for the C file\n", exec);
795 if (fclose(bfp) == EOF)
796 FATAL(exec, "%s: Impossible to close the filedesc\n",
798 if (remove(tbfl) == -1)
799 FATAL(exec, "%s: Impossible to remove the tmpfile\n",