qiskit 2.0.3__cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

qiskit/transpiler/passes/scheduling/alignments/reschedule.py

@@ -0,0 +1,251 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2022, 2024.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Rescheduler pass to adjust node start times."""
+from __future__ import annotations
+from collections.abc import Generator
+
+from qiskit.circuit.gate import Gate
+from qiskit.circuit.delay import Delay
+from qiskit.circuit.measure import Measure
+from qiskit.circuit.reset import Reset
+from qiskit.dagcircuit import DAGCircuit, DAGOpNode, DAGOutNode
+from qiskit.transpiler.basepasses import AnalysisPass
+from qiskit.transpiler.exceptions import TranspilerError
+from qiskit.transpiler.target import Target
+
+
+class ConstrainedReschedule(AnalysisPass):
+    """Rescheduler pass that updates node start times to conform to the hardware alignments.
+
+    This pass shifts DAG node start times previously scheduled with one of
+    the scheduling passes, e.g. :class:`ASAPScheduleAnalysis` or :class:`ALAPScheduleAnalysis`,
+    so that every instruction start time satisfies alignment constraints.
+
+    Examples:
+
+        We assume executing the following circuit on a backend with 16 dt of acquire alignment.
+
+        .. code-block:: text
+
+                 ┌───┐┌────────────────┐┌─┐
+            q_0: ┤ X ├┤ Delay(100[dt]) ├┤M├
+                 └───┘└────────────────┘└╥┘
+            c: 1/════════════════════════╩═
+                                         0
+
+        Note that delay of 100 dt induces a misalignment of 4 dt at the measurement.
+        This pass appends an extra 12 dt time shift to the input circuit.
+
+        .. code-block:: text
+
+                 ┌───┐┌────────────────┐┌─┐
+            q_0: ┤ X ├┤ Delay(112[dt]) ├┤M├
+                 └───┘└────────────────┘└╥┘
+            c: 1/════════════════════════╩═
+                                         0
+
+    Notes:
+
+        Your backend may execute circuits violating these alignment constraints.
+        However, you may obtain erroneous measurement result because of the
+        untracked phase originating in the instruction misalignment.
+    """
+
+    def __init__(
+        self,
+        acquire_alignment: int = 1,
+        pulse_alignment: int = 1,
+        target: Target = None,
+    ):
+        """Create new rescheduler pass.
+
+        The alignment values depend on the control electronics of your quantum processor.
+
+        Args:
+            acquire_alignment: Integer number representing the minimum time resolution to
+                trigger acquisition instruction in units of ``dt``.
+            pulse_alignment: Integer number representing the minimum time resolution to
+                trigger gate instruction in units of ``dt``.
+            target: The :class:`~.Target` representing the target backend, if
+                ``target`` is specified then this argument will take
+                precedence and ``acquire_alignment`` and ``pulse_alignment`` will be ignored.
+        """
+        super().__init__()
+        self.acquire_align = acquire_alignment
+        self.pulse_align = pulse_alignment
+        if target is not None:
+            self.durations = target.durations()
+            self.target = target
+            self.acquire_align = target.acquire_alignment
+            self.pulse_align = target.pulse_alignment
+
+    @classmethod
+    def _get_next_gate(cls, dag: DAGCircuit, node: DAGOpNode) -> Generator[DAGOpNode, None, None]:
+        """Get next non-delay nodes.
+
+        Args:
+            dag: DAG circuit to be rescheduled with constraints.
+            node: Current node.
+
+        Returns:
+            A list of non-delay successors.
+        """
+        for next_node in dag.successors(node):
+            if not isinstance(next_node, DAGOutNode):
+                yield next_node
+
+    def _push_node_back(self, dag: DAGCircuit, node: DAGOpNode):
+        """Update the start time of the current node to satisfy alignment constraints.
+        Immediate successors are pushed back to avoid overlap and will be processed later.
+
+        .. note::
+
+            This logic assumes the all bits in the qregs and cregs synchronously start and end,
+            i.e. occupy the same time slot, but qregs and cregs can take
+            different time slot due to classical I/O latencies.
+
+        Args:
+            dag: DAG circuit to be rescheduled with constraints.
+            node: Current node.
+        """
+        node_start_time = self.property_set["node_start_time"]
+        clbit_write_latency = self.property_set.get("clbit_write_latency", 0)
+
+        if isinstance(node.op, Gate):
+            alignment = self.pulse_align
+        elif isinstance(node.op, (Measure, Reset)):
+            alignment = self.acquire_align
+        elif isinstance(node.op, Delay) or getattr(node.op, "_directive", False):
+            # Directive or delay. These can start at arbitrary time.
+            alignment = None
+        else:
+            raise TranspilerError(f"Unknown operation type for {repr(node)}.")
+
+        this_t0 = node_start_time[node]
+
+        if alignment is not None:
+            misalignment = node_start_time[node] % alignment
+            if misalignment != 0:
+                shift = max(0, alignment - misalignment)
+            else:
+                shift = 0
+            this_t0 += shift
+            node_start_time[node] = this_t0
+
+        # Compute shifted t1 of this node separately for qreg and creg
+        if self.target is not None:
+            try:
+                duration = self.durations.get(node.op, [dag.find_bit(x).index for x in node.qargs])
+            except TranspilerError:
+                duration = 0
+            new_t1q = this_t0 + duration
+
+        elif node.name == "delay":
+            new_t1q = this_t0 + node.op.duration
+        else:
+            new_t1q = this_t0
+        this_qubits = set(node.qargs)
+        if isinstance(node.op, (Measure, Reset)):
+            # creg access ends at the end of instruction
+            new_t1c = new_t1q
+            this_clbits = set(node.cargs)
+        else:
+            new_t1c = None
+            this_clbits = set()
+
+        # Check immediate successors for overlap
+        for next_node in self._get_next_gate(dag, node):
+            # Compute next node start time separately for qreg and creg
+            next_t0q = node_start_time[next_node]
+            next_qubits = set(next_node.qargs)
+            if isinstance(next_node.op, (Measure, Reset)):
+                # creg access starts after write latency
+                next_t0c = next_t0q + clbit_write_latency
+                next_clbits = set(next_node.cargs)
+            else:
+                next_t0c = None
+                next_clbits = set()
+            # Compute overlap if there is qubits overlap
+            if any(this_qubits & next_qubits):
+                qreg_overlap = new_t1q - next_t0q
+            else:
+                qreg_overlap = 0
+            # Compute overlap if there is clbits overlap
+            if any(this_clbits & next_clbits):
+                creg_overlap = new_t1c - next_t0c
+            else:
+                creg_overlap = 0
+
+            # Shift next node if there is finite overlap in either in qubits or clbits
+            overlap = max(qreg_overlap, creg_overlap)
+            node_start_time[next_node] = node_start_time[next_node] + overlap
+
+    def run(self, dag: DAGCircuit):
+        """Run rescheduler.
+
+        This pass should perform rescheduling to satisfy:
+
+            - All DAGOpNode nodes (except for compiler directives) are placed at start time
+              satisfying hardware alignment constraints.
+            - The end time of a node does not overlap with the start time of successor nodes.
+
+        Assumptions:
+
+            - Topological order and absolute time order of DAGOpNode are consistent.
+            - All bits in either qargs or cargs associated with node synchronously start.
+            - Start time of qargs and cargs may different due to I/O latency.
+
+        Based on the configurations above, the rescheduler pass takes the following strategy:
+
+        1. The nodes are processed in the topological order, from the beginning of
+            the circuit (i.e. from left to right). For every node (including compiler
+            directives), the function ``_push_node_back`` performs steps 2 and 3.
+        2. If the start time of the node violates the alignment constraint,
+            the start time is increased to satisfy the constraint.
+        3. Each immediate successor whose start_time overlaps the node's end_time is
+            pushed backwards (towards the end of the wire). Note that at this point
+            the shifted successor does not need to satisfy the constraints, but this
+            will be taken care of when that successor node itself is processed.
+        4. After every node is processed, all misalignment constraints will be resolved,
+            and there will be no overlap between the nodes.
+
+        Args:
+            dag: DAG circuit to be rescheduled with constraints.
+
+        Raises:
+            TranspilerError: If circuit is not scheduled.
+        """
+
+        if "node_start_time" not in self.property_set:
+            raise TranspilerError(
+                f"The input circuit {dag.name} is not scheduled. Call one of scheduling passes "
+                f"before running the {self.__class__.__name__} pass."
+            )
+
+        node_start_time = self.property_set["node_start_time"]
+
+        for node in dag.topological_op_nodes():
+
+            start_time = node_start_time.get(node)
+
+            if start_time is None:
+                raise TranspilerError(
+                    f"Start time of {repr(node)} is not found. This node is likely added after "
+                    "this circuit is scheduled. Run scheduler again."
+                )
+
+            if start_time == 0:
+                # Every instruction can start at t=0.
+                continue
+
+            self._push_node_back(dag, node)

qiskit/transpiler/passes/scheduling/padding/__init__.py

@@ -0,0 +1,16 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2022.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Scheduling pass to fill idle times with gate sequence."""
+
+from .dynamical_decoupling import PadDynamicalDecoupling
+from .pad_delay import PadDelay

