Skip to content

Commit a872de1

Browse files
leobagoleobago
authored
Merge pull request #112 from leobago/AddParams
AddParams Former-commit-id: 6017a47
2 parents f412c51 + 7e2644f commit a872de1

File tree

11 files changed

+230
-53
lines changed

11 files changed

+230
-53
lines changed

‎doc/Doxyfile‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1794,18 +1794,6 @@ GENERATE_XML = NO
17941794

17951795
XML_OUTPUT = xml
17961796

1797-
# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1798-
# validating XML parser to check the syntax of the XML files.
1799-
# This tag requires that the tag GENERATE_XML is set to YES.
1800-
1801-
XML_SCHEMA =
1802-
1803-
# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1804-
# validating XML parser to check the syntax of the XML files.
1805-
# This tag requires that the tag GENERATE_XML is set to YES.
1806-
1807-
XML_DTD =
1808-
18091797
# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
18101798
# listings (including syntax highlighting and cross-referencing information) to
18111799
# the XML output. Note that enabling this will significantly increase the size

‎include/fti.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ typedef struct FTIT_metadata {
136136
} FTIT_metadata;
137137

138138
/** @typedef FTIT_execution
139-
* @brief Execution metadata
139+
* @brief Execution metadata.
140140
*
141141
* This type stores all the dynamic metadata related to the current execution
142142
*/

