statevec-api 0.1.0

Runtime host APIs and plugin ABI types for StateVec domain plugins.
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
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

// Copyright 2026 Jumpex Technology.
// SPDX-License-Identifier: Apache-2.0

#[cfg(feature = "throughput-probe")]
mod imp {
    use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};

    static RUNTIME_HOST_WITH_READ_TYPED_BY_PK_COUNT: AtomicU64 = AtomicU64::new(0);
    static RUNTIME_HOST_UPDATE_TYPED_BY_PK_COUNT: AtomicU64 = AtomicU64::new(0);
    static TYPED_TX_WITH_READ_TYPED_BY_PK_COUNT: AtomicU64 = AtomicU64::new(0);
    static TYPED_TX_UPDATE_TYPED_BY_PK_COUNT: AtomicU64 = AtomicU64::new(0);
    static TYPED_TX_UPDATE_OR_CREATE_TYPED_BY_PK_COUNT: AtomicU64 = AtomicU64::new(0);
    static DUMP_ONCE: AtomicBool = AtomicBool::new(false);

    #[inline(always)]
    fn load(counter: &AtomicU64) -> u64 {
        counter.load(Ordering::Relaxed)
    }

    #[inline(always)]
    fn store(counter: &AtomicU64, value: u64) {
        counter.store(value, Ordering::Relaxed);
    }

    #[inline(always)]
    fn add(counter: &AtomicU64, value: u64) {
        counter.fetch_add(value, Ordering::Relaxed);
    }

    pub struct RuntimeApiProbe;

    impl RuntimeApiProbe {
        pub fn reset() {
            store(&RUNTIME_HOST_WITH_READ_TYPED_BY_PK_COUNT, 0);
            store(&RUNTIME_HOST_UPDATE_TYPED_BY_PK_COUNT, 0);
            store(&TYPED_TX_WITH_READ_TYPED_BY_PK_COUNT, 0);
            store(&TYPED_TX_UPDATE_TYPED_BY_PK_COUNT, 0);
            store(&TYPED_TX_UPDATE_OR_CREATE_TYPED_BY_PK_COUNT, 0);
            DUMP_ONCE.store(false, Ordering::Relaxed);
        }

        pub fn dump_to_stderr_once(label: &str) {
            if DUMP_ONCE.swap(true, Ordering::Relaxed) {
                return;
            }
            eprintln!(
                concat!(
                    "[statevec_api_probe] label={label}",
                    " runtime_host_with_read_typed_by_pk_count={runtime_host_with_read_typed_by_pk_count}",
                    " runtime_host_update_typed_by_pk_count={runtime_host_update_typed_by_pk_count}",
                    " typed_tx_with_read_typed_by_pk_count={typed_tx_with_read_typed_by_pk_count}",
                    " typed_tx_update_typed_by_pk_count={typed_tx_update_typed_by_pk_count}",
                    " typed_tx_update_or_create_typed_by_pk_count={typed_tx_update_or_create_typed_by_pk_count}"
                ),
                label = label,
                runtime_host_with_read_typed_by_pk_count =
                    load(&RUNTIME_HOST_WITH_READ_TYPED_BY_PK_COUNT),
                runtime_host_update_typed_by_pk_count =
                    load(&RUNTIME_HOST_UPDATE_TYPED_BY_PK_COUNT),
                typed_tx_with_read_typed_by_pk_count = load(&TYPED_TX_WITH_READ_TYPED_BY_PK_COUNT),
                typed_tx_update_typed_by_pk_count = load(&TYPED_TX_UPDATE_TYPED_BY_PK_COUNT),
                typed_tx_update_or_create_typed_by_pk_count =
                    load(&TYPED_TX_UPDATE_OR_CREATE_TYPED_BY_PK_COUNT),
            );
        }
    }

    #[inline(always)]
    pub(crate) fn on_runtime_host_with_read_typed_by_pk() {
        add(&RUNTIME_HOST_WITH_READ_TYPED_BY_PK_COUNT, 1);
    }

    #[inline(always)]
    pub(crate) fn on_runtime_host_update_typed_by_pk() {
        add(&RUNTIME_HOST_UPDATE_TYPED_BY_PK_COUNT, 1);
    }

    #[inline(always)]
    pub(crate) fn on_typed_tx_with_read_typed_by_pk() {
        add(&TYPED_TX_WITH_READ_TYPED_BY_PK_COUNT, 1);
    }

    #[inline(always)]
    pub(crate) fn on_typed_tx_update_typed_by_pk() {
        add(&TYPED_TX_UPDATE_TYPED_BY_PK_COUNT, 1);
    }

    #[inline(always)]
    pub(crate) fn on_typed_tx_update_or_create_typed_by_pk() {
        add(&TYPED_TX_UPDATE_OR_CREATE_TYPED_BY_PK_COUNT, 1);
    }
}

#[cfg(not(feature = "throughput-probe"))]
mod imp {
    pub struct RuntimeApiProbe;

    impl RuntimeApiProbe {
        pub fn reset() {}

        pub fn dump_to_stderr_once(_label: &str) {}
    }

    #[inline(always)]
    pub(crate) fn on_runtime_host_with_read_typed_by_pk() {}

    #[inline(always)]
    pub(crate) fn on_runtime_host_update_typed_by_pk() {}

    #[inline(always)]
    pub(crate) fn on_typed_tx_with_read_typed_by_pk() {}

    #[inline(always)]
    pub(crate) fn on_typed_tx_update_typed_by_pk() {}

    #[inline(always)]
    pub(crate) fn on_typed_tx_update_or_create_typed_by_pk() {}
}

pub use imp::RuntimeApiProbe;
pub(crate) use imp::{
    on_runtime_host_update_typed_by_pk, on_runtime_host_with_read_typed_by_pk,
    on_typed_tx_update_or_create_typed_by_pk, on_typed_tx_update_typed_by_pk,
    on_typed_tx_with_read_typed_by_pk,
};