feat(log): add compressed packet log

Resolves: #81

Author: BobAnkh

README.md

@@ -28,3 +28,56 @@ cargo run --example channel-xdp --release --features="camellia" # AF_XDP version
 cargo install flamegraph
 cargo flamegraph --root --example channel
 ```
+
+### Packet Log Spec
+
+```text
+ 0                   1                   2                   3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|       LH.length       | LH.ty.|   GPH.length  |GPH.ac.|GPH.ty.|
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                          GP.timestamp                         |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|           GP.length           |       PRH.length      |PRH.ty.|
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                          PRT (custom)                         |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+```
+
+Generated with [protocol](https://github.com/luismartingarcia/protocol), where:
+
+* `LH` is short for log entry header
+* `GPH` is short for general packet entry header
+* `GP` is short for general packet entry (the body part)
+* `PRH` is short for protocol entry header
+* `PRT` is short for protocol entry (the body part)
+* `ty.` is short for type
+* `ac.` is short for action
+
+```shell
+protocol "LH.length:12,LH.ty.:4,GPH.length:8,GPH.ac.:4,GPH.ty.:4,GP.timestamp:32,GP.length:16,PRH.length:12,PRH.ty.:4,PRT (custom):32"
+```
+
+We currently provide TCP log spec (a variant of the protocol entry body part, i.e. `PRT (custom)`):
+
+```text
+ 0                   1                   2                   3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                          tcp.flow_id                          |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                            tcp.seq                            |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                            tcp.ack                            |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|             ip.id             |         ip.frag_offset        |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|          ip.checksum          |   tcp.flags   |    padding    |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+```
+
+```shell
+protocol "tcp.flow_id:32,tcp.seq:32,tcp.ack:32,ip.id:16,ip.frag_offset:16,ip.checksum:16,tcp.flags:8,padding:8"
+```

config.example.toml

@@ -39,6 +39,18 @@
 #
 
 
+# ----- General Section -----
+# This section determines how to build the rattan itself in general.
+[general]
+
+# Configure the path to store compressed packet log.
+# This logging feature will only be enabled when the `packet_log` field is specified.
+# The meta data of flows will be stored in the file of name `packet_log`.flows
+# packet_log = "./example.log"
+
+# ----- General Section End -----
+
+
 # ----- Environment Section -----
 # This section determines how to build the environment.
 [env]

rattan-core/Cargo.toml

@@ -39,6 +39,7 @@ tracing = { workspace = true }
 tempfile = "3.10.1"
 uuid = { version = "1.10.0", features = ["v4"] }
 serde_with = "3.9.0"
+bitfield = "0.16.1"
 
 [dev-dependencies]
 anyhow = "1.0.69"

rattan-core/src/config/mod.rs

@@ -1,4 +1,4 @@
-use std::collections::HashMap;
+use std::{collections::HashMap, path::PathBuf};
 
 use crate::{devices::Packet, env::StdNetEnvConfig};
 
@@ -35,6 +35,8 @@ pub struct RattanConfig<P: Packet> {
     pub links: HashMap<String, String>,
     #[cfg_attr(feature = "serde", serde(default))]
     pub resource: RattanResourceConfig,
+    #[cfg_attr(feature = "serde", serde(default))]
+    pub general: RattanGeneralConfig,
 }
 
 impl<P: Packet> Default for RattanConfig<P> {
@@ -46,6 +48,7 @@ impl<P: Packet> Default for RattanConfig<P> {
             devices: HashMap::new(),
             links: HashMap::new(),
             resource: RattanResourceConfig::new(),
+            general: RattanGeneralConfig::new(),
         }
     }
 }
@@ -70,6 +73,24 @@ impl RattanResourceConfig {
     }
 }
 
+#[cfg_attr(
+    feature = "serde",
+    serde_with::skip_serializing_none,
+    derive(Serialize, Deserialize),
+    serde(bound = "")
+)]
+#[derive(Clone, Debug, Default)]
+pub struct RattanGeneralConfig {
+    #[cfg_attr(feature = "serde", serde(default))]
+    pub packet_log: Option<PathBuf>,
+}
+
+impl RattanGeneralConfig {
+    pub fn new() -> Self {
+        Default::default()
+    }
+}
+
 #[cfg_attr(
     feature = "serde",
     derive(Serialize, Deserialize),