mti_AddSaveCB()

Adds a simulator checkpoint callback.

Syntax

mti_AddSaveCB( func, param ) 

Returns

Nothing

Arguments

Name	Type	Description
func	mtiVoidFuncPtrT	A pointer to a function to be called when the simulator does a checkpoint
param	void *	A parameter to be passed to the function; OPTIONAL - can be NULL

Description

mti_AddSaveCB() adds the specified function to the simulator checkpoint callback list. The same function can be added multiple times, with possibly a different parameter each time. During a checkpoint operation, all callbacks in the list are called with their respective parameters. The callback function should save its state at this time.

mti_AddSaveCB() should be called from a foreign initialization function. A foreign initialization function is specified either in the foreign attribute string of a foreign architecture or in the -foreign string option of a vsim command.

Related functions

mti_AddRestoreCB()

mti_GetCheckpointFilename()

mti_RemoveSaveCB()

mti_SaveBlock()

mti_SaveChar()

mti_SaveLong()

mti_SaveShort()

mti_SaveString()

Example

FLI code

#include <stdlib.h>
#include <mti.h>

static char * instance_info;

void saveCallback( void * param )
{
  char * inst_info = (char *)param;
  mti_PrintFormatted( "Saving instance info \"%s\"\n", inst_info );
  mti_SaveString( inst_info );
}

void restoreCallback( void * param )
{
  char * inst_info = (char *)param;
  strcpy( inst_info, mti_RestoreString() );
  mti_PrintFormatted( "Restored instance info \"%s\"\n", instance_info );
}

void cleanupCallback( void * param )
{
  mti_PrintMessage( "Cleaning up...\n" );
  free( param );
}

void initForeign(
  mtiRegionIdT       region,   /* The ID of the region in which this     */
                               /* foreign architecture is instantiated.  */
  char              *param,    /* The last part of the string in the     */
                               /* foreign attribute.                     */
  mtiInterfaceListT *generics, /* A list of generics for the foreign model.*/
  mtiInterfaceListT *ports     /* A list of ports for the foreign model.   */
)
{
  instance_info = malloc( strlen(param) + 1 );
  strcpy( instance_info, param );
  mti_AddSaveCB( saveCallback, instance_info );
  mti_AddRestoreCB( restoreCallback, instance_info );
  mti_AddQuitCB( cleanupCallback, instance_info );
  mti_AddRestartCB( cleanupCallback, instance_info );
} 

HDL code

entity for_model is
end for_model;

architecture a of for_model is
  attribute foreign of a : architecture is
   "initForeign for_model.sl; for_model";
begin
end a;

entity top is
end top;

architecture a of top is

  signal s1 : bit := '0';

  component for_model is
  end component;

  for all : for_model use entity work.for_model(a);

begin

  i1 : for_model;

  s1 <= not s1 after 5 ns;

end a; 

Simulation output

% vsim -c top
Reading .../modeltech/sunos5/../tcl/vsim/pref.tcl 

# 5.4b

# vsim -c top 
# Loading .../modeltech/sunos5/../std.standard
# Loading work.top(a)
# Loading work.for_model(a)
# Loading ./for_model.sl
VSIM 1> run 20
VSIM 2> checkpoint cp.file
# Saving instance info "for_model"
VSIM 3> run 30
VSIM 4> restore cp.file
# Loading checkpoint/restore data from file "cp.file"
# Checkpoint created Thu Apr 27 15:52:32 2000
# Restoring state at time 20 ns, iteration 1
# Restored instance info "for_model"
VSIM 5> run 10
VSIM 6> quit
# Cleaning up... 

Model Technology Inc. Voice: (503) 641-1340 Fax: (503)526-5410 http://www.model.com sales@model.com