OpenMPI 0.1.1

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

- File List
- Globals

plm.h
Go to the documentation of this file.
1 /*
2 * Copyright (c) 2004-2008 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$
13 *
14 * Additional copyrights may follow
15 *
16 * $HEADER$
17 */
18 /** @file:
19 *
20 * The Process Lifecycle Management (PLM) subsystem serves as the central
21 * switchyard for all process management activities, including
22 * resource allocation, process mapping, process launch, and process
23 * monitoring.
24 */
25
26 #ifndef ORTE_PLM_H
27 #define ORTE_PLM_H
28
29 /*
30 * includes
31 */
32
33 #include "orte_config.h"
34 #include "orte/types.h"
35
36 #include "opal/mca/mca.h"
37 #include "opal/dss/dss_types.h"
38 #include "opal/class/opal_pointer_array.h"
39
40 #include "orte/runtime/orte_globals.h"
41
42 #include "plm_types.h"
43
44 BEGIN_C_DECLS
45
46 /*
47 * Component functions - all MUST be provided
48 */
49
50 /*
51 * allow the selected module to initialize
52 */
53 typedef int (*orte_plm_base_module_init_fn_t)(void);
54
55 /*
56 * Spawn a job
57 */
58 typedef int (*orte_plm_base_module_spawn_fn_t)(orte_job_t *jdata);
59
60 /*
61 * Remote spawn - spawn called by a daemon to launch a process on its own
62 */
63 typedef int (*orte_plm_base_module_remote_spawn_fn_t)(opal_buffer_t *launch);
64
65 /*
66 * Entry point to set the HNP name
67 */
68 typedef int (*orte_plm_base_module_set_hnp_name_fn_t)(void);
69
70 /**
71 * Cleanup resources held by module.
72 */
73
74 typedef int (*orte_plm_base_module_finalize_fn_t)(void);
75
76 /**
77 * Terminate any processes launched for the respective jobid by
78 * this component.
79 */
80 typedef int (*orte_plm_base_module_terminate_job_fn_t)(orte_jobid_t);
81
82 /**
83 * Terminate the daemons
84 */
85 typedef int (*orte_plm_base_module_terminate_orteds_fn_t)(void);
86
87 /**
88 * Terminate an array of specific procs
89 */
90 typedef int (*orte_plm_base_module_terminate_procs_fn_t)(opal_pointer_array_t *procs);
91
92 /**
93 * Signal any processes launched for the respective jobid by
94 * this component.
95 */
96 typedef int (*orte_plm_base_module_signal_job_fn_t)(orte_jobid_t, int32_t);
97
98 /**
99 * plm module version 1.0.0
100 */
101 struct orte_plm_base_module_1_0_0_t {
102 orte_plm_base_module_init_fn_t init;
103 orte_plm_base_module_set_hnp_name_fn_t set_hnp_name;
104 orte_plm_base_module_spawn_fn_t spawn;
105 orte_plm_base_module_remote_spawn_fn_t remote_spawn;
106 orte_plm_base_module_terminate_job_fn_t terminate_job;
107 orte_plm_base_module_terminate_orteds_fn_t terminate_orteds;
108 orte_plm_base_module_terminate_procs_fn_t terminate_procs;
109 orte_plm_base_module_signal_job_fn_t signal_job;
110 orte_plm_base_module_finalize_fn_t finalize;
111 };
112
113 /** shorten orte_plm_base_module_1_0_0_t declaration */
114 typedef struct orte_plm_base_module_1_0_0_t orte_plm_base_module_1_0_0_t;
115 /** shorten orte_plm_base_module_t declaration */
116 typedef struct orte_plm_base_module_1_0_0_t orte_plm_base_module_t;
117
118
119 /**
120 * plm component
121 */
122 struct orte_plm_base_component_2_0_0_t {
123 /** component version */
124 mca_base_component_t base_version;
125 /** component data */
126 mca_base_component_data_t base_data;
127 };
128 /** Convenience typedef */
129 typedef struct orte_plm_base_component_2_0_0_t orte_plm_base_component_2_0_0_t;
130 /** Convenience typedef */
131 typedef orte_plm_base_component_2_0_0_t orte_plm_base_component_t;
132
133
134 /**
135 * Macro for use in modules that are of type plm
136 */
137 #define ORTE_PLM_BASE_VERSION_2_0_0 \
138 MCA_BASE_VERSION_2_0_0, \
139 "plm", 2, 0, 0
140
141 /* Global structure for accessing PLM functions */
142 ORTE_DECLSPEC extern orte_plm_base_module_t orte_plm; /* holds selected module's function pointers */
143
144 END_C_DECLS
145
146 #endif
mca_base_component_2_0_0_t
Common type for all MCA components.
Definition: mca.h:250
opal_pointer_array_t
dynamic pointer array
Definition: opal_pointer_array.h:45
orte_plm_base_module_signal_job_fn_t
int(* orte_plm_base_module_signal_job_fn_t)(orte_jobid_t, int32_t)
Signal any processes launched for the respective jobid by this component.
Definition: plm.h:96
orte_jobid_t
uint32_t orte_jobid_t
Set the allowed range for ids in each space.
Definition: types.h:76
orte_plm_base_component_2_0_0_t::base_data
mca_base_component_data_t base_data
component data
Definition: plm.h:126
orte_plm_base_component_t
orte_plm_base_component_2_0_0_t orte_plm_base_component_t
Convenience typedef.
Definition: plm.h:131
opal_pointer_array.h
See opal_bitmap.h for an explanation of why there is a split between OPAL and ORTE for this generic c...
orte_plm_base_module_terminate_procs_fn_t
int(* orte_plm_base_module_terminate_procs_fn_t)(opal_pointer_array_t *procs)
Terminate an array of specific procs.
Definition: plm.h:90
mca.h
Top-level interface for all MCA components.
types.h
orte_plm_base_module_terminate_job_fn_t
int(* orte_plm_base_module_terminate_job_fn_t)(orte_jobid_t)
Terminate any processes launched for the respective jobid by this component.
Definition: plm.h:80
orte_plm_base_component_2_0_0_t
plm component
Definition: plm.h:122
dss_types.h
Buffer management types.
mca_base_component_data_2_0_0_t
Meta data for MCA v2.0.0 components.
Definition: mca.h:309
orte_job_t
Definition: orte_globals.h:316
orte_globals.h
Global params for OpenRTE.
orte_plm_base_component_2_0_0_t::base_version
mca_base_component_t base_version
component version
Definition: plm.h:124
opal_buffer_t
Structure for holding a buffer to be used with the RML or OOB subsystems.
Definition: dss_types.h:159
orte_plm_base_module_finalize_fn_t
int(* orte_plm_base_module_finalize_fn_t)(void)
Cleanup resources held by module.
Definition: plm.h:74
orte_plm_base_module_1_0_0_t
plm module version 1.0.0
Definition: plm.h:101
orte_plm_base_module_terminate_orteds_fn_t
int(* orte_plm_base_module_terminate_orteds_fn_t)(void)
Terminate the daemons.
Definition: plm.h:85