‎src/api.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ int FTI_Init(char* configFile, MPI_Comm globalComm)
139139
/*-------------------------------------------------------------------------*/
140140
/**
141141
@brief It returns the current status of the recovery flag.
142-
@return integer FTI_Exec.reco
142+
@return integer FTI_Exec.reco.
143143
144144
This function returns the current status of the recovery flag.
145145

‎src/checkpoint.c‎

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
/*-------------------------------------------------------------------------*/
1414
/**
1515
@brief It updates the local and global mean iteration time.
16+
@param FTI_Exec Execution metadata.
1617
@return integer FTI_SCES if successful.
1718
1819
This function updates the local and global mean iteration time. It also
@@ -66,7 +67,11 @@ int FTI_UpdateIterTime(FTIT_execution* FTI_Exec)
6667
/*-------------------------------------------------------------------------*/
6768
/**
6869
@brief It writes the checkpoint data in the target file.
69-
@param FTI_Data Dataset array.
70+
@param FTI_Conf Configuration metadata.
71+
@param FTI_Exec Execution metadata.
72+
@param FTI_Topo Topology metadata.
73+
@param FTI_Ckpt Checkpoint metadata.
74+
@param FTI_Data Dataset metadata.
7075
@return integer FTI_SCES if successful.
7176
7277
This function checks whether the checkpoint needs to be local or remote,
@@ -121,6 +126,9 @@ int FTI_WriteCkpt(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
121126
/*-------------------------------------------------------------------------*/
122127
/**
123128
@brief Decides wich action start depending on the ckpt. level.
129+
@param FTI_Conf Configuration metadata.
130+
@param FTI_Topo Topology metadata.
131+
@param FTI_Ckpt Checkpoint metadata.
124132
@param level Cleaning checkpoint level.
125133
@param group Must be groupID if App-proc. or 1 if Head.
126134
@param pr Must be 1 if App-proc. or nbApprocs if Head.
@@ -154,6 +162,10 @@ int FTI_GroupClean(FTIT_configuration* FTI_Conf, FTIT_topology* FTI_Topo,
154162
/*-------------------------------------------------------------------------*/
155163
/**
156164
@brief Decides wich action start depending on the ckpt. level.
165+
@param FTI_Conf Configuration metadata.
166+
@param FTI_Exec Execution metadata.
167+
@param FTI_Topo Topology metadata.
168+
@param FTI_Ckpt Checkpoint metadata.
157169
@param group Must be groupID if App-proc. or 1 if Head.
158170
@param fo Must be -1 if App-proc. or 0 if Head.
159171
@param pr Must be 1 if App-proc. or nbApprocs if Head.
@@ -261,6 +273,10 @@ int FTI_PostCkpt(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
261273
/*-------------------------------------------------------------------------*/
262274
/**
263275
@brief It listens for checkpoint notifications.
276+
@param FTI_Conf Configuration metadata.
277+
@param FTI_Exec Execution metadata.
278+
@param FTI_Topo Topology metadata.
279+
@param FTI_Ckpt Checkpoint metadata.
264280
@return integer FTI_SCES if successful.
265281
266282
This function listens for notifications from the application processes
@@ -313,6 +329,10 @@ int FTI_Listen(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
313329
/*-------------------------------------------------------------------------*/
314330
/**
315331
@brief Selects I/O to write to the PFS.
332+
@param FTI_Conf Configuration metadata.
333+
@param FTI_Exec Execution metadata.
334+
@param FTI_Topo Topology metadata.
335+
@param FTI_Data Dataset metadata.
316336
@return integer FTI_SCES if successful.
317337
318338
**/
@@ -365,6 +385,10 @@ int FTI_WritePar(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
365385
/*-------------------------------------------------------------------------*/
366386
/**
367387
@brief Writes ckpt to PFS using POSIX.
388+
@param FTI_Conf Configuration metadata.
389+
@param FTI_Exec Execution metadata.
390+
@param FTI_Topo Topology metadata.
391+
@param FTI_Data Dataset metadata.
368392
@return integer FTI_SCES if successful.
369393
370394
**/
@@ -433,7 +457,11 @@ int FTI_WriteSer(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
433457

434458
/*-------------------------------------------------------------------------*/
435459
/**
436-
@brief Writes ckpt to PFS using MPI I/O
460+
@brief Writes ckpt to PFS using MPI I/O.
461+
@param FTI_Conf Configuration metadata.
462+
@param FTI_Exec Execution metadata.
463+
@param FTI_Topo Topology metadata.
464+
@param FTI_Data Dataset metadata.
437465
@return integer FTI_SCES if successful.
438466
439467
In here it is taken into account, that in MPIIO the count parameter
@@ -581,8 +609,12 @@ int FTI_WriteMpi(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
581609

582610
/*-------------------------------------------------------------------------*/
583611
/**
584-
@brief Writes ckpt to PFS using SIONlib
585-
@return integer FTI_SCES if successful.
612+
@brief Writes ckpt to PFS using SIONlib.
613+
@param FTI_Conf Configuration metadata.
614+
@param FTI_Exec Execution metadata.
615+
@param FTI_Topo Topology metadata.
616+
@param FTI_Data Dataset metadata.
617+
@return integer FTI_SCES if successful.
586618
587619
**/
588620
/*-------------------------------------------------------------------------*/

‎src/conf.c‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
/*-------------------------------------------------------------------------*/
1111
/**
1212
@brief Sets the exec. ID and failure parameters in the conf. file.
13+
@param FTI_Conf Configuration metadata.
14+
@param FTI_Exec Execution metadata.
1315
@param restart Value to set in the conf. file (0 or 1).
1416
@return integer FTI_SCES if successful.
1517
@@ -78,6 +80,11 @@ int FTI_UpdateConf(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec, int r
7880
/*-------------------------------------------------------------------------*/
7981
/**
8082
@brief It reads the configuration given in the configuration file.
83+
@param FTI_Conf Configuration metadata.
84+
@param FTI_Exec Execution metadata.
85+
@param FTI_Topo Topology metadata.
86+
@param FTI_Ckpt Checkpoint metadata.
87+
@param FTI_Inje Type to describe failure injections in FTI.
8188
@return integer FTI_SCES if successful.
8289
8390
This function reads the configuration given in the FTI configuration
@@ -193,6 +200,9 @@ int FTI_ReadConf(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
193200
/*-------------------------------------------------------------------------*/
194201
/**
195202
@brief It tests that the configuration given is correct.
203+
@param FTI_Conf Configuration metadata.
204+
@param FTI_Topo Topology metadata.
205+
@param FTI_Ckpt Checkpoint metadata.
196206
@return integer FTI_SCES if successful.
197207
198208
This function tests the FTI configuration to make sure that all
@@ -290,6 +300,8 @@ int FTI_TestConfig(FTIT_configuration* FTI_Conf, FTIT_topology* FTI_Topo,
290300
/*-------------------------------------------------------------------------*/
291301
/**
292302
@brief It tests that the directories given is correct.
303+
@param FTI_Conf Configuration metadata.
304+
@param FTI_Topo Topology metadata.
293305
@return integer FTI_SCES if successful.
294306
295307
This function tests that the directories given in the FTI configuration
@@ -341,6 +353,10 @@ int FTI_TestDirectories(FTIT_configuration* FTI_Conf, FTIT_topology* FTI_Topo)
341353
/*-------------------------------------------------------------------------*/
342354
/**
343355
@brief It creates the directories required for current execution.
356+
@param FTI_Conf Configuration metadata.
357+
@param FTI_Exec Execution metadata.
358+
@param FTI_Topo Topology metadata.
359+
@param FTI_Ckpt Checkpoint metadata.
344360
@return integer FTI_SCES if successful.
345361
346362
This function creates the temporary metadata, local and global
@@ -406,6 +422,11 @@ int FTI_CreateDirs(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
406422
/*-------------------------------------------------------------------------*/
407423
/**
408424
@brief It reads and tests the configuration given.
425+
@param FTI_Conf Configuration metadata.
426+
@param FTI_Exec Execution metadata.
427+
@param FTI_Topo Topology metadata.
428+
@param FTI_Ckpt Checkpoint metadata.
429+
@param FTI_Inje Type to describe failure injections in FTI.
409430
@return integer FTI_SCES if successful.
410431
411432
This function reads the configuration file. Then test that the

‎src/meta.c‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
/*-------------------------------------------------------------------------*/
1111
/**
1212
@brief It gets the checksums from metadata.
13+
@param FTI_Conf Configuration metadata.
14+
@param FTI_Topo Topology metadata.
15+
@param FTI_Ckpt Checkpoint metadata.
1316
@param checksum Pointer to fill the checkpoint checksum.
1417
@param ptnerChecksum Pointer to fill the ptner file checksum.
1518
@param rsChecksum Pointer to fill the RS file checksum.
@@ -71,6 +74,10 @@ int FTI_GetChecksums(FTIT_configuration* FTI_Conf, FTIT_topology* FTI_Topo,
7174
/*-------------------------------------------------------------------------*/
7275
/**
7376
@brief It writes the RSed file checksum to metadata.
77+
@param FTI_Conf Configuration metadata.
78+
@param FTI_Exec Execution metadata.
79+
@param FTI_Topo Topology metadata.
80+
@param FTI_Ckpt Checkpoint metadata.
7481
@param rank global rank of the process
7582
@param checksum Pointer to the checksum.
7683
@return integer FTI_SCES if successful.
@@ -154,6 +161,9 @@ int FTI_WriteRSedChecksum(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec
154161
/*-------------------------------------------------------------------------*/
155162
/**
156163
@brief It gets the ptner file size from metadata.
164+
@param FTI_Conf Configuration metadata.
165+
@param FTI_Topo Topology metadata.
166+
@param FTI_Ckpt Checkpoint metadata.
157167
@param pfs Pointer to fill the ptner file size.
158168
@param group The group in the node.
159169
@param level The level of the ckpt or 0 if tmp.
@@ -197,6 +207,10 @@ int FTI_GetPtnerSize(FTIT_configuration* FTI_Conf, FTIT_topology* FTI_Topo,
197207
/*-------------------------------------------------------------------------*/
198208
/**
199209
@brief It gets the metadata to recover the data after a failure.
210+
@param FTI_Conf Configuration metadata.
211+
@param FTI_Exec Execution metadata.
212+
@param FTI_Topo Topology metadata.
213+
@param FTI_Ckpt Checkpoint metadata.
200214
@param fs Pointer to fill the checkpoint file size.
201215
@param mfs Pointer to fill the maximum file size.
202216
@param group The group in the node.
@@ -248,9 +262,12 @@ int FTI_GetMeta(FTIT_configuration* FTI_Conf, FTIT_execution* FTI_Exec,
248262
/*-------------------------------------------------------------------------*/
249263
/**
250264
@brief It writes the metadata to recover the data after a failure.
265+
@param FTI_Conf Configuration metadata.
266+
@param FTI_Topo Topology metadata.
251267
@param fs Pointer to the list of checkpoint sizes.
252268
@param mfs The maximum checkpoint file size.
253269
@param fnl Pointer to the list of checkpoint names.
270+
@param checksums Checksums array.
254271
@param member 0 if application process groupID of
255272
respective application process if head.
256273
@return integer FTI_SCES if successful.
@@ -355,6 +372,9 @@ int FTI_WriteMetadata(FTIT_configuration* FTI_Conf, FTIT_topology* FTI_Topo,
355372
/*-------------------------------------------------------------------------*/
356373
/**
357374
@brief It writes the metadata to recover the data after a failure.
375+
@param FTI_Conf Configuration metadata.
376+
@param FTI_Exec Execution metadata.
377+
@param FTI_Topo Topology metadata.
358378
@param globalTmp 1 if using global temporary directory.
359379
@param member 0 if application process groupID of
360380
respective application process if head.

0 commit comments

Comments
 (0)