jkunz
24157ffb64
Every decode error context that formatted its message eagerly now goes
through netlink-packet-core 0.9.0's lazy `ErrorContext::with_context`
(src/error.rs:17, Result impl :51-60): the `.context(format!(..))`,
`.context({ format!(..) })`, `.context(err(payload))` and
`.context(nla_err!(..))` sites, 344 in 66 files. `nla_err!` in
tc/filters/flower/mpls.rs returns an owned String so the closure can
return it. Literal contexts are unchanged.
A link dump Debug-formatted the IFLA_MAP, IFLA_STATS, IFLA_STATS64 and
IFLA_INET6_* payloads of every link on the success path (10 formats per
link). On the same captured RTM_NEWLINK dumps a link now decodes in about
6 us instead of about 60 us on musl, and about 4 us instead of 22 us on
glibc. Decoded values and error texts are unchanged; tests pin the
truncated IFLA_MAP error text and the zero-extended short IFLA_STATS64.
Rust crate for Netlink Route Protocol
The netlink-packet-route crate is designed to abstract Netlink route
protocol(rtnetlink) packet into Rust data types. The goal of
this crate is saving netlink user from reading Kernel Netlink codes.
This crate grouped Netlink route protocol into these modules:
link: NIC interface, similar toip linkcommand.address: IP address, similar toip addresscommand.route: Route, similar toip routecommand.rule: Route rule, similar toip rulecommand.tc: Traffic control, similar totccommand.neighbour: Neighbour, similar toip neighbourcommand.neighbour_table: Neighbour table, similar toip ntablecommand.nsid: Namespace, similar toip netnscommand.
Normally, you should use rtnetlink instead of using this
crate directly.
Development
-
Please use
git commit --signoffto append Signed-off-by trailer to commit message. -
For new source file, please append
// SPDX-License-Identifier: MITat the beginning with content of license new code to MIT license. -
No panic is allowed, please use
Result<>instead ofunwrap()orexpect(). -
Please run
cargo fmtandcargo clippybefore creating pull request. -
All struct/enum should be decorated by
#[non_exhaustive]to preserve API backwards compatibility unless explicit approval from maintainer. -
Unknown netlink attribute should be stored into
Other(DefaultNla)instead of breaking decoding. -
Please use unit test case to cover the serialize and deserialize of the changed netlink attribute. To capture the netlink raw bytes, you may use tcpdump/wireshark again the
nlmoninterface. For example:
modprobe nlmon
ip link add nl0 type nlmon
ip link set nl0 up
tcpdump -i nl0 -w netlink_capture_file.cap
# Then use wireshark to open this `netlink_capture_file.cap`
# Find out the packet you are interested,
# right click -> "Copy" -> "...as Hex Dump".
# You may use https://github.com/cathay4t/hex_to_rust to convert this
# hexdump to rust u8 array
-
The integration test(play with linux kernel netlink interface) should be placed into
rtnetlinkcrate. Current(netlink-packet-route) crate should only unit test case only. -
For certain netlink message which cannot captured by nlmon, please use Rust Debug and explain every bits in comment.
-
Optionally, please run
tools/test_cross_build.shto make sure your code is compilable on other platforms.