capsule 0.1.5

A framework for network function development. Written in Rust, inspired by NetBricks and built on Intel's Data Plane Development Kit.
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
132
133
134
135
136
137
138
139
140
141

/*
* Copyright 2019 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
*/

pub(crate) use capsule_ffi::*;

use crate::warn;
use anyhow::Result;
use std::error::Error;
use std::ffi::{CStr, CString};
use std::os::raw;
use std::ptr::NonNull;

/// Simplify `*const c_char` or [c_char] to `&str` conversion.
pub(crate) trait AsStr {
    fn as_str(&self) -> &str;
}

impl AsStr for *const raw::c_char {
    #[inline]
    fn as_str(&self) -> &str {
        unsafe {
            CStr::from_ptr(*self).to_str().unwrap_or_else(|_| {
                warn!("invalid UTF8 data");
                Default::default()
            })
        }
    }
}

impl AsStr for [raw::c_char] {
    #[inline]
    fn as_str(&self) -> &str {
        unsafe {
            CStr::from_ptr(self.as_ptr()).to_str().unwrap_or_else(|_| {
                warn!("invalid UTF8 data");
                Default::default()
            })
        }
    }
}

/// Simplify `String` and `&str` to `CString` conversion.
pub(crate) trait ToCString {
    fn into_cstring(self) -> CString;
}

impl ToCString for String {
    #[inline]
    fn into_cstring(self) -> CString {
        CString::new(self).unwrap()
    }
}

impl ToCString for &str {
    #[inline]
    fn into_cstring(self) -> CString {
        CString::new(self).unwrap()
    }
}

/// Simplify dpdk FFI binding's return to a `Result` type.
///
/// # Example
///
/// ```
/// ffi::rte_eth_add_tx_callback(..., ..., ..., ...)
///     .into_result(|_| {
///         DpdkError::new()
/// })?;
/// ```
pub(crate) trait ToResult {
    type Ok;

    fn into_result<E, F>(self, f: F) -> Result<Self::Ok>
    where
        E: Error + Send + Sync + 'static,
        F: FnOnce(Self) -> E,
        Self: Sized;
}

impl<T> ToResult for *mut T {
    type Ok = NonNull<T>;

    #[inline]
    fn into_result<E, F>(self, f: F) -> Result<Self::Ok>
    where
        E: Error + Send + Sync + 'static,
        F: FnOnce(Self) -> E,
    {
        NonNull::new(self).ok_or_else(|| f(self).into())
    }
}

impl<T> ToResult for *const T {
    type Ok = *const T;

    #[inline]
    fn into_result<E, F>(self, f: F) -> Result<Self::Ok>
    where
        E: Error + Send + Sync + 'static,
        F: FnOnce(Self) -> E,
    {
        if self.is_null() {
            Err(f(self).into())
        } else {
            Ok(self)
        }
    }
}

impl ToResult for raw::c_int {
    type Ok = u32;

    #[inline]
    fn into_result<E, F>(self, f: F) -> Result<Self::Ok>
    where
        E: Error + Send + Sync + 'static,
        F: FnOnce(Self) -> E,
    {
        if self >= 0 {
            Ok(self as u32)
        } else {
            Err(f(self).into())
        }
    }
}