File Manager

003 File Manager

Current Path: /usr/src/contrib/llvm-project/llvm/include/llvm/IR

usr / src / contrib / llvm-project / llvm / include / llvm / IR /

📁 ..
📄 AbstractCallSite.h(9.5 KB)
📄 Argument.h(5.03 KB)
📄 AssemblyAnnotationWriter.h(2.2 KB)
📄 Attributes.h(35.5 KB)
📄 Attributes.td(8.96 KB)
📄 AutoUpgrade.h(3.96 KB)
📄 BasicBlock.h(21.91 KB)
📄 CFG.h(13.84 KB)
📄 CallingConv.h(9.27 KB)
📄 Comdat.h(2.16 KB)
📄 Constant.h(8.33 KB)
📄 ConstantFolder.h(10.01 KB)
📄 ConstantRange.h(21.6 KB)
📄 Constants.h(53.03 KB)
📄 ConstrainedOps.def(5.4 KB)
📄 DIBuilder.h(44.36 KB)
📄 DataLayout.h(24.11 KB)
📄 DebugInfo.h(5.42 KB)
📄 DebugInfoFlags.def(3.62 KB)
📄 DebugInfoMetadata.h(132.91 KB)
📄 DebugLoc.h(4.57 KB)
📄 DerivedTypes.h(26.81 KB)
📄 DerivedUser.h(1.32 KB)
📄 DiagnosticHandler.h(2.89 KB)
📄 DiagnosticInfo.h(41.02 KB)
📄 DiagnosticPrinter.h(3.46 KB)
📄 Dominators.h(9.94 KB)
📄 FPEnv.h(1.97 KB)
📄 FixedMetadataKinds.def(2.05 KB)
📄 Function.h(31.39 KB)
📄 GVMaterializer.h(1.45 KB)
📄 GetElementPtrTypeIterator.h(5.54 KB)
📄 GlobalAlias.h(3.16 KB)
📄 GlobalIFunc.h(2.51 KB)
📄 GlobalIndirectSymbol.h(3.11 KB)
📄 GlobalObject.h(7.39 KB)
📄 GlobalValue.h(21.2 KB)
📄 GlobalVariable.h(9.6 KB)
📄 IRBuilder.h(105.58 KB)
📄 IRBuilderFolder.h(7.1 KB)
📄 IRPrintingPasses.h(3.57 KB)
📄 InlineAsm.h(15.84 KB)
📄 InstIterator.h(5.06 KB)
📄 InstVisitor.h(13.95 KB)
📄 InstrTypes.h(86.25 KB)
📄 Instruction.def(8.53 KB)
📄 Instruction.h(30.74 KB)
📄 Instructions.h(195.68 KB)
📄 IntrinsicInst.h(29.03 KB)
📄 Intrinsics.h(8.21 KB)
📄 Intrinsics.td(78.88 KB)
📄 IntrinsicsAArch64.td(100.59 KB)
📄 IntrinsicsAMDGPU.td(80.43 KB)
📄 IntrinsicsARM.td(65.15 KB)
📄 IntrinsicsBPF.td(1.54 KB)
📄 IntrinsicsHexagon.td(11.53 KB)
📄 IntrinsicsHexagonDep.td(197.38 KB)
📄 IntrinsicsMips.td(94.94 KB)
📄 IntrinsicsNVVM.td(193.97 KB)
📄 IntrinsicsPowerPC.td(68.23 KB)
📄 IntrinsicsRISCV.td(3.24 KB)
📄 IntrinsicsSystemZ.td(18.56 KB)
📄 IntrinsicsWebAssembly.td(9.38 KB)
📄 IntrinsicsX86.td(242.99 KB)
📄 IntrinsicsXCore.td(6.83 KB)
📄 LLVMContext.h(14.18 KB)
📄 LLVMRemarkStreamer.h(3.36 KB)
📄 LegacyPassManager.h(3.11 KB)
📄 LegacyPassManagers.h(18.17 KB)
📄 LegacyPassNameParser.h(3.73 KB)
📄 MDBuilder.h(8.65 KB)
📄 Mangler.h(2.06 KB)
📄 MatrixBuilder.h(8.81 KB)
📄 Metadata.def(5.07 KB)
📄 Metadata.h(45.24 KB)
📄 Module.h(34.6 KB)
📄 ModuleSlotTracker.h(2.56 KB)
📄 ModuleSummaryIndex.h(58.12 KB)
📄 ModuleSummaryIndexYAML.h(10.93 KB)
📄 NoFolder.h(11.32 KB)
📄 OperandTraits.h(5.78 KB)
📄 Operator.h(19.58 KB)
📄 OptBisect.h(2.79 KB)
📄 PassInstrumentation.h(8.05 KB)
📄 PassManager.h(54.18 KB)
📄 PassManagerImpl.h(5.76 KB)
📄 PassManagerInternal.h(11.9 KB)
📄 PassTimingInfo.h(3.65 KB)
📄 PatternMatch.h(73.41 KB)
📄 PredIteratorCache.h(2.59 KB)
📄 ProfileSummary.h(4.34 KB)
📄 RuntimeLibcalls.def(24.52 KB)
📄 SafepointIRVerifier.h(1.63 KB)
📄 Statepoint.h(13.61 KB)
📄 SymbolTableListTraits.h(4.45 KB)
📄 TrackingMDRef.h(4.5 KB)
📄 Type.h(18.98 KB)
📄 TypeFinder.h(2.57 KB)
📄 Use.h(3.75 KB)
📄 UseListOrder.h(1.18 KB)
📄 User.h(11.75 KB)
📄 VPIntrinsics.def(2.34 KB)
📄 Value.def(3.62 KB)
📄 Value.h(32.16 KB)
📄 ValueHandle.h(18.11 KB)
📄 ValueMap.h(14.09 KB)
📄 ValueSymbolTable.h(4.22 KB)
📄 Verifier.h(5.47 KB)

