assertion.h File Reference

Contains functions for handling assertion coverage. More...

#include <stdio.h>
#include "defines.h"

Go to the source code of this file.

Functions
void	assertion_parse (const char *arg)
	Parses -A command-line option to score command.
void	assertion_parse_attr (attr_param *ap, int line, const func_unit *funit, bool exclude)
	Parses an in-line attribute for assertion coverage information.
void	assertion_get_stats (const func_unit *funit, unsigned int *hit, unsigned int *excluded, unsigned int *total)
	Gather statistics for assertion coverage.
void	assertion_report (FILE *ofile, bool verbose)
	Generates report output for assertion coverage.
void	assertion_get_funit_summary (func_unit *funit, unsigned int *hit, unsigned int *excluded, unsigned int *total)
	Retrieves the total and hit counts of assertions for the specified functional unit.
void	assertion_collect (func_unit *funit, int cov, char ***inst_names, int **excludes, unsigned int *inst_size)
	Collects uncovered and covered assertion instance names for the given module.
void	assertion_get_coverage (const func_unit *funit, const char *inst_name, char **assert_mod, str_link **cp_head, str_link **cp_tail)
	Gets missed coverage point descriptions for the given assertion module.

---

Detailed Description

Contains functions for handling assertion coverage.

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

4/4/2006

---

Function Documentation

void assertion_collect	(	func_unit *	funit,
		int	cov,
		char ***	inst_names,
		int **	excludes,
		unsigned int *	inst_size
	)

Collects uncovered and covered assertion instance names for the given module.

Searches the specified functional unit, collecting all uncovered or covered assertion module instance names.

Parameters:

	funit	Pointer to functional unit
	cov	Specifies if uncovered (0) or covered (1) assertions should be looked for
	inst_names	Pointer to array of uncovered instance names found within the specified functional unit
	excludes	Pointer to array of integers that contain the exclude information for the given instance names
	inst_size	Number of valid elements in the uncov_inst_names array

References isuppl_u::assert_ovl, ovl_collect(), isuppl_u::part, PROFILE, and PROFILE_END.

  { PROFILE(ASSERTION_COLLECT);
  
  /* Initialize outputs */
  *inst_names = NULL;
  *excludes   = NULL;
  *inst_size  = 0;
    
  /* If OVL assertion coverage is needed, get this information */
  if( info_suppl.part.assert_ovl == 1 ) {
    ovl_collect( funit, cov, inst_names, excludes, inst_size );
  }
    
  PROFILE_END;

}

void assertion_get_coverage	(	const func_unit *	funit,
		const char *	inst_name,
		char **	assert_mod,
		str_link **	cp_head,
		str_link **	cp_tail
	)

Gets missed coverage point descriptions for the given assertion module.

Finds all of the coverage points for the given assertion instance and stores their string descriptions and execution counts in the cp list.

Parameters:

	funit	Pointer to functional unit
	inst_name	Name of assertion module instance to retrieve
	assert_mod	Pointer to assertion module name and filename being retrieved
	cp_head	Pointer to head of list of strings/integers containing coverage point information
	cp_tail	Pointer to tail of list of strings/integers containing coverage point information

References isuppl_u::assert_ovl, ovl_get_coverage(), isuppl_u::part, PROFILE, and PROFILE_END.

  { PROFILE(ASSERTION_GET_COVERAGE);

  /* Find functional unit */
  *cp_head = *cp_tail = NULL;

  /* If OVL assertion coverage is needed, get this information */
  if( info_suppl.part.assert_ovl == 1 ) {
    ovl_get_coverage( funit, inst_name, assert_mod, cp_head, cp_tail );
  }

  PROFILE_END;
 
}

void assertion_get_funit_summary	(	func_unit *	funit,
		unsigned int *	hit,
		unsigned int *	excluded,
		unsigned int *	total
	)

Retrieves the total and hit counts of assertions for the specified functional unit.

Counts the total number and number of hit assertions for the specified functional unit.

Parameters:

	funit	Pointer to functional unit
	hit	Pointer to the number of hit assertions in the specified functional unit
	excluded	Pointer to the number of excluded assertions
	total	Pointer to the total number of assertions in the specified functional unit

References isuppl_u::assert_ovl, ovl_get_funit_stats(), isuppl_u::part, PROFILE, and PROFILE_END.

  { PROFILE(ASSERTION_GET_FUNIT_SUMMARY);
        
  /* Initialize total and hit counts */
  *hit      = 0;
  *excluded = 0;
  *total    = 0;
  
  if( info_suppl.part.assert_ovl == 1 ) {
    ovl_get_funit_stats( funit, hit, excluded, total );
  }
    
  PROFILE_END;
  
}

void assertion_get_stats	(	const func_unit *	funit,
		unsigned int *	hit,
		unsigned int *	excluded,
		unsigned int *	total
	)

Gather statistics for assertion coverage.

Gets total and hit assertion coverage statistics for the given functional unit.

