MultiDevice Class Reference

Inherits Device.

Classes
struct	SubDevice

Public Member Functions
	MultiDevice (const DeviceInfo &info, Stats &stats, Profiler &profiler, bool headless)
	~MultiDevice ()
const string &	error_message () override
virtual BVHLayoutMask	get_bvh_layout_mask (uint kernel_features) const override
bool	load_kernels (const uint kernel_features) override
bool	load_osl_kernels () override
void	build_bvh (BVH *bvh, Progress &progress, bool refit) override
virtual void *	get_cpu_osl_memory () 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 vector< SubDevice * > &island)
device_ptr	find_matching_mem (device_ptr key, SubDevice &sub)
void	mem_alloc (device_memory &mem) override
void	mem_copy_to (device_memory &mem) override
void	mem_copy_from (device_memory &mem, size_t y, size_t w, 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, size_t size) override
int	device_number (Device *sub_device) override
virtual void	foreach_device (const function< void(Device *)> &callback) 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 void	get_cpu_kernel_thread_globals (vector< CPUKernelThreadGlobals > &)
virtual void	release_bvh (BVH *)
virtual void	optimize_for_scene (Scene *)
virtual bool	check_peer_access (Device *)
virtual bool	should_use_graphics_interop ()
virtual void *	get_native_buffer (device_ptr)
virtual void *	get_guiding_device () const

