/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ /*! Tester for WebGPU * It enumerates the available backends on the system, * and run the tests through them. * * Test requirements: * - all IDs have the backend `Empty` * - all expected buffers have `MAP_READ` usage * - last action is `Submit` * - no swapchain use !*/ use player::{GlobalPlay, IdentityPassThroughFactory}; use std::{ fs::{read_to_string, File}, io::{Read, Seek, SeekFrom}, path::{Path, PathBuf}, ptr, slice, }; #[derive(serde::Deserialize)] struct RawId { index: u32, epoch: u32, } #[derive(serde::Deserialize)] enum ExpectedData { Raw(Vec), File(String, usize), } impl ExpectedData { fn len(&self) -> usize { match self { ExpectedData::Raw(vec) => vec.len(), ExpectedData::File(_, size) => *size, } } } #[derive(serde::Deserialize)] struct Expectation { name: String, buffer: RawId, offset: wgt::BufferAddress, data: ExpectedData, } #[derive(serde::Deserialize)] struct Test<'a> { features: wgt::Features, expectations: Vec, actions: Vec>, } extern "C" fn map_callback(status: wgc::resource::BufferMapAsyncStatus, _user_data: *mut u8) { match status { wgc::resource::BufferMapAsyncStatus::Success => (), _ => panic!("Unable to map"), } } impl Test<'_> { fn load(path: PathBuf, backend: wgt::Backend) -> Self { let backend_name = match backend { wgt::Backend::Vulkan => "Vulkan", wgt::Backend::Metal => "Metal", wgt::Backend::Dx12 => "Dx12", wgt::Backend::Dx11 => "Dx11", wgt::Backend::Gl => "Gl", _ => unreachable!(), }; let string = read_to_string(path).unwrap().replace("Empty", backend_name); ron::de::from_str(&string).unwrap() } fn run( self, dir: &Path, global: &wgc::hub::Global, adapter: wgc::id::AdapterId, test_num: u32, ) { let backend = adapter.backend(); let device = wgc::id::TypedId::zip(test_num, 0, backend); let (_, error) = wgc::gfx_select!(adapter => global.adapter_request_device( adapter, &wgt::DeviceDescriptor { label: None, features: self.features | wgt::Features::MAPPABLE_PRIMARY_BUFFERS, limits: wgt::Limits::default(), }, None, device )); if let Some(e) = error { panic!("{:?}", e); } let mut command_buffer_id_manager = wgc::hub::IdentityManager::default(); println!("\t\t\tRunning..."); for action in self.actions { wgc::gfx_select!(device => global.process(device, action, dir, &mut command_buffer_id_manager)); } println!("\t\t\tMapping..."); for expect in &self.expectations { let buffer = wgc::id::TypedId::zip(expect.buffer.index, expect.buffer.epoch, backend); wgc::gfx_select!(device => global.buffer_map_async( buffer, expect.offset .. expect.offset+expect.data.len() as wgt::BufferAddress, wgc::resource::BufferMapOperation { host: wgc::device::HostMap::Read, callback: map_callback, user_data: ptr::null_mut(), } )) .unwrap(); } println!("\t\t\tWaiting..."); wgc::gfx_select!(device => global.device_poll(device, true)).unwrap(); for expect in self.expectations { println!("\t\t\tChecking {}", expect.name); let buffer = wgc::id::TypedId::zip(expect.buffer.index, expect.buffer.epoch, backend); let ptr = wgc::gfx_select!(device => global.buffer_get_mapped_range(buffer, expect.offset, None)) .unwrap(); let contents = unsafe { slice::from_raw_parts(ptr, expect.data.len()) }; let expected_data = match expect.data { ExpectedData::Raw(vec) => vec, ExpectedData::File(name, size) => { let mut bin = vec![0; size]; let mut file = File::open(dir.join(name)).unwrap(); file.seek(SeekFrom::Start(expect.offset)).unwrap(); file.read_exact(&mut bin[..]).unwrap(); bin } }; if &expected_data[..] != contents { panic!("Test expectation is not met!"); } } wgc::gfx_select!(device => global.clear_backend(())); } } #[derive(serde::Deserialize)] struct Corpus { backends: wgt::BackendBit, tests: Vec, } const BACKENDS: &[wgt::Backend] = &[ wgt::Backend::Vulkan, wgt::Backend::Metal, wgt::Backend::Dx12, wgt::Backend::Dx11, wgt::Backend::Gl, ]; impl Corpus { fn run_from(path: PathBuf) { println!("Corpus {:?}", path); let dir = path.parent().unwrap(); let corpus: Corpus = ron::de::from_reader(File::open(&path).unwrap()).unwrap(); let global = wgc::hub::Global::new("test", IdentityPassThroughFactory, corpus.backends); for &backend in BACKENDS { if !corpus.backends.contains(backend.into()) { continue; } let adapter = match global.request_adapter( &wgc::instance::RequestAdapterOptions { power_preference: wgt::PowerPreference::LowPower, compatible_surface: None, }, wgc::instance::AdapterInputs::IdSet( &[wgc::id::TypedId::zip(0, 0, backend)], |id| id.backend(), ), ) { Ok(adapter) => adapter, Err(_) => continue, }; println!("\tBackend {:?}", backend); let supported_features = wgc::gfx_select!(adapter => global.adapter_features(adapter)).unwrap(); let mut test_num = 0; for test_path in &corpus.tests { println!("\t\tTest '{:?}'", test_path); let test = Test::load(dir.join(test_path), adapter.backend()); if !supported_features.contains(test.features) { println!( "\t\tSkipped due to missing features {:?}", test.features - supported_features ); continue; } test.run(dir, &global, adapter, test_num); test_num += 1; } } } } #[test] fn test_api() { wgpu_subscriber::initialize_default_subscriber( std::env::var("WGPU_CHROME_TRACE") .as_ref() .map(Path::new) .ok(), ); Corpus::run_from(PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("tests/data/all.ron")) }