1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543

use crate::ffi::vk::*;
use super::error::Result;
use super::error::ErrorCode;
use super::instance::{Instance, QueueFamily, PhysicalDevice, PhysicalDevicesBuilder};
use super::device::{Device, CommandPool, CommandBuffer, CommandBufferBuilder};

use std::ptr;
use std::mem;
use std::mem::MaybeUninit;
use libc::{c_float, c_void};
use std::sync::Arc;
use std::io::Read;

use VkBufferUsageFlagBits::*;
use VkMemoryPropertyFlagBits::*;
use VkPipelineStageFlagBits::*;

pub struct BufferMemory {
    buffer: VkBuffer,
    memory: VkDeviceMemory,
    device: Arc<Device>,
    whole_size: VkDeviceSize,
}

impl BufferMemory {
    pub fn new(device: &Arc<Device>, 
        usage: VkBufferUsageFlags, 
        memory_property_flags: VkMemoryPropertyFlags, 
        size: VkDeviceSize) -> Result<Arc<Self>> {
        unsafe {
            // creates buffer
            let mut buffer = MaybeUninit::<VkBuffer>::zeroed();
            let buffer_create_info = VkBufferCreateInfo::new(size, usage, VkSharingMode::VK_SHARING_MODE_EXCLUSIVE);
            vkCreateBuffer(device.handle(), &buffer_create_info, ptr::null(), buffer.as_mut_ptr())
                .into_result()
                .unwrap();
            let buffer = buffer.assume_init();
            // requirements
            let mut requirements = MaybeUninit::<VkMemoryRequirements>::zeroed();
            vkGetBufferMemoryRequirements(device.handle(), buffer, requirements.as_mut_ptr());
            let requirements = requirements.assume_init();
            let memory_type_index = device.physical_device()
                .memory_type_index(&requirements, memory_property_flags)
                .ok_or_else(|| ErrorCode::SuitableBufferMemoryTypeNotFound)
                .unwrap();
            // allocation
            let mut memory = MaybeUninit::<VkDeviceMemory>::zeroed();
            let allocate_info = VkMemoryAllocateInfo::new(requirements.size, memory_type_index);
            vkAllocateMemory(device.handle(), &allocate_info, ptr::null(), memory.as_mut_ptr())
                .into_result()
                .unwrap();
            let memory = memory.assume_init();
            // binding
            vkBindBufferMemory(device.handle(), buffer, memory, 0)
                .into_result()
                .unwrap();
            let buffer_memory = BufferMemory { 
                buffer: buffer,
                memory: memory,
                device: Arc::clone(device),
                whole_size: size,
            };
            Ok(Arc::new(buffer_memory))
        }
    }

    #[inline]
    pub fn buffer(&self) -> VkBuffer {
        self.buffer
    }

    #[inline]
    pub fn memory(&self) -> VkDeviceMemory {
        self.memory
    }

    #[inline]
    pub fn device(&self) -> &Arc<Device> {
        &self.device
    }
}

impl Drop for BufferMemory {
    fn drop(&mut self) {
        unsafe {
            log_debug!("Drop BufferMemory");
            vkDestroyBuffer(self.device.handle(), self.buffer, ptr::null());
            self.buffer = ptr::null_mut();
            vkFreeMemory(self.device.handle(), self.memory, ptr::null());
            self.memory = ptr::null_mut();
        }
    }
}

pub enum StagingBufferUsage {
    Vertex,
    Index,
}

impl StagingBufferUsage {
    fn host_buffer_usage_flags(&self) -> VkBufferUsageFlags {
        VkBufferUsageFlagBits::VK_BUFFER_USAGE_TRANSFER_SRC_BIT as VkBufferUsageFlags
    }

    fn device_buffer_usage_flags(&self) -> VkBufferUsageFlags {
        let usage = match self {
            &Self::Vertex => VkBufferUsageFlagBits::VK_BUFFER_USAGE_VERTEX_BUFFER_BIT,
            &Self::Index => VkBufferUsageFlagBits::VK_BUFFER_USAGE_INDEX_BUFFER_BIT,
        };
        VkBufferUsageFlagBits::VK_BUFFER_USAGE_TRANSFER_DST_BIT as VkBufferUsageFlags
            | usage as VkBufferUsageFlags
    }

