llvm/bolt/include/bolt/Rewrite/MetadataRewriter.h

//===- bolt/Rewrite/MetadataRewriter.h --------------------------*- C++ -*-===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// Interface for reading and updating metadata in a file.
//
//===----------------------------------------------------------------------===//

#ifndef BOLT_REWRITE_METADATA_REWRITER_H
#define BOLT_REWRITE_METADATA_REWRITER_H

#include "bolt/Core/BinaryContext.h"
#include "llvm/Support/Error.h"

namespace llvm {
namespace bolt {

/// Base class for handling file sections with metadata. In this context,
/// metadata encompasses a wide range of data that references code and other
/// data. Such metadata may or may not have an impact on program execution.
/// Examples include: debug information, unwind information, exception handling
/// tables, etc.
//
/// The metadata can occupy a section (e.g. .note.stapsdt), span a number of
/// sections (e.g.,  DWARF debug info), or exist as subsection of another
/// section in the binary (e.g., static-key jump tables embedded in .rodata
/// section in the Linux Kernel).
class MetadataRewriter { … };

} // namespace bolt
} // namespace llvm

#endif // BOLT_REWRITE_METADATA_REWRITER_H