edit doc; +Load_file lua function for StaticConfig

e1732a364fed · e1732a364fed · commit dbe8e24edbf5 · 2099-01-01T00:00:00.000Z
diff --git a/doc/book/src/app/cmd.md b/doc/book/src/app/cmd.md
@@ -66,6 +66,7 @@ ruci-cmd 运行时产生的日志会自动创建并放在 logs 文件夹中, dai
 -l, --log-level <LOG_LEVEL>
 
 可为 ERROR, WARN, INFO , DEBUG, TRACE
+小写也可以。
 
 ## 环境变量法
 
diff --git a/doc/book/src/get_started.md b/doc/book/src/get_started.md
@@ -15,7 +15,7 @@ ruci 的可执行文件叫做 ruci-cmd, 客户端和服务端都是使用这同
 
 建议下载后缀为 `x86_64-pc-windows-msvc.tar.xz` 的版本
 
-下载后，可以用 7zip 来解压，先解压出一个 tar, 再解压一遍得到程序。
+下载后，可以用 7zip 来解压，先解压出一个 tar, 再解压一遍得到程序。(或双击用7zip 打开后，进入tar之后再将其内容拖拽出来)
 
 第一次运行时，windows 可能弹出提示，询问是否允许连接到网络，同意即可。
 
@@ -34,6 +34,7 @@ apple silicon（m1,m2,m3,m4） 下载
 
 第一次运行时，macOS 会提示您该程序不受信任，您可以到 设置-隐私与安全 中，许可本程序的使用。
 
+注：编译运行则不会出现此提示。
 
 ### x64 linux
 建议 x64的 linux 用户下载 后缀为 `x86_64-unknown-linux-gnu.tar.xz` 的版本
diff --git a/doc/book/src/lua/infinite.md b/doc/book/src/lua/infinite.md
@@ -104,3 +104,6 @@ Config (静态链) 之间，请在 项目中搜索 Dyn_Selectors 以进行学习
 因为其夹在 Config 和 Infinite 之间，并没有什么出彩的地方。但是其使用难度比
 Infinite 要低很多。
 
+# 接下来
+
+[lua自定义协议](lua/user_defined_protocol.md)
diff --git a/doc/book/src/lua/user_defined_protocol.md b/doc/book/src/lua/user_defined_protocol.md
@@ -162,3 +162,4 @@ end
 
 ruci还在lua中注册了 `Debug_print`,`Info_print`,`Warn_print` 函数，可以用于向日志打印自定义输出（以debug,info,warn 级别)
 
+还有 Load_file 函数，可以用它加载 tar 中的文件。（只在 静态链中有效）
diff --git a/doc/book/src/toml/index.md b/doc/book/src/toml/index.md
@@ -57,4 +57,4 @@ chain = [{ Direct = {} }]
 # 接下来
 
 - [lua配置](../lua/lua.md)
-- [路由配置](lua/route_config.md)
+- [路由配置](../lua/route_config.md)
diff --git a/doc/notes.md b/doc/notes.md
@@ -243,6 +243,7 @@ tun 包在 windows 平台使用 wintun, 而在 其它平台使用 系统调用
 
 smoltcp 的实现 在实践中比 lwip 实现快一些。因此 ruci-cmd 只采用了 smoltcp 的网络栈。
 
+在linux/macOS 上还发现了 内存泄漏问题，也许和 tun 包有关. windows上没有任何问题。
 
 # lib note
 
diff --git a/resource/local.lua b/resource/local.lua
@@ -883,7 +883,7 @@ local config_23_tcp_ip_stack_lwip = {
 --]]
 
 
-Config = config_20_spe1
+Config = config_22_lua_example2
 
 -- local str = Load_file("test.crt") -- load file from the default file provider from ruci ( from either tar or folder)
 -- print("content of crt is:", str)
diff --git a/resource/lua_protocol_e2_mathadd.lua b/resource/lua_protocol_e2_mathadd.lua
@@ -4,6 +4,9 @@
 
 local add_num = 1
 
+-- 每创建一个连接，本文件中的代码都会被重复调用一遍，因此在 全局上调用的函数要上心使用
+-- print(Load_file("test.crt"))
+
 local function read(cx, buf)
     if Behavior == 1 then -- client
         local result = TheConn:poll_read(cx, buf)
