]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/dev/dtrace/sdt.c
xnu-2782.1.97.tar.gz
[apple/xnu.git] / bsd / dev / dtrace / sdt.c
index 725ab5585ddaea888afa79431417206c7edc0478..610de106b6ea4e55fbb7469e4baa3e5a16746f4f 100644 (file)
@@ -19,7 +19,7 @@
  * CDDL HEADER END
  */
 /*
- * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
+ * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  * Use is subject to license terms.
  */
 
 #include <sys/fcntl.h>
 #include <miscfs/devfs/devfs.h>
 
+
 #include <sys/dtrace.h>
 #include <sys/dtrace_impl.h>
 
 #include <sys/dtrace_glue.h>
 
 #include <sys/sdt_impl.h>
+extern int dtrace_kernel_symbol_mode;
 
+/* #include <machine/trap.h */
 struct savearea_t; /* Used anonymously */
-typedef kern_return_t (*perfCallback)(int, struct savearea_t *, int, int);
-
-#if defined (__ppc__) || defined (__ppc64__)
-extern perfCallback tempDTraceTrapHook, tempDTraceIntHook;
-extern kern_return_t fbt_perfCallback(int, struct savearea_t *, int, int);
-extern kern_return_t fbt_perfIntCallback(int, struct savearea_t *, int, int);
 
-#define        SDT_PATCHVAL    0x7c810808
-#define SDT_AFRAMES     6
-#elif defined(__i386__) || defined(__x86_64__)
+#if   defined(__x86_64__)
+typedef kern_return_t (*perfCallback)(int, struct savearea_t *, uintptr_t *, int);
 extern perfCallback tempDTraceTrapHook;
-extern kern_return_t fbt_perfCallback(int, struct savearea_t *, int, int);
-
+extern kern_return_t fbt_perfCallback(int, struct savearea_t *, uintptr_t *, int);
 #define        SDT_PATCHVAL    0xf0
 #define        SDT_AFRAMES             6
 #else
@@ -69,11 +64,7 @@ extern kern_return_t fbt_perfCallback(int, struct savearea_t *, int, int);
 
 #define        SDT_PROBETAB_SIZE       0x1000          /* 4k entries -- 16K total */
 
-#if defined(__x86_64__)
-#define DTRACE_PROBE_PREFIX "_dtrace_probeDOLLAR"
-#else
 #define DTRACE_PROBE_PREFIX "_dtrace_probe$"
-#endif
 
 static dev_info_t              *sdt_devi;
 static int                     sdt_verbose = 0;
@@ -86,7 +77,7 @@ static void
 __sdt_provide_module(void *arg, struct modctl *ctl)
 {
 #pragma unused(arg)
-       struct module *mp = (struct module *)ctl->address;
+       struct module *mp = (struct module *)ctl->mod_address;
        char *modname = ctl->mod_modname;
        sdt_probedesc_t *sdpd;
        sdt_probe_t *sdp, *old;
@@ -163,6 +154,10 @@ __sdt_provide_module(void *arg, struct modctl *ctl)
                        mp->sdt_nprobes++;
                }
 
+#if 0          
+               printf ("__sdt_provide_module:  sdpd=0x%p  sdp=0x%p  name=%s, id=%d\n", sdpd, sdp, nname, sdp->sdp_id);
+#endif         
+
                sdp->sdp_hashnext =
                    sdt_probetab[SDT_ADDR2NDX(sdpd->sdpd_offset)];
                sdt_probetab[SDT_ADDR2NDX(sdpd->sdpd_offset)] = sdp;
@@ -180,7 +175,11 @@ sdt_destroy(void *arg, dtrace_id_t id, void *parg)
 #pragma unused(arg,id)
        sdt_probe_t *sdp = parg, *old, *last, *hash;
        int ndx;
+
 #if !defined(__APPLE__)
