11# include "device/metal/bvh.h"
17# include <Metal/Metal.h>
23class MetalDevice :
public Device {
25 id<MTLDevice> mtlDevice = nil;
26 id<MTLLibrary> mtlLibrary[PSO_NUM] = {nil};
27 id<MTLCommandQueue> mtlComputeCommandQueue = nil;
28 id<MTLCommandQueue> mtlGeneralCommandQueue = nil;
29 id<MTLCounterSampleBuffer> mtlCounterSampleBuffer = nil;
30 string source[PSO_NUM];
31 string kernels_md5[PSO_NUM];
32 string global_defines_md5[PSO_NUM];
34 bool capture_enabled =
false;
37 id<MTLBuffer> launch_params_buffer = nil;
38 KernelParamsMetal *launch_params =
nullptr;
41 bool use_metalrt =
false;
42 bool use_metalrt_extended_limits =
false;
43 bool motion_blur =
false;
44 bool use_pcmi =
false;
46 id<MTLBuffer> blas_buffer = nil;
48 API_AVAILABLE(macos(11.0))
49 vector<
id<MTLAccelerationStructure>> unique_blas_array;
51 API_AVAILABLE(macos(11.0))
52 vector<
id<MTLAccelerationStructure>> blas_array;
54 API_AVAILABLE(macos(11.0))
55 id<MTLAccelerationStructure> accel_struct = nil;
58 void prepare_residency();
59 void metal_mem_alloc(
id<MTLResource> allocation);
60 void metal_mem_free(
id<MTLResource> allocation);
64 void add_to_residency_set(
id<MTLResource> allocation);
65 void remove_from_residency_set(
id<MTLResource> allocation);
67 bool mtlResidencySet_enabled = false;
68# if defined(MAC_OS_VERSION_15_0)
69 API_AVAILABLE(macos(15.0), ios(18.0))
70 id<MTLResidencySet> mtlResidencySet = nil;
71 bool mtlResidencySet_dirty = false;
73 std::mutex mtlResidencySet_mutex;
77 bool using_nanovdb =
false;
78 int max_threads_per_threadgroup;
81 bool has_error =
false;
84 device_memory *mem =
nullptr;
85 int pointer_index = -1;
86 id<MTLBuffer> mtlBuffer = nil;
87 id<MTLTexture> mtlTexture = nil;
90 void *hostPtr =
nullptr;
92 using MetalMemMap = map<device_memory *, unique_ptr<MetalMem>>;
93 MetalMemMap metal_mem_map;
94 std::vector<id<MTLResource>> delayed_free_list;
95 std::recursive_mutex metal_mem_map_mutex;
98 bool is_texture(
const KernelImageInfo &info);
99 device_vector<KernelImageInfo> image_info;
100 id<MTLBuffer> image_bindings = nil;
101 std::vector<id<MTLResource>> image_info_id_map;
103 MetalPipelineType kernel_specialization_level = PSO_GENERIC;
108 static std::map<int, MetalDevice *> active_device_ids;
110 static bool is_device_cancelled(
const int device_id);
112 static MetalDevice *get_device_by_ID(
const int device_idID,
115 bool is_ready(
string &status)
const override;
117 void cancel()
override;
121 void set_error(
const string &error)
override;
123 MetalDevice(
const DeviceInfo &info, Stats &stats, Profiler &profiler,
bool headless);
125 ~MetalDevice()
override;
127 bool support_device(
uint64_t kernel_features);
129 bool check_peer_access(Device *peer_device)
override;
131 bool use_adaptive_compilation();
133 bool use_local_atomic_sort()
const;
135 string preprocess_source(MetalPipelineType pso_type,
137 string *source =
nullptr);
139 void refresh_source_and_kernels_md5(MetalPipelineType pso_type);
141 void make_source(MetalPipelineType pso_type,
uint64_t kernel_features);
143 bool load_kernels(
uint64_t kernel_features)
override;
145 void load_image_info();
147 void erase_allocation(device_memory &mem);
149 bool should_use_graphics_interop(
const GraphicsInteropDevice &interop_device,
150 const bool log)
override;
152 void *get_native_buffer(
device_ptr ptr)
override;
154 unique_ptr<DeviceQueue> gpu_queue_create()
override;
156 void build_bvh(
BVH *bvh, Progress &progress,
bool refit)
override;
158 bool set_bvh_limits(
size_t instance_count,
size_t max_prim_count)
override;
160 void optimize_for_scene(Scene *scene)
override;
162 static void compile_and_load(
const int device_id, MetalPipelineType pso_type);
167 bool max_working_set_exceeded(
const size_t safety_margin = 8 * 1024 * 1024)
const;
169 MetalMem *generic_alloc(device_memory &mem);
171 void generic_copy_to(device_memory &mem);
173 void generic_free(device_memory &mem);
175 void mem_alloc(device_memory &mem)
override;
177 void mem_copy_to(device_memory &mem)
override;
179 void mem_move_to_host(device_memory &mem)
override;
181 void mem_copy_from(device_memory &mem)
183 mem_copy_from(mem, -1, -1, -1, -1);
186 device_memory &mem,
const size_t y,
size_t w,
const size_t h,
size_t elem)
override;
188 void mem_or_from_device(device_memory &mem)
override;
190 void mem_zero(device_memory &mem)
override;
192 void mem_free(device_memory &mem)
override;
194 device_ptr mem_alloc_sub_ptr(device_memory &mem,
const size_t offset,
size_t )
override;
196 void const_copy_to(
const char *name,
void *host,
const size_t size)
override;
198 void global_alloc(device_memory &mem);
199 void global_free(device_memory &mem);
201 void image_alloc(device_image &mem);
202 void image_alloc_as_buffer(device_image &mem);
203 void image_copy_to(device_image &mem);
204 void image_free(device_image &mem);
206 void flush_delayed_free_list();
210 void update_bvh(BVHMetal *bvh_metal);
unsigned long long int uint64_t
void refit(btStridingMeshInterface *triangles, const btVector3 &aabbMin, const btVector3 &aabbMax)
SIMD_FORCE_INLINE const btScalar & w() const
Return the w value.
#define CCL_NAMESPACE_END
ccl_device bool BVH_FUNCTION_FULL_NAME BVH(KernelGlobals kg, const ccl_private Ray *ray, ccl_private LocalIntersection *local_isect, const int local_object, ccl_private uint *lcg_state, const int max_hits)
int size(const AssetLibraryReference *library_reference)
std::unique_lock< std::mutex > thread_scoped_lock