Allocator.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
// ============================================================================
// ============================================================================

//
// ********************************************************************
// * DISCLAIMER                                                       *
// *                                                                  *
// * The following disclaimer summarizes all the specific disclaimers *
// * of contributors to this software. The specific disclaimers,which *
// * govern, are listed with their locations in:                      *
// *   http://cern.ch/geant4/license                                  *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.                                                             *
// *                                                                  *
// * This  code  implementation is the  intellectual property  of the *
// * GEANT4 collaboration.                                            *
// * By copying,  distributing  or modifying the Program (or any work *
// * based  on  the Program)  you indicate  your  acceptance of  this *
// * statement, and all its terms.                                    *
// ********************************************************************
//
//
// ------------------------------------------------------------
// GEANT 4 class header file
//
// Class Description:
//
// A class for fast allocation of objects to the heap through a pool of
// chunks organised as linked list. It's meant to be used by associating
// it to the object to be allocated and defining for it new and delete
// operators via MallocSingle() and FreeSingle() methods.

//      ---------------- G4Allocator ----------------
//
// Author: G.Cosmo (CERN), November 2000
// ------------------------------------------------------------

// ============================================================================
#ifndef GAUDIKERNEL_Allocator_h
#define GAUDIKERNEL_Allocator_h 1
// ============================================================================
// Include files
// ============================================================================
// STD & STL
// ============================================================================
#include <cstddef>
// ============================================================================
// GaudiKernel
// ============================================================================
#include "GaudiKernel/AllocatorPool.h"
// ============================================================================

namespace GaudiUtils {
  template <class Type>
  class Allocator {
  public: // with description
    Allocator() throw();
    ~Allocator() throw();

    inline Type* MallocSingle();
    inline void  FreeSingle( Type* anElement );

    inline void ResetStorage();

    inline size_t GetAllocatedSize() const;

  public: // without description
    // This public section includes standard methods and types
    // required if the allocator is to be used as alternative
    // allocator for STL containers.
    // NOTE: the code below is a trivial implementation to make
    //       this class an STL compliant allocator.
    //       It is anyhow NOT recommended to use this class as
    //       alternative allocator for STL containers !

    typedef Type        value_type;
    typedef size_t      size_type;
    typedef ptrdiff_t   difference_type;
    typedef Type*       pointer;
    typedef const Type* const_pointer;
    typedef Type&       reference;
    typedef const Type& const_reference;

    template <class U>
    Allocator( const Allocator<U>& right ) throw() : mem( right.mem ) {}

    pointer       address( reference r ) const { return &r; }
    const_pointer address( const_reference r ) const { return &r; }

    pointer allocate( size_type n, void* /*hint*/ = 0 ) {
      // Allocates space for n elements of type Type, but does not initialise
      //
      Type* mem_alloc = 0;
      if ( n == 1 )
        mem_alloc = MallocSingle();
      else
        mem_alloc = static_cast<Type*>( ::operator new( n * sizeof( Type ) ) );
      return mem_alloc;
    }

    void deallocate( pointer p, size_type n ) {
      // Deallocates n elements of type Type, but doesn't destroy
      //
      if ( n == 1 )
        FreeSingle( p );
      else
        ::operator delete( (void*)p );
      return;
    }

    void construct( pointer p, const Type& val ) { new ( (void*)p ) Type( val ); }
    void destroy( pointer p ) { p->~Type(); }

    size_type max_size() const throw() {
      // Returns the maximum number of elements that can be allocated
      //
      return 2147483647 / sizeof( Type );
    }

    // Rebind allocator to type U
    template <class U>
    struct rebind {
      typedef Allocator<U> other;
    };

  private:
    GaudiUtils::AllocatorPool mem;
    // Pool of elements of sizeof(Type)
  };

} // namespace GaudiUtils

// ------------------------------------------------------------
// Inline implementation
// ------------------------------------------------------------

// Initialization of the static pool
//
// template <class Type> G4AllocatorPool G4Allocator<Type>::mem(sizeof(Type));

// ************************************************************
// G4Allocator constructor
// ************************************************************
//
template <class Type>
GaudiUtils::Allocator<Type>::Allocator() throw() : mem( sizeof( Type ) ) {}

// ************************************************************
// G4Allocator destructor
// ************************************************************
//
template <class Type>
GaudiUtils::Allocator<Type>::~Allocator() throw() {}

// ************************************************************
// MallocSingle
// ************************************************************
//
template <class Type>
Type* GaudiUtils::Allocator<Type>::MallocSingle() {
  return static_cast<Type*>( mem.Alloc() );
}

// ************************************************************
// FreeSingle
// ************************************************************
//
template <class Type>
void GaudiUtils::Allocator<Type>::FreeSingle( Type* anElement ) {
  mem.Free( anElement );
  return;
}

// ************************************************************
// ResetStorage
// ************************************************************
//
template <class Type>
void GaudiUtils::Allocator<Type>::ResetStorage() {
  // Clear all allocated storage and return it to the free store
  //
  mem.Reset();
  return;
}

// ************************************************************
// GetAllocatedSize
// ************************************************************
//
template <class Type>
size_t GaudiUtils::Allocator<Type>::GetAllocatedSize() const {
  return mem.Size();
}

// ************************************************************
// operator==
// ************************************************************
//
template <class T1, class T2>
bool operator==( const GaudiUtils::Allocator<T1>&, const GaudiUtils::Allocator<T2>& ) throw() {
  return true;
}

// ************************************************************
// operator!=
// ************************************************************
//
template <class T1, class T2>
bool operator!=( const GaudiUtils::Allocator<T1>&, const GaudiUtils::Allocator<T2>& ) throw() {
  return false;
}

// ============================================================================
// The END
// ============================================================================
#endif