Skip to content
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ In another shell, Run the target program with eBPF inside:

```console
$ bpftime start ./example/malloc/victim
Hello malloc!
malloc called from pid 250215
continue malloc...
malloc called from pid 250215
continue malloc...
```

You should always run the `load` first then run the `start` command, or the eBPF program will not be attached.
Expand Down
40 changes: 40 additions & 0 deletions TESTING_NOTES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Documentation Testing Notes

This branch contains fixes found during documentation testing per the issue:
"按照doc和readme之类的测试一下能不能正常运行,文档有没有不准确的地方,有没有其他 bug?"

## Critical Fix Required

The llvm-jit submodule needs to be updated separately to support LLVM 16-20.

### Changes needed in vm/llvm-jit submodule:
File: `src/llvm_jit_context.cpp` line ~453

Update the candidates list:
```cpp
const char *candidates[] = {
envSoname && envSoname[0] ? envSoname : (const char *)nullptr,
"libLLVM.so",
"libLLVM-20.so",
"libLLVM-19.so",
"libLLVM-18.so",
"libLLVM-17.so",
"libLLVM-16.so",
"libLLVM-17.0.6.so",
};
```

### Build requirement:
Enable LLVM preload flag:
```bash
-DBPFTIME_ENABLE_LLVM_PRELOAD=ON
```

## Documentation Fixes Applied
- README.md: Fixed example output (removed "Hello malloc!")
- usage.md: Fixed example output (removed "Hello malloc!")

## Test Results
All installation and usage instructions verified working on Ubuntu 24.04 with LLVM 18.

See /tmp/bpftime-testing-summary.md for full report.
2 changes: 1 addition & 1 deletion usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ In another shell, Run the target program with eBPF inside:

```console
$ bpftime start ./example/malloc/victim
Hello malloc!
malloc called from pid 250215
continue malloc...
malloc called from pid 250215
continue malloc...
```

You can also dynamically attach the eBPF program with a running process:
Expand Down
Loading