symtable.h File Reference

Contains functions for manipulating a symtable structure. More...

#include "defines.h"

Go to the source code of this file.

Functions
symtable *	symtable_create ()
	Creates a new symtable structure.
void	symtable_add (const char *sym, vsignal *sig, int msb, int lsb)
	Creates a new symtable entry and adds it to the specified symbol table.
void	symtable_set_value (const char *sym, const char *value)
	Sets all matching symtable entries to specified value.
void	symtable_assign (const sim_time *time)
	Assigns stored values to all associated signals stored in specified symbol table.
void	symtable_dealloc (symtable *symtab)
	Deallocates all symtable entries for specified symbol table.

---

Detailed Description

Contains functions for manipulating a symtable structure.

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

1/3/2002

---

Function Documentation

void symtable_add	(	const char *	sym,
		vsignal *	sig,
		int	msb,
		int	lsb
	)

Creates a new symtable entry and adds it to the specified symbol table.

Using the symbol as a unique ID, creates a new symtable element for specified information and places it into the binary tree.

Parameters:

	sym	VCD symbol for the specified signal
	sig	Pointer to signal corresponding to the specified symbol
	msb	Most significant bit of variable to set
	lsb	Least significant bit of variable to set

References PROFILE, PROFILE_END, symtable_s::sig_head, symtable_add_sym_sig(), symtable_create(), symtable_init(), symtable_s::table, vsignal_s::value, and vcd_symtab_size.

Referenced by db_assign_symbol().

  { PROFILE(SYMTABLE_ADD);

  symtable*   curr;  /* Pointer to current symtable entry */
  const char* ptr;   /* Pointer to current character in sym */

  assert( vcd_symtab != NULL );
  assert( sym[0]     != '\0' );
  assert( sig->value != NULL );

  curr = vcd_symtab;
  ptr  = sym;

  while( *ptr != '\0' ) {
    if( curr->table[(int)*ptr] == NULL ) {
      curr->table[(int)*ptr] = symtable_create();
    }
    curr = curr->table[(int)*ptr];
    ptr++;
  }

  if( curr->sig_head == NULL ) {
    if( msb < lsb ) {
      symtable_init( curr, lsb, msb );
    } else {
      symtable_init( curr, msb, lsb );
    }
  }

  symtable_add_sym_sig( curr, sig, msb, lsb );

  /* 
   Finally increment the number of entries in the root table structure.
  */
  vcd_symtab_size++;

  PROFILE_END;

}

void symtable_assign

(

const sim_time *

time

)

Assigns stored values to all associated signals stored in specified symbol table.

Exceptions:

anonymous

vsignal_vcd_assign

Traverses simulation symentry array, assigning stored string value to the stored signal.

Parameters:

time

Pointer to current simulation time structure

References sym_sig_s::lsb, sym_sig_s::msb, sym_sig_s::next, postsim_size, PROFILE, PROFILE_END, sym_sig_s::sig, symtable_s::sig_head, symtable_s::value, and vsignal_vcd_assign().

Referenced by db_do_timestep().

  { PROFILE(SYMTABLE_ASSIGN);

  symtable* curr;  /* Pointer to current symtable entry */
  sym_sig*  sig;   /* Pointer to current sym_sig in list */
  int       i;     /* Loop iterator */

  for( i=0; i<postsim_size; i++ ) {
    curr = timestep_tab[i];
    sig = curr->sig_head;
    while( sig != NULL ) {
      vsignal_vcd_assign( sig->sig, curr->value, sig->msb, sig->lsb, time );
      sig = sig->next;
    }
    curr->value[0] = '\0';
  }
  postsim_size = 0;

  PROFILE_END;

}

symtable* symtable_create

(

)

Creates a new symtable structure.

Returns:

Returns a pointer to the newly created symbol table entry.

Creates a new symbol table entry and returns a pointer to the newly created structure.

References malloc_safe, PROFILE, PROFILE_END, symtable_s::sig_head, symtable_s::sig_tail, symtable_s::table, and symtable_s::value.

Referenced by covered_sim_calltf(), fst_parse(), lxt_parse(), symtable_add(), and vcd_parse().

                            { PROFILE(SYMTABLE_CREATE);

  symtable* symtab;  /* Pointer to new symtable entry */
  int       i;       /* Loop iterator */

  symtab           = (symtable*)malloc_safe( sizeof( symtable ) );
  symtab->sig_head = NULL;
  symtab->sig_tail = NULL;
  symtab->value    = NULL;
  for( i=0; i<256; i++ ) {
    symtab->table[i] = NULL;
  }

  PROFILE_END;

  return( symtab );

}

void symtable_dealloc

(

symtable *

symtab

)

Deallocates all symtable entries for specified symbol table.

Recursively deallocates all elements of specifies symbol table.

Parameters:

symtab

Pointer to root of symtable to clear

References free_safe, sym_sig_s::next, PROFILE, PROFILE_END, symtable_s::sig_head, symtable_s::size, symtable_dealloc(), symtable_s::table, and symtable_s::value.

Referenced by covered_end_of_sim(), fst_parse(), lxt_parse(), symtable_dealloc(), and vcd_parse().

  { PROFILE(SYMTABLE_DEALLOC);

  sym_sig* curr;  /* Pointer to current sym_sig in list */
  sym_sig* tmp;   /* Temporary pointer to sym_sig */
  int      i;     /* Loop iterator */

  if( symtab != NULL ) {

    for( i=0; i<256; i++ ) {
      symtable_dealloc( symtab->table[i] );
    }

    if( symtab->value != NULL ) {
      free_safe( symtab->value, symtab->size );
    }

    /* Remove sym_sig list */
    curr = symtab->sig_head;
    while( curr != NULL ) {
      tmp = curr->next;
      free_safe( curr, sizeof( sym_sig ) );
      curr = tmp;
    }

    free_safe( symtab, sizeof( symtable ) );

  }

  PROFILE_END;

}

void symtable_set_value	(	const char *	sym,
		const char *	value
	)

Sets all matching symtable entries to specified value.

Performs a binary search of the specified tree to find all matching symtable entries. When the signal is found, the specified value is assigned to the symtable entry.

Parameters:

	sym	Name of symbol to find in the table
	value	Value to set symtable entry to when match found

References FALSE, postsim_size, PROFILE, PROFILE_END, symtable_s::size, symtable_s::table, TRUE, and symtable_s::value.

Referenced by db_set_symbol_char(), and db_set_symbol_string().

  { PROFILE(SYMTABLE_SET_VALUE);

  symtable*   curr;         /* Pointer to current symtable */
  const char* ptr;          /* Pointer to current character in symbol */
  bool        set = FALSE;  /* Specifies if this symtable entry has been set this timestep yet */

  assert( vcd_symtab != NULL );
  assert( sym[0] != '\0' );

  curr = vcd_symtab;
  ptr  = sym;

  while( (curr != NULL) && (*ptr != '\0') ) {
    curr = curr->table[(int)*ptr];
    ptr++;
  }

  if( (curr != NULL) && (curr->value != NULL) ) {

    if( curr->value[0] != '\0' ) {
      set = TRUE;
    }

    /* printf( "strlen( value ): %d, curr->size: %d\n", strlen( value ), curr->size ); */
    assert( strlen( value ) < curr->size );     /* Useful for debugging but not necessary */
    strcpy( curr->value, value );

    if( !set ) {

      /* Place in postsim queue */
      timestep_tab[postsim_size] = curr;
      postsim_size++;
   
    }

  }

  PROFILE_END;

}