+       /*
+        * APPLE NOTE:  sdt probes for kexts not yet implemented
+        */
        struct modctl *ctl = sdp->sdp_ctl;
 
        if (ctl != NULL && ctl->mod_loadcnt == sdp->sdp_loadcnt) {
@@ -220,14 +219,13 @@ sdt_destroy(void *arg, dtrace_id_t id, void *parg)
 }
 
 /*ARGSUSED*/
-static void
+static int
 sdt_enable(void *arg, dtrace_id_t id, void *parg)
 {
 #pragma unused(arg,id)
        sdt_probe_t *sdp = parg;
        struct modctl *ctl = sdp->sdp_ctl;
 
-#if !defined(__APPLE__)
        ctl->mod_nenabled++;
 
        /*
@@ -256,20 +254,7 @@ sdt_enable(void *arg, dtrace_id_t id, void *parg)
                }
                goto err;
        }
-#endif /* __APPLE__ */
 
-#if defined (__ppc__) || defined (__ppc64__)
-       dtrace_casptr(&tempDTraceIntHook, NULL, fbt_perfIntCallback);
-       if (tempDTraceIntHook != (perfCallback)fbt_perfIntCallback) {
-               if (sdt_verbose) {
-                       cmn_err(CE_NOTE, "sdt_enable is failing for probe %s "
-                           "in module %s: tempDTraceIntHook already occupied.",
-                           sdp->sdp_name, ctl->mod_modname);
-               }
-               return;
-       }
-#endif
-       
        dtrace_casptr(&tempDTraceTrapHook, NULL, fbt_perfCallback);
        if (tempDTraceTrapHook != (perfCallback)fbt_perfCallback) {
                if (sdt_verbose) {
@@ -277,7 +262,7 @@ sdt_enable(void *arg, dtrace_id_t id, void *parg)
                            "in module %s: tempDTraceTrapHook already occupied.",
                            sdp->sdp_name, ctl->mod_modname);
                }
-               return;
+               return (0);
        }
 
        while (sdp != NULL) {
@@ -285,10 +270,9 @@ sdt_enable(void *arg, dtrace_id_t id, void *parg)
                                       (vm_size_t)sizeof(sdp->sdp_patchval));
                sdp = sdp->sdp_next;
        }
-#if !defined(__APPLE__)
+
 err:
-#endif /* __APPLE__ */
-       ;
+       return (0);
 }
 
 /*ARGSUSED*/
@@ -297,14 +281,12 @@ sdt_disable(void *arg, dtrace_id_t id, void *parg)
 {
 #pragma unused(arg,id)
        sdt_probe_t *sdp = parg;
-#if !defined(__APPLE__)
        struct modctl *ctl = sdp->sdp_ctl;
 
        ctl->mod_nenabled--;
 
        if (!ctl->mod_loaded || ctl->mod_loadcnt != sdp->sdp_loadcnt)
                goto err;
-#endif /* __APPLE__ */
 
        while (sdp != NULL) {
                (void)ml_nofault_copy( (vm_offset_t)&sdp->sdp_savedval, (vm_offset_t)sdp->sdp_patchpoint, 
@@ -312,19 +294,10 @@ sdt_disable(void *arg, dtrace_id_t id, void *parg)
                sdp = sdp->sdp_next;
        }
 
-#if !defined(__APPLE__)
 err:
-#endif /* __APPLE__ */ 
        ;
 }
 
-static uint64_t
-sdt_getarg(void *arg, dtrace_id_t id, void *parg, int argno, int aframes)
-{
-#pragma unused(arg,id,parg)    /* __APPLE__ */
-       return dtrace_getarg(argno, aframes);
-}
-
 static dtrace_pops_t sdt_pops = {
        NULL,
        sdt_provide_module,
@@ -375,6 +348,9 @@ sdt_attach(dev_info_t *devi, ddi_attach_cmd_t cmd)
        return (DDI_SUCCESS);
 }
 
+/*
+ * APPLE NOTE:  sdt_detach not implemented
+ */
 #if !defined(__APPLE__)
 /*ARGSUSED*/
 static int
@@ -407,100 +383,8 @@ sdt_detach(dev_info_t *dip, ddi_detach_cmd_t cmd)
 
        return (DDI_SUCCESS);
 }
