OpenMPI  0.1.1
base.h
1 /*
2  * Copyright (c) 2004-2010 The Trustees of Indiana University and Indiana
3  * University Research and Technology
4  * Corporation. All rights reserved.
5  *
6  * $COPYRIGHT$
7  *
8  * Additional copyrights may follow
9  *
10  * $HEADER$
11  */
12 #ifndef OPAL_COMPRESS_BASE_H
13 #define OPAL_COMPRESS_BASE_H
14 
15 #include "opal_config.h"
17 #include "opal/util/opal_environ.h"
18 #include "opal/runtime/opal_cr.h"
19 
20 /*
21  * Global functions for MCA overall COMPRESS
22  */
23 
24 #if defined(c_plusplus) || defined(__cplusplus)
25 extern "C" {
26 #endif
27 
28  /**
29  * Initialize the COMPRESS MCA framework
30  *
31  * @retval OPAL_SUCCESS Upon success
32  * @retval OPAL_ERROR Upon failures
33  *
34  * This function is invoked during opal_init();
35  */
36  OPAL_DECLSPEC int opal_compress_base_open(void);
37 
38  /**
39  * Select an available component.
40  *
41  * @retval OPAL_SUCCESS Upon Success
42  * @retval OPAL_NOT_FOUND If no component can be selected
43  * @retval OPAL_ERROR Upon other failure
44  *
45  */
46  OPAL_DECLSPEC int opal_compress_base_select(void);
47 
48  /**
49  * Finalize the COMPRESS MCA framework
50  *
51  * @retval OPAL_SUCCESS Upon success
52  * @retval OPAL_ERROR Upon failures
53  *
54  * This function is invoked during opal_finalize();
55  */
56  OPAL_DECLSPEC int opal_compress_base_close(void);
57 
58  /**
59  * Globals
60  */
61  OPAL_DECLSPEC extern int opal_compress_base_output;
62  OPAL_DECLSPEC extern opal_list_t opal_compress_base_components_available;
63  OPAL_DECLSPEC extern opal_compress_base_component_t opal_compress_base_selected_component;
64  OPAL_DECLSPEC extern opal_compress_base_module_t opal_compress;
65 
66  /**
67  *
68  */
69  OPAL_DECLSPEC int opal_compress_base_tar_create(char ** target);
70  OPAL_DECLSPEC int opal_compress_base_tar_extract(char ** target);
71 
72 #if defined(c_plusplus) || defined(__cplusplus)
73 }
74 #endif
75 
76 #endif /* OPAL_COMPRESS_BASE_H */
Compression Framework.
Generic helper routines for environment manipulation.
Structure for COMPRESS modules.
Definition: compress.h:104
Definition: opal_list.h:147
Structure for COMPRESS components.
Definition: compress.h:85
Checkpoint functionality for Open MPI.