ruby-static-tracing 0.0.4 → 0.0.5

data/ext/ruby-static-tracing/lib/libusdt/usdt_dof_file.c

@@ -0,0 +1,290 @@
+/*
+ * Copyright (c) 2012, Chris Andrews. All rights reserved.
+ */
+
+#include "usdt_internal.h"
+
+#include <sys/ioctl.h>
+
+static uint8_t
+dof_version(uint8_t header_version)
+{
+        uint8_t dof_version;
+        /* DOF versioning: Apple always needs version 3, but Solaris can use
+           1 or 2 depending on whether is-enabled probes are needed. */
+#ifdef __APPLE__
+        dof_version = DOF_VERSION_3;
+#else
+        switch(header_version) {
+        case 1:
+                dof_version = DOF_VERSION_1;
+                break;
+        case 2:
+                dof_version = DOF_VERSION_2;
+                break;
+        default:
+                dof_version = DOF_VERSION;
+        }
+#endif
+        return dof_version;
+}
+
+#ifdef __APPLE__
+static const char *helper = "/dev/dtracehelper";
+
+static int
+load_dof(int fd, dof_helper_t *dh)
+{
+        int ret;
+        uint8_t buffer[sizeof(dof_ioctl_data_t) + sizeof(dof_helper_t)];
+        dof_ioctl_data_t* ioctlData = (dof_ioctl_data_t*)buffer;
+        user_addr_t val;
+
+        ioctlData->dofiod_count = 1;
+        memcpy(&ioctlData->dofiod_helpers[0], dh, sizeof(dof_helper_t));
+
+        val = (user_addr_t)(unsigned long)ioctlData;
+        ret = ioctl(fd, DTRACEHIOC_ADDDOF, &val);
+
+        if (ret < 0)
+                return ret;
+
+        return (int)(ioctlData->dofiod_helpers[0].dofhp_dof);
+}
+
+#else /* Solaris and FreeBSD */
+
+/* ignore Sol10 GA ... */
+static const char *helper = "/dev/dtrace/helper";
+
+static int
+load_dof(int fd, dof_helper_t *dh)
+{
+        int ret;
+
+        ret = ioctl(fd, DTRACEHIOC_ADDDOF, dh);
+#if defined(__FreeBSD__) && __FreeBSD__ <= 10
+	if (ret != -1)
+	    ret = dh ->gen;
+#endif
+        return ret;
+}
+
+#endif
+
+static void
+pad_section(usdt_dof_section_t *sec)
+{
+        size_t i, pad;
+
+        if (sec->align > 1) {
+                i = sec->offset % sec->align;
+                if (i > 0) {
+                        pad = sec->align - i;
+                        sec->offset = (pad + sec->offset);
+                        sec->pad = pad;
+                }
+        }
+}
+
+static void
+dof_header(dof_hdr_t *header)
+{
+        int i;
+
+        header->dofh_ident[DOF_ID_MAG0] = DOF_MAG_MAG0;
+        header->dofh_ident[DOF_ID_MAG1] = DOF_MAG_MAG1;
+        header->dofh_ident[DOF_ID_MAG2] = DOF_MAG_MAG2;
+        header->dofh_ident[DOF_ID_MAG3] = DOF_MAG_MAG3;
+
+        header->dofh_ident[DOF_ID_MODEL]    = DOF_MODEL_NATIVE;
+        header->dofh_ident[DOF_ID_ENCODING] = DOF_ENCODE_NATIVE;
+        header->dofh_ident[DOF_ID_VERSION]  = dof_version(2);
+        header->dofh_ident[DOF_ID_DIFVERS]  = DIF_VERSION;
+        header->dofh_ident[DOF_ID_DIFIREG]  = DIF_DIR_NREGS;
+        header->dofh_ident[DOF_ID_DIFTREG]  = DIF_DTR_NREGS;
+
+        for (i = DOF_ID_PAD; i < DOF_ID_SIZE; i++)
+                header->dofh_ident[i] = 0;
+
+        header->dofh_flags = 0;
+
+        header->dofh_hdrsize = sizeof(dof_hdr_t);
+        header->dofh_secsize = sizeof(dof_sec_t);
+        header->dofh_secoff = sizeof(dof_hdr_t);
+
+        header->dofh_loadsz = 0;
+        header->dofh_filesz = 0;
+        header->dofh_pad = 0;
+}
+
+static size_t
+add_header(usdt_dof_file_t *file, size_t offset, usdt_dof_section_t *section)
+{
+        dof_sec_t header;
+
+        header.dofs_flags   = section->flags;
+        header.dofs_type    = section->type;
+        header.dofs_offset  = section->offset;
+        header.dofs_size    = section->size;
+        header.dofs_entsize = section->entsize;
+        header.dofs_align   = section->align;
+
+        memcpy((file->dof + offset), &header, sizeof(dof_sec_t));
+        return (offset + sizeof(dof_sec_t));
+}
+
+static size_t
+add_section(usdt_dof_file_t *file, size_t offset, usdt_dof_section_t *section)
+{
+        if (section->pad > 0) {
+                /* maximum padding required is 7 */
+                memcpy((file->dof + offset), "\0\0\0\0\0\0\0", section->pad);
+                offset += section->pad;
+        }
+
+        memcpy((file->dof + offset), section->data, section->size);
+        return (offset + section->size);
+}
+
+int
+usdt_dof_file_unload(usdt_dof_file_t *file)
+{
+        int fd, ret;
+
+        if ((fd = open(helper, O_RDWR)) < 0)
+                return (-1);
+
+#ifdef __FreeBSD__
+        ret = ioctl(fd, DTRACEHIOC_REMOVE, &file->gen);
+#else
+        ret = ioctl(fd, DTRACEHIOC_REMOVE, file->gen);
+#endif
+
+        if (ret < 0)
+                return (-1);
+
+        if ((close(fd)) < 0)
+                return (-1);
+
+        return (0);
+}
+
+int
+usdt_dof_file_load(usdt_dof_file_t *file, const char *module)
+{
+        dof_helper_t dh;
+        dof_hdr_t *dof;
+        int fd;
+
+        dof = (dof_hdr_t *) file->dof;
+
+        dh.dofhp_dof  = (uintptr_t)dof;
+        dh.dofhp_addr = (uintptr_t)dof;
+#if __FreeBSD__ >= 11
+        dh.dofhp_pid = getpid();
+#endif
+        (void) strncpy(dh.dofhp_mod, module, sizeof (dh.dofhp_mod));
+
+        if ((fd = open(helper, O_RDWR)) < 0)
+                return (-1);
+
+        file->gen = load_dof(fd, &dh);
+
+        if ((close(fd)) < 0)
+                return (-1);
+
+        if (file->gen < 0)
+                return (-1);
+
+        return (0);
+}
+
+void
+usdt_dof_file_append_section(usdt_dof_file_t *file, usdt_dof_section_t *section)
+{
+        usdt_dof_section_t *s;
+
+        if (file->sections == NULL) {
+                file->sections = section;
+        }
+        else {
+                for (s = file->sections; (s->next != NULL); s = s->next) ;
+                s->next = section;
+        }
+}
+
+void
+usdt_dof_file_generate(usdt_dof_file_t *file, usdt_strtab_t *strtab)
+{
+        dof_hdr_t header;
+        uint64_t filesz;
+        uint64_t loadsz;
+        usdt_dof_section_t *sec;
+        size_t offset;
+
+        dof_header(&header);
+        header.dofh_secnum = 6;
+
+        filesz = sizeof(dof_hdr_t) + (sizeof(dof_sec_t) * header.dofh_secnum);
+        loadsz = filesz;
+
+        strtab->offset = filesz;
+        pad_section((usdt_dof_section_t *)strtab);
+        filesz += strtab->size + strtab->pad;
+
+        if (strtab->flags & 1)
+                loadsz += strtab->size + strtab->pad;
+
+        for (sec = file->sections; sec != NULL; sec = sec->next) {
+                sec->offset = filesz;
+                pad_section(sec);
+                filesz += sec->size + sec->pad;
+                if (sec->flags & 1)
+                        loadsz += sec->size + sec->pad;
+        }
+
+        header.dofh_loadsz = loadsz;
+        header.dofh_filesz = filesz;
+        memcpy(file->dof, &header, sizeof(dof_hdr_t));
+
+        offset = sizeof(dof_hdr_t);
+
+        offset = add_header(file, offset, (usdt_dof_section_t *)strtab);
+
+        for (sec = file->sections; sec != NULL; sec = sec->next)
+                offset = add_header(file, offset, sec);
+
+        offset = add_section(file, offset, (usdt_dof_section_t *)strtab);
+
+        for (sec = file->sections; sec != NULL; sec = sec->next)
+                offset = add_section(file, offset, sec);
+}
+
+usdt_dof_file_t *
+usdt_dof_file_init(usdt_provider_t *provider, size_t size)
+{
+        usdt_dof_file_t *file;
+
+        if ((file = malloc(sizeof(*file))) == NULL) {
+                usdt_error(provider, USDT_ERROR_MALLOC);
+                return (NULL);
+        }
+
+        if ((file->dof = valloc(size)) == NULL) {
+                usdt_error(provider, USDT_ERROR_VALLOC);
+                return (NULL);
+        }
+
+        file->sections = NULL;
+        file->size = size;
+
+        return (file);
+}
+
+void
+usdt_dof_file_free(usdt_dof_file_t *file)
+{
+        free(file->dof);
+        free(file);
+}

