func_unit.h File Reference

Contains functions for handling functional units. More...

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

Go to the source code of this file.

Functions
func_unit *	funit_create ()
	Creates new functional unit from heap and initializes structure.
func_unit *	funit_get_curr_module (func_unit *funit)
	Returns the parent module of the given functional unit.
const func_unit *	funit_get_curr_module_safe (const func_unit *funit)
	Returns the parent module of the given functional unit (returning a const version).
func_unit *	funit_get_curr_function (func_unit *funit)
	Returns the parent function of the given functional unit (if there is one).
func_unit *	funit_get_curr_task (func_unit *funit)
	Returns the parent task of the given functional unit (if there is one).
int	funit_get_port_count (func_unit *funit)
	Returns the number of input, output and inout ports in the specified functional unit.
mod_parm *	funit_find_param (char *name, func_unit *funit)
	Finds specified module parameter given the current functional unit and its scope.
vsignal *	funit_find_signal (char *name, func_unit *funit)
	Finds specified signal given in the current functional unit.
void	funit_remove_stmt_blks_calling_stmt (func_unit *funit, statement *stmt)
	Finds all expressions that call the given statement.
char *	funit_gen_task_function_namedblock_name (char *orig_name, func_unit *parent)
	Generates the internally used task/function/named-block name for the specified functional unit.
void	funit_size_elements (func_unit *funit, funit_inst *inst, bool gen_all, bool alloc_exprs)
	Sizes all elements for the current functional unit from the given instance.
void	funit_db_write (func_unit *funit, char *scope, bool name_diff, FILE *file, funit_inst *inst, bool ids_issued)
	Writes contents of provided functional unit to specified output.
void	funit_db_read (func_unit *funit, char *scope, bool *name_diff, char **line)
	Read contents of current line from specified file, creates functional unit and adds to functional unit list.
void	funit_version_db_read (func_unit *funit, char **line)
	Reads the functional unit version information from the functional unit line and adds it to the current functional unit.
void	funit_db_inst_merge (func_unit *base, FILE *file, bool same)
	Performs an instance merge with the given base functional unit.
void	funit_db_mod_merge (func_unit *base, FILE *file, bool same)
	Performs a module merge with the given base functional unit.
void	funit_merge (func_unit *base, func_unit *other)
	Merges two functional units into the base functional unit.
void	funit_db_merge (func_unit *base, FILE *file, bool same)
	Reads and merges two functional units into base functional unit.
char *	funit_flatten_name (func_unit *funit)
	Flattens the functional unit name by removing all unnamed scope portions.
func_unit *	funit_find_by_id (int id)
	Finds the functional unit that contains the given statement/expression ID.
bool	funit_is_top_module (func_unit *funit)
	Returns TRUE if the given functional unit does not contain any input, output or inout ports.
bool	funit_is_unnamed (func_unit *funit)
	Returns TRUE if the given functional unit is an unnamed scope.
bool	funit_is_unnamed_child_of (func_unit *parent, func_unit *child)
	Returns TRUE if the specified "parent" functional unit is a parent of the "child" functional unit.
bool	funit_is_child_of (func_unit *parent, func_unit *child)
	Returns TRUE if the specified "parent" functional unit is a parent of the "child" functional unit.
void	funit_display_signals (func_unit *funit)
	Displays signals stored in this functional unit.
void	funit_display_expressions (func_unit *funit)
	Displays expressions stored in this functional unit.
void	funit_add_thread (func_unit *funit, thread *thr)
	Adds given thread to functional unit's thread pointer/thread pointer list.
void	funit_push_threads (func_unit *funit, const statement *stmt, const sim_time *time)
	Pushes the threads associated with the given functional unit onto the active simulation queue.
void	funit_delete_thread (func_unit *funit, thread *thr)
	Removes given thread from the given functional unit's thread pointer/thread pointer list.
void	funit_output_dumpvars (FILE *vfile, func_unit *funit, const char *scope)
	Outputs dumpvars calls to the given file.
bool	funit_is_one_signal_assigned (func_unit *funit)
	Returns TRUE if at least one signal was found that needs to be assigned by the dumpfile.
void	funit_dealloc (func_unit *funit)
	Deallocates functional unit element from heap.

---

Detailed Description

Contains functions for handling functional units.

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

12/7/2001

---

Function Documentation

void funit_add_thread	(	func_unit *	funit,
		thread *	thr
	)

Adds given thread to functional unit's thread pointer/thread pointer list.

Parameters:

	funit	Pointer to functional unit to add given thread pointer to
	thr	Pointer to thread associated with this statement

Adds the given thread to the given functional unit's thread/thread list element pointer, allocating memory as needed and adjusting values as needed.

References func_unit_s::elem, func_unit_s::elem_type, thr_list_s::head, malloc_safe, thr_list_s::next, thr_link_s::next, PROFILE, thr_list_s::tail, thr_link_s::thr, func_unit_s::thr, and func_unit_s::tlist.

Referenced by sim_create_thread().

  { PROFILE(STATEMENT_ADD_THREAD);

  assert( funit != NULL );
  assert( thr != NULL );

  /* Statement element should point to a thread */
  if( funit->elem_type == 0 ) {

    /* If the statement element currently points to nothing, simply point the statement element to the given thread */
    if( funit->elem.thr == NULL ) {
      funit->elem.thr = thr;

    /* Otherwise, change the type to a thread list, create a thread list, initialize it and continue */
    } else {

      thr_list* tlist;  /* Pointer to thread list */

      /* Allocate memory for the thread list */
      tlist = (thr_list*)malloc_safe( sizeof( thr_list ) );

      /* Create new thread link for existing thread */
      tlist->head      = (thr_link*)malloc_safe( sizeof( thr_link ) );
      tlist->head->thr = funit->elem.thr;
  
      /* Create new thread link for specified thread */
      tlist->tail       = (thr_link*)malloc_safe( sizeof( thr_link ) );
      tlist->tail->thr  = thr;
      tlist->tail->next = NULL;
      tlist->head->next = tlist->tail;

      /* Specify the next pointer to be NULL (to indicate that there aren't any available thread links to use) */
      tlist->next = NULL;
    
      /* Repopulate the functional unit */
      funit->elem.tlist = tlist;
      funit->elem_type  = 1;
  
    }

  /* Otherwise, the statement element is a pointer to a thread list already */
  } else {

    /* If there are no thread links already allocated and available, allocate a new thread link */
    if( funit->elem.tlist->next == NULL ) {

      thr_link* thrl;  /* Pointer to a thread link */
    
      /* Allocate and initialize thread link */
      thrl       = (thr_link*)malloc_safe( sizeof( thr_link ) );
      thrl->thr  = thr;
      thrl->next = NULL;

      /* Add the new thread link to the list */
      funit->elem.tlist->tail->next = thrl;
      funit->elem.tlist->tail       = thrl;

    /* Otherwise, use the link pointed at by next and adjust next */
    } else {

      funit->elem.tlist->next->thr = thr;
      funit->elem.tlist->next      = funit->elem.tlist->next->next;

    }

  }

}

func_unit* funit_create

(

)

Creates new functional unit from heap and initializes structure.

Returns:

Returns pointer to newly created functional unit element that has been properly initialized.

Allocates memory from the heap for a functional unit element and initializes all contents to NULL. Returns a pointer to the newly created functional unit.

References funit_init(), malloc_safe, PROFILE, and PROFILE_END.

Referenced by db_add_instance(), db_read(), and search_init().

                          { PROFILE(FUNIT_CREATE);

  func_unit* funit;   /* Pointer to newly created functional unit element */

  /* Create and initialize functional unit */
  funit = (func_unit*)malloc_safe( sizeof( func_unit ) );

  funit_init( funit );

  PROFILE_END;

  return( funit );

}

void funit_db_inst_merge	(	func_unit *	base,
		FILE *	file,
		bool	same
	)

Performs an instance merge with the given base functional unit.

Exceptions:

anonymous

fsm_db_merge Throw Throw expression_db_merge vsignal_db_merge

Parses specified line for functional unit information and performs a merge of the two specified functional units, placing the resulting merge functional unit into the functional unit named base. If there are any differences between the two functional units, a warning or error will be displayed to the user.

Parameters:

	base	Module that will merge in that data from the in functional unit
	file	Pointer to CDD file handle to read
	same	Specifies if functional unit to be merged should match existing functional unit exactly or not

References Catch_anonymous, DB_TYPE_EXPRESSION, DB_TYPE_FSM, DB_TYPE_FUNIT_VERSION, DB_TYPE_RACE, DB_TYPE_SIGNAL, DB_TYPE_STATEMENT, exp_link_s::exp, func_unit_s::exp_head, expression_db_merge(), FATAL, free_safe, fsm_db_merge(), func_unit_s::fsm_head, FUNIT_MODULE, func_unit_s::name, race_blk_s::next, fsm_link_s::next, stmt_link_s::next, sig_link_s::next, exp_link_s::next, print_output(), PROFILE, PROFILE_END, func_unit_s::race_head, sig_link_s::sig, func_unit_s::sig_head, func_unit_s::stmt_head, fsm_link_s::table, Throw, Try, func_unit_s::type, util_readline(), func_unit_s::version, and vsignal_db_merge().