qiskit/transpiler/passes/scheduling/padding/base_padding.py

@@ -0,0 +1,284 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2022.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Padding pass to fill empty timeslot."""
+from __future__ import annotations
+
+from collections.abc import Iterable
+import logging
+
+from qiskit.circuit import Qubit, Clbit, Instruction
+from qiskit.circuit.delay import Delay
+from qiskit.dagcircuit import DAGCircuit, DAGNode
+from qiskit.transpiler.basepasses import TransformationPass
+from qiskit.transpiler.exceptions import TranspilerError
+from qiskit.transpiler.target import Target
+from qiskit.transpiler.instruction_durations import InstructionDurations
+
+logger = logging.getLogger(__name__)
+
+
+class BasePadding(TransformationPass):
+    """The base class of padding pass.
+
+    This pass requires one of scheduling passes to be executed before itself.
+    Since there are multiple scheduling strategies, the selection of scheduling
+    pass is left in the hands of the pass manager designer.
+    Once a scheduling analysis pass is run, ``node_start_time`` is generated
+    in the :attr:`property_set`.  This information is represented by a python dictionary of
+    the expected instruction execution times keyed on the node instances.
+    Entries in the dictionary are only created for non-delay nodes.
+    The padding pass expects all ``DAGOpNode`` in the circuit to be scheduled.
+
+    This base class doesn't define any sequence to interleave, but it manages
+    the location where the sequence is inserted, and provides a set of information necessary
+    to construct the proper sequence. Thus, a subclass of this pass just needs to implement
+    :meth:`_pad` method, in which the subclass constructs a circuit block to insert.
+    This mechanism removes lots of boilerplate logic to manage whole DAG circuits.
+
+    Note that padding pass subclasses should define interleaving sequences satisfying:
+
+        - Interleaved sequence does not change start time of other nodes
+        - Interleaved sequence should have total duration of the provided ``time_interval``.
+
+    Any manipulation violating these constraints may prevent this base pass from correctly
+    tracking the start time of each instruction,
+    which may result in violation of hardware alignment constraints.
+    """
+
+    def __init__(
+        self,
+        target: Target = None,
+        durations: InstructionDurations = None,
+    ):
+        """BasePadding initializer.
+
+        Args:
+            target: The :class:`~.Target` representing the target backend.
+                If it supplied and it does not support delay instruction on a qubit,
+                padding passes do not pad any idle time of the qubit.
+        """
+        super().__init__()
+        self.target = target
+        self.durations = durations
+
+    def get_duration(self, node, dag):  # pylint: disable=too-many-return-statements
+        """Get duration of a given node in the circuit."""
+        if node.name == "delay":
+            return node.op.duration
+        if node.name == "barrier":
+            return 0
+        if not self.target and not self.durations:
+            return None
+        indices = [dag.find_bit(qarg).index for qarg in node.qargs]
+
+        if self.target:
+            props_dict = self.target.get(node.name)
+            if not props_dict:
+                return None
+            props = props_dict.get(tuple(indices))
+            if not props:
+                return None
+            if self.target.dt is None:
+                return props.duration
+            else:
+                return self.target.seconds_to_dt(props.duration)
+        return self.durations.get(node.name, indices)
+
+    def run(self, dag: DAGCircuit):
+        """Run the padding pass on ``dag``.
+
+        Args:
+            dag: DAG to be checked.
+
+        Returns:
+            DAGCircuit: DAG with idle time filled with instructions.
+
+        Raises:
+            TranspilerError: When a particular node is not scheduled, likely some transform pass
+                is inserted before this node is called.
+        """
+        self._pre_runhook(dag)
+
+        node_start_time = self.property_set["node_start_time"].copy()
+
+        new_dag = DAGCircuit()
+        for qreg in dag.qregs.values():
+            new_dag.add_qreg(qreg)
+        for creg in dag.cregs.values():
+            new_dag.add_creg(creg)
+
+        # Update start time dictionary for the new_dag.
+        # This information may be used for further scheduling tasks,
+        # but this is immediately invalidated because node id is updated in the new_dag.
+        self.property_set["node_start_time"].clear()
+
+        new_dag.name = dag.name
+        new_dag.metadata = dag.metadata
+        new_dag._unit = self.property_set["time_unit"]
+        new_dag.global_phase = dag.global_phase
+
+        idle_after = {bit: 0 for bit in dag.qubits}
+
+        # Compute fresh circuit duration from the node start time dictionary and op duration.
+        # Note that pre-scheduled duration may change within the alignment passes, i.e.
+        # if some instruction time t0 violating the hardware alignment constraint,
+        # the alignment pass may delay t0 and accordingly the circuit duration changes.
+        circuit_duration = 0
+        for node in dag.topological_op_nodes():
+            if node in node_start_time:
+                t0 = node_start_time[node]
+                t1 = t0 + self.get_duration(node, dag)
+                circuit_duration = max(circuit_duration, t1)
+
+                if isinstance(node.op, Delay):
+                    # The padding class considers a delay instruction as idle time
+                    # rather than instruction. Delay node is removed so that
+                    # we can extract non-delay predecessors.
+                    dag.remove_op_node(node)
+                    continue
+
+                for bit in node.qargs:
+                    # Fill idle time with some sequence
+                    if t0 - idle_after[bit] > 0 and self.__delay_supported(dag.find_bit(bit).index):
+                        # Find previous node on the wire, i.e. always the latest node on the wire
+                        prev_node = next(new_dag.predecessors(new_dag.output_map[bit]))
+                        self._pad(
+                            dag=new_dag,
+                            qubit=bit,
+                            t_start=idle_after[bit],
+                            t_end=t0,
+                            next_node=node,
+                            prev_node=prev_node,
+                        )
+
+                    idle_after[bit] = t1
+
+                self._apply_scheduled_op(new_dag, t0, node.op, node.qargs, node.cargs)
+            else:
+                raise TranspilerError(
+                    f"Operation {repr(node)} is likely added after the circuit is scheduled. "
+                    "Schedule the circuit again if you transformed it."
+                )
+
+        # Add delays until the end of circuit.
+        for bit in new_dag.qubits:
+            if circuit_duration - idle_after[bit] > 0 and self.__delay_supported(
+                dag.find_bit(bit).index
+            ):
+                node = new_dag.output_map[bit]
+                prev_node = next(new_dag.predecessors(node))
+                self._pad(
+                    dag=new_dag,
+                    qubit=bit,
+                    t_start=idle_after[bit],
+                    t_end=circuit_duration,
+                    next_node=node,
+                    prev_node=prev_node,
+                )
+
+        new_dag._duration = circuit_duration
+
+        return new_dag
+
+    def __delay_supported(self, qarg: int) -> bool:
+        """Delay operation is supported on the qubit (qarg) or not."""
+        if self.target is None or self.target.instruction_supported("delay", qargs=(qarg,)):
+            return True
+        return False
+
+    def _pre_runhook(self, dag: DAGCircuit):
+        """Extra routine inserted before running the padding pass.
+
+        Args:
+            dag: DAG circuit on which the sequence is applied.
+
+        Raises:
+            TranspilerError: If the whole circuit or instruction is not scheduled.
+        """
+        if "node_start_time" not in self.property_set:
+            raise TranspilerError(
+                f"The input circuit {dag.name} is not scheduled. Call one of scheduling passes "
+                f"before running the {self.__class__.__name__} pass."
+            )
+        if self.property_set["time_unit"] == "stretch":
+            # This should have already been raised during scheduling, but just in case.
+            raise TranspilerError("Scheduling cannot run on circuits with stretch durations.")
+        for qarg, _ in enumerate(dag.qubits):
+            if not self.__delay_supported(qarg):
+                logger.debug(
+                    "No padding on qubit %d as delay is not supported on it",
+                    qarg,
+                )
+
+    def _apply_scheduled_op(
+        self,
+        dag: DAGCircuit,
+        t_start: int,
+        oper: Instruction,
+        qubits: Qubit | Iterable[Qubit],
+        clbits: Clbit | Iterable[Clbit] = (),
+    ):
+        """Add new operation to DAG with scheduled information.
+
+        This is identical to apply_operation_back + updating the node_start_time property.
+
+        Args:
+            dag: DAG circuit on which the sequence is applied.
+            t_start: Start time of new node.
+            oper: New operation that is added to the DAG circuit.
+            qubits: The list of qubits that the operation acts on.
+            clbits: The list of clbits that the operation acts on.
+        """
+        if isinstance(qubits, Qubit):
+            qubits = [qubits]
+        if isinstance(clbits, Clbit):
+            clbits = [clbits]
+
+        new_node = dag.apply_operation_back(oper, qargs=qubits, cargs=clbits, check=False)
+        self.property_set["node_start_time"][new_node] = t_start
+
+    def _pad(
+        self,
+        dag: DAGCircuit,
+        qubit: Qubit,
+        t_start: int,
+        t_end: int,
+        next_node: DAGNode,
+        prev_node: DAGNode,
+    ):
+        """Interleave instruction sequence in between two nodes.
+
+        .. note::
+            If a DAGOpNode is added here, it should update node_start_time property
+            in the property set so that the added node is also scheduled.
+            This is achieved by adding operation via :meth:`_apply_scheduled_op`.
+
+        .. note::
+
+            This method doesn't check if the total duration of new DAGOpNode added here
+            is identical to the interval (``t_end - t_start``).
+            A developer of the pass must guarantee this is satisfied.
+            If the duration is greater than the interval, your circuit may be
+            compiled down to the target code with extra duration on the backend compiler,
+            which is then played normally without error. However, the outcome of your circuit
+            might be unexpected due to erroneous scheduling.
+
+        Args:
+            dag: DAG circuit that sequence is applied.
+            qubit: The wire that the sequence is applied on.
+            t_start: Absolute start time of this interval.
+            t_end: Absolute end time of this interval.
+            next_node: Node that follows the sequence.
+            prev_node: Node ahead of the sequence.
+        """
+        raise NotImplementedError