LLVM  8.0.1
Public Attributes | List of all members
llvm::xray::XRayFileHeader Struct Reference

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. More...

#include "llvm/XRay/XRayRecord.h"

Collaboration diagram for llvm::xray::XRayFileHeader:
Collaboration graph
[legend]

Public Attributes

uint16_t Version = 0
 Version of the XRay implementation that produced this file. More...
 
uint16_t Type = 0
 A numeric identifier for the type of file this is. More...
 
bool ConstantTSC
 Whether the CPU that produced the timestamp counters (TSC) move at a constant rate. More...
 
bool NonstopTSC
 Whether the CPU that produced the timestamp counters (TSC) do not stop. More...
 
uint64_t CycleFrequency = 0
 The number of cycles per second for the CPU that produced the timestamp counter (TSC) values. More...
 
char FreeFormData [16]
 

Detailed Description

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.

Definition at line 28 of file XRayRecord.h.

Member Data Documentation

◆ ConstantTSC

bool llvm::xray::XRayFileHeader::ConstantTSC

Whether the CPU that produced the timestamp counters (TSC) move at a constant rate.

Definition at line 38 of file XRayRecord.h.

Referenced by llvm::xray::FDRTraceWriter::FDRTraceWriter(), and llvm::xray::readBinaryFormatHeader().

◆ CycleFrequency

uint64_t llvm::xray::XRayFileHeader::CycleFrequency = 0

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.

Definition at line 46 of file XRayRecord.h.

Referenced by llvm::xray::FDRTraceWriter::FDRTraceWriter(), and llvm::xray::readBinaryFormatHeader().

◆ FreeFormData

char llvm::xray::XRayFileHeader::FreeFormData[16]

◆ NonstopTSC

bool llvm::xray::XRayFileHeader::NonstopTSC

Whether the CPU that produced the timestamp counters (TSC) do not stop.

Definition at line 41 of file XRayRecord.h.

Referenced by llvm::xray::FDRTraceWriter::FDRTraceWriter(), and llvm::xray::readBinaryFormatHeader().

◆ Type

uint16_t llvm::xray::XRayFileHeader::Type = 0

A numeric identifier for the type of file this is.

Best used in combination with Version.

Definition at line 34 of file XRayRecord.h.

Referenced by llvm::xray::FDRTraceWriter::FDRTraceWriter(), and llvm::xray::readBinaryFormatHeader().

◆ Version

uint16_t llvm::xray::XRayFileHeader::Version = 0

Version of the XRay implementation that produced this file.

Definition at line 30 of file XRayRecord.h.

Referenced by llvm::xray::FDRTraceWriter::FDRTraceWriter(), llvm::xray::FileBasedRecordProducer::produce(), and llvm::xray::readBinaryFormatHeader().


The documentation for this struct was generated from the following file: