common/sys/sdt.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2013 by Delphix. All rights reserved.
 */

#ifndef _SYS_SDT_H
#define _SYS_SDT_H

#include <sys/stdint.h>

#ifdef  __cplusplus
extern "C" {
#endif

#ifndef _KERNEL

#define DTRACE_PROBE(provider, name) {                  \
    extern void __dtrace_##provider##___##name(void);       \
    __dtrace_##provider##___##name();               \
}

#define DTRACE_PROBE1(provider, name, arg1) {               \
    extern void __dtrace_##provider##___##name(unsigned long);  \
    __dtrace_##provider##___##name((unsigned long)arg1);        \
}

#define DTRACE_PROBE2(provider, name, arg1, arg2) {         \
    extern void __dtrace_##provider##___##name(unsigned long,   \
        unsigned long);                     \
    __dtrace_##provider##___##name((unsigned long)arg1,     \
        (unsigned long)arg2);                   \
}

#define DTRACE_PROBE3(provider, name, arg1, arg2, arg3) {       \
    extern void __dtrace_##provider##___##name(unsigned long,   \
        unsigned long, unsigned long);              \
    __dtrace_##provider##___##name((unsigned long)arg1,     \
        (unsigned long)arg2, (unsigned long)arg3);          \
}

#define DTRACE_PROBE4(provider, name, arg1, arg2, arg3, arg4) {     \
    extern void __dtrace_##provider##___##name(unsigned long,   \
        unsigned long, unsigned long, unsigned long);       \
    __dtrace_##provider##___##name((unsigned long)arg1,     \
        (unsigned long)arg2, (unsigned long)arg3,           \
        (unsigned long)arg4);                   \
}

#define DTRACE_PROBE5(provider, name, arg1, arg2, arg3, arg4, arg5) {   \
    extern void __dtrace_##provider##___##name(unsigned long,   \
        unsigned long, unsigned long, unsigned long, unsigned long);\
    __dtrace_##provider##___##name((unsigned long)arg1,     \
        (unsigned long)arg2, (unsigned long)arg3,           \
        (unsigned long)arg4, (unsigned long)arg5);          \
}

#else /* _KERNEL */

#define DTRACE_PROBE(name)  {                   \
    extern void __dtrace_probe_##name(void);            \
    __dtrace_probe_##name();                    \
}

#define DTRACE_PROBE1(name, type1, arg1) {              \
    extern void __dtrace_probe_##name(uintptr_t);           \
    __dtrace_probe_##name((uintptr_t)(arg1));           \
}

#define DTRACE_PROBE2(name, type1, arg1, type2, arg2) {         \
    extern void __dtrace_probe_##name(uintptr_t, uintptr_t);    \
    __dtrace_probe_##name((uintptr_t)(arg1), (uintptr_t)(arg2));    \
}

#define DTRACE_PROBE3(name, type1, arg1, type2, arg2, type3, arg3) {    \
    extern void __dtrace_probe_##name(uintptr_t, uintptr_t, uintptr_t); \
    __dtrace_probe_##name((uintptr_t)(arg1), (uintptr_t)(arg2), \
        (uintptr_t)(arg3));                     \
}

#define DTRACE_PROBE4(name, type1, arg1, type2, arg2,           \
    type3, arg3, type4, arg4) {                     \
    extern void __dtrace_probe_##name(uintptr_t, uintptr_t,     \
        uintptr_t, uintptr_t);                  \
    __dtrace_probe_##name((uintptr_t)(arg1), (uintptr_t)(arg2), \
        (uintptr_t)(arg3), (uintptr_t)(arg4));          \
}

#define DTRACE_PROBE5(name, type1, arg1, type2, arg2,           \
    type3, arg3, type4, arg4, type5, arg5) {                \
    extern void __dtrace_probe_##name(uintptr_t, uintptr_t,     \
        uintptr_t, uintptr_t, uintptr_t);               \
    __dtrace_probe_##name((uintptr_t)(arg1), (uintptr_t)(arg2), \
        (uintptr_t)(arg3), (uintptr_t)(arg4), (uintptr_t)(arg5));   \
}

#define DTRACE_PROBE6(name, type1, arg1, type2, arg2,           \
    type3, arg3, type4, arg4, type5, arg5, type6, arg6) {       \
    extern void __dtrace_probe_##name(uintptr_t, uintptr_t,     \
        uintptr_t, uintptr_t, uintptr_t, uintptr_t);        \
    __dtrace_probe_##name((uintptr_t)(arg1), (uintptr_t)(arg2), \
        (uintptr_t)(arg3), (uintptr_t)(arg4), (uintptr_t)(arg5),    \
        (uintptr_t)(arg6));                     \
}

