//===- BoundsChecking.h - Bounds checking instrumentation -------*- 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
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_TRANSFORMS_INSTRUMENTATION_BOUNDSCHECKING_H
#define LLVM_TRANSFORMS_INSTRUMENTATION_BOUNDSCHECKING_H

#include "llvm/IR/PassManager.h"
#include "llvm/Support/Compiler.h"
#include "llvm/TargetParser/Triple.h"
#include <optional>

namespace llvm {
class Function;

/// A pass to instrument code and perform run-time bounds checking on loads,
/// stores, and other memory intrinsics.
class BoundsCheckingPass : public PassInfoMixin<BoundsCheckingPass> {

public:
  struct Options {
    struct Runtime {
      Runtime(bool MinRuntime, bool MayReturn, bool HandlerPreserveAllRegs)
          : MinRuntime(MinRuntime), MayReturn(MayReturn),
            HandlerPreserveAllRegs(HandlerPreserveAllRegs) {}
      bool MinRuntime;
      bool MayReturn;
      bool HandlerPreserveAllRegs;
    };
    std::optional<Runtime> Rt; // Trap if empty.
    bool Merge = false;
    std::optional<int8_t> GuardKind; // `allow_ubsan_check` argument.
  };

  BoundsCheckingPass(Options Opts) : Opts(Opts) {}
  LLVM_ABI PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);
  static bool isRequired() { return true; }
  LLVM_ABI void
  printPipeline(raw_ostream &OS,
                function_ref<StringRef(StringRef)> MapClassName2PassName);

private:
  Options Opts;
};

} // end namespace llvm

#endif // LLVM_TRANSFORMS_INSTRUMENTATION_BOUNDSCHECKING_H
