OpenMPI  0.1.1
base.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2004-2006 The Trustees of Indiana University and Indiana
3  * University Research and Technology
4  * Corporation. All rights reserved.
5  * Copyright (c) 2004-2011 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) 2011 Cisco Systems, Inc. All rights reserved.
13  * $COPYRIGHT$
14  *
15  * Additional copyrights may follow
16  *
17  * $HEADER$
18  */
19 /** @file:
20  */
21 
22 #ifndef MCA_ODLS_BASE_H
23 #define MCA_ODLS_BASE_H
24 
25 /*
26  * includes
27  */
28 #include "orte_config.h"
29 
30 #include "opal/mca/mca.h"
31 #include "opal/class/opal_list.h"
32 
33 #include "orte/mca/odls/odls.h"
34 
35 
36 BEGIN_C_DECLS
37 
38 /**
39  * Open the odls framework
40  */
41 ORTE_DECLSPEC int orte_odls_base_open(void);
42 
43 #if !ORTE_DISABLE_FULL_SUPPORT
44 
45 /**
46  * Struct to hold globals for the odls framework
47  */
48 typedef struct orte_odls_base_t {
49  /* components are available */
50  bool components_available;
51  /* component has been selected */
52  bool selected;
53  /** List of opened components */
55  /** selected component */
58 
59 /**
60  * Global instance of odls-wide framework data
61  */
62 ORTE_DECLSPEC extern orte_odls_base_t orte_odls_base;
63 
64 /*
65  * Global functions for MCA overall collective open and close
66  */
67 
68 /**
69  * Select an odls module
70  */
71 ORTE_DECLSPEC int orte_odls_base_select(void);
72 
73 /**
74  * Close the odls framework
75  */
76 ORTE_DECLSPEC int orte_odls_base_finalize(void);
77 ORTE_DECLSPEC int orte_odls_base_close(void);
78 
79 /* proc termination entry points */
80 ORTE_DECLSPEC void orte_odls_base_notify_iof_complete(orte_process_name_t *proc);
81 ORTE_DECLSPEC void orte_base_default_waitpid_fired(orte_process_name_t *proc, int32_t status);
82 
83 /* setup singleton job data */
84 ORTE_DECLSPEC void orte_odls_base_setup_singleton_jobdat(orte_jobid_t jobid);
85 
86 /* Lookup function to see if the child process has already finished. */
87 ORTE_DECLSPEC bool orte_odls_base_default_check_finished(orte_process_name_t *proc);
88 
89 #endif /* ORTE_DISABLE_FULL_SUPPORT */
90 
91 END_C_DECLS
92 #endif
odls component
Definition: odls.h:111
orte_odls_base_component_t selected_component
selected component
Definition: base.h:56
Struct to hold globals for the odls framework.
Definition: base.h:48
uint32_t orte_jobid_t
Set the allowed range for ids in each space.
Definition: types.h:76
Definition: types.h:146
The opal_list_t interface is used to provide a generic doubly-linked list container for Open MPI...
Top-level interface for all MCA components.
struct orte_odls_base_t orte_odls_base_t
Struct to hold globals for the odls framework.
ORTE_DECLSPEC int orte_odls_base_finalize(void)
Close the odls framework.
ORTE_DECLSPEC orte_odls_base_t orte_odls_base
Global instance of odls-wide framework data.
Definition: odls_base_open.c:82
ORTE_DECLSPEC int orte_odls_base_select(void)
Select an odls module.
Definition: odls_base_select.c:34
opal_list_t available_components
List of opened components.
Definition: base.h:54
The OpenRTE Daemon's Local Launch Subsystem.
Definition: opal_list.h:147
BEGIN_C_DECLS ORTE_DECLSPEC int orte_odls_base_open(void)
Open the odls framework.
Definition: odls_base_open.c:89