Improvement to MergeCircuit and ReorderMeasurements for Parameters (#157)

Adds additional improvements for handling input parameters in
the MergeCircuit pass and the ReorderMeasurement pass.

1. The passes will now move more parameters related operations out of
the way when attempting to reorder measurements and merge circuits.

2. The `MergeCircuitsPass::mergeCallCircuits` has been simplified.

3. This PR also adds the `--include-source` command line options as a
debug flag. If this flag is passed when the direct input method is also
used then the input source will be stored in the output payload at
`manifest\input.{qasm|mlir}` depending on the file format.

Author: bcdonovan

include/Dialect/QUIR/Utils/Utils.h

@@ -96,7 +96,12 @@ llvm::Optional<Operation *> nextQuantumOpOrNull(Operation *op);
 /// it is of type OpType, otherwise return null
 // TODO: Should be replaced by an analysis compatable struct.
 template <class OpType>
-llvm::Optional<OpType> nextQuantumOpOrNullOfType(Operation *op);
+llvm::Optional<OpType> nextQuantumOpOrNullOfType(Operation *op) {
+  auto nextOperation = nextQuantumOpOrNull(op);
+  if (nextOperation && isa<OpType>(*nextOperation))
+    return dyn_cast<OpType>(*nextOperation);
+  return llvm::None;
+}
 
 /// Get the previous Op that has the CPTPOp or UnitaryOp trait, or return null
 /// if none found
@@ -107,7 +112,12 @@ llvm::Optional<Operation *> prevQuantumOpOrNull(Operation *op);
 /// it if it is of type OpType, otherwise return null
 // TODO: Should be replaced by an analysis compatable struct.
 template <class OpType>
-llvm::Optional<OpType> prevQuantumOpOrNullOfType(Operation *op);
+llvm::Optional<OpType> prevQuantumOpOrNullOfType(Operation *op) {
+  auto prevOperation = prevQuantumOpOrNull(op);
+  if (prevOperation && isa<OpType>(*prevOperation))
+    return dyn_cast<OpType>(*prevOperation);
+  return llvm::None;
+}
 
 /// Get the next Op that has the CPTPOp or UnitaryOp trait, or is control flow
 /// (has the RegionBranchOpInterface::Trait), or return null if none found

include/Payload/Payload.h

@@ -62,6 +62,7 @@ class Payload {
   // write all files in plaintext to the stream
   virtual void writePlain(std::ostream &stream) = 0;
   virtual void writePlain(llvm::raw_ostream &stream) = 0;
+  virtual void addFile(llvm::StringRef filename, llvm::StringRef str) = 0;
 
   const std::string &getName() const { return name; }
   const std::string &getPrefix() const { return prefix; }

lib/API/api.cpp

@@ -106,6 +106,10 @@ static llvm::cl::opt<bool> plaintextPayload(
     "plaintext-payload", llvm::cl::desc("Write the payload in plaintext"),
     llvm::cl::init(false), llvm::cl::cat(qssc::config::getQSSCCategory()));
 
+static llvm::cl::opt<bool> includeSourceInPayload(
+    "include-source", llvm::cl::desc("Write the input source into the payload"),
+    llvm::cl::init(false), llvm::cl::cat(qssc::config::getQSSCCategory()));
+
 namespace {
 enum InputType { NONE, QASM, MLIR, QOBJ };
 } // anonymous namespace
@@ -672,6 +676,14 @@ compile_(int argc, char const **argv, std::string *outputString,
   }
 
   if (emitAction == Action::GenQEM) {
+
+    if (includeSourceInPayload && directInput) {
+      if (inputType == InputType::QASM)
+        payload->addFile("manifest/input.qasm", inputSource + "\n");
+      else if (inputType == InputType::MLIR)
+        payload->addFile("manifest/input.mlir", inputSource + "\n");
+    }
+
     if (auto err = generateQEM_(target, std::move(payload), moduleOp, ostream))
       return err;
   }

lib/Conversion/OQ3ToStandard/OQ3ToStandard.cpp

@@ -13,6 +13,7 @@
 //===----------------------------------------------------------------------===//
 
 #include "Conversion/OQ3ToStandard/OQ3ToStandard.h"
+#include "Dialect/QUIR/IR/QUIROps.h"
 #include "Dialect/QUIR/Transforms/Passes.h"
 
 #include "Dialect/OQ3/IR/OQ3Ops.h"
@@ -345,6 +346,27 @@ struct RemoveConvertedNilCastsPattern : public OQ3ToStandardConversion<CastOp> {
 
 }; // struct RemoveConvertedNilCastsPattern
 
+struct CastFromFloatConstPattern : public OQ3ToStandardConversion<CastOp> {
+  using OQ3ToStandardConversion<CastOp>::OQ3ToStandardConversion;
+
+  LogicalResult
+  matchAndRewrite(CastOp op, OpAdaptor adaptor,
+                  ConversionPatternRewriter &rewriter) const override {
+
+    auto constOp = op.arg().getDefiningOp<mlir::arith::ConstantOp>();
+    if (!constOp)
+      return failure();
+
+    auto floatAttr = constOp.getValue().dyn_cast<mlir::FloatAttr>();
+    if (!floatAttr)
+      return failure();
+
+    rewriter.replaceOp(op, {adaptor.arg()});
+    return success();
+  } // CastFromFloatConstPattern
+
+}; // struct RemoveConvertedNilCastsPattern
+
 struct RemoveI1ToCBitCastsPattern : public OQ3ToStandardConversion<CastOp> {
   using OQ3ToStandardConversion<CastOp>::OQ3ToStandardConversion;
 
@@ -419,6 +441,7 @@ void oq3::populateOQ3ToStandardConversionPatterns(
       CastIndexToIntPattern,
       RemoveConvertedNilCastsPattern,
       RemoveI1ToCBitCastsPattern,
+      CastFromFloatConstPattern,
       WideningIntCastsPattern>(patterns.getContext(), typeConverter);
   // clang-format on
 }

lib/Conversion/QUIRToStandard/TypeConversion.cpp

@@ -63,6 +63,11 @@ Optional<Type> QuirTypeConverter::convertAngleType(Type t) {
     // for function types in func defs and calls
     return intType;
   }
+  if (auto floatType = t.dyn_cast<FloatType>()) {
+    // MUST return the converted type as itself to mark legal
+    // for function types in func defs and calls
+    return floatType;
+  }
   return llvm::None;
 } // convertAngleType