iceoryx2-pal-testing 0.9.1

iceoryx2: [internal] simple testing primitives
Documentation 
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

// Copyright (c) 2024 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

use alloc::vec;
use alloc::vec::Vec;

#[cfg(feature = "std")]
use std::sync::Mutex;
#[cfg(feature = "std")]
use std::sync::MutexGuard;

#[cfg(not(feature = "std"))]
use iceoryx2_pal_concurrency_sync::spin_lock::SpinLock as Mutex;
#[cfg(not(feature = "std"))]
use iceoryx2_pal_concurrency_sync::spin_lock::SpinLockGuard as MutexGuard;

static CREATION_COUNTER: Mutex<usize> = Mutex::new(0);
static DROP_COUNTER: Mutex<usize> = Mutex::new(0);

static DROP_ORDER: Mutex<Vec<usize>> = Mutex::new(vec![]);
static TRACKING_LOCK: Mutex<LifetimeTrackingState> = Mutex::new(LifetimeTrackingState {});

#[derive(Debug)]
pub struct LifetimeTrackingState {}

impl LifetimeTrackingState {
    pub fn number_of_living_instances(&self) -> usize {
        *CREATION_COUNTER.lock().unwrap_or_else(|e| e.into_inner())
            - *DROP_COUNTER.lock().unwrap_or_else(|e| e.into_inner())
    }

    pub fn drop_order(&self) -> Vec<usize> {
        DROP_ORDER.lock().unwrap_or_else(|e| e.into_inner()).clone()
    }
}

#[repr(C)]
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord)]
pub struct LifetimeTracker {
    pub value: usize,
}

impl Default for LifetimeTracker {
    fn default() -> Self {
        *CREATION_COUNTER.lock().unwrap_or_else(|e| e.into_inner()) += 1;

        Self { value: 0 }
    }
}

impl LifetimeTracker {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn new_with_value(value: usize) -> Self {
        let mut new_self = Self::new();
        new_self.value = value;
        new_self
    }

    pub fn start_tracking() -> MutexGuard<'static, LifetimeTrackingState> {
        let guard = TRACKING_LOCK.lock().unwrap_or_else(|e| e.into_inner());

        *CREATION_COUNTER.lock().unwrap_or_else(|e| e.into_inner()) = 0;
        *DROP_COUNTER.lock().unwrap_or_else(|e| e.into_inner()) = 0;
        DROP_ORDER.lock().unwrap_or_else(|e| e.into_inner()).clear();

        guard
    }
}

impl Clone for LifetimeTracker {
    fn clone(&self) -> Self {
        let mut new_self = Self::new();
        new_self.value = self.value;
        new_self
    }
}

impl Drop for LifetimeTracker {
    fn drop(&mut self) {
        *DROP_COUNTER.lock().unwrap_or_else(|e| e.into_inner()) += 1;
        DROP_ORDER
            .lock()
            .unwrap_or_else(|e| e.into_inner())
            .push(self.value);
    }
}