LLVM  14.0.0git
BlockVerifier.h
Go to the documentation of this file.
1 //===- BlockVerifier.h - FDR Block Verifier -------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // An implementation of the RecordVisitor which verifies a sequence of records
10 // associated with a block, following the FDR mode log format's specifications.
11 //
12 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_XRAY_BLOCKVERIFIER_H
14 #define LLVM_XRAY_BLOCKVERIFIER_H
15 
16 #include "llvm/XRay/FDRRecords.h"
17 #include <array>
18 #include <bitset>
19 
20 namespace llvm {
21 namespace xray {
22 
23 class BlockVerifier : public RecordVisitor {
24 public:
25  // We force State elements to be size_t, to be used as indices for containers.
26  enum class State : std::size_t {
27  Unknown,
29  NewBuffer,
31  PIDEntry,
32  NewCPUId,
33  TSCWrap,
35  TypedEvent,
36  Function,
37  CallArg,
39  StateMax,
40  };
41 
42 private:
43  // We keep track of the current record seen by the verifier.
44  State CurrentRecord = State::Unknown;
45 
46  // Transitions the current record to the new record, records an error on
47  // invalid transitions.
48  Error transition(State To);
49 
50 public:
51  Error visit(BufferExtents &) override;
52  Error visit(WallclockRecord &) override;
53  Error visit(NewCPUIDRecord &) override;
54  Error visit(TSCWrapRecord &) override;
55  Error visit(CustomEventRecord &) override;
56  Error visit(CallArgRecord &) override;
57  Error visit(PIDRecord &) override;
58  Error visit(NewBufferRecord &) override;
59  Error visit(EndBufferRecord &) override;
60  Error visit(FunctionRecord &) override;
61  Error visit(CustomEventRecordV5 &) override;
62  Error visit(TypedEventRecord &) override;
63 
64  Error verify();
65  void reset();
66 };
67 
68 } // namespace xray
69 } // namespace llvm
70 
71 #endif // LLVM_XRAY_BLOCKVERIFIER_H
llvm::xray::BlockVerifier::State
State
Definition: BlockVerifier.h:26
llvm
---------------------— PointerInfo ------------------------------------—
Definition: AllocatorList.h:23
llvm::xray::BlockVerifier::State::NewBuffer
@ NewBuffer
llvm::xray::RecordVisitor
Definition: FDRRecords.h:399
llvm::xray::BlockVerifier::State::Unknown
@ Unknown
llvm::xray::BlockVerifier::reset
void reset()
Definition: BlockVerifier.cpp:201
llvm::xray::FunctionRecord
Definition: FDRRecords.h:372
llvm::xray::BlockVerifier::State::TSCWrap
@ TSCWrap
llvm::xray::PIDRecord
Definition: FDRRecords.h:313
llvm::xray::BlockVerifier::State::CustomEvent
@ CustomEvent
llvm::xray::BufferExtents
Definition: FDRRecords.h:110
llvm::xray::BlockVerifier::State::WallClockTime
@ WallClockTime
llvm::xray::NewCPUIDRecord
Definition: FDRRecords.h:158
llvm::xray::BlockVerifier::visit
Error visit(BufferExtents &) override
Definition: BlockVerifier.cpp:136
llvm::xray::NewBufferRecord
Definition: FDRRecords.h:336
llvm::xray::BlockVerifier::State::EndOfBuffer
@ EndOfBuffer
llvm::xray::BlockVerifier
Definition: BlockVerifier.h:23
llvm::xray::BlockVerifier::State::PIDEntry
@ PIDEntry
llvm::xray::EndBufferRecord
Definition: FDRRecords.h:359
llvm::xray::WallclockRecord
Definition: FDRRecords.h:133
llvm::xray::CallArgRecord
Definition: FDRRecords.h:291
llvm::xray::TypedEventRecord
Definition: FDRRecords.h:262
llvm::xray::TSCWrapRecord
Definition: FDRRecords.h:184
llvm::xray::BlockVerifier::State::TypedEvent
@ TypedEvent
llvm::xray::BlockVerifier::State::Function
@ Function
llvm::xray::BlockVerifier::State::BufferExtents
@ BufferExtents
llvm::xray::BlockVerifier::State::NewCPUId
@ NewCPUId
llvm::xray::BlockVerifier::verify
Error verify()
Definition: BlockVerifier.cpp:182
llvm::Error
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
llvm::xray::BlockVerifier::State::StateMax
@ StateMax
llvm::xray::CustomEventRecord
Definition: FDRRecords.h:206
llvm::xray::CustomEventRecordV5
Definition: FDRRecords.h:235
FDRRecords.h
llvm::xray::BlockVerifier::State::CallArg
@ CallArg