ladybird/Tests/ClangPlugins/LibJSGCTests/substruct_on_stack_ok.cpp
Andreas Kling 95b464fb8b ClangPlugins: Check for GC pointers in non-Cell substruct members
This extends the LibJSGC Clang plugin to detect GC pointers (GC::Ptr,
GC::Ref, JS::Value, etc.) inside non-GC-allocated struct/class members.

When a GC::Cell has a member of a non-Cell type that contains GC
pointers, we now enforce that:

1. The non-Cell type must have a visit_edges(GC::Cell::Visitor&) method
2. The Cell's visit_edges must access that member (presumably to call
   its visit_edges)

The check works recursively, so nested structs and containers like
Vector<GC::Ptr<T>> or HashMap<K, GC::Ptr<V>> are handled correctly.

GC infrastructure types (Root, Heap, etc.) and AK library types are
excluded from these checks as they handle visitation differently.
2026-01-07 12:48:58 +01:00

24 lines
602 B
C++

/*
* Copyright (c) 2026, Andreas Kling <andreas@ladybird.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
// RUN: %clang++ -Xclang -verify %plugin_opts% -c %s -o %t 2>&1
// expected-no-diagnostics
#include <LibGC/Cell.h>
#include <LibGC/Ptr.h>
// A substruct that contains GC pointers but has no visit_edges method.
// This is fine because it's only used on the stack (conservative scanning).
struct StackOnlySubStruct {
GC::Ptr<GC::Cell> m_object;
};
void some_function(GC::Cell& cell)
{
// Using the substruct on the stack is fine
StackOnlySubStruct s;
s.m_object = &cell;
}