+#endif /* __APPLE__ */
 
-/*ARGSUSED*/
-static int
-sdt_info(dev_info_t *dip, ddi_info_cmd_t infocmd, void *arg, void **result)
-{
-       int error;
-
-       switch (infocmd) {
-       case DDI_INFO_DEVT2DEVINFO:
-               *result = (void *)sdt_devi;
-               error = DDI_SUCCESS;
-               break;
-       case DDI_INFO_DEVT2INSTANCE:
-               *result = (void *)0;
-               error = DDI_SUCCESS;
-               break;
-       default:
-               error = DDI_FAILURE;
-       }
-       return (error);
-}
-
-/*ARGSUSED*/
-static int
-sdt_open(dev_t *devp, int flag, int otyp, cred_t *cred_p)
-{
-       return (0);
-}
-
-static struct cb_ops sdt_cb_ops = {
-       sdt_open,               /* open */
-       nodev,                  /* close */
-       nulldev,                /* strategy */
-       nulldev,                /* print */
-       nodev,                  /* dump */
-       nodev,                  /* read */
-       nodev,                  /* write */
-       nodev,                  /* ioctl */
-       nodev,                  /* devmap */
-       nodev,                  /* mmap */
-       nodev,                  /* segmap */
-       nochpoll,               /* poll */
-       ddi_prop_op,            /* cb_prop_op */
-       0,                      /* streamtab  */
-       D_NEW | D_MP            /* Driver compatibility flag */
-};
-
-static struct dev_ops sdt_ops = {
-       DEVO_REV,               /* devo_rev, */
-       0,                      /* refcnt  */
-       sdt_info,               /* get_dev_info */
-       nulldev,                /* identify */
-       nulldev,                /* probe */
-       sdt_attach,             /* attach */
-       sdt_detach,             /* detach */
-       nodev,                  /* reset */
-       &sdt_cb_ops,            /* driver operations */
-       NULL,                   /* bus operations */
-       nodev                   /* dev power */
-};
-
-/*
- * Module linkage information for the kernel.
- */
-static struct modldrv modldrv = {
-       &mod_driverops,         /* module type (this is a pseudo driver) */
-       "Statically Defined Tracing",   /* name of module */
-       &sdt_ops,               /* driver ops */
-};
-
-static struct modlinkage modlinkage = {
-       MODREV_1,
-       (void *)&modldrv,
-       NULL
-};
-
-int
-_init(void)
-{
-       return (mod_install(&modlinkage));
-}
-
-int
-_info(struct modinfo *modinfop)
-{
-       return (mod_info(&modlinkage, modinfop));
-}
-
-int
-_fini(void)
-{
-       return (mod_remove(&modlinkage));
-}
-#else
 d_open_t _sdt_open;
 
 int _sdt_open(dev_t dev, int flags, int devtype, struct proc *p)
@@ -540,14 +424,6 @@ static struct module g_sdt_mach_module;
 #include <mach-o/nlist.h>
 #include <libkern/kernel_mach_header.h>
 
-#if defined(__LP64__)
-#define KERNEL_MAGIC MH_MAGIC_64
-typedef struct nlist_64 kernel_nlist_t;
-#else
-#define KERNEL_MAGIC MH_MAGIC
-typedef struct nlist kernel_nlist_t;
-#endif
-
 void sdt_init( void )
 {
        if (0 == gSDTInited)
@@ -560,108 +436,122 @@ void sdt_init( void )
                        return;
                }
 
