mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-24 03:33:20 +01:00
85c0bb36c3
Summary:
In this change we move the definition of the log reading routines from
the tools directory in LLVM to {include/llvm,lib}/XRay. We improve the
documentation a little bit for the publicly accessible headers, and
adjust the top-matter. This also leads to some refactoring and cleanup
in the tooling code.
In particular, we do the following:
- Rename the class from LogReader to Trace, as it better represents
the logical set of records as opposed to a log.
- Use file type detection instead of asking the user to say what
format the input file is. This allows us to keep the interface
simple and encapsulate the logic of loading the data appropriately.
In future changes we increase the API surface and write dedicated unit
tests for the XRay library.
Depends on D24376.
Reviewers: dblaikie, echristo
Subscribers: mehdi_amini, mgorny, llvm-commits, varno
Differential Revision: https://reviews.llvm.org/D28345
llvm-svn: 291652
72 lines
2.2 KiB
C++
72 lines
2.2 KiB
C++
//===- Trace.h - XRay Trace Abstraction -----------------------------------===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// Defines the XRay Trace class representing records in an XRay trace file.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
#ifndef LLVM_XRAY_TRACE_H
|
|
#define LLVM_XRAY_TRACE_H
|
|
|
|
#include <cstdint>
|
|
#include <vector>
|
|
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include "llvm/Support/FileSystem.h"
|
|
#include "llvm/XRay/XRayRecord.h"
|
|
|
|
namespace llvm {
|
|
namespace xray {
|
|
|
|
/// A Trace object represents the records that have been loaded from XRay
|
|
/// log files generated by instrumented binaries. We encapsulate the logic of
|
|
/// reading the traces in factory functions that populate the Trace object
|
|
/// appropriately.
|
|
///
|
|
/// Trace objects provide an accessor to an XRayFileHeader which says more about
|
|
/// details of the file from which the XRay trace was loaded from.
|
|
///
|
|
/// Usage:
|
|
///
|
|
/// if (auto TraceOrErr = loadTraceFile("xray-log.something.xray")) {
|
|
/// auto& T = *TraceOrErr;
|
|
/// // T.getFileHeader() will provide information from the trace header.
|
|
/// for (const XRayRecord &R : T) {
|
|
/// // ... do something with R here.
|
|
/// }
|
|
/// } else {
|
|
/// // Handle the error here.
|
|
/// }
|
|
///
|
|
class Trace {
|
|
XRayFileHeader FileHeader;
|
|
std::vector<XRayRecord> Records;
|
|
|
|
typedef std::vector<XRayRecord>::const_iterator citerator;
|
|
|
|
friend Expected<Trace> loadTraceFile(StringRef, bool);
|
|
|
|
public:
|
|
/// Provides access to the loaded XRay trace file header.
|
|
const XRayFileHeader &getFileHeader() const { return FileHeader; }
|
|
|
|
citerator begin() const { return Records.begin(); }
|
|
citerator end() const { return Records.end(); }
|
|
size_t size() const { return Records.size(); }
|
|
};
|
|
|
|
/// This function will attempt to load XRay trace records from the provided
|
|
/// |Filename|.
|
|
Expected<Trace> loadTraceFile(StringRef Filename, bool Sort = false);
|
|
|
|
} // namespace xray
|
|
} // namespace llvm
|
|
|
|
#endif // LLVM_XRAY_TRACE_H
|