Public Attributes
list< SubDevice >	devices
device_ptr	unique_key
vector< vector< SubDevice * > >	peer_islands
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 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 (uint device_type_mask=DEVICE_MASK_ALL)
static DeviceInfo	dummy_device (const string &error_msg="")
static string	device_capabilities (uint device_type_mask=DEVICE_MASK_ALL)
static DeviceInfo	get_multi_device (const vector< DeviceInfo > &subdevices, 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

Detailed Description

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

Constructor & Destructor Documentation

MultiDevice()

MultiDevice::MultiDevice ( const DeviceInfo & info, Stats & stats, Profiler & profiler, bool headless )

inline

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

References Device::create(), Device::Device(), Device::headless, Device::info, Device::profiler, Device::stats, and unique_key.

~MultiDevice()

MultiDevice::~MultiDevice ( )

inline

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

References MultiDevice::SubDevice::device, and devices.

Member Function Documentation

build_bvh()

void MultiDevice::build_bvh ( BVH * bvh, Progress & progress, bool refit )

inlineoverridevirtual

Reimplemented from Device.

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

References Device::build_bvh(), Geometry::bvh, BVHParams::bvh_layout, BVH_LAYOUT_BVH2, BVH_LAYOUT_EMBREE, BVH_LAYOUT_EMBREEGPU, BVH_LAYOUT_HIPRT, BVH_LAYOUT_METAL, BVH_LAYOUT_MULTI_EMBREEGPU, BVH_LAYOUT_MULTI_EMBREEGPU_EMBREE, BVH_LAYOUT_MULTI_HIPRT, BVH_LAYOUT_MULTI_HIPRT_EMBREE, BVH_LAYOUT_MULTI_METAL, BVH_LAYOUT_MULTI_METAL_EMBREE, BVH_LAYOUT_MULTI_OPTIX, BVH_LAYOUT_MULTI_OPTIX_EMBREE, BVH_LAYOUT_OPTIX, BVH::create(), MultiDevice::SubDevice::device, DEVICE_HIP, DEVICE_METAL, DEVICE_ONEAPI, DEVICE_OPTIX, devices, BVH::geometry, Device::info, BVH::objects, BVH::params, params, refit(), BVHMulti::sub_bvhs, and DeviceInfo::type.

const_copy_to()

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

inlineoverridevirtual

Implements Device.

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

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

device_number()

int MultiDevice::device_number ( Device * sub_device )

inlineoverridevirtual

Reimplemented from Device.

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

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

error_message()

const string & MultiDevice::error_message ( )

inlineoverridevirtual

Reimplemented from Device.

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

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

find_matching_mem()

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

inline

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

References find_matching_mem_device().

find_matching_mem_device()

SubDevice * MultiDevice::find_matching_mem_device ( device_ptr key, SubDevice & sub )

inline

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

References MultiDevice::SubDevice::peer_island_index, peer_islands, and MultiDevice::SubDevice::ptr_map.

Referenced by find_matching_mem(), is_resident(), mem_copy_from(), and mem_free().

find_suitable_mem_device()

SubDevice * MultiDevice::find_suitable_mem_device ( device_ptr key, const vector< SubDevice * > & island )

inline

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

References MultiDevice::SubDevice::device, Stats::mem_used, MultiDevice::SubDevice::ptr_map, and Device::stats.

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

foreach_device()

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

inlineoverridevirtual

Reimplemented from Device.

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

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

get_bvh_layout_mask()

virtual BVHLayoutMask MultiDevice::get_bvh_layout_mask ( uint kernel_features ) const

inlineoverridevirtual

Implements Device.

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

References BVH_LAYOUT_ALL, BVH_LAYOUT_EMBREE, BVH_LAYOUT_EMBREEGPU, BVH_LAYOUT_HIPRT, BVH_LAYOUT_METAL, BVH_LAYOUT_MULTI_EMBREEGPU, BVH_LAYOUT_MULTI_EMBREEGPU_EMBREE, BVH_LAYOUT_MULTI_HIPRT, BVH_LAYOUT_MULTI_HIPRT_EMBREE, BVH_LAYOUT_MULTI_METAL, BVH_LAYOUT_MULTI_METAL_EMBREE, BVH_LAYOUT_MULTI_OPTIX, BVH_LAYOUT_MULTI_OPTIX_EMBREE, BVH_LAYOUT_NONE, BVH_LAYOUT_OPTIX, MultiDevice::SubDevice::device, devices, and Device::get_bvh_layout_mask().

get_cpu_osl_memory()

virtual void * MultiDevice::get_cpu_osl_memory ( )

inlineoverridevirtual

Reimplemented from Device.

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

References DEVICE_CPU, devices, and NULL.

is_resident()

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

inlineoverridevirtual

Reimplemented from Device.

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

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

load_kernels()

bool MultiDevice::load_kernels ( const uint kernel_features )

inlineoverridevirtual

Reimplemented from Device.

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

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

load_osl_kernels()

bool MultiDevice::load_osl_kernels ( )

inlineoverridevirtual

Reimplemented from Device.

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

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

mem_alloc()

void MultiDevice::mem_alloc ( device_memory & mem )

inlineoverridevirtual

Implements Device.

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

References device_memory::device, MultiDevice::SubDevice::device, Device::device_memory, device_memory::device_pointer, device_memory::device_size, find_suitable_mem_device(), Device::mem_alloc(), MEM_DEVICE_ONLY, MEM_READ_ONLY, MEM_READ_WRITE, peer_islands, MultiDevice::SubDevice::ptr_map, Device::stats, device_memory::type, and unique_key.

mem_copy_from()

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

inlineoverridevirtual

Implements Device.

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

References device_memory::device, MultiDevice::SubDevice::device, Device::device_memory, device_memory::device_pointer, devices, find_matching_mem_device(), Device::mem_copy_from(), MultiDevice::SubDevice::ptr_map, w(), and y.

mem_copy_to()

void MultiDevice::mem_copy_to ( device_memory & mem )

inlineoverridevirtual

Implements Device.

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

References device_memory::device, MultiDevice::SubDevice::device, Device::device_memory, device_memory::device_pointer, device_memory::device_size, find_suitable_mem_device(), Device::mem_copy_to(), MEM_GLOBAL, MEM_TEXTURE, peer_islands, MultiDevice::SubDevice::ptr_map, Device::stats, device_memory::type, and unique_key.

mem_free()

void MultiDevice::mem_free ( device_memory & mem )

inlineoverridevirtual

Implements Device.

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

References device_memory::device, MultiDevice::SubDevice::device, Device::device_memory, device_memory::device_pointer, device_memory::device_size, find_matching_mem_device(), Device::mem_free(), MEM_TEXTURE, peer_islands, MultiDevice::SubDevice::ptr_map, Device::stats, and device_memory::type.

mem_zero()

void MultiDevice::mem_zero ( device_memory & mem )

inlineoverridevirtual

Implements Device.

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

References device_memory::device, MultiDevice::SubDevice::device, Device::device_memory, device_memory::device_pointer, device_memory::device_size, find_suitable_mem_device(), Device::mem_zero(), peer_islands, MultiDevice::SubDevice::ptr_map, Device::stats, and unique_key.

Member Data Documentation

devices

list<SubDevice> MultiDevice::devices

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

Referenced by build_bvh(), const_copy_to(), device_number(), error_message(), foreach_device(), get_bvh_layout_mask(), get_cpu_osl_memory(), is_resident(), load_kernels(), load_osl_kernels(), mem_copy_from(), and ~MultiDevice().

peer_islands

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

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

Referenced by find_matching_mem_device(), mem_alloc(), mem_copy_to(), mem_free(), and mem_zero().

unique_key

device_ptr MultiDevice::unique_key

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

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

---

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

• device/multi/device.cpp