include/eq/client/node.h

/* Copyright (c) 2005-2012, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2010, Cedric Stalder<cedric.stalder@gmail.com>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation .
 *  
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQ_NODE_H
#define EQ_NODE_H

#include <eq/client/api.h>
#include <eq/client/types.h>
#include <eq/client/visitorResult.h>  // enum
#include <eq/fabric/node.h>           // base class

#include <co/commandQueue.h>
#include <co/types.h>
#include <lunchbox/monitor.h>          // member
#include <lunchbox/mtQueue.h>          // member

namespace eq
{
    class Node : public fabric::Node< Config, Node, Pipe, NodeVisitor >
    {
    public:
        EQ_API Node( Config* parent );

        EQ_API virtual ~Node();

        EQ_API ClientPtr getClient();

        EQ_API ServerPtr getServer();

        EQ_API co::CommandQueue* getMainThreadQueue(); 
        EQ_API co::CommandQueue* getCommandThreadQueue(); 

        uint32_t getCurrentFrame() const { return _currentFrame.get(); }

        co::Barrier* getBarrier( const co::ObjectVersion barrier );

        FrameDataPtr getFrameData( const co::ObjectVersion& frameDataVersion );

        void releaseFrameData( FrameDataPtr data );

        EQ_API void waitInitialized() const;

        EQ_API bool isRunning() const;

        EQ_API bool isStopped() const;
        
        EQ_API void waitFrameStarted( const uint32_t frameNumber ) const;

        uint32_t getFinishedFrame() const { return _finishedFrame; }

        class TransmitThread : public lunchbox::Thread
        {
        public:
            TransmitThread( Node* parent ) : _node( parent ) {}
            virtual ~TransmitThread() {}

            co::CommandQueue& getQueue() { return _queue; }
            
        protected:
            virtual void run();

        private:
            co::CommandQueue     _queue;
            Node* const           _node;
        } transmitter;

        EQ_API virtual void setDirty( const uint64_t bits );

        EQ_API void dirtyClientExit();

    protected:
        EQ_API virtual void attach( const UUID& id, const uint32_t instanceID );

        EQ_API void startFrame( const uint32_t frameNumber );

        EQ_API void releaseFrame( const uint32_t frameNumber );

        EQ_API void releaseFrameLocal( const uint32_t frameNumber );


        EQ_API virtual bool configInit( const uint128_t&  initID );

        EQ_API virtual bool configExit();

        EQ_API virtual void frameStart( const uint128_t& frameID, 
                                        const uint32_t frameNumber );

        EQ_API virtual void frameFinish( const uint128_t& frameID, 
                                         const uint32_t frameNumber );

        EQ_API virtual void frameDrawFinish( const uint128_t& frameID, 
                                             const uint32_t frameNumber );

        EQ_API virtual void frameTasksFinish( const uint128_t& frameID, 
                                              const uint32_t frameNumber );

    private:
        enum State
        {
            STATE_STOPPED,
            STATE_INITIALIZING,
            STATE_INIT_FAILED,
            STATE_RUNNING,
            STATE_FAILED
        };
        lunchbox::Monitor< State > _state;

        lunchbox::Monitor< uint32_t > _currentFrame;

        uint32_t _finishedFrame;

        uint32_t _unlockedFrame;

        typedef stde::hash_map< uint128_t, co::Barrier* > BarrierHash;
        lunchbox::Lockable< BarrierHash > _barriers;

        typedef stde::hash_map< uint128_t, FrameDataPtr > FrameDataHash;
        typedef FrameDataHash::const_iterator FrameDataHashCIter;
        typedef FrameDataHash::iterator FrameDataHashIter;
        lunchbox::Lockable< FrameDataHash > _frameDatas;

        struct Private;
        Private* _private; // placeholder for binary-compatible changes

        void _setAffinity();

        void _finishFrame( const uint32_t frameNumber ) const;
        void _frameFinish( const uint128_t& frameID,
                           const uint32_t frameNumber );

        void _flushObjects();

        bool _cmdCreatePipe( co::Command& command );
        bool _cmdDestroyPipe( co::Command& command );
        bool _cmdConfigInit( co::Command& command );
        bool _cmdConfigExit( co::Command& command );
        bool _cmdFrameStart( co::Command& command );
        bool _cmdFrameFinish( co::Command& command );
        bool _cmdFrameDrawFinish( co::Command& command );
        bool _cmdFrameTasksFinish( co::Command& command );
        bool _cmdFrameDataTransmit( co::Command& command );
        bool _cmdFrameDataReady( co::Command& command );
        bool _cmdSetAffinity( co::Command& command );

        LB_TS_VAR( _nodeThread );
        LB_TS_VAR( _commandThread );
    };
}

#endif // EQ_NODE_H