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

// SPDX-License-Identifier: CC0-1.0

//! FFI related to jets
// Typically, the only things in the sys crate are the
// FFI bindings. The high level code should be in the
// main crate.
// We don't follow this practice in the library of as now

pub mod c_env;
pub mod c_frame;
pub mod frame_ffi;
#[rustfmt::skip] pub mod jets_ffi;
#[rustfmt::skip] pub mod jets_wrapper;

pub use c_env::{CElementsTxEnv, CTapEnv, CTransaction};
pub use c_frame::{ffi_bytes_size, round_u_word};
pub use frame_ffi::CFrameItem;

// The bindings use elements_ffi instead of jets_ffi.
pub use jets_ffi as elements_ffi;

use crate::c_jets::c_env::{CRawBuffer, CRawInput, CRawOutput, CRawTapEnv, CRawTransaction};

#[cfg(feature = "test-utils")]
pub mod exec_ffi;

/// sanity checks for using the types.
/// We are not using the internal representation of the types at all, but
/// we do care about the size and alignments of the types.
///
/// This will also us detect whenever there is a change in the underlying C representation
pub fn sanity_checks() -> bool {
    unsafe {
        // Check that UWORD maps correctly to usize. UWORD maps to uint_fast16_t
        // which is at least 16 bits, and is the same size as usize on all
        // platforms 32 and 64 platforms.
        if std::mem::size_of::<usize>() != crate::ffi::c_sizeof_UWORD
            || std::mem::align_of::<usize>() != crate::ffi::c_alignof_UWORD
        {
            return false;
        }

        if std::mem::size_of::<CFrameItem>() != frame_ffi::c_sizeof_frameItem
            || std::mem::size_of::<CRawBuffer>() != c_env::c_sizeof_rawBuffer
            || std::mem::size_of::<CRawInput>() != c_env::c_sizeof_rawInput
            || std::mem::size_of::<CRawOutput>() != c_env::c_sizeof_rawOutput
            || std::mem::size_of::<CRawTransaction>() != c_env::c_sizeof_rawTransaction
            || std::mem::size_of::<CElementsTxEnv>() != c_env::c_sizeof_txEnv
            || std::mem::size_of::<CRawTapEnv>() != c_env::c_sizeof_rawTapEnv
        {
            return false;
        }

        // Check alignments
        if std::mem::align_of::<CFrameItem>() != frame_ffi::c_alignof_frameItem
            || std::mem::align_of::<CRawBuffer>() != c_env::c_alignof_rawBuffer
            || std::mem::align_of::<CRawInput>() != c_env::c_alignof_rawInput
            || std::mem::align_of::<CRawOutput>() != c_env::c_alignof_rawOutput
            || std::mem::align_of::<CRawTransaction>() != c_env::c_alignof_rawTransaction
            || std::mem::align_of::<CElementsTxEnv>() != c_env::c_alignof_txEnv
            || std::mem::align_of::<CRawTapEnv>() != c_env::c_alignof_rawTapEnv
        {
            return false;
        }
    }
    true
}