stat.h File Reference

Contains functions for handling coverage statistics. More...

#include "defines.h"

Go to the source code of this file.

Functions
void	statistic_create (statistic **stat)
	Creates and initializes a new statistic structure.
bool	statistic_is_empty (statistic *stat)
	Returns TRUE if the given statistic structure contains no coverage information.
void	statistic_dealloc (statistic *stat)
	Deallocates memory for a statistic structure.

---

Detailed Description

Contains functions for handling coverage statistics.

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

4/4/2002

---

Function Documentation

void statistic_create

(

statistic **

stat

)

Creates and initializes a new statistic structure.

Allocates new memory for a coverage statistic structure and initializes its values.

Parameters:

stat

Pointer to newly create/initialized statistic structure

References FALSE, malloc_safe, PROFILE, PROFILE_END, and TRUE.

Referenced by report_gather_funit_stats(), and report_gather_instance_stats().

  { PROFILE(STATISTIC_CREATE);

  if( *stat == NULL ) {
    *stat = (statistic*)malloc_safe( sizeof( statistic ) );
  }

  (*stat)->line_hit        = 0;
  (*stat)->line_excluded   = 0;
  (*stat)->line_total      = 0;
  (*stat)->tog01_hit       = 0;
  (*stat)->tog10_hit       = 0;
  (*stat)->tog_excluded    = 0;
  (*stat)->tog_total       = 0;
  (*stat)->tog_cov_found   = FALSE;
  (*stat)->comb_hit        = 0;
  (*stat)->comb_excluded   = 0;
  (*stat)->comb_total      = 0;
  (*stat)->state_total     = 0;
  (*stat)->state_hit       = 0;
  (*stat)->arc_total       = 0;
  (*stat)->arc_hit         = 0;
  (*stat)->arc_excluded    = 0;
  (*stat)->assert_hit      = 0;
  (*stat)->assert_excluded = 0;
  (*stat)->assert_total    = 0;
  (*stat)->mem_wr_hit      = 0;
  (*stat)->mem_rd_hit      = 0;
  (*stat)->mem_ae_total    = 0;
  (*stat)->mem_tog01_hit   = 0;
  (*stat)->mem_tog10_hit   = 0;
  (*stat)->mem_tog_total   = 0;
  (*stat)->mem_cov_found   = FALSE;
  (*stat)->mem_excluded    = 0;
  (*stat)->show            = TRUE;

  PROFILE_END;

}

void statistic_dealloc

(

statistic *

stat

)

Deallocates memory for a statistic structure.

Destroys the specified statistic structure from heap memory.

Parameters:

stat

Pointer to statistic structure to deallocate from heap

References free_safe, PROFILE, and PROFILE_END.

Referenced by funit_clean().

  { PROFILE(STATISTIC_DEALLOC);

  if( stat != NULL ) {
   
    /* Free up memory for entire structure */
    free_safe( stat, sizeof( statistic ) );

  }

  PROFILE_END;

}

bool statistic_is_empty

(

statistic *

stat

)

Returns TRUE if the given statistic structure contains no coverage information.

Returns:

Returns TRUE if the given statistic structure contains values of 0 for all of its metrics.

Parameters:

stat

Pointer to statistic structure to check

References statistic_s::arc_total, statistic_s::assert_total, statistic_s::comb_total, statistic_s::line_total, statistic_s::mem_ae_total, statistic_s::mem_tog_total, PROFILE, PROFILE_END, statistic_s::state_total, and statistic_s::tog_total.

Referenced by report_gather_funit_stats(), and report_gather_instance_stats().

  { PROFILE(STATISTIC_IS_EMPTY);

  bool retval;  /* Return value for this function */

  assert( stat != NULL );

  retval = (stat->line_total    == 0) &&
           (stat->tog_total     == 0) &&
           (stat->comb_total    == 0) &&
           (stat->state_total   == 0) &&
           (stat->arc_total     == 0) &&
           (stat->assert_total  == 0) &&
           (stat->mem_ae_total  == 0) &&
           (stat->mem_tog_total == 0);

  PROFILE_END;

  return( retval );

}