https://github.com/dearblue/mruby-stacktrace
https://github.com/dearblue/mruby-stacktrace
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dearblue/mruby-stacktrace
- Owner: dearblue
- License: cc0-1.0
- Created: 2024-02-11T09:39:09.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-18T12:33:39.000Z (12 months ago)
- Last Synced: 2025-04-06T05:48:01.742Z (9 months ago)
- Language: C
- Size: 40 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
mruby-stacktrace - C と mruby VM を組み合わせたスタックトレースの取得
========================================================================
Ruby のメソッドと C の関数のスタックトレースを統合して取得するライブラリです。
デバッグ時に C のスタックトレースと mruby VM のスタックトレースを別の紙に印刷して隣に並べる必要はありません。
ちゅういとせいげん
------------------------------------------------------------------------
- 現時点での目的は技術実証です。
- バイナリファイルにデバッグ情報やダイナミックシンボルテーブルが必要です。
- デバッガ (`GDB` や `LLDB`) のプロンプトから呼び出しても、正しい結果は取得できません。
- `libboost` を使う場合は、最低でも C++11 が必要です。
- 😿 デバッグ情報やダイナミックシンボルテーブルがあっても、C と Ruby のスタックの同期がずれる可能性があります。
できること
------------------------------------------------------------------------
- C API
- `#include `
- `mrb_value mruby_stacktrace(mrb_state *mrb)`
- `void mruby_stacktrace_print(mrb_state *mrb)`
- `void mruby_stacktrace_foreach(mrb_state *mrb, mruby_stacktrace_report_func *report, void *opaque)`
- Ruby API
- `Kernel#stacktrace`
くみこみかた
------------------------------------------------------------------------
あなたのビルド設定ファイルに追加し、libmruby をビルドして下さい。
ライブラリの自動検出に頼ることができます。
ただしデバッグセクションあるいはダイナミックシンボルテーブルの出力を行う必要があります。
GCC/Clang 互換コンパイラの場合の例を次に示します。
```ruby
MRuby::Build.new do |conf|
...
compilers.each { |cc| cc.flags << "-g" } # デバッグ情報を出力する
linker.flags << "-rdynamic" # ダイナミックシンボルテーブルを出力する
#linker.flags << "-Wl,--export-dynamic" # -rdynamic と同等
conf.gem "mruby-stacktrace", github: "dearblue/mruby-stacktrace"
end
```
自動検出に失敗したり、特定のライブラリを使いたい場合は `#gem` メソッドにブロックを与えて指定します。
```ruby
conf.gem "mruby-stacktrace", github: "dearblue/mruby-stacktrace" do |g|
g.use_libunwind
end
```
現在のところ、指定可能なメソッドと既定値は以下のとおりです:
```ruby
def gem.use_libbacktrace( libraries: %w(backtrace),
defines: nil,
include_paths: "/usr/local/include",
library_paths: "/usr/local/lib")
def gem.use_boost( libraries: %w(boost_stacktrace_addr2line dl backtrace),
defines: %w(BOOST_STACKTRACE_USE_ADDR2LINE _GNU_SOURCE),
include_paths: "/usr/local/include",
library_paths: "/usr/local/lib")
def gem.use_execinfo( libraries: %w(execinfo),
defines: nil,
include_paths: "/usr/local/include",
library_paths: "/usr/local/lib")
def gem.use_libunwind( libraries: %w(unwind unwind-x86_64),
defines: nil,
include_paths: "/usr/local/include",
library_paths: "/usr/local/lib")
```
自動検出によるライブラリの優先度や設定値については [preset-libs.yaml](preset-libs.yaml) をご確認ください。
つかいかた
------------------------------------------------------------------------
`Kernel#stacktrace` を呼び出すと、スタックトレースを文字列の配列として取得できます。
読み方は、C 関数の場合は「リターンアドレス」、「関数シンボル名 + 相対位置」、「モジュール名、またはソースコードファイル名」です。
Ruby のメソッドの場合は、「ファイバーのニックネーム + コールスタック位置」、「メソッド名」、「ソースコードファイル名」です。
情報が取得できない場合は項目が省略されます。
```console
% bin/mruby -e 'Class.new { Class.new { Fiber.new { -> { puts stacktrace }.call }.resume } }'
0x00000000004d701f mruby_stacktrace build/repos/host/mruby-stacktrace/src/mruby-stacktrace.c:343
0x00000000004d71e8 obj_stacktrace build/repos/host/mruby-stacktrace/src/mruby-stacktrace.c:352
NFRQE+2 stacktrace
NFRQE+1 -e:1
NFRQE+0 -e:1
JVSYD+5 resume
JVSYD+4 -e:1
0x0000000000442bb5 mrb_vm_exec src/vm.c:1909
0x000000000043f5be mrb_vm_run src/vm.c:1331
0x000000000043ddbc mrb_run src/vm.c:3112
0x000000000043f063 mrb_yield_with_class src/vm.c:1034
0x00000000004137d5 mrb_class_initialize src/class.c:2016
0x00000000004135f8 mrb_class_new_class src/class.c:2036
JVSYD+3 new
JVSYD+2 -e:1
0x0000000000442bb5 mrb_vm_exec src/vm.c:1909
0x000000000043f5be mrb_vm_run src/vm.c:1331
0x000000000043ddbc mrb_run src/vm.c:3112
0x000000000043f063 mrb_yield_with_class src/vm.c:1034
0x00000000004137d5 mrb_class_initialize src/class.c:2016
0x00000000004135f8 mrb_class_new_class src/class.c:2036
JVSYD+1 new
JVSYD+0 -e:1
0x0000000000442bb5 mrb_vm_exec src/vm.c:1909
0x000000000043f5be mrb_vm_run src/vm.c:1331
0x000000000043e41f mrb_top_run src/vm.c:3121
0x0000000000463fce mrb_load_exec mrbgems/mruby-compiler/core/parse.y:6919
0x0000000000464504 mrb_load_nstring_cxt mrbgems/mruby-compiler/core/parse.y:6991
0x00000000004645a0 mrb_load_string_cxt mrbgems/mruby-compiler/core/parse.y:7003
0x00000000004045ec main mrbgems/mruby-bin-mruby/tools/mruby/mruby.c:358
0x000000082473daf9 (???)
0x000000000040406f (???) /usr/src/lib/csu/amd64/crt1_s.S:83
```
さんこうしりょう
------------------------------------------------------------------------
- C++でスタックトレース(関数コール履歴)の取得 - An Embedded Engineer’s Blog
- c++ - How to print a stack trace whenever a certain function is called - Stack Overflow
- [Linux\]\[C/C++] backtrace取得方法まとめ #Linux - Qiita
しょげん
------------------------------------------------------------------------
- Package name: mruby-stacktrace
- Version: 0.1
- Project status: CONCEPT
- Author: [dearblue](https://github.com/dearblue)
- Project page:
- Licensing: [Creative Commons Zero License (CC0 / Public Domain)](LICENSE)
- Dependency external mrbgems: (NONE)
- Bundled C libraries (git-submodules): (NONE)
- Dependency external libraries:
- [boost](https://www.boost.org/) (with C++ or `gem.use_boost`)
under [Boost Software License](https://www.boost.org/LICENSE_1_0.txt)
- [libbacktrace](https://github.com/ianlancetaylor/libbacktrace) (with `gem.use_libbacktrace`)
under [3 clause BSD License](https://github.com/ianlancetaylor/libbacktrace/blob/master/LICENSE)
- [libexecinfo](https://github.com/NetBSD/src/tree/trunk/lib/libexecinfo) (with `gem.use_execinfo`)
under [2 clause BSD License](https://github.com/NetBSD/src/blob/trunk/lib/libexecinfo/execinfo.h)
- [libunwind](https://github.com/libunwind/libunwind) (with `gem.use_libunwind`)
under [MIT License](https://github.com/libunwind/libunwind/blob/master/COPYING)