    fn host_memory_property_flags(&self) -> VkMemoryPropertyFlags {
        VkMemoryPropertyFlagBits::VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT as VkMemoryPropertyFlags
            | VkMemoryPropertyFlagBits::VK_MEMORY_PROPERTY_HOST_COHERENT_BIT as VkMemoryPropertyFlags
    }

    fn device_memory_property_flags(&self) -> VkMemoryPropertyFlags {
        VkMemoryPropertyFlagBits::VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT as VkMemoryPropertyFlags
    }
}

pub struct StagingBuffer {
    command_pool: Arc<CommandPool>,
    host_buffer_memory: Arc<BufferMemory>,
    device_buffer_memory: Arc<BufferMemory>,
    copying_command_buffer: Arc<CommandBuffer>,
}

impl StagingBuffer {
    pub fn new(command_pool: &Arc<CommandPool>, usage: StagingBufferUsage, size: VkDeviceSize) -> Result<Arc<Self>> {
        unsafe {
            let device = command_pool.queue().device();
            let host_buffer_memory = BufferMemory::new(
                device,
                usage.host_buffer_usage_flags(),
                usage.host_memory_property_flags(),
                size)?;
            let device_buffer_memory = BufferMemory::new(
                device,
                usage.device_buffer_usage_flags(),
                usage.device_memory_property_flags(),
                size)?;
            let command_buffer = CommandBufferBuilder::new(command_pool).build(|command_buffer| {
                let copy_region = VkBufferCopy::new(0, size);
                vkCmdCopyBuffer(
                    command_buffer,
                    host_buffer_memory.buffer(),
                    device_buffer_memory.buffer(),
                    1,
                    &copy_region,
                );
            });
            let staging_buffer = StagingBuffer {
                command_pool: Arc::clone(command_pool),
                host_buffer_memory,
                device_buffer_memory,
                copying_command_buffer: command_buffer,
            };
            Ok(Arc::new(staging_buffer))
        }
    }

    pub fn write(&self, src: *const c_void, size: usize) {
        unsafe {
            let device = self.command_pool.queue().device();
            let host_buffer_memory = &self.host_buffer_memory;
            let mut mapped = MaybeUninit::<*mut c_void>::zeroed();
            vkMapMemory(device.handle(), host_buffer_memory.memory(), 0, size as VkDeviceSize, 0, mapped.as_mut_ptr())
                .into_result()
                .unwrap();
            let mapped = mapped.assume_init();
            std::ptr::copy_nonoverlapping(src, mapped, size);
            vkUnmapMemory(device.handle(), host_buffer_memory.memory());
            self.copying_command_buffer.submit_then_wait(
                VkPipelineStageFlagBits::VK_PIPELINE_STAGE_TRANSFER_BIT as VkPipelineStageFlags);
        }
    }

    #[inline]
    pub fn host_buffer_memory(&self) -> &Arc<BufferMemory> {
        &self.host_buffer_memory
    }

    #[inline]
    pub fn device_buffer_memory(&self) -> &Arc<BufferMemory> {
        &self.device_buffer_memory
    }
}

pub struct ImageMemory {
    device: Arc<Device>,
    handle: VkDeviceMemory,
}

impl ImageMemory {
    pub fn new(device: &Arc<Device>, image: VkImage) -> Result<Arc<Self>> {
        unsafe {
            // image memory requirements
            let mut requirements = MaybeUninit::<VkMemoryRequirements>::zeroed();
            vkGetImageMemoryRequirements(device.handle(), image, requirements.as_mut_ptr());
            let requirements = requirements.assume_init();
            let memory_type_index = device.physical_device()
                .memory_type_index(&requirements, VkMemoryPropertyFlagBits::VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT as VkMemoryPropertyFlags)
                .ok_or_else(|| ErrorCode::SuitableImageMemoryTypeNotFound)
                .unwrap();
            // allocation
            let alloc_info = VkMemoryAllocateInfo::new(requirements.size, memory_type_index);
            let mut memory = MaybeUninit::<VkDeviceMemory>::zeroed();
            vkAllocateMemory(device.handle(), &alloc_info, ptr::null(), memory.as_mut_ptr())
                .into_result()
                .unwrap();
            let memory = memory.assume_init();
            vkBindImageMemory(device.handle(), image, memory, 0)
                .into_result()
                .unwrap();
            let image_memory = ImageMemory {
                device: Arc::clone(device),
                handle: memory,
            };
            Ok(Arc::new(image_memory))
        }
    }

