XrdClSIDManager.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_SID_MANAGER_HH__
#define __XRD_CL_SID_MANAGER_HH__
 
#include <list>
#include <set>
#include <memory>
#include <unordered_map>
#include <string>
#include <cstdint>
#include "XrdSys/XrdSysPthread.hh"
#include "XrdCl/XrdClStatus.hh"
#include "XrdCl/XrdClURL.hh"
 
namespace XrdCl
{
  //----------------------------------------------------------------------------
  // We need the forward declaration for the friendship to work properly
  //----------------------------------------------------------------------------
  class SIDMgrPool;
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class SIDManager
  {
    friend class SIDMgrPool;
 
    private:
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      SIDManager(): pSIDCeiling(1), pRefCount(0) { }
 
#if __cplusplus < 201103L
    //------------------------------------------------------------------------
    // For older complilers we have to make the destructor public, although
    // the shared_pointer is using a custom deleter. It will go away once
    // we drop SLC6 support.
    //------------------------------------------------------------------------
    public:
#endif
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      ~SIDManager() { }
 
    public:
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status AllocateSID( uint8_t sid[2] );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ReleaseSID( uint8_t sid[2] );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void TimeOutSID( uint8_t sid[2] );
 
      //----------------------------------------------------------------------------
      //----------------------------------------------------------------------------
      bool IsAnySIDOldAs( const time_t tlim ) const;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool IsTimedOut( uint8_t sid[2] );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ReleaseTimedOut( uint8_t sid[2] );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ReleaseAllTimedOut();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      uint32_t NumberOfTimedOutSIDs() const
      {
        XrdSysMutexHelper scopedLock( pMutex );
        return pTimeOutSIDs.size();
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      uint16_t GetNumberOfAllocatedSIDs() const;
 
    private:
      std::unordered_map<uint16_t, time_t> pAllocTime;
      std::list<uint16_t>  pFreeSIDs;
      std::set<uint16_t>   pTimeOutSIDs;
      uint16_t             pSIDCeiling;
      mutable XrdSysMutex  pMutex;
      mutable size_t       pRefCount;
  };
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class SIDMgrPool
  {
    public:
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static SIDMgrPool& Instance()
      {
        //----------------------------------------------------------------------
        // We could also use a nifty counter but this is simpler and will do!
        //----------------------------------------------------------------------
        static SIDMgrPool *instance = new SIDMgrPool();
        return *instance;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      ~SIDMgrPool() { }
 
      //------------------------------------------------------------------------
      //               a custom deleter that will return the object to the pool
      //------------------------------------------------------------------------
      std::shared_ptr<SIDManager> GetSIDMgr( const URL &url );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Recycle( SIDManager *mgr );
 
    private:
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      struct RecycleSidMgr
      {
        inline void operator()( SIDManager *mgr )
        {
          SIDMgrPool &pool = SIDMgrPool::Instance();
          pool.Recycle( mgr );
        }
      };
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      SIDMgrPool() { }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      SIDMgrPool( const SIDMgrPool& ) = delete;
      SIDMgrPool( SIDMgrPool&& ) = delete;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      SIDMgrPool& operator=( const SIDMgrPool& ) = delete;
      SIDMgrPool& operator=( SIDMgrPool&& ) = delete;
 
      XrdSysMutex                                  mtx;
      std::unordered_map<std::string, SIDManager*> pool;
  };
}
 
#endif // __XRD_CL_SID_MANAGER_HH__