sys/sys/pmckern.h

   1 /*-
   2  * Copyright (c) 2003, 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_EXIT             1
  43 #define PMC_FN_PROCESS_EXEC             2
  44 #define PMC_FN_PROCESS_FORK             3
  45 #define PMC_FN_CSW_IN                   4
  46 #define PMC_FN_CSW_OUT                  5
  47
  48 /* hook */
  49 extern int (*pmc_hook)(struct thread *_td, int _function, void *_arg);
  50 extern int (*pmc_intr)(int cpu, uintptr_t pc);
  51
  52 /* SX lock protecting the hook */
  53 extern struct sx pmc_sx;
  54
  55 /* hook invocation; for use within the kernel */
  56 #define PMC_CALL_HOOK(t, cmd, arg)              \
  57 do {                                            \
  58         sx_slock(&pmc_sx);                      \
  59         if (pmc_hook != NULL)                   \
  60                 (pmc_hook)((t), (cmd), (arg));  \
  61         sx_sunlock(&pmc_sx);                    \
  62 } while (0)
  63
  64 /* hook invocation that needs an exclusive lock */
  65 #define PMC_CALL_HOOK_X(t, cmd, arg)            \
  66 do {                                            \
  67         sx_xlock(&pmc_sx);                      \
  68         if (pmc_hook != NULL)                   \
  69                 (pmc_hook)((t), (cmd), (arg));  \
  70         sx_xunlock(&pmc_sx);                    \
  71 } while (0)
  72
  73 /* context switches cannot take locks */
  74 #define PMC_SWITCH_CONTEXT(t, cmd)              \
  75 do {                                            \
  76         if (pmc_hook != NULL)                   \
  77                 (pmc_hook)((t), (cmd), NULL);   \
  78 } while (0)
  79
  80
  81 /*
  82  * check if a process is using HWPMCs.
  83  */
  84
  85 #define PMC_PROC_IS_USING_PMCS(p)                               \
  86         (__predict_false(atomic_load_acq_int(&(p)->p_flag) &    \
  87             P_HWPMC))
  88
  89 /* helper functions */
  90 int     pmc_cpu_is_disabled(int _cpu);
  91 int     pmc_cpu_is_logical(int _cpu);
  92
  93 #endif /* _SYS_PMCKERN_H_ */