OpenMPI 0.1.1

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

base.h
1 /*
2 * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
3 * University Research and Technology
4 * Corporation. All rights reserved.
5 * Copyright (c) 2004-2006 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) 2007 Cisco Systems, Inc. All rights reserved.
13 * $COPYRIGHT$
14 *
15 * Additional copyrights may follow
16 *
17 * $HEADER$
18 *
19 */
20
21 #ifndef OPAL_PSTAT_BASE_H
22 #define OPAL_PSTAT_BASE_H
23
24 #include "opal_config.h"
25
26 #include "opal/mca/pstat/pstat.h"
27
28 /*
29 * Global functions for MCA overall pstat open and close
30 */
31
32 BEGIN_C_DECLS
33
34 /**
35 * Initialize the pstat MCA framework
36 *
37 * @retval OPAL_SUCCESS Upon success
38 * @retval OPAL_ERROR Upon failure
39 *
40 * This must be the first function invoked in the pstat MCA
41 * framework. It initializes the pstat MCA framework, finds
42 * and opens pstat components, etc.
43 *
44 * This function is invoked during opal_init().
45 */
46 OPAL_DECLSPEC int opal_pstat_base_open(void);
47
48 /**
49 * Close the pstat MCA framework
50 *
51 * @retval OPAL_SUCCESS Upon success
52 * @retval OPAL_ERROR Upon failure
53 *
54 * This must be the last function invoked in the pstat MCA
55 * framework.
56 *
57 * This function is invoked during opal_finalize().
58 */
59 OPAL_DECLSPEC int opal_pstat_base_close(void);
60
61 /**
62 * Select an available component.
63 *
64 * @return OPAL_SUCCESS Upon success.
65 * @return OPAL_NOT_FOUND If no component can be selected.
66 * @return OPAL_ERROR Upon other failure.
67 *
68 * At the end of this process, we'll either have a single
69 * component that is selected and initialized, or no component was
70 * selected. If no component was selected, subsequent invocation
71 * of the pstat functions will return an error indicating no data
72 * could be obtained
73 */
74 OPAL_DECLSPEC int opal_pstat_base_select(void);
75
76 OPAL_DECLSPEC extern int opal_pstat_base_output;
77 OPAL_DECLSPEC extern opal_list_t opal_pstat_base_components_opened;
78 OPAL_DECLSPEC extern opal_pstat_base_component_t *opal_pstat_base_component;
79
80 END_C_DECLS
81
82 #endif /* OPAL_BASE_PSTAT_H */
pstat.h
pstat (process statistics) framework component interface.
opal_list_t
Definition: opal_list.h:147
opal_pstat_base_component_2_0_0_t
Structure for pstat components.
Definition: pstat.h:50