data/ext/ruby-static-tracing/lib/libusdt/usdt_dof_sections.c

@@ -0,0 +1,180 @@
+/*
+ * Copyright (c) 2012, Chris Andrews. All rights reserved.
+ */
+
+#include "usdt_internal.h"
+
+int
+usdt_dof_probes_sect(usdt_dof_section_t *probes,
+                     usdt_provider_t *provider, usdt_strtab_t *strtab)
+{
+        usdt_probedef_t *pd;
+        dof_probe_t p;
+        dof_stridx_t type, argv;
+        uint8_t argc, i;
+        uint32_t argidx = 0;
+        uint32_t offidx = 0;
+
+        usdt_dof_section_init(probes, DOF_SECT_PROBES, 1);
+
+        for (pd = provider->probedefs; pd != NULL; pd = pd->next) {
+                argc = 0;
+                argv = 0;
+                type = 0;
+
+                for (i = 0; i < pd->argc; i++) {
+                        type = usdt_strtab_add(strtab, pd->types[i]);
+                        argc++;
+                        if (argv == 0)
+                                argv = type;
+                }
+
+                if (usdt_create_tracepoints(pd->probe) < 0) {
+                        usdt_error(provider, USDT_ERROR_VALLOC);
+                        return (-1);
+                }
+
+#ifdef __x86_64__
+                p.dofpr_addr     = (uint64_t) pd->probe->isenabled_addr;
+#elif __i386__ || __i386
+                p.dofpr_addr     = (uint32_t) pd->probe->isenabled_addr;
+#else
+#error "only x86_64 and i386 supported"
+#endif
+                p.dofpr_func     = usdt_strtab_add(strtab, pd->function);
+                p.dofpr_name     = usdt_strtab_add(strtab, pd->name);
+                p.dofpr_nargv    = argv;
+                p.dofpr_xargv    = argv;
+                p.dofpr_argidx   = argidx;
+                p.dofpr_offidx   = offidx;
+                p.dofpr_nargc    = argc;
+                p.dofpr_xargc    = argc;
+                p.dofpr_noffs    = 1;
+                p.dofpr_enoffidx = offidx;
+                p.dofpr_nenoffs  = 1;
+                p.dofpr_pad1     = 0;
+                p.dofpr_pad2     = 0;
+
+                usdt_dof_section_add_data(probes, &p, sizeof(dof_probe_t));
+                probes->entsize = sizeof(dof_probe_t);
+
+                argidx += argc;
+                offidx++;
+        }
+
+        return (0);
+}
+
+int
+usdt_dof_prargs_sect(usdt_dof_section_t *prargs, usdt_provider_t *provider)
+{
+        usdt_probedef_t *pd;
+        uint8_t i;
+
+        usdt_dof_section_init(prargs, DOF_SECT_PRARGS, 2);
+        prargs->entsize = 1;
+
+        for (pd = provider->probedefs; pd != NULL; pd = pd->next) {
+                for (i = 0; i < pd->argc; i++)
+                        usdt_dof_section_add_data(prargs, &i, 1);
+        }
+        if (prargs->size == 0) {
+                i = 0;
+                if (usdt_dof_section_add_data(prargs, &i, 1) < 0) {
+                        usdt_error(provider, USDT_ERROR_MALLOC);
+                        return (-1);
+                }
+        }
+
+        return (0);
+}
+
+int
+usdt_dof_proffs_sect(usdt_dof_section_t *proffs,
+                     usdt_provider_t *provider, char *dof)
+{
+        usdt_probedef_t *pd;
+        uint32_t off;
+
+        usdt_dof_section_init(proffs, DOF_SECT_PROFFS, 3);
+        proffs->entsize = 4;
+
+        for (pd = provider->probedefs; pd != NULL; pd = pd->next) {
+                off = usdt_probe_offset(pd->probe, dof, pd->argc);
+                if (usdt_dof_section_add_data(proffs, &off, 4) < 0) {
+                        usdt_error(provider, USDT_ERROR_MALLOC);
+                        return (-1);
+                }
+        }
+
+        return (0);
+}
+
+int
+usdt_dof_prenoffs_sect(usdt_dof_section_t *prenoffs,
+                       usdt_provider_t *provider, char *dof)
+{
+        usdt_probedef_t *pd;
+        uint32_t off;
+
+        usdt_dof_section_init(prenoffs, DOF_SECT_PRENOFFS, 4);
+        prenoffs->entsize = 4;
+
+        for (pd = provider->probedefs; pd != NULL; pd = pd->next) {
+                off = usdt_is_enabled_offset(pd->probe, dof);
+                if (usdt_dof_section_add_data(prenoffs, &off, 4) < 0) {
+                        usdt_error(provider, USDT_ERROR_MALLOC);
+                        return (-1);
+                }
+        }
+
+        return (0);
+}
+
+int
+usdt_dof_provider_sect(usdt_dof_section_t *provider_s, usdt_provider_t *provider)
+{
+        dof_provider_t p;
+
+        usdt_dof_section_init(provider_s, DOF_SECT_PROVIDER, 5);
+
+        p.dofpv_strtab   = 0;
+        p.dofpv_probes   = 1;
+        p.dofpv_prargs   = 2;
+        p.dofpv_proffs   = 3;
+        p.dofpv_prenoffs = 4;
+        p.dofpv_name     = 1; /* provider name always first strtab entry. */
+
+        /*
+         * Stability is something of a hack. Everything is marked *
+         * "stable" here to permit use of the "args" array, which is *
+         * needed to access arguments past "arg9".
+         *
+         * It should be up to the creator of the provider to decide
+         * this, though, and it should be possible to set the
+         * appropriate stability at creation time.
+         */
+
+        p.dofpv_provattr = DOF_ATTR(DTRACE_STABILITY_STABLE,
+                                    DTRACE_STABILITY_STABLE,
+                                    DTRACE_STABILITY_STABLE);
+        p.dofpv_modattr  = DOF_ATTR(DTRACE_STABILITY_STABLE,
+                                    DTRACE_STABILITY_STABLE,
+                                    DTRACE_STABILITY_STABLE);
+        p.dofpv_funcattr = DOF_ATTR(DTRACE_STABILITY_STABLE,
+                                    DTRACE_STABILITY_STABLE,
+                                    DTRACE_STABILITY_STABLE);
+        p.dofpv_nameattr = DOF_ATTR(DTRACE_STABILITY_STABLE,
+                                    DTRACE_STABILITY_STABLE,
+                                    DTRACE_STABILITY_STABLE);
+        p.dofpv_argsattr = DOF_ATTR(DTRACE_STABILITY_STABLE,
+                                    DTRACE_STABILITY_STABLE,
+                                    DTRACE_STABILITY_STABLE);
+
+        if ((usdt_dof_section_add_data(provider_s, &p, sizeof(p))) < 0) {
+                usdt_error(provider, USDT_ERROR_MALLOC);
+                return (-1);
+        }
+
+        return (0);
+}

