Passes.h

Go to the documentation of this file.

//===- Passes.h - FIRRTL pass entry points ----------------------*- 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
//
//===----------------------------------------------------------------------===//
//
// This header file defines prototypes that expose pass constructors.
//
//===----------------------------------------------------------------------===//
 
#ifndef CIRCT_DIALECT_FIRRTL_PASSES_H
#define CIRCT_DIALECT_FIRRTL_PASSES_H
 
#include "circt/Dialect/FIRRTL/FIRRTLOps.h"
#include "mlir/Pass/Pass.h"
#include "mlir/Pass/PassRegistry.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/STLFunctionalExtras.h"
 
namespace mlir {
class MLIRContext;
class Pass;
} // namespace mlir
 
namespace circt {
namespace firrtl {
class InstanceGraph;
class InstanceInfo;
 
/// Configure which aggregate values will be preserved by the LowerTypes pass.
namespace PreserveAggregate {
enum PreserveMode {
  /// Don't preserve aggregate at all. This has been default behaivor and
  /// compatible with SFC.
  None,
 
  /// Preserve only 1d vectors of ground type (e.g. UInt<2>[3]).
  OneDimVec,
 
  /// Preserve only vectors (e.g. UInt<2>[3][3]).
  Vec,
 
  /// Preserve all aggregate values.
  All,
};
}
 
/// Configure which values will be explicitly preserved by the DropNames pass.
namespace PreserveValues {
enum PreserveMode {
  /// Strip all names. No name on declaration is preserved.
  Strip,
  /// Don't explicitly preserve any named values. Every named operation could
  /// be optimized away by the compiler. Unlike `Strip` names could be preserved
  /// until the end.
  None,
  // Explicitly preserved values with meaningful names.  If a name begins with
  // an "_" it is not considered meaningful.
  Named,
  // Explicitly preserve all values.  No named operation should be optimized
  // away by the compiler.
  All,
};
} // namespace PreserveValues
 
enum class CompanionMode {
  // Lower companions to SystemVerilog binds.
  Bind,
  // Lower companions to explicit instances. Used when assertions or other
  // debugging constructs from the companion are to be included in the design.
  Instantiate,
  // Drop companion modules, eliminating them from the design.
  Drop,
};
 
/// The mode for the InferDomains pass.
enum class InferDomainsMode {
  /// Check domains without inference.
  Check,
  /// Check domains with inference for private modules.
  Infer,
  /// Check domains with inference for both public and private modules.
  InferAll,
};
 
void runCombMemsToRegOfVec(FModuleOp mod, bool ignoreReadEnable,
                           unsigned &numConverted);
LogicalResult runFullReset(CircuitOp circuit, InstanceGraph &ig,
                           InstanceInfo &instanceInfo,
                           bool convertAsyncDomainMems = false);
 
/// Strip domains whose names match the predicate from a circuit.
LogicalResult
stripDomainsFromCircuit(CircuitOp circuit,
                        llvm::function_ref<bool(StringAttr)> shouldStripDomain);
 
#define GEN_PASS_DECL
#include "circt/Dialect/FIRRTL/Passes.h.inc"
 
/// Generate the code for registering passes.
#define GEN_PASS_REGISTRATION
#include "circt/Dialect/FIRRTL/Passes.h.inc"
 
} // namespace firrtl
} // namespace circt
 
#endif // CIRCT_DIALECT_FIRRTL_PASSES_H