reentrant.h File Reference

Contains functions for handling re-entrant tasks and functions. More...

#include "defines.h"

Go to the source code of this file.

Functions
reentrant *	reentrant_create (func_unit *funit)
	Allocates and initializes the reentrant structure for the given functional unit.
void	reentrant_dealloc (reentrant *ren, func_unit *funit, expression *expr)
	Deallocates all memory associated with the given reentrant structure.

---

Detailed Description

Contains functions for handling re-entrant tasks and functions.

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

12/11/2006

---

Function Documentation

reentrant* reentrant_create

(

func_unit *

funit

)

Allocates and initializes the reentrant structure for the given functional unit.

Returns:

Returns a pointer to the newly created reentrant structure.

Allocates and initializes the reentrant structure for the given functional unit, compressing and packing the bits into the given data structure.

Parameters:

funit

Pointer to functional unit to create a new reentrant structure for

References reentrant_s::data, reentrant_s::data_size, malloc_safe, PROFILE, PROFILE_END, reentrant_count_afu_bits(), and reentrant_store_data_bits().

Referenced by expression_op_func__passign().

  { PROFILE(REENTRANT_CREATE);

  reentrant*   ren  = NULL;  /* Pointer to newly created reentrant structure */
  int          data_size;    /* Number of uint8s needed to store the given functional unit */
  unsigned int bits = 0;     /* Number of bits needed to store signal values */
  int          i;            /* Loop iterator */

  /* Get size needed to store data */
  bits = reentrant_count_afu_bits( funit );

  /* Calculate data size */
  data_size = ((bits & 0x7) == 0) ? (bits >> 3) : ((bits >> 3) + 1);

  /* If there is data to store, allocate the needed memory and populate it */
  if( data_size > 0 ) {

    /* Allocate the structure */
    ren = (reentrant*)malloc_safe( sizeof( reentrant ) );

    /* Set the data size */
    ren->data_size = data_size;

    /* Allocate and initialize memory for data */
    ren->data = (uint8*)malloc_safe( sizeof( uint8 ) * ren->data_size );
    for( i=0; i<data_size; i++ ) {
      ren->data[i] = 0;
    }

    /* Walk through the signal list in the reentrant functional unit, compressing and saving vector values */
    reentrant_store_data_bits( funit, ren, 0 );

  }

  PROFILE_END;

  return( ren );

}

void reentrant_dealloc	(	reentrant *	ren,
		func_unit *	funit,
		expression *	expr
	)

Deallocates all memory associated with the given reentrant structure.

Pops data back into the given functional unit and deallocates all memory associated with the given reentrant structure.

Parameters:

	ren	Pointer to the reentrant structure to deallocate from memory
	funit	Pointer to functional unit associated with this reentrant structure
	expr	Pointer of expression to exclude from updating (optional)

References reentrant_s::data, reentrant_s::data_size, free_safe, PROFILE, PROFILE_END, and reentrant_restore_data_bits().

Referenced by expression_op_func__func_call(), and sim_thread().

  { PROFILE(REENTRANT_DEALLOC);

  if( ren != NULL ) {

    /* If we have data being stored, pop it */
    if( ren->data_size > 0 ) {

      /* Walk through each bit in the compressed data array and assign it back to its signal */
      reentrant_restore_data_bits( funit, ren, 0, expr );

      /* Deallocate the data uint8 array */
      free_safe( ren->data, (sizeof( uint8 ) * ren->data_size) );

    }

    /* Deallocate memory allocated for this reentrant structure */
    free_safe( ren, sizeof( reentrant ) );

  }

  PROFILE_END;

}