uievent.py 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. # ex:ts=4:sw=4:sts=4:et
  2. # -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
  3. #
  4. # Copyright (C) 2006 - 2007 Michael 'Mickey' Lauer
  5. # Copyright (C) 2006 - 2007 Richard Purdie
  6. #
  7. # SPDX-License-Identifier: GPL-2.0-only
  8. #
  9. # This program is free software; you can redistribute it and/or modify
  10. # it under the terms of the GNU General Public License version 2 as
  11. # published by the Free Software Foundation.
  12. #
  13. # This program is distributed in the hope that it will be useful,
  14. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. # GNU General Public License for more details.
  17. #
  18. # You should have received a copy of the GNU General Public License along
  19. # with this program; if not, write to the Free Software Foundation, Inc.,
  20. # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21. """
  22. Use this class to fork off a thread to recieve event callbacks from the bitbake
  23. server and queue them for the UI to process. This process must be used to avoid
  24. client/server deadlocks.
  25. """
  26. import socket, threading, pickle, collections
  27. from xmlrpc.server import SimpleXMLRPCServer, SimpleXMLRPCRequestHandler
  28. class BBUIEventQueue:
  29. def __init__(self, BBServer, clientinfo=("localhost, 0")):
  30. self.eventQueue = []
  31. self.eventQueueLock = threading.Lock()
  32. self.eventQueueNotify = threading.Event()
  33. self.BBServer = BBServer
  34. self.clientinfo = clientinfo
  35. server = UIXMLRPCServer(self.clientinfo)
  36. self.host, self.port = server.socket.getsockname()
  37. server.register_function( self.system_quit, "event.quit" )
  38. server.register_function( self.send_event, "event.sendpickle" )
  39. server.socket.settimeout(1)
  40. self.EventHandle = None
  41. # the event handler registration may fail here due to cooker being in invalid state
  42. # this is a transient situation, and we should retry a couple of times before
  43. # giving up
  44. for count_tries in range(5):
  45. ret = self.BBServer.registerEventHandler(self.host, self.port)
  46. if isinstance(ret, collections.Iterable):
  47. self.EventHandle, error = ret
  48. else:
  49. self.EventHandle = ret
  50. error = ""
  51. if self.EventHandle != None:
  52. break
  53. errmsg = "Could not register UI event handler. Error: %s, host %s, "\
  54. "port %d" % (error, self.host, self.port)
  55. bb.warn("%s, retry" % errmsg)
  56. import time
  57. time.sleep(1)
  58. else:
  59. raise Exception(errmsg)
  60. self.server = server
  61. self.t = threading.Thread()
  62. self.t.setDaemon(True)
  63. self.t.run = self.startCallbackHandler
  64. self.t.start()
  65. def getEvent(self):
  66. self.eventQueueLock.acquire()
  67. if len(self.eventQueue) == 0:
  68. self.eventQueueLock.release()
  69. return None
  70. item = self.eventQueue.pop(0)
  71. if len(self.eventQueue) == 0:
  72. self.eventQueueNotify.clear()
  73. self.eventQueueLock.release()
  74. return item
  75. def waitEvent(self, delay):
  76. self.eventQueueNotify.wait(delay)
  77. return self.getEvent()
  78. def queue_event(self, event):
  79. self.eventQueueLock.acquire()
  80. self.eventQueue.append(event)
  81. self.eventQueueNotify.set()
  82. self.eventQueueLock.release()
  83. def send_event(self, event):
  84. self.queue_event(pickle.loads(event))
  85. def startCallbackHandler(self):
  86. self.server.timeout = 1
  87. bb.utils.set_process_name("UIEventQueue")
  88. while not self.server.quit:
  89. try:
  90. self.server.handle_request()
  91. except Exception as e:
  92. import traceback
  93. logger.error("BBUIEventQueue.startCallbackHandler: Exception while trying to handle request: %s\n%s" % (e, traceback.format_exc()))
  94. self.server.server_close()
  95. def system_quit( self ):
  96. """
  97. Shut down the callback thread
  98. """
  99. try:
  100. self.BBServer.unregisterEventHandler(self.EventHandle)
  101. except:
  102. pass
  103. self.server.quit = True
  104. class UIXMLRPCServer (SimpleXMLRPCServer):
  105. def __init__( self, interface ):
  106. self.quit = False
  107. SimpleXMLRPCServer.__init__( self,
  108. interface,
  109. requestHandler=SimpleXMLRPCRequestHandler,
  110. logRequests=False, allow_none=True, use_builtin_types=True)
  111. def get_request(self):
  112. while not self.quit:
  113. try:
  114. sock, addr = self.socket.accept()
  115. sock.settimeout(1)
  116. return (sock, addr)
  117. except socket.timeout:
  118. pass
  119. return (None, None)
  120. def close_request(self, request):
  121. if request is None:
  122. return
  123. SimpleXMLRPCServer.close_request(self, request)
  124. def process_request(self, request, client_address):
  125. if request is None:
  126. return
  127. SimpleXMLRPCServer.process_request(self, request, client_address)