func_iter.h File Reference

Contains functions for dealing with functional unit iterators. More...

#include "defines.h"

Go to the source code of this file.

Data Structures
struct	func_iter_s
Typedefs
typedef struct func_iter_s	func_iter
Functions
void	func_iter_init (func_iter *fi, func_unit *funit, bool stmts, bool sigs)
	Initializes the values in the given structure.
statement *	func_iter_get_next_statement (func_iter *fi)
	Provides the next statement iterator in the functional unit statement iterator.
vsignal *	func_iter_get_next_signal (func_iter *fi)
	Provides the next signal in the functional unit signal iterator.
void	func_iter_dealloc (func_iter *fi)
	Deallocates functional unit iterator.

---

Detailed Description

Contains functions for dealing with functional unit iterators.

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

4/2/2007

---

Typedef Documentation

typedef struct func_iter_s func_iter

Structure for iterating through a functional unit and its unnamed scopes.

---

Function Documentation

void func_iter_dealloc

(

func_iter *

fi

)

Deallocates functional unit iterator.

Deallocates all allocated memory for the given functional unit iterator.

Parameters:

fi

Pointer to functional unit iterator to deallocate

References free_safe, PROFILE, PROFILE_END, func_iter_s::scopes, func_iter_s::sigs, and func_iter_s::sls.

Referenced by combination_collect(), combination_display_verbose(), combination_get_stats(), exclude_is_assert_excluded(), exclude_is_comb_excluded(), exclude_is_line_excluded(), exclude_is_toggle_excluded(), exclude_set_assert_exclude(), exclude_set_comb_exclude(), exclude_set_line_exclude(), exclude_set_toggle_exclude(), line_collect(), line_display_verbose(), line_get_stats(), memory_collect(), memory_display_verbose(), memory_get_coverage(), memory_get_stats(), ovl_collect(), ovl_display_verbose(), ovl_get_coverage(), ovl_get_funit_stats(), rank_gather_comp_cdd_cov(), toggle_collect(), toggle_display_verbose(), toggle_get_coverage(), and toggle_get_stats().

  { PROFILE(FUNC_ITER_DEALLOC);

  int i;  /* Loop iterator */
  
  if( fi != NULL ) {

    /* Deallocate statement iterators */
    if( fi->sls != NULL ) {

      /* Deallocate all statement iterators */
      for( i=0; i<fi->scopes; i++ ) {
        free_safe( fi->sls[i], sizeof( stmt_link ) );
      }

      /* Deallocate array of statement iterators */
      free_safe( fi->sls, (sizeof( stmt_link* ) * fi->scopes) );

    }

    /* Deallocate signal array */
    if( fi->sigs != NULL ) {

      /* Deallocate array of signals */
      free_safe( fi->sigs, (sizeof( sig_link* ) * fi->scopes) );

    }

  }

  PROFILE_END;
  
}

vsignal* func_iter_get_next_signal

(

func_iter *

fi

)

Provides the next signal in the functional unit signal iterator.

Returns:

Returns pointer to next signal in order (or NULL if there are no more signals in the given functional unit)

Parameters:

fi

Pointer to functional unit iterator to use

References func_iter_s::curr_sigl, sig_link_s::next, PROFILE, PROFILE_END, func_iter_s::scopes, sig_link_s::sig, func_iter_s::sig_num, and func_iter_s::sigs.

Referenced by exclude_is_toggle_excluded(), exclude_set_toggle_exclude(), memory_collect(), memory_display_verbose(), memory_get_coverage(), memory_get_stats(), toggle_collect(), toggle_display_verbose(), toggle_get_coverage(), and toggle_get_stats().

  { PROFILE(FUNC_ITER_GET_NEXT_SIGNAL);

  vsignal* sig;

  assert( fi != NULL );

  if( fi->curr_sigl != NULL ) {

    sig           = fi->curr_sigl->sig;
    fi->curr_sigl = fi->curr_sigl->next;

  } else {

    do {
      fi->sig_num++;
    } while( (fi->sig_num < fi->scopes) && (fi->sigs[fi->sig_num] == NULL) );

    if( fi->sig_num < fi->scopes ) {
      sig           = fi->sigs[fi->sig_num]->sig;
      fi->curr_sigl = fi->sigs[fi->sig_num]->next;
    } else {
      sig           = NULL;
      fi->curr_sigl = NULL;
    }

  }

  PROFILE_END;

  return( sig );

}

