2 * Copyright (c) 2005-2007, Joseph Koshy
3 * Copyright (c) 2007 The FreeBSD Foundation
4 * Copyright (c) 2009, Fabien Thomas
7 * Portions of this software were developed by A. Joseph Koshy under
8 * sponsorship from the FreeBSD Foundation and Google, Inc.
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, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * Transform a hwpmc(4) log into human readable form, and into
34 * gprof(1) compatible profiles.
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
40 #include <sys/param.h>
41 #include <sys/endian.h>
43 #include <sys/imgact_aout.h>
44 #include <sys/imgact_elf.h>
47 #include <sys/queue.h>
48 #include <sys/socket.h>
52 #include <netinet/in.h>
73 #include "pmcstat_log.h"
74 #include "pmcpl_callgraph.h"
75 #include "pmcpl_gprof.h"
77 typedef uint64_t WIDEHISTCOUNTER;
79 #define WIDEHISTCOUNTER_MAX UINT64_MAX
80 #define HISTCOUNTER_MAX USHRT_MAX
81 #define WIDEHISTCOUNTER_GMONTYPE ((int) 64)
82 #define HISTCOUNTER_GMONTYPE ((int) 0)
86 * struct pmcstat_gmonfile tracks a given 'gmon.out' file. These
87 * files are mmap()'ed in as needed.
90 struct pmcstat_gmonfile {
91 LIST_ENTRY(pmcstat_gmonfile) pgf_next; /* list of entries */
92 int pgf_overflow; /* whether a count overflowed */
93 pmc_id_t pgf_pmcid; /* id of the associated pmc */
94 size_t pgf_nbuckets; /* #buckets in this gmon.out */
95 unsigned int pgf_nsamples; /* #samples in this gmon.out */
96 pmcstat_interned_string pgf_name; /* pathname of gmon.out file */
97 size_t pgf_ndatabytes; /* number of bytes mapped */
98 void *pgf_gmondata; /* pointer to mmap'ed data */
99 FILE *pgf_file; /* used when writing gmon arcs */
106 static void pmcstat_gmon_create_file(struct pmcstat_gmonfile *_pgf,
107 struct pmcstat_image *_image);
108 static pmcstat_interned_string pmcstat_gmon_create_name(const char *_sd,
109 struct pmcstat_image *_img, pmc_id_t _pmcid);
110 static void pmcstat_gmon_map_file(struct pmcstat_gmonfile *_pgf);
111 static void pmcstat_gmon_unmap_file(struct pmcstat_gmonfile *_pgf);
113 static struct pmcstat_gmonfile *pmcstat_image_find_gmonfile(struct
114 pmcstat_image *_i, pmc_id_t _id);
117 * Create a gmon.out file and size it.
121 pmcstat_gmon_create_file(struct pmcstat_gmonfile *pgf,
122 struct pmcstat_image *image)
127 const char *pathname;
128 char buffer[DEFAULT_BUFFER_SIZE];
130 pathname = pmcstat_string_unintern(pgf->pgf_name);
131 if ((fd = open(pathname, O_RDWR|O_NOFOLLOW|O_CREAT,
132 S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH)) < 0)
133 err(EX_OSERR, "ERROR: Cannot open \"%s\"", pathname);
135 gm.lpc = image->pi_start;
136 gm.hpc = image->pi_end;
137 gm.ncnt = (pgf->pgf_nbuckets * hc_sz) + sizeof(struct gmonhdr);
138 gm.version = GMONVERSION;
139 gm.profrate = 0; /* use ticks */
140 if (args.pa_flags & FLAG_DO_WIDE_GPROF_HC)
141 gm.histcounter_type = WIDEHISTCOUNTER_GMONTYPE;
143 gm.histcounter_type = HISTCOUNTER_GMONTYPE;
144 gm.spare[0] = gm.spare[1] = 0;
146 /* Write out the gmon header */
147 if (write(fd, &gm, sizeof(gm)) < 0)
150 /* Zero fill the samples[] array */
151 (void) memset(buffer, 0, sizeof(buffer));
153 count = pgf->pgf_ndatabytes - sizeof(struct gmonhdr);
154 while (count > sizeof(buffer)) {
155 if (write(fd, &buffer, sizeof(buffer)) < 0)
157 count -= sizeof(buffer);
160 if (write(fd, &buffer, count) < 0)
168 err(EX_OSERR, "ERROR: Cannot write \"%s\"", pathname);
172 * Determine the full pathname of a gmon.out file for a given
173 * (image,pmcid) combination. Return the interned string.
176 pmcstat_interned_string
177 pmcstat_gmon_create_name(const char *samplesdir, struct pmcstat_image *image,
181 char fullpath[PATH_MAX];
183 pmcname = pmcstat_pmcid_to_name(pmcid);
185 err(EX_SOFTWARE, "ERROR: cannot find pmcid");
187 (void) snprintf(fullpath, sizeof(fullpath),
188 "%s/%s/%s", samplesdir, pmcname,
189 pmcstat_string_unintern(image->pi_samplename));
191 return (pmcstat_string_intern(fullpath));
196 * Mmap in a gmon.out file for processing.
200 pmcstat_gmon_map_file(struct pmcstat_gmonfile *pgf)
203 const char *pathname;
205 pathname = pmcstat_string_unintern(pgf->pgf_name);
207 /* the gmon.out file must already exist */
208 if ((fd = open(pathname, O_RDWR | O_NOFOLLOW, 0)) < 0)
209 err(EX_OSERR, "ERROR: cannot open \"%s\"", pathname);
211 pgf->pgf_gmondata = mmap(NULL, pgf->pgf_ndatabytes,
212 PROT_READ|PROT_WRITE, MAP_NOSYNC|MAP_SHARED, fd, 0);
214 if (pgf->pgf_gmondata == MAP_FAILED)
215 err(EX_OSERR, "ERROR: cannot map \"%s\"", pathname);
221 * Unmap a gmon.out file after sync'ing its data to disk.
225 pmcstat_gmon_unmap_file(struct pmcstat_gmonfile *pgf)
227 (void) msync(pgf->pgf_gmondata, pgf->pgf_ndatabytes,
229 (void) munmap(pgf->pgf_gmondata, pgf->pgf_ndatabytes);
230 pgf->pgf_gmondata = NULL;
234 pmcstat_gmon_append_arc(struct pmcstat_image *image, pmc_id_t pmcid,
235 uintptr_t rawfrom, uintptr_t rawto, uint32_t count)
237 struct rawarc arc; /* from <sys/gmon.h> */
238 const char *pathname;
239 struct pmcstat_gmonfile *pgf;
241 if ((pgf = pmcstat_image_find_gmonfile(image, pmcid)) == NULL)
244 if (pgf->pgf_file == NULL) {
245 pathname = pmcstat_string_unintern(pgf->pgf_name);
246 if ((pgf->pgf_file = fopen(pathname, "a")) == NULL)
250 arc.raw_frompc = rawfrom + image->pi_vaddr;
251 arc.raw_selfpc = rawto + image->pi_vaddr;
252 arc.raw_count = count;
254 (void) fwrite(&arc, sizeof(arc), 1, pgf->pgf_file);
258 static struct pmcstat_gmonfile *
259 pmcstat_image_find_gmonfile(struct pmcstat_image *image, pmc_id_t pmcid)
261 struct pmcstat_gmonfile *pgf;
262 LIST_FOREACH(pgf, &image->pi_gmlist, pgf_next)
263 if (pgf->pgf_pmcid == pmcid)
269 pmcstat_cgnode_do_gmon_arcs(struct pmcstat_cgnode *cg, pmc_id_t pmcid)
271 struct pmcstat_cgnode *cgc;
274 * Look for child nodes that belong to the same image.
277 LIST_FOREACH(cgc, &cg->pcg_children, pcg_sibling) {
278 if (cgc->pcg_image == cg->pcg_image)
279 pmcstat_gmon_append_arc(cg->pcg_image, pmcid,
280 cgc->pcg_func, cg->pcg_func, cgc->pcg_count);
281 if (cgc->pcg_nchildren > 0)
282 pmcstat_cgnode_do_gmon_arcs(cgc, pmcid);
287 pmcstat_callgraph_do_gmon_arcs_for_pmcid(pmc_id_t pmcid)
290 struct pmcstat_cgnode_hash *pch;
292 for (n = 0; n < PMCSTAT_NHASH; n++)
293 LIST_FOREACH(pch, &pmcstat_cgnode_hash[n], pch_next)
294 if (pch->pch_pmcid == pmcid &&
295 pch->pch_cgnode->pcg_nchildren > 1)
296 pmcstat_cgnode_do_gmon_arcs(pch->pch_cgnode,
302 pmcstat_callgraph_do_gmon_arcs(void)
304 struct pmcstat_pmcrecord *pmcr;
306 LIST_FOREACH(pmcr, &pmcstat_pmcs, pr_next)
307 pmcstat_callgraph_do_gmon_arcs_for_pmcid(pmcr->pr_pmcid);
311 pmcpl_gmon_initimage(struct pmcstat_image *pi)
318 * Look for a suitable name for the sample files associated
319 * with this image: if `basename(path)`+".gmon" is available,
320 * we use that, otherwise we try iterating through
321 * `basename(path)`+ "~" + NNN + ".gmon" till we get a free
324 if ((sn = basename(pmcstat_string_unintern(pi->pi_execpath))) == NULL)
325 err(EX_OSERR, "ERROR: Cannot process \"%s\"",
326 pmcstat_string_unintern(pi->pi_execpath));
329 nlen = min(nlen, (int) (sizeof(name) - sizeof(".gmon")));
331 snprintf(name, sizeof(name), "%.*s.gmon", nlen, sn);
333 /* try use the unabridged name first */
334 if (pmcstat_string_lookup(name) == NULL)
335 pi->pi_samplename = pmcstat_string_intern(name);
338 * Otherwise use a prefix from the original name and
342 nlen = min(nlen, (int) (sizeof(name)-sizeof("~NNN.gmon")));
347 "ERROR: cannot create a gmon file for"
349 snprintf(name, sizeof(name), "%.*s~%3.3d.gmon",
351 if (pmcstat_string_lookup(name) == NULL) {
353 pmcstat_string_intern(name);
359 LIST_INIT(&pi->pi_gmlist);
363 pmcpl_gmon_shutdownimage(struct pmcstat_image *pi)
365 struct pmcstat_gmonfile *pgf, *pgftmp;
367 LIST_FOREACH_SAFE(pgf, &pi->pi_gmlist, pgf_next, pgftmp) {
369 (void) fclose(pgf->pgf_file);
370 LIST_REMOVE(pgf, pgf_next);
376 pmcpl_gmon_newpmc(pmcstat_interned_string ps, struct pmcstat_pmcrecord *pr)
379 char fullpath[PATH_MAX];
384 * Create the appropriate directory to hold gmon.out files.
387 (void) snprintf(fullpath, sizeof(fullpath), "%s/%s", args.pa_samplesdir,
388 pmcstat_string_unintern(ps));
390 /* If the path name exists, it should be a directory */
391 if (stat(fullpath, &st) == 0 && S_ISDIR(st.st_mode))
394 if (mkdir(fullpath, S_IRWXU|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH) < 0)
395 err(EX_OSERR, "ERROR: Cannot create directory \"%s\"",
400 * Increment the bucket in the gmon.out file corresponding to 'pmcid'
405 pmcpl_gmon_process(struct pmcstat_process *pp, struct pmcstat_pmcrecord *pmcr,
406 uint32_t nsamples, uintfptr_t *cc, int usermode, uint32_t cpu)
408 struct pmcstat_pcmap *map;
409 struct pmcstat_image *image;
410 struct pmcstat_gmonfile *pgf;
413 WIDEHISTCOUNTER *whc;
416 (void) nsamples; (void) usermode; (void) cpu;
418 map = pmcstat_process_find_map(usermode ? pp : pmcstat_kernproc, cc[0]);
420 /* Unknown offset. */
421 pmcstat_stats.ps_samples_unknown_offset++;
425 assert(cc[0] >= map->ppm_lowpc && cc[0] < map->ppm_highpc);
427 image = map->ppm_image;
428 pmcid = pmcr->pr_pmcid;
431 * If this is the first time we are seeing a sample for
432 * this executable image, try determine its parameters.
434 if (image->pi_type == PMCSTAT_IMAGE_UNKNOWN)
435 pmcstat_image_determine_type(image);
437 assert(image->pi_type != PMCSTAT_IMAGE_UNKNOWN);
439 /* Ignore samples in images that we know nothing about. */
440 if (image->pi_type == PMCSTAT_IMAGE_INDETERMINABLE) {
441 pmcstat_stats.ps_samples_indeterminable++;
446 * Find the gmon file corresponding to 'pmcid', creating it if
449 pgf = pmcstat_image_find_gmonfile(image, pmcid);
452 /* Determine the correct histcounter size. */
453 if (args.pa_flags & FLAG_DO_WIDE_GPROF_HC)
454 hc_sz = sizeof(WIDEHISTCOUNTER);
456 hc_sz = sizeof(HISTCOUNTER);
459 if ((pgf = calloc(1, sizeof(*pgf))) == NULL)
460 err(EX_OSERR, "ERROR:");
462 pgf->pgf_gmondata = NULL; /* mark as unmapped */
463 pgf->pgf_name = pmcstat_gmon_create_name(args.pa_samplesdir,
465 pgf->pgf_pmcid = pmcid;
466 assert(image->pi_end > image->pi_start);
467 pgf->pgf_nbuckets = (image->pi_end - image->pi_start) /
468 FUNCTION_ALIGNMENT; /* see <machine/profile.h> */
469 pgf->pgf_ndatabytes = sizeof(struct gmonhdr) +
470 pgf->pgf_nbuckets * hc_sz;
471 pgf->pgf_nsamples = 0;
472 pgf->pgf_file = NULL;
474 pmcstat_gmon_create_file(pgf, image);
476 LIST_INSERT_HEAD(&image->pi_gmlist, pgf, pgf_next);
480 * Map the gmon file in if needed. It may have been mapped
481 * out under memory pressure.
483 if (pgf->pgf_gmondata == NULL)
484 pmcstat_gmon_map_file(pgf);
486 assert(pgf->pgf_gmondata != NULL);
492 bucket = (cc[0] - map->ppm_lowpc) / FUNCTION_ALIGNMENT;
494 assert(bucket < pgf->pgf_nbuckets);
496 if (args.pa_flags & FLAG_DO_WIDE_GPROF_HC) {
497 whc = (WIDEHISTCOUNTER *) ((uintptr_t) pgf->pgf_gmondata +
498 sizeof(struct gmonhdr));
501 if (whc[bucket] < WIDEHISTCOUNTER_MAX)
503 else /* mark that an overflow occurred */
504 pgf->pgf_overflow = 1;
506 hc = (HISTCOUNTER *) ((uintptr_t) pgf->pgf_gmondata +
507 sizeof(struct gmonhdr));
510 if (hc[bucket] < HISTCOUNTER_MAX)
512 else /* mark that an overflow occurred */
513 pgf->pgf_overflow = 1;
524 pmcpl_gmon_shutdown(FILE *mf)
527 struct pmcstat_gmonfile *pgf;
528 struct pmcstat_image *pi;
531 * Sync back all gprof flat profile data.
533 for (i = 0; i < PMCSTAT_NHASH; i++) {
534 LIST_FOREACH(pi, &pmcstat_image_hash[i], pi_next) {
536 (void) fprintf(mf, " \"%s\" => \"%s\"",
537 pmcstat_string_unintern(pi->pi_execpath),
538 pmcstat_string_unintern(
541 /* flush gmon.out data to disk */
542 LIST_FOREACH(pgf, &pi->pi_gmlist, pgf_next) {
543 pmcstat_gmon_unmap_file(pgf);
545 (void) fprintf(mf, " %s/%d",
546 pmcstat_pmcid_to_name(
549 if (pgf->pgf_overflow && args.pa_verbosity >= 1)
551 "WARNING: profile \"%s\" overflowed.",
552 pmcstat_string_unintern(
557 (void) fprintf(mf, "\n");
562 * Compute arcs and add these to the gprof files.
564 if (args.pa_flags & FLAG_DO_GPROF && args.pa_graphdepth > 1)
565 pmcstat_callgraph_do_gmon_arcs();