llvm/XRay/FileHeaderReader.h

0001 //===- FileHeaderReader.h - XRay Trace File Header Reading Function -------===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008 //
0009 // This file declares functions that can load an XRay log header from various
0010 // sources.
0011 //
0012 //===----------------------------------------------------------------------===//
0013 #ifndef LLVM_XRAY_FILEHEADERREADER_H
0014 #define LLVM_XRAY_FILEHEADERREADER_H
0015
0016 #include "llvm/Support/DataExtractor.h"
0017 #include "llvm/Support/Error.h"
0018 #include "llvm/XRay/XRayRecord.h"
0019 #include <cstdint>
0020
0021 namespace llvm {
0022 namespace xray {
0023
0024 /// Convenience function for loading the file header given a data extractor at a
0025 /// specified offset.
0026 Expected<XRayFileHeader> readBinaryFormatHeader(DataExtractor &HeaderExtractor,
0027                                                 uint64_t &OffsetPtr);
0028
0029 } // namespace xray
0030 } // namespace llvm
0031
0032 #endif // LLVM_XRAY_FILEHEADERREADER_H