data/ext/ruby-static-tracing/lib/libusdt/usdt_internal.h

@@ -0,0 +1,107 @@
+/*
+ * Copyright (c) 2012, Chris Andrews. All rights reserved.
+ */
+
+#ifndef __LIB_USDT_USDT_INTERNAL_H__
+#define __LIB_USDT_USDT_INTERNAL_H__
+
+#ifdef __linux__
+#include <endian.h>
+#if __BYTE_ORDER == __LITTLE_ENDIAN
+#ifndef _LITTLE_ENDIAN
+#define _LITTLE_ENDIAN
+#endif
+#endif
+#endif
+
+#include <sys/dtrace.h>
+#include <sys/types.h>
+#include <sys/mman.h>
+
+#include <stdlib.h>
+#include <errno.h>
+#include <string.h>
+#include <fcntl.h>
+#include <unistd.h>
+#include <stdint.h>
+#include <assert.h>
+
+#define FUNC_SIZE 32
+
+#include "usdt.h"
+
+extern void usdt_tracepoint_isenabled(void);
+extern void usdt_tracepoint_probe(void);
+extern void usdt_tracepoint_end(void);
+extern void usdt_probe_args(void *, int, void**);
+
+uint32_t usdt_probe_offset(usdt_probe_t *probe, char *dof, uint8_t argc);
+uint32_t usdt_is_enabled_offset(usdt_probe_t *probe, char *dof);
+int usdt_create_tracepoints(usdt_probe_t *probe);
+void usdt_free_tracepoints(usdt_probe_t *probe);
+
+typedef struct usdt_dof_section {
+        dof_secidx_t index;
+        uint32_t type;
+        uint32_t flags;
+        uint32_t align;
+        uint64_t offset;
+        uint64_t size;
+        uint32_t entsize;
+        size_t pad;
+        struct usdt_dof_section *next;
+        char *data;
+} usdt_dof_section_t;
+
+int usdt_dof_section_init(usdt_dof_section_t *section,
+                          uint32_t type, dof_secidx_t index);
+int usdt_dof_section_add_data(usdt_dof_section_t *section,
+                              void *data, size_t length);
+void usdt_dof_section_free(usdt_dof_section_t *section);
+
+typedef struct usdt_strtab {
+        dof_secidx_t index;
+        uint32_t type;
+        uint32_t flags;
+        uint32_t align;
+        uint64_t offset;
+        uint64_t size;
+        uint32_t entsize;
+        size_t pad;
+        int strindex;
+        char *data;
+} usdt_strtab_t;
+
+int usdt_strtab_init(usdt_strtab_t *strtab, dof_secidx_t index);
+dof_stridx_t usdt_strtab_add(usdt_strtab_t *strtab, const char *string);
+char *usdt_strtab_header(usdt_strtab_t *strtab);
+size_t usdt_strtab_size(usdt_strtab_t *strtab);
+
+size_t usdt_provider_dof_size(usdt_provider_t *provider, usdt_strtab_t *strtab);
+
+typedef struct usdt_dof_file {
+        char *dof;
+        int gen;
+        size_t size;
+        usdt_dof_section_t *sections;
+} usdt_dof_file_t;
+
+usdt_dof_file_t *usdt_dof_file_init(usdt_provider_t *provider, size_t size);
+void usdt_dof_file_append_section(usdt_dof_file_t *file, usdt_dof_section_t *section);
+void usdt_dof_file_generate(usdt_dof_file_t *file, usdt_strtab_t *strtab);
+int usdt_dof_file_load(usdt_dof_file_t *file, const char *module);
+int usdt_dof_file_unload(usdt_dof_file_t *file);
+void usdt_dof_file_free(usdt_dof_file_t *file);
+
+int usdt_dof_probes_sect(usdt_dof_section_t *probes,
+                         usdt_provider_t *provider, usdt_strtab_t *strtab);
+int usdt_dof_prargs_sect(usdt_dof_section_t *prargs,
+                         usdt_provider_t *provider);
+int usdt_dof_proffs_sect(usdt_dof_section_t *proffs,
+                         usdt_provider_t *provider, char *dof);
+int usdt_dof_prenoffs_sect(usdt_dof_section_t *prenoffs,
+                           usdt_provider_t *provider, char *dof);
+int usdt_dof_provider_sect(usdt_dof_section_t *provider_s,
+                           usdt_provider_t *provider);
+
+#endif // __LIB_USDT_USDT_INTERNAL_H__