#define DTRACE_PROBE7(name, type1, arg1, type2, arg2, type3, arg3,  \
    type4, arg4, type5, arg5, type6, arg6, type7, arg7) {       \
    extern void __dtrace_probe_##name(uintptr_t, uintptr_t,     \
        uintptr_t, uintptr_t, uintptr_t, uintptr_t, uintptr_t); \
    __dtrace_probe_##name((uintptr_t)(arg1), (uintptr_t)(arg2), \
        (uintptr_t)(arg3), (uintptr_t)(arg4), (uintptr_t)(arg5),    \
        (uintptr_t)(arg6), (uintptr_t)(arg7));          \
}

#define DTRACE_PROBE8(name, type1, arg1, type2, arg2, type3, arg3,  \
    type4, arg4, type5, arg5, type6, arg6, type7, arg7, type8, arg8) {  \
    extern void __dtrace_probe_##name(uintptr_t, uintptr_t,     \
        uintptr_t, uintptr_t, uintptr_t, uintptr_t,         \
        uintptr_t, uintptr_t);                  \
    __dtrace_probe_##name((uintptr_t)(arg1), (uintptr_t)(arg2), \
        (uintptr_t)(arg3), (uintptr_t)(arg4), (uintptr_t)(arg5),    \
        (uintptr_t)(arg6), (uintptr_t)(arg7), (uintptr_t)(arg8));   \
}

