Avi Drissman | dfd88085 | 2022-09-15 20:11:09 | [diff] [blame] | 1 | // Copyright 2015 The Chromium Authors |
yutak | 4d2f1c7f | 2015-09-16 10:29:36 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef TOOLS_BLINK_GC_PLUGIN_CHECK_FIELDS_VISITOR_H_ |
| 6 | #define TOOLS_BLINK_GC_PLUGIN_CHECK_FIELDS_VISITOR_H_ |
| 7 | |
| 8 | #include <vector> |
| 9 | |
sigbjornf | 55a04e9c | 2017-05-24 18:37:23 | [diff] [blame] | 10 | #include "BlinkGCPluginOptions.h" |
yutak | 4d2f1c7f | 2015-09-16 10:29:36 | [diff] [blame] | 11 | #include "Edge.h" |
| 12 | |
yutak | 4d2f1c7f | 2015-09-16 10:29:36 | [diff] [blame] | 13 | class FieldPoint; |
| 14 | |
| 15 | // This visitor checks that the fields of a class are "well formed". |
Anton Bikineev | 547e673 | 2020-04-01 16:53:58 | [diff] [blame] | 16 | // - unique_ptr, scoped_refptr and WeakPtr must not point to a GC derived type. |
sigbjornf | 1465e995 | 2016-04-19 12:24:40 | [diff] [blame] | 17 | // - Part objects must not be a GC derived type. |
yutak | 4d2f1c7f | 2015-09-16 10:29:36 | [diff] [blame] | 18 | // - An on-heap class must never contain GC roots. |
| 19 | // - Only stack-allocated types may point to stack-allocated types. |
| 20 | |
| 21 | class CheckFieldsVisitor : public RecursiveEdgeVisitor { |
| 22 | public: |
| 23 | enum Error { |
| 24 | kRawPtrToGCManaged, |
yutak | 4d2f1c7f | 2015-09-16 10:29:36 | [diff] [blame] | 25 | kRefPtrToGCManaged, |
| 26 | kReferencePtrToGCManaged, |
sigbjornf | 163954b | 2016-06-20 11:24:57 | [diff] [blame] | 27 | kUniquePtrToGCManaged, |
yutak | 4d2f1c7f | 2015-09-16 10:29:36 | [diff] [blame] | 28 | kMemberToGCUnmanaged, |
| 29 | kMemberInUnmanaged, |
Omer Katz | b4a61dd | 2023-11-09 09:09:20 | [diff] [blame] | 30 | kPtrToMemberInUnmanaged, |
yutak | 4d2f1c7f | 2015-09-16 10:29:36 | [diff] [blame] | 31 | kPtrFromHeapToStack, |
sigbjornf | 1fb76ab1 | 2016-12-20 13:22:15 | [diff] [blame] | 32 | kGCDerivedPartObject, |
| 33 | kIteratorToGCManaged, |
Anton Bikineev | 1f34a19 | 2020-01-23 10:22:55 | [diff] [blame] | 34 | kMemberInStackAllocated, |
Anton Bikineev | 91bb1a5 | 2023-10-30 15:35:19 | [diff] [blame] | 35 | kTraceablePartObjectInUnmanaged, |
Omer Katz | df57e41 | 2024-03-12 17:54:16 | [diff] [blame] | 36 | kRawPtrToTraceable, |
| 37 | kRefPtrToTraceable, |
| 38 | kReferencePtrToTraceable, |
| 39 | kUniquePtrToTraceable, |
yutak | 4d2f1c7f | 2015-09-16 10:29:36 | [diff] [blame] | 40 | }; |
| 41 | |
sigbjornf | adf651b | 2016-04-28 12:06:47 | [diff] [blame] | 42 | using Errors = std::vector<std::pair<FieldPoint*, Error>>; |
yutak | 4d2f1c7f | 2015-09-16 10:29:36 | [diff] [blame] | 43 | |
sigbjornf | 55a04e9c | 2017-05-24 18:37:23 | [diff] [blame] | 44 | explicit CheckFieldsVisitor(const BlinkGCPluginOptions&); |
yutak | 4d2f1c7f | 2015-09-16 10:29:36 | [diff] [blame] | 45 | |
| 46 | Errors& invalid_fields(); |
| 47 | |
| 48 | bool ContainsInvalidFields(RecordInfo* info); |
| 49 | |
sigbjornf | 55a04e9c | 2017-05-24 18:37:23 | [diff] [blame] | 50 | void AtMember(Member*) override; |
| 51 | void AtWeakMember(WeakMember*) override; |
| 52 | void AtValue(Value*) override; |
| 53 | void AtCollection(Collection*) override; |
sigbjornf | 1fb76ab1 | 2016-12-20 13:22:15 | [diff] [blame] | 54 | void AtIterator(Iterator*) override; |
yutak | 4d2f1c7f | 2015-09-16 10:29:36 | [diff] [blame] | 55 | |
yutak | 4d2f1c7f | 2015-09-16 10:29:36 | [diff] [blame] | 56 | private: |
sigbjornf | 55a04e9c | 2017-05-24 18:37:23 | [diff] [blame] | 57 | const BlinkGCPluginOptions& options_; |
| 58 | |
yutak | 4d2f1c7f | 2015-09-16 10:29:36 | [diff] [blame] | 59 | FieldPoint* current_; |
| 60 | bool stack_allocated_host_; |
| 61 | bool managed_host_; |
| 62 | Errors invalid_fields_; |
| 63 | }; |
| 64 | |
| 65 | #endif // TOOLS_BLINK_GC_PLUGIN_CHECK_FIELDS_VISITOR_H_ |