data/ext/ruby-static-tracing/lib/libusdt/usdt_probe.c

@@ -0,0 +1,133 @@
+/*
+ * Copyright (c) 2012, Chris Andrews. All rights reserved.
+ */
+
+#include "usdt_internal.h"
+
+#ifdef __APPLE__
+
+uint32_t
+usdt_probe_offset(usdt_probe_t *probe, char *dof, uint8_t argc)
+{
+        uint32_t offset;
+#ifdef __x86_64__
+        offset = ((uint64_t) probe->probe_addr - (uint64_t) dof + 2);
+#elif __i386__
+        offset = ((uint32_t) probe->probe_addr - (uint32_t) dof + 2);
+#else
+#error "only x86_64 and i386 supported"
+#endif
+        return (offset);
+}
+
+uint32_t
+usdt_is_enabled_offset(usdt_probe_t *probe, char *dof) 
+{
+        uint32_t offset;
+#ifdef __x86_64__
+        offset = ((uint64_t) probe->isenabled_addr - (uint64_t) dof + 6);
+#elif __i386__
+        offset = ((uint32_t) probe->isenabled_addr - (uint32_t) dof + 6);
+#else
+#error "only x86_64 and i386 supported"
+#endif
+        return (offset);
+}
+
+#elif defined __linux__
+
+uint32_t
+usdt_probe_offset(usdt_probe_t *probe, char *dof, uint8_t argc)
+{
+        return (16);
+}
+
+uint32_t
+usdt_is_enabled_offset(usdt_probe_t *probe, char *dof)
+{
+        return (10);
+}
+
+#else /* solaris and freebsd */
+
+uint32_t
+usdt_probe_offset(usdt_probe_t *probe, char *dof, uint8_t argc)
+{
+        return (16);
+}
+
+uint32_t
+usdt_is_enabled_offset(usdt_probe_t *probe, char *dof)
+{
+        return (8);
+}
+
+#endif
+
+int
+usdt_create_tracepoints(usdt_probe_t *probe)
+{
+        /* Prepare the tracepoints - for each probe, a separate chunk
+         * of memory with the tracepoint code copied into it, to give
+         * us unique addresses for each tracepoint.
+         *
+         * On Oracle Linux, this must be an mmapped file because USDT
+         * probes there are implemented as uprobes, which are
+         * addressed by inode and offset. The file used is a small
+         * mkstemp'd file we immediately unlink.
+         *
+         * Elsewhere, we can use the heap directly because USDT will
+         * instrument any memory mapped by the process.
+         */
+
+        size_t size;
+#ifdef __linux__
+        int fd;
+        char tmp[20] = "/tmp/libusdtXXXXXX";
+
+        if ((fd = mkstemp(tmp)) < 0)
+                return (-1);
+        if (unlink(tmp) < 0)
+                return (-1);
+        if (write(fd, "\0", FUNC_SIZE) < FUNC_SIZE)
+                return (-1);
+
+        probe->isenabled_addr = (int (*)())mmap(NULL, FUNC_SIZE,
+                                                PROT_READ | PROT_WRITE | PROT_EXEC,
+                                                MAP_PRIVATE, fd, 0);
+#else
+        probe->isenabled_addr = (int (*)())valloc(FUNC_SIZE);
+#endif
+        if (probe->isenabled_addr == NULL)
+                return (-1);
+
+        /* ensure that the tracepoints will fit the heap we're allocating */
+        size = ((char *)usdt_tracepoint_end - (char *)usdt_tracepoint_isenabled);
+        assert(size < FUNC_SIZE);
+
+        size = ((char *)usdt_tracepoint_probe - (char *)usdt_tracepoint_isenabled);
+        probe->probe_addr = (char *)probe->isenabled_addr + size;
+
+        memcpy((void *)probe->isenabled_addr,
+               (const void *)usdt_tracepoint_isenabled, FUNC_SIZE);
+
+#ifdef __linux__
+        mprotect((void *)probe->isenabled_addr, FUNC_SIZE,
+                 PROT_READ | PROT_EXEC);
+#else
+        mprotect((void *)probe->isenabled_addr, FUNC_SIZE,
+                 PROT_READ | PROT_WRITE | PROT_EXEC);
+#endif
+
+        return (0);
+}
+
+void
+usdt_free_tracepoints(usdt_probe_t *probe)
+{
+#ifdef __linux__
+        (void) munmap(probe->isenabled_addr, FUNC_SIZE);
+#else
+        free(probe->isenabled_addr);
+#endif
+}