feat(rust): add the Iceoryx channel configuration.

Author: nkaz001

hftbacktest/Cargo.toml

@@ -23,7 +23,7 @@ rust-version = "1.82"
 [features]
 default = ["backtest", "live"]
 backtest = ["zip", "uuid", "nom", "hftbacktest-derive"]
-live = ["chrono", "tokio", "futures-util", "iceoryx2", "rand"]
+live = ["chrono", "tokio", "futures-util", "iceoryx2", "rand", "toml", "serde"]
 unstable_fuse = []
 
 [dependencies]
@@ -40,6 +40,8 @@ rand = { version = "0.8.5", optional = true }
 uuid = { version = "1.8.0", features = ["v4"], optional = true }
 nom = { version = "7.1.3", optional = true }
 iceoryx2 = { version = "0.4.1", optional = true, features = ["logger_tracing"] }
+serde = { version = "1.0.215", optional = true, features = ["derive"] }
+toml = { version = "0.8.19", optional = true }
 hftbacktest-derive = { path = "../hftbacktest-derive", optional = true, version = "0.2.0" }
 
 [dev-dependencies]

hftbacktest/src/live/ipc/config.rs

@@ -0,0 +1,35 @@
+use std::{env, fs};
+
+use serde::Deserialize;
+
+pub const MAX_PAYLOAD_SIZE: usize = 512;
+const MAX_BOTS_PER_CONNECTOR: usize = 200;
+const CHANNEL_BUFFER_SIZE: usize = 10000;
+
+#[derive(Deserialize)]
+pub struct ChannelConfig {
+    pub buffer_size: usize,
+    pub max_bots: usize,
+}
+
+impl ChannelConfig {
+    pub fn load_config() -> Self {
+        if let Ok(config_file) = env::var("HFTBACKTEST_CHANNEL_CONFIG") {
+            if let Ok(contents) = fs::read_to_string(config_file) {
+                if let Ok(config) = toml::from_str::<ChannelConfig>(&contents) {
+                    return config;
+                }
+            }
+        }
+        ChannelConfig::default()
+    }
+}
+
+impl Default for ChannelConfig {
+    fn default() -> Self {
+        Self {
+            buffer_size: CHANNEL_BUFFER_SIZE,
+            max_bots: MAX_BOTS_PER_CONNECTOR,
+        }
+    }
+}

hftbacktest/src/live/ipc/iceoryx.rs

@@ -22,15 +22,18 @@ use iceoryx2::{
 use thiserror::Error;
 
 use crate::{
-    live::{ipc::Channel, BotError, Instrument},
+    live::{
+        ipc::{
+            config::{ChannelConfig, MAX_PAYLOAD_SIZE},
+            Channel,
+        },
+        BotError,
+        Instrument,
+    },
     prelude::{LiveEvent, LiveRequest},
     types::BuildError,
 };
 
-const MAX_PAYLOAD_SIZE: usize = 512;
-const MAX_BOTS_PER_CONNECTOR: usize = 500;
-const CHANNEL_BUFFER_SIZE: usize = 100000;
-
 #[derive(Default, Debug)]
 #[repr(C)]
 pub struct CustomHeader {
@@ -74,6 +77,7 @@ impl IceoryxBuilder {
     }
 
     pub fn receiver<T>(self) -> Result<IceoryxReceiver<T>, ChannelError> {
+        let config = ChannelConfig::load_config();
         let node = NodeBuilder::new()
             .create::<ipc::Service>()
             .map_err(|error| ChannelError::BuildError(error.to_string()))?;
@@ -83,9 +87,9 @@ impl IceoryxBuilder {
                 .map_err(|error| ChannelError::BuildError(error.to_string()))?;
             node.service_builder(&service_name)
                 .publish_subscribe::<[u8]>()
-                .subscriber_max_buffer_size(CHANNEL_BUFFER_SIZE)
+                .subscriber_max_buffer_size(config.buffer_size)
                 .max_publishers(1)
-                .max_subscribers(MAX_BOTS_PER_CONNECTOR)
+                .max_subscribers(config.max_bots)
                 .user_header::<CustomHeader>()
                 .open_or_create()
                 .map_err(|error| ChannelError::BuildError(error.to_string()))?
@@ -94,8 +98,8 @@ impl IceoryxBuilder {
                 .map_err(|error| ChannelError::BuildError(error.to_string()))?;
             node.service_builder(&service_name)
                 .publish_subscribe::<[u8]>()
-                .subscriber_max_buffer_size(CHANNEL_BUFFER_SIZE)
-                .max_publishers(MAX_BOTS_PER_CONNECTOR)
+                .subscriber_max_buffer_size(config.buffer_size)
+                .max_publishers(config.max_bots)
                 .max_subscribers(1)
                 .user_header::<CustomHeader>()
                 .open_or_create()
@@ -114,6 +118,7 @@ impl IceoryxBuilder {
     }
 
     pub fn sender<T>(self) -> Result<IceoryxSender<T>, ChannelError> {
+        let config = ChannelConfig::load_config();
         let node = NodeBuilder::new()
             .create::<ipc::Service>()
             .map_err(|error| ChannelError::BuildError(error.to_string()))?;
@@ -123,8 +128,8 @@ impl IceoryxBuilder {
                 .map_err(|error| ChannelError::BuildError(error.to_string()))?;
             node.service_builder(&service_name)
                 .publish_subscribe::<[u8]>()
-                .subscriber_max_buffer_size(100000)
-                .max_publishers(500)
+                .subscriber_max_buffer_size(config.buffer_size)
+                .max_publishers(config.max_bots)
                 .max_subscribers(1)
                 .user_header::<CustomHeader>()
                 .open_or_create()
@@ -134,9 +139,9 @@ impl IceoryxBuilder {
                 .map_err(|error| ChannelError::BuildError(error.to_string()))?;
             node.service_builder(&service_name)
                 .publish_subscribe::<[u8]>()
-                .subscriber_max_buffer_size(100000)
+                .subscriber_max_buffer_size(config.buffer_size)
                 .max_publishers(1)
-                .max_subscribers(500)
+                .max_subscribers(config.max_bots)
                 .user_header::<CustomHeader>()
                 .open_or_create()
                 .map_err(|error| ChannelError::BuildError(error.to_string()))?

hftbacktest/src/live/ipc/mod.rs

@@ -6,6 +6,7 @@ use crate::{
     types::{LiveEvent, LiveRequest},
 };
 
+mod config;
 pub mod iceoryx;
 
 pub const TO_ALL: u64 = 0;