Blender V5.3
MultiDevice Class Reference

Inherits Device.

Classes

struct  SubDevice

Public Types

using Island = std::span<SubDevice *const>

Public Member Functions

device_ptr ptr_map_find (const SubDevice &sub, const device_ptr key) const
bool ptr_map_contains (const SubDevice &sub, const device_ptr key) const
void ptr_map_set (SubDevice &sub, const device_ptr key, const device_ptr ptr)
void ptr_map_erase (SubDevice &sub, const device_ptr key)
 MultiDevice (const DeviceInfo &info_, Stats &stats, Profiler &profiler, bool headless)
void verify_hardware_raytracing ()
const string & error_message () override
BVHLayoutMask get_bvh_layout_mask (const uint64_t kernel_features) const override
bool load_kernels (const uint64_t kernel_features) override
bool load_osl_kernels () override
void build_bvh (BVH *bvh, Progress &progress, bool refit) override
OSLGlobals * get_cpu_osl_memory () override
device_ptr mem_device_ptr (const device_memory &mem, Device *sub_device) override
void set_image_cache_func (KernelImageLoadRequestedCPU image_load_requested_cpu, KernelImageLoadRequestedGPU image_load_requested_gpu) override
bool is_resident (device_ptr key, Device *sub_device) override
SubDevice * find_matching_mem_device (device_ptr key, SubDevice &sub)
SubDevice * find_suitable_mem_device (device_ptr key, const Island island)
device_ptr find_matching_mem (device_ptr key, SubDevice &sub)
vector< Island > mem_islands (const device_memory &mem) const
void * host_alloc (const MemoryType type, const size_t size) override
void host_free (const MemoryType type, void *host_pointer, const size_t size) override
void mem_alloc (device_memory &mem) override
void mem_copy_to (device_memory &mem) override
void mem_move_to_host (device_memory &mem) override
bool is_shared (const void *shared_pointer, const device_ptr key, Device *sub_device) override
void mem_or_from_device (device_memory &mem) override
void mem_copy_from (device_memory &mem, const size_t y, size_t w, const size_t h, size_t elem) override
void mem_zero (device_memory &mem) override
void mem_free (device_memory &mem) override
void const_copy_to (const char *name, void *host, const size_t size) override
int device_number (Device *sub_device) override
void foreach_device (const std::function< void(Device *)> &callback) override
bool has_unified_image_memory_all () const override
Public Member Functions inherited from Device
virtual ~Device () noexcept(false)
bool have_error ()
virtual void set_error (const string &error)
virtual void cancel ()
virtual bool is_ready (string &) const
virtual unique_ptr< DeviceQueue > gpu_queue_create ()
virtual vector< ThreadKernelGlobalsCPU > * acquire_cpu_kernel_thread_globals ()
virtual void release_cpu_kernel_thread_globals ()
void image_load_requested_gpu (DeviceQueue &queue)
virtual void release_bvh (BVH *)
virtual bool set_bvh_limits (size_t, size_t)
virtual void optimize_for_scene (Scene *)
virtual bool check_peer_access (Device *)
virtual bool should_use_graphics_interop (const GraphicsInteropDevice &, const bool=false)
virtual void * get_native_buffer (device_ptr)
virtual void * get_guiding_device () const

Public Attributes

list< SubDevice > devices
std::atomic< device_ptr > unique_key = 1
vector< vector< SubDevice * > > peer_islands
std::shared_mutex ptr_map_mutex
Public Attributes inherited from Device
DeviceInfo info
Stats & stats
Profiler & profiler
bool headless = true

Additional Inherited Members

Static Public Member Functions inherited from Device
static const CPUKernels & get_cpu_kernels ()
static unique_ptr< Device > create (const DeviceInfo &info, Stats &stats, Profiler &profiler, bool headless)
static DeviceType type_from_string (const char *name)
static string string_from_type (DeviceType type)
static vector< DeviceType > available_types ()
static vector< DeviceInfo > available_devices (const uint device_type_mask=DEVICE_MASK_ALL)
static DeviceInfo dummy_device (const string &error_msg="")
static string device_capabilities (const uint device_type_mask=DEVICE_MASK_ALL)
static DeviceInfo get_multi_device (const vector< DeviceInfo > &subdevices, const int threads, bool background)
static void tag_update ()
static void free_memory ()
Protected Member Functions inherited from Device
 Device (const DeviceInfo &info_, Stats &stats_, Profiler &profiler_, bool headless_)
virtual device_ptr mem_alloc_sub_ptr (device_memory &, size_t, size_t)
virtual void mem_free_sub_ptr (device_ptr)
Protected Attributes inherited from Device
string error_msg
KernelImageLoadRequestedGPU image_load_requested_gpu_

Detailed Description

Definition at line 25 of file device/multi/device.cpp.

Member Typedef Documentation

◆ Island

using MultiDevice::Island = std::span<SubDevice *const>

Definition at line 33 of file device/multi/device.cpp.

Constructor & Destructor Documentation

◆ MultiDevice()

Member Function Documentation

◆ build_bvh()

◆ const_copy_to()

void MultiDevice::const_copy_to ( const char * name,
void * host,
const size_t size )
inlineoverridevirtual

Implements Device.

Definition at line 647 of file device/multi/device.cpp.

References devices.

◆ device_number()

int MultiDevice::device_number ( Device * sub_device)
inlineoverridevirtual

Reimplemented from Device.

Definition at line 654 of file device/multi/device.cpp.

References Device::Device(), and devices.

◆ error_message()

const string & MultiDevice::error_message ( )
inlineoverridevirtual