Editing: PassInstrumentation.h

//===- llvm/IR/PassInstrumentation.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
//
//===----------------------------------------------------------------------===//
/// \file
///
/// This file defines the Pass Instrumentation classes that provide
/// instrumentation points into the pass execution by PassManager.
///
/// There are two main classes:
///   - PassInstrumentation provides a set of instrumentation points for
///     pass managers to call on.
///
///   - PassInstrumentationCallbacks registers callbacks and provides access
///     to them for PassInstrumentation.
///
/// PassInstrumentation object is being used as a result of
/// PassInstrumentationAnalysis (so it is intended to be easily copyable).
///
/// Intended scheme of use for Pass Instrumentation is as follows:
///    - register instrumentation callbacks in PassInstrumentationCallbacks
///      instance. PassBuilder provides helper for that.
///
///    - register PassInstrumentationAnalysis with all the PassManagers.
///      PassBuilder handles that automatically when registering analyses.
///
///    - Pass Manager requests PassInstrumentationAnalysis from analysis manager
///      and gets PassInstrumentation as its result.
///
///    - Pass Manager invokes PassInstrumentation entry points appropriately,
///      passing StringRef identification ("name") of the pass currently being
///      executed and IRUnit it works on. There can be different schemes of
///      providing names in future, currently it is just a name() of the pass.
///
///    - PassInstrumentation wraps address of IRUnit into llvm::Any and passes
///      control to all the registered callbacks. Note that we specifically wrap
///      'const IRUnitT*' so as to avoid any accidental changes to IR in
///      instrumenting callbacks.
///
///    - Some instrumentation points (BeforePass) allow to control execution
///      of a pass. For those callbacks returning false means pass will not be
///      executed.
///
/// TODO: currently there is no way for a pass to opt-out of execution control
/// (e.g. become unskippable). PassManager is the only entity that determines
/// how pass instrumentation affects pass execution.
///
//===----------------------------------------------------------------------===//

#ifndef LLVM_IR_PASSINSTRUMENTATION_H
#define LLVM_IR_PASSINSTRUMENTATION_H

#include "llvm/ADT/Any.h"
#include "llvm/ADT/FunctionExtras.h"
#include "llvm/ADT/SmallVector.h"
#include <type_traits>

