Mino revision of pulse passes/functions (#226)

This PR does a minor revision of pulse passes/functions. A new function
is added to obtain the getMixFrameOp with nested call sequence ops

Author: reza-j

include/Dialect/Pulse/Transforms/Scheduling.h

@@ -29,20 +29,20 @@
 
 namespace mlir::pulse {
 
-struct quantumCircuitPulseSchedulingPass
-    : public PassWrapper<quantumCircuitPulseSchedulingPass,
+struct QuantumCircuitPulseSchedulingPass
+    : public PassWrapper<QuantumCircuitPulseSchedulingPass,
                          OperationPass<ModuleOp>> {
 public:
   enum SchedulingMethod { ALAP, ASAP };
   SchedulingMethod SCHEDULING_METHOD = ALAP;
 
   // this pass can optionally receive an string specifying the scheduling
   // method; default method is alap scheduling
-  quantumCircuitPulseSchedulingPass() = default;
-  quantumCircuitPulseSchedulingPass(
-      const quantumCircuitPulseSchedulingPass &pass)
+  QuantumCircuitPulseSchedulingPass() = default;
+  QuantumCircuitPulseSchedulingPass(
+      const QuantumCircuitPulseSchedulingPass &pass)
       : PassWrapper(pass) {}
-  quantumCircuitPulseSchedulingPass(SchedulingMethod inSchedulingMethod) {
+  QuantumCircuitPulseSchedulingPass(SchedulingMethod inSchedulingMethod) {
     SCHEDULING_METHOD = inSchedulingMethod;
   }
 

include/Dialect/Pulse/Utils/Utils.h

@@ -25,6 +25,7 @@
 
 #include "llvm/ADT/StringRef.h"
 
+#include <deque>
 #include <vector>
 
 namespace mlir {
@@ -50,4 +51,24 @@ MixFrameOp getMixFrameOp(PulseOpTy pulseOp, CallSequenceOp callSequenceOp) {
   return mixFrameOp;
 }
 
+template <typename PulseOpTy>
+MixFrameOp
+getMixFrameOp(PulseOpTy pulseOp,
+              std::deque<mlir::pulse::CallSequenceOp> &callSequenceOpStack) {
+
+  auto targetIndex = 0;
+  auto target = pulseOp.getTarget();
+
+  for (auto it = callSequenceOpStack.rbegin(); it != callSequenceOpStack.rend();
+       ++it) {
+    targetIndex = target.template cast<BlockArgument>().getArgNumber();
+    target = it->getOperand(targetIndex);
+  }
+
+  auto mixFrameOp = dyn_cast<mlir::pulse::MixFrameOp>(target.getDefiningOp());
+  if (!mixFrameOp)
+    pulseOp->emitError() << "The target argument is not a MixFrameOp.";
+  return mixFrameOp;
+}
+
 } // end namespace mlir::pulse

lib/Dialect/Pulse/Transforms/Passes.cpp

@@ -42,7 +42,7 @@ void registerPulsePasses() {
   PassRegistration<MergeDelayPass>();
   PassRegistration<RemoveUnusedArgumentsPass>();
   PassRegistration<SchedulePortPass>();
-  PassRegistration<quantumCircuitPulseSchedulingPass>();
+  PassRegistration<QuantumCircuitPulseSchedulingPass>();
   PassRegistration<ClassicalOnlyDetectionPass>();
 }
 

lib/Dialect/Pulse/Transforms/Scheduling.cpp

@@ -44,7 +44,7 @@
 using namespace mlir;
 using namespace mlir::pulse;
 
-void quantumCircuitPulseSchedulingPass::runOnOperation() {
+void QuantumCircuitPulseSchedulingPass::runOnOperation() {
   // check for command line override of the scheduling method
   if (schedulingMethod.hasValue()) {
     if (schedulingMethod.getValue() == "alap")
@@ -72,7 +72,7 @@ void quantumCircuitPulseSchedulingPass::runOnOperation() {
   });
 }
 
-void quantumCircuitPulseSchedulingPass::scheduleAlap(
+void QuantumCircuitPulseSchedulingPass::scheduleAlap(
     mlir::pulse::CallSequenceOp quantumCircuitCallSequenceOp) {
 
   auto quantumCircuitSequenceOp = getSequenceOp(quantumCircuitCallSequenceOp);
@@ -155,20 +155,20 @@ void quantumCircuitPulseSchedulingPass::scheduleAlap(
   LLVM_DEBUG(llvm::dbgs() << "\ttotal duration of quantum circuit "
                           << totalDurationOfQuantumCircuit << "\n");
 
-  // setting duration of the quantum circuit
-  PulseOpSchedulingInterface::setDuration(quantumCircuitSequenceOp,
+  // setting duration of the quantum call circuit
+  PulseOpSchedulingInterface::setDuration(quantumCircuitCallSequenceOp,
                                           totalDurationOfQuantumCircuit);
-  // setting timepoint of the quantum circuit; at this point, we can add
+  // setting timepoint of the quantum call circuit; at this point, we can add
   // totalDurationOfQuantumCircuit to above <=0 timepoints, so that they become
   // >=0, however, that would require walking the IR again. Instead, we add a
-  // postive timepoint to the parent op, i.e., quantum circuit sequence op, and
-  // later passes would need to add this value as an offset to determine the
+  // postive timepoint to the parent op, i.e., quantum circuit call sequence op,
+  // and later passes would need to add this value as an offset to determine the
   // effective timepoints
-  PulseOpSchedulingInterface::setTimepoint(quantumCircuitSequenceOp,
+  PulseOpSchedulingInterface::setTimepoint(quantumCircuitCallSequenceOp,
                                            totalDurationOfQuantumCircuit);
 }
 
-int quantumCircuitPulseSchedulingPass::getNextAvailableTimeOfPorts(
+int QuantumCircuitPulseSchedulingPass::getNextAvailableTimeOfPorts(
     mlir::ArrayAttr ports) {
   int nextAvailableTimeOfAllPorts = 0;
   for (auto attr : ports) {
@@ -184,7 +184,7 @@ int quantumCircuitPulseSchedulingPass::getNextAvailableTimeOfPorts(
   return nextAvailableTimeOfAllPorts;
 }
 
-void quantumCircuitPulseSchedulingPass::updatePortAvailabilityMap(
+void QuantumCircuitPulseSchedulingPass::updatePortAvailabilityMap(
     mlir::ArrayAttr ports, int updatedAvailableTime) {
   for (auto attr : ports) {
     const std::string portName = attr.dyn_cast<StringAttr>().getValue().str();
@@ -194,7 +194,7 @@ void quantumCircuitPulseSchedulingPass::updatePortAvailabilityMap(
   }
 }
 
-mlir::pulse::SequenceOp quantumCircuitPulseSchedulingPass::getSequenceOp(
+mlir::pulse::SequenceOp QuantumCircuitPulseSchedulingPass::getSequenceOp(
     mlir::pulse::CallSequenceOp callSequenceOp) {
   auto seqAttr = callSequenceOp->getAttrOfType<FlatSymbolRefAttr>("callee");
   assert(seqAttr && "Requires a 'callee' symbol reference attribute");
@@ -206,10 +206,10 @@ mlir::pulse::SequenceOp quantumCircuitPulseSchedulingPass::getSequenceOp(
   return sequenceOp;
 }
 
-llvm::StringRef quantumCircuitPulseSchedulingPass::getArgument() const {
+llvm::StringRef QuantumCircuitPulseSchedulingPass::getArgument() const {
   return "quantum-circuit-pulse-scheduling";
 }
 
-llvm::StringRef quantumCircuitPulseSchedulingPass::getDescription() const {
+llvm::StringRef QuantumCircuitPulseSchedulingPass::getDescription() const {
   return "Scheduling a quantum circuit at pulse level.";
 }