LLVM 20.0.0git
FDRTraceExpander.h
Go to the documentation of this file.
1//===- FDRTraceExpander.h - XRay FDR Mode Log Expander --------------------===//
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// We define an FDR record visitor which can re-constitute XRayRecord instances
10// from a sequence of FDR mode records in arrival order into a collection.
11//
12//===----------------------------------------------------------------------===//
13#ifndef LLVM_XRAY_FDRTRACEEXPANDER_H
14#define LLVM_XRAY_FDRTRACEEXPANDER_H
15
16#include "llvm/ADT/STLExtras.h"
19
20namespace llvm {
21namespace xray {
22
24 // Type-erased callback for handling individual XRayRecord instances.
25 function_ref<void(const XRayRecord &)> C;
26 int32_t PID = 0;
27 int32_t TID = 0;
28 uint64_t BaseTSC = 0;
29 XRayRecord CurrentRecord{0, 0, RecordTypes::ENTER, 0, 0, 0, 0, {}, {}};
30 uint16_t CPUId = 0;
31 uint16_t LogVersion = 0;
32 bool BuildingRecord = false;
33 bool IgnoringRecords = false;
34
35 void resetCurrentRecord();
36
37public:
38 explicit TraceExpander(function_ref<void(const XRayRecord &)> F, uint16_t L)
39 : C(std::move(F)), LogVersion(L) {}
40
41 Error visit(BufferExtents &) override;
42 Error visit(WallclockRecord &) override;
43 Error visit(NewCPUIDRecord &) override;
44 Error visit(TSCWrapRecord &) override;
45 Error visit(CustomEventRecord &) override;
46 Error visit(CallArgRecord &) override;
47 Error visit(PIDRecord &) override;
48 Error visit(NewBufferRecord &) override;
49 Error visit(EndBufferRecord &) override;
50 Error visit(FunctionRecord &) override;
52 Error visit(TypedEventRecord &) override;
53
54 // Must be called after all the records have been processed, to handle the
55 // most recent record generated.
56 Error flush();
57};
58
59} // namespace xray
60} // namespace llvm
61
62#endif // LLVM_XRAY_FDRTRACEEXPANDER_H
#define F(x, y, z)
Definition: MD5.cpp:55
This file contains some templates that are useful if you are working with the STL at all.
Lightweight error class with error context and mandatory checking.
Definition: Error.h:160
An efficient, type-erasing, non-owning reference to a callable.
Error visit(BufferExtents &) override
TraceExpander(function_ref< void(const XRayRecord &)> F, uint16_t L)
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1849
Implement std::hash so that hash_code can be used in STL containers.
Definition: BitVector.h:858
An XRayRecord is the denormalized view of data associated in a trace.
Definition: XRayRecord.h:69