1 | #ifndef __XIOS_CContext__ |
---|
2 | #define __XIOS_CContext__ |
---|
3 | |
---|
4 | /// XIOS headers /// |
---|
5 | #include "xios_spl.hpp" |
---|
6 | //#include "node_type.hpp" |
---|
7 | #include "calendar_wrapper.hpp" |
---|
8 | |
---|
9 | #include "declare_group.hpp" |
---|
10 | //#include "context_client.hpp" |
---|
11 | //#include "context_server.hpp" |
---|
12 | #include "data_output.hpp" |
---|
13 | #include "garbage_collector.hpp" |
---|
14 | #include "registry.hpp" |
---|
15 | #include "mpi.hpp" |
---|
16 | |
---|
17 | |
---|
18 | namespace xios { |
---|
19 | class CContextClient; |
---|
20 | class CContextServer; |
---|
21 | |
---|
22 | |
---|
23 | /// ////////////////////// Dclarations ////////////////////// /// |
---|
24 | class CContextGroup; |
---|
25 | class CContextAttributes; |
---|
26 | class CContext; |
---|
27 | class CFile; |
---|
28 | ///-------------------------------------------------------------- |
---|
29 | |
---|
30 | // Declare/Define CFileAttribute |
---|
31 | BEGIN_DECLARE_ATTRIBUTE_MAP(CContext) |
---|
32 | # include "context_attribute.conf" |
---|
33 | END_DECLARE_ATTRIBUTE_MAP(CContext) |
---|
34 | |
---|
35 | ///-------------------------------------------------------------- |
---|
36 | /*! |
---|
37 | \class CContext |
---|
38 | This class corresponds to the concrete presentation of context in xml file and in play an essential role in XIOS |
---|
39 | Each object of this class contains all root definition of elements: files, fiels, domains, axis, etc, ... from which |
---|
40 | we can have access to each element. |
---|
41 | In fact, every thing must a be inside a particuliar context. After the xml file (iodef.xml) is parsed, |
---|
42 | object of the class is created and its contains all information of other elements in the xml file. |
---|
43 | */ |
---|
44 | class CContext |
---|
45 | : public CObjectTemplate<CContext> |
---|
46 | , public CContextAttributes |
---|
47 | { |
---|
48 | public : |
---|
49 | enum EEventId |
---|
50 | { |
---|
51 | EVENT_ID_CLOSE_DEFINITION,EVENT_ID_UPDATE_CALENDAR, |
---|
52 | EVENT_ID_CREATE_FILE_HEADER,EVENT_ID_CONTEXT_FINALIZE, |
---|
53 | EVENT_ID_POST_PROCESS, EVENT_ID_SEND_REGISTRY |
---|
54 | }; |
---|
55 | |
---|
56 | /// typedef /// |
---|
57 | typedef CObjectTemplate<CContext> SuperClass; |
---|
58 | typedef CContextAttributes SuperClassAttribute; |
---|
59 | |
---|
60 | public : |
---|
61 | |
---|
62 | typedef CContextAttributes RelAttributes; |
---|
63 | typedef CContext RelGroup; |
---|
64 | |
---|
65 | //--------------------------------------------------------- |
---|
66 | |
---|
67 | public : |
---|
68 | |
---|
69 | /// Constructeurs /// |
---|
70 | CContext(void); |
---|
71 | explicit CContext(const StdString & id); |
---|
72 | CContext(const CContext & context); // Not implemented yet. |
---|
73 | CContext(const CContext * const context); // Not implemented yet. |
---|
74 | |
---|
75 | /// Destructeur /// |
---|
76 | virtual ~CContext(void); |
---|
77 | |
---|
78 | //--------------------------------------------------------- |
---|
79 | |
---|
80 | public : |
---|
81 | |
---|
82 | /// Mutateurs /// |
---|
83 | void setCalendar(boost::shared_ptr<CCalendar> newCalendar); |
---|
84 | |
---|
85 | /// Accesseurs /// |
---|
86 | boost::shared_ptr<CCalendar> getCalendar(void) const; |
---|
87 | |
---|
88 | public : |
---|
89 | // Initialize server or client |
---|
90 | void initServer(ep_lib::MPI_Comm intraComm, ep_lib::MPI_Comm interComm, CContext* cxtClient = 0); |
---|
91 | void initClient(ep_lib::MPI_Comm intraComm, ep_lib::MPI_Comm interComm, CContext* cxtServer = 0); |
---|
92 | bool isInitialized(void); |
---|
93 | |
---|
94 | // Put sever or client into loop state |
---|
95 | bool eventLoop(void); |
---|
96 | |
---|
97 | bool checkBuffersAndListen(void); |
---|
98 | |
---|
99 | // Finalize a context |
---|
100 | void finalize(void); |
---|
101 | void closeDefinition(void); |
---|
102 | |
---|
103 | // Some functions to process context |
---|
104 | void findAllEnabledFields(void); |
---|
105 | void findAllEnabledFieldsInReadModeFiles(void); |
---|
106 | void readAttributesOfEnabledFieldsInReadModeFiles(); |
---|
107 | void solveAllInheritance(bool apply=true); |
---|
108 | void findEnabledFiles(void); |
---|
109 | void findEnabledReadModeFiles(void); |
---|
110 | void closeAllFile(void); |
---|
111 | void updateCalendar(int step); |
---|
112 | void createFileHeader(void ); |
---|
113 | void checkAxisDomainsGridsEligibilityForCompressedOutput(); |
---|
114 | void prepareTimeseries(void); |
---|
115 | void solveOnlyRefOfEnabledFields(bool sendToServer); |
---|
116 | void solveAllRefOfEnabledFields(bool sendToServer); |
---|
117 | void buildFilterGraphOfEnabledFields(); |
---|
118 | void startPrefetchingOfEnabledReadModeFiles(); |
---|
119 | void checkPrefetchingOfEnabledReadModeFiles(); |
---|
120 | void findFieldsWithReadAccess(void); |
---|
121 | void solveAllRefOfFieldsWithReadAccess(); |
---|
122 | void buildFilterGraphOfFieldsWithReadAccess(); |
---|
123 | void postProcessing(); |
---|
124 | |
---|
125 | std::map<int, StdSize> getAttributesBufferSize(std::map<int, StdSize>& maxEventSize); |
---|
126 | std::map<int, StdSize> getDataBufferSize(std::map<int, StdSize>& maxEventSize); |
---|
127 | void setClientServerBuffer(); |
---|
128 | |
---|
129 | // Send context close definition |
---|
130 | void sendCloseDefinition(void); |
---|
131 | // There are something to send on closing context defintion |
---|
132 | void sendUpdateCalendar(int step); |
---|
133 | void sendCreateFileHeader(void); |
---|
134 | void sendEnabledFiles(); |
---|
135 | void sendEnabledFields(); |
---|
136 | void sendRefDomainsAxis(); |
---|
137 | void sendRefGrid(); |
---|
138 | void sendPostProcessing(); |
---|
139 | void sendRegistry(void) ; //!< after be gathered to the root process of the context, merged registry is sent to the root process of the servers |
---|
140 | const StdString& getIdServer(); |
---|
141 | |
---|
142 | // Client side: Receive and process messages |
---|
143 | static void recvUpdateCalendar(CEventServer& event); |
---|
144 | void recvUpdateCalendar(CBufferIn& buffer); |
---|
145 | static void recvCloseDefinition(CEventServer& event); |
---|
146 | static void recvCreateFileHeader(CEventServer& event); |
---|
147 | void recvCreateFileHeader(CBufferIn& buffer); |
---|
148 | static void recvSolveInheritanceContext(CEventServer& event); |
---|
149 | void recvSolveInheritanceContext(CBufferIn& buffer); |
---|
150 | static void recvPostProcessing(CEventServer& event); |
---|
151 | void recvPostProcessing(CBufferIn& buffer); |
---|
152 | static void recvRegistry(CEventServer& event) ; |
---|
153 | void recvRegistry(CBufferIn& buffer) ; //!< registry is received by the root process of the servers |
---|
154 | |
---|
155 | // dispatch event |
---|
156 | static bool dispatchEvent(CEventServer& event); |
---|
157 | |
---|
158 | public: |
---|
159 | // Get current context |
---|
160 | static CContext* getCurrent(void); |
---|
161 | |
---|
162 | // Get context root |
---|
163 | static CContextGroup* getRoot(void); |
---|
164 | |
---|
165 | // Set current context |
---|
166 | static void setCurrent(const string& id); |
---|
167 | |
---|
168 | // Create new context |
---|
169 | static CContext* create(const string& id = ""); |
---|
170 | |
---|
171 | /// Accesseurs statiques /// |
---|
172 | static StdString GetName(void); |
---|
173 | static StdString GetDefName(void); |
---|
174 | static ENodeType GetType(void); |
---|
175 | |
---|
176 | static CContextGroup* GetContextGroup(void); |
---|
177 | |
---|
178 | // Some functions to visualize structure of current context |
---|
179 | static void ShowTree(StdOStream & out = std::clog); |
---|
180 | static void CleanTree(void); |
---|
181 | |
---|
182 | public : |
---|
183 | // Parse xml node and write all info into context |
---|
184 | virtual void parse(xml::CXMLNode & node); |
---|
185 | |
---|
186 | // Visualize a context |
---|
187 | virtual StdString toString(void) const; |
---|
188 | |
---|
189 | |
---|
190 | // Solve all inheritance relation in current context |
---|
191 | virtual void solveDescInheritance(bool apply, const CAttributeMap * const parent = 0); |
---|
192 | |
---|
193 | // Verify if all root definition in a context have children |
---|
194 | virtual bool hasChild(void) const; |
---|
195 | |
---|
196 | public : |
---|
197 | // Calendar of context |
---|
198 | boost::shared_ptr<CCalendar> calendar; |
---|
199 | |
---|
200 | // List of all enabled files (files on which fields are written or read) |
---|
201 | std::vector<CFile*> enabledFiles; |
---|
202 | // List of all enabled files in read mode (files on which fields are read) |
---|
203 | std::vector<CFile*> enabledReadModeFiles; |
---|
204 | |
---|
205 | // List of all enabled fields whose instant data is accessible from the public API |
---|
206 | // but which are not part of a file |
---|
207 | std::vector<CField*> fieldsWithReadAccess; |
---|
208 | |
---|
209 | // Context root |
---|
210 | static shared_ptr<CContextGroup> root; |
---|
211 | // #pragma omp threadprivate(root) |
---|
212 | |
---|
213 | // Determine context on client or not |
---|
214 | bool hasClient; |
---|
215 | |
---|
216 | // Determine context on server or not |
---|
217 | bool hasServer; |
---|
218 | |
---|
219 | // Concrete context server |
---|
220 | CContextServer* server; |
---|
221 | |
---|
222 | // Concrete contex client |
---|
223 | CContextClient* client; |
---|
224 | |
---|
225 | |
---|
226 | CRegistry* registryIn ; //!< input registry which is read from file |
---|
227 | CRegistry* registryOut ; //!< output registry which will be wrote on file at the finalize |
---|
228 | |
---|
229 | |
---|
230 | private: |
---|
231 | bool isPostProcessed; |
---|
232 | bool finalized; |
---|
233 | StdString idServer_; |
---|
234 | CGarbageCollector garbageCollector; |
---|
235 | std::list<ep_lib::MPI_Comm> comms; //!< Communicators allocated internally |
---|
236 | |
---|
237 | int identifier; |
---|
238 | |
---|
239 | public: // Some function maybe removed in the near future |
---|
240 | int get_identifier(); |
---|
241 | // virtual void toBinary (StdOStream & os) const; |
---|
242 | // virtual void fromBinary(StdIStream & is); |
---|
243 | }; // class CContext |
---|
244 | |
---|
245 | ///-------------------------------------------------------------- |
---|
246 | |
---|
247 | // Declare/Define CContextGroup and CContextDefinition |
---|
248 | DECLARE_GROUP(CContext); |
---|
249 | |
---|
250 | ///-------------------------------------------------------------- |
---|
251 | |
---|
252 | } // namespace xios |
---|
253 | |
---|
254 | #endif // __XIOS_CContext__ |
---|