Referenced by db_read().

  { PROFILE(FUNIT_DB_INST_MERGE);

  exp_link*    curr_base_exp;   /* Pointer to current expression in base functional unit expression list */
  sig_link*    curr_base_sig;   /* Pointer to current signal in base functional unit signal list */
  stmt_link*   curr_base_stmt;  /* Statement list iterator */
  fsm_link*    curr_base_fsm;   /* Pointer to current FSM in base functional unit FSM list */
  race_blk*    curr_base_race;  /* Pointer to current race condition block in base module list  */
  char*        curr_line;       /* Pointer to current line being read from CDD */
  unsigned int curr_line_size;  /* Number of bytes allocated for curr_line */
  char*        rest_line;       /* Pointer to rest of read line */
  int          type;            /* Specifies currently read CDD type */
  int          chars_read;      /* Number of characters read from current CDD line */

  assert( base != NULL );
  assert( base->name != NULL );

  /* Handle the functional unit version, if specified */
  if( base->version != NULL ) {
    if( util_readline( file, &curr_line, &curr_line_size ) ) {
      Try {
        if( sscanf( curr_line, "%d%n", &type, &chars_read ) == 1 ) {
          rest_line = curr_line + chars_read;
          if( type == DB_TYPE_FUNIT_VERSION ) {
            while( *rest_line == ' ' ) rest_line++;
            if( strcmp( base->version, rest_line ) != 0 ) {
              print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
              Throw 0;
            }
          } else {
            print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
            Throw 0;
          }
        } else {
          print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
          Throw 0;
        }
      } Catch_anonymous {
        free_safe( curr_line, curr_line_size );
        Throw 0;
      }
    } else {
      print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
      Throw 0;
    }
  }

  /* Handle all functional unit expressions */
  curr_base_exp = base->exp_head;
  while( curr_base_exp != NULL ) {
    if( util_readline( file, &curr_line, &curr_line_size ) ) {
      Try {
        if( sscanf( curr_line, "%d%n", &type, &chars_read ) == 1 ) {
          rest_line = curr_line + chars_read;
          if( type == DB_TYPE_EXPRESSION ) {
            expression_db_merge( curr_base_exp->exp, &rest_line, same );
          } else {
            print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
            Throw 0;
          }
        } else {
          print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
          Throw 0;
        }
      } Catch_anonymous {
        free_safe( curr_line, curr_line_size );
        Throw 0;
      }
      free_safe( curr_line, curr_line_size );
    } else {
      print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
      Throw 0;
    }
    curr_base_exp = curr_base_exp->next;
  }

  /* Handle all functional unit signals */
  curr_base_sig = base->sig_head;
  while( curr_base_sig != NULL ) {
    if( util_readline( file, &curr_line, &curr_line_size ) ) {
      Try {
        if( sscanf( curr_line, "%d%n", &type, &chars_read ) == 1 ) {
          rest_line = curr_line + chars_read;
          if( type == DB_TYPE_SIGNAL ) {
            vsignal_db_merge( curr_base_sig->sig, &rest_line, same );
          } else {
            print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
            Throw 0;
          }
        } else {
          print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
          Throw 0;
        }
      } Catch_anonymous {
        free_safe( curr_line, curr_line_size );
        Throw 0;
      }
      free_safe( curr_line, curr_line_size );
    } else {
      print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
      Throw 0;
    }
    curr_base_sig = curr_base_sig->next;
  }

  /* Since statements don't get merged, we will just read these lines in */
  curr_base_stmt = base->stmt_head;
  while( curr_base_stmt != NULL ) {
    if( util_readline( file, &curr_line, &curr_line_size ) ) {
      Try {
        if( sscanf( curr_line, "%d%n", &type, &chars_read ) == 1 ) {
          rest_line = curr_line + chars_read;
          if( type != DB_TYPE_STATEMENT ) {
            print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
            Throw 0;
          }
        } else {
          print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
          Throw 0;
        }
      } Catch_anonymous {
        free_safe( curr_line, curr_line_size );
        Throw 0;
      }
      free_safe( curr_line, curr_line_size );
    } else {
      print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
      Throw 0;
    }
    curr_base_stmt = curr_base_stmt->next;
  }

  /* Handle all functional unit FSMs */
  curr_base_fsm = base->fsm_head;
  while( curr_base_fsm != NULL ) {
    if( util_readline( file, &curr_line, &curr_line_size ) ) {
      Try {
        if( sscanf( curr_line, "%d%n", &type, &chars_read ) == 1 ) {
          rest_line = curr_line + chars_read;
          if( type == DB_TYPE_FSM ) {
            fsm_db_merge( curr_base_fsm->table, &rest_line );
          } else {
            print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
            Throw 0;
          }
        } else {
          print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
          Throw 0;
        }
      } Catch_anonymous {
        free_safe( curr_line, curr_line_size );
        Throw 0;
      }
      free_safe( curr_line, curr_line_size );
    } else {
      print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
      Throw 0;
    }
    curr_base_fsm = curr_base_fsm->next;
  }

  /* Since race condition blocks don't get merged, we will just read these lines in */
  if( base->type == FUNIT_MODULE ) {
    curr_base_race = base->race_head;
    while( curr_base_race != NULL ) {
      if( util_readline( file, &curr_line, &curr_line_size ) ) {
        Try {
          if( sscanf( curr_line, "%d%n", &type, &chars_read ) == 1 ) {
            rest_line = curr_line + chars_read;
            if( type != DB_TYPE_RACE ) {
              print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
              Throw 0;
            }
          } else {
            print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
            Throw 0;
          }
        } Catch_anonymous {
          free_safe( curr_line, curr_line_size );
          Throw 0;
        }
        free_safe( curr_line, curr_line_size );
      } else {
        print_output( "Databases being merged are incompatible.", FATAL, __FILE__, __LINE__ );
        Throw 0;
      }
      curr_base_race = curr_base_race->next;
    }
  }

  PROFILE_END;

}

void funit_db_merge	(	func_unit *	base,
		FILE *	file,
		bool	same
	)

Reads and merges two functional units into base functional unit.

void funit_db_mod_merge	(	func_unit *	base,
		FILE *	file,
		bool	same
	)

Performs a module merge with the given base functional unit.

Exceptions:

anonymous

fsm_db_merge Throw Throw expression_db_merge vsignal_db_merge

Parses specified line for functional unit information and performs a merge of the two specified functional units, placing the resulting merge functional unit into the functional unit named base. If there are any differences between the two functional units, a warning or error will be displayed to the user.

Parameters:

	base	Module that will merge in that data from the in functional unit
	file	Pointer to CDD file handle to read
	same	Specifies if functional unit to be merged should match existing functional unit exactly or not

References Catch_anonymous, DB_TYPE_EXPRESSION, DB_TYPE_FSM, DB_TYPE_FUNIT, DB_TYPE_FUNIT_VERSION, DB_TYPE_RACE, DB_TYPE_SIGNAL, DB_TYPE_STATEMENT, race_blk_s::end_line, exp_link_s::exp, func_unit_s::exp_head, exp_link_find_by_pos(), expression_db_merge(), expression_db_read(), FALSE, FATAL, free_safe, fsm_db_merge(), fsm_db_read(), func_unit_s::fsm_head, fsm_link_find_by_pos(), func_unit_s::name, race_blk_s::next, print_output(), PROFILE, PROFILE_END, race_db_read(), func_unit_s::race_head, READ_MODE_REPORT_MOD_MERGE, race_blk_s::reason, sig_link_s::sig, func_unit_s::sig_head, sig_link_find(), race_blk_s::start_line, statement_db_read(), func_unit_s::stmt_head, stmt_link_find_by_pos(), fsm_link_s::table, Throw, TRUE, Try, util_readline(), vsignal_db_merge(), and vsignal_db_read().

