sys/sys/dtrace_bsd.h

   1 /*-
   2  * Copyright (c) 2007-2008 John Birrell (jb@freebsd.org)
   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  * This file contains BSD shims for Sun's DTrace code.
  29  */
  30
  31 #ifndef _SYS_DTRACE_BSD_H
  32 #define _SYS_DTRACE_BSD_H
  33
  34 /* Forward definitions: */
  35 struct mbuf;
  36 struct trapframe;
  37 struct thread;
  38 struct vattr;
  39 struct vnode;
  40
  41 /*
  42  * Cyclic clock function type definition used to hook the cyclic
  43  * subsystem into the appropriate timer interrupt.
  44  */
  45 typedef void (*cyclic_clock_func_t)(struct trapframe *);
  46
  47 /*
  48  * These external variables are actually machine-dependent, so
  49  * they might not actually exist.
  50  *
  51  * Defining them here avoids a proliferation of header files.
  52  */
  53 extern cyclic_clock_func_t     lapic_cyclic_clock_func[];
  54
  55 /*
  56  * The dtrace module handles traps that occur during a DTrace probe.
  57  * This type definition is used in the trap handler to provide a
  58  * hook for the dtrace module to register it's handler with.
  59  */
  60 typedef int (*dtrace_trap_func_t)(struct trapframe *, u_int);
  61
  62 int     dtrace_trap(struct trapframe *, u_int);
  63
  64 extern dtrace_trap_func_t       dtrace_trap_func;
  65
  66 /* Used by the machine dependent trap() code. */
  67 typedef int (*dtrace_invop_func_t)(uintptr_t, uintptr_t *, uintptr_t);
  68 typedef void (*dtrace_doubletrap_func_t)(void);
  69
  70 /* Global variables in trap.c */
  71 extern  dtrace_invop_func_t     dtrace_invop_func;
  72 extern  dtrace_doubletrap_func_t        dtrace_doubletrap_func;
  73
  74 /* Virtual time hook function type. */
  75 typedef void (*dtrace_vtime_switch_func_t)(struct thread *);
  76
  77 extern int                      dtrace_vtime_active;
  78 extern dtrace_vtime_switch_func_t       dtrace_vtime_switch_func;
  79
  80 /* The fasttrap module hooks into the fork, exit and exit. */
  81 typedef void (*dtrace_fork_func_t)(struct proc *, struct proc *);
  82 typedef void (*dtrace_execexit_func_t)(struct proc *);
  83
  84 /* Global variable in kern_fork.c */
  85 extern dtrace_fork_func_t       dtrace_fasttrap_fork;
  86
  87 /* Global variable in kern_exec.c */
  88 extern dtrace_execexit_func_t   dtrace_fasttrap_exec;
  89
  90 /* Global variable in kern_exit.c */
  91 extern dtrace_execexit_func_t   dtrace_fasttrap_exit;
  92
  93 /* The dtmalloc provider hooks into malloc. */
  94 typedef void (*dtrace_malloc_probe_func_t)(u_int32_t, uintptr_t arg0,
  95     uintptr_t arg1, uintptr_t arg2, uintptr_t arg3, uintptr_t arg4);
  96
  97 extern dtrace_malloc_probe_func_t   dtrace_malloc_probe;
  98
  99 /* dtnfsclient NFSv3 access cache provider hooks. */
 100 typedef void (*dtrace_nfsclient_accesscache_flush_probe_func_t)(uint32_t,
 101     struct vnode *);
 102 extern dtrace_nfsclient_accesscache_flush_probe_func_t
 103     dtrace_nfsclient_accesscache_flush_done_probe;
 104
 105 typedef void (*dtrace_nfsclient_accesscache_get_probe_func_t)(uint32_t,
 106     struct vnode *, uid_t, uint32_t);
 107 extern dtrace_nfsclient_accesscache_get_probe_func_t
 108     dtrace_nfsclient_accesscache_get_hit_probe,
 109     dtrace_nfsclient_accesscache_get_miss_probe;
 110
 111 typedef void (*dtrace_nfsclient_accesscache_load_probe_func_t)(uint32_t,
 112     struct vnode *, uid_t, uint32_t, int);
 113 extern dtrace_nfsclient_accesscache_load_probe_func_t
 114     dtrace_nfsclient_accesscache_load_done_probe;
 115
 116 /* dtnfsclient NFSv[23] attribute cache provider hooks. */
 117 typedef void (*dtrace_nfsclient_attrcache_flush_probe_func_t)(uint32_t,
 118     struct vnode *);
 119 extern dtrace_nfsclient_attrcache_flush_probe_func_t
 120     dtrace_nfsclient_attrcache_flush_done_probe;
 121
 122 typedef void (*dtrace_nfsclient_attrcache_get_hit_probe_func_t)(uint32_t,
 123     struct vnode *, struct vattr *);
 124 extern dtrace_nfsclient_attrcache_get_hit_probe_func_t
 125     dtrace_nfsclient_attrcache_get_hit_probe;
 126
 127 typedef void (*dtrace_nfsclient_attrcache_get_miss_probe_func_t)(uint32_t,
 128     struct vnode *);
 129 extern dtrace_nfsclient_attrcache_get_miss_probe_func_t
 130     dtrace_nfsclient_attrcache_get_miss_probe;
 131
 132 typedef void (*dtrace_nfsclient_attrcache_load_probe_func_t)(uint32_t,
 133     struct vnode *, struct vattr *, int);
 134 extern dtrace_nfsclient_attrcache_load_probe_func_t
 135     dtrace_nfsclient_attrcache_load_done_probe;
 136
 137 /* dtnfsclient NFSv[23] RPC provider hooks. */
 138 typedef void (*dtrace_nfsclient_nfs23_start_probe_func_t)(uint32_t,
 139     struct vnode *, struct mbuf *, struct ucred *, int);
 140 extern dtrace_nfsclient_nfs23_start_probe_func_t
 141     dtrace_nfsclient_nfs23_start_probe;
 142
 143 typedef void (*dtrace_nfsclient_nfs23_done_probe_func_t)(uint32_t,
 144     struct vnode *, struct mbuf *, struct ucred *, int, int);
 145 extern dtrace_nfsclient_nfs23_done_probe_func_t
 146     dtrace_nfsclient_nfs23_done_probe;
 147
 148 /*
 149  * Functions which allow the dtrace module to check that the kernel
 150  * hooks have been compiled with sufficient space for it's private
 151  * structures.
 152  */
 153 size_t  kdtrace_proc_size(void);
 154 size_t  kdtrace_thread_size(void);
 155
 156 /*
 157  * OpenSolaris compatible time functions returning nanoseconds.
 158  * On OpenSolaris these return hrtime_t which we define as uint64_t.
 159  */
 160 uint64_t        dtrace_gethrtime(void);
 161 uint64_t        dtrace_gethrestime(void);
 162
 163 #endif /* _SYS_DTRACE_BSD_H */