mindstudio-probe 1.0.1__py3-none-any.whl → 1.0.4__py3-none-any.whl

msprobe/pytorch/api_accuracy_checker/run_ut/run_ut_utils.py

@@ -1,7 +1,70 @@
-hf_32_standard_api = ["conv1d", "conv2d"]
-
-
-class Backward_Message:
-    MULTIPLE_BACKWARD_MESSAGE = "Multiple backward is not supported."
-    UNSUPPORT_BACKWARD_MESSAGE = "function with out=... arguments don't support automatic differentiation, skip backward."
-    NO_BACKWARD_RESULT_MESSAGE = "function backward result is None, skip backward."
+import os
+import re
+
+from msprobe.core.common.const import FileCheckConst
+from msprobe.core.common.file_utils import FileChecker
+from msprobe.pytorch.hook_module.wrap_aten import AtenOPTemplate
+from msprobe.pytorch.hook_module.wrap_functional import FunctionalOPTemplate
+from msprobe.pytorch.hook_module.wrap_npu_custom import NpuOPTemplate
+from msprobe.pytorch.hook_module.wrap_tensor import TensorOPTemplate
+from msprobe.pytorch.hook_module.wrap_torch import TorchOPTemplate
+
+hf_32_standard_api = ["conv1d", "conv2d"]
+
+
+class Backward_Message:
+    MULTIPLE_BACKWARD_MESSAGE = "Multiple backward is not supported."
+    UNSUPPORT_BACKWARD_MESSAGE = "function with out=... arguments don't support automatic differentiation, skip backward."
+    NO_BACKWARD_RESULT_MESSAGE = "function backward result is None, skip backward."
+
+
+class UtDataInfo:
+    def __init__(self, bench_grad, device_grad, device_output, bench_output, grad_in, in_fwd_data_list,
+                 backward_message, rank=0):
+        self.bench_grad = bench_grad
+        self.device_grad = device_grad
+        self.device_output = device_output
+        self.bench_output = bench_output
+        self.grad_in = grad_in
+        self.in_fwd_data_list = in_fwd_data_list
+        self.backward_message = backward_message
+        self.rank = rank
+
+
+def get_validated_result_csv_path(result_csv_path, mode):
+    if mode not in ['result', 'detail']:
+        raise ValueError("The csv mode must be result or detail")
+    result_csv_path_checker = FileChecker(result_csv_path, FileCheckConst.FILE, ability=FileCheckConst.READ_WRITE_ABLE,
+                                          file_type=FileCheckConst.CSV_SUFFIX)
+    validated_result_csv_path = result_csv_path_checker.common_check()
+    if mode == 'result':
+        result_csv_name = os.path.basename(validated_result_csv_path)
+        pattern = r"^accuracy_checking_result_\d{14}\.csv$"
+        if not re.match(pattern, result_csv_name):
+            raise ValueError("When continue run ut, please do not modify the result csv name.")
+    return validated_result_csv_path
+
+
+def get_validated_details_csv_path(validated_result_csv_path):
+    result_csv_name = os.path.basename(validated_result_csv_path)
+    details_csv_name = result_csv_name.replace('result', 'details')
+    details_csv_path = os.path.join(os.path.dirname(validated_result_csv_path), details_csv_name)
+    details_csv_path_checker = FileChecker(details_csv_path, FileCheckConst.FILE,
+                                           ability=FileCheckConst.READ_WRITE_ABLE, file_type=FileCheckConst.CSV_SUFFIX)
+    validated_details_csv_path = details_csv_path_checker.common_check()
+    return validated_details_csv_path
+
+
+def exec_api(api_type, api_name, device, args, kwargs):
+    if api_type == "Functional":
+        torch_api = FunctionalOPTemplate(api_name, str, False)
+    if api_type == "Tensor":
+        torch_api = TensorOPTemplate(api_name, str, False)
+    if api_type == "Torch":
+        torch_api = TorchOPTemplate(api_name, str, False)
+    if api_type == "Aten":
+        torch_api = AtenOPTemplate(api_name, None, False)
+    if api_type == "NPU":
+        torch_api = NpuOPTemplate(api_name, None, False, device)
+    out = torch_api.forward(*args, **kwargs)
+    return out