namespace llvm {

class PreservedAnalyses;
class StringRef;

/// This class manages callbacks registration, as well as provides a way for
/// PassInstrumentation to pass control to the registered callbacks.
class PassInstrumentationCallbacks {
public:
  // Before/After callbacks accept IRUnits whenever appropriate, so they need
  // to take them as constant pointers, wrapped with llvm::Any.
  // For the case when IRUnit has been invalidated there is a different
  // callback to use - AfterPassInvalidated.
  // TODO: currently AfterPassInvalidated does not accept IRUnit, since passing
  // already invalidated IRUnit is unsafe. There are ways to handle invalidated IRUnits
  // in a safe way, and we might pursue that as soon as there is a useful instrumentation
  // that needs it.
  using BeforePassFunc = bool(StringRef, Any);
  using AfterPassFunc = void(StringRef, Any);
  using AfterPassInvalidatedFunc = void(StringRef);
  using BeforeAnalysisFunc = void(StringRef, Any);
  using AfterAnalysisFunc = void(StringRef, Any);

public:
  PassInstrumentationCallbacks() {}

/// Copying PassInstrumentationCallbacks is not intended.
  PassInstrumentationCallbacks(const PassInstrumentationCallbacks &) = delete;
  void operator=(const PassInstrumentationCallbacks &) = delete;

template <typename CallableT> void registerBeforePassCallback(CallableT C) {
    BeforePassCallbacks.emplace_back(std::move(C));
  }

template <typename CallableT> void registerAfterPassCallback(CallableT C) {
    AfterPassCallbacks.emplace_back(std::move(C));
  }

template <typename CallableT>
  void registerAfterPassInvalidatedCallback(CallableT C) {
    AfterPassInvalidatedCallbacks.emplace_back(std::move(C));
  }

template <typename CallableT>
  void registerBeforeAnalysisCallback(CallableT C) {
    BeforeAnalysisCallbacks.emplace_back(std::move(C));
  }

template <typename CallableT>
  void registerAfterAnalysisCallback(CallableT C) {
    AfterAnalysisCallbacks.emplace_back(std::move(C));
  }

private:
  friend class PassInstrumentation;

SmallVector<llvm::unique_function<BeforePassFunc>, 4> BeforePassCallbacks;
  SmallVector<llvm::unique_function<AfterPassFunc>, 4> AfterPassCallbacks;
  SmallVector<llvm::unique_function<AfterPassInvalidatedFunc>, 4>
      AfterPassInvalidatedCallbacks;
  SmallVector<llvm::unique_function<BeforeAnalysisFunc>, 4>
      BeforeAnalysisCallbacks;
  SmallVector<llvm::unique_function<AfterAnalysisFunc>, 4>
      AfterAnalysisCallbacks;
};

/// This class provides instrumentation entry points for the Pass Manager,
/// doing calls to callbacks registered in PassInstrumentationCallbacks.
class PassInstrumentation {
  PassInstrumentationCallbacks *Callbacks;

public:
  /// Callbacks object is not owned by PassInstrumentation, its life-time
  /// should at least match the life-time of corresponding
  /// PassInstrumentationAnalysis (which usually is till the end of current
  /// compilation).
  PassInstrumentation(PassInstrumentationCallbacks *CB = nullptr)
      : Callbacks(CB) {}

/// BeforePass instrumentation point - takes \p Pass instance to be executed
  /// and constant reference to IR it operates on. \Returns true if pass is
  /// allowed to be executed.
  template <typename IRUnitT, typename PassT>
  bool runBeforePass(const PassT &Pass, const IRUnitT &IR) const {
    if (!Callbacks)
      return true;

bool ShouldRun = true;
    for (auto &C : Callbacks->BeforePassCallbacks)
      ShouldRun &= C(Pass.name(), llvm::Any(&IR));
    return ShouldRun;
  }

/// AfterPass instrumentation point - takes \p Pass instance that has
  /// just been executed and constant reference to \p IR it operates on.
  /// \p IR is guaranteed to be valid at this point.
  template <typename IRUnitT, typename PassT>
  void runAfterPass(const PassT &Pass, const IRUnitT &IR) const {
    if (Callbacks)
      for (auto &C : Callbacks->AfterPassCallbacks)
        C(Pass.name(), llvm::Any(&IR));
  }

/// AfterPassInvalidated instrumentation point - takes \p Pass instance
  /// that has just been executed. For use when IR has been invalidated
  /// by \p Pass execution.
  template <typename IRUnitT, typename PassT>
  void runAfterPassInvalidated(const PassT &Pass) const {
    if (Callbacks)
      for (auto &C : Callbacks->AfterPassInvalidatedCallbacks)
        C(Pass.name());
  }

/// BeforeAnalysis instrumentation point - takes \p Analysis instance
  /// to be executed and constant reference to IR it operates on.
  template <typename IRUnitT, typename PassT>
  void runBeforeAnalysis(const PassT &Analysis, const IRUnitT &IR) const {
    if (Callbacks)
      for (auto &C : Callbacks->BeforeAnalysisCallbacks)
        C(Analysis.name(), llvm::Any(&IR));
  }

/// AfterAnalysis instrumentation point - takes \p Analysis instance
  /// that has just been executed and constant reference to IR it operated on.
  template <typename IRUnitT, typename PassT>
  void runAfterAnalysis(const PassT &Analysis, const IRUnitT &IR) const {
    if (Callbacks)
      for (auto &C : Callbacks->AfterAnalysisCallbacks)
        C(Analysis.name(), llvm::Any(&IR));
  }

/// Handle invalidation from the pass manager when PassInstrumentation
  /// is used as the result of PassInstrumentationAnalysis.
  ///
  /// On attempt to invalidate just return false. There is nothing to become
  /// invalid here.
  template <typename IRUnitT, typename... ExtraArgsT>
  bool invalidate(IRUnitT &, const class llvm::PreservedAnalyses &,
                  ExtraArgsT...) {
    return false;
  }
};

} // namespace llvm

#endif

003 File Manager

Editing: PassInstrumentation.h

Upload File

Create Folder