Skip to content

fix: Add recursion limit when hovering on const values #21504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Wilfred wants to merge 1 commit into from
Closed

fix: Add recursion limit when hovering on const values #21504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 26 additions & 7 deletions crates/hir-ty/src/display.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -702,6 +702,7 @@ impl<'db> HirDisplay<'db> for Const<'db> {
&const_bytes.value.inner().memory,
&const_bytes.value.inner().memory_map,
const_bytes.ty,
CONST_SCALAR_RENDER_DEPTH_LIMIT,
),
ConstKind::Unevaluated(unev) => {
let c = unev.def.0;
Expand All @@ -715,16 +716,24 @@ impl<'db> HirDisplay<'db> for Const<'db> {
}
}

/// Maximum recursion depth for rendering const scalars.
/// This prevents stack overflow with self-referential data structures.
const CONST_SCALAR_RENDER_DEPTH_LIMIT: usize = 20;

fn render_const_scalar<'db>(
f: &mut HirFormatter<'_, 'db>,
b: &[u8],
memory_map: &MemoryMap<'db>,
ty: Ty<'db>,
depth: usize,
) -> Result {
if depth == 0 {
return f.write_str("<recursion-limit>");
}
let param_env = ParamEnv::empty();
let infcx = f.interner.infer_ctxt().build(TypingMode::PostAnalysis);
let ty = infcx.at(&ObligationCause::new(), param_env).deeply_normalize(ty).unwrap_or(ty);
render_const_scalar_inner(f, b, memory_map, ty, param_env)
render_const_scalar_inner(f, b, memory_map, ty, param_env, depth)
}

fn render_const_scalar_inner<'db>(
Expand All @@ -733,6 +742,7 @@ fn render_const_scalar_inner<'db>(
memory_map: &MemoryMap<'db>,
ty: Ty<'db>,
param_env: ParamEnv<'db>,
depth: usize,
) -> Result {
use TyKind;
let param_env = ParamEnvAndCrate { param_env, krate: f.krate() };
Expand Down Expand Up @@ -822,7 +832,13 @@ fn render_const_scalar_inner<'db>(
f.write_str(", ")?;
}
let offset = size_one * i;
render_const_scalar(f, &bytes[offset..offset + size_one], memory_map, ty)?;
render_const_scalar(
f,
&bytes[offset..offset + size_one],
memory_map,
ty,
depth - 1,
)?;
}
f.write_str("]")
}
Expand All @@ -840,7 +856,7 @@ fn render_const_scalar_inner<'db>(
return f.write_str("<ref-data-not-available>");
};
f.write_str("&")?;
render_const_scalar(f, bytes, memory_map, t)
render_const_scalar(f, bytes, memory_map, t, depth - 1)
}
TyKind::Adt(adt, _) if b.len() == 2 * size_of::<usize>() => match adt.def_id().0 {
hir_def::AdtId::StructId(s) => {
Expand Down Expand Up @@ -870,7 +886,7 @@ fn render_const_scalar_inner<'db>(
return f.write_str("<ref-data-not-available>");
};
f.write_str("&")?;
render_const_scalar(f, bytes, memory_map, t)
render_const_scalar(f, bytes, memory_map, t, depth - 1)
}
},
TyKind::Tuple(tys) => {
Expand All @@ -891,7 +907,7 @@ fn render_const_scalar_inner<'db>(
continue;
};
let size = layout.size.bytes_usize();
render_const_scalar(f, &b[offset..offset + size], memory_map, ty)?;
render_const_scalar(f, &b[offset..offset + size], memory_map, ty, depth - 1)?;
}
f.write_str(")")
}
Expand All @@ -914,6 +930,7 @@ fn render_const_scalar_inner<'db>(
args,
b,
memory_map,
depth,
)
}
hir_def::AdtId::UnionId(u) => {
Expand Down Expand Up @@ -946,6 +963,7 @@ fn render_const_scalar_inner<'db>(
args,
b,
memory_map,
depth,
)
}
}
Expand Down Expand Up @@ -973,7 +991,7 @@ fn render_const_scalar_inner<'db>(
f.write_str(", ")?;
}
let offset = size_one * i;
render_const_scalar(f, &b[offset..offset + size_one], memory_map, ty)?;
render_const_scalar(f, &b[offset..offset + size_one], memory_map, ty, depth - 1)?;
}
f.write_str("]")
}
Expand Down Expand Up @@ -1006,6 +1024,7 @@ fn render_variant_after_name<'db>(
args: GenericArgs<'db>,
b: &[u8],
memory_map: &MemoryMap<'db>,
depth: usize,
) -> Result {
let param_env = ParamEnvAndCrate { param_env, krate: f.krate() };
match data.shape {
Expand All @@ -1017,7 +1036,7 @@ fn render_variant_after_name<'db>(
return f.write_str("<layout-error>");
};
let size = layout.size.bytes_usize();
render_const_scalar(f, &b[offset..offset + size], memory_map, ty)
render_const_scalar(f, &b[offset..offset + size], memory_map, ty, depth - 1)
};
let mut it = data.fields().iter();
if matches!(data.shape, FieldsShape::Record) {
Expand Down
52 changes: 52 additions & 0 deletions crates/ide/src/hover/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11311,3 +11311,55 @@ pub trait MyTrait {
"#]],
);
}

#[test]
fn hover_recursive_const_fn() {
check(
r#"
//- minicore: option
enum Child {
Static { child: &'static MyEnum },
}

enum MyEnum {
Unit,
Array(Child),
}

impl MyEnum {
pub const fn static_array(child: &'static MyEnum) -> Self {
MyEnum::Array(Child::Static { child })
}
}

pub trait MyTrait {
const MY_CONST: &'static MyEnum;
}

impl<T> MyTrait for Option<T> where T: MyTrait {
const MY_CONST: &'static MyEnum = &MyEnum::static_array(T::MY_CONST);
}

impl MyTrait for () {
const MY_CONST: &'static MyEnum = &MyEnum::Unit;
}

pub struct Address;

impl MyTrait for Address {
const MY_CONST$0: &'static MyEnum = (<Option<()> as MyTrait>::MY_CONST);
}
"#,
expect![[r#"
*MY_CONST*

```rust
ra_test_fixture::Address
```

```rust
const MY_CONST: &'static MyEnum = &Array(Static { child: &Array(Static { child: &Array(Static { child: &Array(Static { child: &Array(Static { child: &Array(Static { child: &Array(<recursion-limit>) }) }) }) }) }) })
```
"#]],
);
}