xnu-4903.270.47.tar.gz

[apple/xnu.git] / bsd / sys / sdt_impl.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (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 2004 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef _SDT_IMPL_H
#define _SDT_IMPL_H

/*
 * This file has been created by splitting up the original DTrace sdt.h
 * header. Keep the pragma notice here to allow version tracking.
 */

/* #pragma ident	"@(#)sdt.h	1.7	05/06/08 SMI" */

#ifdef  __cplusplus
extern "C" {
#endif

extern const char *sdt_prefix;

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

#ifdef  __cplusplus
}
#endif

/* #pragma ident	"@(#)sdt_impl.h	1.3	05/06/08 SMI" */

#ifdef  __cplusplus
extern "C" {
#endif

#include <sys/dtrace.h>

struct module {
	int sdt_nprobes;
	sdt_probedesc_t *sdt_probes;
};

extern int sdt_invop(uintptr_t, uintptr_t *, uintptr_t);
extern uint64_t sdt_getarg(void *, dtrace_id_t, void *, int, int);

void sdt_provide_module(void *, struct modctl *);
void sdt_early_init(void);
void sdt_init(void);

extern int          sdt_probetab_size;
extern int          sdt_probetab_mask;
#define SDT_ADDR2NDX(addr)  ((((uintptr_t)(addr)) >> 4) & sdt_probetab_mask)


#if defined(__x86_64__)
typedef uint8_t sdt_instr_t;
#elif defined(__arm__)
typedef uint16_t sdt_instr_t;
#elif defined(__arm64__)
typedef uint32_t sdt_instr_t;
#else
#error Unknown implementation
#endif

typedef struct sdt_provider {
	const char                      *sdtp_name;     /* name of provider */
	const char                      *sdtp_prefix;   /* prefix for probe names */
	dtrace_pattr_t          *sdtp_attr;     /* stability attributes */
	dtrace_provider_id_t    sdtp_id;        /* provider ID */
} sdt_provider_t;

extern sdt_provider_t sdt_providers[];          /* array of providers */

typedef struct sdt_probe {
	sdt_provider_t  *sdp_provider;          /* provider */
	char            *sdp_name;              /* name of probe */
	int             sdp_namelen;            /* length of allocated name */
	dtrace_id_t     sdp_id;                 /* probe ID */
	struct modctl   *sdp_ctl;               /* modctl for module */
	int             sdp_loadcnt;            /* load count for module */
	int             sdp_primary;            /* non-zero if primary mod */
	sdt_instr_t     *sdp_patchpoint;        /* patch point */
	sdt_instr_t     sdp_patchval;           /* instruction to patch */
	sdt_instr_t     sdp_savedval;           /* saved instruction value */
	struct sdt_probe *sdp_next;             /* next probe */
	struct sdt_probe *sdp_hashnext;         /* next on hash */
} sdt_probe_t;

typedef struct sdt_argdesc {
	const char *sda_provider;               /* provider for arg */
	const char *sda_name;                   /* name of probe */
	const int sda_ndx;                      /* argument index */
	const int sda_mapping;                  /* mapping of argument */
	const char *sda_native;                 /* native type of argument */
	const char *sda_xlate;                  /* translated type of arg */
} sdt_argdesc_t;

extern void sdt_getargdesc(void *, dtrace_id_t, void *, dtrace_argdesc_t *);

#ifdef  __cplusplus
}
#endif

#endif  /* _SDT_IMPL_H */