memfaultd 1.26.1

Memfault daemon for embedded Linux systems. Observability, logging, crash reporting, and updating all in one service. Learn more at https://docs.memfault.com/
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

//
// Copyright (c) Memfault, Inc.
// See License.txt for details
use std::fmt::{Debug, Display, Formatter, Result as FmtResult};
use std::str::FromStr;

use eyre::{eyre, ErrReport, Result};
use serde::{Deserialize, Serialize};

use crate::{
    reboot::reason_codes::RebootReasonCode, util::patterns::alphanum_slug_dots_colon_is_valid,
};

#[derive(Clone, PartialEq, Eq, Deserialize, Serialize)]
#[serde(untagged)]
pub enum RebootReason {
    Code(RebootReasonCode),
    Custom(RebootReasonString),
}

#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
pub struct RebootReasonString {
    unexpected: bool,
    name: String,
}

impl From<RebootReasonCode> for RebootReason {
    fn from(code: RebootReasonCode) -> RebootReason {
        RebootReason::Code(code)
    }
}

impl FromStr for RebootReasonString {
    type Err = ErrReport;
    fn from_str(s: &str) -> Result<RebootReasonString> {
        // Leading '!' indicates an unexpected reboot reason
        if let Some(stripped) = s.strip_prefix('!') {
            if stripped.is_empty() {
                Err(eyre!("\"!\" on its own is not a valid reboot reaosn!"))
            } else {
                match alphanum_slug_dots_colon_is_valid(stripped, 64) {
                    Ok(()) => Ok(RebootReasonString {
                        unexpected: true,
                        name: stripped.to_string(),
                    }),
                    Err(e) => Err(e),
                }
            }
        } else {
            match alphanum_slug_dots_colon_is_valid(s, 64) {
                Ok(()) => Ok(RebootReasonString {
                    unexpected: false,
                    name: s.to_string(),
                }),
                Err(e) => Err(e),
            }
        }
    }
}

impl FromStr for RebootReason {
    type Err = ErrReport;

    fn from_str(s: &str) -> Result<RebootReason> {
        match u32::from_str(s) {
            Ok(code) => match RebootReasonCode::from_repr(code) {
                Some(reset_code) => Ok(RebootReason::Code(reset_code)),
                None => Ok(RebootReason::Code(RebootReasonCode::Unknown)),
            },
            // If the reboot reason isn't parse-able to a u32, it's custom
            Err(_) => match RebootReasonString::from_str(s) {
                Ok(reason) => Ok(RebootReason::Custom(reason)),
                Err(e) => Err(eyre!("Failed to parse custom reboot reason: {}", e)),
            },
        }
    }
}

impl Display for RebootReason {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        match self {
            RebootReason::Code(c) => write!(f, "{}", (*c as u32)),
            RebootReason::Custom(RebootReasonString { unexpected, name }) => {
                if *unexpected {
                    write!(f, "!{}", name)
                } else {
                    write!(f, "{}", name)
                }
            }
        }
    }
}

impl Debug for RebootReason {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        match self {
            RebootReason::Code(c) => write!(f, "{} ({})", (*c as u32), c),
            RebootReason::Custom(RebootReasonString { unexpected, name }) => write!(
                f,
                "{} ({})",
                name,
                if *unexpected {
                    "unexpected reboot"
                } else {
                    "expected reboot"
                }
            ),
        }
    }
}