vart_memory.hpp

Go to the documentation of this file.

/*
 * Copyright 2024-2026 Advanced Micro Devices Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <cstdint>
#include <string>
#include "vart_device.hpp"
#include "vart_memory_types.hpp"
 
namespace vart {
 
class MemoryImplBase;
 
class Memory {
 public:
  Memory(MemoryImplType type, size_t size, uint8_t mbank_idx, std::shared_ptr<Device> device);
 
  Memory(MemoryImplType type, uint8_t* data, size_t size, std::shared_ptr<Device> device);
 
  Memory(std::shared_ptr<MemoryImplBase> ptr);
 
  Memory(MemoryImplType type, int dma_fd, size_t size, std::shared_ptr<Device> device);
 
  ~Memory() = default;
 
  const uint8_t* map(DataMapFlags map_flags);
 
  void unmap();
 
  const std::shared_ptr<MemoryImplBase>& get_pimpl_handle() const;
 
  std::shared_ptr<Device> get_device_handle() const;
 
  size_t get_size();
 
  uint64_t get_physical_addr();
 
  int export_buffer() const;
 
 private:
  std::shared_ptr<MemoryImplBase> pimpl;  
};
}  // namespace vart