Referenced by db_read().

  { PROFILE(FUNIT_DB_MOD_MERGE);

  fsm_link*    curr_base_fsm;   /* Pointer to current FSM in base functional unit FSM list */
  char*        curr_line;       /* Pointer to current line being read from CDD */
  unsigned int curr_line_size;  /* Number of bytes allocated for curr_line */
  char*        rest_line;       /* Pointer to rest of read line */
  int          type;            /* Specifies currently read CDD type */
  int          chars_read;      /* Number of characters read from current CDD line */
  bool         new_funit_found = FALSE;

  assert( base != NULL );
  assert( base->name != NULL );

  /* Initialize pointers */
  curr_base_fsm  = base->fsm_head;

  /* Parse the current functional unit in the CDD file */
  while( !new_funit_found && util_readline( file, &curr_line, &curr_line_size ) ) {

    if( sscanf( curr_line, "%d%n", &type, &chars_read ) == 1 ) {

      rest_line = curr_line + chars_read;
   
      Try {

        switch( type ) {

          case DB_TYPE_FUNIT_VERSION :
            /* Do nothing */
            break;

          case DB_TYPE_EXPRESSION :
            {
              int         id;
              exp_op_type op;
              int         line;
              uint32      col;
              if( sscanf( rest_line, "%d %x %d %x", &id, &op, &line, &col ) == 4 ) {
                exp_link* expl = exp_link_find_by_pos( op, line, col, base->exp_head );
                if( expl != NULL ) {
                  expression_db_merge( expl->exp, &rest_line, FALSE );
                } else {
                  expression_db_read( &rest_line, base, FALSE );
                }
              } else {
                print_output( "Illegal CDD file format", FATAL, __FILE__, __LINE__ );
                Throw 0;
              }
              break;
            }

          case DB_TYPE_SIGNAL :
            {
              char name[256];
              if( sscanf( rest_line, "%s", name ) == 1 ) {
                sig_link* sigl = sig_link_find( name, base->sig_head );
                if( sigl != NULL ) {
                  vsignal_db_merge( sigl->sig, &rest_line, FALSE );
                } else {
                  vsignal_db_read( &rest_line, base );
                }
              } else {
                print_output( "Illegal CDD file format", FATAL, __FILE__, __LINE__ );
                Throw 0;
              }
              break;
            }

          case DB_TYPE_STATEMENT :
            {
              int          id;
              unsigned int ppline;
              uint32       first_col;
              if( sscanf( rest_line, "%d %u %u", &id, &ppline, &first_col ) == 3 ) {
                stmt_link* stmtl = stmt_link_find_by_pos( ppline, first_col, base->stmt_head );
                if( stmtl == NULL ) {
                  statement_db_read( &rest_line, base, READ_MODE_REPORT_MOD_MERGE );
                }
              } else {
                print_output( "Illegal CDD file format", FATAL, __FILE__, __LINE__ );
                Throw 0;
              }
              break;
            }

          case DB_TYPE_FSM :
            {
              int line;
              if( sscanf( rest_line, "%d", &line ) == 1 ) {
                fsm_link* fsml = fsm_link_find_by_pos( line, base->fsm_head );
                if( fsml == NULL ) {
                  fsm_db_read( &rest_line, base );
                } else {
                  fsm_db_merge( curr_base_fsm->table, &rest_line );
                }
              } else {
                print_output( "Illegal CDD file format", FATAL, __FILE__, __LINE__ );
                Throw 0;
              }
              break;
            }

          case DB_TYPE_RACE :
            {
              int reason;
              int start_line;
              int end_line;
              if( sscanf( rest_line, "%d %d %d", &reason, &start_line, &end_line ) == 3 ) {
                race_blk* rb = base->race_head;
                while( (rb != NULL) && ((rb->reason != reason) || (rb->start_line != start_line) || (rb->end_line != end_line)) ) {
                  rb = rb->next;
                }
                if( rb == NULL ) {
                  race_db_read( &rest_line, base );
                }
              } else {
                print_output( "Illegal CDD file format", FATAL, __FILE__, __LINE__ );
                Throw 0;
              }
              break;
            }

          /* If the type is a new functional unit, move the current file pointer back to the beginning of the line */
          case DB_TYPE_FUNIT :
            {
              int rv = fseek( file, (0 - (strlen( curr_line ) + 1)), SEEK_CUR );
              assert( rv == 0 );
              new_funit_found = TRUE;
              break;
            }

          default :
            print_output( "Illegal CDD file format", FATAL, __FILE__, __LINE__ );
            Throw 0;
            /*@-unreachable@*/
            break;
            /*@=unreachable@*/

        }

      } Catch_anonymous {
        free_safe( curr_line, curr_line_size );
        Throw 0;
      }

    }

    /* Deallocate the current line string */
    free_safe( curr_line, curr_line_size );

  }

  PROFILE_END;

}

void funit_db_read	(	func_unit *	funit,
		char *	scope,
		bool *	name_diff,
		char **	line
	)

Read contents of current line from specified file, creates functional unit and adds to functional unit list.

Exceptions:

anonymous

Throw

Reads the current line of the specified file and parses it for a functional unit. If all is successful, returns TRUE; otherwise, returns FALSE.

Parameters:

	funit	Pointer to functional unit to read contents into
	scope	Pointer to name of read functional unit scope
	name_diff	Will cause the name_diff value of the instance to get set to the same value
	line	Pointer to current line to parse

References func_unit_s::end_line, FATAL, func_unit_s::filename, func_unit_s::name, print_output(), PROFILE, PROFILE_END, func_unit_s::start_line, Throw, func_unit_s::timescale, func_unit_s::type, user_msg, and USER_MSG_LENGTH.

Referenced by db_read().

  { PROFILE(FUNIT_DB_READ);

  int  chars_read;   /* Number of characters currently read */
  int  params;       /* Number of parameters in string that were parsed */

  /*@-duplicatequals -formatcode -formattype@*/
  if( (params = sscanf( *line, "%d %s \"%[^\"]\" %d %s %d %d %" FMT64 "u%n", 
                        &(funit->type), funit->name, scope, (int*)name_diff, funit->filename,
                        &(funit->start_line), &(funit->end_line), &(funit->timescale), &chars_read )) == 8 ) {
  /*@=duplicatequals =formatcode =formattype@*/

    *line = *line + chars_read;

  } else {

    unsigned int rv = snprintf( user_msg, USER_MSG_LENGTH, "Internal Error:  Incorrect number of parameters for func_unit, should be 7 but is %d\n",
                                params );
    assert( rv < USER_MSG_LENGTH );
    print_output( user_msg, FATAL, __FILE__, __LINE__ );
    Throw 0;

  }

  PROFILE_END;

}

void funit_db_write	(	func_unit *	funit,
		char *	scope,
		bool	name_diff,
		FILE *	file,
		funit_inst *	inst,
		bool	ids_issued
	)

Writes contents of provided functional unit to specified output.

Exceptions:

anonymous

funit_size_elements

Prints the database line for the specified functional unit to the specified database file. If there are any problems with the write, returns FALSE; otherwise, returns TRUE.

Parameters:

	funit	Pointer to functional unit to write to output
	scope	String version of functional unit scope in hierarchy
	name_diff	Specifies that this instance has an inaccurate way
	file	Pointer to specified output file to write contents
	inst	Pointer to the current functional unit instance
	ids_issued	Specifies if IDs have been issued prior to calling this function

References curr_db, db_scale_to_precision(), DB_TYPE_FUNIT, DB_TYPE_FUNIT_VERSION, DEBUG, func_unit_s::end_line, func_unit_s::er_head, exclude_db_write(), exp_link_s::exp, func_unit_s::exp_head, expression_db_write(), FALSE, func_unit_s::filename, fsm_db_write(), func_unit_s::fsm_head, funit_inst_s::funit, FUNIT_AFUNCTION, FUNIT_ANAMED_BLOCK, FUNIT_ATASK, FUNIT_FUNCTION, FUNIT_MODULE, FUNIT_NAMED_BLOCK, FUNIT_NO_SCORE, funit_size_elements(), FUNIT_TASK, db_s::fver_head, gen_item_db_write(), gen_item_db_write_expr_tree(), get_funit_type(), gitem_link_s::gi, GI_TYPE_SIG, GI_TYPE_STMT, funit_inst_s::gitem_head, funit_inst_s::name, func_unit_s::name, exclude_reason_s::next, race_blk_s::next, fsm_link_s::next, stmt_link_s::next, inst_parm_s::next, sig_link_s::next, gitem_link_s::next, exp_link_s::next, obf_funit, param_db_write(), funit_inst_s::param_head, funit_inst_s::parent, print_output(), PROFILE, PROFILE_END, race_db_write(), func_unit_s::race_head, stmt_link_s::rm_stmt, scope_local(), sig_link_s::sig, func_unit_s::sig_head, func_unit_s::start_line, statement_db_write(), stmt_link_s::stmt, func_unit_s::stmt_head, str_link_s::str2, str_link_find(), strdup_safe, fsm_link_s::table, func_unit_s::timescale, TRUE, func_unit_s::type, user_msg, USER_MSG_LENGTH, func_unit_s::version, and vsignal_db_write().