statement* func_iter_get_next_statement

(

func_iter *

fi

)

Provides the next statement iterator in the functional unit statement iterator.

Returns:

Returns pointer to next statement in line order (or NULL if there are no more statements in the given functional unit)

Parameters:

fi

Pointer to functional unit iterator to use

References func_iter_sort(), stmt_link_s::next, PROFILE, PROFILE_END, func_iter_s::sl_num, func_iter_s::sls, and stmt_link_s::stmt.

Referenced by combination_collect(), combination_display_verbose(), combination_get_stats(), exclude_is_assert_excluded(), exclude_is_comb_excluded(), exclude_is_line_excluded(), exclude_set_assert_exclude(), exclude_set_comb_exclude(), exclude_set_line_exclude(), line_collect(), line_display_verbose(), line_get_stats(), ovl_collect(), ovl_display_verbose(), ovl_get_coverage(), ovl_get_funit_stats(), and rank_gather_comp_cdd_cov().

  { PROFILE(FUNC_ITER_GET_NEXT_STATEMENT);

  statement* stmt;  /* Pointer to next statement in line order */

  assert( fi != NULL );

  if( fi->sl_num == 0 ) {

    stmt = NULL;

  } else {

    assert( fi->sls[0] != NULL );

    /* Get the statement at the head of the sorted list */
    stmt = fi->sls[0]->stmt;

    /* Go to the next statement in the current statement list */
    fi->sls[0] = fi->sls[0]->next;

    /* Resort */
    func_iter_sort( fi );

  }

  PROFILE_END;

  return( stmt );

}

void func_iter_init	(	func_iter *	fi,
		func_unit *	funit,
		bool	stmts,
		bool	sigs
	)

Initializes the values in the given structure.

Initializes the contents of the functional unit iterator structure. This should be called before the functional unit iterator structure is populated with either statement iterator or signal information.

Parameters:

	fi	Pointer to functional unit iterator to initializes
	funit	Pointer to main functional unit to create iterator for (must be named)
	stmts	Set to TRUE if we want statements to be included in the iterator
	sigs	Set to TRUE if we want signals to be included in the iterator

References func_iter_s::curr_sigl, func_iter_add_sig_links(), func_iter_add_stmt_links(), func_iter_count_scopes(), malloc_safe, PROFILE, PROFILE_END, func_iter_s::scopes, func_iter_s::sig_num, func_iter_s::sigs, func_iter_s::sl_num, and func_iter_s::sls.

Referenced by combination_collect(), combination_display_verbose(), combination_get_stats(), exclude_is_assert_excluded(), exclude_is_comb_excluded(), exclude_is_line_excluded(), exclude_is_toggle_excluded(), exclude_set_assert_exclude(), exclude_set_comb_exclude(), exclude_set_line_exclude(), exclude_set_toggle_exclude(), line_collect(), line_display_verbose(), line_get_stats(), memory_collect(), memory_display_verbose(), memory_get_coverage(), memory_get_stats(), ovl_collect(), ovl_display_verbose(), ovl_get_coverage(), ovl_get_funit_stats(), rank_gather_comp_cdd_cov(), toggle_collect(), toggle_display_verbose(), toggle_get_coverage(), and toggle_get_stats().

  { PROFILE(FUNC_ITER_INIT);

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

  /* Count the number of scopes that are within the functional unit iterator */
  fi->scopes  = func_iter_count_scopes( funit );
  fi->sls     = NULL;
  fi->sigs    = NULL;
  fi->sig_num = 0;

  /* Add statement iterators */
  if( stmts ) {
    fi->sls    = (stmt_link**)malloc_safe( sizeof( stmt_link* ) * fi->scopes );
    fi->sl_num = 0;
    func_iter_add_stmt_links( fi, funit );
  }

  /* Add signal lists */
  if( sigs ) {
    fi->sigs      = (sig_link**)malloc_safe( sizeof( sig_link* ) * fi->scopes );
    fi->sig_num   = 0;
    func_iter_add_sig_links( fi, funit );
    fi->sig_num   = 0;
    fi->curr_sigl = fi->sigs[0];
  }

  PROFILE_END;

}