uievent.py 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. #
  2. # Copyright (C) 2006 - 2007 Michael 'Mickey' Lauer
  3. # Copyright (C) 2006 - 2007 Richard Purdie
  4. #
  5. # SPDX-License-Identifier: GPL-2.0-only
  6. #
  7. """
  8. Use this class to fork off a thread to recieve event callbacks from the bitbake
  9. server and queue them for the UI to process. This process must be used to avoid
  10. client/server deadlocks.
  11. """
  12. import socket, threading, pickle, collections
  13. from xmlrpc.server import SimpleXMLRPCServer, SimpleXMLRPCRequestHandler
  14. class BBUIEventQueue:
  15. def __init__(self, BBServer, clientinfo=("localhost, 0")):
  16. self.eventQueue = []
  17. self.eventQueueLock = threading.Lock()
  18. self.eventQueueNotify = threading.Event()
  19. self.BBServer = BBServer
  20. self.clientinfo = clientinfo
  21. server = UIXMLRPCServer(self.clientinfo)
  22. self.host, self.port = server.socket.getsockname()
  23. server.register_function( self.system_quit, "event.quit" )
  24. server.register_function( self.send_event, "event.sendpickle" )
  25. server.socket.settimeout(1)
  26. self.EventHandle = None
  27. # the event handler registration may fail here due to cooker being in invalid state
  28. # this is a transient situation, and we should retry a couple of times before
  29. # giving up
  30. for count_tries in range(5):
  31. ret = self.BBServer.registerEventHandler(self.host, self.port)
  32. if isinstance(ret, collections.Iterable):
  33. self.EventHandle, error = ret
  34. else:
  35. self.EventHandle = ret
  36. error = ""
  37. if self.EventHandle is not None:
  38. break
  39. errmsg = "Could not register UI event handler. Error: %s, host %s, "\
  40. "port %d" % (error, self.host, self.port)
  41. bb.warn("%s, retry" % errmsg)
  42. import time
  43. time.sleep(1)
  44. else:
  45. raise Exception(errmsg)
  46. self.server = server
  47. self.t = threading.Thread()
  48. self.t.setDaemon(True)
  49. self.t.run = self.startCallbackHandler
  50. self.t.start()
  51. def getEvent(self):
  52. self.eventQueueLock.acquire()
  53. if len(self.eventQueue) == 0:
  54. self.eventQueueLock.release()
  55. return None
  56. item = self.eventQueue.pop(0)
  57. if len(self.eventQueue) == 0:
  58. self.eventQueueNotify.clear()
  59. self.eventQueueLock.release()
  60. return item
  61. def waitEvent(self, delay):
  62. self.eventQueueNotify.wait(delay)
  63. return self.getEvent()
  64. def queue_event(self, event):
  65. self.eventQueueLock.acquire()
  66. self.eventQueue.append(event)
  67. self.eventQueueNotify.set()
  68. self.eventQueueLock.release()
  69. def send_event(self, event):
  70. self.queue_event(pickle.loads(event))
  71. def startCallbackHandler(self):
  72. self.server.timeout = 1
  73. bb.utils.set_process_name("UIEventQueue")
  74. while not self.server.quit:
  75. try:
  76. self.server.handle_request()
  77. except Exception as e:
  78. import traceback
  79. logger.error("BBUIEventQueue.startCallbackHandler: Exception while trying to handle request: %s\n%s" % (e, traceback.format_exc()))
  80. self.server.server_close()
  81. def system_quit( self ):
  82. """
  83. Shut down the callback thread
  84. """
  85. try:
  86. self.BBServer.unregisterEventHandler(self.EventHandle)
  87. except:
  88. pass
  89. self.server.quit = True
  90. class UIXMLRPCServer (SimpleXMLRPCServer):
  91. def __init__( self, interface ):
  92. self.quit = False
  93. SimpleXMLRPCServer.__init__( self,
  94. interface,
  95. requestHandler=SimpleXMLRPCRequestHandler,
  96. logRequests=False, allow_none=True, use_builtin_types=True)
  97. def get_request(self):
  98. while not self.quit:
  99. try:
  100. sock, addr = self.socket.accept()
  101. sock.settimeout(1)
  102. return (sock, addr)
  103. except socket.timeout:
  104. pass
  105. return (None, None)
  106. def close_request(self, request):
  107. if request is None:
  108. return
  109. SimpleXMLRPCServer.close_request(self, request)
  110. def process_request(self, request, client_address):
  111. if request is None:
  112. return
  113. SimpleXMLRPCServer.process_request(self, request, client_address)