msprobe/pytorch/api_accuracy_checker/run_ut/torch_ut_setting.json

@@ -1,5 +1,8 @@
-{
-  "topk": {
-    "grad_index": 0
-  }
+{
+  "topk": {
+    "grad_index": 0
+  },
+  "npu_fusion_attention": {
+    "grad_index": 0
+  }
 }

msprobe/pytorch/api_accuracy_checker/tensor_transport_layer/attl.py

@@ -0,0 +1,197 @@
+import glob
+import os.path
+import time
+import re
+from multiprocessing import Queue
+from typing import Optional, Union, Dict, Any
+from dataclasses import dataclass
+
+import torch
+
+from msprobe.pytorch.api_accuracy_checker.common.utils import ApiData
+from msprobe.pytorch.api_accuracy_checker.tensor_transport_layer.client import TCPClient
+from msprobe.pytorch.api_accuracy_checker.tensor_transport_layer.server import TCPServer
+from msprobe.pytorch.common.utils import logger
+from msprobe.core.common.file_utils import remove_path
+from msprobe.pytorch.common.utils import save_api_data, load_api_data, save_pt, load_pt
+
+BufferType = Union[ApiData, Dict[str, Any], str]  # Union[Tensor, Tuple[Optional[Tensor]]]
+
+
+@dataclass
+class ATTLConfig:
+    is_benchmark_device: bool
+    connect_ip: str
+    connect_port: int
+    # storage_config
+    nfs_path: str = None
+    tls_path: str = None
+    check_sum: bool = True
+    queue_size: int = 50
+
+
+class ATTL:
+    def __init__(self, session_id: str, session_config: ATTLConfig, need_dump=True) -> None:
+        self.session_id = session_id
+        self.session_config = session_config
+        self.logger = logger
+        self.socket_manager = None
+        self.data_queue = Queue(maxsize=50)
+        self.dequeue_list = []
+        self.message_end = False
+        self.kill_progress = False
+        self.check_attl_config()
+        if self.session_config.nfs_path:
+            self.nfs_path = self.session_config.nfs_path
+        elif self.session_config.is_benchmark_device:
+
+            self.socket_manager = TCPServer(self.session_config.connect_port,
+                                            self.data_queue,
+                                            self.session_config.check_sum,
+                                            self.session_config.tls_path)
+            self.socket_manager.start()
+        elif need_dump:
+            self.socket_manager = TCPClient(self.session_config.connect_ip,
+                                            self.session_config.connect_port,
+                                            self.session_config.check_sum,
+                                            self.session_config.tls_path)
+            self.socket_manager.start()
+
+    def check_attl_config(self):
+        if self.session_config.nfs_path:
+            if os.path.exists(self.session_config.nfs_path):
+                return
+            else:
+                raise Exception(f"nfs path {self.session_config.nfs_path} doesn't exists.")
+        ipv4_pattern = "([1-9]?\d|1\d{2}|2[0-4]\d|25[0-5])(\.([1-9]?\d|1\d{2}|2[0-4]\d|25[0-5])){3}$"
+        if not re.match(ipv4_pattern, self.session_config.connect_ip):
+            raise Exception(f"host {self.session_config.connect_ip} is invalid.")
+        if not (0 < self.session_config.connect_port <= 65535):
+            raise Exception(f"port {self.session_config.connect_port} is invalid.")
+
+    def stop_serve(self):
+        if isinstance(self.socket_manager, TCPServer):
+            self.socket_manager.stop()
+
+    def send(self, buffer: BufferType) -> None:
+        """
+        npu major in 'send' (client)
+        """
+        # know receiver receive and go next
+        if isinstance(buffer, ApiData):
+            buffer = move2target_device(buffer, torch.device('cpu'))
+
+        if 'device' in buffer.kwargs:
+            buffer.kwargs.pop('device')
+        rank = buffer.rank if hasattr(buffer, "rank") and buffer.rank is not None else 0
+        step = buffer.step if hasattr(buffer, "step") else 0
+        try:
+            io_buff = save_api_data(buffer)
+        except Exception as e:
+            self.logger.info(f"{buffer.name} can not be saved, skip: {e}")
+            return
+        data = io_buff.getvalue()
+        self.socket_manager.add_to_sending_queue(data, rank=rank, step=step)
+
+    def recv(self, timeout_ms=0) -> Optional[BufferType]:
+        buffer = None
+        while buffer is None:
+            if timeout_ms > 0:
+                time.sleep(timeout_ms / 1000.0)
+            if buffer is None and not self.data_queue.empty():
+                buffer = self.data_queue.get()
+                break
+            if buffer is None and timeout_ms > 0:  # timeout is the only case we give up and return None
+                break
+            if self.message_end and self.data_queue.empty():
+                buffer = b"KILL_CONFIRM"
+                self.kill_progress = True
+                break
+            time.sleep(0.1)  # waiting outside the lock before next attempt
+        if buffer is None:
+            # this is a result of a timeout
+            self.logger.info(f"RECEIVE API DATA TIMED OUT")
+        else:
+            if buffer == b"STOP_":
+                return "STOP_"
+            if buffer == b"KILL_":
+                self.message_end = True
+                return "STOP_"
+            if buffer == b"KILL_CONFIRM":
+                self.kill_progress = True
+                return "KILL_"
+            try:
+                buffer = load_api_data(buffer)
+            except Exception as e:
+                self.logger.warning("there is something error. please check it. %s", e)
+            if isinstance(buffer, bytes):
+                return None
+            if isinstance(buffer, str):
+                return buffer
+
+        return buffer
+
+    def upload(self, buffer: BufferType):
+        if isinstance(buffer, ApiData):
+            buffer = move2target_device(buffer, torch.device('cpu'))
+            file_path = os.path.join(self.session_config.nfs_path, buffer.name + ".pt")
+        else:
+            file_path = os.path.join(self.session_config.nfs_path, buffer + f"_{int(time.time())}")
+
+        try:
+            save_pt(buffer, file_path)
+        except Exception as e:
+            self.logger.warning("there is something error in save_pt. please check it. %s", e)
+
+    def download(self):
+        buffer = None
+        cur_file = None
+        for file_type in ("start*", "*.pt", "end*"):
+            pattern = os.path.join(self.nfs_path, file_type)
+            files = glob.glob(pattern)
+            if len(files) > 0:
+                cur_file = files[0]
+                break
+
+        if cur_file is not None:
+            try:
+                buffer = load_pt(cur_file)
+            except Exception as e:
+                self.logger.warning("there is something error. please check it. %s", e)
+            remove_path(cur_file)
+        return buffer
+
+
+def move2device_exec(obj, device):
+    if isinstance(obj, (tuple, list)):
+        data_list = [move2device_exec(val, device) for val in obj]
+        return data_list if isinstance(obj, list) else tuple(data_list)
+    if isinstance(obj, dict):
+        return {key: move2device_exec(val, device) for key, val in obj.items()}
+    elif isinstance(obj, torch.Tensor):
+        obj = obj.detach()
+        if obj.device.type != device:
+            obj = obj.to(device)
+        return obj
+    elif "return_types" in str(type(obj)):
+        return move2device_exec(tuple(obj), device)
+    elif isinstance(obj, torch._C.device):
+        return torch.device(device)
+    else:
+        return obj
+
+
+def move2target_device(buffer: ApiData, target_device):
+    # handle args
+    new_args = move2device_exec(buffer.args, target_device)
+
+    # handle kwargs
+    new_kwargs = move2device_exec(buffer.kwargs, target_device)
+
+    # handle result
+    new_results = move2device_exec(buffer.result, target_device)
+
+    if target_device == torch.device('cpu') or target_device == "cpu":
+        return ApiData(buffer.name, tuple(new_args), new_kwargs, new_results, buffer.step, buffer.rank)
+    else:
+        return ApiData(buffer.name, tuple(new_args), new_kwargs, buffer.result, buffer.step, buffer.rank)

msprobe/pytorch/api_accuracy_checker/tensor_transport_layer/client.py

@@ -0,0 +1,325 @@
+import hashlib
+import io
+import struct
+import time
+import os
+import signal
+import sys
+from queue import Queue
+from threading import Thread
+from typing import Union
+
+from twisted.internet import reactor, protocol, endpoints
+from twisted.protocols.basic import FileSender
+
+from msprobe.pytorch.common.utils import logger
+from msprobe.pytorch.api_accuracy_checker.tensor_transport_layer.ssl_config import cipher_list
+
+
+class TCPDataItem:
+    def __init__(self, data,
+                 sequence_number: int,
+                 rank: int = 0,
+                 step: int = 0):
+        self.raw_data = data
+        self.sequence_number = sequence_number
+        self.rank = rank
+        self.step = step
+        self.retry_times = 0
+        self.pending_time = 0
+        self.busy_time = 0
+
+
+class TCPClient:
+    MAX_SENDING_QUEUE_SIZE = 20
+    ACK_SUCCESS = b"OK___"
+    ACK_ERROR = b"ERROR"
+    ACK_BUSY = b"BUSY_"
+    ACK_STOP = b"STOP_"
+    ACK_STOP_CONFIRM = b"OVER_"
+    ACK_KILL_PROCESS = b"KILL_"
+
+    QUEUE_PENDING_TIME = 600  # 队列10分钟都处于阻塞状态，则终止sending进程
+    RESEND_RETRY_TIMES = 2  # 最大重传数
+    RESEND_TIMER_TIME = 5  # 接收ACK超时定时器
+    RESEND_PENDING_TIME = 60  # 连续pending时间超过1分钟则放弃该数据
+
+    def __init__(self, host="localhost", port=8000, check_sum=False, tls_path=None):
+        self.send_queue = Queue(self.MAX_SENDING_QUEUE_SIZE)
+        self.resend_dict = dict()
+        self.host = host
+        self.port = port
+        self.tls_path = tls_path
+        self.factory = None
+        self.sequence_number = 0
+        self.signal_exit = False
+        self.tcp_manager = ClientProtocol(ack_queue_size=100,
+                                          chunk_size=655360,
+                                          check_sum=check_sum)
+        self.send_thread = Thread(target=self._sending_queue_data)
+        self.send_thread.setDaemon(True)
+        self.send_thread.start()
+        self.destroy_thread = Thread(target=self._destroy_queue_data)
+        self.destroy_thread.setDaemon(True)
+        self.destroy_thread.start()
+
+    @staticmethod
+    def run_reactor():
+        reactor.run(installSignalHandlers=False)
+
+    def start(self):
+        def conn_callback(cur_protocol):
+            if cur_protocol.transport and cur_protocol.transport.getPeer().host == self.host:
+                logger.debug(f"Process: {os.getpid()} connects to server successfully.")
+            else:
+                logger.warning(f"Process: {os.getpid()} fails to connect to server. ")
+                raise ConnectionError(f"Failed to connect to {self.host}.")
+
+        def conn_err_callback(failure):
+            self.signal_exit = True
+            time.sleep(1)
+            reactor.stop()
+            logger.error(f"Failed to connected {self.host} {self.port}. Reason is {failure.getErrorMessage()}")
+            os.kill(os.getpid(), signal.SIGKILL)
+            os.kill(os.getppid(), signal.SIGKILL)
+
+        def cur_protocol():
+            return self.tcp_manager
+
+        self.factory = MessageClientFactory()
+        self.factory.protocol = cur_protocol
+        if self.tls_path:
+            from OpenSSL import SSL
+            from twisted.internet import ssl
+            client_key = os.path.join(self.tls_path, "client.key")
+            client_crt = os.path.join(self.tls_path, "client.crt")
+            client_context_factory = ssl.DefaultOpenSSLContextFactory(client_key, client_crt, SSL.TLSv1_2_METHOD)
+            client_context_ = client_context_factory.getContext()
+            client_context_.set_cipher_list(cipher_list)
+            client_context_.set_options(SSL.OP_NO_RENEGOTIATION)
+            endpoint = endpoints.SSL4ClientEndpoint(reactor, self.host, self.port, client_context_factory)
+        else:
+            endpoint = endpoints.TCP4ClientEndpoint(reactor, self.host, self.port)
+        d = endpoint.connect(self.factory)
+        d.addCallback(conn_callback)
+        d.addErrback(conn_err_callback)
+
+        reactor_thread = Thread(target=self.run_reactor, daemon=True)
+        reactor_thread.start()
+
+    def send_after_queue_empty(self, data):
+        while not self._ready_to_exit():
+            self.add_to_sending_queue(data)
+            time.sleep(2)
+
+    def check_client_alive(self):
+        return self.factory.num_connections > 0
+
+    def stop(self):
+        self.tcp_manager.connection_timeout()
+
+    def send_stop_signal(self):
+        self.send_after_queue_empty(self.ACK_STOP)
+        while not self._ready_to_exit():
+            if not self.check_client_alive():
+                break
+            time.sleep(1)
+        while not self.tcp_manager.kill_process:
+            time.sleep(1)
+
+    def add_to_sending_queue(self, data: Union[bytes, TCPDataItem], rank: int = 0, step: int = 0):
+        if self._ready_to_exit():
+            return
+
+        send_data = data
+        if not isinstance(data, TCPDataItem):
+            send_data = TCPDataItem(data=data,
+                                    sequence_number=self.sequence_number,
+                                    rank=rank,
+                                    step=step)
+            self.sequence_number += 1
+        try:
+            self.send_queue.put(send_data, block=True, timeout=self.QUEUE_PENDING_TIME)
+        except Exception as e:
+            logger.error(f"send_queue put send_data timeout, rank: {send_data.rank}, step: {send_data.step},"
+                         f"sequence_number: {send_data.sequence_number}, {str(e)}")
+
+    def _send_data(self, data: TCPDataItem):
+        self.tcp_manager.send_wrapped_data(data.raw_data,
+                                           sequence_number=data.sequence_number,
+                                           rank=data.rank,
+                                           step=data.step
+                                           )
+
+    def _sending_queue_data(self):
+        while True:
+            if not self.tcp_manager.is_connected:
+                continue
+
+            while self.send_queue.qsize() > 0:
+                if self._ready_to_exit():
+                    break
+                if len(self.resend_dict) < self.MAX_SENDING_QUEUE_SIZE:
+                    data_obj = self.send_queue.get()
+                    self._send_data(data_obj)
+                    resend_key = str(data_obj.sequence_number) + "_" + str(data_obj.rank) + "_" + str(data_obj.step)
+                    if resend_key not in self.resend_dict.keys():
+                        # Send data for the first time
+                        self.resend_dict[resend_key] = data_obj
+                else:
+                    time.sleep(0.1)
+
+            if self._ready_to_exit():
+                logger.debug("Successfully close sending process.")
+                break
+            time.sleep(0.1)
+
+    def _destroy_queue_data(self):
+        while True:
+            if self._ready_to_exit():
+                break
+
+            while len(self.resend_dict) > 0 and self.tcp_manager.ack_queue.qsize() > 0:
+                ack_info, seq_number, rank, step = self.tcp_manager.ack_queue.get()
+                obj_key = str(seq_number) + "_" + str(rank) + "_" + str(step)
+                current_item = self.resend_dict.get(obj_key)
+
+                if current_item is None:
+                    continue
+
+                if ack_info == self.ACK_SUCCESS:
+                    self.resend_dict.pop(obj_key)
+                elif ack_info == self.ACK_BUSY:
+                    logger.debug("RECV BUSY ACK")
+                    if current_item.busy_time > 5:
+                        self._resend_data(current_item)
+                    else:
+                        current_item.busy_time += 1
+                elif ack_info == self.ACK_ERROR:
+                    logger.debug("RECV ERROR ACK")
+                    self._resend_data(current_item)
+                elif ack_info == self.ACK_STOP_CONFIRM:
+                    logger.debug("RECV STOP ACK")
+                    self.factory.num_connections -= 1
+
+                break
+
+            time.sleep(0.1)
+
+    def _resend_data(self, data: TCPDataItem):
+        if data.retry_times < self.RESEND_RETRY_TIMES:
+            data.retry_times += 1
+            logger.debug(f"Resend data seq number: {data.sequence_number}")
+            self.add_to_sending_queue(data)
+        else:
+            self.resend_dict.pop(data.sequence_number)
+            logger.debug(f"SKIP send sequence number {data.sequence_number} after retry {data.retry_times} times!")
+
+    def _pending_data(self, data: TCPDataItem):
+        if data.pending_time >= self.RESEND_PENDING_TIME:
+            self.resend_dict.pop(data.sequence_number)
+            logger.debug(f"SKIP send sequence number {data.sequence_number} after pending {data.pending_time} times!")
+            return
+
+        # wait time is 100MB per second
+        pending_time = max(1, len(data.raw_data) // (2 ** 20 * 50))
+        data.pending_time += pending_time
+        time.sleep(pending_time)
+
+    def _ready_to_exit(self):
+        return self.signal_exit or self.tcp_manager.signal_exit
+
+
+class ClientProtocol(protocol.Protocol):
+    TIMEOUT = 60 * 10
+
+    def __init__(self, ack_queue_size=100, chunk_size=65536, check_sum=False):
+        self.buffer = io.BytesIO()
+        self.is_connected = False
+        self.check_sum = check_sum
+        self.tell = 0
+        self.ack_queue = Queue(maxsize=ack_queue_size)
+        self.file_sender = FileSender()
+        self.file_sender.CHUNK_SIZE = chunk_size
+        self.signal_exit = False
+        self.defer = None
+        self.kill_process = False
+
+    def dataReceived(self, data):
+        if self.timeout_call.active():
+            self.timeout_call.reset(self.TIMEOUT)
+
+        self.buffer.seek(0, 2)
+        self.buffer.write(data)
+        self.buffer.seek(self.tell)
+        while True:
+            if len(self.buffer.getvalue()) >= 29:  # 5 + 8 * 3
+                ack = self.buffer.read(5)
+                seq_number = struct.unpack('!Q', self.buffer.read(8))[0]
+                rank = struct.unpack('!Q', self.buffer.read(8))[0]
+                step = struct.unpack('!Q', self.buffer.read(8))[0]
+                if ack == b"KILL_":
+                    self.kill_process = True
+                    logger.debug(f"接收到KILL信号, PID {os.getpid()}")
+                if ack == b"OVER_":
+                    self.factory.num_connections -= 1
+                self.tell += 29
+                if not self.ack_queue.full():
+                    self.ack_queue.put((ack, seq_number, rank, step))
+                    self.buffer = io.BytesIO(self.buffer.getvalue()[self.tell:])
+                    self.tell = 0
+                else:
+                    time.sleep(0.1)
+            else:
+                break
+
+    def send_wrapped_data(self, data, sequence_number: int = 0, rank: int = 0, step: int = 0):
+        length = len(data)
+        md5_hash = hashlib.md5(data).hexdigest() if self.check_sum else ""
+        while True:
+            if self.defer is None or self.defer.called:
+                self.defer = self.send_large_data(
+                    length.to_bytes(8, byteorder='big') +
+                    sequence_number.to_bytes(8, byteorder='big') +
+                    rank.to_bytes(8, byteorder='big') +
+                    step.to_bytes(8, byteorder='big') +
+                    md5_hash.encode() +
+                    data)
+                break
+            time.sleep(0.01)
+
+    def send_large_data(self, data):
+        d = self.file_sender.beginFileTransfer(io.BytesIO(data), self.transport)
+        return d
+
+    def connection_timeout(self):
+        if self.factory.num_connections <= 0:
+            return
+
+        self.factory.num_connections -= 1
+        logger.debug(f"超时退出{self.transport.addr}, PID {os.getpid()}")
+        self.transport.loseConnection()
+
+    def connectionMade(self):
+        self.timeout_call = reactor.callLater(self.TIMEOUT, self.connection_timeout)
+        self.is_connected = True
+        self.factory.num_connections += 1
+        logger.info("successfully connect server")
+
+    def connectionLost(self, reason):
+        self.signal_exit = True
+        self.factory.num_connections -= 1
+        logger.info(f"Lost connection with server, reason is : {reason}")
+
+
+class MessageClientFactory(protocol.ClientFactory):
+    def __init__(self):
+        self.num_connections = 0
+
+    def clientConnectionFailed(self, connector, reason):
+        logger.info(f"Fail to connection with server: {reason.getErrorMessage()}")
+        reactor.stop()
+
+    def clientConnectionLost(self, connector, reason):
+        logger.info(f"Client lost connection with server: {reason.getErrorMessage()}")
+        reactor.stop()