Parameters:

	funit	Pointer to current functional unit
	hit	Pointer to the total number of hit assertions in this functional unit
	excluded	Pointer to the number of excluded assertions
	total	Pointer to the total number of assertions found in this functional unit

References isuppl_u::assert_ovl, ovl_get_funit_stats(), isuppl_u::part, PROFILE, and PROFILE_END.

Referenced by report_gather_funit_stats(), and report_gather_instance_stats().

  { PROFILE(ASSERTION_GET_STATS);

  assert( funit != NULL );

  /* Initialize total and hit values */
  *hit      = 0;
  *excluded = 0;
  *total    = 0;

  /* If OVL assertion coverage is needed, check this functional unit */
  if( info_suppl.part.assert_ovl == 1 ) {
    ovl_get_funit_stats( funit, hit, excluded, total );
  }

  PROFILE_END;

}

void assertion_parse

(

const char *

arg

)

Parses -A command-line option to score command.

Parameters:

arg

Command-line argument specified in -A option to score command to parse

Parses the specified command-line argument as an assertion to consider for coverage.

References PROFILE, and PROFILE_END.

                                                    { PROFILE(ASSERTION_PARSE);

  PROFILE_END;

}

void assertion_parse_attr	(	attr_param *	ap,
		int	line,
		const func_unit *	funit,
		bool	exclude
	)

Parses an in-line attribute for assertion coverage information.

Parses the specified assertion attribute for assertion coverage details.

Parameters:

	ap	Pointer to attribute to parse
	line	First line number of assertion
	funit	Pointer to current functional unit containing this attribute
	exclude	If TRUE, excludes this assertion from coverage consideration

References PROFILE, and PROFILE_END.

Referenced by attribute_parse().

  { PROFILE(ASSERTION_PARSE_ATTR);

  PROFILE_END;
}

void assertion_report	(	FILE *	ofile,
		bool	verbose
	)

Generates report output for assertion coverage.

Outputs assertion coverage report information to the given file handle.

Parameters:

	ofile	File to output report contents to
	verbose	Specifies if verbose report output needs to be generated

References assertion_display_funit_summary(), assertion_display_instance_summary(), assertion_funit_summary(), assertion_funit_verbose(), assertion_instance_summary(), assertion_instance_verbose(), curr_db, FALSE, funit_head, inst_link_s::inst, db_s::inst_head, funit_inst_s::name_diff, inst_link_s::next, PROFILE, PROFILE_END, report_covered, report_instance, and funit_inst_s::suppl.

Referenced by report_generate().

  { PROFILE(ASSERTION_REPORT);

  bool       missed_found = FALSE;  /* If set to TRUE, lines were found to be missed */
  inst_link* instl;                 /* Pointer to current instance link */
  int        acc_hits     = 0;      /* Total number of assertions hit */
  int        acc_total    = 0;      /* Total number of assertions in design */

  fprintf( ofile, "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n" );
  fprintf( ofile, "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~   ASSERTION COVERAGE RESULTS   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n" );
  fprintf( ofile, "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n" );

  if( report_instance ) {

    fprintf( ofile, "Instance                                           Hit/ Miss/Total    Percent hit\n" );
    fprintf( ofile, "---------------------------------------------------------------------------------------------------------------------\n" );

    instl = db_list[curr_db]->inst_head;
    while( instl != NULL ) {
      missed_found |= assertion_instance_summary( ofile, instl->inst, (instl->inst->suppl.name_diff ? "<NA>" : "*"), &acc_hits, &acc_total );
      instl = instl->next;
    }
    fprintf( ofile, "---------------------------------------------------------------------------------------------------------------------\n" );
    (void)assertion_display_instance_summary( ofile, "Accumulated", acc_hits, acc_total );

    if( verbose && (missed_found || report_covered) ) {
      fprintf( ofile, "---------------------------------------------------------------------------------------------------------------------\n" );
      instl = db_list[curr_db]->inst_head;
      while( instl != NULL ) {
        assertion_instance_verbose( ofile, instl->inst, (instl->inst->suppl.name_diff ? "<NA>" : "*") );
        instl = instl->next;
      }

    }

  } else {

    fprintf( ofile, "Module/Task/Function      Filename                 Hit/ Miss/Total    Percent hit\n" );
    fprintf( ofile, "---------------------------------------------------------------------------------------------------------------------\n" );

    missed_found = assertion_funit_summary( ofile, db_list[curr_db]->funit_head, &acc_hits, &acc_total );
    fprintf( ofile, "---------------------------------------------------------------------------------------------------------------------\n" );
    (void)assertion_display_funit_summary( ofile, "Accumulated", "", acc_hits, acc_total );

    if( verbose && (missed_found || report_covered) ) {
      fprintf( ofile, "---------------------------------------------------------------------------------------------------------------------\n" );
      assertion_funit_verbose( ofile, db_list[curr_db]->funit_head );
    }

  }

  fprintf( ofile, "\n\n" );

  PROFILE_END;

}