race.h File Reference

Contains functions used to check for race conditions and proper signal use within the specified design. More...

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

Go to the source code of this file.

Functions
void	race_check_modules ()
	Checks the current module for race conditions.
void	race_db_write (race_blk *head, FILE *file)
	Writes contents of specified race condition block to specified file output.
void	race_db_read (char **line, func_unit *curr_mod)
	Reads contents from specified line for a race condition block and assigns the new block to the curr_mod.
void	race_get_stats (race_blk *curr, unsigned int *race_total, unsigned int type_total[][RACE_TYPE_NUM])
	Get statistic information for the specified race condition block list.
void	race_report (FILE *ofile, bool verbose)
	Displays report information for race condition blocks in design.
void	race_collect_lines (func_unit *funit, int **slines, int **elines, int **reasons, int *line_cnt)
	Collects all of the lines in the specified module that were not verified due to race condition breach.
void	race_blk_delete_list (race_blk *rb)
	Deallocates the specified race condition block from memory.

---

Detailed Description

Contains functions used to check for race conditions and proper signal use within the specified design.

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

12/15/2004

---

Function Documentation

void race_blk_delete_list

(

race_blk *

rb

)

Deallocates the specified race condition block from memory.

Recursively deallocates the specified race condition block list.

Parameters:

rb

Pointer to race condition block to deallocate

References free_safe, race_blk_s::next, PROFILE, PROFILE_END, and race_blk_delete_list().

Referenced by funit_clean(), and race_blk_delete_list().

  { PROFILE(RACE_BLK_DELETE_LIST);

  if( rb != NULL ) {

    /* Delete the next race condition block first */
    race_blk_delete_list( rb->next );

    /* Deallocate the memory for this race condition block */
    free_safe( rb, sizeof( race_blk ) );

  }

  PROFILE_END;

}

void race_check_modules

(

)

Checks the current module for race conditions.

Exceptions:

anonymous

race_check_race_count funit_size_elements

Performs race checking for the currently loaded module. This function should be called when the endmodule keyword is detected in the current module.

References isuppl_u::assert_ovl, stmt_blk_s::bassign, stmt_blk_s::cmb, curr_db, DEBUG, debug_mode, FALSE, free_safe, funit_link_s::funit, db_s::funit_head, FUNIT_MODULE, funit_size_elements(), db_s::inst_head, inst_link_find_by_funit(), malloc_safe, func_unit_s::name, stmt_blk_s::nassign, funit_link_s::next, stmt_link_s::next, ovl_is_assertion_module(), statement_s::part, isuppl_u::part, print_output(), PROFILE, PROFILE_END, race_calc_assignments(), race_calc_stmt_blk_type(), race_check_assignment_types(), race_check_one_block_assignment(), race_check_race_count(), stmt_blk_s::remove, sb_size, stmt_blk_s::seq, stmt_blk_s::stmt, stmt_link_s::stmt, stmt_blk_add_to_remove_list(), stmt_conn_id, func_unit_s::stmt_head, str_link_find(), statement_s::suppl, and func_unit_s::type.

