bufferArrayRegistry.h

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_IMAGING_HD_ST_BUFFER_ARRAY_REGISTRY_H
#define PXR_IMAGING_HD_ST_BUFFER_ARRAY_REGISTRY_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hdSt/api.h"
#include "pxr/imaging/hdSt/strategyBase.h"
 
#include "pxr/imaging/hd/bufferArrayRange.h"
#include "pxr/imaging/hd/bufferSpec.h"
#include "pxr/imaging/hd/perfLog.h"
 
#include "pxr/imaging/hf/perfLog.h"
 
#include "pxr/base/vt/dictionary.h"
#include "pxr/base/tf/token.h"
 
#include <tbb/concurrent_unordered_map.h>
 
#include <condition_variable>
#include <memory>
#include <mutex>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
using HdBufferArraySharedPtr = std::shared_ptr<class HdBufferArray>;
 
class HdStBufferArrayRegistry 
{
public:
    HF_MALLOC_TAG_NEW("new HdStBufferArrayRegistry");
 
    HDST_API
    HdStBufferArrayRegistry();
    ~HdStBufferArrayRegistry() = default;
 
    HDST_API
    HdBufferArrayRangeSharedPtr AllocateRange(
        HdStAggregationStrategy *strategy,
        TfToken const &role,
        HdBufferSpecVector const &bufferSpecs,
        HdBufferArrayUsageHint usageHint);
 
    HDST_API
    void   ReallocateAll(HdStAggregationStrategy *strategy);
 
    HDST_API
    void   GarbageCollect();
 
    HDST_API
    size_t GetResourceAllocation(HdStAggregationStrategy *strategy, 
                                 VtDictionary &result) const;
    
    HDST_API
    friend std::ostream &operator <<(std::ostream &out,
                                     const HdStBufferArrayRegistry& self);
 
private:
 
    HdStBufferArrayRegistry(const HdStBufferArrayRegistry &) = delete;
    HdStBufferArrayRegistry &operator=(const HdStBufferArrayRegistry &)=delete;
 
    typedef std::list<HdBufferArraySharedPtr> _HdBufferArraySharedPtrList;
 
    struct _Entry
    {
        _HdBufferArraySharedPtrList bufferArrays;
        std::mutex                  lock;
        std::condition_variable     emptyCondition;
 
        // Default / Copy constructors needed for std::make_pair.
        // as the version of TBB doesn't have emplace() yet.
        _Entry() {}
        _Entry(const _Entry &other) { TF_VERIFY(bufferArrays.empty()); }
    };
 
 
    class _EntryIsNotEmpty
    {
    public:
        _EntryIsNotEmpty(const _Entry &entry) : _entry(entry) {}
 
        bool operator()() {
            return (!(_entry.bufferArrays.empty()));
        }
 
    private:
        const _Entry &_entry;
    };
 
    using _BufferArrayIndex = tbb::concurrent_unordered_map<
                                HdStAggregationStrategy::AggregationId, _Entry>;
    _BufferArrayIndex _entries;
 
    void _InsertNewBufferArray(_Entry &entry,
                               const HdBufferArraySharedPtr &expectedTail,
                               HdStAggregationStrategy *strategy,
                               TfToken const &role,
                               HdBufferSpecVector const &bufferSpecs,
                               HdBufferArrayUsageHint usageHint);
};
    
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_HD_ST_BUFFER_ARRAY_REGISTRY_H