    #[inline]
    pub fn handle(&self) -> VkDeviceMemory {
        self.handle
    }
}

impl Drop for ImageMemory {
    fn drop(&mut self) {
        unsafe {
            log_debug!("Drop ImageMemory");
            vkFreeMemory(self.device.handle(), self.handle, ptr::null());
            self.handle = ptr::null_mut();
        }
    }
}

pub struct DedicatedBufferMemory {
    buffer: VkBuffer,
    memory: VkDeviceMemory,
    device: Arc<Device>,
    size: VkDeviceSize,
}

impl DedicatedBufferMemory {
    pub fn new(device: &Arc<Device>, 
        usage: VkBufferUsageFlags, 
        memory_property_flags: VkMemoryPropertyFlags, 
        size: VkDeviceSize) -> Result<Arc<Self>> {
        unsafe {
            // creates buffer
            let mut buffer = MaybeUninit::<VkBuffer>::zeroed();
            let buffer_create_info = VkBufferCreateInfo::new(size, usage, VkSharingMode::VK_SHARING_MODE_EXCLUSIVE);
            vkCreateBuffer(device.handle(), &buffer_create_info, ptr::null(), buffer.as_mut_ptr())
                .into_result()
                .unwrap();
            let buffer = buffer.assume_init();
            // find memory requirements
            let mut dedicated = MaybeUninit::<VkMemoryDedicatedRequirements>::zeroed();
            {
                let dedicated = dedicated.as_mut_ptr().as_mut().unwrap();
                dedicated.sType = VkStructureType::VK_STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS;
            }
            let mut requirements = MaybeUninit::<VkMemoryRequirements2>::zeroed();
            {
                let requirements = requirements.as_mut_ptr().as_mut().unwrap();
                requirements.sType = VkStructureType::VK_STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2;
                requirements.pNext = dedicated.as_mut_ptr() as *mut _;
            }
            let requirements_info = VkBufferMemoryRequirementsInfo2 {
                sType: VkStructureType::VK_STRUCTURE_TYPE_BUFFER_MEMORY_REQUIREMENTS_INFO_2,
                pNext: ptr::null(),
                buffer: buffer,
            };
            vkGetBufferMemoryRequirements2(device.handle(), &requirements_info, requirements.as_mut_ptr());
            let requirements = requirements.assume_init();
            // physical memory properties
            let memory_type_index = device.physical_device()
                .memory_type_index(&requirements.memoryRequirements, memory_property_flags)
                .ok_or_else(|| ErrorCode::SuitableBufferMemoryTypeNotFound)
                .unwrap();
            // allocation
            let mut memory = MaybeUninit::<VkDeviceMemory>::zeroed();
            {
                let use_device_address = (usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT as VkBufferUsageFlags) 
                    == VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT as VkBufferUsageFlags;
                let allocate_flags = if use_device_address {
                    VkMemoryAllocateFlagBits::VK_MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT as VkMemoryAllocateFlags
                } else {
                    0 as VkMemoryAllocateFlags
                };
                let allocate_flags_info = VkMemoryAllocateFlagsInfo {
                    sType: VkStructureType::VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO,
                    pNext: ptr::null(),
                    flags: allocate_flags,
                    deviceMask: 0,
                };
                let allocate_info = VkMemoryAllocateInfo {
                    sType: VkStructureType::VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO,
                    pNext: &allocate_flags_info as *const _ as *const c_void,
                    allocationSize: requirements.memoryRequirements.size,
                    memoryTypeIndex: memory_type_index,
                };
                vkAllocateMemory(device.handle(), &allocate_info, ptr::null(), memory.as_mut_ptr())
                    .into_result()
                    .unwrap();
            }
            let memory = memory.assume_init();
            // binding
            vkBindBufferMemory(device.handle(), buffer, memory, 0)
                .into_result()
                .unwrap();
            let buffer_memory = DedicatedBufferMemory { 
                buffer: buffer,
                memory: memory,
                device: Arc::clone(device),
                size: size,
            };
            Ok(Arc::new(buffer_memory))
        }
    }

