OpenMPI  0.1.1
carto_file.h
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-2005 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) 2006-2007 Cisco Systems, Inc. All rights reserved.
13  *
14  * $COPYRIGHT$
15  *
16  * Additional copyrights may follow
17  *
18  * $HEADER$
19  */
20 
21 /**
22  * @file#this is a comment
23 # Node declaration Node type (Free string) Node name (Free string)
24 # (Reserve word) (socket is a reserve word (free string)
25 # for CPU socket)
26 #=======================================================================
27  EDGE Memory mem0
28  EDGE Memory mem1
29  EDGE Memory mem2
30  EDGE Memory mem3
31 #
32  EDGE socket socket0
33  EDGE socket socket1
34  EDGE socket socket2
35  EDGE socket socket3
36 #
37  EDGE Infiniband mthca0
38  EDGE Infiniband mthca1
39 #
40  EDGE Ethernet eth0
41  EDGE Ethernet eth1
42 #
43 #
44 # Connection decleration From node To node:weight To node:weight ......
45 # (Reserve word) (declered (declered (declered
46 # above) above) above)
47 #===============================================================================================
48  BRANCH mem0 socket0:0
49  BRANCH mem3 socket3:0
50 #
51  BRANCH socket0 mem0:0 socket1:1 socket2:1 mthca0:1 eth0:1
52  BRANCH socket1 socket0:1 socket3:1
53  BRANCH socket2 socket1:1 socket3:1
54  BRANCH socket3 mem3:0 socket1:1 socket2:1 mthca1:1 eth1:1
55 #
56 #
57  BRANCH mthca0 socket0:1
58  BRANCH mthca1 socket3:1
59 #
60  BRANCH eth0 socket0:1
61  BRANCH eth1 socket3:1
62 
63 #Bi-Directional connection
64 #
65  BRANCH_BI_DIR socket1 mem1:0
66  BRANCH_BI_DIR socket2 mem2:0
67 #
68 # end of carto file.
69 
70  *
71  * The file component uses a cartograpy file to discover the
72  * host cartography.
73  *
74  * An example cartography file:
75  *
76 
77  *
78  *
79  *
80  *
81  *
82  */
83 
84 #ifndef MCA_CARTO_FILE_H
85 #define MCA_CARTO_FILE_H
86 
87 #include "opal_config.h"
88 
89 #include "opal/mca/mca.h"
90 #include "opal/mca/carto/carto.h"
91 
92 BEGIN_C_DECLS
93 
94 extern char *carto_file_path;
95 
96 /**
97  * Globally exported variable
98  */
99 OPAL_DECLSPEC extern const opal_carto_base_component_2_0_0_t
100 mca_carto_file_component;
101 
102 
103 /**
104  * carto query API function
105  *
106  * Query function for carto components. Simply returns a priority
107  * to rank it against other available carto components (assumedly,
108  * only one component will be available per platform, but it's
109  * possible that there could be more than one available).
110  */
111 int opal_carto_file_component_query(mca_base_module_t **module, int *priority);
112 
113 END_C_DECLS
114 
115 #endif /* MCA_CARTO_FILE_EXPORT_H */
Common type for all MCA modules.
Definition: mca.h:100
The carto framework suplies an information of the the host structure and connection between the host ...
Structure for carto components.
Definition: carto.h:118
Top-level interface for all MCA components.