[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 */
#if defined(__APPLE__)
	char			*sdpd_func;	
#endif /* __APPLE__ */
	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);
#if defined (__APPLE__)
extern uint64_t sdt_getarg(void *, dtrace_id_t, void *, int, int);
#endif /* __APPLE__ */    

void sdt_provide_module(void *, struct modctl *);
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;
#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 */
Commit	Line	Data
2d21ac55 A	1	/*
	2	* CDDL HEADER START
	3	*
	4	* The contents of this file are subject to the terms of the
	5	* Common Development and Distribution License, Version 1.0 only
	6	* (the "License"). You may not use this file except in compliance
	7	* with the License.
	8	*
	9	* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
	10	* or http://www.opensolaris.org/os/licensing.
	11	* See the License for the specific language governing permissions
	12	* and limitations under the License.
	13	*
	14	* When distributing Covered Code, include this CDDL HEADER in each
	15	* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
	16	* If applicable, add the following below this CDDL HEADER, with the
	17	* fields enclosed by brackets "[]" replaced with your own identifying
	18	* information: Portions Copyright [yyyy] [name of copyright owner]
	19	*
	20	* CDDL HEADER END
	21	*/
	22	/*
	23	* Copyright 2004 Sun Microsystems, Inc. All rights reserved.
	24	* Use is subject to license terms.
	25	*/
	26
	27	#ifndef _SDT_IMPL_H
	28	#define _SDT_IMPL_H
	29
	30	/*
	31	* This file has been created by splitting up the original DTrace sdt.h
	32	* header. Keep the pragma notice here to allow version tracking.
	33	*/
	34
	35	/* #pragma ident "@(#)sdt.h 1.7 05/06/08 SMI" */
	36
	37	#ifdef __cplusplus
	38	extern "C" {
	39	#endif
	40
	41	extern const char *sdt_prefix;
	42
	43	typedef struct sdt_probedesc {
	44	char sdpd_name; / name of this probe */
	45	#if defined(__APPLE__)
	46	char *sdpd_func;
	47	#endif /* __APPLE__ */
	48	unsigned long sdpd_offset; /* offset of call in text */
	49	struct sdt_probedesc sdpd_next; / next static probe */
	50	} sdt_probedesc_t;
	51
	52	#ifdef __cplusplus
	53	}
	54	#endif
	55
	56	/* #pragma ident "@(#)sdt_impl.h 1.3 05/06/08 SMI" */
	57
	58	#ifdef __cplusplus
	59	extern "C" {
	60	#endif
	61
	62	#include <sys/dtrace.h>
	63
2d21ac55 A	64	struct module {
	65	int sdt_nprobes;
	66	sdt_probedesc_t *sdt_probes;
	67	};
	68
	69	extern int sdt_invop(uintptr_t, uintptr_t *, uintptr_t);
6d2010ae A	70	#if defined (__APPLE__)
	71	extern uint64_t sdt_getarg(void , dtrace_id_t, void , int, int);
	72	#endif /* __APPLE__ */
2d21ac55 A	73
	74	void sdt_provide_module(void , struct modctl );
	75	void sdt_init(void);
	76
	77	extern int sdt_probetab_size;
	78	extern int sdt_probetab_mask;
	79	#define SDT_ADDR2NDX(addr) ((((uintptr_t)(addr)) >> 4) & sdt_probetab_mask)
	80
	81
39236c6e	82	#if defined(__x86_64__)
2d21ac55	83	typedef uint8_t sdt_instr_t;
2d21ac55 A	84	#else
	85	#error Unknown implementation
	86	#endif
2d21ac55 A	87
	88	typedef struct sdt_provider {
	89	const char sdtp_name; / name of provider */
	90	const char sdtp_prefix; / prefix for probe names */
	91	dtrace_pattr_t sdtp_attr; / stability attributes */
	92	dtrace_provider_id_t sdtp_id; /* provider ID */
	93	} sdt_provider_t;
	94
	95	extern sdt_provider_t sdt_providers[]; /* array of providers */
	96
	97	typedef struct sdt_probe {
	98	sdt_provider_t sdp_provider; / provider */
	99	char sdp_name; / name of probe */
	100	int sdp_namelen; /* length of allocated name */
	101	dtrace_id_t sdp_id; /* probe ID */
	102	struct modctl sdp_ctl; / modctl for module */
	103	int sdp_loadcnt; /* load count for module */
	104	int sdp_primary; /* non-zero if primary mod */
	105	sdt_instr_t sdp_patchpoint; / patch point */
	106	sdt_instr_t sdp_patchval; /* instruction to patch */
	107	sdt_instr_t sdp_savedval; /* saved instruction value */
	108	struct sdt_probe sdp_next; / next probe */
	109	struct sdt_probe sdp_hashnext; / next on hash */
	110	} sdt_probe_t;
	111
	112	typedef struct sdt_argdesc {
	113	const char sda_provider; / provider for arg */
	114	const char sda_name; / name of probe */
	115	const int sda_ndx; /* argument index */
	116	const int sda_mapping; /* mapping of argument */
	117	const char sda_native; / native type of argument */
	118	const char sda_xlate; / translated type of arg */
	119	} sdt_argdesc_t;
	120
	121	extern void sdt_getargdesc(void , dtrace_id_t, void , dtrace_argdesc_t *);
	122
	123	#ifdef __cplusplus
	124	}
	125	#endif
	126
	127	#endif /* _SDT_IMPL_H */