Line data Source code
1 :
2 : /* Copyright (c) 2005-2015, Stefan Eilemann <eile@equalizergraphics.com>
3 : * Cedric Stalder <cedric Stalder@gmail.com>
4 : * Daniel Nachbaur <danielnachbaur@gmail.com>
5 : *
6 : * This library is free software; you can redistribute it and/or modify it under
7 : * the terms of the GNU Lesser General Public License version 2.1 as published
8 : * by the Free Software Foundation.
9 : *
10 : * This library is distributed in the hope that it will be useful, but WITHOUT
11 : * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 : * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
13 : * details.
14 : *
15 : * You should have received a copy of the GNU Lesser General Public License
16 : * along with this library; if not, write to the Free Software Foundation, Inc.,
17 : * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 : */
19 :
20 : #ifndef EQFABRIC_CONFIG_H
21 : #define EQFABRIC_CONFIG_H
22 :
23 : #include <eq/fabric/api.h>
24 : #include <eq/fabric/types.h> // typedefs
25 : #include <eq/fabric/object.h> // DIRTY_CUSTOM enum
26 :
27 : namespace eq
28 : {
29 : namespace fabric
30 : {
31 : /** Base data class for a configuration. @sa eq::Config */
32 : template< class S, class C, class O, class L, class CV, class N, class V >
33 : // cppcheck-suppress noConstructor
34 : class Config : public Object
35 : {
36 : public:
37 : typedef std::vector< O* > Observers; //!< A vector of observers
38 : typedef std::vector< L* > Layouts; //!< A vector of layouts
39 : typedef std::vector< CV* > Canvases; //!< A vector of canvases
40 : typedef std::vector< N* > Nodes; //!< A vector of nodes
41 :
42 : /** @name Data Access */
43 : //@{
44 : /** @return the local server proxy. @version 1.0 */
45 : EQFABRIC_INL lunchbox::RefPtr< S > getServer();
46 :
47 : /** @return the local server proxy. @version 1.0 */
48 : EQFABRIC_INL lunchbox::RefPtr< const S > getServer() const;
49 :
50 : /** @return the vector of observers, app-node only. @version 1.0 */
51 5769 : const Observers& getObservers() const { return _observers; }
52 :
53 : /** @return the vector of layouts, app-node only. @version 1.0 */
54 5715 : const Layouts& getLayouts() const { return _layouts; }
55 :
56 : /** @return the vector of canvases, app-node only. @version 1.0 */
57 5511 : const Canvases& getCanvases() const { return _canvases; }
58 :
59 : /**
60 : * @internal
61 : * @return the timeout in ms or LB_TIMEOUT_INDEFINITE for failures.
62 : */
63 : EQFABRIC_INL uint32_t getTimeout() const;
64 :
65 : /**
66 : * @return the vector of nodes instantiated in this process.
67 : * @version 1.0
68 : */
69 11389 : const Nodes& getNodes() const { return _nodes; }
70 :
71 : EQFABRIC_INL N* findAppNode(); //!< @internal
72 : EQFABRIC_INL const N* findAppNode() const; //!< @internal
73 :
74 : /**
75 : * Perform a depth-first traversal of this config.
76 : *
77 : * @param visitor the visitor.
78 : * @return the result of the visitor traversal.
79 : * @version 1.0
80 : */
81 : EQFABRIC_INL VisitorResult accept( V& visitor );
82 :
83 : /** Const-version of accept(). @version 1.0 */
84 : EQFABRIC_INL VisitorResult accept( V& visitor ) const;
85 :
86 : /** @return the entity of the given identifier, or 0. @version 1.0 */
87 : template< typename T > EQFABRIC_INL T* find( const uint128_t& id );
88 :
89 : /** @return the entity of the given identifier, or 0. @version 1.0 */
90 : template< typename T >
91 : EQFABRIC_INL const T* find( const uint128_t& id ) const;
92 :
93 : /** @return the first entity of the given name, or 0. @version 1.0 */
94 : template< typename T >
95 : EQFABRIC_INL T* find( const std::string& name );
96 :
97 : /** @return the first entity of the given name, or 0. @version 1.0 */
98 : template< typename T >
99 : EQFABRIC_INL const T* find( const std::string& name ) const;
100 :
101 : /** @internal @return the observer at the given path. */
102 : O* getObserver( const ObserverPath& path );
103 :
104 : /** @internal @return the layout at the given path. */
105 : L* getLayout( const LayoutPath& path );
106 :
107 : /** @internal @return the canvas at the given path. */
108 : CV* getCanvas( const CanvasPath& path );
109 :
110 : /** @internal */
111 : template< typename T > void find( const uint128_t& id, T** result );
112 :
113 : /** @internal */
114 : template< typename T > void find( const std::string& name,
115 : const T** result ) const;
116 :
117 : /** @internal Update or init the given canvas in a running config. */
118 2 : virtual void updateCanvas( CV* ) { /* NOP */ }
119 :
120 : /** @internal Init the given canvas in a running config. */
121 0 : virtual void exitCanvas( CV* ) { /* NOP */ }
122 : //@}
123 :
124 : /** @name Attributes */
125 : //@{
126 : // Note: also update string array initialization in config.ipp
127 :
128 : /** Floating-point attributes */
129 : enum FAttribute
130 : {
131 : FATTR_EYE_BASE, //!< The default interocular distance in meters
132 : FATTR_VERSION, //!< The version of the file loaded
133 : FATTR_LAST,
134 : FATTR_ALL = FATTR_LAST + 5
135 : };
136 :
137 : /** Integer attributes. */
138 : enum IAttribute
139 : {
140 : IATTR_ROBUSTNESS, //!< Tolerate resource failures
141 : IATTR_LAST,
142 : IATTR_ALL = IATTR_LAST + 5
143 : };
144 :
145 : /** @internal */
146 3382 : void setFAttribute( const FAttribute attr, const float value )
147 3382 : { _fAttributes[attr] = value; }
148 : /** @internal */
149 2768 : void setIAttribute( const IAttribute attr, const int32_t value )
150 2768 : { _iAttributes[attr] = value; }
151 :
152 : /** @return the given floating-point attribute. */
153 1078 : float getFAttribute( const FAttribute attr ) const
154 1078 : { return _fAttributes[attr]; }
155 :
156 : /** @return the given integer attribute. */
157 216 : int32_t getIAttribute( const IAttribute attr ) const
158 216 : { return _iAttributes[attr]; }
159 :
160 : /** @internal */
161 : static const std::string& getFAttributeString( const FAttribute attr );
162 : /** @internal */
163 : static const std::string& getIAttributeString( const IAttribute attr );
164 : //@}
165 :
166 :
167 : /** @name Operations */
168 : //@{
169 : /**
170 : * Set the maximum accepted latency for this config.
171 : *
172 : * The latency is defined as the maximum number of frames between the
173 : * start of a frame and the finish of the last rendering task for that
174 : * frame. Setting the latency of a running config finishes all pending
175 : * frames.
176 : *
177 : * @param latency the latency.
178 : * @version 1.0
179 : */
180 : virtual void setLatency( const uint32_t latency );
181 :
182 : /** @return the latency of this config. @version 1.0 */
183 261 : uint32_t getLatency() const { return _data.latency; }
184 :
185 : /** @internal Restore the last backup. */
186 : EQFABRIC_INL virtual void restore();
187 : //@}
188 :
189 0 : virtual void output( std::ostream& ) const {} //!< @internal
190 : void create( O** observer ); //!< @internal
191 : void release( O* observer ); //!< @internal
192 : void create( L** layout ); //!< @internal
193 : void release( L* layout ); //!< @internal
194 : void create( CV** canvas ); //!< @internal
195 : void release( CV* canvas ); //!< @internal
196 : void create( N** node ); //!< @internal
197 : void release( N* node ); //!< @internal
198 :
199 : protected:
200 : /** @internal Construct a new config. */
201 : EQFABRIC_INL explicit Config( lunchbox::RefPtr< S > parent );
202 :
203 : /** @internal Destruct a config. */
204 : EQFABRIC_INL virtual ~Config();
205 :
206 : /** @internal */
207 : EQFABRIC_INL virtual void attach( const uint128_t& id,
208 : const uint32_t instanceID );
209 :
210 : /** @internal */
211 : EQFABRIC_INL virtual void serialize( co::DataOStream& os,
212 : const uint64_t dirtyBits );
213 : EQFABRIC_INL virtual void deserialize( co::DataIStream& is,
214 : const uint64_t dirtyBits );
215 : EQFABRIC_INL virtual void notifyDetach();
216 :
217 : /** @internal Execute the slave remove request. */
218 0 : virtual void _removeChild( const uint128_t& )
219 0 : { LBUNIMPLEMENTED; }
220 :
221 : template< class, class, class, class, class, class >
222 : friend class Server;
223 :
224 : void setAppNodeID( const co::NodeID& nodeID ); //!< @internal
225 : /** @internal */
226 16 : const co::NodeID& getAppNodeID() const { return _appNodeID; }
227 :
228 : /** @internal */
229 : EQFABRIC_INL EventOCommand sendError( co::NodePtr node,
230 : const uint32_t event,
231 : const Error& error );
232 :
233 0 : virtual void changeLatency( const uint32_t ) { /* NOP */ }//!< @internal
234 0 : virtual bool mapViewObjects() const { return false; } //!< @internal
235 7 : virtual bool mapNodeObjects() const { return false; } //!< @internal
236 :
237 : /** @internal */
238 765 : virtual VisitorResult _acceptCompounds( V& )
239 765 : { return TRAVERSE_CONTINUE; }
240 : /** @internal */
241 0 : virtual VisitorResult _acceptCompounds( V& ) const
242 0 : { return TRAVERSE_CONTINUE; }
243 : template< class C2, class V2 >
244 : friend VisitorResult _acceptImpl( C2*, V2& );
245 :
246 : N* _findNode( const uint128_t& id ); //!< @internal
247 :
248 : /** @internal */
249 : EQFABRIC_INL virtual uint128_t commit( const uint32_t incarnation =
250 : CO_COMMIT_NEXT );
251 : //@}
252 :
253 : private:
254 : /** The parent server. */
255 : lunchbox::RefPtr< S > _server;
256 :
257 : /** Float attributes. */
258 : float _fAttributes[FATTR_ALL];
259 :
260 : /** Integer attributes. */
261 : int32_t _iAttributes[IATTR_ALL];
262 :
263 : /** The list of observers. */
264 : Observers _observers;
265 :
266 : /** The list of layouts. */
267 : Layouts _layouts;
268 :
269 : /** The list of canvases. */
270 : Canvases _canvases;
271 :
272 : /** The list of nodes. */
273 : Nodes _nodes;
274 :
275 : /** The node identifier of the node running the application thread. */
276 : co::NodeID _appNodeID;
277 :
278 : struct BackupData
279 : {
280 876 : BackupData() : latency( 1 ) {}
281 :
282 : /** The latency between frame start and end frame, in frames. */
283 : uint32_t latency;
284 : }
285 : _data, _backup;
286 :
287 : struct Private;
288 : Private* _private; // placeholder for binary-compatible changes
289 :
290 : enum DirtyBits
291 : {
292 : DIRTY_MEMBER = Object::DIRTY_CUSTOM << 0,
293 : DIRTY_LATENCY = Object::DIRTY_CUSTOM << 1,
294 : DIRTY_ATTRIBUTES = Object::DIRTY_CUSTOM << 2,
295 : DIRTY_NODES = Object::DIRTY_CUSTOM << 3,
296 : DIRTY_OBSERVERS = Object::DIRTY_CUSTOM << 4,
297 : DIRTY_LAYOUTS = Object::DIRTY_CUSTOM << 5,
298 : DIRTY_CANVASES = Object::DIRTY_CUSTOM << 6,
299 : DIRTY_CONFIG_BITS =
300 : DIRTY_MEMBER | DIRTY_ATTRIBUTES | DIRTY_OBSERVERS |
301 : DIRTY_LAYOUTS | DIRTY_CANVASES | DIRTY_NODES | DIRTY_LATENCY
302 : };
303 :
304 : /** @internal @return the bits to be re-committed by the master. */
305 0 : virtual uint64_t getRedistributableBits() const
306 0 : { return DIRTY_CONFIG_BITS; }
307 :
308 : template< class, class > friend class Observer;
309 : void _addObserver( O* observer );
310 : bool _removeObserver( O* observer );
311 :
312 : template< class, class, class > friend class Layout;
313 : void _addLayout( L* layout );
314 : bool _removeLayout( L* layout );
315 :
316 : template< class, class, class, class > friend class Canvas;
317 : void _addCanvas( CV* canvas );
318 : bool _removeCanvas( CV* canvas );
319 :
320 : template< class, class, class, class > friend class Node;
321 : void _addNode( N* node );
322 : EQFABRIC_INL bool _removeNode( N* node );
323 :
324 : typedef co::CommandFunc< Config< S, C, O, L, CV, N, V > > CmdFunc;
325 : bool _cmdNewLayout( co::ICommand& command );
326 : bool _cmdNewCanvas( co::ICommand& command );
327 : bool _cmdNewObserver( co::ICommand& command );
328 : bool _cmdNewEntityReply( co::ICommand& command );
329 : };
330 :
331 : template< class S, class C, class O, class L, class CV, class N, class V >
332 : EQFABRIC_INL std::ostream& operator << ( std::ostream& os,
333 : const Config< S, C, O, L, CV, N, V >& config );
334 : }
335 : }
336 : #endif // EQFABRIC_CONFIG_H
|
