sys/sys/pmclog.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2005-2007, Joseph Koshy
   5  * Copyright (c) 2007 The FreeBSD Foundation
   6  * All rights reserved.
   7  *
   8  * Portions of this software were developed by A. Joseph Koshy under
   9  * sponsorship from the FreeBSD Foundation and Google, Inc.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _SYS_PMCLOG_H_
  36 #define _SYS_PMCLOG_H_
  37
  38 #include <sys/pmc.h>
  39
  40 enum pmclog_type {
  41         /* V1 ABI */
  42         PMCLOG_TYPE_CLOSELOG = 1,
  43         PMCLOG_TYPE_DROPNOTIFY = 2,
  44         PMCLOG_TYPE_INITIALIZE = 3,
  45         PMCLOG_TYPE_MAPPINGCHANGE = 4, /* unused in v1 */
  46         PMCLOG_TYPE_PMCALLOCATE = 5,
  47         PMCLOG_TYPE_PMCATTACH = 6,
  48         PMCLOG_TYPE_PMCDETACH = 7,
  49         PMCLOG_TYPE_PROCCSW = 8,
  50         PMCLOG_TYPE_PROCEXEC = 9,
  51         PMCLOG_TYPE_PROCEXIT = 10,
  52         PMCLOG_TYPE_PROCFORK = 11,
  53         PMCLOG_TYPE_SYSEXIT = 12,
  54         PMCLOG_TYPE_USERDATA = 13,
  55         /*
  56          * V2 ABI
  57          *
  58          * The MAP_{IN,OUT} event types obsolete the MAPPING_CHANGE
  59          * event type.  The CALLCHAIN event type obsoletes the
  60          * PCSAMPLE event type.
  61          */
  62         PMCLOG_TYPE_MAP_IN = 14,
  63         PMCLOG_TYPE_MAP_OUT = 15,
  64         PMCLOG_TYPE_CALLCHAIN = 16,
  65         /*
  66          * V3 ABI
  67          *
  68          * New variant of PMCLOG_TYPE_PMCALLOCATE for dynamic event.
  69          */
  70         PMCLOG_TYPE_PMCALLOCATEDYN = 17,
  71         /*
  72          * V6 ABI
  73          */
  74         PMCLOG_TYPE_THR_CREATE = 18,
  75         PMCLOG_TYPE_THR_EXIT = 19,
  76         PMCLOG_TYPE_PROC_CREATE = 20
  77 };
  78
  79 /*
  80  * A log entry descriptor comprises of a 32 bit header and a 64 bit
  81  * time stamp followed by as many 32 bit words are required to record
  82  * the event.
  83  *
  84  * Header field format:
  85  *
  86  *  31           24           16                                   0
  87  *   +------------+------------+-----------------------------------+
  88  *   |    MAGIC   |    TYPE    |               LENGTH              |
  89  *   +------------+------------+-----------------------------------+
  90  *
  91  * MAGIC        is the constant PMCLOG_HEADER_MAGIC.
  92  * TYPE         contains a value of type enum pmclog_type.
  93  * LENGTH       contains the length of the event record, in bytes.
  94  */
  95
  96 #define PMCLOG_ENTRY_HEADER                             \
  97         uint32_t                pl_header;              \
  98         uint32_t                pl_ts_sec;              \
  99         uint32_t                pl_ts_nsec;
 100
 101
 102 /*
 103  * The following structures are used to describe the size of each kind
 104  * of log entry to sizeof().  To keep the compiler from adding
 105  * padding, the fields of each structure are aligned to their natural
 106  * boundaries, and the structures are marked as 'packed'.
 107  *
 108  * The actual reading and writing of the log file is always in terms
 109  * of 4 byte quantities.
 110  */
 111
 112 struct pmclog_callchain {
 113         PMCLOG_ENTRY_HEADER
 114         uint32_t                pl_pid;
 115         uint32_t                pl_tid;
 116         uint32_t                pl_pmcid;
 117         uint32_t                pl_cpuflags;
 118         uint32_t                pl_cpuflags2;
 119         /* 8 byte aligned */
 120         uintptr_t               pl_pc[PMC_CALLCHAIN_DEPTH_MAX];
 121 } __packed;
 122
 123 #define PMC_CALLCHAIN_CPUFLAGS_TO_CPU(CF)       (((CF) >> 16) & 0xFFFF)
 124 #define PMC_CALLCHAIN_CPUFLAGS_TO_USERMODE(CF)  ((CF) & PMC_CC_F_USERSPACE)
 125 #define PMC_CALLCHAIN_TO_CPUFLAGS(CPU,FLAGS)    \
 126         (((CPU) << 16) | ((FLAGS) & 0xFFFF))
 127
 128 struct pmclog_closelog {
 129         PMCLOG_ENTRY_HEADER
 130         uint32_t                pl_pad;
 131 };
 132
 133 struct pmclog_dropnotify {
 134         PMCLOG_ENTRY_HEADER
 135         uint32_t                pl_pad;
 136 };
 137
 138 struct pmclog_initialize {
 139         PMCLOG_ENTRY_HEADER
 140         uint32_t                pl_version;     /* driver version */
 141         uint32_t                pl_cpu;         /* enum pmc_cputype */
 142         uint32_t                pl_pad;
 143         char                    pl_cpuid[PMC_CPUID_LEN];
 144 } __packed;
 145
 146 struct pmclog_map_in {
 147         PMCLOG_ENTRY_HEADER
 148         uint32_t                pl_pid;
 149         uintfptr_t              pl_start;       /* 8 byte aligned */
 150         char                    pl_pathname[PATH_MAX];
 151 } __packed;
 152
 153 struct pmclog_map_out {
 154         PMCLOG_ENTRY_HEADER
 155         uint32_t                pl_pid;
 156         uintfptr_t              pl_start;       /* 8 byte aligned */
 157         uintfptr_t              pl_end;
 158 } __packed;
 159
 160 struct pmclog_pmcallocate {
 161         PMCLOG_ENTRY_HEADER
 162         uint32_t                pl_pmcid;
 163         uint32_t                pl_event;
 164         uint32_t                pl_flags;
 165 } __packed;
 166
 167 struct pmclog_pmcattach {
 168         PMCLOG_ENTRY_HEADER
 169         uint32_t                pl_pmcid;
 170         uint32_t                pl_pid;
 171         uint32_t                pl_pad;
 172         char                    pl_pathname[PATH_MAX];
 173 } __packed;
 174
 175 struct pmclog_pmcdetach {
 176         PMCLOG_ENTRY_HEADER
 177         uint32_t                pl_pmcid;
 178         uint32_t                pl_pid;
 179         uint32_t                pl_pad;
 180 } __packed;
 181
 182 struct pmclog_proccsw {
 183         PMCLOG_ENTRY_HEADER
 184         uint32_t                pl_pmcid;
 185         uint64_t                pl_value;       /* keep 8 byte aligned */
 186         uint32_t                pl_pid;
 187         uint32_t                pl_tid;
 188 } __packed;
 189
 190 struct pmclog_proccreate {
 191         PMCLOG_ENTRY_HEADER
 192         uint32_t                pl_pid;
 193         uint64_t                pl_pcomm[MAXCOMLEN+1];  /* keep 8 byte aligned */
 194 } __packed;
 195
 196 struct pmclog_procexec {
 197         PMCLOG_ENTRY_HEADER
 198         uint32_t                pl_pid;
 199         uint32_t                pl_pmcid;
 200         uint32_t                pl_pad;
 201         uintfptr_t              pl_start;       /* keep 8 byte aligned */
 202         char                    pl_pathname[PATH_MAX];
 203 } __packed;
 204
 205 struct pmclog_procexit {
 206         PMCLOG_ENTRY_HEADER
 207         uint32_t                pl_pmcid;
 208         uint32_t                pl_pid;
 209         uint32_t                pl_pad;
 210         uint64_t                pl_value;       /* keep 8 byte aligned */
 211 } __packed;
 212
 213 struct pmclog_procfork {
 214         PMCLOG_ENTRY_HEADER
 215         uint32_t                pl_oldpid;
 216         uint32_t                pl_newpid;
 217         uint32_t                pl_pad;
 218 } __packed;
 219
 220 struct pmclog_sysexit {
 221         PMCLOG_ENTRY_HEADER
 222         uint32_t                pl_pid;
 223 } __packed;
 224
 225 struct pmclog_threadcreate {
 226         PMCLOG_ENTRY_HEADER
 227         uint32_t                pl_tid;
 228         uint32_t                pl_pid;
 229         uint32_t                pl_pad;
 230         uint64_t                pl_tdname[MAXCOMLEN+1]; /* keep 8 byte aligned */
 231 } __packed;
 232
 233 struct pmclog_threadexit {
 234         PMCLOG_ENTRY_HEADER
 235         uint32_t                pl_tid;
 236 } __packed;
 237
 238 struct pmclog_userdata {
 239         PMCLOG_ENTRY_HEADER
 240         uint32_t                pl_userdata;
 241 } __packed;
 242
 243 struct pmclog_pmcallocatedyn {
 244         PMCLOG_ENTRY_HEADER
 245         uint32_t                pl_pmcid;
 246         uint32_t                pl_event;
 247         uint32_t                pl_flags;
 248         char                    pl_evname[PMC_NAME_MAX];
 249 } __packed;
 250
 251 union pmclog_entry {            /* only used to size scratch areas */
 252         struct pmclog_callchain         pl_cc;
 253         struct pmclog_closelog          pl_cl;
 254         struct pmclog_dropnotify        pl_dn;
 255         struct pmclog_initialize        pl_i;
 256         struct pmclog_map_in            pl_mi;
 257         struct pmclog_map_out           pl_mo;
 258         struct pmclog_pmcallocate       pl_a;
 259         struct pmclog_pmcallocatedyn    pl_ad;
 260         struct pmclog_pmcattach         pl_t;
 261         struct pmclog_pmcdetach         pl_d;
 262         struct pmclog_proccsw           pl_c;
 263         struct pmclog_procexec          pl_x;
 264         struct pmclog_procexit          pl_e;
 265         struct pmclog_procfork          pl_f;
 266         struct pmclog_sysexit           pl_se;
 267         struct pmclog_userdata          pl_u;
 268 };
 269
 270 #define PMCLOG_HEADER_MAGIC                                     0xEEU
 271
 272 #define PMCLOG_HEADER_TO_LENGTH(H)                              \
 273         ((H) & 0x0000FFFF)
 274 #define PMCLOG_HEADER_TO_TYPE(H)                                \
 275         (((H) & 0x00FF0000) >> 16)
 276 #define PMCLOG_HEADER_TO_MAGIC(H)                               \
 277         (((H) & 0xFF000000) >> 24)
 278 #define PMCLOG_HEADER_CHECK_MAGIC(H)                            \
 279         (PMCLOG_HEADER_TO_MAGIC(H) == PMCLOG_HEADER_MAGIC)
 280
 281 #ifdef  _KERNEL
 282
 283 /*
 284  * Prototypes
 285  */
 286 int     pmclog_configure_log(struct pmc_mdep *_md, struct pmc_owner *_po,
 287     int _logfd);
 288 int     pmclog_deconfigure_log(struct pmc_owner *_po);
 289 int     pmclog_flush(struct pmc_owner *_po, int force);
 290 int     pmclog_close(struct pmc_owner *_po);
 291 void    pmclog_initialize(void);
 292 int     pmclog_proc_create(struct thread *td, void **handlep);
 293 void    pmclog_proc_ignite(void *handle, struct pmc_owner *po);
 294 void    pmclog_process_callchain(struct pmc *_pm, struct pmc_sample *_ps);
 295 void    pmclog_process_closelog(struct pmc_owner *po);
 296 void    pmclog_process_dropnotify(struct pmc_owner *po);
 297 void    pmclog_process_map_in(struct pmc_owner *po, pid_t pid,
 298     uintfptr_t start, const char *path);
 299 void    pmclog_process_map_out(struct pmc_owner *po, pid_t pid,
 300     uintfptr_t start, uintfptr_t end);
 301 void    pmclog_process_pmcallocate(struct pmc *_pm);
 302 void    pmclog_process_pmcattach(struct pmc *_pm, pid_t _pid, char *_path);
 303 void    pmclog_process_pmcdetach(struct pmc *_pm, pid_t _pid);
 304 void    pmclog_process_proccsw(struct pmc *_pm, struct pmc_process *_pp,
 305     pmc_value_t _v, struct thread *);
 306 void    pmclog_process_procexec(struct pmc_owner *_po, pmc_id_t _pmid, pid_t _pid,
 307     uintfptr_t _startaddr, char *_path);
 308 void    pmclog_process_procexit(struct pmc *_pm, struct pmc_process *_pp);
 309 void    pmclog_process_procfork(struct pmc_owner *_po, pid_t _oldpid, pid_t _newpid);
 310 void    pmclog_process_sysexit(struct pmc_owner *_po, pid_t _pid);
 311 void    pmclog_process_threadcreate(struct pmc_owner *_po, struct thread *td, int sync);
 312 void    pmclog_process_threadexit(struct pmc_owner *_po, struct thread *td);
 313 void    pmclog_process_proccreate(struct pmc_owner *_po, struct proc *p, int sync);
 314 int     pmclog_process_userlog(struct pmc_owner *_po,
 315     struct pmc_op_writelog *_wl);
 316 void    pmclog_shutdown(void);
 317 #endif  /* _KERNEL */
 318
 319 #endif  /* _SYS_PMCLOG_H_ */