The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/sdt.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright 2006-2008 John Birrell <jb@FreeBSD.org>
    3  *
    4  * Redistribution and use in source and binary forms, with or without
    5  * modification, are permitted provided that the following conditions
    6  * are met:
    7  * 1. Redistributions of source code must retain the above copyright
    8  *    notice, this list of conditions and the following disclaimer.
    9  * 2. Redistributions in binary form must reproduce the above copyright
   10  *    notice, this list of conditions and the following disclaimer in the
   11  *    documentation and/or other materials provided with the distribution.
   12  * 
   13  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   16  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
   17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   23  * SUCH DAMAGE.
   24  *
   25  * $FreeBSD: releng/8.3/sys/sys/sdt.h 219107 2011-02-28 23:28:35Z rwatson $
   26  *
   27  * Statically Defined Tracing (SDT) definitions.
   28  *
   29  */
   30 
   31 #ifndef _SYS_SDT_H
   32 #define _SYS_SDT_H
   33 
   34 #ifndef _KERNEL
   35 
   36 #define _DTRACE_VERSION 1
   37 
   38 #define DTRACE_PROBE(prov, name) {                              \
   39         extern void __dtrace_##prov##___##name(void);           \
   40         __dtrace_##prov##___##name();                           \
   41 }
   42 
   43 #define DTRACE_PROBE1(prov, name, arg1) {                       \
   44         extern void __dtrace_##prov##___##name(unsigned long);  \
   45         __dtrace_##prov##___##name((unsigned long)arg1);        \
   46 }
   47 
   48 #define DTRACE_PROBE2(prov, name, arg1, arg2) {                 \
   49         extern void __dtrace_##prov##___##name(unsigned long,   \
   50             unsigned long);                                     \
   51         __dtrace_##prov##___##name((unsigned long)arg1,         \
   52             (unsigned long)arg2);                               \
   53 }
   54 
   55 #define DTRACE_PROBE3(prov, name, arg1, arg2, arg3) {           \
   56         extern void __dtrace_##prov##___##name(unsigned long,   \
   57             unsigned long, unsigned long);                      \
   58         __dtrace_##prov##___##name((unsigned long)arg1,         \
   59             (unsigned long)arg2, (unsigned long)arg3);          \
   60 }
   61 
   62 #define DTRACE_PROBE4(prov, name, arg1, arg2, arg3, arg4) {     \
   63         extern void __dtrace_##prov##___##name(unsigned long,   \
   64             unsigned long, unsigned long, unsigned long);       \
   65         __dtrace_##prov##___##name((unsigned long)arg1,         \
   66             (unsigned long)arg2, (unsigned long)arg3,           \
   67             (unsigned long)arg4);                               \
   68 }
   69 
   70 #define DTRACE_PROBE5(prov, name, arg1, arg2, arg3, arg4, arg5) {       \
   71         extern void __dtrace_##prov##___##name(unsigned long,           \
   72             unsigned long, unsigned long, unsigned long, unsigned long);\
   73         __dtrace_##prov##___##name((unsigned long)arg1,                 \
   74             (unsigned long)arg2, (unsigned long)arg3,                   \
   75             (unsigned long)arg4, (unsigned long)arg5);                  \
   76 }
   77 
   78 #else /* _KERNEL */
   79 
   80 #ifndef KDTRACE_HOOKS
   81 
   82 #define SDT_PROVIDER_DEFINE(prov)
   83 #define SDT_PROVIDER_DECLARE(prov)
   84 #define SDT_PROBE_DEFINE(prov, mod, func, name, sname)
   85 #define SDT_PROBE_DECLARE(prov, mod, func, name)
   86 #define SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
   87 #define SDT_PROBE_ARGTYPE(prov, mod, func, name, num, type)
   88 
   89 #define SDT_PROBE_DEFINE1(prov, mod, func, name, sname, arg0)
   90 #define SDT_PROBE_DEFINE2(prov, mod, func, name, sname, arg0, arg1)
   91 #define SDT_PROBE_DEFINE3(prov, mod, func, name, sname, arg0, arg1, arg2)
   92 #define SDT_PROBE_DEFINE4(prov, mod, func, name, sname, arg0, arg1, arg2, arg3)
   93 #define SDT_PROBE_DEFINE5(prov, mod, func, name, sname, arg0, arg1, arg2, arg3, arg4)
   94 
   95 #define SDT_PROBE1(prov, mod, func, name, arg0)
   96 #define SDT_PROBE2(prov, mod, func, name, arg0, arg1)
   97 #define SDT_PROBE3(prov, mod, func, name, arg0, arg1, arg2)
   98 #define SDT_PROBE4(prov, mod, func, name, arg0, arg1, arg2, arg3)
   99 #define SDT_PROBE5(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
  100 
  101 #else
  102 
  103 /*
  104  * This type definition must match that of dtrace_probe. It is defined this
  105  * way to avoid having to rely on CDDL code.
  106  */
  107 typedef void (*sdt_probe_func_t)(u_int32_t, uintptr_t arg0, uintptr_t arg1,
  108     uintptr_t arg2, uintptr_t arg3, uintptr_t arg4);
  109 
  110 /*
  111  * The hook for the probe function. See kern_sdt.c which defaults this to
  112  * it's own stub. The 'sdt' provider will set it to dtrace_probe when it
  113  * loads.
  114  */
  115 extern sdt_probe_func_t sdt_probe_func;
  116 
  117 typedef enum {
  118         SDT_UNINIT = 1,
  119         SDT_INIT,
  120 } sdt_state_t;
  121 
  122 struct sdt_probe;
  123 struct sdt_provider;
  124 
  125 struct sdt_argtype {
  126         int     ndx;                    /* Argument index. */
  127         const char *type;               /* Argument type string. */
  128         TAILQ_ENTRY(sdt_argtype)
  129                         argtype_entry;  /* Argument type list entry. */
  130         struct sdt_probe
  131                         *probe;         /* Ptr to the probe structure. */
  132 };
  133 
  134 struct sdt_probe {
  135         int             version;        /* Set to sizeof(struct sdt_ref). */
  136         sdt_state_t     state;
  137         struct sdt_provider
  138                         *prov;          /* Ptr to the provider structure. */
  139         TAILQ_ENTRY(sdt_probe)
  140                         probe_entry;    /* SDT probe list entry. */
  141         TAILQ_HEAD(argtype_list_head, sdt_argtype) argtype_list;
  142         const char      *mod;
  143         const char      *func;
  144         const char      *name;
  145         id_t            id;             /* DTrace probe ID. */
  146         int             n_args;         /* Number of arguments. */
  147 };
  148 
  149 struct sdt_provider {
  150         const char *name;               /* Provider name. */
  151         TAILQ_ENTRY(sdt_provider)
  152                         prov_entry;     /* SDT provider list entry. */
  153         TAILQ_HEAD(probe_list_head, sdt_probe) probe_list;
  154         uintptr_t       id;             /* DTrace provider ID. */
  155 };
  156 
  157 #define SDT_PROVIDER_DEFINE(prov)                                               \
  158         struct sdt_provider sdt_provider_##prov[1] = {                          \
  159                 { #prov, { NULL, NULL }, { NULL, NULL } }                       \
  160         };                                                                      \
  161         SYSINIT(sdt_provider_##prov##_init, SI_SUB_KDTRACE,                     \
  162             SI_ORDER_SECOND, sdt_provider_register,                             \
  163             sdt_provider_##prov );                                              \
  164         SYSUNINIT(sdt_provider_##prov##_uninit, SI_SUB_KDTRACE,                 \
  165             SI_ORDER_SECOND, sdt_provider_deregister,                           \
  166             sdt_provider_##prov )
  167 
  168 #define SDT_PROVIDER_DECLARE(prov)                                              \
  169         extern struct sdt_provider sdt_provider_##prov[1]
  170 
  171 #define SDT_PROBE_DEFINE(prov, mod, func, name, sname)                          \
  172         struct sdt_probe sdt_##prov##_##mod##_##func##_##name[1] = {            \
  173                 { sizeof(struct sdt_probe), 0, sdt_provider_##prov,             \
  174                     { NULL, NULL }, { NULL, NULL }, #mod, #func, #sname, 0, 0 } \
  175         };                                                                      \
  176         SYSINIT(sdt_##prov##_##mod##_##func##_##name##_init, SI_SUB_KDTRACE,    \
  177             SI_ORDER_SECOND + 1, sdt_probe_register,                            \
  178             sdt_##prov##_##mod##_##func##_##name );                             \
  179         SYSUNINIT(sdt_##prov##_##mod##_##func##_##name##_uninit,                \
  180             SI_SUB_KDTRACE, SI_ORDER_SECOND + 1, sdt_probe_deregister,          \
  181             sdt_##prov##_##mod##_##func##_##name )
  182 
  183 #define SDT_PROBE_DECLARE(prov, mod, func, name)                                \
  184         extern struct sdt_probe sdt_##prov##_##mod##_##func##_##name[1]
  185 
  186 #define SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)          \
  187         if (sdt_##prov##_##mod##_##func##_##name->id)                           \
  188                 (*sdt_probe_func)(sdt_##prov##_##mod##_##func##_##name->id,     \
  189                     (uintptr_t) arg0, (uintptr_t) arg1, (uintptr_t) arg2,       \
  190                     (uintptr_t) arg3, (uintptr_t) arg4)
  191 
  192 #define SDT_PROBE_ARGTYPE(prov, mod, func, name, num, type)                     \
  193         struct sdt_argtype sdt_##prov##_##mod##_##func##_##name##num[1]         \
  194             = { { num, type, { NULL, NULL },                                    \
  195             sdt_##prov##_##mod##_##func##_##name }                              \
  196         };                                                                      \
  197         SYSINIT(sdt_##prov##_##mod##_##func##_##name##num##_init,               \
  198             SI_SUB_KDTRACE, SI_ORDER_SECOND + 2, sdt_argtype_register,          \
  199             sdt_##prov##_##mod##_##func##_##name##num );                        \
  200         SYSUNINIT(sdt_##prov##_##mod##_##func##_##name##num##_uninit,           \
  201             SI_SUB_KDTRACE, SI_ORDER_SECOND + 2, sdt_argtype_deregister,        \
  202             sdt_##prov##_##mod##_##func##_##name##num )
  203 
  204 #define SDT_PROBE_DEFINE1(prov, mod, func, name, sname, arg0)           \
  205         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
  206         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0)
  207 
  208 #define SDT_PROBE_DEFINE2(prov, mod, func, name, sname, arg0, arg1)     \
  209         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
  210         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
  211         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1)
  212 
  213 #define SDT_PROBE_DEFINE3(prov, mod, func, name, sname, arg0, arg1, arg2)\
  214         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
  215         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
  216         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1);              \
  217         SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2)
  218 
  219 #define SDT_PROBE_DEFINE4(prov, mod, func, name, sname, arg0, arg1, arg2, arg3) \
  220         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
  221         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
  222         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1);              \
  223         SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2);              \
  224         SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3)
  225 
  226 #define SDT_PROBE_DEFINE5(prov, mod, func, name, sname, arg0, arg1, arg2, arg3, arg4) \
  227         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
  228         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
  229         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1);              \
  230         SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2);              \
  231         SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3);              \
  232         SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4)
  233 
  234 #define SDT_PROBE1(prov, mod, func, name, arg0)                         \
  235         SDT_PROBE(prov, mod, func, name, arg0, 0, 0, 0, 0)
  236 #define SDT_PROBE2(prov, mod, func, name, arg0, arg1)                   \
  237         SDT_PROBE(prov, mod, func, name, arg0, arg1, 0, 0, 0)
  238 #define SDT_PROBE3(prov, mod, func, name, arg0, arg1, arg2)             \
  239         SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2,  0, 0)
  240 #define SDT_PROBE4(prov, mod, func, name, arg0, arg1, arg2, arg3)       \
  241         SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, 0)
  242 #define SDT_PROBE5(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4) \
  243         SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
  244 
  245 typedef int (*sdt_argtype_listall_func_t)(struct sdt_argtype *, void *);
  246 typedef int (*sdt_probe_listall_func_t)(struct sdt_probe *, void *);
  247 typedef int (*sdt_provider_listall_func_t)(struct sdt_provider *, void *);
  248 
  249 void sdt_argtype_deregister(void *);
  250 void sdt_argtype_register(void *);
  251 void sdt_probe_deregister(void *);
  252 void sdt_probe_register(void *);
  253 void sdt_provider_deregister(void *);
  254 void sdt_provider_register(void *);
  255 void sdt_probe_stub(u_int32_t, uintptr_t arg0, uintptr_t arg1, uintptr_t arg2,
  256     uintptr_t arg3, uintptr_t arg4);
  257 int sdt_argtype_listall(struct sdt_probe *, sdt_argtype_listall_func_t, void *);
  258 int sdt_probe_listall(struct sdt_provider *, sdt_probe_listall_func_t, void *);
  259 int sdt_provider_listall(sdt_provider_listall_func_t,void *);
  260 
  261 #endif /* KDTRACE_HOOKS */
  262 
  263 #endif /* _KERNEL */
  264 
  265 #endif /* _SYS_SDT_H */

Cache object: bee77a32b2fadba143cf93272149b05e


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.