bp3d_debug/engine/
mod.rs

1// Copyright (c) 2024, BlockProject 3D
2//
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without modification,
6// are permitted provided that the following conditions are met:
7//
8//     * Redistributions of source code must retain the above copyright notice,
9//       this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above copyright notice,
11//       this list of conditions and the following disclaimer in the documentation
12//       and/or other materials provided with the distribution.
13//     * Neither the name of BlockProject 3D nor the names of its contributors
14//       may be used to endorse or promote products derived from this software
15//       without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29use std::sync::atomic::{AtomicBool, Ordering};
30
31mod default;
32
33pub trait Engine:
34    crate::logger::Logger + crate::profiler::Profiler + crate::trace::Tracer + Sync
35{
36}
37impl<T: crate::logger::Logger + crate::profiler::Profiler + crate::trace::Tracer + Sync> Engine
38    for T
39{
40}
41
42static ENGINE_INIT_FLAG: AtomicBool = AtomicBool::new(false);
43
44static mut ENGINE: &dyn Engine = &default::DefaultDebugger {};
45
46pub fn get() -> &'static dyn Engine {
47    unsafe { ENGINE }
48}
49
50pub fn set(engine: &'static dyn Engine) -> bool {
51    let flag = ENGINE_INIT_FLAG.load(Ordering::Relaxed);
52    if flag {
53        return false;
54    }
55    unsafe { ENGINE = engine };
56    ENGINE_INIT_FLAG.store(true, Ordering::Relaxed);
57    true
58}
59
60#[cfg(test)]
61mod tests {
62    use crate::trace::span::Id;
63    use std::num::NonZeroU32;
64
65    #[test]
66    fn basic() {
67        crate::engine::set(&crate::engine::default::DefaultDebugger {});
68        assert!(!crate::engine::set(
69            &crate::engine::default::DefaultDebugger {}
70        ));
71    }
72
73    #[test]
74    fn after_use() {
75        crate::engine::get().span_exit(Id::new(unsafe { NonZeroU32::new_unchecked(1) }, unsafe {
76            NonZeroU32::new_unchecked(1)
77        }));
78        assert!(!crate::engine::set(
79            &crate::engine::default::DefaultDebugger {}
80        ));
81    }
82}
bp3d_debug/engine/mod.rs

bp3d_debug/engine/
mod.rs