Referenced by instance_db_write().

  { PROFILE(FUNIT_DB_WRITE);

  sig_link*       curr_sig;       /* Pointer to current functional unit sig_link element */
  exp_link*       curr_exp;       /* Pointer to current functional unit exp_link element */
  stmt_link*      curr_stmt;      /* Statement list iterator */
  inst_parm*      curr_parm;      /* Pointer to current instance parameter */
  fsm_link*       curr_fsm;       /* Pointer to current functional unit fsm_link element */
  race_blk*       curr_race;      /* Pointer to current race condition block */
#ifndef VPI_ONLY
  gitem_link*     curr_gi;        /* Pointer to current gitem_link element */
#endif
  exclude_reason* curr_er;        /* Pointer to current exclude reason element */
  char            modname[4096];  /* Name of module */
  char            tmp[4096];      /* Temporary string holder */
  str_link*       strl;           /* Pointer to string link */

  if( funit->type != FUNIT_NO_SCORE ) {

#ifdef DEBUG_MODE
    assert( (funit->type == FUNIT_MODULE)    || (funit->type == FUNIT_NAMED_BLOCK) ||
            (funit->type == FUNIT_FUNCTION)  || (funit->type == FUNIT_TASK)        ||
            (funit->type == FUNIT_AFUNCTION) || (funit->type == FUNIT_ATASK)       ||
            (funit->type == FUNIT_ANAMED_BLOCK) );
    {
      unsigned int rv = snprintf( user_msg, USER_MSG_LENGTH, "Writing %s %s", get_funit_type( funit->type ), obf_funit( funit->name ) );
      assert( rv < USER_MSG_LENGTH );
      print_output( user_msg, DEBUG, __FILE__, __LINE__ );
    }
#endif

    /* Calculate module name to display */
    if( scope_local( funit->name ) || (inst == NULL) ) {
      strcpy( modname, funit->name );
    } else {
      funit_inst*  parent_inst = inst->parent;
      unsigned int rv;
      strcpy( modname, inst->name );
      assert( parent_inst != NULL );
      while( parent_inst->funit->type != FUNIT_MODULE ) {
        unsigned int rv = snprintf( tmp, 4096, "%s.%s", parent_inst->name, modname );
        assert( rv < 4096 );
        strcpy( modname, tmp );
        parent_inst = parent_inst->parent;
      }
      rv = snprintf( tmp, 4096, "%s.%s", parent_inst->funit->name, modname );
      assert( rv < 4096 );
      strcpy( modname, tmp );
    }

    /* Size all elements in this functional unit and calculate timescale if we are in parse mode */
    if( inst != NULL ) {
      funit_size_elements( funit, inst, TRUE, FALSE );
      funit->timescale = db_scale_to_precision( (uint64)1, funit );
    }
  
    /*@-duplicatequals -formatcode -formattype@*/
    fprintf( file, "%d %d %s \"%s\" %d %s %d %d %" FMT64 "u\n",
      DB_TYPE_FUNIT,
      funit->type,
      modname,
      scope,
      name_diff,
      funit->filename,
      funit->start_line,
      funit->end_line,
      funit->timescale
    );
    /*@=duplicatequals =formatcode =formattype@*/

    /* Figure out if a file version exists for this functional unit */
    if( (funit->version == NULL) && ((strl = str_link_find( funit->filename, db_list[curr_db]->fver_head )) != NULL) ) {
      funit->version = strdup_safe( strl->str2 );
    }

    /* If a version was specified for this functional unit, write it now */
    if( funit->version != NULL ) {
      fprintf( file, "%d %s\n", DB_TYPE_FUNIT_VERSION, funit->version );
    }

    /* Now print all expressions in functional unit */
    curr_exp = funit->exp_head;
    while( curr_exp != NULL ) {
      expression_db_write( curr_exp->exp, file, (inst != NULL), ids_issued );
      curr_exp = curr_exp->next;
    }

#ifndef VPI_ONLY
    /* Now print all expressions within generated statements in functional unit */
    if( inst != NULL ) {
      curr_gi = inst->gitem_head;
      while( curr_gi != NULL ) {
        gen_item_db_write_expr_tree( curr_gi->gi, file );
        curr_gi = curr_gi->next;
      }
    }
#endif

    /* Now print all signals in functional unit */
    curr_sig = funit->sig_head;
    while( curr_sig != NULL ) {
      vsignal_db_write( curr_sig->sig, file );
      curr_sig = curr_sig->next; 
    }

    /* Now print all parameters in functional unit */
    if( inst != NULL ) {
      curr_parm = inst->param_head;
      while( curr_parm != NULL ) {
        param_db_write( curr_parm, file );
        curr_parm = curr_parm->next;
      }
    }

#ifndef VPI_ONLY
    /* Now print any generated signals in the current instance */
    if( inst != NULL ) {
      curr_gi = inst->gitem_head;
      while( curr_gi != NULL ) {
        gen_item_db_write( curr_gi->gi, GI_TYPE_SIG, file );
        curr_gi = curr_gi->next;
      }
    }
#endif

    /* Now print all statements in functional unit */
    curr_stmt = funit->stmt_head;
    while( curr_stmt != NULL ) {
      if( curr_stmt->rm_stmt ) {
        statement_db_write( curr_stmt->stmt, file, ids_issued );
      }
      curr_stmt = curr_stmt->next;
    }

#ifndef VPI_ONLY
    /* Now print any generated statements in the current instance */
    if( inst != NULL ) {
      curr_gi = inst->gitem_head;
      while( curr_gi != NULL ) {
        gen_item_db_write( curr_gi->gi, GI_TYPE_STMT, file );
        curr_gi = curr_gi->next;
      }
    }
#endif

    /* Now print all FSM structures in functional unit */
    curr_fsm = funit->fsm_head;
    while( curr_fsm != NULL ) {
      fsm_db_write( curr_fsm->table, file, ids_issued );
      curr_fsm = curr_fsm->next;
    }

    /* Now print all race condition block structures in functional unit (if we are a module) */
    if( funit->type == FUNIT_MODULE ) {
      curr_race = funit->race_head;
      while( curr_race != NULL ) {
        race_db_write( curr_race, file );
        curr_race = curr_race->next;
      }
    }

    /* Now print all of the exclusion reasons in the functional unit */
    curr_er = funit->er_head;
    while( curr_er != NULL ) {
      exclude_db_write( curr_er, file );
      curr_er = curr_er->next;
    }

  }

  PROFILE_END;

}

void funit_dealloc

(

func_unit *

funit

)

Deallocates functional unit element from heap.

Deallocates functional unit; name and filename strings; and finally the structure itself from the heap.

Parameters:

funit

Pointer to functional unit element to deallocate

References free_safe, funit_clean(), PROFILE, and PROFILE_END.

Referenced by db_add_instance(), db_read(), funit_link_delete_list(), funit_link_remove(), and gen_item_resolve().

  { PROFILE(FUNIT_DEALLOC);

  if( funit != NULL ) {

    /* Deallocate the contents of the functional unit itself */
    funit_clean( funit );

    /* Deallocate functional unit element itself */
    free_safe( funit, sizeof( func_unit ) );

  }

  PROFILE_END;

}

void funit_delete_thread	(	func_unit *	funit,
		thread *	thr
	)

Removes given thread from the given functional unit's thread pointer/thread pointer list.

Searches the given functional unit thread element for the given thread. When the thread is found, its corresponding thread link is moved to the end of the thread list, the next pointer is updated accordingly and the thread pointer is set to NULL. This function will be called whenever a thread is killed in the simulator.

Parameters:

	funit	Pointer to functional unit to delete thread from thread pointer/thread list
	thr	Pointer to thread to remove from the given statement

References func_unit_s::elem, func_unit_s::elem_type, thr_list_s::head, thr_list_s::next, thr_link_s::next, PROFILE, PROFILE_END, thr_list_s::tail, thr_link_s::thr, func_unit_s::thr, and func_unit_s::tlist.

Referenced by sim_kill_thread().

  { PROFILE(STATEMENT_DELETE_THREAD);

  assert( funit != NULL );
  assert( thr != NULL );

  /* If the statement element type is a thread pointer, simply clear the thread pointer */
  if( funit->elem_type == 0 ) {
    funit->elem.thr = NULL;

  /* Otherwise, find the given thread in the statement thread list and remove it */
  } else {

    thr_link* curr = funit->elem.tlist->head;
    thr_link* last = NULL;

    /* Search the thread list for the matching thread */
    while( (curr != NULL) && (curr->thr != thr) ) {
      last = curr;
      curr = curr->next;
    }

    /* We should have found the thread in the statement list */
    assert( curr != NULL );

    /* Move this thread link to the end of the thread link list and clear out its values */
    if( funit->elem.tlist->tail != curr ) {
      if( funit->elem.tlist->head == curr ) {
        funit->elem.tlist->head = curr->next;
      } else {
        last->next = curr->next;
      }
      funit->elem.tlist->tail->next = curr;
      funit->elem.tlist->tail       = curr;
      curr->next = NULL;
    }
  
    /* Clear the thread pointer */
    curr->thr = NULL; 
  
    /* If the thread list next pointer is NULL, set it to the freed thread link structure */
    if( funit->elem.tlist->next == NULL ) {
      funit->elem.tlist->next = curr;
    }
  
  } 

  PROFILE_END;
    
}

void funit_display_expressions

(

func_unit *

funit

)

Displays expressions stored in this functional unit.

Parameters:

funit

Pointer to functional unit element to display expressions

Iterates through expression list of specified functional unit, displaying each expression's id.

