diff options
| -rw-r--r-- | lib/libpmc/pmclog.3 | 44 | ||||
| -rw-r--r-- | lib/libpmc/pmclog.c | 19 | ||||
| -rw-r--r-- | lib/libpmc/pmclog.h | 15 | ||||
| -rw-r--r-- | sys/dev/hwpmc/hwpmc_logging.c | 35 | ||||
| -rw-r--r-- | sys/dev/hwpmc/hwpmc_mod.c | 170 | ||||
| -rw-r--r-- | sys/kern/kern_linker.c | 78 | ||||
| -rw-r--r-- | sys/sys/linker.h | 3 | ||||
| -rw-r--r-- | sys/sys/param.h | 2 | ||||
| -rw-r--r-- | sys/sys/pmc.h | 10 | ||||
| -rw-r--r-- | sys/sys/pmckern.h | 18 | ||||
| -rw-r--r-- | sys/sys/pmclog.h | 39 | ||||
| -rw-r--r-- | sys/vm/vm_mmap.c | 41 | ||||
| -rw-r--r-- | usr.sbin/pmcstat/pmcstat.8 | 46 | ||||
| -rw-r--r-- | usr.sbin/pmcstat/pmcstat.c | 103 | ||||
| -rw-r--r-- | usr.sbin/pmcstat/pmcstat.h | 13 | ||||
| -rw-r--r-- | usr.sbin/pmcstat/pmcstat_log.c | 1271 |
16 files changed, 1399 insertions, 508 deletions
diff --git a/lib/libpmc/pmclog.3 b/lib/libpmc/pmclog.3 index 862f9cc..82674a9 100644 --- a/lib/libpmc/pmclog.3 +++ b/lib/libpmc/pmclog.3 @@ -1,4 +1,4 @@ -.\" Copyright (c) 2005 Joseph Koshy. All rights reserved. +.\" Copyright (c) 2005-2006 Joseph Koshy. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions @@ -23,7 +23,7 @@ .\" .\" $FreeBSD$ .\" -.Dd June 1, 2005 +.Dd March 26, 2006 .Os .Dt PMCLOG 3 .Sh NAME @@ -82,15 +82,21 @@ struct pmclog_ev { struct timespec pl_ts; /* log entry timestamp */ enum pmclog_type pl_type; /* log entry kind */ union { /* log entry data */ - struct pmclog_ev_allocate pl_a; - struct pmclog_ev_proccsw pl_c; - struct pmclog_ev_dropnotify pl_d; - struct pmclog_ev_procexit pl_e; - struct pmclog_ev_initialize pl_i; - struct pmclog_ev_pcsample pl_s; - struct pmclog_ev_pmcattach pl_t; - struct pmclog_ev_userdata pl_u; - struct pmclog_ev_procexec pl_x; + struct pmclog_ev_closelog pl_cl; + struct pmclog_ev_dropnotify pl_d; + struct pmclog_ev_initialize pl_i; + struct pmclog_ev_map_in pl_mi; + struct pmclog_ev_map_out pl_mo; + struct pmclog_ev_pcsample pl_s; + struct pmclog_ev_pmcallocate pl_a; + struct pmclog_ev_pmcattach pl_t; + struct pmclog_ev_pmcdetach pl_d; + struct pmclog_ev_proccsw pl_c; + struct pmclog_ev_procexec pl_x; + struct pmclog_ev_procexit pl_e; + struct pmclog_ev_procfork pl_f; + struct pmclog_ev_sysexit pl_e; + struct pmclog_ev_userdata pl_u; } pl_u; }; .Ed @@ -149,8 +155,20 @@ had to drop data due to a resource constraint. .It Dv PMCLOG_TYPE_INITIALIZE An initialization record. This is the first record in a log file. -.It Dv PMCLOG_TYPE_MAPPINGCHANGE -A record describing an address space change for a process. +.It Dv PMCLOG_TYPE_MAP_IN +A record describing the introduction of a mapping to an executable +object by a +.Xr kldload 2 +or +.Xr mmap 2 +system call. +.It Dv PMCLOG_TYPE_MAP_OUT +A record describing the removal of a mapping to an executable +object by a +.Xr kldunload 2 +or +.Xr munmap 2 +system call. .It Dv PMCLOG_TYPE_PCSAMPLE A record containing an instruction pointer sample. .It Dv PMCLOG_TYPE_PMCALLOCATE diff --git a/lib/libpmc/pmclog.c b/lib/libpmc/pmclog.c index e5dd2fc..fcd4a4f 100644 --- a/lib/libpmc/pmclog.c +++ b/lib/libpmc/pmclog.c @@ -1,5 +1,5 @@ /*- - * Copyright (c) 2005 Joseph Koshy + * Copyright (c) 2005-2006 Joseph Koshy * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -322,13 +322,16 @@ pmclog_get_event(void *cookie, char **data, ssize_t *len, ps->ps_arch = ev->pl_u.pl_i.pl_arch; ps->ps_initialized = 1; break; - case PMCLOG_TYPE_MAPPINGCHANGE: - PMCLOG_GET_PATHLEN(pathlen,evlen,pmclog_mappingchange); - PMCLOG_READ32(le,ev->pl_u.pl_m.pl_type); - PMCLOG_READADDR(le,ev->pl_u.pl_m.pl_start); - PMCLOG_READADDR(le,ev->pl_u.pl_m.pl_end); - PMCLOG_READ32(le,ev->pl_u.pl_m.pl_pid); - PMCLOG_READSTRING(le, ev->pl_u.pl_m.pl_pathname, pathlen); + case PMCLOG_TYPE_MAP_IN: + PMCLOG_GET_PATHLEN(pathlen,evlen,pmclog_map_in); + PMCLOG_READ32(le,ev->pl_u.pl_mi.pl_pid); + PMCLOG_READADDR(le,ev->pl_u.pl_mi.pl_start); + PMCLOG_READSTRING(le, ev->pl_u.pl_mi.pl_pathname, pathlen); + break; + case PMCLOG_TYPE_MAP_OUT: + PMCLOG_READ32(le,ev->pl_u.pl_mo.pl_pid); + PMCLOG_READADDR(le,ev->pl_u.pl_mo.pl_start); + PMCLOG_READADDR(le,ev->pl_u.pl_mo.pl_end); break; case PMCLOG_TYPE_PCSAMPLE: PMCLOG_READ32(le,ev->pl_u.pl_s.pl_pid); diff --git a/lib/libpmc/pmclog.h b/lib/libpmc/pmclog.h index bc3c476..90fb193 100644 --- a/lib/libpmc/pmclog.h +++ b/lib/libpmc/pmclog.h @@ -1,5 +1,5 @@ /*- - * Copyright (c) 2005 Joseph Koshy + * Copyright (c) 2005-2006 Joseph Koshy * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -49,14 +49,18 @@ struct pmclog_ev_initialize { uint32_t pl_arch; }; -struct pmclog_ev_mappingchange { - uint32_t pl_type; +struct pmclog_ev_map_in { pid_t pl_pid; uintfptr_t pl_start; - uintfptr_t pl_end; char pl_pathname[PATH_MAX]; }; +struct pmclog_ev_map_out { + pid_t pl_pid; + uintfptr_t pl_start; + uintfptr_t pl_end; +}; + struct pmclog_ev_pcsample { uintfptr_t pl_pc; pid_t pl_pid; @@ -124,7 +128,8 @@ struct pmclog_ev { struct pmclog_ev_closelog pl_cl; struct pmclog_ev_dropnotify pl_dn; struct pmclog_ev_initialize pl_i; - struct pmclog_ev_mappingchange pl_m; + struct pmclog_ev_map_in pl_mi; + struct pmclog_ev_map_out pl_mo; struct pmclog_ev_pcsample pl_s; struct pmclog_ev_pmcallocate pl_a; struct pmclog_ev_pmcattach pl_t; diff --git a/sys/dev/hwpmc/hwpmc_logging.c b/sys/dev/hwpmc/hwpmc_logging.c index f901cbe..efa0c52 100644 --- a/sys/dev/hwpmc/hwpmc_logging.c +++ b/sys/dev/hwpmc/hwpmc_logging.c @@ -137,10 +137,11 @@ static struct mtx pmc_kthread_mtx; /* sleep lock */ CTASSERT(sizeof(struct pmclog_closelog) == 3*4); CTASSERT(sizeof(struct pmclog_dropnotify) == 3*4); -CTASSERT(sizeof(struct pmclog_mappingchange) == PATH_MAX + - 5*4 + 2*sizeof(uintfptr_t)); -CTASSERT(offsetof(struct pmclog_mappingchange,pl_pathname) == - 5*4 + 2*sizeof(uintfptr_t)); +CTASSERT(sizeof(struct pmclog_map_in) == PATH_MAX + + 4*4 + sizeof(uintfptr_t)); +CTASSERT(offsetof(struct pmclog_map_in,pl_pathname) == + 4*4 + sizeof(uintfptr_t)); +CTASSERT(sizeof(struct pmclog_map_out) == 4*4 + 2*sizeof(uintfptr_t)); CTASSERT(sizeof(struct pmclog_pcsample) == 6*4 + sizeof(uintfptr_t)); CTASSERT(sizeof(struct pmclog_pmcallocate) == 6*4); CTASSERT(sizeof(struct pmclog_pmcattach) == 5*4 + PATH_MAX); @@ -728,24 +729,36 @@ pmclog_process_dropnotify(struct pmc_owner *po) } void -pmclog_process_mappingchange(struct pmc_owner *po, pid_t pid, int type, - uintfptr_t start, uintfptr_t end, char *path) +pmclog_process_map_in(struct pmc_owner *po, pid_t pid, uintfptr_t start, + const char *path) { int pathlen, recordlen; + KASSERT(path != NULL, ("[pmclog,%d] map-in, null path", __LINE__)); + pathlen = strlen(path) + 1; /* #bytes for path name */ - recordlen = offsetof(struct pmclog_mappingchange, pl_pathname) + + recordlen = offsetof(struct pmclog_map_in, pl_pathname) + pathlen; - PMCLOG_RESERVE(po,MAPPINGCHANGE,recordlen); - PMCLOG_EMIT32(type); - PMCLOG_EMITADDR(start); - PMCLOG_EMITADDR(end); + PMCLOG_RESERVE(po, MAP_IN, recordlen); PMCLOG_EMIT32(pid); + PMCLOG_EMITADDR(start); PMCLOG_EMITSTRING(path,pathlen); PMCLOG_DESPATCH(po); } +void +pmclog_process_map_out(struct pmc_owner *po, pid_t pid, uintfptr_t start, + uintfptr_t end) +{ + KASSERT(start <= end, ("[pmclog,%d] start > end", __LINE__)); + + PMCLOG_RESERVE(po, MAP_OUT, sizeof(struct pmclog_map_out)); + PMCLOG_EMIT32(pid); + PMCLOG_EMITADDR(start); + PMCLOG_EMITADDR(end); + PMCLOG_DESPATCH(po); +} void pmclog_process_pcsample(struct pmc *pm, struct pmc_sample *ps) diff --git a/sys/dev/hwpmc/hwpmc_mod.c b/sys/dev/hwpmc/hwpmc_mod.c index 0b6f72d..12d742a 100644 --- a/sys/dev/hwpmc/hwpmc_mod.c +++ b/sys/dev/hwpmc/hwpmc_mod.c @@ -1,5 +1,5 @@ /*- - * Copyright (c) 2003-2005 Joseph Koshy + * Copyright (c) 2003-2006 Joseph Koshy * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -53,6 +53,8 @@ __FBSDID("$FreeBSD$"); #include <sys/systm.h> #include <sys/vnode.h> +#include <sys/linker.h> /* needs to be after <sys/malloc.h> */ + #include <machine/atomic.h> #include <machine/md_var.h> @@ -1411,19 +1413,138 @@ pmc_process_csw_out(struct thread *td) } /* + * Log a KLD operation. + */ + +static void +pmc_process_kld_load(struct pmckern_map_in *pkm) +{ + struct pmc_owner *po; + + sx_assert(&pmc_sx, SX_LOCKED); + + /* + * Notify owners of system sampling PMCs about KLD operations. + */ + + LIST_FOREACH(po, &pmc_ss_owners, po_ssnext) + if (po->po_flags & PMC_PO_OWNS_LOGFILE) + pmclog_process_map_in(po, (pid_t) -1, pkm->pm_address, + (char *) pkm->pm_file); + + /* + * TODO: Notify owners of (all) process-sampling PMCs too. + */ + + return; +} + +static void +pmc_process_kld_unload(struct pmckern_map_out *pkm) +{ + struct pmc_owner *po; + + sx_assert(&pmc_sx, SX_LOCKED); + + LIST_FOREACH(po, &pmc_ss_owners, po_ssnext) + if (po->po_flags & PMC_PO_OWNS_LOGFILE) + pmclog_process_map_out(po, (pid_t) -1, + pkm->pm_address, pkm->pm_address + pkm->pm_size); + + /* + * TODO: Notify owners of process-sampling PMCs. + */ +} + +/* + * A mapping change for a process. + */ + +static void +pmc_process_mmap(struct thread *td, struct pmckern_map_in *pkm) +{ + int ri; + pid_t pid; + char *fullpath, *freepath; + const struct pmc *pm; + struct pmc_owner *po; + const struct pmc_process *pp; + + freepath = fullpath = NULL; + pmc_getfilename((struct vnode *) pkm->pm_file, &fullpath, &freepath); + + pid = td->td_proc->p_pid; + + /* Inform owners of all system-wide sampling PMCs. */ + LIST_FOREACH(po, &pmc_ss_owners, po_ssnext) + if (po->po_flags & PMC_PO_OWNS_LOGFILE) + pmclog_process_map_in(po, pid, pkm->pm_address, fullpath); + + if ((pp = pmc_find_process_descriptor(td->td_proc, 0)) == NULL) + goto done; + + /* + * Inform sampling PMC owners tracking this process. + */ + for (ri = 0; ri < md->pmd_npmc; ri++) + if ((pm = pp->pp_pmcs[ri].pp_pmc) != NULL && + PMC_IS_SAMPLING_MODE(PMC_TO_MODE(pm))) + pmclog_process_map_in(pm->pm_owner, + pid, pkm->pm_address, fullpath); + + done: + if (freepath) + FREE(freepath, M_TEMP); +} + + +/* + * Log an munmap request. + */ + +static void +pmc_process_munmap(struct thread *td, struct pmckern_map_out *pkm) +{ + int ri; + pid_t pid; + struct pmc_owner *po; + const struct pmc *pm; + const struct pmc_process *pp; + + pid = td->td_proc->p_pid; + + LIST_FOREACH(po, &pmc_ss_owners, po_ssnext) + if (po->po_flags & PMC_PO_OWNS_LOGFILE) + pmclog_process_map_out(po, pid, pkm->pm_address, + pkm->pm_address + pkm->pm_size); + + if ((pp = pmc_find_process_descriptor(td->td_proc, 0)) == NULL) + return; + + for (ri = 0; ri < md->pmd_npmc; ri++) + if ((pm = pp->pp_pmcs[ri].pp_pmc) != NULL && + PMC_IS_SAMPLING_MODE(PMC_TO_MODE(pm))) + pmclog_process_map_out(po, pid, pkm->pm_address, + pkm->pm_address + pkm->pm_size); +} + +/* * The 'hook' invoked from the kernel proper */ #ifdef DEBUG const char *pmc_hooknames[] = { + /* these strings correspond to PMC_FN_* in <sys/pmckern.h> */ "", - "EXIT", "EXEC", - "FORK", "CSW-IN", "CSW-OUT", - "SAMPLE" + "SAMPLE", + "KLDLOAD", + "KLDUNLOAD", + "MMAP", + "MUNMAP" }; #endif @@ -1585,6 +1706,27 @@ pmc_hook_handler(struct thread *td, int function, void *arg) pmc_process_samples(PCPU_GET(cpuid)); break; + + case PMC_FN_KLD_LOAD: + sx_assert(&pmc_sx, SX_LOCKED); + pmc_process_kld_load((struct pmckern_map_in *) arg); + break; + + case PMC_FN_KLD_UNLOAD: + sx_assert(&pmc_sx, SX_LOCKED); + pmc_process_kld_unload((struct pmckern_map_out *) arg); + break; + + case PMC_FN_MMAP: + sx_assert(&pmc_sx, SX_LOCKED); + pmc_process_mmap(td, (struct pmckern_map_in *) arg); + break; + + case PMC_FN_MUNMAP: + sx_assert(&pmc_sx, SX_LOCKED); + pmc_process_munmap(td, (struct pmckern_map_out *) arg); + break; + default: #ifdef DEBUG KASSERT(0, ("[pmc,%d] unknown hook %d\n", __LINE__, function)); @@ -2237,6 +2379,8 @@ pmc_start(struct pmc *pm) po->po_sscount++; } + /* TODO: dump system wide process mappings to the log? */ + /* * Move to the CPU associated with this * PMC, and start the hardware. @@ -2408,10 +2552,11 @@ pmc_syscall_handler(struct thread *td, void *syscall_args) case PMC_OP_CONFIGURELOG: { + struct proc *p; struct pmc *pm; struct pmc_owner *po; + struct pmckern_map_in *km, *kmbase; struct pmc_op_configurelog cl; - struct proc *p; sx_assert(&pmc_sx, SX_XLOCKED); @@ -2446,6 +2591,21 @@ pmc_syscall_handler(struct thread *td, void *syscall_args) } } else error = EINVAL; + + if (error) + break; + + /* + * Log the current set of kernel modules. + */ + kmbase = linker_hwpmc_list_objects(); + for (km = kmbase; km->pm_file != NULL; km++) { + PMCDBG(LOG,REG,1,"%s %p", (char *) km->pm_file, + (void *) km->pm_address); + pmclog_process_map_in(po, (pid_t) -1, km->pm_address, + km->pm_file); + } + FREE(kmbase, M_LINKER); } break; diff --git a/sys/kern/kern_linker.c b/sys/kern/kern_linker.c index ca05cc0..a48cfd2 100644 --- a/sys/kern/kern_linker.c +++ b/sys/kern/kern_linker.c @@ -28,6 +28,7 @@ __FBSDID("$FreeBSD$"); #include "opt_ddb.h" +#include "opt_hwpmc_hooks.h" #include "opt_mac.h" #include <sys/param.h> @@ -51,6 +52,10 @@ __FBSDID("$FreeBSD$"); #include "linker_if.h" +#ifdef HWPMC_HOOKS +#include <sys/pmckern.h> +#endif + #ifdef KLD_DEBUG int kld_debug = 0; #endif @@ -751,6 +756,9 @@ linker_ddb_symbol_values(c_linker_sym_t sym, linker_symval_t *symval) int kldload(struct thread *td, struct kldload_args *uap) { +#ifdef HWPMC_HOOKS + struct pmckern_map_in pkm; +#endif char *kldname, *modname; char *pathname = NULL; linker_file_t lf; @@ -786,6 +794,11 @@ kldload(struct thread *td, struct kldload_args *uap) if (error) goto out; +#ifdef HWPMC_HOOKS + pkm.pm_file = lf->filename; + pkm.pm_address = (uintptr_t) lf->address; + PMC_CALL_HOOK(td, PMC_FN_KLD_LOAD, (void *) &pkm); +#endif lf->userrefs++; td->td_retval[0] = lf->id; out: @@ -801,6 +814,9 @@ out: static int kern_kldunload(struct thread *td, int fileid, int flags) { +#ifdef HWPMC_HOOKS + struct pmckern_map_out pkm; +#endif linker_file_t lf; int error = 0; @@ -825,11 +841,21 @@ kern_kldunload(struct thread *td, int fileid, int flags) goto out; } lf->userrefs--; +#ifdef HWPMC_HOOKS + /* Save data needed by hwpmc(4) before unloading the kld. */ + pkm.pm_address = (uintptr_t) lf->address; + pkm.pm_size = lf->size; +#endif error = linker_file_unload(lf, flags); if (error) lf->userrefs++; } else error = ENOENT; + +#ifdef HWPMC_HOOKS + if (error == 0) + PMC_CALL_HOOK(td, PMC_FN_KLD_UNLOAD, (void *) &pkm); +#endif out: mtx_unlock(&Giant); return (error); @@ -1659,6 +1685,58 @@ linker_basename(const char *path) return (filename); } +#ifdef HWPMC_HOOKS + +/* + * Inform hwpmc about the set of kernel modules currently loaded. + */ +void * +linker_hwpmc_list_objects(void) +{ + int nobjects, nmappings; + linker_file_t lf; + struct pmckern_map_in *ko, *kobase; + + nmappings = 15; /* a reasonable default */ + + retry: + /* allocate nmappings+1 entries */ + MALLOC(kobase, struct pmckern_map_in *, + (nmappings + 1) * sizeof(struct pmckern_map_in), M_LINKER, + M_WAITOK | M_ZERO); + + nobjects = 0; + mtx_lock(&kld_mtx); + TAILQ_FOREACH(lf, &linker_files, link) + nobjects++; + + KASSERT(nobjects > 0, ("linker_hpwmc_list_objects: no kernel " + "objects?")); + + if (nobjects > nmappings) { + nmappings = nobjects; + FREE(kobase, M_LINKER); + mtx_unlock(&kld_mtx); + goto retry; + } + + ko = kobase; + TAILQ_FOREACH(lf, &linker_files, link) { + ko->pm_file = lf->filename; + ko->pm_address = (uintptr_t) lf->address; + ko++; + } + + /* The last entry of the malloced area comprises of all zeros. */ + KASSERT(ko->pm_file == NULL, + ("linker_hwpmc_list_objects: last object not NULL")); + + mtx_unlock(&kld_mtx); + + return ((void *) kobase); +} +#endif + /* * Find a file which contains given module and load it, if "parent" is not * NULL, register a reference to it. diff --git a/sys/sys/linker.h b/sys/sys/linker.h index 90ed243..c112eb4 100644 --- a/sys/sys/linker.h +++ b/sys/sys/linker.h @@ -172,6 +172,9 @@ int linker_ddb_search_symbol(caddr_t _value, c_linker_sym_t *_sym, int linker_ddb_symbol_values(c_linker_sym_t _sym, linker_symval_t *_symval); +/* HWPMC helper */ +void *linker_hwpmc_list_objects(void); + #endif /* _KERNEL */ /* diff --git a/sys/sys/param.h b/sys/sys/param.h index 4c6a6ca..04ee8b8 100644 --- a/sys/sys/param.h +++ b/sys/sys/param.h @@ -57,7 +57,7 @@ * is created, otherwise 1. */ #undef __FreeBSD_version -#define __FreeBSD_version 700014 /* Master, propagated to newvers */ +#define __FreeBSD_version 700015 /* Master, propagated to newvers */ #ifndef LOCORE #include <sys/types.h> diff --git a/sys/sys/pmc.h b/sys/sys/pmc.h index 3ce513d..a0bad56 100644 --- a/sys/sys/pmc.h +++ b/sys/sys/pmc.h @@ -1,5 +1,5 @@ /*- - * Copyright (c) 2003-2005, Joseph Koshy + * Copyright (c) 2003-2006, Joseph Koshy * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -50,9 +50,9 @@ * * The patch version is incremented for every bug fix. */ -#define PMC_VERSION_MAJOR 0x01 -#define PMC_VERSION_MINOR 0x02 -#define PMC_VERSION_PATCH 0x0003 +#define PMC_VERSION_MAJOR 0x02 +#define PMC_VERSION_MINOR 0x00 +#define PMC_VERSION_PATCH 0x0000 #define PMC_VERSION (PMC_VERSION_MAJOR << 24 | \ PMC_VERSION_MINOR << 16 | PMC_VERSION_PATCH) @@ -538,7 +538,7 @@ struct pmc_op_getmsr { #define PMC_MTXPOOL_SIZE 32 #define PMC_LOG_BUFFER_SIZE 4 #define PMC_NLOGBUFFERS 16 -#define PMC_NSAMPLES 16 +#define PMC_NSAMPLES 32 #define PMC_SYSCTL_NAME_PREFIX "kern." PMC_MODULE_NAME "." diff --git a/sys/sys/pmckern.h b/sys/sys/pmckern.h index d489fe6..5ae3101 100644 --- a/sys/sys/pmckern.h +++ b/sys/sys/pmckern.h @@ -1,5 +1,5 @@ /*- - * Copyright (c) 2003-2005, Joseph Koshy + * Copyright (c) 2003-2006, Joseph Koshy * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -43,10 +43,24 @@ #define PMC_FN_CSW_IN 2 #define PMC_FN_CSW_OUT 3 #define PMC_FN_DO_SAMPLES 4 +#define PMC_FN_KLD_LOAD 5 +#define PMC_FN_KLD_UNLOAD 6 +#define PMC_FN_MMAP 7 +#define PMC_FN_MUNMAP 8 struct pmckern_procexec { int pm_credentialschanged; - uintptr_t pm_entryaddr; + uintfptr_t pm_entryaddr; +}; + +struct pmckern_map_in { + void *pm_file; /* filename or vnode pointer */ + uintfptr_t pm_address; /* address object is loaded at */ +}; + +struct pmckern_map_out { + uintfptr_t pm_address; /* start address of region */ + size_t pm_size; /* size of unmapped region */ }; /* hook */ diff --git a/sys/sys/pmclog.h b/sys/sys/pmclog.h index 026c667..2d2edc0 100644 --- a/sys/sys/pmclog.h +++ b/sys/sys/pmclog.h @@ -1,5 +1,5 @@ /*- - * Copyright (c) 2005 Joseph Koshy + * Copyright (c) 2005-2006, Joseph Koshy * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -32,10 +32,11 @@ #include <sys/pmc.h> enum pmclog_type { + /* V1 ABI */ PMCLOG_TYPE_CLOSELOG, PMCLOG_TYPE_DROPNOTIFY, PMCLOG_TYPE_INITIALIZE, - PMCLOG_TYPE_MAPPINGCHANGE, + PMCLOG_TYPE_MAPPINGCHANGE, /* unused in v1 */ PMCLOG_TYPE_PCSAMPLE, PMCLOG_TYPE_PMCALLOCATE, PMCLOG_TYPE_PMCATTACH, @@ -45,11 +46,19 @@ enum pmclog_type { PMCLOG_TYPE_PROCEXIT, PMCLOG_TYPE_PROCFORK, PMCLOG_TYPE_SYSEXIT, - PMCLOG_TYPE_USERDATA + PMCLOG_TYPE_USERDATA, + /* + * V2 ABI + * + * The MAP_{IN,OUT} event types obsolete the MAPPING_CHANGE + * event type of the older (V1) ABI. + */ + PMCLOG_TYPE_MAP_IN, + PMCLOG_TYPE_MAP_OUT }; -#define PMCLOG_MAPPING_INSERT 0x01 -#define PMCLOG_MAPPING_DELETE 0x02 +#define PMCLOG_MAPPING_INSERT 0x01 /* obsolete */ +#define PMCLOG_MAPPING_DELETE 0x02 /* obsolete */ /* * A log entry descriptor comprises of a 32 bit header and a 64 bit @@ -98,15 +107,19 @@ struct pmclog_initialize { uint32_t pl_cpu; /* enum pmc_cputype */ } __packed; -struct pmclog_mappingchange { +struct pmclog_map_in { PMCLOG_ENTRY_HEADER - uint32_t pl_type; - uintfptr_t pl_start; /* 8 byte aligned */ - uintfptr_t pl_end; uint32_t pl_pid; + uintfptr_t pl_start; /* 8 byte aligned */ char pl_pathname[PATH_MAX]; } __packed; +struct pmclog_map_out { + PMCLOG_ENTRY_HEADER + uint32_t pl_pid; + uintfptr_t pl_start; /* 8 byte aligned */ + uintfptr_t pl_end; +} __packed; struct pmclog_pcsample { PMCLOG_ENTRY_HEADER @@ -178,6 +191,8 @@ union pmclog_entry { /* only used to size scratch areas */ struct pmclog_closelog pl_cl; struct pmclog_dropnotify pl_dn; struct pmclog_initialize pl_i; + struct pmclog_map_in pl_mi; + struct pmclog_map_out pl_mo; struct pmclog_pcsample pl_s; struct pmclog_pmcallocate pl_a; struct pmclog_pmcattach pl_t; @@ -212,8 +227,10 @@ int pmclog_flush(struct pmc_owner *_po); void pmclog_initialize(void); void pmclog_process_closelog(struct pmc_owner *po); void pmclog_process_dropnotify(struct pmc_owner *po); -void pmclog_process_mappingchange(struct pmc_owner *po, pid_t pid, int type, - uintfptr_t start, uintfptr_t end, char *path); +void pmclog_process_map_in(struct pmc_owner *po, pid_t pid, + uintfptr_t start, const char *path); +void pmclog_process_map_out(struct pmc_owner *po, pid_t pid, + uintfptr_t start, uintfptr_t end); void pmclog_process_pcsample(struct pmc *_pm, struct pmc_sample *_ps); void pmclog_process_pmcallocate(struct pmc *_pm); void pmclog_process_pmcattach(struct pmc *_pm, pid_t _pid, char *_path); diff --git a/sys/vm/vm_mmap.c b/sys/vm/vm_mmap.c index 9379c3b..33f387e 100644 --- a/sys/vm/vm_mmap.c +++ b/sys/vm/vm_mmap.c @@ -44,6 +44,7 @@ __FBSDID("$FreeBSD$"); #include "opt_compat.h" +#include "opt_hwpmc_hooks.h" #include "opt_mac.h" #include <sys/param.h> @@ -79,6 +80,10 @@ __FBSDID("$FreeBSD$"); #include <vm/vm_page.h> #include <vm/vm_kern.h> +#ifdef HWPMC_HOOKS +#include <sys/pmckern.h> +#endif + #ifndef _SYS_SYSPROTO_H_ struct sbrk_args { int incr; @@ -201,6 +206,9 @@ mmap(td, uap) struct thread *td; struct mmap_args *uap; { +#ifdef HWPMC_HOOKS + struct pmckern_map_in pkm; +#endif struct file *fp; struct vnode *vp; vm_offset_t addr; @@ -364,6 +372,15 @@ mmap(td, uap) error = vm_mmap(&vms->vm_map, &addr, size, prot, maxprot, flags, handle_type, handle, pos); +#ifdef HWPMC_HOOKS + /* inform hwpmc(4) if an executable is being mapped */ + if (error == 0 && handle_type == OBJT_VNODE && + (prot & PROT_EXEC)) { + pkm.pm_file = handle; + pkm.pm_address = (uintptr_t) addr; + PMC_CALL_HOOK(td, PMC_FN_MMAP, (void *) &pkm); + } +#endif if (error == 0) td->td_retval[0] = (register_t) (addr + pageoff); done: @@ -495,6 +512,10 @@ munmap(td, uap) struct thread *td; struct munmap_args *uap; { +#ifdef HWPMC_HOOKS + struct pmckern_map_out pkm; + vm_map_entry_t entry; +#endif vm_offset_t addr; vm_size_t size, pageoff; vm_map_t map; @@ -525,6 +546,26 @@ munmap(td, uap) vm_map_unlock(map); return (EINVAL); } +#ifdef HWPMC_HOOKS + /* + * Inform hwpmc if the address range being unmapped contains + * an executable region. + */ + if (vm_map_lookup_entry(map, addr, &entry)) { + for (; + entry != &map->header && entry->start < addr + size; + entry = entry->next) { + if (vm_map_check_protection(map, entry->start, + entry->end, VM_PROT_EXECUTE) == TRUE) { + pkm.pm_address = (uintptr_t) addr; + pkm.pm_size = (size_t) size; + PMC_CALL_HOOK(td, PMC_FN_MUNMAP, + (void *) &pkm); + break; + } + } + } +#endif /* returns nothing but KERN_SUCCESS anyway */ vm_map_delete(map, addr, addr + size); vm_map_unlock(map); diff --git a/usr.sbin/pmcstat/pmcstat.8 b/usr.sbin/pmcstat/pmcstat.8 index 369a39d..692216f 100644 --- a/usr.sbin/pmcstat/pmcstat.8 +++ b/usr.sbin/pmcstat/pmcstat.8 @@ -1,4 +1,4 @@ -.\" Copyright (c) 2003 Joseph Koshy. All rights reserved. +.\" Copyright (c) 2003-2006 Joseph Koshy. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions @@ -23,7 +23,7 @@ .\" .\" $FreeBSD$ .\" -.Dd July 1, 2005 +.Dd March 26, 2006 .Os .Dt PMCSTAT 8 .Sh NAME @@ -34,6 +34,7 @@ .Op Fl C .Op Fl D Ar pathname .Op Fl E +.Op Fl M Ar mapfilename .Op Fl O Ar logfilename .Op Fl P Ar event-spec .Op Fl R Ar logfilename @@ -42,12 +43,15 @@ .Op Fl c Ar cpu .Op Fl d .Op Fl g -.Op Fl k Ar kernelfile +.Op Fl k Ar kerneldir .Op Fl n Ar rate .Op Fl o Ar outputfile .Op Fl p Ar event-spec +.Op Fl q +.Op Fl r Ar fsroot .Op Fl s Ar event-spec .Op Fl t Ar pid +.Op Fl v .Op Fl w Ar secs .Op Ar command Op Ar args .Sh DESCRIPTION @@ -116,6 +120,21 @@ complex pipeline of processes when used in conjunction with the .Fl d option. The default is to not to enable per-process tracking. +.It Fl M Ar mapfilename +Write the mapping between executable objects encountered in the event +log and the abbreviated pathnames used for +.Xr gprof 1 +profiles to file +.Ar mapfilename . +If this option is not specified, mapping information is not written. +Argument +.Ar mapfilename +may be a +.Dq Li - +in which case this mapping information is sent to the output +file configured by the +.Fl o +option. .It Fl O Ar logfilename Send logging output to file .Ar logfilename . @@ -159,11 +178,14 @@ A separate profile file is generated for each executable object encountered. Profile files are placed in sub-directories named by their PMC event name. -.It Fl k Ar kernelfile -Set the pathname of the kernel to argument -.Ar kernelfile . +.It Fl k Ar kerneldir +Set the pathname of the kernel directory to argument +.Ar kerneldir . +This directory specifies where +.Nm +should look for the kernel and its modules. The default is -.Pa /boot/kernel/kernel . +.Pa /boot/kernel . .It Fl n Ar rate Set the default sampling rate for subsequent sampling mode PMCs specified on the command line. @@ -179,6 +201,14 @@ The default is to send output to Allocate a process mode counting PMC measuring hardware events specified in .Ar event-spec . +.It Fl q +Decrease verbosity. +.It Fl r Ar fsroot +Set the top of the filesystem hierarchy under which executables +are located to argument +.Ar fsroot . +The default is +.Pa / . .It Fl s Ar event-spec Allocate a system mode counting PMC measuring hardware events specified in @@ -189,6 +219,8 @@ Attach all process mode PMCs allocated to the process with PID The option is not allowed in conjunction with specifying a command using .Ar command . +.It Fl v +Increase verbosity. .It Fl w Ar secs Print the values of all counting mode PMCs every .Ar secs diff --git a/usr.sbin/pmcstat/pmcstat.c b/usr.sbin/pmcstat/pmcstat.c index 9db889b..dd78bcd 100644 --- a/usr.sbin/pmcstat/pmcstat.c +++ b/usr.sbin/pmcstat/pmcstat.c @@ -1,5 +1,5 @@ /*- - * Copyright (c) 2003-2005, Joseph Koshy + * Copyright (c) 2003-2006, Joseph Koshy * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -40,6 +40,7 @@ __FBSDID("$FreeBSD$"); #include <err.h> #include <errno.h> #include <fcntl.h> +#include <libgen.h> #include <limits.h> #include <math.h> #include <pmc.h> @@ -110,7 +111,7 @@ pmcstat_cleanup(struct pmcstat_args *a) } if (a->pa_flags & (FLAG_HAS_PIPE | FLAG_HAS_OUTPUT_LOGFILE)) - pmcstat_shutdown_logging(); + pmcstat_shutdown_logging(a); } void @@ -317,6 +318,7 @@ pmcstat_show_usage(void) "\t -C\t\t (toggle) show cumulative counts\n" "\t -D path\t create profiles in directory \"path\"\n" "\t -E\t\t (toggle) show counts at process exit\n" + "\t -M file\t print executable/gmon file map to \"file\"\n" "\t -O file\t send log output to \"file\"\n" "\t -P spec\t allocate a process-private sampling PMC\n" "\t -R file\t read events from \"file\"\n" @@ -325,12 +327,15 @@ pmcstat_show_usage(void) "\t -c cpu\t\t set cpu for subsequent system-wide PMCs\n" "\t -d\t\t (toggle) track descendants\n" "\t -g\t\t produce gprof(1) compatible profiles\n" - "\t -k file\t set the path to the kernel\n" + "\t -k dir\t set the path to the kernel\n" "\t -n rate\t set sampling rate\n" "\t -o file\t send print output to \"file\"\n" "\t -p spec\t allocate a process-private counting PMC\n" + "\t -q\t\t suppress verbosity\n" + "\t -r fsroot\t specify FS root directory\n" "\t -s spec\t allocate a system-wide counting PMC\n" "\t -t pid\t\t attach to running process with pid \"pid\"\n" + "\t -v\t\t increase verbosity\n" "\t -w secs\t set printing time interval" ); } @@ -350,7 +355,7 @@ main(int argc, char **argv) int pipefd[2]; int use_cumulative_counts; pid_t pid; - char *end; + char *end, *tmp; const char *errmsg; enum pmcstat_state runstate; struct pmc_driverstats ds_start, ds_end; @@ -359,6 +364,7 @@ main(int argc, char **argv) struct kevent kev; struct winsize ws; struct stat sb; + char buffer[PATH_MAX]; check_driver_stats = 0; current_cpu = 0; @@ -369,19 +375,22 @@ main(int argc, char **argv) use_cumulative_counts = 0; args.pa_required = 0; args.pa_flags = 0; + args.pa_verbosity = 1; args.pa_pid = (pid_t) -1; args.pa_logfd = -1; + args.pa_fsroot = ""; + args.pa_kernel = strdup("/boot/kernel"); args.pa_samplesdir = "."; - args.pa_kernel = "/boot/kernel/kernel"; args.pa_printfile = stderr; args.pa_interval = DEFAULT_WAIT_INTERVAL; + args.pa_mapfilename = NULL; STAILQ_INIT(&args.pa_head); bzero(&ds_start, sizeof(ds_start)); bzero(&ds_end, sizeof(ds_end)); ev = NULL; - while ((option = getopt(argc, argv, "CD:EO:P:R:S:Wc:dgk:n:o:p:s:t:w:")) - != -1) + while ((option = getopt(argc, argv, + "CD:EM:O:P:R:S:Wc:dgk:n:o:p:qr:s:t:vw:")) != -1) switch (option) { case 'C': /* cumulative values */ use_cumulative_counts = !use_cumulative_counts; @@ -419,7 +428,8 @@ main(int argc, char **argv) break; case 'k': /* pathname to the kernel */ - args.pa_kernel = optarg; + free(args.pa_kernel); + args.pa_kernel = strdup(optarg); args.pa_required |= FLAG_DO_GPROF; args.pa_flags |= FLAG_HAS_KERNELPATH; break; @@ -430,6 +440,10 @@ main(int argc, char **argv) FLAG_HAS_COUNTING_PMCS | FLAG_HAS_OUTPUT_LOGFILE); break; + case 'M': /* mapfile */ + args.pa_mapfilename = optarg; + break; + case 'p': /* process virtual counting PMC */ case 's': /* system-wide counting PMC */ case 'P': /* process virtual sampling PMC */ @@ -523,6 +537,14 @@ main(int argc, char **argv) args.pa_flags |= FLAG_HAS_OUTPUT_LOGFILE; break; + case 'q': /* quiet mode */ + args.pa_verbosity = 0; + break; + + case 'r': /* root FS path */ + args.pa_fsroot = optarg; + break; + case 'R': /* read an existing log file */ if (args.pa_logparser != NULL) errx(EX_USAGE, "ERROR: option -R may only be " @@ -544,6 +566,10 @@ main(int argc, char **argv) args.pa_pid = pid; break; + case 'v': /* verbose */ + args.pa_verbosity++; + break; + case 'w': /* wait interval */ interval = strtod(optarg, &end); if (*end != '\0' || interval <= 0) @@ -658,14 +684,22 @@ main(int argc, char **argv) "ERROR: option -O is used only with options " "-E, -P, -S and -W."); - /* -D dir and -k kernel path require -g */ + /* -D dir and -k kernel path require -g or -R */ if ((args.pa_flags & FLAG_HAS_KERNELPATH) && - ((args.pa_flags & FLAG_DO_GPROF) == 0)) - errx(EX_USAGE, "ERROR: option -k is only used with -g."); + (args.pa_flags & FLAG_DO_GPROF) == 0 && + (args.pa_flags & FLAG_READ_LOGFILE) == 0) + errx(EX_USAGE, "ERROR: option -k is only used with -g/-R."); if ((args.pa_flags & FLAG_HAS_SAMPLESDIR) && - ((args.pa_flags & FLAG_DO_GPROF) == 0)) - errx(EX_USAGE, "ERROR: option -D is only used with -g."); + (args.pa_flags & FLAG_DO_GPROF) == 0 && + (args.pa_flags & FLAG_READ_LOGFILE) == 0) + errx(EX_USAGE, "ERROR: option -D is only used with -g/-R."); + + /* -M mapfile requires -g or -R */ + if (args.pa_mapfilename != NULL && + (args.pa_flags & FLAG_DO_GPROF) == 0 && + (args.pa_flags & FLAG_READ_LOGFILE) == 0) + errx(EX_USAGE, "ERROR: option -M is only used with -g/-R."); /* * Disallow textual output of sampling PMCs if counting PMCs @@ -678,6 +712,35 @@ main(int argc, char **argv) errx(EX_USAGE, "ERROR: option -O is required if counting and " "sampling PMCs are specified together."); + /* + * Check if "-k kerneldir" was specified, and if whether 'kerneldir' + * actually refers to a a file. If so, use `dirname path` to determine + * the kernel directory. + */ + if (args.pa_flags & FLAG_HAS_KERNELPATH) { + (void) snprintf(buffer, sizeof(buffer), "%s%s", args.pa_fsroot, + args.pa_kernel); + if (stat(buffer, &sb) < 0) + err(EX_OSERR, "ERROR: Cannot locate kernel \"%s\"", + buffer); + if (!S_ISREG(sb.st_mode) && !S_ISDIR(sb.st_mode)) + errx(EX_USAGE, "ERROR: \"%s\": Unsupported file type.", + buffer); + if (!S_ISDIR(sb.st_mode)) { + tmp = args.pa_kernel; + args.pa_kernel = strdup(dirname(args.pa_kernel)); + free(tmp); + (void) snprintf(buffer, sizeof(buffer), "%s%s", + args.pa_fsroot, args.pa_kernel); + if (stat(buffer, &sb) < 0) + err(EX_OSERR, "ERROR: Cannot stat \"%s\"", + buffer); + if (!S_ISDIR(sb.st_mode)) + errx(EX_USAGE, "ERROR: \"%s\" is not a " + "directory.", buffer); + } + } + /* if we've been asked to process a log file, do that and exit */ if (args.pa_flags & FLAG_READ_LOGFILE) { /* @@ -688,13 +751,14 @@ main(int argc, char **argv) args.pa_flags |= FLAG_DO_PRINT; pmcstat_initialize_logging(&args); - if ((args.pa_logfd = pmcstat_open(args.pa_inputpath, + if ((args.pa_logfd = pmcstat_open_log(args.pa_inputpath, PMCSTAT_OPEN_FOR_READ)) < 0) err(EX_OSERR, "ERROR: Cannot open \"%s\" for " "reading", args.pa_inputpath); if ((args.pa_logparser = pmclog_open(args.pa_logfd)) == NULL) err(EX_OSERR, "ERROR: Cannot create parser"); pmcstat_process_log(&args); + pmcstat_shutdown_logging(&args); exit(EX_OK); } @@ -721,7 +785,8 @@ main(int argc, char **argv) */ if (args.pa_required & FLAG_HAS_OUTPUT_LOGFILE) { if (args.pa_outputpath) { - if ((args.pa_logfd = pmcstat_open(args.pa_outputpath, + if ((args.pa_logfd = + pmcstat_open_log(args.pa_outputpath, PMCSTAT_OPEN_FOR_WRITE)) < 0) err(EX_OSERR, "ERROR: Cannot open \"%s\" for " "writing", args.pa_outputpath); @@ -966,17 +1031,21 @@ main(int argc, char **argv) pmcstat_cleanup(&args); + free(args.pa_kernel); + /* check if the driver lost any samples or events */ if (check_driver_stats) { if (pmc_get_driver_stats(&ds_end) < 0) err(EX_OSERR, "ERROR: Cannot retrieve driver " "statistics"); - if (ds_start.pm_intr_bufferfull != ds_end.pm_intr_bufferfull) + if (ds_start.pm_intr_bufferfull != ds_end.pm_intr_bufferfull && + args.pa_verbosity > 0) warnx("WARNING: some samples were dropped. Please " "consider tuning the \"kern.hwpmc.nsamples\" " "tunable."); if (ds_start.pm_buffer_requests_failed != - ds_end.pm_buffer_requests_failed) + ds_end.pm_buffer_requests_failed && + args.pa_verbosity > 0) warnx("WARNING: some events were discarded. Please " "consider tuning the \"kern.hwpmc.nbuffers\" " "tunable."); diff --git a/usr.sbin/pmcstat/pmcstat.h b/usr.sbin/pmcstat/pmcstat.h index f0246f9..c861f22 100644 --- a/usr.sbin/pmcstat/pmcstat.h +++ b/usr.sbin/pmcstat/pmcstat.h @@ -1,5 +1,5 @@ /*- - * Copyright (c) 2005, Joseph Koshy + * Copyright (c) 2005-2006, Joseph Koshy * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -93,14 +93,17 @@ struct pmcstat_ev { struct pmcstat_args { int pa_flags; /* argument flags */ int pa_required; /* required features */ + int pa_verbosity; /* verbosity level */ pid_t pa_pid; /* attached to pid */ FILE *pa_printfile; /* where to send printed output */ int pa_logfd; /* output log file */ char *pa_inputpath; /* path to input log */ char *pa_outputpath; /* path to output log */ void *pa_logparser; /* log file parser */ - const char *pa_kernel; /* pathname of the kernel */ + const char *pa_fsroot; /* FS root where executables reside */ + char *pa_kernel; /* pathname of the kernel */ const char *pa_samplesdir; /* directory for profile files */ + const char *pa_mapfilename;/* mapfile name */ double pa_interval; /* printing interval in seconds */ int pa_argc; char **pa_argv; @@ -111,17 +114,15 @@ struct pmcstat_args { void pmcstat_cleanup(struct pmcstat_args *_a); int pmcstat_close_log(struct pmcstat_args *_a); void pmcstat_initialize_logging(struct pmcstat_args *_a); -int pmcstat_open(const char *_p, int _mode); +int pmcstat_open_log(const char *_p, int _mode); void pmcstat_print_counters(struct pmcstat_args *_a); void pmcstat_print_headers(struct pmcstat_args *_a); void pmcstat_print_pmcs(struct pmcstat_args *_a); void pmcstat_setup_process(struct pmcstat_args *_a); void pmcstat_show_usage(void); -void pmcstat_shutdown_logging(void); +void pmcstat_shutdown_logging(struct pmcstat_args *_a); void pmcstat_start_pmcs(struct pmcstat_args *_a); void pmcstat_start_process(struct pmcstat_args *_a); int pmcstat_process_log(struct pmcstat_args *_a); -int pmcstat_print_log(struct pmcstat_args *_a); -int pmcstat_convert_log(struct pmcstat_args *_a); #endif /* _PMCSTAT_H_ */ diff --git a/usr.sbin/pmcstat/pmcstat_log.c b/usr.sbin/pmcstat/pmcstat_log.c index 9b7e02f..8cf3087 100644 --- a/usr.sbin/pmcstat/pmcstat_log.c +++ b/usr.sbin/pmcstat/pmcstat_log.c @@ -1,5 +1,5 @@ /*- - * Copyright (c) 2005, Joseph Koshy + * Copyright (c) 2005-2006, Joseph Koshy * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -24,27 +24,14 @@ * SUCH DAMAGE. */ -#include <sys/cdefs.h> -__FBSDID("$FreeBSD$"); - /* - * Transform a hwpmc(4) log into human readable form and into gprof(1) - * compatible profiles. - * - * Each executable object encountered in the log gets one 'gmon.out' - * profile per PMC. We currently track: - * - program executables - * - shared libraries loaded by the runtime loader - * - the runtime loader itself - * - the kernel. - * We do not track shared objects mapped in by dlopen() yet (this - * needs additional support from hwpmc(4)). - * - * 'gmon.out' profiles generated for a given sampling PMC are - * aggregates of all the samples for that particular executable - * object. + * Transform a hwpmc(4) log into human readable form, and into + * gprof(1) compatible profiles. */ +#include <sys/cdefs.h> +__FBSDID("$FreeBSD$"); + #include <sys/param.h> #include <sys/endian.h> #include <sys/gmon.h> @@ -78,19 +65,47 @@ __FBSDID("$FreeBSD$"); #define max(A,B) ((A) > (B) ? (A) : (B)) /* - * A simple implementation of interned strings. Each interned string - * is assigned a unique address, so that subsequent string compares - * can be done by a simple pointer comparision instead of with - * strcmp(). + * PUBLIC INTERFACES + * + * pmcstat_initialize_logging() initialize this module, called first + * pmcstat_shutdown_logging() orderly shutdown, called last + * pmcstat_open_log() open an eventlog for processing + * pmcstat_process_log() print/convert an event log + * pmcstat_close_log() finish processing an event log + * + * IMPLEMENTATION OF GMON OUTPUT + * + * We correlate each 'sample' seen in the event log back to an + * executable object in the system. Executable objects include: + * - program executables, + * - shared libraries loaded by the runtime loader, + * - dlopen()'ed objects loaded by the program, + * - the runtime loader itself, + * - the kernel and kernel modules. + * + * Each such executable object gets one 'gmon.out' profile, per PMC in + * use. Creation of 'gmon.out' profiles is done lazily. The + * 'gmon.out' profiles generated for a given sampling PMC are + * aggregates of all the samples for that particular executable + * object. + * + * Each process that we know about is treated as a set of regions that + * map to executable objects. Processes are described by + * 'pmcstat_process' structures. Executable objects are tracked by + * 'pmcstat_image' structures. The kernel and kernel modules are + * common to all processes (they reside at the same virtual addresses + * for all processes). Individual processes can have their text + * segments and shared libraries loaded at process-specific locations. + * + * A given executable object can be in use by multiple processes + * (e.g., libc.so) and loaded at a different address in each. + * pmcstat_pcmap structures track per-image mappings. + * + * The sample log could have samples from multiple PMCs; we + * generate one 'gmon.out' profile per PMC. */ -struct pmcstat_string { - LIST_ENTRY(pmcstat_string) ps_next; /* hash link */ - int ps_len; - int ps_hash; - const char *ps_string; -}; -static LIST_HEAD(,pmcstat_string) pmcstat_string_hash[PMCSTAT_NHASH]; +typedef const void *pmcstat_interned_string; /* * 'pmcstat_pmcrecord' is a mapping from PMC ids to human-readable @@ -99,8 +114,8 @@ static LIST_HEAD(,pmcstat_string) pmcstat_string_hash[PMCSTAT_NHASH]; struct pmcstat_pmcrecord { LIST_ENTRY(pmcstat_pmcrecord) pr_next; - pmc_id_t pr_pmcid; - const char *pr_pmcname; + pmc_id_t pr_pmcid; + pmcstat_interned_string pr_pmcname; }; static LIST_HEAD(,pmcstat_pmcrecord) pmcstat_pmcs = @@ -114,19 +129,17 @@ static LIST_HEAD(,pmcstat_pmcrecord) pmcstat_pmcs = struct pmcstat_gmonfile { LIST_ENTRY(pmcstat_gmonfile) pgf_next; /* list of entries */ + int pgf_overflow; /* whether a count overflowed */ pmc_id_t pgf_pmcid; /* id of the associated pmc */ size_t pgf_nbuckets; /* #buckets in this gmon.out */ - const char *pgf_name; /* pathname of gmon.out file */ + pmcstat_interned_string pgf_name; /* pathname of gmon.out file */ size_t pgf_ndatabytes; /* number of bytes mapped */ void *pgf_gmondata; /* pointer to mmap'ed data */ }; -static TAILQ_HEAD(,pmcstat_gmonfile) pmcstat_gmonfiles = - TAILQ_HEAD_INITIALIZER(pmcstat_gmonfiles); - /* * A 'pmcstat_image' structure describes an executable program on - * disk. 'pi_internedpath' is a cookie representing the pathname of + * disk. 'pi_execpath' is a cookie representing the pathname of * the executable. 'pi_start' and 'pi_end' are the least and greatest * virtual addresses for the text segments in the executable. * 'pi_gmonlist' contains a linked list of gmon.out files associated @@ -134,31 +147,52 @@ static TAILQ_HEAD(,pmcstat_gmonfile) pmcstat_gmonfiles = */ enum pmcstat_image_type { - PMCSTAT_IMAGE_UNKNOWN = 0, - PMCSTAT_IMAGE_ELF, - PMCSTAT_IMAGE_AOUT + PMCSTAT_IMAGE_UNKNOWN = 0, /* never looked at the image */ + PMCSTAT_IMAGE_INDETERMINABLE, /* can't tell what the image is */ + PMCSTAT_IMAGE_ELF32, /* ELF 32 bit object */ + PMCSTAT_IMAGE_ELF64, /* ELF 64 bit object */ + PMCSTAT_IMAGE_AOUT /* AOUT object */ }; struct pmcstat_image { LIST_ENTRY(pmcstat_image) pi_next; /* hash link */ TAILQ_ENTRY(pmcstat_image) pi_lru; /* LRU list */ - const char *pi_internedpath; /* cookie */ - const char *pi_samplename; /* sample path name */ + pmcstat_interned_string pi_execpath;/* cookie */ + pmcstat_interned_string pi_samplename; /* sample path name */ enum pmcstat_image_type pi_type; /* executable type */ + + /* + * Executables have pi_start and pi_end; these are zero + * for shared libraries. + */ uintfptr_t pi_start; /* start address (inclusive) */ uintfptr_t pi_end; /* end address (exclusive) */ uintfptr_t pi_entry; /* entry address */ - int pi_isdynamic; /* whether a dynamic object */ - const char *pi_dynlinkerpath; /* path in .interp section */ + uintfptr_t pi_vaddr; /* virtual address where loaded */ + int pi_isdynamic; /* whether a dynamic + * object */ + int pi_iskernelmodule; + pmcstat_interned_string pi_dynlinkerpath; /* path in .interp */ + /* + * An image can be associated with one or more gmon.out files; + * one per PMC. + */ LIST_HEAD(,pmcstat_gmonfile) pi_gmlist; }; +/* + * All image descriptors are kept in a hash table. + */ static LIST_HEAD(,pmcstat_image) pmcstat_image_hash[PMCSTAT_NHASH]; static TAILQ_HEAD(,pmcstat_image) pmcstat_image_lru = TAILQ_HEAD_INITIALIZER(pmcstat_image_lru); +/* + * A 'pmcstat_pcmap' structure maps a virtual address range to an + * underlying 'pmcstat_image' descriptor. + */ struct pmcstat_pcmap { TAILQ_ENTRY(pmcstat_pcmap) ppm_next; uintfptr_t ppm_lowpc; @@ -167,7 +201,15 @@ struct pmcstat_pcmap { }; /* - * A 'pmcstat_process' structure tracks processes. + * A 'pmcstat_process' structure models processes. Each process is + * associated with a set of pmcstat_pcmap structures that map + * addresses inside it to executable objects. This set is implemented + * as a list, kept sorted in ascending order of mapped addresses. + * + * 'pp_pid' holds the pid of the process. When a process exits, the + * 'pp_isactive' field is set to zero, but the process structure is + * not immediately reclaimed because there may still be samples in the + * log for this process. */ struct pmcstat_process { @@ -178,45 +220,200 @@ struct pmcstat_process { TAILQ_HEAD(,pmcstat_pcmap) pp_map; /* address range map */ }; +#define PMCSTAT_ALLOCATE 1 + +/* + * All process descriptors are kept in a hash table. + */ static LIST_HEAD(,pmcstat_process) pmcstat_process_hash[PMCSTAT_NHASH]; static struct pmcstat_process *pmcstat_kernproc; /* kernel 'process' */ +/* Misc. statistics */ +static struct pmcstat_stats { + int ps_exec_aout; /* # a.out executables seen */ + int ps_exec_elf; /* # elf executables seen */ + int ps_exec_errors; /* # errors processing executables */ + int ps_exec_indeterminable; /* # unknown executables seen */ + int ps_samples_total; /* total number of samples processed */ + int ps_samples_unknown_offset; /* #samples not in any map */ + int ps_samples_indeterminable; /* #samples in indeterminable images */ +} pmcstat_stats; + /* * Prototypes */ static void pmcstat_gmon_create_file(struct pmcstat_gmonfile *_pgf, struct pmcstat_image *_image); -static const char *pmcstat_gmon_create_name(const char *_sd, +static pmcstat_interned_string pmcstat_gmon_create_name(const char *_sd, struct pmcstat_image *_img, pmc_id_t _pmcid); static void pmcstat_gmon_map_file(struct pmcstat_gmonfile *_pgf); static void pmcstat_gmon_unmap_file(struct pmcstat_gmonfile *_pgf); -static struct pmcstat_image *pmcstat_image_from_path(const char *_path); -static enum pmcstat_image_type pmcstat_image_get_type(const char *_p); -static void pmcstat_image_get_elf_params(struct pmcstat_image *_image); +static void pmcstat_image_determine_type(struct pmcstat_image *_image, + struct pmcstat_args *_a); +static struct pmcstat_image *pmcstat_image_from_path(pmcstat_interned_string + _path, int _iskernelmodule); +static void pmcstat_image_get_aout_params(struct pmcstat_image *_image, + struct pmcstat_args *_a); +static void pmcstat_image_get_elf_params(struct pmcstat_image *_image, + struct pmcstat_args *_a); static void pmcstat_image_increment_bucket(struct pmcstat_pcmap *_pcm, uintfptr_t _pc, pmc_id_t _pmcid, struct pmcstat_args *_a); static void pmcstat_image_link(struct pmcstat_process *_pp, - struct pmcstat_image *_i, uintfptr_t _lpc, uintfptr_t _hpc); + struct pmcstat_image *_i, uintfptr_t _lpc); -static void pmcstat_pmcid_add(pmc_id_t _pmcid, const char *_name, - struct pmcstat_args *_a); +static void pmcstat_pmcid_add(pmc_id_t _pmcid, + pmcstat_interned_string _name, struct pmcstat_args *_a); static const char *pmcstat_pmcid_to_name(pmc_id_t _pmcid); -static void pmcstat_process_add_elf_image(struct pmcstat_process *_pp, - const char *_path, uintfptr_t _entryaddr); +static void pmcstat_process_aout_exec(struct pmcstat_process *_pp, + struct pmcstat_image *_image, uintfptr_t _entryaddr, + struct pmcstat_args *_a); +static void pmcstat_process_elf_exec(struct pmcstat_process *_pp, + struct pmcstat_image *_image, uintfptr_t _entryaddr, + struct pmcstat_args *_a); static void pmcstat_process_exec(struct pmcstat_process *_pp, - const char *_path, uintfptr_t _entryaddr); -static struct pmcstat_process *pmcstat_process_lookup(pid_t _pid, int _allocate); + pmcstat_interned_string _path, uintfptr_t _entryaddr, + struct pmcstat_args *_ao); +static struct pmcstat_process *pmcstat_process_lookup(pid_t _pid, + int _allocate); static struct pmcstat_pcmap *pmcstat_process_find_map( struct pmcstat_process *_p, uintfptr_t _pc); static int pmcstat_string_compute_hash(const char *_string); -static const char *pmcstat_string_intern(const char *_s); -static struct pmcstat_string *pmcstat_string_lookup(const char *_s); +static void pmcstat_string_initialize(void); +static pmcstat_interned_string pmcstat_string_intern(const char *_s); +static pmcstat_interned_string pmcstat_string_lookup(const char *_s); +static int pmcstat_string_lookup_hash(pmcstat_interned_string _is); +static void pmcstat_string_shutdown(void); +static const char *pmcstat_string_unintern(pmcstat_interned_string _is); + + +/* + * A simple implementation of interned strings. Each interned string + * is assigned a unique address, so that subsequent string compares + * can be done by a simple pointer comparision instead of using + * strcmp(). This speeds up hash table lookups and saves memory if + * duplicate strings are the norm. + */ +struct pmcstat_string { + LIST_ENTRY(pmcstat_string) ps_next; /* hash link */ + int ps_len; + int ps_hash; + char *ps_string; +}; + +static LIST_HEAD(,pmcstat_string) pmcstat_string_hash[PMCSTAT_NHASH]; + +/* + * Compute a 'hash' value for a string. + */ +static int +pmcstat_string_compute_hash(const char *s) +{ + int hash; + + for (hash = 0; *s; s++) + hash ^= *s; + + return (hash & PMCSTAT_HASH_MASK); +} + +/* + * Intern a copy of string 's', and return a pointer to the + * interned structure. + */ + +static pmcstat_interned_string +pmcstat_string_intern(const char *s) +{ + struct pmcstat_string *ps; + const struct pmcstat_string *cps; + int hash, len; + + if ((cps = pmcstat_string_lookup(s)) != NULL) + return (cps); + + hash = pmcstat_string_compute_hash(s); + len = strlen(s); + + if ((ps = malloc(sizeof(*ps))) == NULL) + err(EX_OSERR, "ERROR: Could not intern string"); + ps->ps_len = len; + ps->ps_hash = hash; + ps->ps_string = strdup(s); + LIST_INSERT_HEAD(&pmcstat_string_hash[hash], ps, ps_next); + return ((pmcstat_interned_string) ps); +} + +static const char * +pmcstat_string_unintern(pmcstat_interned_string str) +{ + const char *s; + + s = ((const struct pmcstat_string *) str)->ps_string; + return (s); +} + +static pmcstat_interned_string +pmcstat_string_lookup(const char *s) +{ + struct pmcstat_string *ps; + int hash, len; + + hash = pmcstat_string_compute_hash(s); + len = strlen(s); + + LIST_FOREACH(ps, &pmcstat_string_hash[hash], ps_next) + if (ps->ps_len == len && ps->ps_hash == hash && + strcmp(ps->ps_string, s) == 0) + return (ps); + return (NULL); +} + +static int +pmcstat_string_lookup_hash(pmcstat_interned_string s) +{ + const struct pmcstat_string *ps; + + ps = (const struct pmcstat_string *) s; + return (ps->ps_hash); +} + +/* + * Initialize the string interning facility. + */ + +static void +pmcstat_string_initialize(void) +{ + int i; + + for (i = 0; i < PMCSTAT_NHASH; i++) + LIST_INIT(&pmcstat_string_hash[i]); +} + +/* + * Destroy the string table, free'ing up space. + */ + +static void +pmcstat_string_shutdown(void) +{ + int i; + struct pmcstat_string *ps, *pstmp; + + for (i = 0; i < PMCSTAT_NHASH; i++) + LIST_FOREACH_SAFE(ps, &pmcstat_string_hash[i], ps_next, + pstmp) { + LIST_REMOVE(ps, ps_next); + free(ps->ps_string); + free(ps); + } +} /* * Create a gmon.out file and size it. @@ -229,11 +426,13 @@ pmcstat_gmon_create_file(struct pmcstat_gmonfile *pgf, int fd; size_t count; struct gmonhdr gm; + const char *pathname; char buffer[DEFAULT_BUFFER_SIZE]; - if ((fd = open(pgf->pgf_name, O_RDWR|O_NOFOLLOW|O_CREAT, + pathname = pmcstat_string_unintern(pgf->pgf_name); + if ((fd = open(pathname, O_RDWR|O_NOFOLLOW|O_CREAT, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH)) < 0) - err(EX_OSERR, "ERROR: Cannot open \"%s\"", pgf->pgf_name); + err(EX_OSERR, "ERROR: Cannot open \"%s\"", pathname); gm.lpc = image->pi_start; gm.hpc = image->pi_end; @@ -261,15 +460,22 @@ pmcstat_gmon_create_file(struct pmcstat_gmonfile *pgf, if (write(fd, &buffer, count) < 0) goto error; + /* TODO size the arc table */ + (void) close(fd); return; error: - err(EX_OSERR, "ERROR: Cannot write \"%s\"", pgf->pgf_name); + err(EX_OSERR, "ERROR: Cannot write \"%s\"", pathname); } -const char * +/* + * Determine the full pathname of a gmon.out file for a given + * (image,pmcid) combination. Return the interned string. + */ + +pmcstat_interned_string pmcstat_gmon_create_name(const char *samplesdir, struct pmcstat_image *image, pmc_id_t pmcid) { @@ -279,34 +485,40 @@ pmcstat_gmon_create_name(const char *samplesdir, struct pmcstat_image *image, pmcname = pmcstat_pmcid_to_name(pmcid); (void) snprintf(fullpath, sizeof(fullpath), - "%s/%s/%s", samplesdir, pmcname, image->pi_samplename); + "%s/%s/%s", samplesdir, pmcname, + pmcstat_string_unintern(image->pi_samplename)); - return pmcstat_string_intern(fullpath); + return (pmcstat_string_intern(fullpath)); } +/* + * Mmap in a gmon.out file for processing. + */ + static void pmcstat_gmon_map_file(struct pmcstat_gmonfile *pgf) { int fd; + const char *pathname; + + pathname = pmcstat_string_unintern(pgf->pgf_name); /* the gmon.out file must already exist */ - if ((fd = open(pgf->pgf_name, O_RDWR | O_NOFOLLOW, 0)) < 0) - err(EX_OSERR, "ERROR: cannot open \"%s\"", - pgf->pgf_name); + if ((fd = open(pathname, O_RDWR | O_NOFOLLOW, 0)) < 0) + err(EX_OSERR, "ERROR: cannot open \"%s\"", pathname); pgf->pgf_gmondata = mmap(NULL, pgf->pgf_ndatabytes, PROT_READ|PROT_WRITE, MAP_NOSYNC|MAP_SHARED, fd, 0); if (pgf->pgf_gmondata == MAP_FAILED) - /* XXX unmap a few files and try again? */ - err(EX_OSERR, "ERROR: cannot map \"%s\"", pgf->pgf_name); + err(EX_OSERR, "ERROR: cannot map \"%s\"", pathname); (void) close(fd); } /* - * Unmap the data mapped from a gmon.out file. + * Unmap a gmon.out file after sync'ing its data to disk. */ static void @@ -318,11 +530,66 @@ pmcstat_gmon_unmap_file(struct pmcstat_gmonfile *pgf) pgf->pgf_gmondata = NULL; } +/* + * Determine whether a given executable image is an A.OUT object, and + * if so, fill in its parameters from the text file. + * Sets image->pi_type. + */ + static void -pmcstat_image_get_elf_params(struct pmcstat_image *image) +pmcstat_image_get_aout_params(struct pmcstat_image *image, + struct pmcstat_args *a) +{ + int fd; + ssize_t nbytes; + struct exec ex; + const char *path; + char buffer[PATH_MAX]; + + path = pmcstat_string_unintern(image->pi_execpath); + assert(path != NULL); + + if (image->pi_iskernelmodule) + errx(EX_SOFTWARE, "ERROR: a.out kernel modules are " + "unsupported \"%s\"", path); + + (void) snprintf(buffer, sizeof(buffer), "%s%s", + a->pa_fsroot, path); + + if ((fd = open(buffer, O_RDONLY, 0)) < 0 || + (nbytes = read(fd, &ex, sizeof(ex))) < 0) { + warn("WARNING: Cannot determine type of \"%s\"", path); + image->pi_type = PMCSTAT_IMAGE_INDETERMINABLE; + if (fd != -1) + (void) close(fd); + return; + } + + (void) close(fd); + + if ((unsigned) nbytes != sizeof(ex) || + N_BADMAG(ex)) + return; + + image->pi_type = PMCSTAT_IMAGE_AOUT; + + /* TODO: the rest of a.out processing */ + + return; +} + +/* + * Examine an ELF file to determine the size of its text segment. + * Sets image->pi_type if anything conclusive can be determined about + * this image. + */ + +static void +pmcstat_image_get_elf_params(struct pmcstat_image *image, + struct pmcstat_args *a) { int fd, i; - struct stat st; + const char *path; void *mapbase; uintfptr_t minva, maxva; const Elf_Ehdr *h; @@ -333,34 +600,58 @@ pmcstat_image_get_elf_params(struct pmcstat_image *image) const Elf32_Phdr *ph32; const Elf32_Shdr *sh32; #endif - const char *path; + enum pmcstat_image_type image_type; + struct stat st; + char buffer[PATH_MAX]; assert(image->pi_type == PMCSTAT_IMAGE_UNKNOWN); minva = ~(uintfptr_t) 0; maxva = (uintfptr_t) 0; - path = image->pi_internedpath; - - if ((fd = open(path, O_RDONLY, 0)) < 0) - err(EX_OSERR, "ERROR: Cannot open \"%s\"", path); + path = pmcstat_string_unintern(image->pi_execpath); - if (fstat(fd, &st) < 0) - err(EX_OSERR, "ERROR: Cannot stat \"%s\"", path); + assert(path != NULL); - if ((mapbase = mmap(0, st.st_size, PROT_READ, MAP_SHARED, fd, 0)) == - MAP_FAILED) - err(EX_OSERR, "ERROR: Cannot mmap \"%s\"", path); + /* + * Look for kernel modules under FSROOT/KERNELPATH/NAME, + * and user mode executable objects under FSROOT/PATHNAME. + */ + if (image->pi_iskernelmodule) + (void) snprintf(buffer, sizeof(buffer), "%s%s/%s", + a->pa_fsroot, a->pa_kernel, path); + else + (void) snprintf(buffer, sizeof(buffer), "%s%s", + a->pa_fsroot, path); + + if ((fd = open(buffer, O_RDONLY, 0)) < 0 || + fstat(fd, &st) < 0 || + (mapbase = mmap(0, st.st_size, PROT_READ, MAP_SHARED, + fd, 0)) == MAP_FAILED) { + warn("WARNING: Cannot determine type of \"%s\"", buffer); + image->pi_type = PMCSTAT_IMAGE_INDETERMINABLE; + if (fd != -1) + (void) close(fd); + return; + } (void) close(fd); + /* Punt on non-ELF objects */ h = (const Elf_Ehdr *) mapbase; if (!IS_ELF(*h)) - err(EX_SOFTWARE, "ERROR: \"%s\" not an ELF file", path); + return; - /* we only handle executable objects */ - if (h->e_type != ET_EXEC && h->e_type != ET_DYN) - err(EX_DATAERR, "ERROR: Unknown file type for \"%s\"", - image->pi_internedpath); + /* + * We only handle executable ELF objects and kernel + * modules. + */ + if (h->e_type != ET_EXEC && h->e_type != ET_DYN && + !(image->pi_iskernelmodule && h->e_type == ET_REL)) + return; + + image->pi_isdynamic = 0; + image->pi_dynlinkerpath = NULL; + image->pi_vaddr = 0; #define GET_VA(H, SH, MINVA, MAXVA) do { \ for (i = 0; i < (H)->e_shnum; i++) \ @@ -381,17 +672,18 @@ pmcstat_image_get_elf_params(struct pmcstat_image *image) case PT_INTERP: \ image->pi_dynlinkerpath = \ pmcstat_string_intern( \ - (char *) mapbase + \ + (char *) mapbase + \ (PH)[i].p_offset); \ break; \ + case PT_LOAD: \ + if ((PH)[i].p_offset == 0) \ + image->pi_vaddr = \ + (PH)[i].p_vaddr; \ + break; \ } \ } \ } while (0) - image->pi_type = PMCSTAT_IMAGE_ELF; - image->pi_isdynamic = 0; - image->pi_dynlinkerpath = NULL; - switch (h->e_machine) { case EM_386: case EM_486: @@ -409,6 +701,7 @@ pmcstat_image_get_elf_params(struct pmcstat_image *image) h32->e_phoff); GET_PHDR_INFO(h32, ph32, image); } + image_type = PMCSTAT_IMAGE_ELF32; break; #endif default: @@ -423,6 +716,7 @@ pmcstat_image_get_elf_params(struct pmcstat_image *image) h->e_phoff); GET_PHDR_INFO(h, ph, image); } + image_type = PMCSTAT_IMAGE_ELF64; break; } @@ -430,36 +724,68 @@ pmcstat_image_get_elf_params(struct pmcstat_image *image) #undef GET_VA image->pi_start = minva; - image->pi_end = maxva; + image->pi_end = maxva; + image->pi_type = image_type; if (munmap(mapbase, st.st_size) < 0) err(EX_OSERR, "ERROR: Cannot unmap \"%s\"", path); + return; +} + +/* + * Given an image descriptor, determine whether it is an ELF, or AOUT. + * If no handler claims the image, set its type to 'INDETERMINABLE'. + */ + +static void +pmcstat_image_determine_type(struct pmcstat_image *image, + struct pmcstat_args *a) +{ + assert(image->pi_type == PMCSTAT_IMAGE_UNKNOWN); + + /* Try each kind of handler in turn */ + if (image->pi_type == PMCSTAT_IMAGE_UNKNOWN) + pmcstat_image_get_elf_params(image, a); + if (image->pi_type == PMCSTAT_IMAGE_UNKNOWN) + pmcstat_image_get_aout_params(image, a); + /* + * Otherwise, remember that we tried to determine + * the object's type and had failed. + */ + if (image->pi_type == PMCSTAT_IMAGE_UNKNOWN) + image->pi_type = PMCSTAT_IMAGE_INDETERMINABLE; } /* * Locate an image descriptor given an interned path, adding a fresh * descriptor to the cache if necessary. This function also finds a * suitable name for this image's sample file. + * + * We defer filling in the file format specific parts of the image + * structure till the time we actually see a sample that would fall + * into this image. */ static struct pmcstat_image * -pmcstat_image_from_path(const char *internedpath) +pmcstat_image_from_path(pmcstat_interned_string internedpath, + int iskernelmodule) { int count, hash, nlen; struct pmcstat_image *pi; char *sn; char name[NAME_MAX]; - hash = pmcstat_string_compute_hash(internedpath); + hash = pmcstat_string_lookup_hash(internedpath); - /* Look for an existing entry. */ + /* First, look for an existing entry. */ LIST_FOREACH(pi, &pmcstat_image_hash[hash], pi_next) - if (pi->pi_internedpath == internedpath) { + if (pi->pi_execpath == internedpath && + pi->pi_iskernelmodule == iskernelmodule) { /* move descriptor to the head of the lru list */ TAILQ_REMOVE(&pmcstat_image_lru, pi, pi_lru); TAILQ_INSERT_HEAD(&pmcstat_image_lru, pi, pi_lru); - return pi; + return (pi); } /* @@ -468,13 +794,14 @@ pmcstat_image_from_path(const char *internedpath) */ pi = malloc(sizeof(*pi)); if (pi == NULL) - return NULL; + return (NULL); pi->pi_type = PMCSTAT_IMAGE_UNKNOWN; - pi->pi_internedpath = internedpath; + pi->pi_execpath = internedpath; pi->pi_start = ~0; pi->pi_entry = ~0; pi->pi_end = 0; + pi->pi_iskernelmodule = iskernelmodule; /* * Look for a suitable name for the sample files associated @@ -483,23 +810,31 @@ pmcstat_image_from_path(const char *internedpath) * `basename(path)`+ "~" + NNN + ".gmon" till we get a free * entry. */ - if ((sn = basename(internedpath)) == NULL) - err(EX_OSERR, "ERROR: Cannot process \"%s\"", internedpath); + if ((sn = basename(pmcstat_string_unintern(internedpath))) == NULL) + err(EX_OSERR, "ERROR: Cannot process \"%s\"", + pmcstat_string_unintern(internedpath)); nlen = strlen(sn); - nlen = min(nlen, (int) sizeof(name) - 6); /* ".gmon\0" */ + nlen = min(nlen, (int) (sizeof(name) - sizeof(".gmon"))); snprintf(name, sizeof(name), "%.*s.gmon", nlen, sn); + /* try use the unabridged name first */ if (pmcstat_string_lookup(name) == NULL) pi->pi_samplename = pmcstat_string_intern(name); else { + /* + * Otherwise use a prefix from the original name and + * upto 3 digits. + */ nlen = strlen(sn); - nlen = min(nlen, (int) sizeof(name)-10); /* "~ddd.gmon\0" */ + nlen = min(nlen, (int) (sizeof(name)-sizeof("~NNN.gmon"))); count = 0; do { - count++; - snprintf(name, sizeof(name), "%.*s~%3.3d", + if (++count > 999) + errx(EX_CANTCREAT, "ERROR: cannot create a gmon " + "file for \"%s\"", name); + snprintf(name, sizeof(name), "%.*s~%3.3d.gmon", nlen, sn, count); if (pmcstat_string_lookup(name) == NULL) { pi->pi_samplename = pmcstat_string_intern(name); @@ -508,51 +843,13 @@ pmcstat_image_from_path(const char *internedpath) } while (count > 0); } + LIST_INIT(&pi->pi_gmlist); LIST_INSERT_HEAD(&pmcstat_image_hash[hash], pi, pi_next); TAILQ_INSERT_HEAD(&pmcstat_image_lru, pi, pi_lru); - return pi; -} - -/* - * Given an open file, determine its file type. - */ - -static enum pmcstat_image_type -pmcstat_image_get_type(const char *path) -{ - int fd; - Elf_Ehdr eh; - struct exec ex; - ssize_t nbytes; - char buffer[DEFAULT_BUFFER_SIZE]; - - if ((fd = open(path, O_RDONLY)) < 0) - err(EX_OSERR, "ERROR: Cannot open \"%s\"", path); - - nbytes = max(sizeof(eh), sizeof(ex)); - if ((nbytes = pread(fd, buffer, nbytes, 0)) < 0) - err(EX_OSERR, "ERROR: Cannot read \"%s\"", path); - - (void) close(fd); - - /* check if its an ELF file */ - if ((unsigned) nbytes >= sizeof(Elf_Ehdr)) { - bcopy(buffer, &eh, sizeof(eh)); - if (IS_ELF(eh)) - return PMCSTAT_IMAGE_ELF; - } - - /* Look for an A.OUT header */ - if ((unsigned) nbytes >= sizeof(struct exec)) { - bcopy(buffer, &ex, sizeof(ex)); - if (!N_BADMAG(ex)) - return PMCSTAT_IMAGE_AOUT; - } - - return PMCSTAT_IMAGE_UNKNOWN; + return (pi); } /* @@ -571,13 +868,27 @@ pmcstat_image_increment_bucket(struct pmcstat_pcmap *map, uintfptr_t pc, assert(pc >= map->ppm_lowpc && pc < map->ppm_highpc); + image = map->ppm_image; + /* - * Find the gmon file corresponding to 'pmcid', creating it if - * needed. + * If this is the first time we are seeing a sample for + * this executable image, try determine its parameters. */ + if (image->pi_type == PMCSTAT_IMAGE_UNKNOWN) + pmcstat_image_determine_type(image, a); - image = map->ppm_image; + assert(image->pi_type != PMCSTAT_IMAGE_UNKNOWN); + + /* Ignore samples in images that we know nothing about. */ + if (image->pi_type == PMCSTAT_IMAGE_INDETERMINABLE) { + pmcstat_stats.ps_samples_indeterminable++; + return; + } + /* + * Find the gmon file corresponding to 'pmcid', creating it if + * needed. + */ LIST_FOREACH(pgf, &image->pi_gmlist, pgf_next) if (pgf->pgf_pmcid == pmcid) break; @@ -609,6 +920,12 @@ pmcstat_image_increment_bucket(struct pmcstat_pcmap *map, uintfptr_t pc, if (pgf->pgf_gmondata == NULL) pmcstat_gmon_map_file(pgf); + assert(pgf->pgf_gmondata != NULL); + + /* + * + */ + bucket = (pc - map->ppm_lowpc) / FUNCTION_ALIGNMENT; assert(bucket < pgf->pgf_nbuckets); @@ -617,31 +934,45 @@ pmcstat_image_increment_bucket(struct pmcstat_pcmap *map, uintfptr_t pc, sizeof(struct gmonhdr)); /* saturating add */ - if (hc[bucket] < 0xFFFF) + if (hc[bucket] < 0xFFFFU) /* XXX tie this to sizeof(HISTCOUNTER) */ hc[bucket]++; - + else /* mark that an overflow occurred */ + pgf->pgf_overflow = 1; } /* - * Record the fact that PC values from 'lowpc' to 'highpc' come from + * Record the fact that PC values from 'start' to 'end' come from * image 'image'. */ static void pmcstat_image_link(struct pmcstat_process *pp, struct pmcstat_image *image, - uintfptr_t lowpc, uintfptr_t highpc) + uintfptr_t start) { struct pmcstat_pcmap *pcm, *pcmnew; + uintfptr_t offset; + + assert(image->pi_type != PMCSTAT_IMAGE_UNKNOWN && + image->pi_type != PMCSTAT_IMAGE_INDETERMINABLE); if ((pcmnew = malloc(sizeof(*pcmnew))) == NULL) - err(EX_OSERR, "ERROR: "); + err(EX_OSERR, "ERROR: Cannot create a map entry"); - pcmnew->ppm_lowpc = lowpc; - pcmnew->ppm_highpc = highpc; + /* + * Adjust the map entry to only cover the text portion + * of the object. + */ + + offset = start - image->pi_vaddr; + pcmnew->ppm_lowpc = image->pi_start + offset; + pcmnew->ppm_highpc = image->pi_end + offset; pcmnew->ppm_image = image; + assert(pcmnew->ppm_lowpc < pcmnew->ppm_highpc); + + /* Overlapped mmap()'s are assumed to never occur. */ TAILQ_FOREACH(pcm, &pp->pp_map, ppm_next) - if (pcm->ppm_lowpc < lowpc) + if (pcm->ppm_lowpc >= pcmnew->ppm_highpc) break; if (pcm == NULL) @@ -651,11 +982,79 @@ pmcstat_image_link(struct pmcstat_process *pp, struct pmcstat_image *image, } /* + * Unmap images in the range [start..end) associated with process + * 'pp'. + */ + +static void +pmcstat_image_unmap(struct pmcstat_process *pp, uintfptr_t start, + uintfptr_t end) +{ + struct pmcstat_pcmap *pcm, *pcmtmp, *pcmnew; + + assert(pp != NULL); + assert(start < end); + + /* + * Cases: + * - we could have the range completely in the middle of an + * existing pcmap; in this case we have to split the pcmap + * structure into two (i.e., generate a 'hole'). + * - we could have the range covering multiple pcmaps; these + * will have to be removed. + * - we could have either 'start' or 'end' falling in the + * middle of a pcmap; in this case shorten the entry. + */ + + TAILQ_FOREACH_SAFE(pcm, &pp->pp_map, ppm_next, pcmtmp) { + assert(pcm->ppm_lowpc < pcm->ppm_highpc); + if (pcm->ppm_highpc <= start) + continue; + if (pcm->ppm_lowpc > end) + return; + if (pcm->ppm_lowpc >= start && pcm->ppm_highpc <= end) { + /* + * The current pcmap is completely inside the + * unmapped range: remove it entirely. + */ + TAILQ_REMOVE(&pp->pp_map, pcm, ppm_next); + free(pcm); + } else if (pcm->ppm_lowpc < start && pcm->ppm_highpc > end) { + /* + * Split this pcmap into two; curtail the + * current map to end at [start-1], and start + * the new one at [end]. + */ + if ((pcmnew = malloc(sizeof(*pcmnew))) == NULL) + err(EX_OSERR, "ERROR: Cannot split a map " + "entry"); + + pcmnew->ppm_image = pcm->ppm_image; + + pcmnew->ppm_lowpc = end; + pcmnew->ppm_highpc = pcm->ppm_highpc; + + pcm->ppm_highpc = start; + + TAILQ_INSERT_AFTER(&pp->pp_map, pcm, pcmnew, ppm_next); + + return; + } else if (pcm->ppm_lowpc < start) + pcm->ppm_lowpc = start; + else if (pcm->ppm_highpc > end) + pcm->ppm_highpc = end; + else + assert(0); + } +} + +/* * Add a {pmcid,name} mapping. */ static void -pmcstat_pmcid_add(pmc_id_t pmcid, const char *name, struct pmcstat_args *a) +pmcstat_pmcid_add(pmc_id_t pmcid, pmcstat_interned_string ps, + struct pmcstat_args *a) { struct pmcstat_pmcrecord *pr; struct stat st; @@ -663,7 +1062,7 @@ pmcstat_pmcid_add(pmc_id_t pmcid, const char *name, struct pmcstat_args *a) LIST_FOREACH(pr, &pmcstat_pmcs, pr_next) if (pr->pr_pmcid == pmcid) { - pr->pr_pmcname = name; + pr->pr_pmcname = ps; return; } @@ -671,11 +1070,11 @@ pmcstat_pmcid_add(pmc_id_t pmcid, const char *name, struct pmcstat_args *a) err(EX_OSERR, "ERROR: Cannot allocate pmc record"); pr->pr_pmcid = pmcid; - pr->pr_pmcname = name; + pr->pr_pmcname = ps; LIST_INSERT_HEAD(&pmcstat_pmcs, pr, pr_next); (void) snprintf(fullpath, sizeof(fullpath), "%s/%s", a->pa_samplesdir, - name); + pmcstat_string_unintern(ps)); /* If the path name exists, it should be a directory */ if (stat(fullpath, &st) == 0 && S_ISDIR(st.st_mode)) @@ -687,7 +1086,7 @@ pmcstat_pmcid_add(pmc_id_t pmcid, const char *name, struct pmcstat_args *a) } /* - * Given a pmcid in use, find its human-readable name, or a + * Given a pmcid in use, find its human-readable name. */ static const char * @@ -698,7 +1097,7 @@ pmcstat_pmcid_to_name(pmc_id_t pmcid) LIST_FOREACH(pr, &pmcstat_pmcs, pr_next) if (pr->pr_pmcid == pmcid) - return pr->pr_pmcname; + return (pmcstat_string_unintern(pr->pr_pmcname)); /* create a default name and add this entry */ if ((pr = malloc(sizeof(*pr))) == NULL) @@ -710,35 +1109,42 @@ pmcstat_pmcid_to_name(pmc_id_t pmcid) LIST_INSERT_HEAD(&pmcstat_pmcs, pr, pr_next); - return pr->pr_pmcname; + return (pmcstat_string_unintern(pr->pr_pmcname)); } /* - * Associate an ELF image with a process. Argument 'path' names the - * executable while 'fd' is an already open descriptor to it. + * Associate an AOUT image with a process. */ static void -pmcstat_process_add_elf_image(struct pmcstat_process *pp, const char *path, - uintfptr_t entryaddr) +pmcstat_process_aout_exec(struct pmcstat_process *pp, + struct pmcstat_image *image, uintfptr_t entryaddr, + struct pmcstat_args *a) { - size_t linelen; - FILE *rf; - char *line; - uintmax_t libstart; - struct pmcstat_image *image, *rtldimage; - char libname[PATH_MAX], libpath[PATH_MAX]; - char command[PATH_MAX + sizeof(PMCSTAT_LDD_COMMAND) + 1]; + (void) pp; + (void) image; + (void) entryaddr; + (void) a; + /* TODO Implement a.out handling */ +} - /* Look up path in the cache. */ - if ((image = pmcstat_image_from_path(path)) == NULL) - return; +/* + * Associate an ELF image with a process. + */ - if (image->pi_type == PMCSTAT_IMAGE_UNKNOWN) - pmcstat_image_get_elf_params(image); +static void +pmcstat_process_elf_exec(struct pmcstat_process *pp, + struct pmcstat_image *image, uintfptr_t entryaddr, + struct pmcstat_args *a) +{ + uintmax_t libstart; + struct pmcstat_image *rtldimage; + + assert(image->pi_type == PMCSTAT_IMAGE_ELF32 || + image->pi_type == PMCSTAT_IMAGE_ELF64); /* Create a map entry for the base executable. */ - pmcstat_image_link(pp, image, image->pi_start, image->pi_end); + pmcstat_image_link(pp, image, image->pi_vaddr); /* * For dynamically linked executables we need to: @@ -747,6 +1153,7 @@ pmcstat_process_add_elf_image(struct pmcstat_process *pp, const char *path, * (b) find all the executable objects that the dynamic linker * brought in. */ + if (image->pi_isdynamic) { /* @@ -756,6 +1163,7 @@ pmcstat_process_add_elf_image(struct pmcstat_process *pp, const char *path, * [ TEXT DATA BSS HEAP -->*RTLD SHLIBS <--STACK] * ^ ^ * 0 VM_MAXUSER_ADDRESS + * * The exact address where the loader gets mapped in * will vary according to the size of the executable @@ -766,59 +1174,27 @@ pmcstat_process_add_elf_image(struct pmcstat_process *pp, const char *path, * this we can figure out the address where the * runtime loader's file object had been mapped to. */ - rtldimage = pmcstat_image_from_path(image->pi_dynlinkerpath); - if (rtldimage == NULL) - err(EX_OSERR, "ERROR: Cannot find image for " - "\"%s\"", image->pi_dynlinkerpath); - if (rtldimage->pi_type == PMCSTAT_IMAGE_UNKNOWN) - pmcstat_image_get_elf_params(rtldimage); - - libstart = entryaddr - rtldimage->pi_entry; - pmcstat_image_link(pp, rtldimage, libstart, - libstart + rtldimage->pi_end - rtldimage->pi_start); - - /* Process all other objects loaded by this executable. */ - (void) snprintf(command, sizeof(command), "%s %s", - PMCSTAT_LDD_COMMAND, path); - - if ((rf = popen(command, "r")) == NULL) - err(EX_OSERR, "ERROR: Cannot create pipe"); - - (void) fgetln(rf, &linelen); - - while (!feof(rf) && !ferror(rf)) { - - if ((line = fgetln(rf, &linelen)) == NULL) - continue; - line[linelen-1] = '\0'; - - libstart = 0; - libpath[0] = libname[0] = '\0'; - if (sscanf(line, "%s \"%[^\"]\" %jx", - libname, libpath, &libstart) != 3) - continue; - - if (libstart == 0) { - warnx("WARNING: object \"%s\" was not found " - "for program \"%s\".", libname, path); - continue; - } - - image = pmcstat_image_from_path( - pmcstat_string_intern(libpath)); - if (image == NULL) - err(EX_OSERR, "ERROR: Cannot process " - "\"%s\"", libpath); + rtldimage = pmcstat_image_from_path(image->pi_dynlinkerpath, + 0); + if (rtldimage == NULL) { + warnx("WARNING: Cannot find image for \"%s\".", + pmcstat_string_unintern(image->pi_dynlinkerpath)); + pmcstat_stats.ps_exec_errors++; + return; + } - if (image->pi_type == PMCSTAT_IMAGE_UNKNOWN) - pmcstat_image_get_elf_params(image); + if (rtldimage->pi_type == PMCSTAT_IMAGE_UNKNOWN) + pmcstat_image_get_elf_params(rtldimage, a); - pmcstat_image_link(pp, image, libstart + image->pi_start, - libstart + image->pi_end); + if (rtldimage->pi_type != PMCSTAT_IMAGE_ELF32 && + rtldimage->pi_type != PMCSTAT_IMAGE_ELF64) { + warnx("WARNING: rtld not an ELF object \"%s\".", + pmcstat_string_unintern(image->pi_dynlinkerpath)); + return; } - (void) pclose(rf); - + libstart = entryaddr - rtldimage->pi_entry; + pmcstat_image_link(pp, rtldimage, libstart); } } @@ -843,7 +1219,7 @@ pmcstat_process_lookup(pid_t pid, int allocate) LIST_FOREACH_SAFE(pp, &pmcstat_process_hash[hash], pp_next, pptmp) if (pp->pp_pid == pid) { /* Found a descriptor, check and process zombies */ - if (allocate && !pp->pp_isactive) { + if (allocate && pp->pp_isactive == 0) { /* remove maps */ TAILQ_FOREACH_SAFE(ppm, &pp->pp_map, ppm_next, ppmtmp) { @@ -855,11 +1231,11 @@ pmcstat_process_lookup(pid_t pid, int allocate) free(pp); break; } - return pp; + return (pp); } if (!allocate) - return NULL; + return (NULL); if ((pp = malloc(sizeof(*pp))) == NULL) err(EX_OSERR, "ERROR: Cannot allocate pid descriptor"); @@ -870,7 +1246,7 @@ pmcstat_process_lookup(pid_t pid, int allocate) TAILQ_INIT(&pp->pp_map); LIST_INSERT_HEAD(&pmcstat_process_hash[hash], pp, pp_next); - return pp; + return (pp); } /* @@ -878,31 +1254,41 @@ pmcstat_process_lookup(pid_t pid, int allocate) */ static void -pmcstat_process_exec(struct pmcstat_process *pp, const char *path, - uintfptr_t entryaddr) +pmcstat_process_exec(struct pmcstat_process *pp, + pmcstat_interned_string path, uintfptr_t entryaddr, + struct pmcstat_args *a) { - enum pmcstat_image_type filetype; struct pmcstat_image *image; - if ((image = pmcstat_image_from_path(path)) == NULL) + if ((image = pmcstat_image_from_path(path, 0)) == NULL) { + pmcstat_stats.ps_exec_errors++; return; + } if (image->pi_type == PMCSTAT_IMAGE_UNKNOWN) - filetype = pmcstat_image_get_type(path); - else - filetype = image->pi_type; + pmcstat_image_determine_type(image, a); - switch (filetype) { - case PMCSTAT_IMAGE_ELF: - pmcstat_process_add_elf_image(pp, path, entryaddr); + assert(image->pi_type != PMCSTAT_IMAGE_UNKNOWN); + + switch (image->pi_type) { + case PMCSTAT_IMAGE_ELF32: + case PMCSTAT_IMAGE_ELF64: + pmcstat_stats.ps_exec_elf++; + pmcstat_process_elf_exec(pp, image, entryaddr, a); break; case PMCSTAT_IMAGE_AOUT: + pmcstat_stats.ps_exec_aout++; + pmcstat_process_aout_exec(pp, image, entryaddr, a); + break; + + case PMCSTAT_IMAGE_INDETERMINABLE: + pmcstat_stats.ps_exec_indeterminable++; break; default: err(EX_SOFTWARE, "ERROR: Unsupported executable type for " - "\"%s\"", path); + "\"%s\"", pmcstat_string_unintern(path)); } } @@ -916,108 +1302,85 @@ pmcstat_process_find_map(struct pmcstat_process *p, uintfptr_t pc) { struct pmcstat_pcmap *ppm; - TAILQ_FOREACH(ppm, &p->pp_map, ppm_next) - if (pc >= ppm->ppm_lowpc && pc < ppm->ppm_highpc) - return ppm; + TAILQ_FOREACH(ppm, &p->pp_map, ppm_next) { + if (pc >= ppm->ppm_lowpc && pc < ppm->ppm_highpc) + return (ppm); + if (pc < ppm->ppm_lowpc) + return (NULL); + } - return NULL; + return (NULL); } -/* - * Compute a 'hash' value for a string. - */ static int -pmcstat_string_compute_hash(const char *s) -{ - int hash; - - for (hash = 0; *s; s++) - hash ^= *s; - - return hash & PMCSTAT_HASH_MASK; -} - -/* - * Intern a copy of string 's', and return a pointer to it. - */ - -static const char * -pmcstat_string_intern(const char *s) -{ - struct pmcstat_string *ps; - int hash, len; - - hash = pmcstat_string_compute_hash(s); - len = strlen(s); - - if ((ps = pmcstat_string_lookup(s)) != NULL) - return ps->ps_string; - - if ((ps = malloc(sizeof(*ps))) == NULL) - err(EX_OSERR, "ERROR: Could not intern string"); - ps->ps_len = len; - ps->ps_hash = hash; - ps->ps_string = strdup(s); - LIST_INSERT_HEAD(&pmcstat_string_hash[hash], ps, ps_next); - return ps->ps_string; -} - -static struct pmcstat_string * -pmcstat_string_lookup(const char *s) -{ - struct pmcstat_string *ps; - int hash, len; - - hash = pmcstat_string_compute_hash(s); - len = strlen(s); - - LIST_FOREACH(ps, &pmcstat_string_hash[hash], ps_next) - if (ps->ps_len == len && ps->ps_hash == hash && - strcmp(ps->ps_string, s) == 0) - return ps; - return NULL; -} - -/* - * Public Interfaces. - */ - -/* - * Close a logfile, after first flushing all in-module queued data. - */ - -int -pmcstat_close_log(struct pmcstat_args *a) -{ - if (pmc_flush_logfile() < 0 || - pmc_configure_logfile(-1) < 0) - err(EX_OSERR, "ERROR: logging failed"); - a->pa_flags &= ~(FLAG_HAS_OUTPUT_LOGFILE | FLAG_HAS_PIPE); - return a->pa_flags & FLAG_HAS_PIPE ? PMCSTAT_EXITING : - PMCSTAT_FINISHED; -} - - -int pmcstat_convert_log(struct pmcstat_args *a) { uintfptr_t pc; + pid_t pid; + struct pmcstat_image *image; struct pmcstat_process *pp, *ppnew; struct pmcstat_pcmap *ppm, *ppmtmp; struct pmclog_ev ev; - const char *image_path; + pmcstat_interned_string image_path; while (pmclog_read(a->pa_logparser, &ev) == 0) { assert(ev.pl_state == PMCLOG_OK); switch (ev.pl_type) { - case PMCLOG_TYPE_MAPPINGCHANGE: + case PMCLOG_TYPE_INITIALIZE: + if ((ev.pl_u.pl_i.pl_version & 0xFF000000) != + PMC_VERSION_MAJOR << 24 && a->pa_verbosity > 0) + warnx("WARNING: Log version 0x%x does not " + "match compiled version 0x%x.", + ev.pl_u.pl_i.pl_version, + PMC_VERSION_MAJOR); + break; + case PMCLOG_TYPE_MAP_IN: /* * Introduce an address range mapping for a - * process. + * userland process or the kernel (pid == -1). + * + * We always allocate a process descriptor so + * that subsequent samples seen for this + * address range are mapped to the current + * object being mapped in. */ + pid = ev.pl_u.pl_mi.pl_pid; + if (pid == -1) + pp = pmcstat_kernproc; + else + pp = pmcstat_process_lookup(pid, + PMCSTAT_ALLOCATE); + + assert(pp != NULL); + + image_path = pmcstat_string_intern(ev.pl_u.pl_mi. + pl_pathname); + image = pmcstat_image_from_path(image_path, pid == -1); + if (image->pi_type == PMCSTAT_IMAGE_UNKNOWN) + pmcstat_image_determine_type(image, a); + if (image->pi_type != PMCSTAT_IMAGE_INDETERMINABLE) + pmcstat_image_link(pp, image, + ev.pl_u.pl_mi.pl_start); + break; + + case PMCLOG_TYPE_MAP_OUT: + /* + * Remove an address map. + */ + pid = ev.pl_u.pl_mo.pl_pid; + if (pid == -1) + pp = pmcstat_kernproc; + else + pp = pmcstat_process_lookup(pid, 0); + + if (pp == NULL) /* unknown process */ + break; + + pmcstat_image_unmap(pp, ev.pl_u.pl_mo.pl_start, + ev.pl_u.pl_mo.pl_end); break; case PMCLOG_TYPE_PCSAMPLE: @@ -1028,12 +1391,17 @@ pmcstat_convert_log(struct pmcstat_args *a) * pair and increment the appropriate entry * bin inside this. */ + pmcstat_stats.ps_samples_total++; + pc = ev.pl_u.pl_s.pl_pc; - pp = pmcstat_process_lookup(ev.pl_u.pl_s.pl_pid, 1); + pp = pmcstat_process_lookup(ev.pl_u.pl_s.pl_pid, + PMCSTAT_ALLOCATE); if ((ppm = pmcstat_process_find_map(pp, pc)) == NULL && (ppm = pmcstat_process_find_map(pmcstat_kernproc, - pc)) == NULL) - break; /* unknown process,offset pair */ + pc)) == NULL) { /* unknown process,offset pair */ + pmcstat_stats.ps_samples_unknown_offset++; + break; + } pmcstat_image_increment_bucket(ppm, pc, ev.pl_u.pl_s.pl_pmcid, a); @@ -1055,7 +1423,8 @@ pmcstat_convert_log(struct pmcstat_args *a) * Change the executable image associated with * a process. */ - pp = pmcstat_process_lookup(ev.pl_u.pl_x.pl_pid, 1); + pp = pmcstat_process_lookup(ev.pl_u.pl_x.pl_pid, + PMCSTAT_ALLOCATE); /* delete the current process map */ TAILQ_FOREACH_SAFE(ppm, &pp->pp_map, ppm_next, ppmtmp) { @@ -1063,13 +1432,12 @@ pmcstat_convert_log(struct pmcstat_args *a) free(ppm); } - /* locate the descriptor for the new 'base' image */ + /* associate this process image */ image_path = pmcstat_string_intern( ev.pl_u.pl_x.pl_pathname); - - /* link to the new image */ + assert(image_path != NULL); pmcstat_process_exec(pp, image_path, - ev.pl_u.pl_x.pl_entryaddr); + ev.pl_u.pl_x.pl_entryaddr, a); break; case PMCLOG_TYPE_PROCEXIT: @@ -1086,7 +1454,7 @@ pmcstat_convert_log(struct pmcstat_args *a) pp = pmcstat_process_lookup(ev.pl_u.pl_e.pl_pid, 0); if (pp == NULL) break; - pp->pp_isactive = 0; /* make a zombie */ + pp->pp_isactive = 0; /* mark as a zombie */ break; case PMCLOG_TYPE_SYSEXIT: @@ -1099,20 +1467,23 @@ pmcstat_convert_log(struct pmcstat_args *a) case PMCLOG_TYPE_PROCFORK: /* - * If we had been tracking 'oldpid', then clone - * its pid descriptor. + * Allocate a process descriptor for the new + * (child) process. + */ + ppnew = + pmcstat_process_lookup(ev.pl_u.pl_f.pl_newpid, + PMCSTAT_ALLOCATE); + + /* + * If we had been tracking the parent, clone + * its address maps. */ pp = pmcstat_process_lookup(ev.pl_u.pl_f.pl_oldpid, 0); if (pp == NULL) break; - - ppnew = - pmcstat_process_lookup(ev.pl_u.pl_f.pl_newpid, 1); - - /* copy the old process' address maps */ TAILQ_FOREACH(ppm, &pp->pp_map, ppm_next) pmcstat_image_link(ppnew, ppm->ppm_image, - ppm->ppm_lowpc, ppm->ppm_highpc); + ppm->ppm_lowpc); break; default: /* other types of entries are not relevant */ @@ -1121,47 +1492,19 @@ pmcstat_convert_log(struct pmcstat_args *a) } if (ev.pl_state == PMCLOG_EOF) - return PMCSTAT_FINISHED; + return (PMCSTAT_FINISHED); else if (ev.pl_state == PMCLOG_REQUIRE_DATA) - return PMCSTAT_RUNNING; + return (PMCSTAT_RUNNING); err(EX_DATAERR, "ERROR: event parsing failed (record %jd, " "offset 0x%jx)", (uintmax_t) ev.pl_count + 1, ev.pl_offset); } - -/* - * Open a log file, for reading or writing. - * - * The function returns the fd of a successfully opened log or -1 in - * case of failure. - */ - -int -pmcstat_open(const char *path, int mode) -{ - int fd; - - /* - * If 'path' is "-" then open one of stdin or stdout depending - * on the value of 'mode'. Otherwise, treat 'path' as a file - * name and open that. - */ - if (path[0] == '-' && path[1] == '\0') - fd = (mode == PMCSTAT_OPEN_FOR_READ) ? 0 : 1; - else - fd = open(path, mode == PMCSTAT_OPEN_FOR_READ ? - O_RDONLY : (O_WRONLY|O_CREAT|O_TRUNC), - S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH); - - return fd; -} - /* * Print log entries as text. */ -int +static int pmcstat_print_log(struct pmcstat_args *a) { struct pmclog_ev ev; @@ -1180,14 +1523,17 @@ pmcstat_print_log(struct pmcstat_args *a) ev.pl_u.pl_i.pl_version, pmc_name_of_cputype(ev.pl_u.pl_i.pl_arch)); break; - case PMCLOG_TYPE_MAPPINGCHANGE: - PMCSTAT_PRINT_ENTRY(a,"mapping","%s %d %p %p \"%s\"", - ev.pl_u.pl_m.pl_type == PMCLOG_MAPPING_INSERT ? - "insert" : "delete", - ev.pl_u.pl_m.pl_pid, - (void *) ev.pl_u.pl_m.pl_start, - (void *) ev.pl_u.pl_m.pl_end, - ev.pl_u.pl_m.pl_pathname); + case PMCLOG_TYPE_MAP_IN: + PMCSTAT_PRINT_ENTRY(a,"map-in","%d %p \"%s\"", + ev.pl_u.pl_mi.pl_pid, + (void *) ev.pl_u.pl_mi.pl_start, + ev.pl_u.pl_mi.pl_pathname); + break; + case PMCLOG_TYPE_MAP_OUT: + PMCSTAT_PRINT_ENTRY(a,"map-out","%d %p %p", + ev.pl_u.pl_mo.pl_pid, + (void *) ev.pl_u.pl_mo.pl_start, + (void *) ev.pl_u.pl_mo.pl_end); break; case PMCLOG_TYPE_PCSAMPLE: PMCSTAT_PRINT_ENTRY(a,"sample","0x%x %d %p %c", @@ -1252,9 +1598,9 @@ pmcstat_print_log(struct pmcstat_args *a) } if (ev.pl_state == PMCLOG_EOF) - return PMCSTAT_FINISHED; + return (PMCSTAT_FINISHED); else if (ev.pl_state == PMCLOG_REQUIRE_DATA) - return PMCSTAT_RUNNING; + return (PMCSTAT_RUNNING); err(EX_DATAERR, "ERROR: event parsing failed " "(record %jd, offset 0x%jx)", @@ -1263,6 +1609,54 @@ pmcstat_print_log(struct pmcstat_args *a) } /* + * Public Interfaces. + */ + +/* + * Close a logfile, after first flushing all in-module queued data. + */ + +int +pmcstat_close_log(struct pmcstat_args *a) +{ + if (pmc_flush_logfile() < 0 || + pmc_configure_logfile(-1) < 0) + err(EX_OSERR, "ERROR: logging failed"); + a->pa_flags &= ~(FLAG_HAS_OUTPUT_LOGFILE | FLAG_HAS_PIPE); + return (a->pa_flags & FLAG_HAS_PIPE ? PMCSTAT_EXITING : + PMCSTAT_FINISHED); +} + + + +/* + * Open a log file, for reading or writing. + * + * The function returns the fd of a successfully opened log or -1 in + * case of failure. + */ + +int +pmcstat_open_log(const char *path, int mode) +{ + int fd; + + /* + * If 'path' is "-" then open one of stdin or stdout depending + * on the value of 'mode'. Otherwise, treat 'path' as a file + * name and open that. + */ + if (path[0] == '-' && path[1] == '\0') + fd = (mode == PMCSTAT_OPEN_FOR_READ) ? 0 : 1; + else + fd = open(path, mode == PMCSTAT_OPEN_FOR_READ ? + O_RDONLY : (O_WRONLY|O_CREAT|O_TRUNC), + S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH); + + return (fd); +} + +/* * Process a log file in offline analysis mode. */ @@ -1275,66 +1669,88 @@ pmcstat_process_log(struct pmcstat_args *a) * log to the current output file. */ if (a->pa_flags & FLAG_DO_PRINT) - return pmcstat_print_log(a); + return (pmcstat_print_log(a)); else /* convert the log to gprof compatible profiles */ - return pmcstat_convert_log(a); + return (pmcstat_convert_log(a)); } +/* + * Initialize module. + */ + void pmcstat_initialize_logging(struct pmcstat_args *a) { int i; - const char *kernpath; - struct pmcstat_image *img; + + (void) a; /* use a convenient format for 'ldd' output */ if (setenv("LD_TRACE_LOADED_OBJECTS_FMT1","%o \"%p\" %x\n",1) != 0) - goto error; + err(EX_OSERR, "ERROR: Cannot setenv"); /* Initialize hash tables */ + pmcstat_string_initialize(); for (i = 0; i < PMCSTAT_NHASH; i++) { LIST_INIT(&pmcstat_image_hash[i]); LIST_INIT(&pmcstat_process_hash[i]); - LIST_INIT(&pmcstat_string_hash[i]); } - /* create a fake 'process' entry for the kernel with pid == -1 */ - if ((pmcstat_kernproc = pmcstat_process_lookup((pid_t) -1, 1)) == NULL) - goto error; - - if ((kernpath = pmcstat_string_intern(a->pa_kernel)) == NULL) - goto error; - - img = pmcstat_image_from_path(kernpath); - - pmcstat_image_get_elf_params(img); - pmcstat_image_link(pmcstat_kernproc, img, img->pi_start, img->pi_end); - - return; - - error: - err(EX_OSERR, "ERROR: Cannot initialize logging"); + /* + * Create a fake 'process' entry for the kernel with pid -1. + * hwpmc(4) will subsequently inform us about where the kernel + * and any loaded kernel modules are mapped. + */ + if ((pmcstat_kernproc = pmcstat_process_lookup((pid_t) -1, + PMCSTAT_ALLOCATE)) == NULL) + err(EX_OSERR, "ERROR: Cannot initialize logging"); } +/* + * Shutdown module. + */ + void -pmcstat_shutdown_logging(void) +pmcstat_shutdown_logging(struct pmcstat_args *a) { int i; + FILE *mf; struct pmcstat_gmonfile *pgf, *pgftmp; struct pmcstat_image *pi, *pitmp; struct pmcstat_process *pp, *pptmp; - struct pmcstat_string *ps, *pstmp; + + /* determine where to send the map file */ + mf = NULL; + if (a->pa_mapfilename != NULL) + mf = (strcmp(a->pa_mapfilename, "-") == 0) ? + a->pa_printfile : fopen(a->pa_mapfilename, "w"); + + if (mf == NULL && a->pa_flags & FLAG_DO_GPROF && + a->pa_verbosity >= 2) + mf = a->pa_printfile; + + if (mf) + (void) fprintf(mf, "MAP:\n"); for (i = 0; i < PMCSTAT_NHASH; i++) { LIST_FOREACH_SAFE(pi, &pmcstat_image_hash[i], pi_next, pitmp) { /* flush gmon.out data to disk */ LIST_FOREACH_SAFE(pgf, &pi->pi_gmlist, pgf_next, pgftmp) { - pmcstat_gmon_unmap_file(pgf); - LIST_REMOVE(pgf, pgf_next); - free(pgf); + pmcstat_gmon_unmap_file(pgf); + LIST_REMOVE(pgf, pgf_next); + + if (pgf->pgf_overflow && a->pa_verbosity >= 1) + warnx("WARNING: profile \"%s\" " + "overflowed.", + pmcstat_string_unintern(pgf->pgf_name)); + free(pgf); } + if (mf) + (void) fprintf(mf, " \"%s\" -> \"%s\"\n", + pmcstat_string_unintern(pi->pi_execpath), + pmcstat_string_unintern(pi->pi_samplename)); LIST_REMOVE(pi, pi_next); free(pi); @@ -1344,10 +1760,31 @@ pmcstat_shutdown_logging(void) LIST_REMOVE(pp, pp_next); free(pp); } - LIST_FOREACH_SAFE(ps, &pmcstat_string_hash[i], ps_next, - pstmp) { - LIST_REMOVE(ps, ps_next); - free(ps); - } } + + pmcstat_string_shutdown(); + + /* + * Print errors unless -q was specified. Print all statistics + * if verbosity > 1. + */ +#define PRINT(N,V,A) do { \ + if (pmcstat_stats.ps_##V || (A)->pa_verbosity >= 2) \ + (void) fprintf((A)->pa_printfile, " %-40s %d\n",\ + N, pmcstat_stats.ps_##V); \ + } while (0) + + if (a->pa_verbosity >= 1 && a->pa_flags & FLAG_DO_GPROF) { + (void) fprintf(a->pa_printfile, "CONVERSION STATISTICS:\n"); + PRINT("#exec/a.out", exec_aout, a); + PRINT("#exec/elf", exec_elf, a); + PRINT("#exec/unknown", exec_indeterminable, a); + PRINT("#exec handling errors", exec_errors, a); + PRINT("#samples/total", samples_total, a); + PRINT("#samples/unclaimed", samples_unknown_offset, a); + PRINT("#samples/unknown-object", samples_indeterminable, a); + } + + if (mf) + (void) fclose(mf); } |
