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>
 
namespace XrdCl
{
  class  Message;
  class  Channel;
  class  TransportHandler;
  class  TaskManager;
  struct SubStreamData;
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class Stream
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      enum StreamStatus
      {
        Disconnected    = 0,    
        Connected       = 1,    
        Connecting      = 2,    
        Error           = 3     
      };
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Stream( std::shared_ptr<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 SetChannelData( AnyObject *channelData )
      {
        pChannelData = channelData;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetTaskManager( TaskManager *taskManager )
      {
        pTaskManager = taskManager;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetJobManager( JobManager *jobManager )
      {
        pJobManager = jobManager;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus EnableLink( PathID &path );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Disconnect( bool force = false );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Tick( time_t now );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      const URL *GetURL() const
      {
        return pUrl.get();
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      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, bool hush=false );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      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 )
      {
        XrdSysMutexHelper scopedLock( pMutex );
        pOnDataConnJob = onConnJob;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool CanCollapse( const URL &url );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status Query( uint16_t   query, AnyObject &result );
 
    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;
      }
 
      //------------------------------------------------------------------------
      // Job handling force disconnect
      //------------------------------------------------------------------------
      class ForceDisconnectJob: public Job
      {
        public:
          ForceDisconnectJob( std::shared_ptr<URL> url ) : pUrl( url ) {}
          virtual ~ForceDisconnectJob() {}
          virtual void Run( void* )
          {
            DefaultEnv::GetPostMaster()->ForceDisconnect( *pUrl );
            delete this;
          }
        private:
          std::shared_ptr<URL> pUrl;
      };
 
      //------------------------------------------------------------------------
      // 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,
                         XrdSysMutexHelper &lock );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void MonitorDisconnection( XRootDStatus status );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus RequestClose( Message  &resp );
 
      typedef std::vector<SubStreamData*> SubStreamList;
 
      //------------------------------------------------------------------------
      // Data members
      //------------------------------------------------------------------------
      std::shared_ptr<URL>           pUrl;
      const URL                      pPrefer;
      std::string                    pStreamName;
      TransportHandler              *pTransport;
      Poller                        *pPoller;
      TaskManager                   *pTaskManager;
      JobManager                    *pJobManager;
      XrdSysRecMutex                 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;
      ForceDisconnectJob            *pTTLDiscJob;
      std::atomic<int>               pSubsWaitingClose;
 
      //------------------------------------------------------------------------
      // When disconnecting other sub-streams from within a poller callback
      // we call IOEvents::Channel::Delete, potentially on channels with an
      // active callback in a different thread. The poller will require that
      // callback to finish before Delete returns. However those theads may
      // block waiting on us to complete, either for our poller to be idle or
      // due to one of our mutexes. Detect that situation by noting when all
      // sub-streams are about to be closed. Protected by mutex below. In case
      // bother are needed, lock order should be pDiscMtuex, pMutex.
      //------------------------------------------------------------------------
      XrdSysCondVar                  pDiscCV;
      int                            pDiscAllCnt;
 
      //------------------------------------------------------------------------
      // 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;
  };
}
 
#endif // __XRD_CL_STREAM_HH__