Changes between Version 1 and Version 2 of Public/User_Guide/SCR

Timestamp:

Sep 16, 2016, 2:04:00 PM (8 years ago)

Author:

Andreas Galonska

Comment:

—

Public/User_Guide/SCR

@@ -1 +1 @@
 
 == SCR (Scalable Checkpoint Restart) ==
+
+'''API'''
+
+{{{
+/* initialize the SCR library. If not using SIONlib _Buddy_Checkpointing_ use (NULL,NULL) as params, otherwise the check_readable() function and args from SIONlib (refer to SIONlib Doku) */
+int SCR_Init(int (* check_readable)(char *, void *), void *args);
+
+/* shut down the SCR library */
+int SCR_Finalize();
+
+/* determine whether a checkpoint should be taken at the current time */
+int SCR_Need_checkpoint(int* flag);
+
+/* inform library that a new checkpoint is starting */
+int SCR_Start_checkpoint();
+
+/* determine the path and filename to be used to open a file. Before calling SCR_Start_checkpoint -> delivers path to restore your data. After calling it -> path to a new checkpoint to be created */
+int SCR_Route_file(const char* name, char* file);
+
+/* inform library that the current checkpoint is complete. valid needs to be provided by user codes. SCR is unable to check if your CP was written correctly for obvious reasons */
+int SCR_Complete_checkpoint(int valid);
+
+/* register files created without knowledge of SCR, e.g. SIONlib Buddy checkpoints with multiple files. can be retrieved from SIOBlib by 
+ * sion_io_stat_t *file_stat; file_stat = sion_get_io_info(sid); before closing the SIONlib file. Then usage is:
+ * scr_register_files((const char**) file_stat->names, file_stat->nfiles);
+ * When only using SIONlib to create node-local files _without_ Buddy Checkpointing, this is _NOT_ necessary!
+ */
+int scr_register_files(const char **filenames, int n);
+}}}
+
+
+
+
 
 '''Configuration'''