Reimplemented from Device.

Definition at line 145 of file device/multi/device.cpp.

References devices, and Device::error_msg.

◆ find_matching_mem()

device_ptr MultiDevice::find_matching_mem ( device_ptr key,
SubDevice & sub )
inline

Definition at line 405 of file device/multi/device.cpp.

References find_matching_mem_device(), and ptr_map_find().

◆ find_matching_mem_device()

◆ find_suitable_mem_device()

SubDevice * MultiDevice::find_suitable_mem_device ( device_ptr key,
const Island island )
inline

◆ foreach_device()

void MultiDevice::foreach_device ( const std::function< void(Device *)> & callback)
inlineoverridevirtual

Reimplemented from Device.

Definition at line 668 of file device/multi/device.cpp.

References Device::Device(), and devices.

◆ get_bvh_layout_mask()

◆ get_cpu_osl_memory()

OSLGlobals * MultiDevice::get_cpu_osl_memory ( )
inlineoverridevirtual

Reimplemented from Device.

Definition at line 322 of file device/multi/device.cpp.

References DEVICE_CPU, and devices.

◆ has_unified_image_memory_all()

bool MultiDevice::has_unified_image_memory_all ( ) const
inlineoverridevirtual

Reimplemented from Device.

Definition at line 675 of file device/multi/device.cpp.

References devices.

◆ host_alloc()

void * MultiDevice::host_alloc ( const MemoryType type,
const size_t size )
inlineoverridevirtual

Reimplemented from Device.

Definition at line 427 of file device/multi/device.cpp.

References DEVICE_CPU, devices, and Device::host_alloc().

◆ host_free()

void MultiDevice::host_free ( const MemoryType type,
void * host_pointer,
const size_t size )
inlineoverridevirtual

Reimplemented from Device.

Definition at line 438 of file device/multi/device.cpp.

References DEVICE_CPU, devices, and Device::host_free().

◆ is_resident()

bool MultiDevice::is_resident ( device_ptr key,
Device * sub_device )
inlineoverridevirtual

Reimplemented from Device.

Definition at line 363 of file device/multi/device.cpp.

References Device::Device(), MultiDevice::SubDevice::device, devices, and find_matching_mem_device().

◆ is_shared()

bool MultiDevice::is_shared ( const void * shared_pointer,
const device_ptr key,
Device * sub_device )
inlineoverridevirtual

◆ load_kernels()

bool MultiDevice::load_kernels ( const uint64_t kernel_features)
inlineoverridevirtual

Reimplemented from Device.

Definition at line 208 of file device/multi/device.cpp.

References devices.

◆ load_osl_kernels()

bool MultiDevice::load_osl_kernels ( )
inlineoverridevirtual

Reimplemented from Device.

Definition at line 219 of file device/multi/device.cpp.

References devices.

◆ mem_alloc()

◆ mem_copy_from()

void MultiDevice::mem_copy_from ( device_memory & mem,
const size_t y,
size_t w,
const size_t h,
size_t elem )
inlineoverridevirtual

◆ mem_copy_to()

◆ mem_device_ptr()

device_ptr MultiDevice::mem_device_ptr ( const device_memory & mem,
Device * sub_device )
inlineoverridevirtual

◆ mem_free()

◆ mem_islands()

vector< Island > MultiDevice::mem_islands ( const device_memory & mem) const
inline

◆ mem_move_to_host()

◆ mem_or_from_device()

void MultiDevice::mem_or_from_device ( device_memory & mem)
inlineoverridevirtual

◆ mem_zero()

◆ ptr_map_contains()

bool MultiDevice::ptr_map_contains ( const SubDevice & sub,
const device_ptr key ) const
inline

◆ ptr_map_erase()

void MultiDevice::ptr_map_erase ( SubDevice & sub,
const device_ptr key )
inline

Definition at line 62 of file device/multi/device.cpp.

References lock, MultiDevice::SubDevice::ptr_map, and ptr_map_mutex.

Referenced by mem_free().

◆ ptr_map_find()

device_ptr MultiDevice::ptr_map_find ( const SubDevice & sub,
const device_ptr key ) const
inline

◆ ptr_map_set()

void MultiDevice::ptr_map_set ( SubDevice & sub,
const device_ptr key,
const device_ptr ptr )
inline

◆ set_image_cache_func()

void MultiDevice::set_image_cache_func ( KernelImageLoadRequestedCPU image_load_requested_cpu,
KernelImageLoadRequestedGPU image_load_requested_gpu )
inlineoverridevirtual

Reimplemented from Device.

Definition at line 355 of file device/multi/device.cpp.

References devices, and Device::image_load_requested_gpu().

◆ verify_hardware_raytracing()

void MultiDevice::verify_hardware_raytracing ( )
inline

Member Data Documentation

◆ devices

◆ peer_islands

vector<vector<SubDevice *> > MultiDevice::peer_islands

Definition at line 37 of file device/multi/device.cpp.

Referenced by find_matching_mem_device(), mem_islands(), and MultiDevice().

◆ ptr_map_mutex

std::shared_mutex MultiDevice::ptr_map_mutex
mutable

Definition at line 41 of file device/multi/device.cpp.

Referenced by ptr_map_contains(), ptr_map_erase(), ptr_map_find(), and ptr_map_set().

◆ unique_key

std::atomic<device_ptr> MultiDevice::unique_key = 1

Definition at line 36 of file device/multi/device.cpp.

Referenced by mem_alloc(), mem_copy_to(), mem_move_to_host(), and mem_zero().


The documentation for this class was generated from the following file: