/*
 * Copyright 2005, 2016. Rene Rivera
 * Distributed under the Boost Software License, Version 1.0.
 * (See accompanying file LICENSE_1_0.txt or copy at
 * http://www.boost.org/LICENSE_1_0.txt)
 */

#ifndef BJAM_DEBUG_H
#define BJAM_DEBUG_H

#include "config.h"
#include "constants.h"
#include "object.h"


typedef struct profile_info
{
    /* name of rule being called */
    OBJECT * name;
    /* cumulative time spent in rule, in seconds */
    double cumulative;
    /* time spent in rule proper, in seconds */
    double net;
    /* number of time rule was entered */
    unsigned long num_entries;
    /* number of the times this function is present in stack */
    unsigned long stack_count;
    /* memory allocated by the call, in KiB */
    double memory;
} profile_info;

typedef struct profile_frame
{
    /* permanent storage where data accumulates */
    profile_info * info;
    /* overhead for profiling in this call */
    double overhead;
    /* time of last entry to rule */
    double entry_time;
    /* stack frame of caller */
    struct profile_frame * caller;
    /* time spent in subrules */
    double subrules;
} profile_frame;

profile_frame * profile_init( OBJECT * rulename, profile_frame * );
void profile_enter( OBJECT * rulename, profile_frame * );
void profile_memory( long mem );
void profile_exit( profile_frame * );
void profile_dump();
double profile_clock();

#define PROFILE_ENTER( scope ) profile_frame PROF_ ## scope, *PROF_ ## scope ## _p = profile_init( constant_ ## scope, &PROF_ ## scope )
#define PROFILE_EXIT( scope ) profile_exit( PROF_ ## scope ## _p )

OBJECT * profile_make_local( char const * );
#define PROFILE_ENTER_LOCAL( scope ) \
    static OBJECT * constant_LOCAL_##scope = 0; \
    if (DEBUG_PROFILE && !constant_LOCAL_##scope) constant_LOCAL_##scope = profile_make_local( #scope ); \
    PROFILE_ENTER( LOCAL_##scope )
#define PROFILE_EXIT_LOCAL( scope ) PROFILE_EXIT( LOCAL_##scope )

#endif