Skip to content

Commit

Permalink
Merge pull request #112 from leobago/AddParams
Browse files Browse the repository at this point in the history 
AddParams

Former-commit-id: 6017a47
  • Loading branch information
@leobago
leobago authored Jul 13, 2017
2 parents f412c51 + 7e2644f commit a872de1
Show file tree
Hide file tree
Showing 11 changed files with 230 additions and 53 deletions.
12 changes: 0 additions & 12 deletions doc/Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1794,18 +1794,6 @@ GENERATE_XML = NO

XML_OUTPUT = xml

# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
# validating XML parser to check the syntax of the XML files.
# This tag requires that the tag GENERATE_XML is set to YES.

XML_SCHEMA =

# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
# validating XML parser to check the syntax of the XML files.
# This tag requires that the tag GENERATE_XML is set to YES.

XML_DTD =

# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
# the XML output. Note that enabling this will significantly increase the size
Expand Down
2 changes: 1 addition & 1 deletion include/fti.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ typedef struct FTIT_metadata {
} FTIT_metadata;

/** @typedef FTIT_execution
* @brief Execution metadata
* @brief Execution metadata.
*
* This type stores all the dynamic metadata related to the current execution
*/
Expand Down
2 changes: 1 addition & 1 deletion src/api.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ int FTI_Init(char* configFile, MPI_Comm globalComm)
/*-------------------------------------------------------------------------*/
/**
@brief It returns the current status of the recovery flag.
@return integer FTI_Exec.reco
@return integer FTI_Exec.reco.
This function returns the current status of the recovery flag.
Expand Down
40 changes: 36 additions & 4 deletions src/checkpoint.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
/*-------------------------------------------------------------------------*/
/**
@brief It updates the local and global mean iteration time.
@param FTI_Exec Execution metadata.
@return integer FTI_SCES if successful.
This function updates the local and global mean iteration time. It also
Expand Down Expand Up @@ -66,7 +67,11 @@ int FTI_UpdateIterTime(FTIT_execution* FTI_Exec)
/*-------------------------------------------------------------------------*/
/**
@brief It writes the checkpoint data in the target file.
@param FTI_Data Dataset array.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param FTI_Topo Topology metadata.
@param FTI_Ckpt Checkpoint metadata.
@param FTI_Data Dataset metadata.
@return integer FTI_SCES if successful.
This function checks whether the checkpoint needs to be local or remote,
Expand Down Expand Up @@ -121,6 +126,9 @@ int FTI_WriteCkpt(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
/*-------------------------------------------------------------------------*/
/**
@brief Decides wich action start depending on the ckpt. level.
@param FTI_Conf Configuration metadata.
@param FTI_Topo Topology metadata.
@param FTI_Ckpt Checkpoint metadata.
@param level Cleaning checkpoint level.
@param group Must be groupID if App-proc. or 1 if Head.
@param pr Must be 1 if App-proc. or nbApprocs if Head.
Expand Down Expand Up @@ -154,6 +162,10 @@ int FTI_GroupClean(FTIT_configuration* FTI_Conf, FTIT_topology* FTI_Topo,
/*-------------------------------------------------------------------------*/
/**
@brief Decides wich action start depending on the ckpt. level.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param FTI_Topo Topology metadata.
@param FTI_Ckpt Checkpoint metadata.
@param group Must be groupID if App-proc. or 1 if Head.
@param fo Must be -1 if App-proc. or 0 if Head.
@param pr Must be 1 if App-proc. or nbApprocs if Head.
Expand Down Expand Up @@ -261,6 +273,10 @@ int FTI_PostCkpt(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
/*-------------------------------------------------------------------------*/
/**
@brief It listens for checkpoint notifications.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param FTI_Topo Topology metadata.
@param FTI_Ckpt Checkpoint metadata.
@return integer FTI_SCES if successful.
This function listens for notifications from the application processes
Expand Down Expand Up @@ -313,6 +329,10 @@ int FTI_Listen(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
/*-------------------------------------------------------------------------*/
/**
@brief Selects I/O to write to the PFS.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param FTI_Topo Topology metadata.
@param FTI_Data Dataset metadata.
@return integer FTI_SCES if successful.
**/
Expand Down Expand Up @@ -365,6 +385,10 @@ int FTI_WritePar(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
/*-------------------------------------------------------------------------*/
/**
@brief Writes ckpt to PFS using POSIX.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param FTI_Topo Topology metadata.
@param FTI_Data Dataset metadata.
@return integer FTI_SCES if successful.
**/
Expand Down Expand Up @@ -433,7 +457,11 @@ int FTI_WriteSer(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,

/*-------------------------------------------------------------------------*/
/**
@brief Writes ckpt to PFS using MPI I/O
@brief Writes ckpt to PFS using MPI I/O.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param FTI_Topo Topology metadata.
@param FTI_Data Dataset metadata.
@return integer FTI_SCES if successful.
In here it is taken into account, that in MPIIO the count parameter
Expand Down Expand Up @@ -581,8 +609,12 @@ int FTI_WriteMpi(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,

/*-------------------------------------------------------------------------*/
/**
@brief Writes ckpt to PFS using SIONlib
@return integer FTI_SCES if successful.
@brief Writes ckpt to PFS using SIONlib.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param FTI_Topo Topology metadata.
@param FTI_Data Dataset metadata.
@return integer FTI_SCES if successful.
**/
/*-------------------------------------------------------------------------*/
Expand Down
21 changes: 21 additions & 0 deletions src/conf.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
/*-------------------------------------------------------------------------*/
/**
@brief Sets the exec. ID and failure parameters in the conf. file.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param restart Value to set in the conf. file (0 or 1).
@return integer FTI_SCES if successful.
Expand Down Expand Up @@ -78,6 +80,11 @@ int FTI_UpdateConf(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec, int r
/*-------------------------------------------------------------------------*/
/**
@brief It reads the configuration given in the configuration file.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param FTI_Topo Topology metadata.
@param FTI_Ckpt Checkpoint metadata.
@param FTI_Inje Type to describe failure injections in FTI.
@return integer FTI_SCES if successful.
This function reads the configuration given in the FTI configuration
Expand Down Expand Up @@ -193,6 +200,9 @@ int FTI_ReadConf(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
/*-------------------------------------------------------------------------*/
/**
@brief It tests that the configuration given is correct.
@param FTI_Conf Configuration metadata.
@param FTI_Topo Topology metadata.
@param FTI_Ckpt Checkpoint metadata.
@return integer FTI_SCES if successful.
This function tests the FTI configuration to make sure that all
Expand Down Expand Up @@ -290,6 +300,8 @@ int FTI_TestConfig(FTIT_configuration* FTI_Conf, FTIT_topology* FTI_Topo,
/*-------------------------------------------------------------------------*/
/**
@brief It tests that the directories given is correct.
@param FTI_Conf Configuration metadata.
@param FTI_Topo Topology metadata.
@return integer FTI_SCES if successful.
This function tests that the directories given in the FTI configuration
Expand Down Expand Up @@ -341,6 +353,10 @@ int FTI_TestDirectories(FTIT_configuration* FTI_Conf, FTIT_topology* FTI_Topo)
/*-------------------------------------------------------------------------*/
/**
@brief It creates the directories required for current execution.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param FTI_Topo Topology metadata.
@param FTI_Ckpt Checkpoint metadata.
@return integer FTI_SCES if successful.
This function creates the temporary metadata, local and global
Expand Down Expand Up @@ -406,6 +422,11 @@ int FTI_CreateDirs(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
/*-------------------------------------------------------------------------*/
/**
@brief It reads and tests the configuration given.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param FTI_Topo Topology metadata.
@param FTI_Ckpt Checkpoint metadata.
@param FTI_Inje Type to describe failure injections in FTI.
@return integer FTI_SCES if successful.
This function reads the configuration file. Then test that the
Expand Down
20 changes: 20 additions & 0 deletions src/meta.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
/*-------------------------------------------------------------------------*/
/**
@brief It gets the checksums from metadata.
@param FTI_Conf Configuration metadata.
@param FTI_Topo Topology metadata.
@param FTI_Ckpt Checkpoint metadata.
@param checksum Pointer to fill the checkpoint checksum.
@param ptnerChecksum Pointer to fill the ptner file checksum.
@param rsChecksum Pointer to fill the RS file checksum.
Expand Down Expand Up @@ -71,6 +74,10 @@ int FTI_GetChecksums(FTIT_configuration* FTI_Conf, FTIT_topology* FTI_Topo,
/*-------------------------------------------------------------------------*/
/**
@brief It writes the RSed file checksum to metadata.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param FTI_Topo Topology metadata.
@param FTI_Ckpt Checkpoint metadata.
@param rank global rank of the process
@param checksum Pointer to the checksum.
@return integer FTI_SCES if successful.
Expand Down Expand Up @@ -154,6 +161,9 @@ int FTI_WriteRSedChecksum(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec
/*-------------------------------------------------------------------------*/
/**
@brief It gets the ptner file size from metadata.
@param FTI_Conf Configuration metadata.
@param FTI_Topo Topology metadata.
@param FTI_Ckpt Checkpoint metadata.
@param pfs Pointer to fill the ptner file size.
@param group The group in the node.
@param level The level of the ckpt or 0 if tmp.
Expand Down Expand Up @@ -197,6 +207,10 @@ int FTI_GetPtnerSize(FTIT_configuration* FTI_Conf, FTIT_topology* FTI_Topo,
/*-------------------------------------------------------------------------*/
/**
@brief It gets the metadata to recover the data after a failure.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param FTI_Topo Topology metadata.
@param FTI_Ckpt Checkpoint metadata.
@param fs Pointer to fill the checkpoint file size.
@param mfs Pointer to fill the maximum file size.
@param group The group in the node.
Expand Down Expand Up @@ -248,9 +262,12 @@ int FTI_GetMeta(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
/*-------------------------------------------------------------------------*/
/**
@brief It writes the metadata to recover the data after a failure.
@param FTI_Conf Configuration metadata.
@param FTI_Topo Topology metadata.
@param fs Pointer to the list of checkpoint sizes.
@param mfs The maximum checkpoint file size.
@param fnl Pointer to the list of checkpoint names.
@param checksums Checksums array.
@param member 0 if application process groupID of
respective application process if head.
@return integer FTI_SCES if successful.
Expand Down Expand Up @@ -355,6 +372,9 @@ int FTI_WriteMetadata(FTIT_configuration* FTI_Conf, FTIT_topology* FTI_Topo,
/*-------------------------------------------------------------------------*/
/**
@brief It writes the metadata to recover the data after a failure.
@param FTI_Conf Configuration metadata.
@param FTI_Exec Execution metadata.
@param FTI_Topo Topology metadata.
@param globalTmp 1 if using global temporary directory.
@param member 0 if application process groupID of
respective application process if head.
Expand Down
Loading

0 comments on commit a872de1

Please sign in to comment.