References exp_link_s::exp, func_unit_s::exp_head, expression_display(), get_funit_type(), func_unit_s::name, exp_link_s::next, obf_funit, PROFILE, PROFILE_END, and func_unit_s::type.

                                                   { PROFILE(FUNIT_DISPLAY_EXPRESSIONS);

  exp_link* expl;    /* Pointer to current expression link element */

  printf( "%s => %s", get_funit_type( funit->type ), obf_funit( funit->name ) );

  expl = funit->exp_head;
  while( expl != NULL ) {
    expression_display( expl->exp );
    expl = expl->next;
  }

  PROFILE_END;

}

void funit_display_signals

(

func_unit *

funit

)

Displays signals stored in this functional unit.

Parameters:

funit

Pointer to functional unit element to display signals.

Iterates through signal list of specified functional unit, displaying each signal's name, width, lsb and value.

References get_funit_type(), func_unit_s::name, sig_link_s::next, obf_funit, PROFILE, PROFILE_END, sig_link_s::sig, func_unit_s::sig_head, func_unit_s::type, and vsignal_display().

                                               { PROFILE(FUNIT_DISPLAY_SIGNALS);

  sig_link* sigl;  /* Pointer to current signal link element */

  printf( "%s => %s", get_funit_type( funit->type ), obf_funit( funit->name ) );

  sigl = funit->sig_head;
  while( sigl != NULL ) {
    vsignal_display( sigl->sig );
    sigl = sigl->next;
  }

  PROFILE_END;

}

func_unit* funit_find_by_id

(

int

id

)

Finds the functional unit that contains the given statement/expression ID.

Returns:

Returns a pointer to the functional unit that contains the specified expression/statement ID if one exists; otherwise, returns NULL.

Searches the functional units until one is found that contains the expression/statement identified by the specified ID and returns a pointer to this functional unit. If no such ID exists in the design, a value of NULL is returned to the calling statement.

Parameters:

id

Expression/statement ID to search for

References curr_db, func_unit_s::exp_head, exp_link_find(), funit_link_s::funit, db_s::funit_head, funit_link_s::next, PROFILE, and PROFILE_END.

Referenced by combination_get_coverage(), combination_get_expression(), stmt_blk_add_to_remove_list(), and stmt_blk_remove().

  { PROFILE(FUNIT_FIND_BY_ID);

  funit_link* funitl;       /* Temporary pointer to functional unit link */
  exp_link*   expl = NULL;  /* Temporary pointer to expression link */

  funitl = db_list[curr_db]->funit_head;
  while( (funitl != NULL) && (expl == NULL) ) {
    if( (expl = exp_link_find( id, funitl->funit->exp_head )) == NULL ) {
      funitl = funitl->next;
    }
  }

  PROFILE_END;
      
  return( (funitl == NULL) ? NULL : funitl->funit );
    
}

mod_parm* funit_find_param	(	char *	name,
		func_unit *	funit
	)

Finds specified module parameter given the current functional unit and its scope.

Returns:

Returns a pointer to the module parameter structure that contains the specified parameter name if it exists; otherwise, returns NULL.

Recursively searches from the current functional unit up through its scope until either the parameter is found or until we have exhausted the scope.

Parameters:

	name	Name of parameter to search for
	funit	Functional unit to check for existence of named parameter

References funit_find_param(), mod_parm_find(), func_unit_s::param_head, func_unit_s::parent, PROFILE, and PROFILE_END.

Referenced by funit_find_param(), and scope_find_param().

  { PROFILE(FUNIT_FIND_PARAM);

  mod_parm* mparm = NULL;  /* Pointer to found module parameter */

  if( funit != NULL ) {

    if( (mparm = mod_parm_find( name, funit->param_head )) == NULL ) {
      mparm = funit_find_param( name, funit->parent );
    }

  }

  PROFILE_END;

  return( mparm );

}

vsignal* funit_find_signal	(	char *	name,
		func_unit *	funit
	)

Finds specified signal given in the current functional unit.

Returns:

Returns a pointer to the found signal in the given functional unit; otherwise, returns NULL if the signal could not be found.

Searches the signal list in the given functional unit for the specified signal name. If it isn't found there, we look in the generate item list for the same signal.

Parameters:

	name	Name of the signal that we are searching for
	funit	Pointer to functional unit to search in

References gen_item_s::elem, FALSE, gen_item_create_sig(), gen_item_dealloc(), gen_item_find(), gitem_link_s::gi, func_unit_s::gitem_head, gitem_link_find(), vsignal_s::name, PROFILE, PROFILE_END, gen_item_s::sig, sig_link_s::sig, func_unit_s::sig_head, and sig_link_find().

Referenced by scope_find_signal().

  { PROFILE(FUNIT_FIND_SIGNAL);

  vsignal*    found_sig = NULL;  /* Pointer to the found signal */
  vsignal     sig;               /* Holder for signal to search for */
  sig_link*   sigl;              /* Pointer to signal link */
#ifndef VPI_ONLY
  gen_item*   gi;                /* Pointer to temporary generate item */
  gen_item*   found_gi;          /* Pointer to found generate item */
  gitem_link* gil;               /* Pointer to found generate item link */
#endif

  sig.name = name;

  /* Search for signal in given functional unit signal list */
  if( (sigl = sig_link_find( name, funit->sig_head )) != NULL ) {

    found_sig = sigl->sig;

#ifndef VPI_ONLY
  } else {

    /* If it was not found, search in the functional unit generate item list */
    gi = gen_item_create_sig( &sig );

    if( ((gil = gitem_link_find( gi, funit->gitem_head )) != NULL) && ((found_gi = gen_item_find( gil->gi, gi )) != NULL) ) {
      found_sig = found_gi->elem.sig;
    }

    /* Deallocate temporary generate item */
    gen_item_dealloc( gi, FALSE );
#endif

  }

  PROFILE_END;

  return( found_sig );

}

char* funit_flatten_name

(

func_unit *

funit

)

Flattens the functional unit name by removing all unnamed scope portions.

Returns:

Returns the flattened name of the given functional unit

Parameters:

funit

Pointer to functional unit to flatten name

References db_is_unnamed_scope(), func_unit_s::name, PROFILE, PROFILE_END, and scope_extract_front().

Referenced by assertion_funit_summary(), assertion_funit_verbose(), assertion_instance_verbose(), combination_funit_summary(), combination_funit_verbose(), combination_instance_verbose(), fsm_funit_summary(), fsm_funit_verbose(), fsm_instance_verbose(), line_funit_summary(), line_funit_verbose(), line_instance_verbose(), memory_ae_funit_summary(), memory_funit_verbose(), memory_instance_verbose(), memory_toggle_funit_summary(), ovl_display_verbose(), race_report_summary(), race_report_verbose(), toggle_funit_summary(), toggle_funit_verbose(), and toggle_instance_verbose().

  { PROFILE(FUNIT_FLATTEN_NAME);

  static char fscope[4096];  /* Flattened scope name */
  char        tmp[4096];     /* Temporary string storage */
  char        front[4096];   /* First portion of scope name */
  char        rest[4096];    /* Last portion of scope name */

  assert( funit != NULL );

  scope_extract_front( funit->name, fscope, rest );
  strcpy( tmp, rest );
  scope_extract_front( tmp, front, rest );

  while( front[0] != '\0' ) {
    if( !db_is_unnamed_scope( front ) ) {
      strcat( fscope, "." );
      strcat( fscope, front );
    }
    strcpy( tmp, rest );
    scope_extract_front( tmp, front, rest ); 
  }

  PROFILE_END;

  return fscope;

}

char* funit_gen_task_function_namedblock_name	(	char *	orig_name,
		func_unit *	parent
	)

Generates the internally used task/function/named-block name for the specified functional unit.

Returns:

Returns dynamically allocated string containing internally used task, function or named-block name.

Parameters:

	orig_name	Verilog name of task, function or named-block
	parent	Pointer to parent functional unit of this functional unit

References func_unit_s::name, PROFILE, PROFILE_END, and strdup_safe.

Referenced by db_add_function_task_namedblock().

  { PROFILE(FUNIT_GEN_TASK_FUNCTION_NAMEDBLOCK_NAME);

  char         full_name[4096];  /* Container for new name */
  unsigned int rv;               /* Return value for snprintf calls */

  assert( parent != NULL );
  assert( orig_name != NULL );

  /* Generate full name to use for the function/task */
  rv = snprintf( full_name, 4096, "%s.%s", parent->name, orig_name );
  assert( rv < 4096 );

  PROFILE_END;

  return( strdup_safe( full_name ) );

}

func_unit* funit_get_curr_function

(

func_unit *

funit

)

Returns the parent function of the given functional unit (if there is one).

Returns:

Returns a pointer to the function that contains the specified functional unit if one exists; otherwise, returns NULL.

Parameters:

funit

Functional unit that may be nested in a function

References FUNIT_AFUNCTION, FUNIT_FUNCTION, FUNIT_MODULE, func_unit_s::parent, PROFILE, PROFILE_END, and func_unit_s::type.

