pageCache.h

Go to the documentation of this file.

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_EXEC_EF_PAGE_CACHE_H
#define PXR_EXEC_EF_PAGE_CACHE_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/exec/ef/api.h"
#include "pxr/exec/ef/outputValueCache.h"
#include "pxr/exec/ef/vectorKey.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class Ef_PageCache
{
public:
    EF_API
    ~Ef_PageCache();
 
    template < typename T >
    static Ef_PageCache *New() {
        return new Ef_PageCache(&_KeyFactory<T>);
    }
 
    EF_API
    Ef_OutputValueCache *Get(const VdfVector &key) const;
 
    EF_API
    Ef_OutputValueCache *GetOrCreate(const VdfVector &key);
 
    EF_API
    size_t Clear();
 
    typedef
        Ef_VectorKey::Map<Ef_OutputValueCache *>::Type
        CacheMap;
 
    typedef
        typename CacheMap::iterator 
        iterator;
 
    iterator begin() {
        return _cache.begin();
    }
 
    iterator end() {
        return _cache.end();
    }
 
private:
    // The type of the factory function, which is responsible for creating a
    // Ef_VectorKey from a given VdfVector.
    using _KeyFactoryFunction =
        Ef_VectorKey::StoredType (*) (const VdfVector &);
 
    // Constructor.
    EF_API
    Ef_PageCache(_KeyFactoryFunction keyFactory);
 
    // A factory functor, which creates an Ef_VectorKey (for use as a key in
    // a hash map) from a VdfVector holding data of type T. 
    template < typename T >
    static Ef_VectorKey::StoredType _KeyFactory(const VdfVector &value) {
        return Ef_VectorKey::StoredType(new Ef_TypedVectorKey<T>(value));
    }
 
private:
    // The map of pages to output-to-value caches.
    CacheMap _cache;
 
    // The key factory function for building new Ef_VectorKeys.
    _KeyFactoryFunction _keyFactory;
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif