ftp_ckpt.h

Path MPICH-V for MPICH the MPI Implementation

/** @file ftp_ckpt.h defines the checkpoint API for daemon */
#ifndef _FTP_CKPT_H_
#define _FTP_CKPT_H_

#include "config.h"
#include "debug.h"
#include "checkpoint.h"
#include "protocolCheckpoint.h"


/** This protocol dependent function gives size of Protocol Channel data size
  * @param np: number of MPI processes
  * @return size of protocol data size suitable for genericCheckpoint.putCkptProto()
  */
#ifndef ftp_ckpt_protocolsize
int ftp_ckpt_protocolsize(int np);
#endif

/** This function may modify or take some specifical protocol action related to the 
  * previous value of the seqnumber. Called just before connection to checkpoint server.
  * @param previous value of the seqnumber
  */ 
#ifndef ftp_ckpt_seqnumber
void ftp_ckpt_seqnumber(int seq);
#endif

/** This function indicates if checkpoint socket should be added to writeset of select
  * @param cin: CkptInfo struct associated to this checkpoint
  * @return 0 when this socket has not to be set, cin->sock.data otherwise
  */
#ifndef ftp_ckpt_wfdset
int ftp_ckpt_wfdset(CkptInfo *cin);
#endif

/** This function test wether a checkpoint is possible at this time or not.
  * @return 0 no checkpoint is possible, CP_START (from vtypes.h) a
  *   checkpoint is possible now
  */
#ifndef ftp_ckpt_try
int ftp_ckpt_try(void);
#endif

/** Called during pckpt_begin. Protocol dependent checkpoint mmodule may initialize
  * some staticaly defined status with this function.
  * @param cin: Checkpoint structure associated with this checkpoint
  * @return -1 on error, 0 on sucess
  */
#ifndef ftp_ckpt_begin
int ftp_ckpt_begin(CkptInfo *cin);
#endif

/** This protocol dependent function gives number of function 
  * set by setwritefunc  
  */
#ifndef ftp_ckpt_nbfunc
int ftp_ckpt_nbfunc(void);
#endif

/** This protocol dependent function sets list of functions and args to call
  * in order to proceed to checkpoint. Theses functions are called by pckpt_generic_write()
  * in that order. Functions to be called may be defined as static functions
  * elsewhere. pckpt_imgwritefunc gives an exemple of such a function, witch could be used
  * as an exemple of async checkpoint sending function.
  */
#ifndef ftp_ckpt_setwritefunc
void ftp_ckpt_setwritefunc(CkptInfo *cin);
#endif

/** Called just before closing connexions to checkpoint server. May be used to
  * finalize some protocol specific tasks in the protocol specific checkpoint
  * module.
  * @param cin: Checkpoint structure associated with this checkpoint
  * @return -1 on error, 0 on sucess
  */
#ifndef ftp_ckpt_end
int ftp_ckpt_end(CkptInfo *cin);
#endif



/** Called during prestart_begin. Protocol dependent checkpoint mmodule may initialize
  * some staticaly defined status with this function.
  * @param cin: Checkpoint structure associated with this checkpoint
  * @return -1 on error, 0 on sucess
  */
#ifndef ftp_restart_begin
int ftp_restart_begin(CkptInfo *cin);
#endif

/** This protocol dependent function gives number of function 
  * set by setwritefunc  
  */
#ifndef ftp_restart_nbfunc
int ftp_restart_nbfunc(void);
#endif

/** This protocol dependent function sets list of functions and args to call
  * in order to proceed to restart. Theses functions are called by prestart_generic_read()
  * in that order. Functions to be called may be defined as static functions
  * elsewhere. pckpt_imgreadfunc gives an exemple of such a function, witch could be used
  * as an exemple of async checkpoint sending function.
  */
#ifndef ftp_restart_setreadfunc
int ftp_restart_setreadfunc(CkptInfo *cin);
#endif

/** Called just before closing connexions to checkpoint server. May be used to
  * finalize some protocol specific tasks in the protocol specific checkpoint
  * module.
  * @param cin: Checkpoint structure associated with this checkpoint
  * @return -1 on error, 0 on sucess
  */
#ifndef ftp_restart_end
int ftp_restart_end(CkptInfo *);
#endif


#endif