#define DTRACE_SCHED(name)                      \
    DTRACE_PROBE(__sched_##name);

#define DTRACE_SCHED1(name, type1, arg1)                \
    DTRACE_PROBE1(__sched_##name, type1, arg1);

#define DTRACE_SCHED2(name, type1, arg1, type2, arg2)           \
    DTRACE_PROBE2(__sched_##name, type1, arg1, type2, arg2);

#define DTRACE_SCHED3(name, type1, arg1, type2, arg2, type3, arg3)  \
    DTRACE_PROBE3(__sched_##name, type1, arg1, type2, arg2, type3, arg3);

#define DTRACE_SCHED4(name, type1, arg1, type2, arg2,           \
    type3, arg3, type4, arg4)                       \
    DTRACE_PROBE4(__sched_##name, type1, arg1, type2, arg2,     \
        type3, arg3, type4, arg4);

#define DTRACE_PROC(name)                       \
    DTRACE_PROBE(__proc_##name);

#define DTRACE_PROC1(name, type1, arg1)                 \
    DTRACE_PROBE1(__proc_##name, type1, arg1);

#define DTRACE_PROC2(name, type1, arg1, type2, arg2)            \
    DTRACE_PROBE2(__proc_##name, type1, arg1, type2, arg2);

#define DTRACE_PROC3(name, type1, arg1, type2, arg2, type3, arg3)   \
    DTRACE_PROBE3(__proc_##name, type1, arg1, type2, arg2, type3, arg3);

#define DTRACE_PROC4(name, type1, arg1, type2, arg2,            \
    type3, arg3, type4, arg4)                       \
    DTRACE_PROBE4(__proc_##name, type1, arg1, type2, arg2,      \
        type3, arg3, type4, arg4);

#define DTRACE_IO(name)                         \
    DTRACE_PROBE(__io_##name);

#define DTRACE_IO1(name, type1, arg1)                   \
    DTRACE_PROBE1(__io_##name, type1, arg1);

#define DTRACE_IO2(name, type1, arg1, type2, arg2)          \
    DTRACE_PROBE2(__io_##name, type1, arg1, type2, arg2);

#define DTRACE_IO3(name, type1, arg1, type2, arg2, type3, arg3) \
    DTRACE_PROBE3(__io_##name, type1, arg1, type2, arg2, type3, arg3);

#define DTRACE_IO4(name, type1, arg1, type2, arg2,          \
    type3, arg3, type4, arg4)                       \
    DTRACE_PROBE4(__io_##name, type1, arg1, type2, arg2,        \
        type3, arg3, type4, arg4);

#define DTRACE_ISCSI_2(name, type1, arg1, type2, arg2)          \
    DTRACE_PROBE2(__iscsi_##name, type1, arg1, type2, arg2);

#define DTRACE_ISCSI_3(name, type1, arg1, type2, arg2, type3, arg3) \
    DTRACE_PROBE3(__iscsi_##name, type1, arg1, type2, arg2, type3, arg3);

#define DTRACE_ISCSI_4(name, type1, arg1, type2, arg2,          \
    type3, arg3, type4, arg4)                       \
    DTRACE_PROBE4(__iscsi_##name, type1, arg1, type2, arg2,     \
        type3, arg3, type4, arg4);

#define DTRACE_ISCSI_5(name, type1, arg1, type2, arg2,          \
    type3, arg3, type4, arg4, type5, arg5)              \
    DTRACE_PROBE5(__iscsi_##name, type1, arg1, type2, arg2,     \
        type3, arg3, type4, arg4, type5, arg5);

#define DTRACE_ISCSI_6(name, type1, arg1, type2, arg2,          \
    type3, arg3, type4, arg4, type5, arg5, type6, arg6)         \
    DTRACE_PROBE6(__iscsi_##name, type1, arg1, type2, arg2,     \
        type3, arg3, type4, arg4, type5, arg5, type6, arg6);

#define DTRACE_ISCSI_7(name, type1, arg1, type2, arg2,          \
    type3, arg3, type4, arg4, type5, arg5, type6, arg6, type7, arg7)    \
    DTRACE_PROBE7(__iscsi_##name, type1, arg1, type2, arg2,     \
        type3, arg3, type4, arg4, type5, arg5, type6, arg6,     \
        type7, arg7);

#define DTRACE_ISCSI_8(name, type1, arg1, type2, arg2,          \
    type3, arg3, type4, arg4, type5, arg5, type6, arg6,         \
    type7, arg7, type8, arg8)                       \
    DTRACE_PROBE8(__iscsi_##name, type1, arg1, type2, arg2,     \
        type3, arg3, type4, arg4, type5, arg5, type6, arg6,     \
        type7, arg7, type8, arg8);

#define DTRACE_NFSV3_3(name, type1, arg1, type2, arg2,          \
    type3, arg3)                            \
    DTRACE_PROBE3(__nfsv3_##name, type1, arg1, type2, arg2,     \
        type3, arg3);
#define DTRACE_NFSV3_4(name, type1, arg1, type2, arg2,          \
    type3, arg3, type4, arg4)                       \
    DTRACE_PROBE4(__nfsv3_##name, type1, arg1, type2, arg2,     \
        type3, arg3, type4, arg4);

#define DTRACE_NFSV4_1(name, type1, arg1) \
    DTRACE_PROBE1(__nfsv4_##name, type1, arg1);

#define DTRACE_NFSV4_2(name, type1, arg1, type2, arg2) \
    DTRACE_PROBE2(__nfsv4_##name, type1, arg1, type2, arg2);

#define DTRACE_NFSV4_3(name, type1, arg1, type2, arg2, type3, arg3) \
    DTRACE_PROBE3(__nfsv4_##name, type1, arg1, type2, arg2, type3, arg3);

#define DTRACE_SMB_1(name, type1, arg1) \
    DTRACE_PROBE1(__smb_##name, type1, arg1);

#define DTRACE_SMB_2(name, type1, arg1, type2, arg2) \
    DTRACE_PROBE2(__smb_##name, type1, arg1, type2, arg2);

#define DTRACE_IP(name)                     \
    DTRACE_PROBE(__ip_##name);

#define DTRACE_IP1(name, type1, arg1)                   \
    DTRACE_PROBE1(__ip_##name, type1, arg1);

#define DTRACE_IP2(name, type1, arg1, type2, arg2)          \
    DTRACE_PROBE2(__ip_##name, type1, arg1, type2, arg2);

#define DTRACE_IP3(name, type1, arg1, type2, arg2, type3, arg3) \
    DTRACE_PROBE3(__ip_##name, type1, arg1, type2, arg2, type3, arg3);

#define DTRACE_IP4(name, type1, arg1, type2, arg2,          \
    type3, arg3, type4, arg4)                       \
    DTRACE_PROBE4(__ip_##name, type1, arg1, type2, arg2,        \
        type3, arg3, type4, arg4);

#define DTRACE_IP5(name, type1, arg1, type2, arg2,          \
    type3, arg3, type4, arg4, type5, arg5)              \
    DTRACE_PROBE5(__ip_##name, type1, arg1, type2, arg2,        \
        type3, arg3, type4, arg4, type5, arg5);

#define DTRACE_IP6(name, type1, arg1, type2, arg2,          \
    type3, arg3, type4, arg4, type5, arg5, type6, arg6)         \
    DTRACE_PROBE6(__ip_##name, type1, arg1, type2, arg2,        \
        type3, arg3, type4, arg4, type5, arg5, type6, arg6);

#define DTRACE_IP7(name, type1, arg1, type2, arg2, type3, arg3,     \
    type4, arg4, type5, arg5, type6, arg6, type7, arg7)         \
    DTRACE_PROBE7(__ip_##name, type1, arg1, type2, arg2,        \
        type3, arg3, type4, arg4, type5, arg5, type6, arg6,     \
        type7, arg7);

#define DTRACE_TCP(name)                        \
    DTRACE_PROBE(__tcp_##name);

#define DTRACE_TCP1(name, type1, arg1)                  \
    DTRACE_PROBE1(__tcp_##name, type1, arg1);

#define DTRACE_TCP2(name, type1, arg1, type2, arg2)         \
    DTRACE_PROBE2(__tcp_##name, type1, arg1, type2, arg2);

#define DTRACE_TCP3(name, type1, arg1, type2, arg2, type3, arg3)    \
    DTRACE_PROBE3(__tcp_##name, type1, arg1, type2, arg2, type3, arg3);

#define DTRACE_TCP4(name, type1, arg1, type2, arg2,         \
    type3, arg3, type4, arg4)                       \
    DTRACE_PROBE4(__tcp_##name, type1, arg1, type2, arg2,       \
        type3, arg3, type4, arg4);

#define DTRACE_TCP5(name, type1, arg1, type2, arg2,         \
    type3, arg3, type4, arg4, type5, arg5)              \
    DTRACE_PROBE5(__tcp_##name, type1, arg1, type2, arg2,       \
        type3, arg3, type4, arg4, type5, arg5);

#define DTRACE_TCP6(name, type1, arg1, type2, arg2,         \
    type3, arg3, type4, arg4, type5, arg5, type6, arg6)         \
    DTRACE_PROBE6(__tcp_##name, type1, arg1, type2, arg2,       \
        type3, arg3, type4, arg4, type5, arg5, type6, arg6);

#define DTRACE_UDP(name)                        \
    DTRACE_PROBE(__udp_##name);

#define DTRACE_UDP1(name, type1, arg1)                  \
    DTRACE_PROBE1(__udp_##name, type1, arg1);

#define DTRACE_UDP2(name, type1, arg1, type2, arg2)         \
    DTRACE_PROBE2(__udp_##name, type1, arg1, type2, arg2);

#define DTRACE_UDP3(name, type1, arg1, type2, arg2, type3, arg3)    \
    DTRACE_PROBE3(__udp_##name, type1, arg1, type2, arg2, type3, arg3);

#define DTRACE_UDP4(name, type1, arg1, type2, arg2,         \
    type3, arg3, type4, arg4)                       \
    DTRACE_PROBE4(__udp_##name, type1, arg1, type2, arg2,       \
        type3, arg3, type4, arg4);

#define DTRACE_UDP5(name, type1, arg1, type2, arg2,         \
    type3, arg3, type4, arg4, type5, arg5)              \
    DTRACE_PROBE5(__udp_##name, type1, arg1, type2, arg2,       \
        type3, arg3, type4, arg4, type5, arg5);


#define DTRACE_SYSEVENT2(name, type1, arg1, type2, arg2)        \
    DTRACE_PROBE2(__sysevent_##name, type1, arg1, type2, arg2);

#define DTRACE_XPV(name)                        \
    DTRACE_PROBE(__xpv_##name);

#define DTRACE_XPV1(name, type1, arg1)                  \
    DTRACE_PROBE1(__xpv_##name, type1, arg1);

#define DTRACE_XPV2(name, type1, arg1, type2, arg2)         \
    DTRACE_PROBE2(__xpv_##name, type1, arg1, type2, arg2);

#define DTRACE_XPV3(name, type1, arg1, type2, arg2, type3, arg3)    \
    DTRACE_PROBE3(__xpv_##name, type1, arg1, type2, arg2, type3, arg3);

#define DTRACE_XPV4(name, type1, arg1, type2, arg2, type3, arg3,    \
        type4, arg4)                        \
    DTRACE_PROBE4(__xpv_##name, type1, arg1, type2, arg2,       \
        type3, arg3, type4, arg4);

#define DTRACE_FC_1(name, type1, arg1) \
    DTRACE_PROBE1(__fc_##name, type1, arg1);

#define DTRACE_FC_2(name, type1, arg1, type2, arg2) \
    DTRACE_PROBE2(__fc_##name, type1, arg1, type2, arg2);

#define DTRACE_FC_3(name, type1, arg1, type2, arg2, type3, arg3) \
    DTRACE_PROBE3(__fc_##name, type1, arg1, type2, arg2, type3, arg3);

#define DTRACE_FC_4(name, type1, arg1, type2, arg2, type3, arg3, type4, arg4) \
    DTRACE_PROBE4(__fc_##name, type1, arg1, type2, arg2, type3, arg3, \
        type4, arg4);

#define DTRACE_FC_5(name, type1, arg1, type2, arg2, type3, arg3,    \
        type4, arg4, type5, arg5)                   \
    DTRACE_PROBE5(__fc_##name, type1, arg1, type2, arg2, type3, arg3, \
        type4, arg4, type5, arg5);

#define DTRACE_SRP_1(name, type1, arg1)                 \
    DTRACE_PROBE1(__srp_##name, type1, arg1);

#define DTRACE_SRP_2(name, type1, arg1, type2, arg2)            \
    DTRACE_PROBE2(__srp_##name, type1, arg1, type2, arg2);

#define DTRACE_SRP_3(name, type1, arg1, type2, arg2, type3, arg3)   \
    DTRACE_PROBE3(__srp_##name, type1, arg1, type2, arg2, type3, arg3);

#define DTRACE_SRP_4(name, type1, arg1, type2, arg2, type3, arg3,   \
        type4, arg4)                        \
    DTRACE_PROBE4(__srp_##name, type1, arg1, type2, arg2,       \
        type3, arg3, type4, arg4);

#define DTRACE_SRP_5(name, type1, arg1, type2, arg2, type3, arg3,   \
        type4, arg4, type5, arg5)                   \
    DTRACE_PROBE5(__srp_##name, type1, arg1, type2, arg2,       \
        type3, arg3, type4, arg4, type5, arg5);

#define DTRACE_SRP_6(name, type1, arg1, type2, arg2, type3, arg3,   \
        type4, arg4, type5, arg5, type6, arg6)          \
    DTRACE_PROBE6(__srp_##name, type1, arg1, type2, arg2,       \
        type3, arg3, type4, arg4, type5, arg5, type6, arg6);

#define DTRACE_SRP_7(name, type1, arg1, type2, arg2, type3, arg3,   \
        type4, arg4, type5, arg5, type6, arg6, type7, arg7)     \
    DTRACE_PROBE7(__srp_##name, type1, arg1, type2, arg2,       \
        type3, arg3, type4, arg4, type5, arg5, type6, arg6, type7, arg7);

#define DTRACE_SRP_8(name, type1, arg1, type2, arg2, type3, arg3,   \
        type4, arg4, type5, arg5, type6, arg6, type7, arg7, type8, arg8) \
    DTRACE_PROBE8(__srp_##name, type1, arg1, type2, arg2,       \
        type3, arg3, type4, arg4, type5, arg5, type6, arg6,     \
        type7, arg7, type8, arg8);

/*
 * The set-error SDT probe is extra static, in that we declare its fake
 * function literally, rather than with the DTRACE_PROBE1() macro.  This is
 * necessary so that SET_ERROR() can evaluate to a value, which wouldn't
 * be possible if it required multiple statements (to declare the function
 * and then call it).
 *
 * SET_ERROR() uses the comma operator so that it can be used without much
 * additional code.  For example, "return (EINVAL);" becomes
 * "return (SET_ERROR(EINVAL));".  Note that the argument will be evaluated
 * twice, so it should not have side effects (e.g. something like:
 * "return (SET_ERROR(log_error(EINVAL, info)));" would log the error twice).
 */
extern void __dtrace_probe_set__error(uintptr_t);
#define SET_ERROR(err) (__dtrace_probe_set__error(err), err)

#endif /* _KERNEL */

extern const char *sdt_prefix;

typedef struct sdt_probedesc {
    char            *sdpd_name; /* name of this probe */
    unsigned long       sdpd_offset;    /* offset of call in text */
    struct sdt_probedesc    *sdpd_next; /* next static probe */
} sdt_probedesc_t;

#ifdef  __cplusplus
}
#endif

#endif  /* _SYS_SDT_H */