XrdClStream.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Copyright (c) 2011-2012 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@cern.ch>
//------------------------------------------------------------------------------
// XRootD is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// XRootD 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 General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
//------------------------------------------------------------------------------
 
#ifndef __XRD_CL_STREAM_HH__
#define __XRD_CL_STREAM_HH__
 
#include "XrdCl/XrdClPoller.hh"
#include "XrdCl/XrdClStatus.hh"
#include "XrdCl/XrdClURL.hh"
#include "XrdCl/XrdClPostMasterInterfaces.hh"
#include "XrdCl/XrdClChannelHandlerList.hh"
#include "XrdCl/XrdClJobManager.hh"
#include "XrdCl/XrdClInQueue.hh"
#include "XrdCl/XrdClUtils.hh"
 
#include "XrdSys/XrdSysPthread.hh"
#include "XrdSys/XrdSysRAtomic.hh"
#include "XrdNet/XrdNetAddr.hh"
#include "XrdOuc/XrdOucCompiler.hh"
#include <list>
#include <vector>
#include <functional>
#include <memory>
 
#include <assert.h>
 
namespace XrdCl
{
  class  Message;
  class  Channel;
  class  TransportHandler;
  class  TaskManager;
  struct SubStreamData;
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class StreamMutex
  {
    public:
      StreamMutex(): mcv(0), hasfn(false) { }
      ~StreamMutex()
      {
        assert( mlist.empty() );
        assert( mclosing.empty() );
        assert( mthmap.empty() );
        assert( hasfn == false );
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void AddClosing( uint16_t subStream );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void RemoveClosing( uint16_t subStream );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Lock();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Lock( uint16_t subStream, bool &isclosing );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Lock( const std::function<void()> &func, bool &isclosing );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void UnLock();
 
      struct MtxInfo
      {
        MtxInfo(): cnt( 0 ) { }
        MtxInfo( const std::function<void()> &func ): cnt( 0 ), fn( func ) { }
        ~MtxInfo() { }
 
        size_t cnt;
        std::function<void()> fn;
      };
 
      XrdSysCondVar mcv;
      std::list<MtxInfo> mlist;
      std::map<uint16_t, size_t> mclosing;
      std::map<pthread_t, std::list<MtxInfo>::iterator> mthmap;
      bool hasfn;
      std::list<MtxInfo>::iterator fnlistit;
  };
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class StreamMutexHelper
  {
    public:
      StreamMutexHelper( StreamMutex &sm ): mtx( &sm )
      {
        mtx->Lock();
      }
 
      StreamMutexHelper( StreamMutex &sm, uint16_t idx,
                         bool &isclosing ): mtx( &sm )
      {
        mtx->Lock( idx, isclosing );
        if( isclosing ) mtx = nullptr;
      }
 
      StreamMutexHelper( StreamMutex &sm, const std::function<void()> &func,
                         bool &isclosing ): mtx( &sm )
      {
        mtx->Lock( func, isclosing );
        if( isclosing ) mtx = nullptr;
      }
 
      ~StreamMutexHelper()
      {
        UnLock();
      }
 
      void UnLock()
      {
        if( !mtx ) return;
        mtx->UnLock();
        mtx = nullptr;
      }
 
      StreamMutex *mtx;
  };
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class Stream
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      enum StreamStatus
      {
        Disconnected    = 0,    
        Connected       = 1,    
        Connecting      = 2,    
        Error           = 3     
      };
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Stream( const URL *url, const URL &prefer = URL() );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      ~Stream();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Initialize();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Send( Message     *msg,
                         MsgHandler  *handler,
                         bool         stateful,
                         time_t       expires );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetTransport( TransportHandler *transport )
      {
        pTransport = transport;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetPoller( Poller *poller )
      {
        pPoller = poller;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetIncomingQueue( InQueue *incomingQueue )
      {
        pIncomingQueue = incomingQueue;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetChannel( std::weak_ptr<Channel> &channel )
      {
        pChannel = channel;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetChannelData( AnyObject *channelData )
      {
        pChannelData = channelData;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetTaskManager( TaskManager *taskManager )
      {
        pTaskManager = taskManager;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetJobManager( JobManager *jobManager )
      {
        pJobManager = jobManager;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus EnableLink( PathID &path );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Finalize();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Tick( time_t now );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      const URL *GetURL() const
      {
        return pUrl;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ForceConnect();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      const std::string &GetName() const
      {
        return pStreamName;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void DisableIfEmpty( uint16_t subStream );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void OnIncoming( uint16_t  subStream,
                       std::shared_ptr<Message> msg,
                       uint32_t  bytesReceived );
 
      //------------------------------------------------------------------------
      // Call when one of the sockets is ready to accept a new message
      //------------------------------------------------------------------------
      std::pair<Message *, MsgHandler *>
        OnReadyToWrite( uint16_t subStream );
 
      //------------------------------------------------------------------------
      // Call when a message is written to the socket
      //------------------------------------------------------------------------
      void OnMessageSent( uint16_t  subStream,
                          Message  *msg,
                          uint32_t  bytesSent );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void OnConnect( uint16_t subStream );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void OnConnectError( uint16_t subStream, XRootDStatus status );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void OnError( uint16_t subStream, XRootDStatus status );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ForceError( XRootDStatus status, const bool hush,
                       const uint64_t sess );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool OnReadTimeout( uint16_t subStream ) XRD_WARN_UNUSED_RESULT;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool OnWriteTimeout( uint16_t subStream ) XRD_WARN_UNUSED_RESULT;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void RegisterEventHandler( ChannelEventHandler *handler );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void RemoveEventHandler( ChannelEventHandler *handler );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      MsgHandler*
        InstallIncHandler( std::shared_ptr<Message> &msg, uint16_t stream );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      uint16_t InspectStatusRsp( uint16_t stream, MsgHandler *&incHandler );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetOnDataConnectHandler( std::shared_ptr<Job> &onConnJob )
      {
        StreamMutexHelper scopedLock( pMutex );
        pOnDataConnJob = onConnJob;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool CanCollapse( const URL &url );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status Query( uint16_t   query, AnyObject &result );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      std::shared_ptr<Channel> GetChannel()
      {
        return pChannel.lock();
      }
 
    private:
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static bool IsPartial( Message &msg );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      inline static bool HasNetAddr( const XrdNetAddr              &addr,
                                           std::vector<XrdNetAddr> &addresses )
      {
        auto itr = addresses.begin();
        for( ; itr != addresses.end() ; ++itr )
        {
          if( itr->Same( &addr ) ) return true;
        }
 
        return false;
      }
 
      //------------------------------------------------------------------------
      // Used under error conditions to move handlers from the out & in queue
      // helpers back to main out queue for the subStream or the in queue.
      //------------------------------------------------------------------------
      void Reinsert( uint16_t subStream );
 
      //------------------------------------------------------------------------
      // Job handling the incoming messages
      //------------------------------------------------------------------------
      class HandleIncMsgJob: public Job
      {
        public:
          HandleIncMsgJob( MsgHandler *handler ): pHandler( handler ) {};
          virtual ~HandleIncMsgJob() {};
          virtual void Run( void* )
          {
            pHandler->Process();
            delete this;
          }
        private:
          MsgHandler *pHandler;
      };
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void OnFatalError( uint16_t           subStream,
                         XRootDStatus       status,
                         StreamMutexHelper &lock );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void MonitorDisconnection( XRootDStatus status );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus RequestClose( Message  &resp );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SockHandlerClose( uint16_t subStream );
 
 
      typedef std::vector<SubStreamData*> SubStreamList;
 
      //------------------------------------------------------------------------
      // Data members
      //------------------------------------------------------------------------
      const URL                     *pUrl;
      const URL                      pPrefer;
      std::string                    pStreamName;
      TransportHandler              *pTransport;
      Poller                        *pPoller;
      TaskManager                   *pTaskManager;
      JobManager                    *pJobManager;
      StreamMutex                    pMutex;
      InQueue                       *pIncomingQueue;
      AnyObject                     *pChannelData;
      uint32_t                       pLastStreamError;
      XRootDStatus                   pLastFatalError;
      uint16_t                       pStreamErrorWindow;
      uint16_t                       pConnectionCount;
      uint16_t                       pConnectionRetry;
      time_t                         pConnectionInitTime;
      uint16_t                       pConnectionWindow;
      SubStreamList                  pSubStreams;
      std::vector<XrdNetAddr>        pAddresses;
      Utils::AddressType             pAddressType;
      ChannelHandlerList             pChannelEvHandlers;
      uint64_t                       pSessionId;
 
      //------------------------------------------------------------------------
      // Monitoring info
      //------------------------------------------------------------------------
      timeval                        pConnectionStarted;
      timeval                        pConnectionDone;
      std::atomic<uint64_t>          pBytesSent;
      std::atomic<uint64_t>          pBytesReceived;
 
      //------------------------------------------------------------------------
      // Data stream on-connect handler
      //------------------------------------------------------------------------
      std::shared_ptr<Job>           pOnDataConnJob;
 
      //------------------------------------------------------------------------
      // Track last assigned Id across all Streams, to ensure unique sessionId
      //------------------------------------------------------------------------
      static RAtomic_uint64_t        sSessCntGen;
 
      //------------------------------------------------------------------------
      // Non owning copy of the shared_ptr PostMaster creates for our Channel
      //------------------------------------------------------------------------
      std::weak_ptr<Channel>         pChannel;
  };
}
 
#endif // __XRD_CL_STREAM_HH__