-               if (KERNEL_MAGIC != _mh_execute_header.magic) {
-               g_sdt_kernctl.address = (vm_address_t)NULL;
-               g_sdt_kernctl.size = 0;
+               if (MH_MAGIC_KERNEL != _mh_execute_header.magic) {
+                       g_sdt_kernctl.mod_address = (vm_address_t)NULL;
+                       g_sdt_kernctl.mod_size = 0;
                } else {
-               kernel_mach_header_t        *mh;
-               struct load_command         *cmd;
-               kernel_segment_command_t    *orig_ts = NULL, *orig_le = NULL;
-               struct symtab_command       *orig_st = NULL;
-               kernel_nlist_t              *sym = NULL;
-               char                        *strings;
-               unsigned int                i;
-
-               g_sdt_mach_module.sdt_nprobes = 0;
-               g_sdt_mach_module.sdt_probes = NULL;
-
-               g_sdt_kernctl.address = (vm_address_t)&g_sdt_mach_module;
-               g_sdt_kernctl.size = 0;
-               strncpy((char *)&(g_sdt_kernctl.mod_modname), "mach_kernel", KMOD_MAX_NAME);
-
-               mh = &_mh_execute_header;
-               cmd = (struct load_command*) &mh[1];
-               for (i = 0; i < mh->ncmds; i++) {
-                       if (cmd->cmd == LC_SEGMENT_KERNEL) {
-                       kernel_segment_command_t *orig_sg = (kernel_segment_command_t *) cmd;
-
-                       if (LIT_STRNEQL(orig_sg->segname, SEG_TEXT))
-                               orig_ts = orig_sg;
-                       else if (LIT_STRNEQL(orig_sg->segname, SEG_LINKEDIT))
-                               orig_le = orig_sg;
-                       else if (LIT_STRNEQL(orig_sg->segname, ""))
-                               orig_ts = orig_sg; /* kexts have a single unnamed segment */
-                       }
-                       else if (cmd->cmd == LC_SYMTAB)
-                       orig_st = (struct symtab_command *) cmd;
-       
-                       cmd = (struct load_command *) ((uintptr_t) cmd + cmd->cmdsize);
-               }
-       
-               if ((orig_ts == NULL) || (orig_st == NULL) || (orig_le == NULL))
-                       return;
-
-               sym = (kernel_nlist_t *)(orig_le->vmaddr + orig_st->symoff - orig_le->fileoff);
-               strings = (char *)(orig_le->vmaddr + orig_st->stroff - orig_le->fileoff);
-
-               for (i = 0; i < orig_st->nsyms; i++) {
-                       uint8_t n_type = sym[i].n_type & (N_TYPE | N_EXT);
-                       char *name = strings + sym[i].n_un.n_strx;
+                       kernel_mach_header_t        *mh;
+                       struct load_command         *cmd;
+                       kernel_segment_command_t    *orig_ts = NULL, *orig_le = NULL;
+                       struct symtab_command       *orig_st = NULL;
+                       kernel_nlist_t              *sym = NULL;
+                       char                        *strings;
+                       unsigned int                i;
+                       
+                       g_sdt_mach_module.sdt_nprobes = 0;
+                       g_sdt_mach_module.sdt_probes = NULL;
+                       
+                       g_sdt_kernctl.mod_address = (vm_address_t)&g_sdt_mach_module;
+                       g_sdt_kernctl.mod_size = 0;
+                       strncpy((char *)&(g_sdt_kernctl.mod_modname), "mach_kernel", KMOD_MAX_NAME);
+                       
+                       g_sdt_kernctl.mod_next = NULL;
+                       g_sdt_kernctl.mod_stale = NULL;
+                       g_sdt_kernctl.mod_id = 0;
+                       g_sdt_kernctl.mod_loadcnt = 1;
+                       g_sdt_kernctl.mod_loaded = 1;
+                       g_sdt_kernctl.mod_flags = 0;
+                       g_sdt_kernctl.mod_nenabled = 0;
+                       
+                       mh = &_mh_execute_header;
+                       cmd = (struct load_command*) &mh[1];
+                       for (i = 0; i < mh->ncmds; i++) {
+                               if (cmd->cmd == LC_SEGMENT_KERNEL) {
+                                       kernel_segment_command_t *orig_sg = (kernel_segment_command_t *) cmd;
+                                       
+                                       if (LIT_STRNEQL(orig_sg->segname, SEG_TEXT))
+                                               orig_ts = orig_sg;
+                                       else if (LIT_STRNEQL(orig_sg->segname, SEG_LINKEDIT))
+                                               orig_le = orig_sg;
+                                       else if (LIT_STRNEQL(orig_sg->segname, ""))
+                                               orig_ts = orig_sg; /* kexts have a single unnamed segment */
+                               }
+                               else if (cmd->cmd == LC_SYMTAB)
+                                       orig_st = (struct symtab_command *) cmd;
+                               
+                               cmd = (struct load_command *) ((uintptr_t) cmd + cmd->cmdsize);
+                       }
+                       
+                       if ((orig_ts == NULL) || (orig_st == NULL) || (orig_le == NULL))
+                               return;
+                       
+                       sym = (kernel_nlist_t *)(orig_le->vmaddr + orig_st->symoff - orig_le->fileoff);
+                       strings = (char *)(orig_le->vmaddr + orig_st->stroff - orig_le->fileoff);
+                       
+                       for (i = 0; i < orig_st->nsyms; i++) {
+                               uint8_t n_type = sym[i].n_type & (N_TYPE | N_EXT);
+                               char *name = strings + sym[i].n_un.n_strx;
                                const char *prev_name;
                                unsigned long best;
                                unsigned int j;
-
-                       /* Check that the symbol is a global and that it has a name. */
-                       if (((N_SECT | N_EXT) != n_type && (N_ABS | N_EXT) != n_type))
-                       continue;
-
-                       if (0 == sym[i].n_un.n_strx) /* iff a null, "", name. */
-                       continue;
-
-                       /* Lop off omnipresent leading underscore. */
-                       if (*name == '_')
-                       name += 1;
-
-                               if (strstr(name, DTRACE_PROBE_PREFIX)) {
+                               
+                               /* Check that the symbol is a global and that it has a name. */
+                               if (((N_SECT | N_EXT) != n_type && (N_ABS | N_EXT) != n_type))
+                                       continue;
+                               
+                               if (0 == sym[i].n_un.n_strx) /* iff a null, "", name. */
+                                       continue;
+                               
+                               /* Lop off omnipresent leading underscore. */
+                               if (*name == '_')
+                                       name += 1;
+                               
+                               if (strncmp(name, DTRACE_PROBE_PREFIX, sizeof(DTRACE_PROBE_PREFIX) - 1) == 0) {
                                        sdt_probedesc_t *sdpd = kmem_alloc(sizeof(sdt_probedesc_t), KM_SLEEP);
                                        int len = strlen(name) + 1;
-
+                                       
                                        sdpd->sdpd_name = kmem_alloc(len, KM_SLEEP);
                                        strncpy(sdpd->sdpd_name, name, len); /* NUL termination is ensured. */
-
+                                       
                                        prev_name = "<unknown>";
                                        best = 0;
                                        
-                                       /* Avoid shadow build warnings */
+                                       /*
+                                        * Find the symbol immediately preceding the sdt probe site just discovered,
+                                        * that symbol names the function containing the sdt probe.
+                                        */
                                        for (j = 0; j < orig_st->nsyms; j++) {
                                                uint8_t jn_type = sym[j].n_type & (N_TYPE | N_EXT);
                                                char *jname = strings + sym[j].n_un.n_strx;
-
+                                               
                                                if (((N_SECT | N_EXT) != jn_type && (N_ABS | N_EXT) != jn_type))
                                                        continue;
-
+                                               
                                                if (0 == sym[j].n_un.n_strx) /* iff a null, "", name. */
                                                        continue;
-
+                                               
                                                if (*jname == '_')
                                                        jname += 1;
-                                               if (strstr(jname, DTRACE_PROBE_PREFIX))
-                                                       continue;
-
+                                               
                                                if (*(unsigned long *)sym[i].n_value <= (unsigned long)sym[j].n_value)
                                                        continue;
-
+                                               
                                                if ((unsigned long)sym[j].n_value > best) {
                                                        best = (unsigned long)sym[j].n_value;
                                                        prev_name = jname;
                                                }
                                        }
-
+                                       
                                        sdpd->sdpd_func = kmem_alloc((len = strlen(prev_name) + 1), KM_SLEEP);
                                        strncpy(sdpd->sdpd_func, prev_name, len); /* NUL termination is ensured. */
-
+                                       
                                        sdpd->sdpd_offset = *(unsigned long *)sym[i].n_value;
 
+#if 0
+                                       printf("sdt_init: sdpd_offset=0x%lx, n_value=0x%lx, name=%s\n",
+                                           sdpd->sdpd_offset,  *(unsigned long *)sym[i].n_value, name);
+#endif
+
                                        sdpd->sdpd_next = g_sdt_mach_module.sdt_probes;
                                        g_sdt_mach_module.sdt_probes = sdpd;
                                } else {
@@ -669,9 +559,9 @@ void sdt_init( void )
                                }
                        }
                }
-
+               
                sdt_attach( (dev_info_t *)(uintptr_t)majdevno, DDI_ATTACH );
-
+               
                gSDTInited = 1;
        } else
                panic("sdt_init: called twice!\n");
@@ -683,19 +573,32 @@ void sdt_init( void )
 void
 sdt_provide_module(void *arg, struct modctl *ctl)
 {
-#pragma unused(ctl)
 #pragma unused(arg)
-    __sdt_provide_module(arg, &g_sdt_kernctl);
-
-       sdt_probedesc_t *sdpd = g_sdt_mach_module.sdt_probes;
-       while (sdpd) {
-               sdt_probedesc_t *this_sdpd = sdpd;
-               kmem_free((void *)sdpd->sdpd_name, strlen(sdpd->sdpd_name) + 1);
-               kmem_free((void *)sdpd->sdpd_func, strlen(sdpd->sdpd_func) + 1);
-               sdpd = sdpd->sdpd_next;
-               kmem_free((void *)this_sdpd, sizeof(sdt_probedesc_t));
+       ASSERT(ctl != NULL);
+       ASSERT(dtrace_kernel_symbol_mode != DTRACE_KERNEL_SYMBOLS_NEVER);
+       lck_mtx_assert(&mod_lock, LCK_MTX_ASSERT_OWNED);
+       
+       if (MOD_SDT_DONE(ctl))
+               return;
+               
+       if (MOD_IS_MACH_KERNEL(ctl)) {
+               __sdt_provide_module(arg, &g_sdt_kernctl);
+               
+               sdt_probedesc_t *sdpd = g_sdt_mach_module.sdt_probes;
+               while (sdpd) {
+                       sdt_probedesc_t *this_sdpd = sdpd;
+                       kmem_free((void *)sdpd->sdpd_name, strlen(sdpd->sdpd_name) + 1);
+                       kmem_free((void *)sdpd->sdpd_func, strlen(sdpd->sdpd_func) + 1);
+                       sdpd = sdpd->sdpd_next;
+                       kmem_free((void *)this_sdpd, sizeof(sdt_probedesc_t));
+               }
+               g_sdt_mach_module.sdt_probes = NULL;
+       } else {
+               /*
+                * APPLE NOTE:  sdt probes for kexts not yet implemented
+                */
        }
-       g_sdt_mach_module.sdt_probes = NULL;
+       
+       /* Need to mark this module as completed */
+       ctl->mod_flags |= MODCTL_SDT_PROBES_PROVIDED;
 }
-
-#endif /* __APPLE__ */