Low cost stacktrace walking
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 122k
- Fork
- 37.3k
- Merge medio
- 4g 2h
- PR unite (30g)
- 283
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia tracciando i punti di ingresso interni di V8 mostrati nell’esempio, in particolare JavaScriptStackFrameIterator, JavaScriptFrame e SharedFunctionInfo, e confronta la visibilità dei relativi simboli tra Node 22 e Node 24. Individua quindi la configurazione di build o di esportazione che controlla questi simboli. Il lavoro è completato quando una scansione nativa dello stack senza allocazioni rimane utilizzabile senza richiedere una nuova API pubblica.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- cpp, nodejs
- Ambito
- backend
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 38/100