Referenced by db_create_expression().

  { PROFILE(FUNIT_GET_CURR_FUNCTION);

  assert( funit != NULL );

  while( (funit->type != FUNIT_FUNCTION) && (funit->type != FUNIT_AFUNCTION) && (funit->type != FUNIT_MODULE) ) {
    funit = funit->parent;
  }

  PROFILE_END;

  return( ((funit->type == FUNIT_FUNCTION) || (funit->type == FUNIT_AFUNCTION)) ? funit : NULL );

}

func_unit* funit_get_curr_module

(

func_unit *

funit

)

Returns the parent module of the given functional unit.

Returns:

Returns a pointer to the module that contains the specified functional unit.

Traverses up parent list until the FUNIT_MODULE is found (parent should be NULL).

Parameters:

funit

Pointer to functional unit to get its module from

References func_unit_s::parent, PROFILE, and PROFILE_END.

Referenced by combination_get_expression(), db_add_function_task_namedblock(), db_find_typedef(), exclude_find_expression(), exclude_find_fsm_arc(), exclude_find_signal(), func_iter_add_sig_links(), func_iter_add_stmt_links(), func_iter_count_scopes(), and mod_parm_add().

  { PROFILE(FUNIT_GET_CURR_MODULE);

  assert( funit != NULL );

  while( funit->parent != NULL ) {
    funit = funit->parent;
  }

  PROFILE_END;

  return( funit );

}

const func_unit* funit_get_curr_module_safe

(

const func_unit *

funit

)

Returns the parent module of the given functional unit (returning a const version).

Returns:

Returns a const pointer to the module that contains the specified functional unit.

Traverses up parent list until the FUNIT_MODULE is found (parent should be NULL). Does this in a way that guarantees that the found functional unit will not be modified.

Parameters:

funit

Pointer to functional unit to get its module from

References func_unit_s::parent, PROFILE, and PROFILE_END.

Referenced by bind_find_sig_name().

  { PROFILE(FUNIT_GET_CURR_MODULE_SAFE);

  assert( funit != NULL );

  while( funit->parent != NULL ) {
    funit = funit->parent;
  }

  PROFILE_END;

  return( funit );

}

func_unit* funit_get_curr_task

(

func_unit *

funit

)

Returns the parent task of the given functional unit (if there is one).

Returns:

Returns a pointer to the function that contains the specified functional unit if one exists; otherwise, returns NULL.

Parameters:

funit

Functional unit that may be nested in a function

References FUNIT_ATASK, FUNIT_MODULE, FUNIT_TASK, func_unit_s::parent, PROFILE, PROFILE_END, and func_unit_s::type.

  { PROFILE(FUNIT_GET_CURR_TASK);

  assert( funit != NULL );

  while( (funit->type != FUNIT_TASK) && (funit->type != FUNIT_ATASK) && (funit->type != FUNIT_MODULE) ) {
    funit = funit->parent;
  }

  PROFILE_END;

  return( ((funit->type == FUNIT_TASK) || (funit->type == FUNIT_ATASK)) ? funit : NULL );

}

int funit_get_port_count

(

func_unit *

funit

)

Returns the number of input, output and inout ports in the specified functional unit.

Returns:

Returns the number of input, output and inout ports specified in this functional unit

Parameters:

funit

Pointer to functional unit to process

References sig_link_s::next, ssuppl_u::part, PROFILE, PROFILE_END, sig_link_s::sig, func_unit_s::sig_head, SSUPPL_TYPE_INOUT_NET, SSUPPL_TYPE_INOUT_REG, SSUPPL_TYPE_INPUT_NET, SSUPPL_TYPE_INPUT_REG, SSUPPL_TYPE_OUTPUT_NET, SSUPPL_TYPE_OUTPUT_REG, vsignal_s::suppl, and ssuppl_u::type.

Referenced by bind_task_function_namedblock().

  { PROFILE(FUNIT_GET_PORT_COUNT);

  sig_link* sigl;          /* Pointer to current signal link to examine */
  int       port_cnt = 0;  /* Return value for this function */

  assert( funit != NULL );

  sigl = funit->sig_head;
  while( sigl != NULL ) {
    if( (sigl->sig->suppl.part.type == SSUPPL_TYPE_INPUT_NET)  ||
        (sigl->sig->suppl.part.type == SSUPPL_TYPE_INPUT_REG)  ||
        (sigl->sig->suppl.part.type == SSUPPL_TYPE_OUTPUT_NET) ||
        (sigl->sig->suppl.part.type == SSUPPL_TYPE_OUTPUT_REG) ||
        (sigl->sig->suppl.part.type == SSUPPL_TYPE_INOUT_NET)  ||
        (sigl->sig->suppl.part.type == SSUPPL_TYPE_INOUT_REG) ) {
      port_cnt++;
    }
    sigl = sigl->next;
  }

  PROFILE_END;

  return( port_cnt );

}

bool funit_is_child_of	(	func_unit *	parent,
		func_unit *	child
	)

Returns TRUE if the specified "parent" functional unit is a parent of the "child" functional unit.

Parameters:

	parent	Potential parent functional unit to check for relationship to child
	child	Potential child functional unit to check for relationship to parent

Returns:

Returns TRUE if the relationship of the "parent" and "child" is just that.

References func_unit_s::parent, PROFILE, and PROFILE_END.

Referenced by sim_kill_thread_with_funit().

                                                              { PROFILE(FUNIT_IS_CHILD_OF);

  while( (child->parent != NULL) && (child->parent != parent) ) {
    child = child->parent;
  }

  PROFILE_END;

  return( child->parent == parent );

}

bool funit_is_one_signal_assigned

(

func_unit *

funit

)

Returns TRUE if at least one signal was found that needs to be assigned by the dumpfile.

Returns:

Returns TRUE if at least one signal was found that needs to be assigned by the dumpfile.

Parameters:

funit

Pointer to functional unit to check

References vsignal_s::exp_head, sig_link_s::next, PROFILE, PROFILE_END, sig_link_s::sig, func_unit_s::sig_head, and SIGNAL_ASSIGN_FROM_DUMPFILE.

Referenced by db_check_dumpfile_scopes().

  { PROFILE(FUNIT_IS_ONE_SIGNAL_ASSIGNED);

  sig_link* sigl = funit->sig_head;

  while( (sigl != NULL) && ((sigl->sig->exp_head == NULL) || !SIGNAL_ASSIGN_FROM_DUMPFILE( sigl->sig )) ) {
    sigl = sigl->next;
  }

  PROFILE_END;

  return( sigl != NULL );

}

bool funit_is_top_module

(

func_unit *

funit

)

Returns TRUE if the given functional unit does not contain any input, output or inout ports.

Returns:

Returns TRUE if the specified functional unit does not contain any inputs, outputs or inouts and is of type MODULE.

Parameters:

funit

Pointer to functional unit to check

References FALSE, FUNIT_MODULE, sig_link_s::next, ssuppl_u::part, PROFILE, PROFILE_END, sig_link_s::sig, func_unit_s::sig_head, SSUPPL_TYPE_INOUT_NET, SSUPPL_TYPE_INOUT_REG, SSUPPL_TYPE_INPUT_NET, SSUPPL_TYPE_INPUT_REG, SSUPPL_TYPE_OUTPUT_NET, SSUPPL_TYPE_OUTPUT_REG, vsignal_s::suppl, ssuppl_u::type, and func_unit_s::type.

Referenced by db_check_for_top_module().

  { PROFILE(FUNIT_IS_TOP_MODULE);

  bool      retval = FALSE;  /* Return value for this function */
  sig_link* sigl;            /* Pointer to current signal link */

  assert( funit != NULL );

  /* Only check the signal list if we are a MODULE type */
  if( funit->type == FUNIT_MODULE ) {

    sigl = funit->sig_head;
    while( (sigl != NULL) &&
           (sigl->sig->suppl.part.type != SSUPPL_TYPE_INPUT_NET)  &&
           (sigl->sig->suppl.part.type != SSUPPL_TYPE_INPUT_REG)  &&
           (sigl->sig->suppl.part.type != SSUPPL_TYPE_OUTPUT_NET) &&
           (sigl->sig->suppl.part.type != SSUPPL_TYPE_OUTPUT_REG) &&
           (sigl->sig->suppl.part.type != SSUPPL_TYPE_INOUT_NET)  &&
           (sigl->sig->suppl.part.type != SSUPPL_TYPE_INOUT_REG) ) {
      sigl = sigl->next;
    }

    retval = (sigl == NULL);

  }

  PROFILE_END;

  return( retval );

}

bool funit_is_unnamed

(

func_unit *

funit

)

Returns TRUE if the given functional unit is an unnamed scope.

Parameters:

funit

Pointer to functional unit to check.

Returns:

Returns TRUE if the specified functional unit is an unnamed scope; otherwise, returns FALSE.

A functional unit is considered to be an unnamed scope if it is of type FUNIT_NAMED_BLOCK and the last portion of its functional unit name returns TRUE after calling the db_is_unnamed_scope() function.

References db_is_unnamed_scope(), FALSE, FUNIT_ANAMED_BLOCK, FUNIT_NAMED_BLOCK, func_unit_s::name, PROFILE, PROFILE_END, scope_extract_back(), and func_unit_s::type.

