Support multi-version Lua (5.3/5.4/5.5) with dynamic detection

  Major changes:
  - Add dynamic Lua version detection via DWARF debug info
  - Split lua.h into version-specific headers (lua_5_3_6.h, lua_5_4_0.h, lua_5_5_0.h)
  - Build separate BPF skeletons for each Lua version
  - Use DWARF to precisely locate the L variable position

  Bug fixes:
  - Fix tsslen macro in lua_5_4_0.h: use shrlen != 0xFF check instead of tt field
  - Fix lua_get_file in lua_5_5_0.h: use strisshr() for short string detection
  - Fix build.rs typo: cargo:cargo -> cargo:rerun-if-changed
  - Add missing rerun-if-changed for new lua header files

  Other changes:
  - Update dependencies to latest versions
  - Change default sample frequency from 1000Hz to 100Hz
  - Bump version to 0.2

Author: findstr

.github/workflows/rust.yml

@@ -11,12 +11,52 @@ env:
 
 jobs:
   build:
-
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y \
+          clang \
+          llvm \
+          libelf-dev \
+          linux-tools-common \
+          linux-tools-generic \
+          libbpf-dev \
+          linux-headers-$(uname -r)
+
+    - name: Setup bpftool
+      run: |
+        # Link bpftool from linux-tools
+        sudo ln -sf /usr/lib/linux-tools/*/bpftool /usr/local/bin/bpftool || true
+        bpftool version
+
+    - name: Generate vmlinux.h if BTF not available
+      run: |
+        # Check if BTF is available on the runner
+        if [ ! -f /sys/kernel/btf/vmlinux ]; then
+          echo "BTF not available, downloading pre-generated vmlinux.h..."
+          mkdir -p src/bpf
+          # Use vmlinux.h from libbpf-bootstrap (covers common kernel structures)
+          curl -sL https://raw.githubusercontent.com/libbpf/libbpf-bootstrap/master/vmlinux/vmlinux_608.h -o src/bpf/vmlinux.h
+          echo "Downloaded vmlinux.h"
+        else
+          echo "BTF available at /sys/kernel/btf/vmlinux"
+        fi
+
+    - name: Setup Rust
+      uses: dtolnay/rust-toolchain@stable
+
     - name: Build
-      run: cargo build --verbose
+      run: |
+        # If vmlinux.h was pre-generated, skip btf_dump in build.rs
+        if [ -f src/bpf/vmlinux.h ]; then
+          export SKIP_BTF_DUMP=1
+        fi
+        cargo build --verbose
+
     - name: Run tests
       run: cargo test --verbose

.gitignore

@@ -13,3 +13,4 @@ Cargo.lock
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
 src/bpf/vmlinux.h
+lua/

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "lua-perf"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 keywords = ["lua", "perf", "lua-perf"]
 build = "build.rs"
@@ -20,30 +20,28 @@ exclude = [
 
 [dependencies]
 libc = "0.2.147"
-procfs = "0.16.0-RC1"
-procmaps = "0.4.1"
-memmap2 = "0.9.0"
-gimli = "0.28.0"
+procfs = "0.18.0"
+memmap2 = "0.9.9"
+gimli = "0.32"
 rustc-demangle = "0.1.21"
-regex = "1.6"
+regex = "1.11"
 iced-x86 = "1.17"
 byteorder = "1.4.3"
 anyhow = "1.0"
-libbpf-rs="0.21.2"
+libbpf-rs="0.25.0"
 plain = "0.2"
-nix = "0.27.1"
+nix = "0.30.1"
 tracing = "0.1"
 tracing-subscriber = {version = "0.3", features = ["ansi", "env-filter", "fmt"]}
-blazesym = "=0.2.0-alpha.6"
-goblin = { version = "0.7.1", features = ["elf64"] }
+blazesym = "=0.2.1"
+goblin = { version = "0.10.4", features = ["elf64"] }
 clap = { version = "4.4.6", features = ["derive", "env"] }
 clap_derive = "4.4.2"
 time = { version = "0.3", features = ["formatting", "local-offset", "macros"]}
-psutil = "3.2.2"
 lazy_static = "1.4.0"
 ctrlc = "3.4.1"
-capstone = "0.11.0"
+capstone = "0.14.0"
 
 [build-dependencies]
-libbpf-cargo = "0.21.2"
+libbpf-cargo = "0.25.0"
 

README.en.md

@@ -1,13 +1,15 @@
 # lua-perf
 [![cn](https://img.shields.io/badge/lang-cn-red.svg)](./README.md)
 
-`lua-perf` is a performance profiling tool implemented based on `eBPF`, currently supporting `Lua 5.4`.
+`lua-perf` is a performance profiling tool implemented based on `eBPF`, supporting `Lua 5.3`, `Lua 5.4`, and `Lua 5.5`.
 
 ## Features
 
 - Provides performance analysis for mixed `C` and `Lua` code, as well as pure `C` code.
 - Uses stack sampling technique with minimal performance impact on the target process, making it suitable for production environments.
 - Performs stack backtracing in the kernel space using `eh-frame`, eliminating the need for the target process to use the `-fno-omit-frame-pointer` option to preserve stack frame pointers.
+- Automatically detects the Lua version of the target process, no manual specification required.
+- Precisely locates the `L` variable position via DWARF debug information, supporting GCC/Clang O0~O3 optimization levels.
 
 ## Requirements
 
@@ -19,7 +21,7 @@ To use `lua-perf`, make sure you meet the following requirements:
 
 To generate flame graphs, you need to use `lua-perf` in conjunction with the [FlameGraph](https://github.com/brendangregg/FlameGraph.git) tool. Here's how you can do it:
 
-1. First, run the command `sudo lua-perf -p <pid> -f <HZ>` to sample the call stacks of the target process and generate a `perf.fold` file in the current directory. `<pid>` is the process ID of the target process, which can be a process inside a Docker container or a process on the host machine. `<HZ>` is the stack sampling frequency, with a default value of `1000` (1000 samples per second).
+1. First, run the command `sudo lua-perf -p <pid> -f <HZ>` to sample the call stacks of the target process and generate a `perf.fold` file in the current directory. `<pid>` is the process ID of the target process, which can be a process inside a Docker container or a process on the host machine. `<HZ>` is the stack sampling frequency, with a default value of `100` (100 samples per second).
 
 2. Next, convert the `perf.fold` file to a flame graph by running `./FlameGraph/flamegraph.pl perf.folded > perf.svg`.
 
@@ -35,15 +37,13 @@ In the BPF program, bpf_trace_printk is used to print logs. If you suspect any a
 ```
 sudo mount -t tracefs nodev /sys/kernel/tracing
 sudo cat /sys/kernel/debug/tracing/trace_pipe
-These commands will help you access the logs and view them. If you have any further questions, feel free to ask.
 ```
 
 ## Known Issues
 
 `lua-perf` currently has the following known issues:
 
 - Lack of support for `CFA_expression`, which may result in failed stack backtracing in extreme cases.
-- When analyzing Lua stacks, the search for the `L` pointer is currently done by assuming it is stored in register `rbx`, which is correct for most cases with `GCC -O2`. However, depending on the optimization level of GCC, the value of `L` may be stored in a different register, leading to failures in Lua stack analysis.
 - The analysis of `CFA` instructions does not handle `vdso` at the moment, causing stack backtracing failures for function calls in `vdso`.
 - The process of merging C stacks and Lua stacks uses a heuristic strategy, which may have some flaws in extreme cases (none have been found so far).
 
@@ -53,7 +53,5 @@ The following tasks are planned for `lua-perf`:
 
 - Support for `CFA_expression`
 - Support for `vdso`
-- Dynamic analysis of the `L` register
 - Optimization of the merging strategy for C stacks and Lua stacks
-- Support for more versions of Lua
 

README.md

@@ -1,13 +1,15 @@
 # lua-perf
 [![en](https://img.shields.io/badge/lang-en-red.svg)](./README.en.md)
 
-`lua-perf`是一个基于`eBPF`实现的性能分析工具，目前仅支持`Lua 5.4`。
+`lua-perf`是一个基于`eBPF`实现的性能分析工具，支持`Lua 5.3`、`Lua 5.4`和`Lua 5.5`。
 
 ## 功能
 
 - 提供对`C`和`Lua`混合代码的性能分析，同时也支持纯`C`代码。
 - 采用栈采样技术，并且对目标进程的性能影响非常小，可以在生产环境中使用。
 - 通过使用`eh-frame`在内核空间进行栈回溯，不要求目标进程使用`-fno-omit-frame-pointer`选项来保留栈帧指针。
+- 自动检测目标进程的Lua版本，无需手动指定。
+- 通过DWARF调试信息精确定位`L`变量位置，支持GCC/Clang O0~O3优化级别。
 
 ## 执行要求
 
@@ -19,7 +21,7 @@
 
 要生成火焰图，您需要使用`lua-perf`配合[FlameGraph](https://github.com/brendangregg/FlameGraph.git)工具进行操作。以下是步骤：
 
-1. 首先，使用命令 `sudo lua-perf -p <pid> -f <HZ>` 对目标进程进行栈采样，并在当前目录下生成 `perf.fold` 文件。其中 `<pid>` 是目标进程的进程ID，可以是Docker内的进程或者宿主机上的进程。`<HZ>` 是栈的采样频率，默认为 `1000`（即每秒采样1000次）。
+1. 首先，使用命令 `sudo lua-perf -p <pid> -f <HZ>` 对目标进程进行栈采样，并在当前目录下生成 `perf.fold` 文件。其中 `<pid>` 是目标进程的进程ID，可以是Docker内的进程或者宿主机上的进程。`<HZ>` 是栈的采样频率，默认为 `100`（即每秒采样100次）。
 
 2. 然后，使用命令 `./FlameGraph/flamegraph.pl perf.folded > perf.svg` 将 `perf.fold` 文件转换成火焰图。
 
@@ -43,7 +45,6 @@ sudo cat /sys/kernel/debug/tracing/trace_pipe
 `lua-perf`目前存在以下已知问题：
 
 - 尚不支持`CFA_expression`，在某些极端情况下可能会导致调用栈回溯失败。
-- 在分析Lua栈时，动态分析`L`寄存器(目前仅支持gcc/clang O0~03)
 - 在分析`CFA`指令时，暂时没有处理 `vdso`，因此在 `vdso` 中的函数调用会导致栈回溯失败。
 - 在合并进程的C栈和Lua栈时，采用了启发式的合并策略，极端情况下可能存在一些瑕疵（目前尚未发现）。
 
@@ -54,4 +55,3 @@ sudo cat /sys/kernel/debug/tracing/trace_pipe
 - 支持`CFA_expression`
 - 支持`vdso`
 - 优化C栈和Lua栈的合并策略
-- 支持更多版本的Lua

build.rs

@@ -10,6 +10,12 @@ use libbpf_cargo::SkeletonBuilder;
 const BPF_SRC: &str = concat!("src/bpf/", "profile.bpf.c");
 
 fn btf_dump() {
+        // Check if we should skip BTF dump (e.g., vmlinux.h already exists in src/bpf/)
+        if env::var("SKIP_BTF_DUMP").is_ok() {
+                println!("cargo:warning=Skipping BTF dump, using existing vmlinux.h");
+                return;
+        }
+
         let mut out = PathBuf::from(env::var_os("OUT_DIR").expect("OUT_DIR must be set in build script"));
         out.push("vmlinux.h");
         let path = out.to_str().unwrap();
@@ -20,28 +26,53 @@ fn btf_dump() {
                 .spawn()
                 .expect("failed to generate vmlinux.h");
         cmd.wait().expect("fail to generate vmlinux.h");
-        println!("cargo:cargo rerun-if-not-exists={}", path);
+        println!("cargo:rerun-if-changed={}", path);
 }
 
 fn output() ->String {
         let out_dir = env::var_os("OUT_DIR").expect("OUT_DIR must be set in build script");
-        let out_dir_str = out_dir.to_str().unwrap().clone();
+        let out_dir_str = out_dir.to_str().unwrap();
         String::from_str(out_dir_str).unwrap()
 }
 fn build_skel() {
-        let mut out = PathBuf::from(env::var_os("OUT_DIR").expect("OUT_DIR must be set in build script"));
-        out.push("profile.skel.rs");
-        let include = format!("-I{}", output());
+    let out_dir = PathBuf::from(env::var_os("OUT_DIR").expect("OUT_DIR must be set in build script"));
+
+    // When SKIP_BTF_DUMP is set, vmlinux.h is in src/bpf/ instead of OUT_DIR
+    let include_out = format!("-I{}", output());
+    let include_src_bpf = "-Isrc/bpf".to_string();
+
+    // Define versions: (suffix, clang_flags)
+    // Suffix "" means default filename "profile.skel.rs" (Lua 5.4.0 default)
+    let versions = vec![
+        ("_5_5_0", vec!["-DLUA_VERSION_5_5_0"]),
+        ("_5_4_0", vec!["-DLUA_VERSION_5_4_0"]),
+        ("_5_3_6", vec!["-DLUA_VERSION_5_3_6"]),
+    ];
+
+    for (suffix, flags) in versions {
+        let mut out = out_dir.clone();
+        out.push(format!("profile{}.skel.rs", suffix));
+
+        // Include both OUT_DIR (for normal builds) and src/bpf (for pre-generated vmlinux.h)
+        let mut args = vec![include_out.clone(), include_src_bpf.clone()];
+        for f in flags {
+            args.push(f.to_string());
+        }
+
         SkeletonBuilder::new()
-                .debug(true)
-                .clang_args(include)
+                .clang_args(args)
                 .source(BPF_SRC)
                 .build_and_generate(&out)
                 .unwrap();
-        println!("cargo:rerun-if-changed={BPF_SRC}");
-        println!("cargo:rerun-if-changed=src/bpf/lstate.h");
-        println!("cargo:rerun-if-changed=src/bpf/profile.h");
-        println!("cargo:rerun-if-changed=src/bpf/hash.h");
+    }
+
+    println!("cargo:rerun-if-changed={BPF_SRC}");
+    println!("cargo:rerun-if-changed=src/bpf/profile.h");
+    println!("cargo:rerun-if-changed=src/bpf/hash.h");
+    println!("cargo:rerun-if-changed=src/bpf/lua.h");
+    println!("cargo:rerun-if-changed=src/bpf/lua_5_3_6.h");
+    println!("cargo:rerun-if-changed=src/bpf/lua_5_4_0.h");
+    println!("cargo:rerun-if-changed=src/bpf/lua_5_5_0.h");
 }
 
 fn main() {

src/args.rs

@@ -3,11 +3,11 @@ use clap::Parser;
 #[derive(Parser)]
 #[command(name = "lua-perf")]
 #[command(author = "findstr <findstrx@gmail.com>")]
-#[command(version = "0.1")]
+#[command(version = "0.2")]
 #[command(about = "A perf tool for C and Lua hybrid code")]
 pub struct Args {
         #[arg(short, long, help = "PID of the process to profile")]
         pub pid: libc::pid_t,
-        #[clap(short, long, default_value_t = 1000, help="Profile sample frequency(HZ)")]
+        #[clap(short, long, default_value_t = 100, help="Profile sample frequency(HZ)")]
         pub freq: u64,
 }

src/bpf/lua.h

@@ -1,6 +1,14 @@
 #ifndef _LUA_H
 #define _LUA_H
 
-#include "lua54.h"
+#if defined(LUA_VERSION_5_5_0)
+#include "lua_5_5_0.h"
+#elif defined(LUA_VERSION_5_4_0)
+#include "lua_5_4_0.h"
+#elif defined(LUA_VERSION_5_3_6)
+#include "lua_5_3_6.h"
+#else
+#error "Lua version not defined"
+#endif
 
 #endif