llvm/llvm/include/llvm/Remarks/BitstreamRemarkContainer.h

//===-- BitstreamRemarkContainer.h - Container for remarks --------------*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file provides declarations for things used in the various types of
// remark containers.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_REMARKS_BITSTREAMREMARKCONTAINER_H
#define LLVM_REMARKS_BITSTREAMREMARKCONTAINER_H

#include "llvm/ADT/StringRef.h"
#include "llvm/Bitstream/BitCodes.h"
#include <cstdint>

namespace llvm {
namespace remarks {

/// The current version of the remark container.
/// Note: this is different from the version of the remark entry.
constexpr uint64_t CurrentContainerVersion = …;
/// The magic number used for identifying remark blocks.
constexpr StringLiteral ContainerMagic("RMRK");

/// Type of the remark container.
/// The remark container has two modes:
/// * separate: the metadata is separate from the remarks and points to the
///             auxiliary file that contains the remarks.
/// * standalone: the metadata and the remarks are emitted together.
enum class BitstreamRemarkContainerType { … };

/// The possible blocks that will be encountered in a bitstream remark
/// container.
enum BlockIDs { … };

constexpr StringRef MetaBlockName = …;
constexpr StringRef RemarkBlockName = …;

/// The possible records that can be encountered in the previously described
/// blocks.
enum RecordIDs { … };

constexpr StringRef MetaContainerInfoName = …;
constexpr StringRef MetaRemarkVersionName = …;
constexpr StringRef MetaStrTabName = …;
constexpr StringRef MetaExternalFileName = …;
constexpr StringRef RemarkHeaderName = …;
constexpr StringRef RemarkDebugLocName = …;
constexpr StringRef RemarkHotnessName = …;
constexpr StringRef RemarkArgWithDebugLocName = …;
constexpr StringRef RemarkArgWithoutDebugLocName = …;

} // end namespace remarks
} // end namespace llvm

#endif // LLVM_REMARKS_BITSTREAMREMARKCONTAINER_H