timer.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"

int ABTI_timer_create(ABTI_timer **pp_newtimer);

double ABT_get_wtime(void)
{
    return ABTI_get_wtime();
}

int ABT_timer_create(ABT_timer *newtimer)
{
    int abt_errno = ABT_SUCCESS;
    ABTI_timer *p_newtimer;

    abt_errno = ABTI_timer_create(&p_newtimer);
    ABTI_CHECK_ERROR(abt_errno);

    *newtimer = ABTI_timer_get_handle(p_newtimer);

fn_exit:
    return abt_errno;

fn_fail:
    *newtimer = ABT_TIMER_NULL;
    HANDLE_ERROR_FUNC_WITH_CODE(abt_errno);
    goto fn_exit;
}

int ABT_timer_dup(ABT_timer timer, ABT_timer *newtimer)
{
    int abt_errno = ABT_SUCCESS;
    ABTI_timer *p_timer = ABTI_timer_get_ptr(timer);
    ABTI_CHECK_NULL_TIMER_PTR(p_timer);

    ABTI_timer *p_newtimer;

    abt_errno = ABTI_timer_create(&p_newtimer);
    ABTI_CHECK_ERROR(abt_errno);

    memcpy(p_newtimer, p_timer, sizeof(ABTI_timer));

    *newtimer = ABTI_timer_get_handle(p_newtimer);

fn_exit:
    return abt_errno;

fn_fail:
    HANDLE_ERROR_FUNC_WITH_CODE(abt_errno);
    goto fn_exit;
}

int ABT_timer_free(ABT_timer *timer)
{
    int abt_errno = ABT_SUCCESS;
    ABTI_timer *p_timer = ABTI_timer_get_ptr(*timer);
    ABTI_CHECK_NULL_TIMER_PTR(p_timer);

    /* We use libc malloc/free for ABT_timer because ABTU_malloc/free might
     * need the initialization of Argobots if they are not the same as libc
     * malloc/free.  This is to allow ABT_timer to be used irrespective of
     * Argobots initialization. */
    free(p_timer);
    *timer = ABT_TIMER_NULL;

fn_exit:
    return abt_errno;

fn_fail:
    HANDLE_ERROR_FUNC_WITH_CODE(abt_errno);
    goto fn_exit;
}

int ABT_timer_start(ABT_timer timer)
{
    int abt_errno = ABT_SUCCESS;
    ABTI_timer *p_timer = ABTI_timer_get_ptr(timer);
    ABTI_CHECK_NULL_TIMER_PTR(p_timer);

    ABTD_time_get(&p_timer->start);

fn_exit:
    return abt_errno;

fn_fail:
    HANDLE_ERROR_FUNC_WITH_CODE(abt_errno);
    goto fn_exit;
}

int ABT_timer_stop(ABT_timer timer)
{
    int abt_errno = ABT_SUCCESS;
    ABTI_timer *p_timer = ABTI_timer_get_ptr(timer);
    ABTI_CHECK_NULL_TIMER_PTR(p_timer);

    ABTD_time_get(&p_timer->end);

fn_exit:
    return abt_errno;

fn_fail:
    HANDLE_ERROR_FUNC_WITH_CODE(abt_errno);
    goto fn_exit;
}

int ABT_timer_read(ABT_timer timer, double *secs)
{
    int abt_errno = ABT_SUCCESS;
    ABTI_timer *p_timer = ABTI_timer_get_ptr(timer);
    ABTI_CHECK_NULL_TIMER_PTR(p_timer);

    double start, end;

    start = ABTD_time_read_sec(&p_timer->start);
    end = ABTD_time_read_sec(&p_timer->end);

    *secs = end - start;

fn_exit:
    return abt_errno;

fn_fail:
    HANDLE_ERROR_FUNC_WITH_CODE(abt_errno);
    goto fn_exit;
}

int ABT_timer_stop_and_read(ABT_timer timer, double *secs)
{
    int abt_errno = ABT_SUCCESS;
    ABTI_timer *p_timer = ABTI_timer_get_ptr(timer);
    ABTI_CHECK_NULL_TIMER_PTR(p_timer);

    double start, end;

    ABTD_time_get(&p_timer->end);
    start = ABTD_time_read_sec(&p_timer->start);
    end = ABTD_time_read_sec(&p_timer->end);

    *secs = end - start;

fn_exit:
    return abt_errno;

fn_fail:
    HANDLE_ERROR_FUNC_WITH_CODE(abt_errno);
    goto fn_exit;
}

int ABT_timer_stop_and_add(ABT_timer timer, double *secs)
{
    int abt_errno = ABT_SUCCESS;
    ABTI_timer *p_timer = ABTI_timer_get_ptr(timer);
    ABTI_CHECK_NULL_TIMER_PTR(p_timer);

    double start, end;

    ABTD_time_get(&p_timer->end);
    start = ABTD_time_read_sec(&p_timer->start);
    end = ABTD_time_read_sec(&p_timer->end);

    *secs += (end - start);

fn_exit:
    return abt_errno;

fn_fail:
    HANDLE_ERROR_FUNC_WITH_CODE(abt_errno);
    goto fn_exit;
}

int ABT_timer_get_overhead(double *overhead)
{
    int abt_errno = ABT_SUCCESS;
    ABT_timer h_timer;
    int i;
    const int iter = 5000;
    double secs, sum = 0.0;

    abt_errno = ABT_timer_create(&h_timer);
    ABTI_CHECK_ERROR(abt_errno);

    for (i = 0; i < iter; i++) {
        ABT_timer_start(h_timer);
        ABT_timer_stop(h_timer);
        ABT_timer_read(h_timer, &secs);
        sum += secs;
    }

    abt_errno = ABT_timer_free(&h_timer);
    ABTI_CHECK_ERROR(abt_errno);

    *overhead = sum / iter;

fn_exit:
    return abt_errno;

fn_fail:
    HANDLE_ERROR_FUNC_WITH_CODE(abt_errno);
    goto fn_exit;
}

/*****************************************************************************/
/* Internal functions                                                        */
/*****************************************************************************/

int ABTI_timer_create(ABTI_timer **pp_newtimer)
{
    int abt_errno = ABT_SUCCESS;

    /* We use libc malloc/free for ABT_timer because ABTU_malloc/free might
     * need the initialization of Argobots if they are not the same as libc
     * malloc/free.  This is to allow ABT_timer to be used irrespective of
     * Argobots initialization. */
    ABTI_timer *p_newtimer = (ABTI_timer *)malloc(sizeof(ABTI_timer));
    ABTI_CHECK_TRUE(p_newtimer != NULL, ABT_ERR_MEM);

    *pp_newtimer = p_newtimer;

fn_exit:
    return abt_errno;

fn_fail:
    HANDLE_ERROR_FUNC_WITH_CODE(abt_errno);
    goto fn_exit;
}