Add blocking progress mode to Python async

ci/test_python.sh

@@ -39,20 +39,27 @@ rapids-logger "Python Async Tests"
 # run_py_tests_async PROGRESS_MODE   ENABLE_DELAYED_SUBMISSION ENABLE_PYTHON_FUTURE SKIP
 run_py_tests_async   thread          0                         0                    0
 run_py_tests_async   thread          1                         1                    0
+run_py_tests_async   blocking        0                         0                    0
 
 rapids-logger "Python Benchmarks"
 # run_py_benchmark  BACKEND   PROGRESS_MODE   ASYNCIO_WAIT  ENABLE_DELAYED_SUBMISSION ENABLE_PYTHON_FUTURE NBUFFERS SLOW
 run_py_benchmark    ucxx-core thread          0             0                         0                    1        0
 run_py_benchmark    ucxx-core thread          1             0                         0                    1        0
 
-for nbuf in 1 8; do
-  if [[ ! $RAPIDS_CUDA_VERSION =~ 11.2.* ]]; then
-    # run_py_benchmark  BACKEND     PROGRESS_MODE   ASYNCIO_WAIT  ENABLE_DELAYED_SUBMISSION ENABLE_PYTHON_FUTURE NBUFFERS SLOW
-    run_py_benchmark    ucxx-async  thread          0             0                         0                    ${nbuf}  0
-    run_py_benchmark    ucxx-async  thread          0             0                         1                    ${nbuf}  0
-    run_py_benchmark    ucxx-async  thread          0             1                         0                    ${nbuf}  0
-    run_py_benchmark    ucxx-async  thread          0             1                         1                    ${nbuf}  0
-  fi
+for progress_mode in "blocking" "thread"; do
+  for nbuf in 1 8; do
+    if [[ ! $RAPIDS_CUDA_VERSION =~ 11.2.* ]]; then
+      # run_py_benchmark  BACKEND     PROGRESS_MODE     ASYNCIO_WAIT  ENABLE_DELAYED_SUBMISSION ENABLE_PYTHON_FUTURE NBUFFERS SLOW
+      run_py_benchmark    ucxx-async  ${progress_mode}  0             0                         0                    ${nbuf}  0
+      run_py_benchmark    ucxx-async  ${progress_mode}  0             0                         1                    ${nbuf}  0
+      if [[ ${progress_mode} != "blocking" ]]; then
+        # Delayed submission isn't support by blocking progress mode
+        # run_py_benchmark  BACKEND     PROGRESS_MODE     ASYNCIO_WAIT  ENABLE_DELAYED_SUBMISSION ENABLE_PYTHON_FUTURE NBUFFERS SLOW
+        run_py_benchmark    ucxx-async  ${progress_mode}  0             1                         0                    ${nbuf}  0
+        run_py_benchmark    ucxx-async  ${progress_mode}  0             1                         1                    ${nbuf}  0
+      fi
+    fi
+  done
 done
 
 rapids-logger "C++ future -> Python future notifier example"

ci/test_python_distributed.sh

@@ -33,6 +33,7 @@ print_ucx_config
 
 rapids-logger "Run distributed-ucxx tests with conda package"
 # run_distributed_ucxx_tests    PROGRESS_MODE   ENABLE_DELAYED_SUBMISSION   ENABLE_PYTHON_FUTURE
+run_distributed_ucxx_tests      blocking        0                           0
 run_distributed_ucxx_tests      polling         0                           0
 run_distributed_ucxx_tests      thread          0                           0
 run_distributed_ucxx_tests      thread          0                           1
@@ -42,6 +43,7 @@ run_distributed_ucxx_tests      thread          1                           1
 install_distributed_dev_mode
 
 # run_distributed_ucxx_tests_internal   PROGRESS_MODE   ENABLE_DELAYED_SUBMISSION   ENABLE_PYTHON_FUTURE
+run_distributed_ucxx_tests_internal     blocking        0                           0
 run_distributed_ucxx_tests_internal     polling         0                           0
 run_distributed_ucxx_tests_internal     thread          0                           0
 run_distributed_ucxx_tests_internal     thread          0                           1

cpp/include/ucxx/worker.h

