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 (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 *
21 * Portions Copyright 2006-2008 John Birrell jb@freebsd.org
22 *
23 * $FreeBSD$
24 *
25 */
26
27/*
28 * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
29 * Use is subject to license terms.
30 */
31
32#ifndef _FBT_H_
33#define _FBT_H_
34
35#include "fbt_isa.h"
36
37/*
38 * fbt_probe is a bit of a misnomer.  One of these structures is created for
39 * each trace point of an FBT probe.  A probe might have multiple trace points
40 * (e.g., a function with multiple return instructions), and different probes
41 * might have a trace point at the same address (e.g., GNU ifuncs).
42 */
43typedef struct fbt_probe {
44	struct fbt_probe *fbtp_hashnext;	/* global hash table linkage */
45	struct fbt_probe *fbtp_tracenext;	/* next probe for tracepoint */
46	struct fbt_probe *fbtp_probenext;	/* next tracepoint for probe */
47	int		fbtp_enabled;
48	fbt_patchval_t  *fbtp_patchpoint;
49	int8_t		fbtp_rval;
50	fbt_patchval_t	fbtp_patchval;
51	fbt_patchval_t	fbtp_savedval;
52	uintptr_t	fbtp_roffset;
53	dtrace_id_t	fbtp_id;
54	const char	*fbtp_name;
55	modctl_t	*fbtp_ctl;
56	int		fbtp_loadcnt;
57	int		fbtp_symindx;
58} fbt_probe_t;
59
60struct linker_file;
61struct linker_symval;
62struct trapframe;
63
64int	fbt_invop(uintptr_t, struct trapframe *, uintptr_t);
65void	fbt_patch_tracepoint(fbt_probe_t *, fbt_patchval_t);
66int	fbt_provide_module_function(struct linker_file *, int,
67	    struct linker_symval *, void *);
68int	fbt_excluded(const char *name);
69
70extern dtrace_provider_id_t	fbt_id;
71extern fbt_probe_t		**fbt_probetab;
72extern int			fbt_probetab_mask;
73
74#define	FBT_ADDR2NDX(addr)	((((uintptr_t)(addr)) >> 4) & fbt_probetab_mask)
75#define	FBT_PROBETAB_SIZE	0x8000		/* 32k entries -- 128K total */
76
77#ifdef MALLOC_DECLARE
78MALLOC_DECLARE(M_FBT);
79#endif
80
81#endif
82