VolumeExecutable.h

Go to the documentation of this file.

// Copyright Contributors to the OpenVDB Project
// SPDX-License-Identifier: MPL-2.0


#ifndef OPENVDB_AX_COMPILER_VOLUME_EXECUTABLE_HAS_BEEN_INCLUDED
#define OPENVDB_AX_COMPILER_VOLUME_EXECUTABLE_HAS_BEEN_INCLUDED

#include "CustomData.h"
#include "AttributeRegistry.h"

#include <openvdb/version.h>
#include <openvdb/Grid.h>

#include <unordered_map>

class TestVolumeExecutable;

namespace llvm {
class ExecutionEngine;
class LLVMContext;
}

namespace openvdb {
OPENVDB_USE_VERSION_NAMESPACE
namespace OPENVDB_VERSION_NAME {
namespace ax {

class Compiler;

class VolumeExecutable
{
public:
    using Ptr = std::shared_ptr<VolumeExecutable>;
    ~VolumeExecutable();

    VolumeExecutable(const VolumeExecutable& other);


    void execute(openvdb::GridPtrVec& grids) const;
    void execute(openvdb::GridBase& grid) const;


    void setCreateMissing(const bool flag);
    bool getCreateMissing() const;

    void setTreeExecutionLevel(const Index level);
    Index getTreeExecutionLevel() const;

    enum class IterType { ON, OFF, ALL };
    void setValueIterator(const IterType& iter);
    IterType getValueIterator() const;

    void setGrainSize(const size_t grain);
    size_t getGrainSize() const;


    // @brief deprecated methods
    OPENVDB_DEPRECATED void
    execute(openvdb::GridPtrVec& grids,
        const IterType iter,
        const bool create) const
    {
        VolumeExecutable copy(*this);
        copy.setValueIterator(iter);
        copy.setCreateMissing(create);
        copy.execute(grids);
    }

    OPENVDB_DEPRECATED void
    execute(openvdb::GridPtrVec& grids,
        const IterType iter) const
    {
        VolumeExecutable copy(*this);
        copy.setValueIterator(iter);
        copy.execute(grids);
    }


    // foward declaration of settings for this executable
    struct Settings;

private:
    friend class Compiler;
    friend class ::TestVolumeExecutable;

    VolumeExecutable(const std::shared_ptr<const llvm::LLVMContext>& context,
        const std::shared_ptr<const llvm::ExecutionEngine>& engine,
        const AttributeRegistry::ConstPtr& accessRegistry,
        const CustomData::ConstPtr& customData,
        const std::unordered_map<std::string, uint64_t>& functions);

private:
    // The Context and ExecutionEngine must exist _only_ for object lifetime
    // management. The ExecutionEngine must be destroyed before the Context
    const std::shared_ptr<const llvm::LLVMContext> mContext;
    const std::shared_ptr<const llvm::ExecutionEngine> mExecutionEngine;
    const AttributeRegistry::ConstPtr mAttributeRegistry;
    const CustomData::ConstPtr mCustomData;
    const std::unordered_map<std::string, uint64_t> mFunctionAddresses;
    std::unique_ptr<Settings> mSettings;
};

} // namespace ax
} // namespace OPENVDB_VERSION_NAME
} // namespace openvdb

#endif // OPENVDB_AX_COMPILER_VOLUME_EXECUTABLE_HAS_BEEN_INCLUDED