func_iter.c File Reference

#include <stdlib.h>
#include <assert.h>
#include "defines.h"
#include "func_iter.h"
#include "func_unit.h"
#include "util.h"

Functions
void	func_iter_display (func_iter *fi)
static void	func_iter_sort (func_iter *fi)
static int	func_iter_count_scopes (func_unit *funit)
static void	func_iter_add_stmt_links (func_iter *fi, func_unit *funit)
static void	func_iter_add_sig_links (func_iter *fi, func_unit *funit)
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

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

4/2/2007

---

Function Documentation

static void func_iter_add_sig_links	(	func_iter *	fi,
		func_unit *	funit
	)			[static]

Recursively iterates through the functional units, adding their signal link pointers to the func_iter structure's array.

Parameters:

	fi	Pointer to functional unit iterator to populate
	funit	Pointer to current functional unit

References funit_link_s::funit, funit_get_curr_module(), funit_is_unnamed(), funit_link_s::next, func_unit_s::parent, PROFILE, PROFILE_END, func_unit_s::sig_head, func_iter_s::sig_num, func_iter_s::sigs, and func_unit_s::tf_head.

Referenced by func_iter_init().

  { PROFILE(FUNC_ITER_ADD_SIG_LINKS);

  funit_link* child;   /* Pointer to child functional unit */
  func_unit*  parent;  /* Pointer to parent module of this functional unit */

  /* Add the pointer */
  fi->sigs[fi->sig_num] = funit->sig_head;
  fi->sig_num++;

  /* Get the parent module */
  parent = funit_get_curr_module( funit );

  /* Now traverse down all of the child functional units doing the same */
  child = parent->tf_head;
  while( child != NULL ) {
    if( funit_is_unnamed( child->funit ) && (child->funit->parent == funit) ) {
      func_iter_add_sig_links( fi, child->funit );
    }
    child = child->next;
  }

  PROFILE_END;

}

static void func_iter_add_stmt_links	(	func_iter *	fi,
		func_unit *	funit
	)			[static]

Recursively iterates through functional units, adding their statement links to the func_iter structure's array.

Parameters:

	fi	Pointer to functional unit iterator to populate
	funit	Pointer to current functional unit

References func_iter_sort(), funit_link_s::funit, funit_get_curr_module(), funit_is_unnamed(), funit_link_s::next, func_unit_s::parent, PROFILE, PROFILE_END, func_iter_s::scopes, func_iter_s::sl_num, func_iter_s::sls, func_unit_s::stmt_head, and func_unit_s::tf_head.

Referenced by func_iter_init().

  { PROFILE(FUNC_ITER_ADD_STMT_LINKS);

  funit_link* child;   /* Pointer to child functional unit */
  func_unit*  parent;  /* Pointer to parent module of this functional unit */
  int         i;       /* Loop iterator */

  /* First, shift all current statement iterators down by one */
  for( i=(fi->scopes - 2); i>=0; i-- ) {
    fi->sls[i+1] = fi->sls[i];
  }

  /* Set the sls pointer to the head of the functional unit statement list */
  fi->sls[0] = funit->stmt_head;

  /* Increment the si_num */
  (fi->sl_num)++;

  /* Now sort the new statement iterator */
  func_iter_sort( fi );

  /* Get the parent module */
  parent = funit_get_curr_module( funit );

  /* Now traverse down all of the child functional units doing the same */
  child = parent->tf_head;
  while( child != NULL ) {
    if( funit_is_unnamed( child->funit ) && (child->funit->parent == funit) ) {
      func_iter_add_stmt_links( fi, child->funit );
    }
    child = child->next;
  }

  PROFILE_END;

}

static int func_iter_count_scopes

(

func_unit *

funit

)

[static]

Returns:

Returns the number of statement iterators found in all of the unnamed functional units within a named functional unit.

Parameters:

funit

Pointer to current functional unit being examined

References funit_link_s::funit, funit_get_curr_module(), funit_is_unnamed(), funit_link_s::next, func_unit_s::parent, PROFILE, PROFILE_END, and func_unit_s::tf_head.

Referenced by func_iter_init().

  { PROFILE(FUNC_ITER_COUNT_STMT_ITERS);

  int         count = 1;  /* Number of statement iterators within this functional unit */
  funit_link* child;      /* Pointer to child functional unit */
  func_unit*  parent;     /* Parent module of this functional unit */

  assert( funit != NULL );

  /* Get parent module */
  parent = funit_get_curr_module( funit );

  /* Iterate through children functional units, counting all of the unnamed scopes */
  child = parent->tf_head;
  while( child != NULL ) {
    if( funit_is_unnamed( child->funit ) && (child->funit->parent == funit) ) {
      count += func_iter_count_scopes( child->funit );
    }
    child = child->next;
  }

  PROFILE_END;

  return( count );

}

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;
  
}

void func_iter_display

(

func_iter *

fi

)

Displays the given function iterator to standard output.

Parameters:

fi

Pointer to functional unit iterator to display

References vsignal_s::name, statement_s::ppline, PROFILE, PROFILE_END, func_iter_s::scopes, sig_link_s::sig, func_iter_s::sig_num, func_iter_s::sigs, func_iter_s::sl_num, func_iter_s::sls, and stmt_link_s::stmt.

  { PROFILE(FUNC_ITER_DISPLAY);

  int i;  /* Loop iterator */

  printf( "Functional unit iterator (scopes: %u):\n", fi->scopes );

  if( fi->sls != NULL ) {
    for( i=0; i<fi->sl_num; i++ ) {
      if( fi->sls[i] != NULL ) {
        printf( "  Line: %u\n", fi->sls[i]->stmt->ppline );
      }
    }
  }

  if( fi->sigs != NULL ) {
    for( i=0; i<fi->sig_num; i++ ) {
      if( fi->sigs[i] != NULL ) {
        printf( "  Name: %s\n", fi->sigs[i]->sig->name );
      }
    }
  }

  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;

}

static void func_iter_sort

(

func_iter *

fi

)

[static]

Performs a bubble sort of the first element such that the first line is in location 0 of the sis array.

Parameters:

fi

Pointer to functional unit iterator to sort

References expression_s::col, statement_s::exp, expression_s::part, statement_s::ppline, PROFILE, PROFILE_END, func_iter_s::sl_num, func_iter_s::sls, and stmt_link_s::stmt.

Referenced by func_iter_add_stmt_links(), and func_iter_get_next_statement().

  { PROFILE(FUNC_ITER_SORT);

  stmt_link* tmp;  /* Temporary statement iterator */
  int        i;    /* Loop iterator */

  assert( fi != NULL );
  assert( fi->sl_num > 0 );

  tmp = fi->sls[0];

  /*
   If the statement iterator at the top of the list is NULL, shift all valid statement iterators
   towards the top and store this statement iterator after them 
  */
  if( tmp == NULL ) {

    for( i=0; i<(fi->sl_num - 1); i++ ) {
      fi->sls[i] = fi->sls[i+1];
    }
    fi->sls[i] = tmp;
    (fi->sl_num)--;

  /* Otherwise, re-sort them based on line number */
  } else {

    i = 0;
    while( (i < (fi->sl_num - 1)) &&
           ((tmp->stmt->ppline > fi->sls[i+1]->stmt->ppline) ||
            ((tmp->stmt->ppline == fi->sls[i+1]->stmt->ppline) &&
             (tmp->stmt->exp->col.part.last > fi->sls[i+1]->stmt->exp->col.part.last))) ) {
      fi->sls[i] = fi->sls[i+1];
      i++;
    }
    fi->sls[i] = tmp;

  }

  PROFILE_END;

}