bsd/sys/fasttrap_impl.h

   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
  22 /*
  23  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
  24  * Use is subject to license terms.
  25  */
  26
  27 #ifndef _FASTTRAP_IMPL_H
  28 #define _FASTTRAP_IMPL_H
  29
  30 /*
  31  * #pragma ident        "@(#)fasttrap_impl.h    1.12    06/06/12 SMI"
  32  */
  33
  34 #include <sys/types.h>
  35 #include <sys/dtrace.h>
  36 #include <sys/proc.h>
  37 #include <sys/user.h>
  38 #include <sys/fasttrap.h>
  39 #include <sys/fasttrap_isa.h>
  40
  41 #define proc_t struct proc
  42
  43 #ifdef  __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /*
  48  * Fasttrap Providers, Probes and Tracepoints
  49  *
  50  * Each Solaris process can have multiple providers -- the pid provider as
  51  * well as any number of user-level statically defined tracing (USDT)
  52  * providers. Those providers are each represented by a fasttrap_provider_t.
  53  * All providers for a given process have a pointer to a shared
  54  * fasttrap_proc_t. The fasttrap_proc_t has two states: active or defunct.
  55  * It becomes defunct when the process performs an exit or an exec.
  56  *
  57  * Each probe is represented by a fasttrap_probe_t which has a pointer to
  58  * its associated provider as well as a list of fasttrap_id_tp_t structures
  59  * which are tuples combining a fasttrap_id_t and a fasttrap_tracepoint_t.
  60  * A fasttrap_tracepoint_t represents the actual point of instrumentation
  61  * and it contains two lists of fasttrap_id_t structures (to be fired pre-
  62  * and post-instruction emulation) that identify the probes attached to the
  63  * tracepoint. Tracepoints also have a pointer to the fasttrap_proc_t for the
  64  * process they trace which is used when looking up a tracepoint both at
  65  * probe fire time and when enabling and disabling probes.
  66  *
  67  * It's important to note that probes are preallocated with the necessary
  68  * number of tracepoints, but that tracepoints can be shared by probes and
  69  * swapped between probes. If a probe's preallocated tracepoint is enabled
  70  * (and, therefore, the associated probe is enabled), and that probe is
  71  * then disabled, ownership of that tracepoint may be exchanged for an
  72  * unused tracepoint belonging to another probe that was attached to the
  73  * enabled tracepoint.
  74  */
  75
  76 /*
  77  * APPLE NOTE: All kmutex_t's have been converted to lck_mtx_t
  78  */
  79
  80 typedef struct fasttrap_proc {
  81         pid_t ftpc_pid;                         /* process ID for this proc */
  82         uint_t ftpc_defunct;                    /* denotes a lame duck proc */
  83         uint64_t ftpc_count;                    /* reference count */
  84         lck_mtx_t ftpc_mtx;                     /* proc lock */
  85         struct fasttrap_proc *ftpc_next;        /* next proc in hash chain */
  86 } fasttrap_proc_t;
  87
  88 typedef struct fasttrap_provider {
  89         pid_t ftp_pid;                          /* process ID for this prov */
  90         fasttrap_provider_type_t ftp_provider_type;     /* type of this provider (usdt, pid, objc, oneshot) */
  91         char ftp_name[DTRACE_PROVNAMELEN];      /* prov name (w/o the pid) */
  92         dtrace_provider_id_t ftp_provid;        /* DTrace provider handle */
  93         uint_t ftp_marked;                      /* mark for possible removal */
  94         uint_t ftp_retired;                     /* mark when retired */
  95         lck_mtx_t ftp_mtx;                      /* provider lock */
  96         lck_mtx_t ftp_cmtx;                     /* lock on creating probes */
  97         uint64_t ftp_rcount;                    /* enabled probes ref count */
  98         uint64_t ftp_ccount;                    /* consumers creating probes */
  99         uint64_t ftp_mcount;                    /* meta provider count */
 100         fasttrap_proc_t *ftp_proc;              /* shared proc for all provs */
 101         struct fasttrap_provider *ftp_next;     /* next prov in hash chain */
 102 } fasttrap_provider_t;
 103
 104 typedef struct fasttrap_id fasttrap_id_t;
 105 typedef struct fasttrap_probe fasttrap_probe_t;
 106 typedef struct fasttrap_tracepoint fasttrap_tracepoint_t;
 107
 108 struct fasttrap_id {
 109         fasttrap_probe_t *fti_probe;            /* referrring probe */
 110         fasttrap_id_t *fti_next;                /* enabled probe list on tp */
 111         fasttrap_probe_type_t fti_ptype;        /* probe type */
 112 };
 113
 114 typedef struct fasttrap_id_tp {
 115         fasttrap_id_t fit_id;
 116         fasttrap_tracepoint_t *fit_tp;
 117 } fasttrap_id_tp_t;
 118
 119 struct fasttrap_probe {
 120         dtrace_id_t ftp_id;                     /* DTrace probe identifier */
 121         pid_t ftp_pid;                          /* pid for this probe */
 122         fasttrap_provider_t *ftp_prov;          /* this probe's provider */
 123         user_addr_t ftp_faddr;                  /* associated function's addr */
 124         size_t ftp_fsize;                       /* associated function's size */
 125         uint64_t ftp_gen;                       /* modification generation */
 126         uint64_t ftp_ntps;                      /* number of tracepoints */
 127         uint8_t *ftp_argmap;                    /* native to translated args */
 128         uint8_t ftp_nargs;                      /* translated argument count */
 129         uint8_t ftp_enabled;                    /* is this probe enabled */
 130         char *ftp_xtypes;                       /* translated types index */
 131         char *ftp_ntypes;                       /* native types index */
 132         fasttrap_id_tp_t ftp_tps[1];            /* flexible array */
 133 };
 134
 135 #define FASTTRAP_ID_INDEX(id)   \
 136 ((fasttrap_id_tp_t *)(((char *)(id) - offsetof(fasttrap_id_tp_t, fit_id))) - \
 137 &(id)->fti_probe->ftp_tps[0])
 138
 139 struct fasttrap_tracepoint {
 140         fasttrap_proc_t *ftt_proc;              /* associated process struct */
 141         user_addr_t ftt_pc;                     /* address of tracepoint */
 142         pid_t ftt_pid;                          /* pid of tracepoint */
 143         fasttrap_machtp_t ftt_mtp;              /* ISA-specific portion */
 144         fasttrap_id_t *ftt_ids;                 /* NULL-terminated list */
 145         fasttrap_id_t *ftt_retids;              /* NULL-terminated list */
 146         fasttrap_tracepoint_t *ftt_next;        /* link in global hash */
 147 };
 148
 149 typedef struct fasttrap_bucket {
 150         lck_mtx_t ftb_mtx;                      /* bucket lock */
 151         void *ftb_data;                         /* data payload */
 152
 153         uint8_t ftb_pad[64 - sizeof (lck_mtx_t) - sizeof (void *)];
 154 } fasttrap_bucket_t;
 155
 156 typedef struct fasttrap_hash {
 157         ulong_t fth_nent;                       /* power-of-2 num. of entries */
 158         ulong_t fth_mask;                       /* fth_nent - 1 */
 159         fasttrap_bucket_t *fth_table;           /* array of buckets */
 160 } fasttrap_hash_t;
 161
 162 /*
 163  * If at some future point these assembly functions become observable by
 164  * DTrace, then these defines should become separate functions so that the
 165  * fasttrap provider doesn't trigger probes during internal operations.
 166  */
 167 #define fasttrap_copyout        copyout
 168 #define fasttrap_fuword32       fuword32
 169 #define fasttrap_suword32       suword32
 170
 171 #if defined __APPLE__
 172 /*
 173  * xnu runs in 32 bit mode even when supporting 64 bit processes. We need
 174  * to make size explicit.
 175  */
 176 #define fasttrap_fuword64       fuword64
 177 #define fasttrap_suword64       suword64
 178 #define fasttrap_fuword64_noerr fuword64_noerr
 179 #define fasttrap_fuword32_noerr fuword32_noerr
 180 #else
 181 #define fasttrap_fulword        fulword
 182 #define fasttrap_sulword        sulword
 183 #endif
 184
 185 extern void fasttrap_sigtrap(proc_t *, uthread_t, user_addr_t);
 186
 187 extern dtrace_id_t              fasttrap_probe_id;
 188 extern fasttrap_hash_t          fasttrap_tpoints;
 189
 190 #define FASTTRAP_TPOINTS_INDEX(pid, pc) \
 191         (((pc) / sizeof (fasttrap_instr_t) + (pid)) & fasttrap_tpoints.fth_mask)
 192
 193 /*
 194  * Must be implemented by fasttrap_isa.c
 195  */
 196 extern int fasttrap_tracepoint_init(proc_t *, fasttrap_tracepoint_t *,
 197     user_addr_t, fasttrap_probe_type_t);
 198 extern int fasttrap_tracepoint_install(proc_t *, fasttrap_tracepoint_t *);
 199 extern int fasttrap_tracepoint_remove(proc_t *, fasttrap_tracepoint_t *);
 200
 201 #if defined (__ppc__) || defined (__ppc64__)
 202 extern int fasttrap_pid_probe(ppc_saved_state_t *regs);
 203 extern int fasttrap_return_probe(ppc_saved_state_t* regs);
 204 #elif defined (__i386__) || defined(__x86_64__)
 205 extern int fasttrap_pid_probe(x86_saved_state_t *regs);
 206 extern int fasttrap_return_probe(x86_saved_state_t* regs);
 207 #else
 208 #error architecture not supported
 209 #endif
 210
 211 extern uint64_t fasttrap_pid_getarg(void *, dtrace_id_t, void *, int, int);
 212 extern uint64_t fasttrap_usdt_getarg(void *, dtrace_id_t, void *, int, int);
 213
 214 #ifdef  __cplusplus
 215 }
 216 #endif
 217
 218 #undef proc_t
 219
 220 #endif  /* _FASTTRAP_IMPL_H */