ipfixrw 0.1.0

IPFIX reader/writer library
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

use std::{
    cell::RefCell,
    collections::HashMap,
    rc::Rc,
    sync::{Arc, RwLock},
};

use crate::{
    information_elements::Formatter,
    parser::{
        DataRecordKey, DataRecordType, FieldSpecifier, OptionsTemplateRecord, TemplateRecord,
    },
};

#[derive(Clone, Debug)]
pub struct ExpandedFieldSpecifier {
    pub name: DataRecordKey,
    pub ty: DataRecordType,
    pub enterprise_number: Option<u32>,
    pub information_element_identifier: u16,
    pub field_length: u16,
}

impl ExpandedFieldSpecifier {
    /// Look up a DataRecordKey and DataRecordType for this
    /// information element from the formatter. If not present,
    /// returns Unrecognized/Bytes.
    fn from_field_spec(field_spec: &FieldSpecifier, formatter: &Formatter) -> Self {
        let (name, ty) = match formatter.get(&(
            field_spec.enterprise_number.unwrap_or(0),
            field_spec.information_element_identifier,
        )) {
            Some((name, ty)) => (DataRecordKey::Str(name), ty),
            None => (
                DataRecordKey::Unrecognized(field_spec.clone()),
                // TODO: this is probably not technically correct
                &DataRecordType::Bytes,
            ),
        };

        Self {
            name,
            ty: *ty,
            enterprise_number: field_spec.enterprise_number,
            information_element_identifier: field_spec.information_element_identifier,
            field_length: field_spec.field_length,
        }
    }
}

#[derive(Clone, Debug)]
pub enum Template {
    Template(Vec<ExpandedFieldSpecifier>),
    OptionsTemplate(Vec<ExpandedFieldSpecifier>),
}

pub trait TemplateStorage: std::fmt::Debug {
    fn get_template(&self, template_id: u16) -> Option<Template>;
    fn insert_template(&self, template_id: u16, template: Template);

    fn insert_template_records(&self, template_records: &[TemplateRecord], formatter: &Formatter) {
        for template in template_records {
            let expanded_template = Template::Template(
                template
                    .field_specifiers
                    .iter()
                    .map(|field_spec| {
                        ExpandedFieldSpecifier::from_field_spec(field_spec, formatter)
                    })
                    .collect(),
            );

            self.insert_template(template.template_id, expanded_template);
        }
    }

    // TODO: these should probably be treated differently
    fn insert_options_template_records(
        &self,
        template_records: &[OptionsTemplateRecord],
        formatter: &Formatter,
    ) {
        for template in template_records {
            let expanded_template = Template::OptionsTemplate(
                template
                    .field_specifiers
                    .iter()
                    .map(|field_spec| {
                        ExpandedFieldSpecifier::from_field_spec(field_spec, formatter)
                    })
                    .collect(),
            );
            self.insert_template(template.template_id, expanded_template);
        }
    }
}

impl<S: ::std::hash::BuildHasher> TemplateStorage for RefCell<HashMap<u16, Template, S>> {
    fn get_template(&self, template_id: u16) -> Option<Template> {
        self.borrow().get(&template_id).cloned()
    }
    fn insert_template(&self, template_id: u16, template: Template) {
        self.borrow_mut().insert(template_id, template);
    }
}

impl<S: ::std::hash::BuildHasher> TemplateStorage for Arc<RwLock<HashMap<u16, Template, S>>> {
    fn get_template(&self, template_id: u16) -> Option<Template> {
        self.read().unwrap().get(&template_id).cloned()
    }
    fn insert_template(&self, template_id: u16, template: Template) {
        self.write().unwrap().insert(template_id, template);
    }
}

pub type TemplateStore = Rc<dyn TemplateStorage>;