LLVM  14.0.0git
BlockIndexer.h
Go to the documentation of this file.
1 //===- BlockIndexer.h - FDR Block Indexing Visitor ------------------------===//
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 generates a mapping between a
10 // thread and a range of records representing a block.
11 //
12 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_XRAY_BLOCKINDEXER_H
14 #define LLVM_XRAY_BLOCKINDEXER_H
15 
16 #include "llvm/ADT/DenseMap.h"
17 #include "llvm/XRay/FDRRecords.h"
18 #include <cstdint>
19 #include <vector>
20 
21 namespace llvm {
22 namespace xray {
23 
24 // The BlockIndexer will gather all related records associated with a
25 // process+thread and group them by 'Block'.
26 class BlockIndexer : public RecordVisitor {
27 public:
28  struct Block {
30  int32_t ThreadID;
32  std::vector<Record *> Records;
33  };
34 
35  // This maps the process + thread combination to a sequence of blocks.
36  using Index = DenseMap<std::pair<uint64_t, int32_t>, std::vector<Block>>;
37 
38 private:
39  Index &Indices;
40 
41  Block CurrentBlock{0, 0, nullptr, {}};
42 
43 public:
44  explicit BlockIndexer(Index &I) : RecordVisitor(), Indices(I) {}
45 
46  Error visit(BufferExtents &) override;
47  Error visit(WallclockRecord &) override;
48  Error visit(NewCPUIDRecord &) override;
49  Error visit(TSCWrapRecord &) override;
50  Error visit(CustomEventRecord &) override;
51  Error visit(CallArgRecord &) override;
52  Error visit(PIDRecord &) override;
53  Error visit(NewBufferRecord &) override;
54  Error visit(EndBufferRecord &) override;
55  Error visit(FunctionRecord &) override;
56  Error visit(CustomEventRecordV5 &) override;
57  Error visit(TypedEventRecord &) override;
58 
59  /// The flush() function will clear out the current state of the visitor, to
60  /// allow for explicitly flushing a block's records to the currently
61  /// recognized thread and process combination.
62  Error flush();
63 };
64 
65 } // namespace xray
66 } // namespace llvm
67 
68 #endif // LLVM_XRAY_BLOCKINDEXER_H
llvm::xray::BlockIndexer::visit
Error visit(BufferExtents &) override
Definition: BlockIndexer.cpp:18
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AllocatorList.h:23
llvm::xray::BlockIndexer::BlockIndexer
BlockIndexer(Index &I)
Definition: BlockIndexer.h:44
llvm::xray::RecordVisitor
Definition: FDRRecords.h:399
llvm::xray::FunctionRecord
Definition: FDRRecords.h:372
llvm::xray::PIDRecord
Definition: FDRRecords.h:313
llvm::xray::BlockIndexer::Block
Definition: BlockIndexer.h:28
DenseMap.h
llvm::xray::BufferExtents
Definition: FDRRecords.h:110
llvm::xray::NewCPUIDRecord
Definition: FDRRecords.h:158
llvm::xray::BlockIndexer::Block::ProcessID
uint64_t ProcessID
Definition: BlockIndexer.h:29
llvm::xray::BlockIndexer::flush
Error flush()
The flush() function will clear out the current state of the visitor, to allow for explicitly flushin...
Definition: BlockIndexer.cpp:82
llvm::xray::NewBufferRecord
Definition: FDRRecords.h:336
llvm::xray::BlockIndexer::Block::ThreadID
int32_t ThreadID
Definition: BlockIndexer.h:30
uint64_t
llvm::DenseMap
Definition: DenseMap.h:714
I
#define I(x, y, z)
Definition: MD5.cpp:59
llvm::xray::EndBufferRecord
Definition: FDRRecords.h:359
llvm::xray::WallclockRecord
Definition: FDRRecords.h:133
llvm::xray::BlockIndexer::Block::Records
std::vector< Record * > Records
Definition: BlockIndexer.h:32
llvm::xray::CallArgRecord
Definition: FDRRecords.h:291
llvm::xray::TypedEventRecord
Definition: FDRRecords.h:262
llvm::xray::TSCWrapRecord
Definition: FDRRecords.h:184
llvm::xray::BlockIndexer
Definition: BlockIndexer.h:26
llvm::xray::BlockIndexer::Block::WallclockTime
WallclockRecord * WallclockTime
Definition: BlockIndexer.h:31
llvm::Error
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
llvm::xray::CustomEventRecord
Definition: FDRRecords.h:206
llvm::xray::CustomEventRecordV5
Definition: FDRRecords.h:235
FDRRecords.h