valgrind.c

Go to the documentation of this file.

/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil ; -*- */
/*
 * See COPYRIGHT in top-level directory.
 */
 
#include "abti.h"
 
#ifdef HAVE_VALGRIND_SUPPORT
 
/*
 * These routines register and unregister stacks of threads so that Valgrind can
 * handle them.  This implementation uses a very naive linear list to keep track
 * of stacks and valgrind_id.  Its performance is bad compared to, for example,
 * hash tables, but performance is less important when Valgrind is used.
 */
 
typedef size_t ABTI_valgrind_id;
 
typedef struct ABTI_valgrind_id_list_t {
    const void *p_stack;
    ABTI_valgrind_id valgrind_id;
    struct ABTI_valgrind_id_list_t *p_next;
} ABTI_valgrind_id_list;
 
/* The list is protected by a global lock. */
static ABTD_spinlock g_valgrind_id_list_lock =
    ABTD_SPINLOCK_STATIC_INITIALIZER();
static int g_num_malloc_failures = 0;
static ABTI_valgrind_id_list *gp_valgrind_id_list_head = NULL;
static ABTI_valgrind_id_list *gp_valgrind_id_list_tail = NULL;
 
#include <valgrind/valgrind.h>
 
void ABTI_valgrind_register_stack(const void *p_stack, size_t size)
{
    if (p_stack == 0)
        return;
 
    const void *p_start = (char *)(p_stack);
    const void *p_end = (char *)(p_stack) + size;
 
    ABTD_spinlock_acquire(&g_valgrind_id_list_lock);
    ABTI_valgrind_id_list *p_valgrind_id_list =
        (ABTI_valgrind_id_list *)malloc(sizeof(ABTI_valgrind_id_list));
    if (p_valgrind_id_list) {
        ABTI_valgrind_id valgrind_id = VALGRIND_STACK_REGISTER(p_start, p_end);
        p_valgrind_id_list->p_stack = p_stack;
        p_valgrind_id_list->valgrind_id = valgrind_id;
        p_valgrind_id_list->p_next = 0;
        if (!gp_valgrind_id_list_head) {
            gp_valgrind_id_list_head = p_valgrind_id_list;
            gp_valgrind_id_list_tail = p_valgrind_id_list;
        } else {
            gp_valgrind_id_list_tail->p_next = p_valgrind_id_list;
            gp_valgrind_id_list_tail = p_valgrind_id_list;
        }
        LOG_DEBUG("valgrind : register stack %p (id = %d)\n", p_stack,
                  (int)valgrind_id);
    } else {
        /* When malloc() fails, VALGRIND_STACK_REGISTER is not performed, so we
         * cannot deregister this stack region. */
        g_num_malloc_failures++;
    }
    ABTD_spinlock_release(&g_valgrind_id_list_lock);
}
 
void ABTI_valgrind_unregister_stack(const void *p_stack)
{
    if (p_stack == 0)
        return;
 
    ABTD_spinlock_acquire(&g_valgrind_id_list_lock);
    if (gp_valgrind_id_list_head->p_stack == p_stack) {
        VALGRIND_STACK_DEREGISTER(gp_valgrind_id_list_head->valgrind_id);
        ABTI_valgrind_id_list *p_next = gp_valgrind_id_list_head->p_next;
        free(gp_valgrind_id_list_head);
        gp_valgrind_id_list_head = p_next;
        if (!p_next)
            gp_valgrind_id_list_tail = NULL;
    } else {
        /* Do linear search to find the corresponding valgrind_id. */
        ABTI_valgrind_id_list *p_prev = gp_valgrind_id_list_head;
        ABTI_valgrind_id_list *p_current = gp_valgrind_id_list_head->p_next;
        ABT_bool deregister_flag = ABT_FALSE;
        while (p_current) {
            if (p_current->p_stack == p_stack) {
                LOG_DEBUG("valgrind : deregister stack %p (id = %d)\n", p_stack,
                          (int)p_current->valgrind_id);
                VALGRIND_STACK_DEREGISTER(p_current->valgrind_id);
                p_prev->p_next = p_current->p_next;
                if (!p_prev->p_next)
                    gp_valgrind_id_list_tail = p_prev;
                free(p_current);
                deregister_flag = ABT_TRUE;
                break;
            }
            p_prev = p_current;
            p_current = p_current->p_next;
        }
        if (!deregister_flag) {
            /* Although it is less likely, maybe we missed stack registration
             * because of the failure of malloc. */
            ABTI_ASSERT(g_num_malloc_failures > 0);
            g_num_malloc_failures--;
        }
    }
    ABTD_spinlock_release(&g_valgrind_id_list_lock);
}
 
#endif