2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2005-2007, Joseph Koshy
5 * Copyright (c) 2007 The FreeBSD Foundation
6 * Copyright (c) 2009, Fabien Thomas
9 * Portions of this software were developed by A. Joseph Koshy under
10 * sponsorship from the FreeBSD Foundation and Google, Inc.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * Transform a hwpmc(4) log into human readable form, and into
36 * gprof(1) compatible profiles.
39 #include <sys/cdefs.h>
40 __FBSDID("$FreeBSD$");
42 #include <sys/param.h>
43 #include <sys/endian.h>
45 #include <sys/imgact_aout.h>
46 #include <sys/imgact_elf.h>
49 #include <sys/queue.h>
50 #include <sys/socket.h>
54 #include <netinet/in.h>
75 #include "pmcstat_log.h"
76 #include "pmcpl_callgraph.h"
77 #include "pmcpl_gprof.h"
79 typedef uint64_t WIDEHISTCOUNTER;
81 #define min(A,B) ((A) < (B) ? (A) : (B))
82 #define max(A,B) ((A) > (B) ? (A) : (B))
84 #define WIDEHISTCOUNTER_MAX UINT64_MAX
85 #define HISTCOUNTER_MAX USHRT_MAX
86 #define WIDEHISTCOUNTER_GMONTYPE ((int) 64)
87 #define HISTCOUNTER_GMONTYPE ((int) 0)
91 * struct pmcstat_gmonfile tracks a given 'gmon.out' file. These
92 * files are mmap()'ed in as needed.
95 struct pmcstat_gmonfile {
96 LIST_ENTRY(pmcstat_gmonfile) pgf_next; /* list of entries */
97 int pgf_overflow; /* whether a count overflowed */
98 pmc_id_t pgf_pmcid; /* id of the associated pmc */
99 size_t pgf_nbuckets; /* #buckets in this gmon.out */
100 unsigned int pgf_nsamples; /* #samples in this gmon.out */
101 pmcstat_interned_string pgf_name; /* pathname of gmon.out file */
102 size_t pgf_ndatabytes; /* number of bytes mapped */
103 void *pgf_gmondata; /* pointer to mmap'ed data */
104 FILE *pgf_file; /* used when writing gmon arcs */
111 static void pmcstat_gmon_create_file(struct pmcstat_gmonfile *_pgf,
112 struct pmcstat_image *_image);
113 static pmcstat_interned_string pmcstat_gmon_create_name(const char *_sd,
114 struct pmcstat_image *_img, pmc_id_t _pmcid);
115 static void pmcstat_gmon_map_file(struct pmcstat_gmonfile *_pgf);
116 static void pmcstat_gmon_unmap_file(struct pmcstat_gmonfile *_pgf);
118 static struct pmcstat_gmonfile *pmcstat_image_find_gmonfile(struct
119 pmcstat_image *_i, pmc_id_t _id);
122 * Create a gmon.out file and size it.
126 pmcstat_gmon_create_file(struct pmcstat_gmonfile *pgf,
127 struct pmcstat_image *image)
132 const char *pathname;
133 char buffer[DEFAULT_BUFFER_SIZE];
135 pathname = pmcstat_string_unintern(pgf->pgf_name);
136 if ((fd = open(pathname, O_RDWR|O_NOFOLLOW|O_CREAT,
137 S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH)) < 0)
138 err(EX_OSERR, "ERROR: Cannot open \"%s\"", pathname);
140 gm.lpc = image->pi_start;
141 gm.hpc = image->pi_end;
142 gm.ncnt = (pgf->pgf_nbuckets * hc_sz) + sizeof(struct gmonhdr);
143 gm.version = GMONVERSION;
144 gm.profrate = 0; /* use ticks */
145 if (args.pa_flags & FLAG_DO_WIDE_GPROF_HC)
146 gm.histcounter_type = WIDEHISTCOUNTER_GMONTYPE;
148 gm.histcounter_type = HISTCOUNTER_GMONTYPE;
149 gm.spare[0] = gm.spare[1] = 0;
151 /* Write out the gmon header */
152 if (write(fd, &gm, sizeof(gm)) < 0)
155 /* Zero fill the samples[] array */
156 (void) memset(buffer, 0, sizeof(buffer));
158 count = pgf->pgf_ndatabytes - sizeof(struct gmonhdr);
159 while (count > sizeof(buffer)) {
160 if (write(fd, &buffer, sizeof(buffer)) < 0)
162 count -= sizeof(buffer);
165 if (write(fd, &buffer, count) < 0)
173 err(EX_OSERR, "ERROR: Cannot write \"%s\"", pathname);
177 * Determine the full pathname of a gmon.out file for a given
178 * (image,pmcid) combination. Return the interned string.
181 pmcstat_interned_string
182 pmcstat_gmon_create_name(const char *samplesdir, struct pmcstat_image *image,
186 char fullpath[PATH_MAX];
188 pmcname = pmcstat_pmcid_to_name(pmcid);
190 err(EX_SOFTWARE, "ERROR: cannot find pmcid");
192 (void) snprintf(fullpath, sizeof(fullpath),
193 "%s/%s/%s", samplesdir, pmcname,
194 pmcstat_string_unintern(image->pi_samplename));
196 return (pmcstat_string_intern(fullpath));
201 * Mmap in a gmon.out file for processing.
205 pmcstat_gmon_map_file(struct pmcstat_gmonfile *pgf)
208 const char *pathname;
210 pathname = pmcstat_string_unintern(pgf->pgf_name);
212 /* the gmon.out file must already exist */
213 if ((fd = open(pathname, O_RDWR | O_NOFOLLOW, 0)) < 0)
214 err(EX_OSERR, "ERROR: cannot open \"%s\"", pathname);
216 pgf->pgf_gmondata = mmap(NULL, pgf->pgf_ndatabytes,
217 PROT_READ|PROT_WRITE, MAP_NOSYNC|MAP_SHARED, fd, 0);
219 if (pgf->pgf_gmondata == MAP_FAILED)
220 err(EX_OSERR, "ERROR: cannot map \"%s\"", pathname);
226 * Unmap a gmon.out file after sync'ing its data to disk.
230 pmcstat_gmon_unmap_file(struct pmcstat_gmonfile *pgf)
232 (void) msync(pgf->pgf_gmondata, pgf->pgf_ndatabytes,
234 (void) munmap(pgf->pgf_gmondata, pgf->pgf_ndatabytes);
235 pgf->pgf_gmondata = NULL;
239 pmcstat_gmon_append_arc(struct pmcstat_image *image, pmc_id_t pmcid,
240 uintptr_t rawfrom, uintptr_t rawto, uint32_t count)
242 struct rawarc arc; /* from <sys/gmon.h> */
243 const char *pathname;
244 struct pmcstat_gmonfile *pgf;
246 if ((pgf = pmcstat_image_find_gmonfile(image, pmcid)) == NULL)
249 if (pgf->pgf_file == NULL) {
250 pathname = pmcstat_string_unintern(pgf->pgf_name);
251 if ((pgf->pgf_file = fopen(pathname, "a")) == NULL)
255 arc.raw_frompc = rawfrom + image->pi_vaddr;
256 arc.raw_selfpc = rawto + image->pi_vaddr;
257 arc.raw_count = count;
259 (void) fwrite(&arc, sizeof(arc), 1, pgf->pgf_file);
263 static struct pmcstat_gmonfile *
264 pmcstat_image_find_gmonfile(struct pmcstat_image *image, pmc_id_t pmcid)
266 struct pmcstat_gmonfile *pgf;
267 LIST_FOREACH(pgf, &image->pi_gmlist, pgf_next)
268 if (pgf->pgf_pmcid == pmcid)
274 pmcstat_cgnode_do_gmon_arcs(struct pmcstat_cgnode *cg, pmc_id_t pmcid)
276 struct pmcstat_cgnode *cgc;
279 * Look for child nodes that belong to the same image.
282 LIST_FOREACH(cgc, &cg->pcg_children, pcg_sibling) {
283 if (cgc->pcg_image == cg->pcg_image)
284 pmcstat_gmon_append_arc(cg->pcg_image, pmcid,
285 cgc->pcg_func, cg->pcg_func, cgc->pcg_count);
286 if (cgc->pcg_nchildren > 0)
287 pmcstat_cgnode_do_gmon_arcs(cgc, pmcid);
292 pmcstat_callgraph_do_gmon_arcs_for_pmcid(pmc_id_t pmcid)
295 struct pmcstat_cgnode_hash *pch;
297 for (n = 0; n < PMCSTAT_NHASH; n++)
298 LIST_FOREACH(pch, &pmcstat_cgnode_hash[n], pch_next)
299 if (pch->pch_pmcid == pmcid &&
300 pch->pch_cgnode->pcg_nchildren > 1)
301 pmcstat_cgnode_do_gmon_arcs(pch->pch_cgnode,
307 pmcstat_callgraph_do_gmon_arcs(void)
309 struct pmcstat_pmcrecord *pmcr;
311 LIST_FOREACH(pmcr, &pmcstat_pmcs, pr_next)
312 pmcstat_callgraph_do_gmon_arcs_for_pmcid(pmcr->pr_pmcid);
316 pmcpl_gmon_initimage(struct pmcstat_image *pi)
318 const char *execpath;
324 * Look for a suitable name for the sample files associated
325 * with this image: if `basename(path)`+".gmon" is available,
326 * we use that, otherwise we try iterating through
327 * `basename(path)`+ "~" + NNN + ".gmon" till we get a free
330 execpath = pmcstat_string_unintern(pi->pi_execpath);
331 if ((snbuf = strdup(execpath)) == NULL)
332 err(EX_OSERR, "ERROR: Cannot copy \"%s\"", execpath);
333 if ((sn = basename(snbuf)) == NULL)
334 err(EX_OSERR, "ERROR: Cannot process \"%s\"", execpath);
337 nlen = min(nlen, (int) (sizeof(name) - sizeof(".gmon")));
339 snprintf(name, sizeof(name), "%.*s.gmon", nlen, sn);
341 /* try use the unabridged name first */
342 if (pmcstat_string_lookup(name) == NULL)
343 pi->pi_samplename = pmcstat_string_intern(name);
346 * Otherwise use a prefix from the original name and
350 nlen = min(nlen, (int) (sizeof(name)-sizeof("~NNN.gmon")));
355 "ERROR: cannot create a gmon file for"
357 snprintf(name, sizeof(name), "%.*s~%3.3d.gmon",
359 if (pmcstat_string_lookup(name) == NULL) {
361 pmcstat_string_intern(name);
368 LIST_INIT(&pi->pi_gmlist);
372 pmcpl_gmon_shutdownimage(struct pmcstat_image *pi)
374 struct pmcstat_gmonfile *pgf, *pgftmp;
376 LIST_FOREACH_SAFE(pgf, &pi->pi_gmlist, pgf_next, pgftmp) {
378 (void) fclose(pgf->pgf_file);
379 LIST_REMOVE(pgf, pgf_next);
385 pmcpl_gmon_newpmc(pmcstat_interned_string ps, struct pmcstat_pmcrecord *pr)
388 char fullpath[PATH_MAX];
393 * Create the appropriate directory to hold gmon.out files.
396 (void) snprintf(fullpath, sizeof(fullpath), "%s/%s", args.pa_samplesdir,
397 pmcstat_string_unintern(ps));
399 /* If the path name exists, it should be a directory */
400 if (stat(fullpath, &st) == 0 && S_ISDIR(st.st_mode))
403 if (mkdir(fullpath, S_IRWXU|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH) < 0)
404 err(EX_OSERR, "ERROR: Cannot create directory \"%s\"",
409 * Increment the bucket in the gmon.out file corresponding to 'pmcid'
414 pmcpl_gmon_process(struct pmcstat_process *pp, struct pmcstat_pmcrecord *pmcr,
415 uint32_t nsamples, uintfptr_t *cc, int usermode, uint32_t cpu)
417 struct pmcstat_pcmap *map;
418 struct pmcstat_image *image;
419 struct pmcstat_gmonfile *pgf;
422 WIDEHISTCOUNTER *whc;
425 (void) nsamples; (void) usermode; (void) cpu;
427 map = pmcstat_process_find_map(usermode ? pp : pmcstat_kernproc, cc[0]);
429 /* Unknown offset. */
430 pmcstat_stats.ps_samples_unknown_offset++;
434 assert(cc[0] >= map->ppm_lowpc && cc[0] < map->ppm_highpc);
436 image = map->ppm_image;
437 pmcid = pmcr->pr_pmcid;
440 * If this is the first time we are seeing a sample for
441 * this executable image, try determine its parameters.
443 if (image->pi_type == PMCSTAT_IMAGE_UNKNOWN)
444 pmcstat_image_determine_type(image, &args);
446 assert(image->pi_type != PMCSTAT_IMAGE_UNKNOWN);
448 /* Ignore samples in images that we know nothing about. */
449 if (image->pi_type == PMCSTAT_IMAGE_INDETERMINABLE) {
450 pmcstat_stats.ps_samples_indeterminable++;
455 * Find the gmon file corresponding to 'pmcid', creating it if
458 pgf = pmcstat_image_find_gmonfile(image, pmcid);
461 /* Determine the correct histcounter size. */
462 if (args.pa_flags & FLAG_DO_WIDE_GPROF_HC)
463 hc_sz = sizeof(WIDEHISTCOUNTER);
465 hc_sz = sizeof(HISTCOUNTER);
468 if ((pgf = calloc(1, sizeof(*pgf))) == NULL)
469 err(EX_OSERR, "ERROR:");
471 pgf->pgf_gmondata = NULL; /* mark as unmapped */
472 pgf->pgf_name = pmcstat_gmon_create_name(args.pa_samplesdir,
474 pgf->pgf_pmcid = pmcid;
475 assert(image->pi_end > image->pi_start);
476 pgf->pgf_nbuckets = howmany(image->pi_end - image->pi_start,
477 FUNCTION_ALIGNMENT); /* see <machine/profile.h> */
478 pgf->pgf_ndatabytes = sizeof(struct gmonhdr) +
479 pgf->pgf_nbuckets * hc_sz;
480 pgf->pgf_nsamples = 0;
481 pgf->pgf_file = NULL;
483 pmcstat_gmon_create_file(pgf, image);
485 LIST_INSERT_HEAD(&image->pi_gmlist, pgf, pgf_next);
489 * Map the gmon file in if needed. It may have been mapped
490 * out under memory pressure.
492 if (pgf->pgf_gmondata == NULL)
493 pmcstat_gmon_map_file(pgf);
495 assert(pgf->pgf_gmondata != NULL);
501 bucket = (cc[0] - map->ppm_lowpc) / FUNCTION_ALIGNMENT;
503 assert(bucket < pgf->pgf_nbuckets);
505 if (args.pa_flags & FLAG_DO_WIDE_GPROF_HC) {
506 whc = (WIDEHISTCOUNTER *) ((uintptr_t) pgf->pgf_gmondata +
507 sizeof(struct gmonhdr));
510 if (whc[bucket] < WIDEHISTCOUNTER_MAX)
512 else /* mark that an overflow occurred */
513 pgf->pgf_overflow = 1;
515 hc = (HISTCOUNTER *) ((uintptr_t) pgf->pgf_gmondata +
516 sizeof(struct gmonhdr));
519 if (hc[bucket] < HISTCOUNTER_MAX)
521 else /* mark that an overflow occurred */
522 pgf->pgf_overflow = 1;
533 pmcpl_gmon_shutdown(FILE *mf)
536 struct pmcstat_gmonfile *pgf;
537 struct pmcstat_image *pi;
540 * Sync back all gprof flat profile data.
542 for (i = 0; i < PMCSTAT_NHASH; i++) {
543 LIST_FOREACH(pi, &pmcstat_image_hash[i], pi_next) {
545 (void) fprintf(mf, " \"%s\" => \"%s\"",
546 pmcstat_string_unintern(pi->pi_execpath),
547 pmcstat_string_unintern(
550 /* flush gmon.out data to disk */
551 LIST_FOREACH(pgf, &pi->pi_gmlist, pgf_next) {
552 pmcstat_gmon_unmap_file(pgf);
554 (void) fprintf(mf, " %s/%d",
555 pmcstat_pmcid_to_name(
558 if (pgf->pgf_overflow && args.pa_verbosity >= 1)
560 "WARNING: profile \"%s\" overflowed.",
561 pmcstat_string_unintern(
566 (void) fprintf(mf, "\n");
571 * Compute arcs and add these to the gprof files.
573 if (args.pa_flags & FLAG_DO_GPROF && args.pa_graphdepth > 1)
574 pmcstat_callgraph_do_gmon_arcs();