SoCpuBufferObjectCache.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
#ifndef _SO_BUFFER_OBJECT_CACHE_H_
#define _SO_BUFFER_OBJECT_CACHE_H_
 
#include <Inventor/SbBase.h>
#include <Inventor/STL/map>
#include <Inventor/STL/list>
 
class SoBufferObject;
class SoCpuBufferObject;
class SbThreadSpinlock;
 
#ifdef _WIN32
#pragma warning( push )
#pragma warning(disable:4251)
#endif
 
{
 public:
   
  virtual void flush();
 
  virtual void resize( const size_t newSize );
 
  virtual size_t getSize( );
 
 private:
  SoCpuBufferObjectCache();
 
  virtual ~SoCpuBufferObjectCache();
  
  virtual SoCpuBufferObject* getBufferRef( const uint64_t bufferId );
 
  virtual uint64_t addInCache( SoCpuBufferObject* bufferObject );
 
  virtual bool releaseBufferRef ( const uint64_t bufferId );
 
  SoCpuBufferObject* getBuffer(const uint64_t bufferId);
 
  // internal perf counters access
  void getInternalCounter(  uint64_t &nbCacheAccess, uint64_t& nbCacheDefault);
  void resetInternalCounter( );
 
  // Force a delete from cache (mainly used as a double checked in SoCpuBufferCache destructor
  // costly because we have to search for the bufferId first.
  virtual bool deleteFromCache( const uint64_t bufferId );
 
  // Retrieve bufferId from its signature. 
  uint64_t getMappingIdfromSig(const uint64_t& cacheSig);
 
private:
 
  // implementation of getBuffer for getBuffer and getBufferRef
  // notes it is upd to the caller to lock the cacheList mutex
  SoCpuBufferObject* getBufferInternal(const uint64_t bufferId);
 
  // internal cache management
  typedef std::map<uint64_t, SoCpuBufferObject*> cacheListType;
  typedef std::map<uint64_t, uint64_t> bufferSignatureMap;
  typedef std::list<uint64_t> lruBufferIdsType;
 
  cacheListType m_cacheList;
  bufferSignatureMap m_bufferIdToSigMap;
  bufferSignatureMap m_bufferSigToIdMap;
  // List of sorted ids. The last one is the last used one.
  lruBufferIdsType lruBufferIds;
 
  // Max size of the cache
  size_t m_maxCacheSize;
 
  // Uniq Id management
  uint64_t getUniqueId();
  uint64_t m_lasUniqId;
 
  // Remove the least recently used buffer.
  void makeRoomInCache();
  
  // Spinlock used to protect cache access
  SbThreadSpinlock *m_cacheListLock;
 
  // perf counter manager
  uint64_t m_perfNbCacheAccess ;
  uint64_t m_perfNbCacheDefault;
};
 
#ifdef WIN32
#pragma warning( pop )
#endif
 
#endif //_SO_BUFFER_OBJECT_CACHE_H_