Referenced by assertion_funit_summary(), assertion_funit_verbose(), assertion_instance_summary(), assertion_instance_verbose(), combination_funit_summary(), combination_funit_verbose(), combination_get_stats(), combination_instance_summary(), combination_instance_verbose(), combination_reset_counted_exprs(), fsm_funit_summary(), fsm_funit_verbose(), fsm_instance_summary(), fsm_instance_verbose(), func_iter_add_sig_links(), func_iter_add_stmt_links(), func_iter_count_scopes(), funit_is_unnamed_child_of(), instance_find_scope(), line_funit_summary(), line_funit_verbose(), line_get_stats(), line_instance_summary(), line_instance_verbose(), memory_ae_funit_summary(), memory_ae_instance_summary(), memory_funit_verbose(), memory_get_stats(), memory_instance_verbose(), memory_toggle_funit_summary(), memory_toggle_instance_summary(), rank_gather_comp_cdd_cov(), toggle_funit_summary(), toggle_funit_verbose(), toggle_get_stats(), toggle_instance_summary(), and toggle_instance_verbose().

                                          { PROFILE(FUNIT_IS_UNNAMED);

  bool retval = FALSE;  /* Return value for this function */
  char back[256];       /* Last portion of functional unit name */
  char rest[4096];      /* Rest of functional unit name */

  /* Only begin..end blocks can be unnamed scopes */
  if( (funit->type == FUNIT_NAMED_BLOCK) || (funit->type == FUNIT_ANAMED_BLOCK) ) {
    scope_extract_back( funit->name, back, rest );
    retval = db_is_unnamed_scope( back );
  }

  PROFILE_END;

  return( retval );

}

bool funit_is_unnamed_child_of	(	func_unit *	parent,
		func_unit *	child
	)

Returns TRUE if the specified "parent" functional unit is a parent of the "child" functional unit.

Parameters:

	parent	Potential parent functional unit to check for relationship to child
	child	Potential child functional unit to check for relationship to parent

Returns:

Returns TRUE if the relationship of the "parent" and "child" is just that.

References funit_is_unnamed(), func_unit_s::parent, PROFILE, and PROFILE_END.

                                                                      { PROFILE(FUNIT_IS_UNNAMED_CHILD_OF);

  while( (child->parent != NULL) && (child->parent != parent) && funit_is_unnamed( child->parent ) ) {
    child = child->parent;
  }

  PROFILE_END;

  return( child->parent == parent );

}

void funit_merge	(	func_unit *	base,
		func_unit *	other
	)

Merges two functional units into the base functional unit.

Merges two functional units into the base functional unit. Used for creating merged results for GUI usage.

Parameters:

	base	Base functional unit that will contain the merged results
	other	Other functional unit that will be merged

References func_unit_s::er_head, exclude_merge(), exp_link_s::exp, func_unit_s::exp_head, expression_merge(), func_unit_s::fsm_head, fsm_merge(), func_unit_s::name, exclude_reason_s::next, fsm_link_s::next, sig_link_s::next, exp_link_s::next, PROFILE, PROFILE_END, sig_link_s::sig, func_unit_s::sig_head, fsm_link_s::table, and vsignal_merge().

Referenced by instance_merge_tree().

  { PROFILE(FUNIT_MERGE);

  exp_link*       curr_base_exp;   /* Pointer to current expression in base functional unit expression list */
  exp_link*       curr_other_exp;  /* Pointer to current expression in other functional unit expression list */
  sig_link*       curr_base_sig;   /* Pointer to current signal in base functional unit signal list */
  sig_link*       curr_other_sig;  /* Pointer to current signal in other functional unit signal list */
  fsm_link*       curr_base_fsm;   /* Pointer to current FSM in base functional unit FSM list */
  fsm_link*       curr_other_fsm;  /* Pointer to current FSM in other functional unit FSM list */
  exclude_reason* curr_other_er;

  assert( base != NULL );
  assert( base->name != NULL );

  /* Handle all functional unit expressions */
  curr_base_exp  = base->exp_head;
  curr_other_exp = other->exp_head;
  while( (curr_base_exp != NULL) && (curr_other_exp != NULL) ) {
    expression_merge( curr_base_exp->exp, curr_other_exp->exp );
    curr_base_exp  = curr_base_exp->next;
    curr_other_exp = curr_other_exp->next;
  }
  assert( (curr_base_exp == NULL) && (curr_other_exp == NULL) );

  /* Handle all functional unit signals */
  curr_base_sig  = base->sig_head;
  curr_other_sig = other->sig_head;
  while( (curr_base_sig != NULL) && (curr_other_sig != NULL) ) {
    vsignal_merge( curr_base_sig->sig, curr_other_sig->sig );
    curr_base_sig  = curr_base_sig->next;
    curr_other_sig = curr_other_sig->next;
  }
  assert( (curr_base_sig == NULL) && (curr_other_exp == NULL) );

  /* Handle all functional unit FSMs */
  curr_base_fsm  = base->fsm_head;
  curr_other_fsm = other->fsm_head;
  while( (curr_base_fsm != NULL) && (curr_other_fsm != NULL) ) {
    fsm_merge( curr_base_fsm->table, curr_other_fsm->table );
    curr_base_fsm  = curr_base_fsm->next;
    curr_other_fsm = curr_other_fsm->next;
  }
  assert( (curr_base_fsm == NULL) && (curr_other_fsm == NULL) );

  /* Handle all functional unit exclusion reasons */
  curr_other_er = other->er_head;
  while( curr_other_er != NULL ) {
    exclude_merge( base, curr_other_er );
    curr_other_er = curr_other_er->next;
  }

  PROFILE_END;

}

void funit_output_dumpvars	(	FILE *	vfile,
		func_unit *	funit,
		const char *	scope
	)

Outputs dumpvars calls to the given file.

Outputs all of the needed signals to the specified file.

Parameters:

	vfile	Pointer to file to output dumpvars information to
	funit	Pointer to functional unit to output
	scope	Instance scope

References ssuppl_u::assigned, FALSE, vsignal_s::name, sig_link_s::next, ssuppl_u::part, PROFILE, PROFILE_END, sig_link_s::sig, func_unit_s::sig_head, SSUPPL_TYPE_ENUM, SSUPPL_TYPE_EVENT, SSUPPL_TYPE_GENVAR, SSUPPL_TYPE_MEM, SSUPPL_TYPE_PARAM, SSUPPL_TYPE_PARAM_REAL, vsignal_s::suppl, TRUE, and ssuppl_u::type.

Referenced by instance_output_dumpvars().

  { PROFILE(FUNIT_OUTPUT_DUMPVARS);

  sig_link* sigl  = funit->sig_head;
  bool      first = TRUE;

  while( sigl != NULL ) {
    if( (sigl->sig->suppl.part.assigned == 0) &&
        (sigl->sig->suppl.part.type != SSUPPL_TYPE_PARAM)      &&
        (sigl->sig->suppl.part.type != SSUPPL_TYPE_PARAM_REAL) &&
        (sigl->sig->suppl.part.type != SSUPPL_TYPE_ENUM)       &&
        (sigl->sig->suppl.part.type != SSUPPL_TYPE_MEM)        &&
        (sigl->sig->suppl.part.type != SSUPPL_TYPE_GENVAR)     &&
        (sigl->sig->suppl.part.type != SSUPPL_TYPE_EVENT) ) {
      if( first ) {
        first = FALSE;
        fprintf( vfile, "  $dumpvars( 1, %s.%s", scope, sigl->sig->name );
      } else {
        fprintf( vfile, ",\n                %s.%s", scope, sigl->sig->name );
      }
    }
    sigl = sigl->next;
  } 

  if( !first ) {
    fprintf( vfile, " );\n" );
  }

  PROFILE_END;

}

void funit_push_threads	(	func_unit *	funit,
		const statement *	stmt,
		const sim_time *	time
	)

Pushes the threads associated with the given functional unit onto the active simulation queue.

Adds all of the given functional unit threads to the active simulation queue.

Parameters:

	funit	Pointer of functional unit to push threads from
	stmt	Pointer to the statement to search for in functional unit threads
	time	Pointer to current simulation time

References thread_s::curr, func_unit_s::elem, func_unit_s::elem_type, thr_list_s::head, thr_link_s::next, thread_s::part, PROFILE, PROFILE_END, sim_thread_push(), thread_s::suppl, thr_link_s::thr, func_unit_s::thr, THR_ST_WAITING, and func_unit_s::tlist.

Referenced by sim_expr_changed().

  { PROFILE(FUNIT_PUSH_THREADS);

  assert( funit != NULL );

  if( funit->elem_type == 0 ) {
    if( (funit->elem.thr != NULL) && (funit->elem.thr->suppl.part.state == THR_ST_WAITING) && (funit->elem.thr->curr == stmt) ) {
      sim_thread_push( funit->elem.thr, time );
    }
  } else {
    thr_link* curr = funit->elem.tlist->head;
    while( (curr != NULL) && (curr->thr != NULL) ) {
      if( (curr->thr != NULL) && (curr->thr->suppl.part.state == THR_ST_WAITING) && (curr->thr->curr == stmt) ) {
        sim_thread_push( curr->thr, time );
      }
      curr = curr->next;
    }
  }

  PROFILE_END;

}