@@ -253,6 +253,23 @@ class Worker : public Component {
    */
   void initBlockingProgressMode();
 
+  /**
+   * @brief Get the epoll file descriptor associated with the worker.
+   *
+   * Get the epoll file descriptor associated with the worker when running in blocking mode.
+   * The worker only has an associated epoll file descriptor after
+   * `initBlockingProgressMode()` is executed.
+   *
+   * The file descriptor is destroyed as part of the `ucxx::Worker` destructor, thus any
+   * reference to it shall not be used after that.
+   *
+   * @throws std::runtime_error if `initBlockingProgressMode()` was not executed to run the
+   *                            worker in blocking progress mode.
+   *
+   * @returns the file descriptor.
+   */
+  int getEpollFileDescriptor();
+
   /**
    * @brief Arm the UCP worker.
    *

cpp/src/worker.cpp

@@ -220,6 +220,14 @@ void Worker::initBlockingProgressMode()
   }
 }
 
+int Worker::getEpollFileDescriptor()
+{
+  if (_epollFileDescriptor == 0)
+    throw std::runtime_error("Worker not running in blocking progress mode");
+
+  return _epollFileDescriptor;
+}
+
 bool Worker::arm()
 {
   ucs_status_t status = ucp_worker_arm(_handle);

python/ucxx/ucxx/_lib/libucxx.pyx

@@ -617,6 +617,23 @@ cdef class UCXWorker():
         with nogil:
             self._worker.get().initBlockingProgressMode()
 
+    def arm(self) -> bool:
+        cdef bint armed
+
+        with nogil:
+            armed = self._worker.get().arm()
+
+        return armed
+
+    @property
+    def epoll_file_descriptor(self) -> int:
+        cdef int epoll_file_descriptor = 0
+
+        with nogil:
+            epoll_file_descriptor = self._worker.get().getEpollFileDescriptor()
+
+        return epoll_file_descriptor
+
     def progress(self) -> None:
         with nogil:
             self._worker.get().progress()

python/ucxx/ucxx/_lib/ucxx_api.pxd

@@ -229,6 +229,8 @@ cdef extern from "<ucxx/api.h>" namespace "ucxx" nogil:
             uint16_t port, ucp_listener_conn_callback_t callback, void *callback_args
         ) except +raise_py_error
         void initBlockingProgressMode() except +raise_py_error
+        int getEpollFileDescriptor()
+        bint arm() except +raise_py_error
         void progress()
         bint progressOnce()
         void progressWorkerEvent(int epoll_timeout)

python/ucxx/ucxx/_lib_async/application_context.py

@@ -13,7 +13,7 @@
 from ucxx.exceptions import UCXMessageTruncatedError
 from ucxx.types import Tag
 
-from .continuous_ucx_progress import PollingMode, ThreadMode
+from .continuous_ucx_progress import BlockingMode, PollingMode, ThreadMode
 from .endpoint import Endpoint
 from .exchange_peer_info import exchange_peer_info
 from .listener import ActiveClients, Listener, _listener_handler
@@ -60,6 +60,9 @@ def __init__(
             enable_python_future=self._enable_python_future,
         )
 
+        if self.progress_mode == "blocking":
+            self.worker.init_blocking_progress_mode()
+
         self.start_notifier_thread()
 
         weakref.finalize(self, self.progress_tasks.clear)
@@ -82,7 +85,7 @@ def progress_mode(self, progress_mode):
                 else:
                     progress_mode = "thread"
 
-            valid_progress_modes = ["polling", "thread", "thread-polling"]
+            valid_progress_modes = ["blocking", "polling", "thread", "thread-polling"]
             if not isinstance(progress_mode, str) or not any(
                 progress_mode == m for m in valid_progress_modes
             ):
@@ -460,6 +463,8 @@ def continuous_ucx_progress(self, event_loop=None):
             task = ThreadMode(self.worker, loop, polling_mode=True)
         elif self.progress_mode == "polling":
             task = PollingMode(self.worker, loop)
+        elif self.progress_mode == "blocking":
+            task = BlockingMode(self.worker, loop)
 
         self.progress_tasks.append(task)
 

python/ucxx/ucxx/_lib_async/continuous_ucx_progress.py

@@ -3,6 +3,11 @@
 
 
 import asyncio
+import socket
+import time
+import weakref
+
+from ucxx._lib.libucxx import UCXWorker
 
 
 class ProgressTask(object):
@@ -25,11 +30,13 @@ def __init__(self, worker, event_loop):
         self.asyncio_task = None
 
     def __del__(self):
-        if self.asyncio_task is not None:
-            # FIXME: This does not work, the cancellation must be awaited.
-            # Running with polling mode will always cause
-            # `Task was destroyed but it is pending!` errors at ucxx.reset().
-            self.asyncio_task.cancel()
+        # FIXME: This only works if the event loop is still running and awaits the
+        # cancelation.
+        # Running with blocking and polling modes may cause
+        # `Task was destroyed but it is pending!` errors at ucxx.reset().
+        if self.event_loop is not None and self.event_loop.is_running():
+            if self.asyncio_task is not None:
+                self.call_soon_threadsafe(self.asyncio_task.cancel())
 
     # Hash and equality is based on the event loop
     def __hash__(self):
@@ -70,3 +77,133 @@ async def _progress_task(self):
             worker.progress()
             # Give other co-routines a chance to run.
             await asyncio.sleep(0)
+
+
+class BlockingMode(ProgressTask):
+    def __init__(
+        self,
+        worker: UCXWorker,
+        event_loop: asyncio.AbstractEventLoop,
+        progress_timeout: float = 1.0,
+    ):
+        """Progress the UCX worker in blocking mode.
+
+        The blocking progress mode ensure the worker is progress whenever the UCX
+        worker reports an event on its epoll file descriptor. In certain
+        circumstances the epoll file descriptor may not
+
+        Parameters
+        ----------
+        worker: UCXWorker
+            Worker object from the UCXX Cython API to progress.
+        event_loop: asyncio.AbstractEventLoop
+            Asynchronous event loop where to schedule async tasks.
+        progress_timeout: float
+            The timeout to sleep until calling checking again whether the worker should
+            be progressed.
+        """
+        super().__init__(worker, event_loop)
+
+        # Creating a job that is ready straight away but with low priority.
+        # Calling `await self.event_loop.sock_recv(self.rsock, 1)` will
+        # return when all non-IO tasks are finished.
+        # See <https://stackoverflow.com/a/48491563>.
+        self.rsock, wsock = socket.socketpair()
+        self.rsock.setblocking(0)
+        wsock.setblocking(0)
+        wsock.close()
+
+        epoll_fd = worker.epoll_file_descriptor
+
+        # Bind an asyncio reader to a UCX epoll file descriptor
+        event_loop.add_reader(epoll_fd, self._fd_reader_callback)
+
+        # Remove the reader and close socket on finalization
+        weakref.finalize(self, event_loop.remove_reader, epoll_fd)
+        weakref.finalize(self, self.rsock.close)
+
+        self.blocking_asyncio_task = None
+        self.last_progress_time = time.monotonic() - progress_timeout
+        self.asyncio_task = event_loop.create_task(self._timeout_progress(1.0))
+
+    def __del__(self):
+        """Cancel asynchronous blocking progress task.
+
+        Cancel asynchronouns blocking progress task.
+
+        .. warning::
+            This only works if the event loop is still running. If the event loop has
+            been closed before this runs the following error will be printed by the
+            interpreter on the standard output:
+
+            ```
+            Task was destroyed but it is pending!
+            ```
+        """
+        if self.event_loop is not None and self.event_loop.is_running():
+            if self.blocking_asyncio_task is not None:
+                self.call_soon_threadsafe(self.blocking_asyncio_task.cancel())
+
+        super().__del__()
+
+    def _fd_reader_callback(self):
+        """Schedule new progress task upon worker event.
+
+        Schedule new progress task when a new event occurs in the worker's epoll file
+        descriptor.
+        """
+        self.worker.progress()
+
+        # Notice, we can safely overwrite `self.dangling_arm_task`
+        # since previous arm task is finished by now.
+        assert self.blocking_asyncio_task is None or self.blocking_asyncio_task.done()
+        self.blocking_asyncio_task = self.event_loop.create_task(self._arm_worker())
+
+    async def _arm_worker(self):
+        """Progress the worker and rearm.
+
+        Progress and rearm the worker to watch for new events on its epoll file
+        descriptor.
+        """
+        # When arming the worker, the following must be true:
+        #  - No more progress in UCX (see doc of ucp_worker_arm())
+        #  - All asyncio tasks that isn't waiting on UCX must be executed
+        #    so that the asyncio's next state is epoll wait.
+        #    See <https://github.com/rapidsai/ucx-py/issues/413>
+        while True:
+            self.last_progress_time = time.monotonic()
+            self.worker.progress()
+
+            # This IO task returns when all non-IO tasks are finished.
+            # Notice, we do NOT hold a reference to `worker` while waiting.
+            await self.event_loop.sock_recv(self.rsock, 1)
+
+            if self.worker.arm():
+                # At this point we know that asyncio's next state is
+                # epoll wait.
+                break
+
+    async def _timeout_progress(self, progress_timeout: float = 1.0):
+        """Protect worker from never progressing again.
+
+        To ensure the worker progresses if no events are raised and the asyncio loop
+        getting stuck we must ensure the worker is progressed every so often. This
+        method ensures the worker is progressed independent of what the epoll file
+        descriptor does if longer than `progress_timeout` has elapsed since last check,
+        thus preventing a deadlock.
+
+        Parameters
+        ----------
+        progress_timeout: float
+            The timeout to sleep until calling checking again whether the worker should
+            be progressed.
+        """
+        while True:
+            worker = self.worker
+            if worker is None:
+                return
+            if time.monotonic() > self.last_progress_time + progress_timeout:
+                self.last_progress_time = time.monotonic()
+                worker.progress()
+            # Give other co-routines a chance to run.
+            await asyncio.sleep(progress_timeout)

python/ucxx/ucxx/benchmarks/send_recv.py

@@ -294,8 +294,8 @@ def parse_args():
     parser.add_argument(
         "--progress-mode",
         default="thread",
-        help="Progress mode for the UCP worker. Valid options are: "
-        "'thread' (default) and 'blocking'.",
+        help="Progress mode for the UCP worker. Valid options are: 'blocking, "
+        "'polling', 'thread' and 'thread-polling. (Default: 'thread')'",
         type=str,
     )
     parser.add_argument(
@@ -350,8 +350,6 @@ def parse_args():
 
     if args.progress_mode not in ["blocking", "polling", "thread", "thread-polling"]:
         raise RuntimeError(f"Invalid `--progress-mode`: '{args.progress_mode}'")
-    if args.progress_mode == "blocking" and args.backend == "ucxx-async":
-        raise RuntimeError("Blocking progress mode not supported for ucxx-async yet")
     if args.asyncio_wait and not args.progress_mode.startswith("thread"):
         raise RuntimeError(
             "`--asyncio-wait` requires `--progress-mode=thread` or "