# Copyright (c) 2020 PaddlePaddle Authors. All Rights Reserved. # # Licensed 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=doc-string-missing import threading import multiprocessing import multiprocessing.queues import sys if sys.version_info.major == 2: import Queue elif sys.version_info.major == 3: import queue as Queue else: raise Exception("Error Python version") import numpy as np import logging import enum import copy _LOGGER = logging.getLogger() class ChannelDataEcode(enum.Enum): OK = 0 TIMEOUT = 1 NOT_IMPLEMENTED = 2 TYPE_ERROR = 3 RPC_PACKAGE_ERROR = 4 CLIENT_ERROR = 5 UNKNOW = 6 class ChannelDataType(enum.Enum): DICT = 0 CHANNEL_NPDATA = 1 ERROR = 2 class ChannelData(object): def __init__(self, datatype=None, npdata=None, dictdata=None, data_id=None, ecode=None, error_info=None): ''' There are several ways to use it: 1. ChannelData(ChannelDataType.CHANNEL_NPDATA.value, npdata, data_id) 2. ChannelData(ChannelDataType.DICT.value, dictdata, data_id) 3. ChannelData(ecode, error_info, data_id) Protobufs are not pickle-able: https://stackoverflow.com/questions/55344376/how-to-import-protobuf-module ''' if ecode is not None: if data_id is None or error_info is None: raise ValueError("data_id and error_info cannot be None") datatype = ChannelDataType.ERROR.value else: if datatype == ChannelDataType.CHANNEL_NPDATA.value: ecode, error_info = ChannelData.check_npdata(npdata) if ecode != ChannelDataEcode.OK.value: datatype = ChannelDataType.ERROR.value _LOGGER.error(error_info) elif datatype == ChannelDataType.DICT.value: ecode, error_info = ChannelData.check_dictdata(dictdata) if ecode != ChannelDataEcode.OK.value: datatype = ChannelDataType.ERROR.value _LOGGER.error(error_info) else: raise ValueError("datatype not match") self.datatype = datatype self.npdata = npdata self.dictdata = dictdata self.id = data_id self.ecode = ecode self.error_info = error_info @staticmethod def check_dictdata(dictdata): ecode = ChannelDataEcode.OK.value error_info = None if isinstance(dictdata, list): # batch data for sample in dictdata: if not isinstance(sample, dict): ecode = ChannelDataEcode.TYPE_ERROR.value error_info = "the value of data must " \ "be dict, but get {}.".format(type(sample)) break elif not isinstance(dictdata, dict): # batch size = 1 ecode = ChannelDataEcode.TYPE_ERROR.value error_info = "the value of data must " \ "be dict, but get {}.".format(type(dictdata)) return ecode, error_info @staticmethod def check_npdata(npdata): ecode = ChannelDataEcode.OK.value error_info = None if isinstance(npdata, list): # batch data for sample in npdata: if not isinstance(sample, dict): ecode = ChannelDataEcode.TYPE_ERROR.value error_info = "the value of data must " \ "be dict, but get {}.".format(type(sample)) break for _, value in sample.items(): if not isinstance(value, np.ndarray): ecode = ChannelDataEcode.TYPE_ERROR.value error_info = "the value of data must " \ "be np.ndarray, but get {}.".format(type(value)) return ecode, error_info elif isinstance(npdata, dict): # batch_size = 1 for _, value in npdata.items(): if not isinstance(value, np.ndarray): ecode = ChannelDataEcode.TYPE_ERROR.value error_info = "the value of data must " \ "be np.ndarray, but get {}.".format(type(value)) break else: ecode = ChannelDataEcode.TYPE_ERROR.value error_info = "the value of data must " \ "be dict, but get {}.".format(type(npdata)) return ecode, error_info def parse(self): feed = None if self.datatype == ChannelDataType.CHANNEL_NPDATA.value: # return narray feed = self.npdata elif self.datatype == ChannelDataType.DICT.value: # return dict feed = self.dictdata else: raise TypeError("Error type({}) in datatype.".format(self.datatype)) return feed def __str__(self): return "type[{}], ecode[{}], id[{}]".format( ChannelDataType(self.datatype).name, self.ecode, self.id) class ProcessChannel(object): """ (Process version) The channel used for communication between Ops. 1. Support multiple different Op feed data (multiple producer) Different types of data will be packaged through the data ID 2. Support multiple different Op fetch data (multiple consumer) Only when all types of Ops get the data of the same ID, the data will be poped; The Op of the same type will not get the data of the same ID. 3. (TODO) Timeout and BatchSize are not fully supported. Note: 1. The ID of the data in the channel must be different. 2. The function add_producer() and add_consumer() are not thread safe, and can only be called during initialization. There are two buffers and one queue in Channel: op_A \ / op_D op_B - a. input_buf -> b. queue -> c. output_buf - op_E op_C / \ op_F a. In input_buf, the input of multiple predecessor Ops is packed by data ID. b. The packed data will be stored in queue. c. In order to support multiple successor Ops to retrieve data, output_buf maintains the data obtained from queue. """ def __init__(self, manager, name=None, maxsize=0, timeout=None): # For queue multiprocess: after putting an object on # an empty queue there may be an infinitessimal delay # before the queue's :meth:`~Queue.empty` # see more: # - https://bugs.python.org/issue18277 # - https://hg.python.org/cpython/rev/860fc6a2bd21 self._que = manager.Queue(maxsize=maxsize) self._maxsize = maxsize self._timeout = timeout self.name = name self._stop = False self._cv = multiprocessing.Condition() self._producers = [] self._pushed_producer_count = manager.dict() # {data_id: count} self._input_buf = manager.dict() # {data_id: {op_name: data}} self._reset_max_cursor = 1000000000000000000 self._consumer_cursors = manager.dict() # {op_name: cursor} self._cursor_count = manager.dict() # {cursor: count} self._base_cursor = manager.Value('i', 0) self._output_buf = manager.list() def get_producers(self): return self._producers def get_consumers(self): return self._consumer_cursors.keys() def _log(self, info_str): return "[{}] {}".format(self.name, info_str) def debug(self): return self._log("p: {}, c: {}".format(self.get_producers(), self.get_consumers())) def add_producer(self, op_name): """ not thread safe, and can only be called during initialization. """ if op_name in self._producers: raise ValueError( self._log("producer({}) is already in channel".format(op_name))) self._producers.append(op_name) def add_consumer(self, op_name): """ not thread safe, and can only be called during initialization. """ if op_name in self._consumer_cursors: raise ValueError( self._log("consumer({}) is already in channel".format(op_name))) self._consumer_cursors[op_name] = 0 if self._cursor_count.get(0) is None: self._cursor_count[0] = 0 self._cursor_count[0] += 1 def push(self, channeldata, op_name=None): _LOGGER.debug( self._log("{} try to push data: {}".format(op_name, channeldata.__str__()))) if len(self._producers) == 0: raise Exception( self._log( "expected number of producers to be greater than 0, but the it is 0." )) elif len(self._producers) == 1: with self._cv: while self._stop is False: try: self._que.put({op_name: channeldata}, timeout=0) break except Queue.Full: self._cv.wait() _LOGGER.debug( self._log("{} channel size: {}".format(op_name, self._que.qsize()))) self._cv.notify_all() _LOGGER.debug(self._log("{} notify all".format(op_name))) _LOGGER.debug(self._log("{} push data succ!".format(op_name))) return True elif op_name is None: raise Exception( self._log( "There are multiple producers, so op_name cannot be None.")) producer_num = len(self._producers) data_id = channeldata.id put_data = None with self._cv: _LOGGER.debug(self._log("{} get lock".format(op_name))) if data_id not in self._input_buf: self._input_buf[data_id] = { name: None for name in self._producers } self._pushed_producer_count[data_id] = 0 # see: https://docs.python.org/3.6/library/multiprocessing.html?highlight=multiprocess#proxy-objects # self._input_buf[data_id][op_name] = channeldata tmp_input_buf = self._input_buf[data_id] tmp_input_buf[op_name] = channeldata self._input_buf[data_id] = tmp_input_buf if self._pushed_producer_count[data_id] + 1 == producer_num: put_data = self._input_buf[data_id] self._input_buf.pop(data_id) self._pushed_producer_count.pop(data_id) else: self._pushed_producer_count[data_id] += 1 if put_data is None: _LOGGER.debug( self._log("{} push data succ, but not push to queue.". format(op_name))) else: while self._stop is False: try: _LOGGER.debug( self._log("{} push data succ: {}".format( op_name, put_data.__str__()))) self._que.put(put_data, timeout=0) break except Queue.Empty: self._cv.wait() _LOGGER.debug( self._log("multi | {} push data succ!".format(op_name))) self._cv.notify_all() return True def front(self, op_name=None): _LOGGER.debug(self._log("{} try to get data...".format(op_name))) if len(self._consumer_cursors) == 0: raise Exception( self._log( "expected number of consumers to be greater than 0, but the it is 0." )) elif len(self._consumer_cursors) == 1: resp = None with self._cv: while self._stop is False and resp is None: try: _LOGGER.debug( self._log("{} try to get(with channel empty: {})". format(op_name, self._que.empty()))) resp = self._que.get(timeout=0) break except Queue.Empty: _LOGGER.debug( self._log( "{} wait for empty queue(with channel empty: {})". format(op_name, self._que.empty()))) self._cv.wait() _LOGGER.debug( self._log("{} get data succ: {}".format(op_name, resp.__str__( )))) return resp elif op_name is None: raise Exception( self._log( "There are multiple consumers, so op_name cannot be None.")) # In output_buf, different Ops (according to op_name) have different # cursors. In addition, there is a base_cursor. Their difference is # the data_idx to be taken by the corresponding Op at the current # time: data_idx = consumer_cursor - base_cursor # # base_cursor consumer_B_cursor (data_idx: 3) # | | # output_buf: | data0 | data1 | data2 | data3 | # | # consumer_A_cursor (data_idx: 0) with self._cv: # When the data required by the current Op is not in output_buf, # it is necessary to obtain a data from queue and add it to output_buf. while self._stop is False and self._consumer_cursors[ op_name] - self._base_cursor.value >= len(self._output_buf): _LOGGER.debug( self._log( "({}) B self._consumer_cursors: {}, self._base_cursor: {}, len(self._output_buf): {}". format(op_name, self._consumer_cursors, self._base_cursor.value, len(self._output_buf)))) try: _LOGGER.debug( self._log("{} try to get(with channel size: {})".format( op_name, self._que.qsize()))) channeldata = self._que.get(timeout=0) self._output_buf.append(channeldata) break except Queue.Empty: _LOGGER.debug( self._log( "{} wait for empty queue(with channel size: {})". format(op_name, self._que.qsize()))) self._cv.wait() consumer_cursor = self._consumer_cursors[op_name] base_cursor = self._base_cursor.value data_idx = consumer_cursor - base_cursor resp = self._output_buf[data_idx] _LOGGER.debug(self._log("{} get data: {}".format(op_name, resp))) self._cursor_count[consumer_cursor] -= 1 if consumer_cursor == base_cursor and self._cursor_count[ consumer_cursor] == 0: # When all the different Ops get the data that data_idx points # to, pop the data from output_buf. self._cursor_count.pop(consumer_cursor) self._output_buf.pop(0) self._base_cursor.value += 1 # to avoid cursor overflow if self._base_cursor.value >= self._reset_max_cursor: self._base_cursor.value -= self._reset_max_cursor for name in self._consumer_cursors.keys(): self._consumer_cursors[name] -= self._reset_max_cursor cursor_count_tmp = { cursor - self._reset_max_cursor: count for cursor, count in self._cursor_count.copy().items() } self._cursor_count.clear() for cursor, count in cursor_count_tmp.items(): self._cursor_count[cursor] = count self._consumer_cursors[op_name] += 1 new_consumer_cursor = self._consumer_cursors[op_name] if self._cursor_count.get(new_consumer_cursor) is None: self._cursor_count[new_consumer_cursor] = 0 self._cursor_count[new_consumer_cursor] += 1 _LOGGER.debug( self._log( "({}) A self._consumer_cursors: {}, self._base_cursor: {}, len(self._output_buf): {}". format(op_name, self._consumer_cursors, self._base_cursor.value, len(self._output_buf)))) _LOGGER.debug(self._log("{} notify all".format(op_name))) self._cv.notify_all() _LOGGER.debug(self._log("multi | {} get data succ!".format(op_name))) return resp # reference, read only def stop(self): #TODO self.close() self._stop = True self._cv.notify_all() class ThreadChannel(Queue.Queue): """ (Thread version)The channel used for communication between Ops. 1. Support multiple different Op feed data (multiple producer) Different types of data will be packaged through the data ID 2. Support multiple different Op fetch data (multiple consumer) Only when all types of Ops get the data of the same ID, the data will be poped; The Op of the same type will not get the data of the same ID. 3. (TODO) Timeout and BatchSize are not fully supported. Note: 1. The ID of the data in the channel must be different. 2. The function add_producer() and add_consumer() are not thread safe, and can only be called during initialization. There are two buffers and one queue in Channel: op_A \ / op_D op_B - a. input_buf -> b. queue -> c. output_buf - op_E op_C / \ op_F a. In input_buf, the input of multiple predecessor Ops is packed by data ID. b. The packed data will be stored in queue. c. In order to support multiple successor Ops to retrieve data, output_buf maintains the data obtained from queue. """ def __init__(self, name=None, maxsize=-1, timeout=None): Queue.Queue.__init__(self, maxsize=maxsize) self._maxsize = maxsize self._timeout = timeout self.name = name self._stop = False self._cv = threading.Condition() self._producers = [] self._pushed_producer_count = {} # {data_id: count} self._input_buf = {} # {data_id: {op_name: data}} self._reset_max_cursor = 1000000000000000000 self._consumer_cursors = {} # {op_name: idx} self._cursor_count = {} # {cursor: count} self._base_cursor = 0 self._output_buf = [] def get_producers(self): return self._producers def get_consumers(self): return self._consumer_cursors.keys() def _log(self, info_str): return "[{}] {}".format(self.name, info_str) def debug(self): return self._log("p: {}, c: {}".format(self.get_producers(), self.get_consumers())) def add_producer(self, op_name): """ not thread safe, and can only be called during initialization. """ if op_name in self._producers: raise ValueError( self._log("producer({}) is already in channel".format(op_name))) self._producers.append(op_name) def add_consumer(self, op_name): """ not thread safe, and can only be called during initialization. """ if op_name in self._consumer_cursors: raise ValueError( self._log("consumer({}) is already in channel".format(op_name))) self._consumer_cursors[op_name] = 0 if self._cursor_count.get(0) is None: self._cursor_count[0] = 0 self._cursor_count[0] += 1 def push(self, channeldata, op_name=None): _LOGGER.debug( self._log("{} try to push data: {}".format(op_name, channeldata.__str__()))) if len(self._producers) == 0: raise Exception( self._log( "expected number of producers to be greater than 0, but the it is 0." )) elif len(self._producers) == 1: with self._cv: while self._stop is False: try: self.put({op_name: channeldata}, timeout=0) break except Queue.Full: self._cv.wait() self._cv.notify_all() _LOGGER.debug(self._log("{} push data succ!".format(op_name))) return True elif op_name is None: raise Exception( self._log( "There are multiple producers, so op_name cannot be None.")) producer_num = len(self._producers) data_id = channeldata.id put_data = None with self._cv: _LOGGER.debug(self._log("{} get lock".format(op_name))) if data_id not in self._input_buf: self._input_buf[data_id] = { name: None for name in self._producers } self._pushed_producer_count[data_id] = 0 self._input_buf[data_id][op_name] = channeldata if self._pushed_producer_count[data_id] + 1 == producer_num: put_data = self._input_buf[data_id] self._input_buf.pop(data_id) self._pushed_producer_count.pop(data_id) else: self._pushed_producer_count[data_id] += 1 if put_data is None: _LOGGER.debug( self._log("{} push data succ, but not push to queue.". format(op_name))) else: while self._stop is False: try: self.put(put_data, timeout=0) break except Queue.Empty: self._cv.wait() _LOGGER.debug( self._log("multi | {} push data succ!".format(op_name))) self._cv.notify_all() return True def front(self, op_name=None): _LOGGER.debug(self._log("{} try to get data".format(op_name))) if len(self._consumer_cursors) == 0: raise Exception( self._log( "expected number of consumers to be greater than 0, but the it is 0." )) elif len(self._consumer_cursors) == 1: resp = None with self._cv: while self._stop is False and resp is None: try: resp = self.get(timeout=0) break except Queue.Empty: self._cv.wait() _LOGGER.debug( self._log("{} get data succ: {}".format(op_name, resp.__str__( )))) return resp elif op_name is None: raise Exception( self._log( "There are multiple consumers, so op_name cannot be None.")) # In output_buf, different Ops (according to op_name) have different # cursors. In addition, there is a base_cursor. Their difference is # the data_idx to be taken by the corresponding Op at the current # time: data_idx = consumer_cursor - base_cursor # # base_cursor consumer_B_cursor (data_idx: 3) # | | # output_buf: | data0 | data1 | data2 | data3 | # | # consumer_A_cursor (data_idx: 0) with self._cv: # When the data required by the current Op is not in output_buf, # it is necessary to obtain a data from queue and add it to output_buf. while self._stop is False and self._consumer_cursors[ op_name] - self._base_cursor >= len(self._output_buf): try: channeldata = self.get(timeout=0) self._output_buf.append(channeldata) break except Queue.Empty: self._cv.wait() consumer_cursor = self._consumer_cursors[op_name] base_cursor = self._base_cursor data_idx = consumer_cursor - base_cursor resp = None self._cursor_count[consumer_cursor] -= 1 if consumer_cursor == base_cursor and self._cursor_count[ consumer_cursor] == 0: # When all the different Ops get the data that data_idx points # to, pop the data from output_buf. self._cursor_count.pop(consumer_cursor) resp = self._output_buf.pop(0) self._base_cursor += 1 # to avoid cursor overflow if self._base_cursor >= self._reset_max_cursor: self._base_cursor -= self._reset_max_cursor for name in self._consumer_cursors: self._consumer_cursors[name] -= self._reset_max_cursor self._cursor_count = { cursor - self._reset_max_cursor: count for cursor, count in self._cursor_count.items() } else: resp = copy.deepcopy(self._output_buf[data_idx]) _LOGGER.debug(self._log("{} get data: {}".format(op_name, resp))) self._consumer_cursors[op_name] += 1 new_consumer_cursor = self._consumer_cursors[op_name] if self._cursor_count.get(new_consumer_cursor) is None: self._cursor_count[new_consumer_cursor] = 0 self._cursor_count[new_consumer_cursor] += 1 self._cv.notify_all() _LOGGER.debug(self._log("multi | {} get data succ!".format(op_name))) return resp def stop(self): #TODO self.close() self._stop = True self._cv.notify_all()