lib/client/node.h

/* Copyright (c) 2005-2009, Stefan Eilemann <eile@equalizergraphics.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/types.h>
#include <eq/client/visitorResult.h>  // enum

#include <eq/net/barrier.h>
#include <eq/net/objectVersion.h>
#include <eq/base/base.h>

namespace eq
{
    class CommandQueue;
    class FrameData;
    class NodeVisitor;

    class Node : public net::Object
    {
    public:
        EQ_EXPORT Node( Config* parent );

        EQ_EXPORT virtual ~Node();

        Config*       getConfig()       { return _config; }
        const Config* getConfig() const { return _config; }

        EQ_EXPORT ClientPtr getClient();
        EQ_EXPORT ServerPtr getServer();

        const PipeVector& getPipes() const { return _pipes; }
        const std::string& getName() const { return _name; }

        uint32_t getTasks() const { return _tasks; }

        EQ_EXPORT CommandQueue* getNodeThreadQueue();

        EQ_EXPORT VisitorResult accept( NodeVisitor& visitor );

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

        FrameData* getFrameData( const net::ObjectVersion& dataVersion );

        EQ_EXPORT void waitInitialized() const;
        EQ_EXPORT bool isRunning() const;
        
        EQ_EXPORT void waitFrameStarted( const uint32_t frameNumber ) const;

        uint32_t getFinishedFrame() const { return _finishedFrame; }

        // Note: also update string array initialization in node.cpp
        enum IAttribute
        {
            IATTR_THREAD_MODEL,           
            IATTR_FILL1,
            IATTR_FILL2,
            IATTR_ALL
        };

        EQ_EXPORT void setIAttribute( const IAttribute attr,
                                      const int32_t value );
        EQ_EXPORT int32_t getIAttribute( const IAttribute attr ) const;
        EQ_EXPORT static const std::string& getIAttributeString(
                                                        const IAttribute attr );

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

            void send( FrameData* data, net::NodePtr node, 
                       const uint32_t frameNumber );
            
        protected:
            virtual void* run();

        private:
            struct Task
            {
                Task( FrameData* d, net::NodePtr n, const uint32_t f ) 
                        : data( d ), node( n ), frameNumber( f ) {}

                FrameData*   data;
                net::NodePtr node;
                uint32_t     frameNumber;
            };

            base::MTQueue< Task > _tasks;
            Node* const           _node;
        };

        TransmitThread transmitter;

    protected:
        friend class Config;

        EQ_EXPORT virtual void attachToSession( const uint32_t id, 
                                                const uint32_t instanceID, 
                                                net::Session* session );

        EQ_EXPORT void startFrame( const uint32_t frameNumber );

        EQ_EXPORT void releaseFrame( const uint32_t frameNumber );

        EQ_EXPORT void releaseFrameLocal( const uint32_t frameNumber );


        EQ_EXPORT virtual bool configInit( const uint32_t initID );

        EQ_EXPORT virtual bool configExit();

        EQ_EXPORT virtual void frameStart( const uint32_t frameID, 
                                           const uint32_t frameNumber );

        virtual void frameFinish( const uint32_t frameID, 
                                  const uint32_t frameNumber ) 
            { releaseFrame( frameNumber ); }

        EQ_EXPORT virtual void frameDrawFinish( const uint32_t frameID, 
                                                const uint32_t frameNumber );

        EQ_EXPORT virtual void frameTasksFinish( const uint32_t frameID, 
                                                 const uint32_t frameNumber );

        EQ_EXPORT void setErrorMessage( const std::string& message );

    private:
        Config* const          _config;

        std::string            _name;

        int32_t _iAttributes[IATTR_ALL];
        static std::string _iAttributeStrings[IATTR_ALL];

        uint32_t _tasks;

        PipeVector             _pipes;

        std::string            _error;

        enum State
        {
            STATE_STOPPED,
            STATE_INITIALIZING,
            STATE_INIT_FAILED,
            STATE_RUNNING
        };
        base::Monitor< State > _state;

        base::Monitor<uint32_t> _currentFrame;

        uint32_t                  _unlockedFrame;

        uint32_t                  _finishedFrame;

        typedef stde::hash_map< uint32_t, net::Barrier* > BarrierHash;
        BarrierHash _barriers;
        base::Lock  _barriersMutex;

        typedef stde::hash_map< uint32_t, FrameData* > FrameDataHash;
        FrameDataHash _frameDatas;
        base::Lock    _frameDatasMutex;

        union // placeholder for binary-compatible changes
        {
            char dummy[64];
        };

        friend class Pipe;
        void _addPipe( Pipe* pipe );
        void _removePipe( Pipe* pipe );
        Pipe* _findPipe( const uint32_t id );

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

        void _flushObjects();

        virtual void getInstanceData( net::DataOStream& os ) { EQDONTCALL }
        virtual void applyInstanceData( net::DataIStream& is ) { EQDONTCALL }

        net::CommandResult _cmdCreatePipe( net::Command& command );
        net::CommandResult _cmdDestroyPipe( net::Command& command );
        net::CommandResult _cmdConfigInit( net::Command& command );
        net::CommandResult _cmdConfigExit( net::Command& command );
        net::CommandResult _cmdFrameStart( net::Command& command );
        net::CommandResult _cmdFrameFinish( net::Command& command );
        net::CommandResult _cmdFrameDrawFinish( net::Command& command );
        net::CommandResult _cmdFrameTasksFinish( net::Command& command );

        CHECK_THREAD_DECLARE( _nodeThread );
    };
}

#endif // EQ_NODE_H