    #[inline]
    pub fn buffer(&self) -> VkBuffer {
        self.buffer
    }

    #[inline]
    pub fn memory(&self) -> VkDeviceMemory {
        self.memory
    }

    #[inline]
    pub fn device(&self) -> &Arc<Device> {
        &self.device
    }

    #[inline]
    pub fn size(&self) -> VkDeviceSize {
        self.size
    }

    pub fn buffer_device_address(&self) -> VkDeviceAddress {
        unsafe {
            let address_info = VkBufferDeviceAddressInfo {
                sType: VkStructureType::VK_STRUCTURE_TYPE_BUFFER_DEVICE_ADDRESS_INFO,
                pNext: ptr::null(),
                buffer: self.buffer(),
            };
            vkGetBufferDeviceAddress(self.device.handle(), &address_info)
        }
    }
}

impl Drop for DedicatedBufferMemory {
    fn drop(&mut self) {
        unsafe {
            log_debug!("Drop DedicatedBufferMemory");
            vkDestroyBuffer(self.device.handle(), self.buffer, ptr::null());
            vkFreeMemory(self.device.handle(), self.memory, ptr::null());
        }
    }
}

pub struct DedicatedStagingBuffer {
    command_pool: Arc<CommandPool>,
    host_buffer_memory: Arc<DedicatedBufferMemory>,
    device_buffer_memory: Arc<DedicatedBufferMemory>,
    copying_command_buffer: Arc<CommandBuffer>,
    size: VkDeviceSize,
}

impl DedicatedStagingBuffer {
    pub fn new(command_pool: &Arc<CommandPool>, 
    device_buffer_usage: VkBufferUsageFlags, 
    device_memory_properties: VkMemoryPropertyFlags,
    size: VkDeviceSize,
) -> Result<Arc<Self>> {
        unsafe {
            let device = command_pool.queue().device();
            let host_buffer_memory = DedicatedBufferMemory::new(
                device,
                VK_BUFFER_USAGE_TRANSFER_SRC_BIT as VkBufferUsageFlags,
                VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT as VkMemoryPropertyFlags
                    | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT as VkMemoryPropertyFlags,
                size,
            )?;
            let device_buffer_memory = DedicatedBufferMemory::new(
                device,
                device_buffer_usage
                    | VK_BUFFER_USAGE_TRANSFER_DST_BIT as VkBufferUsageFlags,
                device_memory_properties,
                size,
            )?;
            let command_buffer = CommandBufferBuilder::new(command_pool).build(|command_buffer| {
                let copy_region = VkBufferCopy::new(0, size);
                vkCmdCopyBuffer(
                    command_buffer,
                    host_buffer_memory.buffer(),
                    device_buffer_memory.buffer(),
                    1,
                    &copy_region,
                );
            });
            let staging_buffer = DedicatedStagingBuffer {
                command_pool: Arc::clone(command_pool),
                host_buffer_memory,
                device_buffer_memory,
                copying_command_buffer: command_buffer,
                size,
            };
            Ok(Arc::new(staging_buffer))
        }
    }

    pub fn write(&self, src: *const c_void, size: usize) {
        unsafe {
            let device = self.command_pool.queue().device();
            let host_buffer_memory = &self.host_buffer_memory;
            let mut mapped = MaybeUninit::<*mut c_void>::zeroed();
            vkMapMemory(device.handle(), host_buffer_memory.memory(), 0, size as VkDeviceSize, 0, mapped.as_mut_ptr())
                .into_result()
                .unwrap();
            let mapped = mapped.assume_init();
            std::ptr::copy_nonoverlapping(src, mapped, size);
            vkUnmapMemory(device.handle(), host_buffer_memory.memory());
            self.copying_command_buffer
                .submit_then_wait(VK_PIPELINE_STAGE_TRANSFER_BIT as VkPipelineStageFlags);
        }
    }

