OpenMPI 0.1.1

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

- File List
- Globals

pstat.h
Go to the documentation of this file.
1 /*
2 * Copyright (c) 2004-2007 High Performance Computing Center Stuttgart,
3 * University of Stuttgart. All rights reserved.
4 * Copyright (c) 2004-2008 The Trustees of Indiana University.
5 * All rights reserved.
6 *
7 * $COPYRIGHT$
8 *
9 * Additional copyrights may follow
10 *
11 * $HEADER$
12 */
13
14 /**
15 * @file
16 *
17 * pstat (process statistics) framework component interface.
18 *
19 * Intent
20 *
21 * To support the ompi-top utility.
22 *
23 */
24
25 #ifndef OPAL_MCA_PSTAT_H
26 #define OPAL_MCA_PSTAT_H
27
28 #include "opal_config.h"
29
30 #include "opal/mca/mca.h"
31 #include "opal/mca/base/base.h"
32 #include "opal/dss/dss_types.h"
33
34 BEGIN_C_DECLS
35
36 /**
37 * Module initialization function. Should return OPAL_SUCCESS.
38 */
39 typedef int (*opal_pstat_base_module_init_fn_t)(void);
40
41 typedef int (*opal_pstat_base_module_query_fn_t)(pid_t pid,
42 opal_pstats_t *stats,
43 opal_node_stats_t *nstats);
44
45 typedef int (*opal_pstat_base_module_fini_fn_t)(void);
46
47 /**
48 * Structure for pstat components.
49 */
50 struct opal_pstat_base_component_2_0_0_t {
51 /** MCA base component */
52 mca_base_component_t base_version;
53 /** MCA base data */
54 mca_base_component_data_t base_data;
55 };
56
57 /**
58 * Convenience typedef
59 */
60 typedef struct opal_pstat_base_component_2_0_0_t opal_pstat_base_component_2_0_0_t;
61 typedef struct opal_pstat_base_component_2_0_0_t opal_pstat_base_component_t;
62
63 /**
64 * Structure for pstat modules
65 */
66 struct opal_pstat_base_module_1_0_0_t {
67 opal_pstat_base_module_init_fn_t init;
68 opal_pstat_base_module_query_fn_t query;
69 opal_pstat_base_module_fini_fn_t finalize;
70 };
71
72 /**
73 * Convenience typedef
74 */
75 typedef struct opal_pstat_base_module_1_0_0_t opal_pstat_base_module_1_0_0_t;
76 typedef struct opal_pstat_base_module_1_0_0_t opal_pstat_base_module_t;
77
78
79 /**
80 * Macro for use in components that are of type pstat
81 */
82 #define OPAL_PSTAT_BASE_VERSION_2_0_0 \
83 MCA_BASE_VERSION_2_0_0, \
84 "pstat", 2, 0, 0
85
86 /* Global structure for accessing pstat functions */
87 OPAL_DECLSPEC extern opal_pstat_base_module_t opal_pstat;
88
89 END_C_DECLS
90
91 #endif /* OPAL_MCA_PSTAT_H */
mca_base_component_2_0_0_t
Common type for all MCA components.
Definition: mca.h:250
opal_pstat_base_module_init_fn_t
BEGIN_C_DECLS typedef int(* opal_pstat_base_module_init_fn_t)(void)
Module initialization function.
Definition: pstat.h:39
mca.h
Top-level interface for all MCA components.
opal_node_stats_t
Definition: dss_types.h:121
opal_pstat_base_component_2_0_0_t::base_data
mca_base_component_data_t base_data
MCA base data.
Definition: pstat.h:54
dss_types.h
Buffer management types.
opal_pstat_base_module_1_0_0_t
Structure for pstat modules.
Definition: pstat.h:66
mca_base_component_data_2_0_0_t
Meta data for MCA v2.0.0 components.
Definition: mca.h:309
opal_pstat_base_component_2_0_0_t::base_version
mca_base_component_t base_version
MCA base component.
Definition: pstat.h:52
opal_pstats_t
Definition: dss_types.h:100
opal_pstat_base_component_2_0_0_t
Structure for pstat components.
Definition: pstat.h:50