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$
   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 #define SDT_PROBE_DEFINE6(prov, mod, func, name, snamp, arg0, arg1, arg2,      \
   95     arg3, arg4, arg5)
   96 #define SDT_PROBE_DEFINE7(prov, mod, func, name, snamp, arg0, arg1, arg2,      \
   97     arg3, arg4, arg5, arg6)
   98 
   99 #define SDT_PROBE0(prov, mod, func, name)
  100 #define SDT_PROBE1(prov, mod, func, name, arg0)
  101 #define SDT_PROBE2(prov, mod, func, name, arg0, arg1)
  102 #define SDT_PROBE3(prov, mod, func, name, arg0, arg1, arg2)
  103 #define SDT_PROBE4(prov, mod, func, name, arg0, arg1, arg2, arg3)
  104 #define SDT_PROBE5(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
  105 #define SDT_PROBE6(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5)
  106 #define SDT_PROBE7(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5,  \
  107     arg6)
  108 
  109 #else
  110 
  111 /*
  112  * This type definition must match that of dtrace_probe. It is defined this
  113  * way to avoid having to rely on CDDL code.
  114  */
  115 typedef void (*sdt_probe_func_t)(u_int32_t, uintptr_t arg0, uintptr_t arg1,
  116     uintptr_t arg2, uintptr_t arg3, uintptr_t arg4);
  117 
  118 /*
  119  * The hook for the probe function. See kern_sdt.c which defaults this to
  120  * it's own stub. The 'sdt' provider will set it to dtrace_probe when it
  121  * loads.
  122  */
  123 extern sdt_probe_func_t sdt_probe_func;
  124 
  125 typedef enum {
  126         SDT_UNINIT = 1,
  127         SDT_INIT,
  128 } sdt_state_t;
  129 
  130 struct sdt_probe;
  131 struct sdt_provider;
  132 
  133 struct sdt_argtype {
  134         int     ndx;                    /* Argument index. */
  135         const char *type;               /* Argument type string. */
  136         TAILQ_ENTRY(sdt_argtype)
  137                         argtype_entry;  /* Argument type list entry. */
  138         struct sdt_probe
  139                         *probe;         /* Ptr to the probe structure. */
  140 };
  141 
  142 struct sdt_probe {
  143         int             version;        /* Set to sizeof(struct sdt_ref). */
  144         sdt_state_t     state;
  145         struct sdt_provider
  146                         *prov;          /* Ptr to the provider structure. */
  147         TAILQ_ENTRY(sdt_probe)
  148                         probe_entry;    /* SDT probe list entry. */
  149         TAILQ_HEAD(argtype_list_head, sdt_argtype) argtype_list;
  150         const char      *mod;
  151         const char      *func;
  152         const char      *name;
  153         id_t            id;             /* DTrace probe ID. */
  154         int             n_args;         /* Number of arguments. */
  155 };
  156 
  157 struct sdt_provider {
  158         const char *name;               /* Provider name. */
  159         TAILQ_ENTRY(sdt_provider)
  160                         prov_entry;     /* SDT provider list entry. */
  161         TAILQ_HEAD(probe_list_head, sdt_probe) probe_list;
  162         uintptr_t       id;             /* DTrace provider ID. */
  163 };
  164 
  165 #define SDT_PROVIDER_DEFINE(prov)                                               \
  166         struct sdt_provider sdt_provider_##prov[1] = {                          \
  167                 { #prov, { NULL, NULL }, { NULL, NULL } }                       \
  168         };                                                                      \
  169         SYSINIT(sdt_provider_##prov##_init, SI_SUB_KDTRACE,                     \
  170             SI_ORDER_SECOND, sdt_provider_register,                             \
  171             sdt_provider_##prov );                                              \
  172         SYSUNINIT(sdt_provider_##prov##_uninit, SI_SUB_KDTRACE,                 \
  173             SI_ORDER_SECOND, sdt_provider_deregister,                           \
  174             sdt_provider_##prov )
  175 
  176 #define SDT_PROVIDER_DECLARE(prov)                                              \
  177         extern struct sdt_provider sdt_provider_##prov[1]
  178 
  179 #define SDT_PROBE_DEFINE(prov, mod, func, name, sname)                          \
  180         struct sdt_probe sdt_##prov##_##mod##_##func##_##name[1] = {            \
  181                 { sizeof(struct sdt_probe), 0, sdt_provider_##prov,             \
  182                     { NULL, NULL }, { NULL, NULL }, #mod, #func, #sname, 0, 0 } \
  183         };                                                                      \
  184         SYSINIT(sdt_##prov##_##mod##_##func##_##name##_init, SI_SUB_KDTRACE,    \
  185             SI_ORDER_SECOND + 1, sdt_probe_register,                            \
  186             sdt_##prov##_##mod##_##func##_##name );                             \
  187         SYSUNINIT(sdt_##prov##_##mod##_##func##_##name##_uninit,                \
  188             SI_SUB_KDTRACE, SI_ORDER_SECOND + 1, sdt_probe_deregister,          \
  189             sdt_##prov##_##mod##_##func##_##name )
  190 
  191 #define SDT_PROBE_DECLARE(prov, mod, func, name)                                \
  192         extern struct sdt_probe sdt_##prov##_##mod##_##func##_##name[1]
  193 
  194 #define SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)          \
  195         if (sdt_##prov##_##mod##_##func##_##name->id)                           \
  196                 (*sdt_probe_func)(sdt_##prov##_##mod##_##func##_##name->id,     \
  197                     (uintptr_t) arg0, (uintptr_t) arg1, (uintptr_t) arg2,       \
  198                     (uintptr_t) arg3, (uintptr_t) arg4)
  199 
  200 #define SDT_PROBE_ARGTYPE(prov, mod, func, name, num, type)                     \
  201         struct sdt_argtype sdt_##prov##_##mod##_##func##_##name##num[1]         \
  202             = { { num, type, { NULL, NULL },                                    \
  203             sdt_##prov##_##mod##_##func##_##name }                              \
  204         };                                                                      \
  205         SYSINIT(sdt_##prov##_##mod##_##func##_##name##num##_init,               \
  206             SI_SUB_KDTRACE, SI_ORDER_SECOND + 2, sdt_argtype_register,          \
  207             sdt_##prov##_##mod##_##func##_##name##num );                        \
  208         SYSUNINIT(sdt_##prov##_##mod##_##func##_##name##num##_uninit,           \
  209             SI_SUB_KDTRACE, SI_ORDER_SECOND + 2, sdt_argtype_deregister,        \
  210             sdt_##prov##_##mod##_##func##_##name##num )
  211 
  212 #define SDT_PROBE_DEFINE1(prov, mod, func, name, sname, arg0)           \
  213         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
  214         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0)
  215 
  216 #define SDT_PROBE_DEFINE2(prov, mod, func, name, sname, arg0, arg1)     \
  217         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
  218         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
  219         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1)
  220 
  221 #define SDT_PROBE_DEFINE3(prov, mod, func, name, sname, arg0, arg1, arg2)\
  222         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
  223         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
  224         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1);              \
  225         SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2)
  226 
  227 #define SDT_PROBE_DEFINE4(prov, mod, func, name, sname, arg0, arg1, arg2, arg3) \
  228         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
  229         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
  230         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1);              \
  231         SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2);              \
  232         SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3)
  233 
  234 #define SDT_PROBE_DEFINE5(prov, mod, func, name, sname, arg0, arg1, arg2, arg3, arg4) \
  235         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
  236         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
  237         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1);              \
  238         SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2);              \
  239         SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3);              \
  240         SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4)
  241 
  242 #define SDT_PROBE_DEFINE6(prov, mod, func, name, sname, arg0, arg1, arg2, arg3,\
  243     arg4, arg5) \
  244         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
  245         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
  246         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1);              \
  247         SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2);              \
  248         SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3);              \
  249         SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4);              \
  250         SDT_PROBE_ARGTYPE(prov, mod, func, name, 5, arg5);
  251 
  252 #define SDT_PROBE_DEFINE7(prov, mod, func, name, sname, arg0, arg1, arg2, arg3,\
  253     arg4, arg5, arg6) \
  254         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
  255         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
  256         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1);              \
  257         SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2);              \
  258         SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3);              \
  259         SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4);              \
  260         SDT_PROBE_ARGTYPE(prov, mod, func, name, 5, arg5);              \
  261         SDT_PROBE_ARGTYPE(prov, mod, func, name, 6, arg6);
  262 
  263 #define SDT_PROBE0(prov, mod, func, name)                               \
  264         SDT_PROBE(prov, mod, func, name, 0, 0, 0, 0, 0)
  265 #define SDT_PROBE1(prov, mod, func, name, arg0)                         \
  266         SDT_PROBE(prov, mod, func, name, arg0, 0, 0, 0, 0)
  267 #define SDT_PROBE2(prov, mod, func, name, arg0, arg1)                   \
  268         SDT_PROBE(prov, mod, func, name, arg0, arg1, 0, 0, 0)
  269 #define SDT_PROBE3(prov, mod, func, name, arg0, arg1, arg2)             \
  270         SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2,  0, 0)
  271 #define SDT_PROBE4(prov, mod, func, name, arg0, arg1, arg2, arg3)       \
  272         SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, 0)
  273 #define SDT_PROBE5(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4) \
  274         SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
  275 #define SDT_PROBE6(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5)  \
  276         do {                                                                   \
  277                 if (sdt_##prov##_##mod##_##func##_##name->id)                  \
  278                         (*(void (*)(uint32_t, uintptr_t, uintptr_t, uintptr_t, \
  279                             uintptr_t, uintptr_t, uintptr_t))sdt_probe_func)(  \
  280                             sdt_##prov##_##mod##_##func##_##name->id,          \
  281                             (uintptr_t)arg0, (uintptr_t)arg1, (uintptr_t)arg2, \
  282                             (uintptr_t)arg3, (uintptr_t)arg4, (uintptr_t)arg5);\
  283         } while (0)
  284 #define SDT_PROBE7(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5,  \
  285     arg6)                                                                      \
  286         do {                                                                   \
  287                 if (sdt_##prov##_##mod##_##func##_##name->id)                  \
  288                         (*(void (*)(uint32_t, uintptr_t, uintptr_t, uintptr_t, \
  289                             uintptr_t, uintptr_t, uintptr_t, uintptr_t))       \
  290                             sdt_probe_func)(                                   \
  291                             sdt_##prov##_##mod##_##func##_##name->id,          \
  292                             (uintptr_t)arg0, (uintptr_t)arg1, (uintptr_t)arg2, \
  293                             (uintptr_t)arg3, (uintptr_t)arg4, (uintptr_t)arg5, \
  294                             (uintptr_t)arg6);                                  \
  295         } while (0)
  296 
  297 typedef int (*sdt_argtype_listall_func_t)(struct sdt_argtype *, void *);
  298 typedef int (*sdt_probe_listall_func_t)(struct sdt_probe *, void *);
  299 typedef int (*sdt_provider_listall_func_t)(struct sdt_provider *, void *);
  300 
  301 void sdt_argtype_deregister(void *);
  302 void sdt_argtype_register(void *);
  303 void sdt_probe_deregister(void *);
  304 void sdt_probe_register(void *);
  305 void sdt_provider_deregister(void *);
  306 void sdt_provider_register(void *);
  307 void sdt_probe_stub(u_int32_t, uintptr_t arg0, uintptr_t arg1, uintptr_t arg2,
  308     uintptr_t arg3, uintptr_t arg4);
  309 int sdt_argtype_listall(struct sdt_probe *, sdt_argtype_listall_func_t, void *);
  310 int sdt_probe_listall(struct sdt_provider *, sdt_probe_listall_func_t, void *);
  311 int sdt_provider_listall(sdt_provider_listall_func_t,void *);
  312 
  313 void sdt_register_callbacks(sdt_provider_listall_func_t, void *,
  314     sdt_provider_listall_func_t, void *, sdt_probe_listall_func_t, void *);
  315 void sdt_deregister_callbacks(void);
  316 
  317 #endif /* KDTRACE_HOOKS */
  318 
  319 #endif /* _KERNEL */
  320 
  321 #endif /* _SYS_SDT_H */

Cache object: 3512e97a7445890354b8e3e1da441af8


[ 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.