sys/sys/sdt.h

   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 #include <sys/cdefs.h>
  81 #include <sys/linker_set.h>
  82
  83 #ifndef KDTRACE_HOOKS
  84
  85 #define SDT_PROVIDER_DEFINE(prov)
  86 #define SDT_PROVIDER_DECLARE(prov)
  87 #define SDT_PROBE_DEFINE(prov, mod, func, name, sname)
  88 #define SDT_PROBE_DECLARE(prov, mod, func, name)
  89 #define SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
  90 #define SDT_PROBE_ARGTYPE(prov, mod, func, name, num, type)
  91
  92 #define SDT_PROBE_DEFINE0(prov, mod, func, name, sname)
  93 #define SDT_PROBE_DEFINE1(prov, mod, func, name, sname, arg0)
  94 #define SDT_PROBE_DEFINE2(prov, mod, func, name, sname, arg0, arg1)
  95 #define SDT_PROBE_DEFINE3(prov, mod, func, name, sname, arg0, arg1, arg2)
  96 #define SDT_PROBE_DEFINE4(prov, mod, func, name, sname, arg0, arg1, arg2, arg3)
  97 #define SDT_PROBE_DEFINE5(prov, mod, func, name, sname, arg0, arg1, arg2, arg3, arg4)
  98 #define SDT_PROBE_DEFINE6(prov, mod, func, name, snamp, arg0, arg1, arg2,      \
  99     arg3, arg4, arg5)
 100 #define SDT_PROBE_DEFINE7(prov, mod, func, name, snamp, arg0, arg1, arg2,      \
 101     arg3, arg4, arg5, arg6)
 102
 103 #define SDT_PROBE0(prov, mod, func, name)
 104 #define SDT_PROBE1(prov, mod, func, name, arg0)
 105 #define SDT_PROBE2(prov, mod, func, name, arg0, arg1)
 106 #define SDT_PROBE3(prov, mod, func, name, arg0, arg1, arg2)
 107 #define SDT_PROBE4(prov, mod, func, name, arg0, arg1, arg2, arg3)
 108 #define SDT_PROBE5(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
 109 #define SDT_PROBE6(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5)
 110 #define SDT_PROBE7(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5,  \
 111     arg6)
 112
 113 #else
 114
 115 SET_DECLARE(sdt_providers_set, struct sdt_provider);
 116 SET_DECLARE(sdt_probes_set, struct sdt_probe);
 117 SET_DECLARE(sdt_argtypes_set, struct sdt_argtype);
 118
 119 #define SDT_PROVIDER_DEFINE(prov)                                               \
 120         struct sdt_provider sdt_provider_##prov[1] = {                          \
 121                 { #prov, { NULL, NULL }, { NULL, NULL }, 0, 0 }                 \
 122         };                                                                      \
 123         DATA_SET(sdt_providers_set, sdt_provider_##prov);
 124
 125 #define SDT_PROVIDER_DECLARE(prov)                                              \
 126         extern struct sdt_provider sdt_provider_##prov[1]
 127
 128 #define SDT_PROBE_DEFINE(prov, mod, func, name, sname)                          \
 129         struct sdt_probe sdt_##prov##_##mod##_##func##_##name[1] = {            \
 130                 { sizeof(struct sdt_probe), sdt_provider_##prov,                \
 131                     { NULL, NULL }, { NULL, NULL }, #mod, #func, #sname, 0, 0,  \
 132                     NULL }                                                      \
 133         };                                                                      \
 134         DATA_SET(sdt_probes_set, sdt_##prov##_##mod##_##func##_##name);
 135
 136 #define SDT_PROBE_DECLARE(prov, mod, func, name)                                \
 137         extern struct sdt_probe sdt_##prov##_##mod##_##func##_##name[1]
 138
 139 #define SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)          \
 140         if (sdt_##prov##_##mod##_##func##_##name->id)                           \
 141                 (*sdt_probe_func)(sdt_##prov##_##mod##_##func##_##name->id,     \
 142                     (uintptr_t) arg0, (uintptr_t) arg1, (uintptr_t) arg2,       \
 143                     (uintptr_t) arg3, (uintptr_t) arg4)
 144
 145 #define SDT_PROBE_ARGTYPE(prov, mod, func, name, num, type)                     \
 146         struct sdt_argtype sdt_##prov##_##mod##_##func##_##name##num[1]         \
 147             = { { num, type, { NULL, NULL },                                    \
 148             sdt_##prov##_##mod##_##func##_##name }                              \
 149         };                                                                      \
 150         DATA_SET(sdt_argtypes_set, sdt_##prov##_##mod##_##func##_##name##num);
 151
 152 #define SDT_PROBE_DEFINE0(prov, mod, func, name, sname)                 \
 153         SDT_PROBE_DEFINE(prov, mod, func, name, sname)
 154
 155 #define SDT_PROBE_DEFINE1(prov, mod, func, name, sname, arg0)           \
 156         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
 157         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0)
 158
 159 #define SDT_PROBE_DEFINE2(prov, mod, func, name, sname, arg0, arg1)     \
 160         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
 161         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
 162         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1)
 163
 164 #define SDT_PROBE_DEFINE3(prov, mod, func, name, sname, arg0, arg1, arg2)\
 165         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
 166         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
 167         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1);              \
 168         SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2)
 169
 170 #define SDT_PROBE_DEFINE4(prov, mod, func, name, sname, arg0, arg1, arg2, arg3) \
 171         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
 172         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
 173         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1);              \
 174         SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2);              \
 175         SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3)
 176
 177 #define SDT_PROBE_DEFINE5(prov, mod, func, name, sname, arg0, arg1, arg2, arg3, arg4) \
 178         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
 179         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
 180         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1);              \
 181         SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2);              \
 182         SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3);              \
 183         SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4)
 184
 185 #define SDT_PROBE_DEFINE6(prov, mod, func, name, sname, arg0, arg1, arg2, arg3,\
 186     arg4, arg5) \
 187         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
 188         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
 189         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1);              \
 190         SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2);              \
 191         SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3);              \
 192         SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4);              \
 193         SDT_PROBE_ARGTYPE(prov, mod, func, name, 5, arg5);
 194
 195 #define SDT_PROBE_DEFINE7(prov, mod, func, name, sname, arg0, arg1, arg2, arg3,\
 196     arg4, arg5, arg6) \
 197         SDT_PROBE_DEFINE(prov, mod, func, name, sname);                 \
 198         SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0);              \
 199         SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1);              \
 200         SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2);              \
 201         SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3);              \
 202         SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4);              \
 203         SDT_PROBE_ARGTYPE(prov, mod, func, name, 5, arg5);              \
 204         SDT_PROBE_ARGTYPE(prov, mod, func, name, 6, arg6);
 205
 206 #define SDT_PROBE0(prov, mod, func, name)                               \
 207         SDT_PROBE(prov, mod, func, name, 0, 0, 0, 0, 0)
 208 #define SDT_PROBE1(prov, mod, func, name, arg0)                         \
 209         SDT_PROBE(prov, mod, func, name, arg0, 0, 0, 0, 0)
 210 #define SDT_PROBE2(prov, mod, func, name, arg0, arg1)                   \
 211         SDT_PROBE(prov, mod, func, name, arg0, arg1, 0, 0, 0)
 212 #define SDT_PROBE3(prov, mod, func, name, arg0, arg1, arg2)             \
 213         SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2,  0, 0)
 214 #define SDT_PROBE4(prov, mod, func, name, arg0, arg1, arg2, arg3)       \
 215         SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, 0)
 216 #define SDT_PROBE5(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4) \
 217         SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
 218 #define SDT_PROBE6(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5)  \
 219         do {                                                                   \
 220                 if (sdt_##prov##_##mod##_##func##_##name->id)                  \
 221                         (*(void (*)(uint32_t, uintptr_t, uintptr_t, uintptr_t, \
 222                             uintptr_t, uintptr_t, uintptr_t))sdt_probe_func)(  \
 223                             sdt_##prov##_##mod##_##func##_##name->id,          \
 224                             (uintptr_t)arg0, (uintptr_t)arg1, (uintptr_t)arg2, \
 225                             (uintptr_t)arg3, (uintptr_t)arg4, (uintptr_t)arg5);\
 226         } while (0)
 227 #define SDT_PROBE7(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5,  \
 228     arg6)                                                                      \
 229         do {                                                                   \
 230                 if (sdt_##prov##_##mod##_##func##_##name->id)                  \
 231                         (*(void (*)(uint32_t, uintptr_t, uintptr_t, uintptr_t, \
 232                             uintptr_t, uintptr_t, uintptr_t, uintptr_t))       \
 233                             sdt_probe_func)(                                   \
 234                             sdt_##prov##_##mod##_##func##_##name->id,          \
 235                             (uintptr_t)arg0, (uintptr_t)arg1, (uintptr_t)arg2, \
 236                             (uintptr_t)arg3, (uintptr_t)arg4, (uintptr_t)arg5, \
 237                             (uintptr_t)arg6);                                  \
 238         } while (0)
 239
 240 #endif /* KDTRACE_HOOKS */
 241
 242 /*
 243  * This type definition must match that of dtrace_probe. It is defined this
 244  * way to avoid having to rely on CDDL code.
 245  */
 246 typedef void (*sdt_probe_func_t)(uint32_t, uintptr_t arg0, uintptr_t arg1,
 247     uintptr_t arg2, uintptr_t arg3, uintptr_t arg4);
 248
 249 /*
 250  * The 'sdt' provider will set it to dtrace_probe when it loads.
 251  */
 252 extern sdt_probe_func_t sdt_probe_func;
 253
 254 struct sdt_probe;
 255 struct sdt_provider;
 256 struct linker_file;
 257
 258 struct sdt_argtype {
 259         int     ndx;                    /* Argument index. */
 260         const char *type;               /* Argument type string. */
 261         TAILQ_ENTRY(sdt_argtype)
 262                         argtype_entry;  /* Argument type list entry. */
 263         struct sdt_probe
 264                         *probe;         /* Ptr to the probe structure. */
 265 };
 266
 267 struct sdt_probe {
 268         int             version;        /* Set to sizeof(struct sdt_probe). */
 269         struct sdt_provider *prov;      /* Ptr to the provider structure. */
 270         TAILQ_ENTRY(sdt_probe)
 271                         probe_entry;    /* SDT probe list entry. */
 272         TAILQ_HEAD(argtype_list_head, sdt_argtype) argtype_list;
 273         const char      *mod;
 274         const char      *func;
 275         const char      *name;
 276         id_t            id;             /* DTrace probe ID. */
 277         int             n_args;         /* Number of arguments. */
 278         struct linker_file *sdtp_lf;    /* Module in which we're defined. */
 279 };
 280
 281 struct sdt_provider {
 282         char *name;                     /* Provider name. */
 283         TAILQ_ENTRY(sdt_provider)
 284                         prov_entry;     /* SDT provider list entry. */
 285         TAILQ_HEAD(probe_list_head, sdt_probe) probe_list;
 286         uintptr_t       id;             /* DTrace provider ID. */
 287         int             sdt_refs;       /* Number of module references. */
 288 };
 289
 290 void sdt_probe_stub(uint32_t, uintptr_t, uintptr_t, uintptr_t, uintptr_t,
 291     uintptr_t);
 292
 293 #endif /* _KERNEL */
 294
 295 #endif /* _SYS_SDT_H */