sys/sys/pmckern.h

   1 /*-
   2  * Copyright (c) 2003-2006, Joseph Koshy
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 /*
  30  * PMC interface used by the base kernel.
  31  */
  32
  33 #ifndef _SYS_PMCKERN_H_
  34 #define _SYS_PMCKERN_H_
  35
  36 #include <sys/param.h>
  37 #include <sys/kernel.h>
  38 #include <sys/lock.h>
  39 #include <sys/proc.h>
  40 #include <sys/sx.h>
  41
  42 #define PMC_FN_PROCESS_EXEC             1
  43 #define PMC_FN_CSW_IN                   2
  44 #define PMC_FN_CSW_OUT                  3
  45 #define PMC_FN_DO_SAMPLES               4
  46 #define PMC_FN_KLD_LOAD                 5
  47 #define PMC_FN_KLD_UNLOAD               6
  48 #define PMC_FN_MMAP                     7
  49 #define PMC_FN_MUNMAP                   8
  50
  51 struct pmckern_procexec {
  52         int             pm_credentialschanged;
  53         uintfptr_t      pm_entryaddr;
  54 };
  55
  56 struct pmckern_map_in {
  57         void            *pm_file;       /* filename or vnode pointer */
  58         uintfptr_t      pm_address;     /* address object is loaded at */
  59 };
  60
  61 struct pmckern_map_out {
  62         uintfptr_t      pm_address;     /* start address of region */
  63         size_t          pm_size;        /* size of unmapped region */
  64 };
  65
  66 /* hook */
  67 extern int (*pmc_hook)(struct thread *_td, int _function, void *_arg);
  68 extern int (*pmc_intr)(int _cpu, uintptr_t _pc, int _usermode);
  69
  70 /* SX lock protecting the hook */
  71 extern struct sx pmc_sx;
  72
  73 /* Per-cpu flags indicating availability of sampling data */
  74 extern volatile cpumask_t pmc_cpumask;
  75
  76 /* Count of system-wide sampling PMCs in existence */
  77 extern volatile int pmc_ss_count;
  78
  79 /* kernel version number */
  80 extern const int pmc_kernel_version;
  81
  82 /* Hook invocation; for use within the kernel */
  83 #define PMC_CALL_HOOK(t, cmd, arg)              \
  84 do {                                            \
  85         sx_slock(&pmc_sx);                      \
  86         if (pmc_hook != NULL)                   \
  87                 (pmc_hook)((t), (cmd), (arg));  \
  88         sx_sunlock(&pmc_sx);                    \
  89 } while (0)
  90
  91 /* Hook invocation that needs an exclusive lock */
  92 #define PMC_CALL_HOOK_X(t, cmd, arg)            \
  93 do {                                            \
  94         sx_xlock(&pmc_sx);                      \
  95         if (pmc_hook != NULL)                   \
  96                 (pmc_hook)((t), (cmd), (arg));  \
  97         sx_xunlock(&pmc_sx);                    \
  98 } while (0)
  99
 100 /*
 101  * Some hook invocations (e.g., from context switch and clock handling
 102  * code) need to be lock-free.
 103  */
 104 #define PMC_CALL_HOOK_UNLOCKED(t, cmd, arg)     \
 105 do {                                            \
 106         if (pmc_hook != NULL)                   \
 107                 (pmc_hook)((t), (cmd), (arg));  \
 108 } while (0)
 109
 110 #define PMC_SWITCH_CONTEXT(t,cmd)       PMC_CALL_HOOK_UNLOCKED(t,cmd,NULL)
 111
 112 /* Check if a process is using HWPMCs.*/
 113 #define PMC_PROC_IS_USING_PMCS(p)                               \
 114         (__predict_false(atomic_load_acq_int(&(p)->p_flag) &    \
 115             P_HWPMC))
 116
 117 #define PMC_SYSTEM_SAMPLING_ACTIVE()            (pmc_ss_count > 0)
 118
 119 /* Check if a CPU has recorded samples. */
 120 #define PMC_CPU_HAS_SAMPLES(C)  (__predict_false(pmc_cpumask & (1 << (C))))
 121
 122 /* helper functions */
 123 int     pmc_cpu_is_disabled(int _cpu);
 124 int     pmc_cpu_is_logical(int _cpu);
 125
 126 #endif /* _SYS_PMCKERN_H_ */