Heap Snapshot node names aren't parameterized for Types

The heap snapshot currently outputs names that are missing Parameters when printing the names of Types. 

For example:
<img width="901" alt="Screen Shot 2022-11-08 at 6 38 27 PM" src="https://user-images.githubusercontent.com/1582097/200699317-9e22a4c2-8e90-44a8-b2b2-a6c95f84b5af.png">


The issue is that we are currently using this code to print the names of types:
https://github.com/JuliaLang/julia/blob/4ff526a8dd750b5a50a5be022a71a5e0a6c9ff80/src/gc-heap-snapshot.cpp#L217-L221

which does this:
```julia
julia> t2 = Tuple{Int,Int}
Tuple{Int64, Int64}

julia> static_shown(t2)
"Tuple{Int64, Int64}"

julia> t2.name.name
:Tuple
```

I think we should be instead following the approach used in `jl_static_show` to print the fully parameterized names of types. Something like this:
https://github.com/JuliaLang/julia/blob/4ff526a8dd750b5a50a5be022a71a5e0a6c9ff80/src/rtutils.c#L772-L845

Maybe we can factor out a helper function that shares the same code for `jl_static_show` and this code?
Or maybe we even just want to directly call `jl_static_show()` on a stringstream? Is there a reason we didn't do this in the first place?

CC: @apaz-cli, @vtjnash, @IanButterworth, @gbaraldi, @vilterp.

Thanks all! :)

https://github.com/JuliaLang/julia/blob/4ff526a8dd750b5a50a5be022a71a5e0a6c9ff80/src/rtutils.c#L798-L809

	else if (jl_is_datatype(a)) {
	type_name = string("Type{") + string(jl_symbol_name_(((_jl_datatype_t*)a)->name->name)) + string("}");
	name = StringRef(type_name);
	self_size = sizeof(jl_task_t);
	}

	else if (vt == jl_datatype_type) {
	// typeof(v) == DataType, so v is a Type object.
	// Types are printed as a fully qualified name, with parameters, e.g.
	// `Base.Set{Int}`, and function types are printed as e.g. `typeof(Main.f)`
	jl_datatype_t dv = (jl_datatype_t)v;
	jl_sym_t *globname;
	int globfunc = is_globname_binding(v, dv) && is_globfunction(v, dv, &globname);
	jl_sym_t *sym = globfunc ? globname : dv->name->name;
	char *sn = jl_symbol_name(sym);
	size_t quote = 0;
	if (dv->name == jl_tuple_typename) {
	if (dv == jl_tuple_type)
	return jl_printf(out, "Tuple");
	int taillen = 1, tlen = jl_nparams(dv), i;
	for (i = tlen-2; i >= 0; i--) {
	if (jl_tparam(dv, i) == jl_tparam(dv, tlen-1))
	taillen++;
	else
	break;
	}
	if (taillen == tlen && taillen > 3) {
	n += jl_printf(out, "NTuple{%d, ", tlen);
	n += jl_static_show_x(out, jl_tparam0(dv), depth);
	n += jl_printf(out, "}");
	}
	else {
	n += jl_printf(out, "Tuple{");
	for (i = 0; i < (taillen > 3 ? tlen-taillen : tlen); i++) {
	if (i > 0)
	n += jl_printf(out, ", ");
	n += jl_static_show_x(out, jl_tparam(dv, i), depth);
	}
	if (taillen > 3) {
	n += jl_printf(out, ", Vararg{");
	n += jl_static_show_x(out, jl_tparam(dv, tlen-1), depth);
	n += jl_printf(out, ", %d}", taillen);
	}
	n += jl_printf(out, "}");
	}
	return n;
	}
	if (globfunc) {
	n += jl_printf(out, "typeof(");
	}
	if (jl_core_module && (dv->name->module != jl_core_module \|\| !jl_module_exports_p(jl_core_module, sym))) {
	n += jl_static_show_x(out, (jl_value_t*)dv->name->module, depth);
	n += jl_printf(out, ".");
	size_t i = 0;
	if (globfunc && !jl_id_start_char(u8_nextchar(sn, &i))) {
	n += jl_printf(out, ":(");
	quote = 1;
	}
	}
	n += jl_static_show_x_sym_escaped(out, sym);
	if (globfunc) {
	n += jl_printf(out, ")");
	if (quote) {
	n += jl_printf(out, ")");
	}
	}
	if (dv->parameters && (jl_value_t*)dv != dv->name->wrapper) {
	size_t j, tlen = jl_nparams(dv);
	if (tlen > 0) {
	n += jl_printf(out, "{");
	for (j = 0; j < tlen; j++) {
	jl_value_t *p = jl_tparam(dv,j);
	n += jl_static_show_x(out, p, depth);
	if (j != tlen-1)
	n += jl_printf(out, ", ");
	}
	n += jl_printf(out, "}");
	}
	}
	}

	n += jl_printf(out, "Tuple{");
	for (i = 0; i < (taillen > 3 ? tlen-taillen : tlen); i++) {
	if (i > 0)
	n += jl_printf(out, ", ");
	n += jl_static_show_x(out, jl_tparam(dv, i), depth);
	}
	if (taillen > 3) {
	n += jl_printf(out, ", Vararg{");
	n += jl_static_show_x(out, jl_tparam(dv, tlen-1), depth);
	n += jl_printf(out, ", %d}", taillen);
	}
	n += jl_printf(out, "}");

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Heap Snapshot node names aren't parameterized for Types #47502

NHDaly
openedon Nov 8, 2022

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Heap Snapshot node names aren't parameterized for Types #47502

Description

NHDalyopenedon Nov 8, 2022

Metadata