mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-23 19:23:23 +01:00
21c2bce874
Summary: This change cuts across LLVM and compiler-rt to add support for rendering custom events in the XRayRecord type, to allow for including user-provided annotations in the output YAML (as raw bytes). This work enables us to add custom event and typed event records into the `llvm::xray::Trace` type for user-provided events. This can then be programmatically handled through the C++ API and can be included in some of the tooling as well. For now we support printing the raw data we encounter in the custom events in the converted output. Future work will allow us to start interpreting these custom and typed events through a yet-to-be-defined API for extending the trace analysis library. Reviewers: mboerger Subscribers: hiraditya, llvm-commits Differential Revision: https://reviews.llvm.org/D54139 llvm-svn: 346214
106 lines
3.3 KiB
C++
106 lines
3.3 KiB
C++
//===- XRayRecord.h - XRay Trace Record -----------------------------------===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file replicates the record definition for XRay log entries. This should
|
|
// follow the evolution of the log record versions supported in the compiler-rt
|
|
// xray project.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
#ifndef LLVM_XRAY_XRAY_RECORD_H
|
|
#define LLVM_XRAY_XRAY_RECORD_H
|
|
|
|
#include <cstdint>
|
|
#include <vector>
|
|
#include <string>
|
|
|
|
namespace llvm {
|
|
namespace xray {
|
|
|
|
/// XRay traces all have a header providing some top-matter information useful
|
|
/// to help tools determine how to interpret the information available in the
|
|
/// trace.
|
|
struct XRayFileHeader {
|
|
/// Version of the XRay implementation that produced this file.
|
|
uint16_t Version = 0;
|
|
|
|
/// A numeric identifier for the type of file this is. Best used in
|
|
/// combination with Version.
|
|
uint16_t Type = 0;
|
|
|
|
/// Whether the CPU that produced the timestamp counters (TSC) move at a
|
|
/// constant rate.
|
|
bool ConstantTSC;
|
|
|
|
/// Whether the CPU that produced the timestamp counters (TSC) do not stop.
|
|
bool NonstopTSC;
|
|
|
|
/// The number of cycles per second for the CPU that produced the timestamp
|
|
/// counter (TSC) values. Useful for estimating the amount of time that
|
|
/// elapsed between two TSCs on some platforms.
|
|
uint64_t CycleFrequency = 0;
|
|
|
|
// This is different depending on the type of xray record. The naive format
|
|
// stores a Wallclock timespec. FDR logging stores the size of a thread
|
|
// buffer.
|
|
char FreeFormData[16];
|
|
};
|
|
|
|
/// Determines the supported types of records that could be seen in XRay traces.
|
|
/// This may or may not correspond to actual record types in the raw trace (as
|
|
/// the loader implementation may synthesize this information in the process of
|
|
/// of loading).
|
|
enum class RecordTypes {
|
|
ENTER,
|
|
EXIT,
|
|
TAIL_EXIT,
|
|
ENTER_ARG,
|
|
CUSTOM_EVENT,
|
|
TYPED_EVENT
|
|
};
|
|
|
|
/// An XRayRecord is the denormalized view of data associated in a trace. These
|
|
/// records may not correspond to actual entries in the raw traces, but they are
|
|
/// the logical representation of records in a higher-level event log.
|
|
struct XRayRecord {
|
|
/// RecordType values are used as "sub-types" which have meaning in the
|
|
/// context of the `Type` below. For function call and custom event records,
|
|
/// the RecordType is always 0, while for typed events we store the type in
|
|
/// the RecordType field.
|
|
uint16_t RecordType;
|
|
|
|
/// The CPU where the thread is running. We assume number of CPUs <= 65536.
|
|
uint16_t CPU;
|
|
|
|
/// Identifies the type of record.
|
|
RecordTypes Type;
|
|
|
|
/// The function ID for the record, if this is a function call record.
|
|
int32_t FuncId;
|
|
|
|
/// Get the full 8 bytes of the TSC when we get the log record.
|
|
uint64_t TSC;
|
|
|
|
/// The thread ID for the currently running thread.
|
|
uint32_t TId;
|
|
|
|
/// The process ID for the currently running process.
|
|
uint32_t PId;
|
|
|
|
/// The function call arguments.
|
|
std::vector<uint64_t> CallArgs;
|
|
|
|
/// For custom and typed events, we provide the raw data from the trace.
|
|
std::string Data;
|
|
};
|
|
|
|
} // namespace xray
|
|
} // namespace llvm
|
|
|
|
#endif // LLVM_XRAY_XRAY_RECORD_H
|