Referenced by parse_design().

                          { PROFILE(RACE_CHECK_MODULES);

  int         sb_index;  /* Index to statement block array */
  stmt_link*  curr;
  funit_link* modl;      /* Pointer to current module link */
  int         i;         /* Loop iterator */
  int         ignore;    /* Placeholder */
  funit_inst* inst;      /* Instance of this functional unit */

  modl = db_list[curr_db]->funit_head;

  while( modl != NULL ) {

    /* Get instance */
    ignore = 0;
    inst   = inst_link_find_by_funit( modl->funit, db_list[curr_db]->inst_head, &ignore );

    /* Only perform race condition checking for modules that are instantiated and are not OVL assertions and are not ignored */
    if( (modl->funit->type == FUNIT_MODULE) &&
        (inst != NULL) &&
        ((info_suppl.part.assert_ovl == 0) || !ovl_is_assertion_module( modl->funit )) &&
        (str_link_find( modl->funit->name, race_ignore_mod_head ) == NULL) ) {

      /* Size elements for the current module */
      funit_size_elements( modl->funit, inst, FALSE, FALSE );

      /* Clear statement block array size */
      sb_size = 0;

      /* First, get the size of the statement block array for this module */
      curr = modl->funit->stmt_head;
      while( curr != NULL ) {
        if( (curr->stmt->suppl.part.head == 1) &&
            (curr->stmt->suppl.part.is_called == 0) ) {
          sb_size++;
        }
        curr = curr->next;
      }

      if( sb_size > 0 ) {

        /* Allocate memory for the statement block array and clear current index */
        sb       = (stmt_blk*)malloc_safe( sizeof( stmt_blk ) * sb_size );
        sb_index = 0;

        /* Second, populate the statement block array with pointers to the head statements */
        curr = modl->funit->stmt_head;
        while( curr != NULL ) {
          if( (curr->stmt->suppl.part.head == 1) &&
              (curr->stmt->suppl.part.is_called == 0) ) {
            sb[sb_index].stmt    = curr->stmt;
            sb[sb_index].remove  = FALSE;
            sb[sb_index].seq     = FALSE;
            sb[sb_index].cmb     = FALSE;
            sb[sb_index].bassign = FALSE;
            sb[sb_index].nassign = FALSE;
            race_calc_stmt_blk_type( sb[sb_index].stmt->exp, sb_index );
            race_calc_assignments( sb[sb_index].stmt, sb_index );
            sb_index++; 
            stmt_conn_id++;
          }
          curr = curr->next;
        }

        /* Perform checks #1 - #5 */
        race_check_assignment_types( modl->funit );

        /* Perform check #6 */
        race_check_one_block_assignment( modl->funit );

        /* Cleanup statements to be removed */
        curr_funit = modl->funit;
        for( i=0; i<sb_size; i++ ) {
          if( sb[i].remove ) {
#ifdef DEBUG_MODE
            if( debug_mode ) {
              print_output( "Removing statement block because it was found to have a race condition", DEBUG, __FILE__, __LINE__ );
            }
#endif 
            stmt_blk_add_to_remove_list( sb[i].stmt );
          }
        }

        /* Deallocate stmt_blk list */
        free_safe( sb, (sizeof( stmt_blk ) * sb_size) );

      }

    }

    modl = modl->next;

  }

  /* Handle output if any race conditions were found */
  race_check_race_count();

  PROFILE_END;

}

void race_collect_lines	(	func_unit *	funit,
		int **	slines,
		int **	elines,
		int **	reasons,
		int *	line_cnt
	)

Collects all of the lines in the specified module that were not verified due to race condition breach.

Collects all of the line numbers in the specified module that were ignored from coverage due to detecting a race condition. This function is primarily used by the GUI for outputting purposes.

Parameters:

	funit	Pointer to functional unit
	slines	Pointer to an array of starting line numbers that contain line numbers of race condition statements
	elines	Pointer to an array of ending line numbers that contain line numbers of race condition statements
	reasons	Pointer to an array of race condition reason integers, one for each line in the lines array
	line_cnt	Pointer to number of elements that exist in lines array

References race_blk_s::end_line, race_blk_s::next, PROFILE, PROFILE_END, func_unit_s::race_head, realloc_safe, race_blk_s::reason, and race_blk_s::start_line.

  { PROFILE(RACE_COLLECT_LINES);

  race_blk* curr_race = NULL;  /* Pointer to current race condition block */

  /* Begin by allocating some memory for the lines */
  *slines   = NULL;
  *elines   = NULL;
  *reasons  = NULL;
  *line_cnt = 0;

  curr_race = funit->race_head;
  while( curr_race != NULL ) {

    *slines  = (int*)realloc_safe( *slines,  (sizeof( int ) * (*line_cnt)), (sizeof( int ) * (*line_cnt + 1)) );
    *elines  = (int*)realloc_safe( *elines,  (sizeof( int ) * (*line_cnt)), (sizeof( int ) * (*line_cnt + 1)) );
    *reasons = (int*)realloc_safe( *reasons, (sizeof( int ) * (*line_cnt)), (sizeof( int ) * (*line_cnt + 1)) );

    (*slines)[*line_cnt]  = curr_race->start_line;
    (*elines)[*line_cnt]  = curr_race->end_line;
    (*reasons)[*line_cnt] = curr_race->reason;
    (*line_cnt)++;

    curr_race = curr_race->next;

  }

  PROFILE_END;

}

void race_db_read	(	char **	line,
		func_unit *	curr_mod
	)

Reads contents from specified line for a race condition block and assigns the new block to the curr_mod.

Exceptions:

anonymous

Throw Throw

Reads the specified line from the CDD file and parses it for race condition block information.

Parameters:

	line	Pointer to line containing information for a race condition block
	curr_mod	Pointer to current module to store race condition block to

