OpenMPI  0.1.1
opal.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana
3  * University Research and Technology
4  * Corporation. All rights reserved.
5  * Copyright (c) 2004-2007 The University of Tennessee and The University
6  * of Tennessee Research Foundation. All rights
7  * reserved.
8  * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
9  * University of Stuttgart. All rights reserved.
10  * Copyright (c) 2004-2005 The Regents of the University of California.
11  * All rights reserved.
12  * Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
13  * Copyright (c) 2010 Cisco Systems, Inc. All rights reserved.
14  * $COPYRIGHT$
15  *
16  * Additional copyrights may follow
17  *
18  * $HEADER$
19  */
20 
21 /** @file **/
22 
23 #ifndef OPAL_H
24 #define OPAL_H
25 
26 #include "opal_config.h"
27 
28 BEGIN_C_DECLS
29 
30 /** version string of opal */
31 OPAL_DECLSPEC extern const char opal_version_string[];
32 
33 /* Size of a cache line. To be replaced with real hwloc info (in
34  trunk/v1.5 and beyond, only), but for the moment, just move it here
35  so that we can remove opal/include/sys/cache.h whose only purpose
36  is life is to #define CACHE_LINE_SIZE (and has a conflict on
37  NetBSD). */
38 OPAL_DECLSPEC extern int opal_cache_line_size;
39 
40 /**
41  * Initialize the OPAL layer, including the MCA system.
42  *
43  * @retval OPAL_SUCCESS Upon success.
44  * @retval OPAL_ERROR Upon failure.
45  *
46  * \note If this function is called, opal_init_util() should *not* be
47  * called.
48  */
49 OPAL_DECLSPEC int opal_init(int* pargc, char*** pargv);
50 
51 /**
52  * Finalize the OPAL layer, including the MCA system.
53  *
54  * @retval OPAL_SUCCESS Upon success.
55  * @retval OPAL_ERROR Upon failure.
56  *
57  * \note If this function is called, opal_finalize_util() should *not*
58  * be called.
59  */
60 OPAL_DECLSPEC int opal_finalize(void);
61 
62 /**
63  * Initialize the OPAL layer, excluding the MCA system.
64  *
65  * @retval OPAL_SUCCESS Upon success.
66  * @retval OPAL_ERROR Upon failure.
67  *
68  * \note If this function is called, opal_init() should *not*
69  * be called.
70  */
71 OPAL_DECLSPEC int opal_init_util(int* pargc, char*** pargv);
72 
73 /**
74  * Finalize the OPAL layer, excluding the MCA system.
75  *
76  * @retval OPAL_SUCCESS Upon success.
77  * @retval OPAL_ERROR Upon failure.
78  *
79  * \note If this function is called, opal_finalize() should *not*
80  * be called.
81  */
82 OPAL_DECLSPEC int opal_finalize_util(void);
83 
84 /**
85  * Internal function. Do not call.
86  */
87 OPAL_DECLSPEC int opal_register_params(void);
88 
89 END_C_DECLS
90 
91 #endif
OPAL_DECLSPEC int opal_init(int *pargc, char ***pargv)
Initialize the OPAL layer, including the MCA system.
Definition: opal_init.c:329
OPAL_DECLSPEC int opal_init_util(int *pargc, char ***pargv)
Initialize the OPAL layer, excluding the MCA system.
Definition: opal_init.c:224
OPAL_DECLSPEC int opal_finalize(void)
Finalize the OPAL layer, including the MCA system.
Definition: opal_finalize.c:113
OPAL_DECLSPEC int opal_finalize_util(void)
Finalize the OPAL layer, excluding the MCA system.
Definition: opal_finalize.c:62
BEGIN_C_DECLS OPAL_DECLSPEC const char opal_version_string[]
version string of opal
Definition: opal_init.c:70
OPAL_DECLSPEC int opal_register_params(void)
Internal function.
Definition: opal_params.c:41