libbpf-cargo 0.26.2

Cargo plugin to build bpf programs
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

//! Utility functionality for working with generated skeletons.

use std::error::Error;
use std::fmt::Arguments;
use std::fmt::Debug;
use std::fmt::Result;

use tracing::field::Field;
use tracing::field::Visit;
use tracing::Event;
use tracing::Subscriber;
use tracing_subscriber::fmt::format::FormatFields;
use tracing_subscriber::fmt::format::Writer;
use tracing_subscriber::fmt::FmtContext;
use tracing_subscriber::fmt::FormatEvent;
use tracing_subscriber::registry::LookupSpan;


/// A visitor for "extracting" captured field values from a tracing
/// span/event.
#[derive(Debug)]
struct Visitor<'w> {
    writer: Writer<'w>,
}

impl<'w> Visitor<'w> {
    fn new(writer: Writer<'w>) -> Self {
        Self { writer }
    }

    fn record_value(&mut self, field: &Field, value: Arguments<'_>) {
        let name = field.name();
        // Special case the field "message", only printing the value and
        // not the name.
        if name == "message" {
            let _result = writeln!(self.writer, "cargo:warning={value}");
        } else {
            let _result = writeln!(self.writer, "cargo:warning={name}={value}");
        }
    }
}

impl Visit for Visitor<'_> {
    fn record_debug(&mut self, field: &Field, value: &dyn Debug) {
        self.record_value(field, format_args!("{value:?}"))
    }

    fn record_f64(&mut self, field: &Field, value: f64) {
        self.record_value(field, format_args!("{value}"))
    }

    fn record_i64(&mut self, field: &Field, value: i64) {
        self.record_value(field, format_args!("{value}"))
    }

    fn record_u64(&mut self, field: &Field, value: u64) {
        self.record_value(field, format_args!("{value}"))
    }

    fn record_i128(&mut self, field: &Field, value: i128) {
        self.record_value(field, format_args!("{value}"))
    }

    fn record_u128(&mut self, field: &Field, value: u128) {
        self.record_value(field, format_args!("{value}"))
    }

    fn record_bool(&mut self, field: &Field, value: bool) {
        self.record_value(field, format_args!("{value}"))
    }

    fn record_str(&mut self, field: &Field, value: &str) {
        self.record_value(field, format_args!("{value}"))
    }

    fn record_error(&mut self, field: &Field, value: &(dyn Error + 'static)) {
        self.record_value(field, format_args!("{value}"))
    }
}


/// A `tracing` formatter intended for surfacing compiler
/// warnings/messages from within a build script.
///
/// ```no_run
/// # use libbpf_cargo::SkeletonBuilder;
/// # use libbpf_cargo::util::CargoWarningFormatter;
/// let () = tracing_subscriber::fmt()
///     .event_format(CargoWarningFormatter)
///     .init();
///
/// // Generate and build the skeleton, which may emit compiler
/// // warnings.
/// SkeletonBuilder::new()
///     // [...]
///     .build()
///     .unwrap();
/// ```
#[derive(Debug)]
pub struct CargoWarningFormatter;

impl<S, N> FormatEvent<S, N> for CargoWarningFormatter
where
    S: Subscriber + for<'a> LookupSpan<'a>,
    N: for<'a> FormatFields<'a> + 'static,
{
    fn format_event(
        &self,
        _ctx: &FmtContext<'_, S, N>,
        writer: Writer<'_>,
        event: &Event<'_>,
    ) -> Result {
        let mut visitor = Visitor::new(writer);
        let () = event.record(&mut visitor);
        Ok(())
    }
}