python/tvm/exec/popen_worker.py

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
# pylint: disable=invalid-name
# ruff: noqa: RUF012
"""Internal PopenWorker for PopenPool."""

import logging
import os
import pickle
import struct
import sys
import threading
import traceback

import cloudpickle

from tvm.support.popen_pool import StatusKind


class TimeoutStatus:
    __slot__ = ["status"]

    def __init__(self):
        self.status = StatusKind.RUNNING


def main():
    """Main worker function"""
    if len(sys.argv) != 3:
        print("Usage: <read_fd> <write_fd>")
        return
    if sys.platform == "win32":
        # pylint: disable=import-outside-toplevel
        import msvcrt

        reader = os.fdopen(msvcrt.open_osfhandle(int(sys.argv[1]), os.O_BINARY), "rb")
        writer = os.fdopen(msvcrt.open_osfhandle(int(sys.argv[2]), os.O_BINARY), "wb")
    else:
        reader = os.fdopen(int(sys.argv[1]), "rb")
        writer = os.fdopen(int(sys.argv[2]), "wb")

    logging.basicConfig(level=logging.INFO)

    lock = threading.Lock()

    def _respond(ret_value):
        """Send data back to the client."""
        data = cloudpickle.dumps(ret_value, protocol=pickle.HIGHEST_PROTOCOL)
        writer.write(struct.pack("<i", len(data)))
        writer.write(data)
        writer.flush()

    def _cancel_run(status):
        lock.acquire()
        if status.status == StatusKind.RUNNING:
            _respond((StatusKind.TIMEOUT, TimeoutError()))
            status.status = StatusKind.TIMEOUT
        lock.release()

    while True:
        raw_bytes_size = reader.read(4)
        if len(raw_bytes_size) != 4:
            # the parent exited
            return
        bytes_size = struct.unpack("<i", raw_bytes_size)[0]
        fn, args, kwargs, timeout = cloudpickle.loads(reader.read(bytes_size))
        status = TimeoutStatus()

        if timeout is not None:
            watcher = threading.Timer(timeout, _cancel_run, [status])
            watcher.daemon = True
            watcher.start()

        # pylint: disable=broad-except
        try:
            result = fn(*args, **kwargs)
            ret_value = (StatusKind.COMPLETE, result)
        except Exception as exception:
            msg = traceback.format_exc()
            ret_value = (StatusKind.EXCEPTION, type(exception)(msg))

        if timeout is not None:
            watcher.cancel()

        lock.acquire()
        if status.status == StatusKind.RUNNING:
            _respond(ret_value)
            status.status = StatusKind.COMPLETE
        lock.release()


if __name__ == "__main__":
    try:
        main()
    except (OSError, KeyboardInterrupt):
        pass