void funit_remove_stmt_blks_calling_stmt	(	func_unit *	funit,
		statement *	stmt
	)

Finds all expressions that call the given statement.

Searches all statement blocks in the given functional unit that have expressions that call the functional unit containing the given statement as its first statement.

Parameters:

	funit	Pointer to functional unit to search in
	stmt	Pointer to statement to search for

References stmt_link_s::next, statement_s::part, PROFILE, PROFILE_END, statement_contains_expr_calling_stmt(), stmt_link_s::stmt, stmt_blk_add_to_remove_list(), func_unit_s::stmt_head, and statement_s::suppl.

Referenced by instance_remove_stmt_blks_calling_stmt().

  { PROFILE(FUNIT_REMOVE_STMT_BLKS_CALLING_STMT);

  if( funit != NULL ) {

    stmt_link* curr = funit->stmt_head;

    /* Search all of the statement blocks */
    while( curr != NULL ) {
      if( (curr->stmt->suppl.part.head == 1) && statement_contains_expr_calling_stmt( curr->stmt, stmt ) ) {
        stmt_blk_add_to_remove_list( curr->stmt );
      }
      curr = curr->next;
    }

  }

  PROFILE_END;

}

void funit_size_elements	(	func_unit *	funit,
		funit_inst *	inst,
		bool	gen_all,
		bool	alloc_exprs
	)

Sizes all elements for the current functional unit from the given instance.

Exceptions:

anonymous

expression_resize enumerate_resolve param_resolve expression_set_value expression_set_value expression_set_value vsignal_create_vec gen_item_resize_stmts_and_sigs

Resizes signals if they are contigent upon parameter values. After all signals have been resized, the signal's corresponding expressions are resized. This function should be called just prior to outputting this funtional unit's contents to the CDD file (after parsing phase only)

Parameters:

	funit	Pointer to functional unit containing elements to resize
	inst	Pointer to instance containing this functional unit
	gen_all	Set to TRUE to generate all components (this should only be set by the funit_db_write function)
	alloc_exprs	Allocates vector data for all expressions if set to TRUE

References enumerate_resolve(), ESUPPL_IS_ROOT, exp_link_s::exp, func_unit_s::exp_head, mod_parm_s::exp_head, vsignal_s::exp_head, EXP_OP_FUNC_CALL, EXP_OP_PASSIGN, expression_resize(), expression_set_value(), FALSE, fsm_create_tables(), func_unit_s::fsm_head, esuppl_u::gen_expr, gen_item_bind(), gen_item_resize_stmts_and_sigs(), gitem_link_s::gi, funit_inst_s::gitem_head, inst_parm_bind(), inst_parm_s::mparm, fsm_link_s::next, sig_link_s::next, gitem_link_s::next, inst_parm_s::next, exp_link_s::next, expression_s::op, funit_inst_s::param_head, param_resolve(), param_set_sig_size(), esuppl_u::part, PROFILE, PROFILE_END, expression_s::sig, sig_link_s::sig, mod_parm_s::sig, inst_parm_s::sig, func_unit_s::sig_head, expression_s::suppl, fsm_link_s::table, TRUE, vector_s::ul, vector_s::value, expression_s::value, and vsignal_create_vec().

Referenced by expression_resize(), funit_db_write(), param_size_function(), and race_check_modules().

  { PROFILE(FUNIT_SIZE_ELEMENTS);
  
  inst_parm*  curr_iparm;       /* Pointer to current instance parameter to evaluate */
  exp_link*   curr_exp;         /* Pointer to current expression link to evaluate */
  fsm_link*   curr_fsm;         /* Pointer to current FSM structure to evaluate */
#ifndef VPI_ONLY
  gitem_link* curr_gi;          /* Pointer to current generate item link to evaluate */
#endif
  sig_link*   curr_sig;         /* Pointer to current signal link to evaluate */
  bool        resolve = FALSE;  /* If set to TRUE, perform one more parameter resolution */

  assert( funit != NULL );
  assert( inst != NULL );

  /*
   First, traverse through current instance's parameter list and resolve
   any unresolved parameters created via generate statements.
  */
  curr_iparm = inst->param_head;
  while( curr_iparm != NULL ) {
    if( curr_iparm->mparm == NULL ) {
      curr_exp = curr_iparm->sig->exp_head;
      while( curr_exp != NULL ) {
        if( curr_exp->exp->suppl.part.gen_expr == 0 ) {
          expression_set_value( curr_exp->exp, curr_iparm->sig, funit );
          resolve = TRUE;
        }
        curr_exp = curr_exp->next;
      }
    }
    curr_iparm = curr_iparm->next;
  }
  
  /* If we need to do another parameter resolution for generate blocks, do it now */
  if( resolve ) {
    param_resolve( inst );
  }

#ifndef VPI_ONLY
  /*
   Second, traverse through any BIND generate items and update the expression name.
  */
  curr_gi = inst->gitem_head;
  while( curr_gi != NULL ) {
    gen_item_bind( curr_gi->gi );
    curr_gi = curr_gi->next;
  }
#endif

  /* 
   Third, traverse through current instance's instance parameter list and
   set sizes of signals and expressions.
  */
  curr_iparm = inst->param_head;
  while( curr_iparm != NULL ) {
    inst_parm_bind( curr_iparm );
    if( curr_iparm->mparm != NULL ) {
      /* This parameter sizes a signal so perform the signal size */
      if( curr_iparm->mparm->sig != NULL ) {
        param_set_sig_size( curr_iparm->mparm->sig, curr_iparm );
      } else {
        /* This parameter attaches to an expression tree */
        curr_exp = curr_iparm->mparm->exp_head;
        while( curr_exp != NULL ) {
          expression_set_value( curr_exp->exp, curr_iparm->sig, funit );
          curr_exp = curr_exp->next;
        }
      }
    }
    curr_iparm = curr_iparm->next;
  }

  /* Traverse through all signals, calculating and creating their vector values */
  curr_sig = funit->sig_head;
  while( curr_sig != NULL ) {
    vsignal_create_vec( curr_sig->sig );
    curr_sig = curr_sig->next;
  }

  /*
   Fourth, resolve all enumerated values for this functional unit
  */
  enumerate_resolve( inst );

  /*
   Fifth, traverse all expressions and set expressions to specified
   signals.  Makes the assumption that all children expressions come
   before the root expression in the list (this is currently the case).
  */
  curr_exp = funit->exp_head;
  while( curr_exp != NULL ) {
    if( ESUPPL_IS_ROOT( curr_exp->exp->suppl ) ) {
      /* Perform an entire expression resize */
      expression_resize( curr_exp->exp, funit, TRUE, alloc_exprs );
    }
    if( (curr_exp->exp->sig != NULL) &&
        (curr_exp->exp->op != EXP_OP_FUNC_CALL) &&
        (curr_exp->exp->op != EXP_OP_PASSIGN) ) {
      expression_set_value( curr_exp->exp, curr_exp->exp->sig, funit );
      assert( curr_exp->exp->value->value.ul != NULL );
    }
    curr_exp = curr_exp->next;
  }

#ifndef VPI_ONLY
  /* Sixth, traverse all generate items and resize all expressions and signals. */
  curr_gi = inst->gitem_head;
  while( curr_gi != NULL ) {
    gen_item_resize_stmts_and_sigs( curr_gi->gi, funit );
    curr_gi = curr_gi->next;
  }
#endif

  if( gen_all ) {

    /*
     Last, size all FSMs.  Since the FSM structure is reliant on the size
     of the state variable signal to which it is attached, its tables
     cannot be created until the state variable size can be calculated.
     Since this has been done now, size the FSMs.
    */
    curr_fsm = funit->fsm_head;
    while( curr_fsm != NULL ) {
      fsm_create_tables( curr_fsm->table );
      curr_fsm = curr_fsm->next;
    }

  }

  PROFILE_END;
    
}

void funit_version_db_read	(	func_unit *	funit,
		char **	line
	)

Reads the functional unit version information from the functional unit line and adds it to the current functional unit.

Reads in the functional unit version information from the specified CDD line.

Parameters:

	funit	Pointer to current functional unit to read version into
	line	Pointer to current line to parse

References PROFILE, PROFILE_END, strdup_safe, and func_unit_s::version.

Referenced by db_read().

  { PROFILE(FUNIT_VERSION_DB_READ);

  /* The current functional unit version must not have already been set */
  assert( funit->version == NULL );

  /* Strip the leading whitespace */
  while( **line == ' ' ) (*line)++;
  
  /* The rest of the line will be the version information (internal whitespace is allowed) */
  funit->version = strdup_safe( *line );

  PROFILE_END;

}