SuperPin API

Typedefs
typedef VOID(*	LEVEL_PINCLIENT::SPSLICE_BEGIN_CALLBACK )(INT32 sliceNum, VOID *v)
typedef VOID(*	LEVEL_PINCLIENT::SPSLICE_END_CALLBACK )(INT32 sliceNum, VOID *v)
typedef VOID(*	LEVEL_PINCLIENT::SPSLICE_TOOLRESET_CALLBACK )(UINT32 sliceNum)
Functions
VOID	LEVEL_PINCLIENT::SP_AddSliceBeginFunction (SPSLICE_BEGIN_CALLBACK fun, VOID *val)
VOID	LEVEL_PINCLIENT::SP_AddSliceEndFunction (SPSLICE_END_CALLBACK fun, VOID *val)
VOID	LEVEL_PINCLIENT::SP_EndSlice ()
BOOL	LEVEL_PINCLIENT::SP_Init (SPSLICE_TOOLRESET_CALLBACK fun)
VOID *	LEVEL_PINCLIENT::SP_CreateSharedArea (VOID *localData, UINT32 size, UINT32 autoMerge)

---

Detailed Description

This API allows the tool user to write a superpin tool. Superpin will split the application into multiple slices that execute in parallel. The tool's data can be automatically merged or manually merged with a tool specified routine.

---

Typedef Documentation

typedef VOID(* LEVEL_PINCLIENT::SPSLICE_BEGIN_CALLBACK)(INT32 sliceNum, VOID *v)

Call back function when thread begins

typedef VOID(* LEVEL_PINCLIENT::SPSLICE_END_CALLBACK)(INT32 sliceNum, VOID *v)

Call back function when thread ends

typedef VOID(* LEVEL_PINCLIENT::SPSLICE_TOOLRESET_CALLBACK)(UINT32 sliceNum)

Call back function when thread begins after recording to reset statis

---

Function Documentation

VOID LEVEL_PINCLIENT::SP_AddSliceBeginFunction (  SPSLICE_BEGIN_CALLBACK  fun, VOID *  val )

Call func immediately after a new superpin slice has been created Parameters: fun  Call back function to execute after new thread has been created val  Value to be passed to fun when it is called

VOID LEVEL_PINCLIENT::SP_AddSliceEndFunction (  SPSLICE_END_CALLBACK  fun, VOID *  val )

Call func immediately before a superpin slice ends Parameters: fun  Call back function to execute before new thread ends val  Value to be passed to fun when it is called

VOID* LEVEL_PINCLIENT::SP_CreateSharedArea (  VOID *  localData, UINT32  size, UINT32  autoMerge )

Add automatic merging routine and allocate data return page of shared memory for tool usage if using superpin and success return localdata if not using superpin or failure

VOID LEVEL_PINCLIENT::SP_EndSlice (   )

SuperPin! End this timeslice now

BOOL LEVEL_PINCLIENT::SP_Init (  SPSLICE_TOOLRESET_CALLBACK  fun  )

Initialize SuperPin system. Must be called before PIN_StartProgram return TRUE if using superpin return FALSE if failure or not using superpin

---