Low cost stacktrace walking
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 122k
- フォーク
- 37.3k
- 平均マージ
- 4日 2時間
- マージ済み PR(30日)
- 283
説明
What is the problem this feature will solve?
Public APIs that allow for stack collection/walking are quite heavy, doing memory allocation and symbol resolution in the background.
All the necessary features are already available - but exported as local symbols, making theme very hard to use even from native code.
What is the feature you are proposing to solve the problem?
Below is example code, that used to work fine in node 20 and 22, but will not work on 24+ because the necessary symbols are not global anymore (so in a way it is regression) . I do not mind that the private API are not stable and require recompilation specific for v8. I do not need new public API - it would be nice of course, but I can easily maintain multiple version of my code. Having symbols local though, makes the project extremely complex:
struct FrameId {
uint32_t script_id;
uint32_t start_position;
uint32_t end_position;
uint32_t filler;
v8::internal::Tagged<v8::internal::SharedFunctionInfo> sfi;
};
size_t get_stack_frame_ids(v8::Isolate* isolate, FrameId* buffer, size_t max_len) {
v8::internal::JavaScriptStackFrameIterator it(reinterpret_cast<v8::internal::Isolate*>(isolate));
size_t count = 0;
while (!it.done() && count < max_len) {
v8::internal::JavaScriptFrame* frame = it.frame();
v8::internal::Tagged<v8::internal::JSFunction> function = frame->function();
v8::internal::Tagged<v8::internal::SharedFunctionInfo> sfi = function->shared();
v8::internal::Tagged<v8::internal::Script> script = v8::internal::Cast<v8::internal::Script>(sfi->script());
buffer[count].script_id = script->id();
buffer[count].start_position = sfi->StartPosition();
buffer[count].end_position = sfi->EndPosition();
buffer[count].sfi = sfi;
count++;
it.Advance();
}
return count;
}
size_t describe_frame(v8::Isolate* isolate, FrameId* frame_id, char* buffer, size_t buffer_size) {
// Fetch function name and script name
std::unique_ptr<char[]> name = frame_id->sfi->DebugNameCStr();
size_t offset = 0;
size_t i=0;
while(offset < buffer_size - 3 && name[i] != '\0') {
buffer[offset++] = name[i++];
}
buffer[offset++] = '(';
v8::internal::Tagged<v8::internal::Script> script = v8::internal::Cast<v8::internal::Script>(frame_id->sfi->script());
v8::internal::Tagged<v8::internal::Object> raw_name = script->GetNameOrSourceURL();
if (IsString(raw_name)) {
name = v8::internal::Cast<v8::internal::String>(raw_name)->ToCString();
i=0;
while(offset < buffer_size - 2 && name[i] != '\0') {
buffer[offset++] = name[i++];
}
} else {
if(offset < buffer_size - 11) {
memcpy(buffer+offset, "<unknown>", 9);
offset += 9;
}
}
buffer[offset++] = ':';
// Format the final description into the buffer
offset += snprintf(buffer+offset, buffer_size - offset, "%d:%d)", frame_id->start_position, frame_id->end_position);
// If buffer was too small, null-terminate it safely
if (offset >= buffer_size) {
buffer[buffer_size - 1] = '\0'; // Null-terminate the buffer
offset = buffer_size - 1; // Set offset to the last position
}
return offset;
}
What alternatives have you considered?
There do not seem to be alternative for "allocation free" stack walking.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、例に示されている V8 の内部エントリポイント、特に JavaScriptStackFrameIterator、JavaScriptFrame、SharedFunctionInfo を追跡し、Node 22 と Node 24 の間でそれらのシンボルの可視性を比較します。次に、これらのシンボルを制御しているビルドまたはエクスポート設定を特定します。新しい公開 API を必要とせずに、割り当てなしのネイティブスタックウォークを引き続き使用できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- cpp, nodejs
- 領域
- backend
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100