diff --git a/resource/remote.lua b/resource/remote.lua
@@ -160,8 +160,8 @@ Config = {
 
         }
         -- ]]
-        { chain = { tcp, spe1_in, trojan_in }, tag = "listen1" }
-        -- { chain = lua_example2, tag = "listen1" },
+        -- { chain = { tcp, spe1_in, trojan_in }, tag = "listen1" }
+        { chain = lua_example2, tag = "listen1" },
     },
 
     ---[[
diff --git a/rucimp/dev.md b/rucimp/dev.md
@@ -17,3 +17,14 @@ cargo clippy --all-targets --all-features
 lwip 无法在 windows 上编译通过, 因此没有加入 ruci-cmd 的feature中 。且经手动测试，发现其性能可能比smoltcp 差一些
 
 在windows 上,tun 包的性能 似乎是因为使用了wintun 的原因，比在 macOS/linux 上要快不少
+
+macOS/linux 上存在内存泄漏，不知如何解决，可能与 tun 包有关。
+
+ 从 tun device 有三种方式可以 异步读取，
+     1. 在 device 用 AsyncDevice 它自己的 split 方法
+     2. 转为 AsyncConn 后 用 tokio 的 split
+     3. 转为 Frame 后 分成 sink 和 stream
+    
+实测第一种情况 会在 向 tun 写入时卡住, 第2、3种情况效果相同。
+但是都卡顿,效果与 smoltcp 类似.因此认为是tun 包的问题,与 tcp/ip 栈无关
+
diff --git a/rucimp/src/map/lua/mod.rs b/rucimp/src/map/lua/mod.rs
@@ -36,6 +36,29 @@ use tokio::io::AsyncWrite;
 use tokio::io::AsyncWriteExt;
 use tokio::io::ReadBuf;
 
+pub fn create_load_file_func(lua: &Lua, file_source: &crate::utils::FileSource) {
+    let raw_ptr = file_source as *const crate::utils::FileSource as *const std::os::raw::c_void;
+
+    let pointer_n = raw_ptr as usize;
+
+    let f = lua
+        .create_function(move |lua, s: mlua::BString| {
+            let file_name = std::str::from_utf8(s.as_slice()).unwrap();
+
+            let file_source = unsafe {
+                &*((pointer_n as *const std::os::raw::c_void) as *const crate::utils::FileSource)
+            };
+
+            let r = file_source
+                .get_file_content(file_name)
+                .map_err(|e| mlua::Error::external(e))?;
+
+            lua.create_string(&r.0)
+        })
+        .unwrap();
+    lua.globals().set("Load_file", f).unwrap();
+}
+
 /// 被用于 infinite.rs 中 给 lua 添加 Create_out_map 和 Create_in_map 函数.
 #[derive(Clone)]
 pub struct MapWrapper(pub Arc<MapBox>);
@@ -435,6 +458,8 @@ impl AsyncWrite for LuaConn {
 pub struct LuaMap {
     pub lua_text: String,        //整个 lua文件的内容
     pub handshake_f_key: String, //lua文件中 对应的 map 函数的 函数名
+
+    pub file_source: Option<crate::utils::FileSource>,
 }
 
 impl Name for LuaMap {
@@ -450,12 +475,6 @@ impl LuaMap {
         // 但 maps却是 多线程 调用的，同一时间可能有很多个 maps 调用
 
         let lua = Lua::new();
-        let _: () = lua
-            .load(&self.lua_text)
-            .eval()
-            .context("eval lua failed")
-            .unwrap();
-        let handshake_f: LuaFunction = lua.globals().get(self.handshake_f_key.as_str()).unwrap();
 
         let f = lua
             .create_function(|_, n: usize| Ok(ReadBufWrapper::new(n)))
@@ -502,6 +521,17 @@ impl LuaMap {
             .unwrap();
         lua.globals().set("Warn_print", f).unwrap();
 
+        if let Some(fs) = &self.file_source {
+            create_load_file_func(&lua, &fs);
+        }
+
+        let _: () = lua
+            .load(&self.lua_text)
+            .eval()
+            .context("eval lua failed")
+            .unwrap();
+        let handshake_f: LuaFunction = lua.globals().get(self.handshake_f_key.as_str()).unwrap();
+
         (lua, handshake_f)
     }
 }
diff --git a/rucimp/src/modes/chain/config/lua/finite.rs b/rucimp/src/modes/chain/config/lua/finite.rs
@@ -2,6 +2,8 @@
 Defines functions to load finite(partial) dynamic chain configs from a lua file.
 */
 
+use crate::map::lua::create_load_file_func;
+
 use super::*;
 use dynamic::Finite;
 use parking_lot::Mutex;
@@ -34,7 +36,7 @@ pub fn load_finite_dynamic(
 ) -> mlua::Result<LoadFiniteDynamicResult> {
     let (sc, sm) = load_finite_config_and_selector_map(lua_text, file_source)?;
 
-    let (ibs, fb, obm) = get_io_bounds_by_config_and_selector_map(sc.clone(), sm);
+    let (ibs, fb, obm) = get_io_bounds_by_config_and_selector_map(sc.clone(), sm, file_source);
     Ok((sc, ibs, fb, obm))
 }
 
@@ -90,8 +92,9 @@ fn load_finite_config_and_selector_map(
 fn get_io_bounds_by_config_and_selector_map(
     c: StaticConfig,
     mut selector_map: HashMap<String, LuaNextSelector>,
+    file_source: Option<&crate::utils::FileSource>,
 ) -> (Vec<DMIterBox>, DMIterBox, Arc<HashMap<String, DMIterBox>>) {
-    let ibs = c.get_inbounds();
+    let ibs = c.get_inbounds(file_source);
     let v: Vec<DMIterBox> = ibs
         .into_iter()
         .map(|v| {
@@ -112,7 +115,7 @@ fn get_io_bounds_by_config_and_selector_map(
         })
         .collect();
 
-    let obs = c.get_outbounds();
+    let obs = c.get_outbounds(file_source);
 
     let mut first_o: Option<DMIterBox> = None;
 
diff --git a/rucimp/src/modes/chain/config/lua/infinite.rs b/rucimp/src/modes/chain/config/lua/infinite.rs
@@ -1,4 +1,4 @@
-use crate::map::lua::MapWrapper;
+use crate::map::lua::{create_load_file_func, MapWrapper};
 
 /*
 Defines functions to load infinite(complete) dynamic chain configs from a lua file.
@@ -18,9 +18,9 @@ pub type GMap = HashMap<String, LuaNextGenerator>;
 ///
 /// 把 lua中的配置 在 rust 中 初始化为 MapBox, 并包在 LuaMapWrapper 中
 pub fn set_lua_create_in_map_func(lua: &Lua) -> anyhow::Result<()> {
-    let f = lua.create_function(|lua, v: LuaValue| {
+    let f = lua.create_function(move |lua, v: LuaValue| {
         let c = lua.from_value::<InMapConfig>(v)?;
-        let m = c.to_map_box();
+        let m = c.to_map_box(None);
         let m = MapWrapper(Arc::new(m));
         Ok(m)
     })?;
@@ -32,9 +32,9 @@ pub fn set_lua_create_in_map_func(lua: &Lua) -> anyhow::Result<()> {
 ///
 /// 把 lua中的配置 在 rust 中 初始化为 MapBox, 并包在 LuaMapWrapper 中
 pub fn set_lua_create_out_map_func(lua: &Lua) -> anyhow::Result<()> {
-    let f = lua.create_function(|lua, v: LuaValue| {
+    let f = lua.create_function(move |lua, v: LuaValue| {
         let c = lua.from_value::<OutMapConfig>(v)?;
-        let m = c.to_map_box();
+        let m = c.to_map_box(None);
         let m = MapWrapper(Arc::new(m));
         Ok(m)
         // }
@@ -157,15 +157,15 @@ impl InnerLuaNextGenerator {
         }
     }
 
-    fn lua_value_to_oim<T: for<'de> Deserialize<'de> + ruci::map::ToMapBox>(
+    fn lua_value_to_oim<T: for<'de> Deserialize<'de> + AdvancedToMapBox>(
         &self,
         i: i64,
         v: Value,
     ) -> Option<dynamic::IndexMapBox> {
         let ic: LuaResult<T> = self.lua.from_value(v);
         match ic {
             Ok(ic) => {
-                let mut mb = ic.to_map_box();
+                let mut mb = ic.to_map_box(None);
                 mb.set_chain_tag(&self.tag);
                 Some((i, Some(Arc::new(mb))))
             }
diff --git a/rucimp/src/modes/chain/config/lua/mod.rs b/rucimp/src/modes/chain/config/lua/mod.rs
@@ -4,7 +4,6 @@ Defines functions to load static chain from a lua file.
 
 #[cfg(test)]
 #[allow(unused)]
-#[cfg(any(feature = "lua", feature = "lua54"))]
 pub mod test;
 
 pub mod finite;
@@ -27,7 +26,7 @@ pub fn load_static(
 ) -> mlua::Result<StaticConfig> {
     let lua = Lua::new();
 
-    file_source.inspect(|file_source| create_load_file_func(&lua, file_source));
+    file_source.inspect(|file_source| crate::map::lua::create_load_file_func(&lua, file_source));
 
     lua.load(lua_text).exec()?;
 
@@ -44,26 +43,3 @@ pub fn save_static(c: &StaticConfig) -> mlua::Result<Lua> {
     lua.globals().set(CONFIG_KEY, lua.to_value(c)?)?;
     Ok(lua)
 }
-
-pub fn create_load_file_func(lua: &Lua, file_source: &crate::utils::FileSource) {
-    let raw_ptr = file_source as *const crate::utils::FileSource as *const std::os::raw::c_void;
-
-    let pointer_n = raw_ptr as usize;
-
-    let f = lua
-        .create_function(move |lua, s: mlua::BString| {
-            let file_name = std::str::from_utf8(s.as_slice()).unwrap();
-
-            let file_source = unsafe {
-                &*((pointer_n as *const std::os::raw::c_void) as *const crate::utils::FileSource)
-            };
-
-            let r = file_source
-                .get_file_content(file_name)
-                .map_err(|e| mlua::Error::external(e))?;
-
-            lua.create_string(&r.0)
-        })
-        .unwrap();
-    lua.globals().set("Load_file", f).unwrap();
-}
diff --git a/rucimp/src/modes/chain/config/lua/test.rs b/rucimp/src/modes/chain/config/lua/test.rs
@@ -278,7 +278,7 @@ fn test_tag_route() -> mlua::Result<()> {
     assert!(tr.is_some());
     println!("{:#?}", c.get_tag_route());
 
-    println!("{:#?}", c.get_default_and_outbounds_map());
+    println!("{:#?}", c.get_default_and_outbounds_map(None));
 
     Ok(())
 }
diff --git a/rucimp/src/modes/chain/config/mod.rs b/rucimp/src/modes/chain/config/mod.rs
diff --git a/rucimp/src/modes/chain/engine.rs b/rucimp/src/modes/chain/engine.rs
diff --git a/rucimp/src/utils.rs b/rucimp/src/utils.rs

Original file line number	Diff line number	Diff line change
`@@ -162,3 +162,4 @@ end`
`162`	`162`
`163`	`163`	ruci还在lua中注册了 `Debug_print`,`Info_print`,`Warn_print` 函数，可以用于向日志打印自定义输出（以debug,info,warn 级别)
`164`	`164`
	`165`	`+还有 Load_file 函数，可以用它加载 tar 中的文件。（只在静态链中有效）`
Original file line number	Diff line number	Diff line change
`@@ -243,6 +243,7 @@ tun 包在 windows 平台使用 wintun, 而在其它平台使用系统调用`
`243`	`243`
`244`	`244`	`smoltcp 的实现在实践中比 lwip 实现快一些。因此 ruci-cmd 只采用了 smoltcp 的网络栈。`
`245`	`245`
	`246`	`+在linux/macOS 上还发现了内存泄漏问题，也许和 tun 包有关. windows上没有任何问题。`
`246`	`247`
`247`	`248`	`# lib note`
`248`	`249`
Original file line number	Diff line number	Diff line change
`@@ -160,8 +160,8 @@ Config = {`
`160`	`160`
`161`	`161`	`}`
`162`	`162`	`-- ]]`
`163`		`- { chain = { tcp, spe1_in, trojan_in }, tag = "listen1" }`
`164`		`- -- { chain = lua_example2, tag = "listen1" },`
	`163`	`+ -- { chain = { tcp, spe1_in, trojan_in }, tag = "listen1" }`
	`164`	`+ { chain = lua_example2, tag = "listen1" },`
`165`	`165`	`},`
`166`	`166`
`167`	`167`	`---[[`