stmt_blk.c File Reference

#include <assert.h>
#include "db.h"
#include "defines.h"
#include "expr.h"
#include "func_unit.h"
#include "gen_item.h"
#include "link.h"
#include "obfuscate.h"
#include "profiler.h"
#include "statement.h"
#include "stmt_blk.h"

Functions
void	stmt_blk_add_to_remove_list (statement *stmt)
void	stmt_blk_remove ()
	Removes all statement blocks listed for removal.
void	stmt_blk_specify_removal_reason (logic_rm_type type, const char *file, int line, const char *cfile, int cline)
Variables
static stmt_link *	rm_stmt_head = NULL
static stmt_link *	rm_stmt_tail = NULL
static const char *	logic_rm_msgs [LOGIC_RM_NUM]
func_unit *	curr_funit
char	user_msg [USER_MSG_LENGTH]

---

Detailed Description

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

11/23/2005

---

Function Documentation

void stmt_blk_add_to_remove_list

(

statement *

stmt

)

Adds the statement block containing the specified statement to the list of statement blocks to remove after parsing, binding and race condition checking has occurred.

Parameters:

stmt

Pointer to statement in a statement block that needs to be removed

References statement_s::exp, funit_find_by_id(), generate_remove_stmt(), statement_s::head, expression_s::id, statement_s::part, PROFILE, PROFILE_END, stmt_link_add(), stmt_link_find(), statement_s::suppl, and TRUE.

Referenced by bind_perform(), bind_signal(), expression_dealloc(), funit_remove_stmt_blks_calling_stmt(), race_check_modules(), and statement_dealloc_recursive().

  { PROFILE(STMT_BLK_ADD_TO_REMOVE_LIST);

  func_unit* funit;  /* Pointer to functional unit containing this statement */

  assert( stmt != NULL );

#ifndef VPI_ONLY
  if( !generate_remove_stmt( stmt ) ) {
#endif

    /* If this is a head statement, don't bother looking this up again */
    if( stmt->suppl.part.head == 0 ) {

      /* Find the functional unit that contains this statement */
      funit = funit_find_by_id( stmt->exp->id );
      assert( funit != NULL );

      /* Find the head statement of the statement block that contains this statement */
      stmt = stmt->head;

    }

    /* If this statement has not been added to the removal list already, do so now */
    if( stmt_link_find( stmt->exp->id, rm_stmt_head ) == NULL ) {
      (void)stmt_link_add( stmt, TRUE, &rm_stmt_head, &rm_stmt_tail );
    }

#ifndef VPI_ONLY
  }
#endif

  PROFILE_END;

}

void stmt_blk_remove

(

)

Removes all statement blocks listed for removal.

Iterates through rm_stmt list, deallocating each statement block in that list. This function is only called once after the parsing, binding and race condition checking phases have completed.

References db_remove_stmt_blks_calling_statement(), statement_s::exp, FUNIT_AFUNCTION, FUNIT_ANAMED_BLOCK, FUNIT_ATASK, funit_find_by_id(), FUNIT_FUNCTION, FUNIT_NAMED_BLOCK, FUNIT_NO_SCORE, FUNIT_TASK, expression_s::id, PROFILE, PROFILE_END, statement_dealloc_recursive(), stmt_link_s::stmt, stmt_link_unlink(), TRUE, and func_unit_s::type.

Referenced by parse_design().

                       { PROFILE(STMT_BLK_REMOVE);

  statement* stmt;      /* Temporary pointer to current statement to deallocate */

  /* Remove all statement blocks */
  while( rm_stmt_head != NULL ) {
    stmt = rm_stmt_head->stmt;
    stmt_link_unlink( stmt, &rm_stmt_head, &rm_stmt_tail );
    curr_funit = funit_find_by_id( stmt->exp->id );
    assert( curr_funit != NULL );
    /*
     If we are removing the statement contained in a task, function or named block, we need to remove all statement
     blocks that contain expressions that call this task, function or named block.
    */
    if( (curr_funit->type == FUNIT_FUNCTION)  || (curr_funit->type == FUNIT_TASK)  || (curr_funit->type == FUNIT_NAMED_BLOCK) ||
        (curr_funit->type == FUNIT_AFUNCTION) || (curr_funit->type == FUNIT_ATASK) || (curr_funit->type == FUNIT_ANAMED_BLOCK) ) {
      curr_funit->type = FUNIT_NO_SCORE;
      db_remove_stmt_blks_calling_statement( stmt );
    }
    /* Deallocate the statement block now */
    statement_dealloc_recursive( stmt, TRUE );
  }

  PROFILE_END;

}

void stmt_blk_specify_removal_reason	(	logic_rm_type	type,
		const char *	file,
		int	line,
		const char *	cfile,
		int	cline
	)

Outputs the reason why a logic block is being removed from coverage consideration.

Parameters:

	type	Reason for removing the logic block
	file	Filename containing logic block being removed
	line	Line containing logic that is causing logic block removal
	cfile	File containing removal line
	cline	Line containing removal line

References logic_rm_msgs, print_output(), PROFILE, PROFILE_END, user_msg, USER_MSG_LENGTH, WARNING, and WARNING_WRAP.

  { PROFILE(STMT_BLK_SPECIFY_REMOVAL_REASON);

  unsigned int rv = snprintf( user_msg, USER_MSG_LENGTH, "Removing logic block containing line %d in file %s because", line, file );
  assert( rv < USER_MSG_LENGTH );
  print_output( user_msg, WARNING, cfile, cline );
  print_output( logic_rm_msgs[type], WARNING_WRAP, cfile, cline );

  PROFILE_END;

}

---

Variable Documentation

func_unit* curr_funit

Pointer to the functional unit structure for the functional unit that is currently being parsed.

const char* logic_rm_msgs[LOGIC_RM_NUM] [static]

Initial value:

 {
  "it contains a real number (currently unsupported)",
  "it contains an unsupported system function",
  "it contains an unsupported system task"
}

Array containing reasons for logic block removal

Referenced by stmt_blk_specify_removal_reason().

stmt_link* rm_stmt_head = NULL [static]

Pointer to head of statement block list to remove

stmt_link* rm_stmt_tail = NULL [static]

Pointer to tail of statement block list to remove

char user_msg[USER_MSG_LENGTH]

Holds some output that will be displayed via the print_output command. This is created globally so that memory does not need to be reallocated for each function that wishes to use it.