References FATAL, race_blk_s::next, print_output(), PROFILE, PROFILE_END, race_blk_create(), func_unit_s::race_head, func_unit_s::race_tail, and Throw.

Referenced by db_read(), and funit_db_mod_merge().

  { PROFILE(RACE_DB_READ);

  int       start_line;     /* Starting line for race condition block */
  int       end_line;       /* Ending line for race condition block */
  int       reason;         /* Reason for why the race condition block exists */
  int       chars_read;     /* Number of characters read via sscanf */
  race_blk* rb;             /* Pointer to newly created race condition block */

  if( sscanf( *line, "%d %d %d%n", &reason, &start_line, &end_line, &chars_read ) == 3 ) {

    *line = *line + chars_read;

    if( curr_mod == NULL ) {

      print_output( "Internal error:  race condition in database written before its functional unit", FATAL, __FILE__, __LINE__ );
      Throw 0;

    } else {

      /* Create the new race condition block */
      rb = race_blk_create( reason, start_line, end_line );

      /* Add the new race condition block to the current module */
      if( curr_mod->race_head == NULL ) {
        curr_mod->race_head = curr_mod->race_tail = rb;
      } else {
        curr_mod->race_tail->next = rb;
        curr_mod->race_tail       = rb;
      }

    }

  } else {

    print_output( "Unable to parse race condition line in database file.  Unable to read.", FATAL, __FILE__, __LINE__ );
    Throw 0;

  }

  PROFILE_END;

}

void race_db_write	(	race_blk *	rb,
		FILE *	file
	)

Writes contents of specified race condition block to specified file output.

Writes contents of specified race condition block to the specified output stream.

Parameters:

	rb	Pointer to race condition block to write to specified output file
	file	File handle of output stream to write

References DB_TYPE_RACE, race_blk_s::end_line, PROFILE, PROFILE_END, race_blk_s::reason, and race_blk_s::start_line.

Referenced by funit_db_write().

  { PROFILE(RACE_DB_WRITE);

  fprintf( file, "%d %d %d %d\n",
    DB_TYPE_RACE,
    rb->reason,
    rb->start_line,
    rb->end_line
  );

  PROFILE_END;

}

void race_get_stats	(	race_blk *	curr,
		unsigned int *	race_total,
		unsigned int	type_total[][RACE_TYPE_NUM]
	)

Get statistic information for the specified race condition block list.

Iterates through specified race condition block list, totaling the number of race conditions found as well as tallying each type of race condition.

Parameters:

	curr	Pointer to head of race condition block list
	race_total	Pointer to value that will hold the total number of race conditions in this module
	type_total	Pointer to array containing number of race conditions found for each violation type

References race_blk_s::next, PROFILE, PROFILE_END, and race_blk_s::reason.

Referenced by report_gather_funit_stats(), and report_gather_instance_stats().

  { PROFILE(RACE_GET_STATS);

  int i;  /* Loop iterator */

  /* Clear totals */
  *race_total = 0;
  for( i=0; i<RACE_TYPE_NUM; i++ ) {
    (*type_total)[i] = 0;
  }

  /* Tally totals */
  while( curr != NULL ) {
    (*type_total)[curr->reason]++;
    (*race_total)++;
    curr = curr->next;
  }

  PROFILE_END;

}

void race_report	(	FILE *	ofile,
		bool	verbose
	)

Displays report information for race condition blocks in design.

Generates the race condition report information and displays it to the specified output stream.

Parameters:

	ofile	Output stream to display report information to
	verbose	Specifies if summary or verbose output should be displayed

References curr_db, funit_head, PROFILE, PROFILE_END, race_report_summary(), and race_report_verbose().

Referenced by report_generate().

  { PROFILE(RACE_REPORT);

  bool found;  /* If set to TRUE, race conditions were found */

  fprintf( ofile, "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n" );
  fprintf( ofile, "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~   RACE CONDITION VIOLATIONS   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n" );
  fprintf( ofile, "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n" );
  fprintf( ofile, "Module                    Filename                 Number of Violations found\n" );
  fprintf( ofile, "---------------------------------------------------------------------------------------------------------------------\n" );

  found = race_report_summary( ofile, db_list[curr_db]->funit_head );

  if( verbose && found ) {
    fprintf( ofile, "---------------------------------------------------------------------------------------------------------------------\n" );
    race_report_verbose( ofile, db_list[curr_db]->funit_head );
  }

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

  PROFILE_END;

}