Low cost stacktrace walking
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- JavaScript
- Estrellas
- 122k
- Forks
- 37.3k
- Merge medio
- 4 d 2 h
- PR fusionados (30 d)
- 283
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza siguiendo los puntos de entrada internos de V8 mostrados en el ejemplo, especialmente JavaScriptStackFrameIterator, JavaScriptFrame y SharedFunctionInfo, y compara la visibilidad de sus símbolos entre Node 22 y Node 24. Después, identifica la configuración de compilación o exportación que controla estos símbolos. Se considera terminado cuando un recorrido nativo de la pila sin asignaciones sigue siendo utilizable sin requerir una nueva API pública.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- cpp, nodejs
- Área
- backend
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100