    pub unsafe fn update(&self, size: VkDeviceSize, func: impl FnOnce(*mut c_void)) {
        assert_eq!(size, self.size);
        let device = self.command_pool.queue().device();
        let host_buffer_memory = &self.host_buffer_memory;
        let mut mapped = MaybeUninit::<*mut c_void>::zeroed();
        vkMapMemory(device.handle(), host_buffer_memory.memory(), 0, size, 0, mapped.as_mut_ptr())
            .into_result()
            .unwrap();
        let mapped = mapped.assume_init();
        func(mapped);
        vkUnmapMemory(device.handle(), host_buffer_memory.memory());
        self.copying_command_buffer
            .submit_then_wait(VK_PIPELINE_STAGE_TRANSFER_BIT as VkPipelineStageFlags);
    }

    #[inline]
    pub fn host_buffer_memory(&self) -> &Arc<DedicatedBufferMemory> {
        &self.host_buffer_memory
    }

    #[inline]
    pub fn device_buffer_memory(&self) -> &Arc<DedicatedBufferMemory> {
        &self.device_buffer_memory
    }
}

pub struct UniformBuffer {
    staging_buffer: Arc<DedicatedStagingBuffer>,
}

impl UniformBuffer {
    pub fn new<Model>(command_pool: &Arc<CommandPool>, model: &Vec<Model>) -> Result<Arc<Self>> {
        unsafe {
            Self::init(command_pool, model)
        }
    }

    unsafe fn init<Model>(command_pool: &Arc<CommandPool>, model: &Vec<Model>) -> Result<Arc<Self>> {
        let size = std::mem::size_of::<Model>() * model.len();
        let staging_buffer = DedicatedStagingBuffer::new(command_pool, 
            VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT as VkBufferUsageFlags,
            VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT as VkMemoryPropertyFlags,
            size as VkDeviceSize,
        )
            .unwrap();
        staging_buffer.write(model.as_ptr() as *const _ as *const c_void, size);
        let uniform_buffer = UniformBuffer {
            staging_buffer,
        };
        Ok(Arc::new(uniform_buffer))
    }

    #[inline]
    pub fn device_buffer_memory(&self) -> &Arc<DedicatedBufferMemory> {
        self.staging_buffer.device_buffer_memory()
    }

    pub fn update<Model>(&self, model: &Vec<Model>) {
        let size = std::mem::size_of::<Model>() * model.len();
        assert_eq!(size as VkDeviceSize, self.staging_buffer.host_buffer_memory().size());
        self.staging_buffer.write(model.as_ptr() as *const _ as *const c_void, size);
    }
}

pub struct StorageBuffer {
    staging_buffer: Arc<DedicatedStagingBuffer>,
}

impl StorageBuffer {
    pub fn new<Model>(
        command_pool: &Arc<CommandPool>, 
        model: &Vec<Model>,
    ) -> Result<Arc<Self>> {
        unsafe {
            Self::init(command_pool, model)
        }
    }

    unsafe fn init<Model>(
        command_pool: &Arc<CommandPool>, 
        model: &Vec<Model>,
    ) -> Result<Arc<Self>> {
        let size = std::mem::size_of::<Model>() * model.len();
        let staging_buffer = DedicatedStagingBuffer::new(command_pool, 
            VK_BUFFER_USAGE_STORAGE_BUFFER_BIT as VkBufferUsageFlags,
            VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT as VkMemoryPropertyFlags,
            size as VkDeviceSize,
        )
            .unwrap();
        staging_buffer.write(model.as_ptr() as *const _ as *const c_void, size);
        let storage_buffer = StorageBuffer {
            staging_buffer,
        };
        Ok(Arc::new(storage_buffer))
    }

    #[inline]
    pub fn device_buffer_memory(&self) -> &Arc<DedicatedBufferMemory> {
        self.staging_buffer.device_buffer_memory()
    }

    pub fn update<Model>(&self, model: &Vec<Model>) {
        let size = std::mem::size_of::<Model>() * model.len();
        assert_eq!(size as VkDeviceSize, self.staging_buffer.host_buffer_memory().size());
        self.staging_buffer.write(model.as_ptr() as *const _ as *const c_void, size);
    }
}