apple-log 0.5.0

Safe Rust bindings for Apple's os / OSLog APIs on macOS
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
126
127
128
129
130
131

//! API-surface coverage harness for `apple-log`.

#![allow(clippy::cast_precision_loss, clippy::iter_on_single_items)]

use std::collections::BTreeSet;
use std::path::PathBuf;
use std::process::Command;

fn sdk_root() -> PathBuf {
    let out = Command::new("xcrun")
        .args(["--sdk", "macosx", "--show-sdk-path"])
        .output()
        .expect("xcrun");
    assert!(out.status.success());
    PathBuf::from(String::from_utf8(out.stdout).unwrap().trim().to_string())
}

fn read_header(rel: &str) -> String {
    let p = sdk_root().join(rel);
    std::fs::read_to_string(&p).unwrap_or_else(|e| panic!("read {}: {e}", p.display()))
}

#[test]
fn os_log_symbols_present_in_header() {
    let header = read_header("usr/include/os/log.h");
    for sym in &[
        "OS_LOG_DEFAULT",
        "OS_LOG_DISABLED",
        "os_log_create",
        "os_log_with_type",
        "os_log_info",
        "os_log_debug",
        "os_log_error",
        "os_log_fault",
        "os_log_info_enabled",
        "os_log_debug_enabled",
        "os_log_type_t",
        "OS_LOG_TYPE_DEFAULT",
        "OS_LOG_TYPE_INFO",
        "OS_LOG_TYPE_DEBUG",
        "OS_LOG_TYPE_ERROR",
        "OS_LOG_TYPE_FAULT",
    ] {
        assert!(header.contains(sym), "os/log.h missing {sym:?}");
    }
}

#[test]
fn signpost_symbols_present_in_header() {
    let header = read_header("usr/include/os/signpost.h");
    for sym in &[
        "os_signpost_id_generate",
        "os_signpost_id_make_with_pointer",
        "os_signpost_enabled",
        "os_signpost_event_emit",
        "os_signpost_interval_begin",
        "os_signpost_animation_interval_begin",
        "os_signpost_interval_end",
        "OS_SIGNPOST_ID_NULL",
        "OS_SIGNPOST_ID_INVALID",
        "OS_SIGNPOST_ID_EXCLUSIVE",
        "OS_LOG_CATEGORY_POINTS_OF_INTEREST",
        "OS_LOG_CATEGORY_DYNAMIC_TRACING",
        "OS_LOG_CATEGORY_DYNAMIC_STACK_TRACING",
    ] {
        assert!(header.contains(sym), "os/signpost.h missing {sym:?}");
    }
}

#[test]
fn activity_symbols_present_in_header() {
    let header = read_header("usr/include/os/activity.h");
    for sym in &[
        "OS_ACTIVITY_CURRENT",
        "OS_ACTIVITY_NONE",
        "OS_ACTIVITY_FLAG_DEFAULT",
        "OS_ACTIVITY_FLAG_DETACHED",
        "OS_ACTIVITY_FLAG_IF_NONE_PRESENT",
        "os_activity_apply_f",
        "os_activity_scope_enter",
        "os_activity_scope_leave",
        "os_activity_get_identifier",
    ] {
        assert!(header.contains(sym), "os/activity.h missing {sym:?}");
    }
}

#[test]
fn os_atomic_symbols_present_in_header() {
    let header = read_header("usr/include/libkern/OSAtomicDeprecated.h");
    for sym in &[
        "OSAtomicAdd32",
        "OSAtomicCompareAndSwap32",
        "OSAtomicCompareAndSwap64",
        "OSAtomicCompareAndSwapPtr",
        "OSAtomicTestAndSet",
        "OSAtomicTestAndClear",
        "OSAtomicFifoEnqueue",
        "OSAtomicFifoDequeue",
    ] {
        assert!(header.contains(sym), "OSAtomicDeprecated.h missing {sym:?}");
    }
    let queue_header = read_header("usr/include/libkern/OSAtomicQueue.h");
    for sym in &["OSAtomicEnqueue", "OSAtomicDequeue", "OSQueueHead"] {
        assert!(queue_header.contains(sym), "OSAtomicQueue.h missing {sym:?}");
    }
}

#[test]
fn rust_constants_match_apple_values() {
    use apple_log::{
        Level, SignpostId, CATEGORY_DYNAMIC_STACK_TRACING, CATEGORY_DYNAMIC_TRACING,
        CATEGORY_POINTS_OF_INTEREST,
    };

    assert_eq!(Level::Default as i32, 0x00);
    assert_eq!(Level::Info as i32, 0x01);
    assert_eq!(Level::Debug as i32, 0x02);
    assert_eq!(Level::Error as i32, 0x10);
    assert_eq!(Level::Fault as i32, 0x11);

    assert_eq!(SignpostId::NULL.as_u64(), 0);
    assert_eq!(SignpostId::INVALID.as_u64(), u64::MAX);
    assert_eq!(SignpostId::EXCLUSIVE.as_u64(), 0xEEEE_B0B5_B2B2_EEEE);

    assert_eq!(CATEGORY_POINTS_OF_INTEREST, "PointsOfInterest");
    assert_eq!(CATEGORY_DYNAMIC_TRACING, "DynamicTracing");
    assert_eq!(CATEGORY_DYNAMIC_STACK_TRACING, "DynamicStackTracing");

    let _ = BTreeSet::<u64>::new();
}