taskexp.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
  1. #
  2. # BitBake Graphical GTK based Dependency Explorer
  3. #
  4. # Copyright (C) 2007 Ross Burton
  5. # Copyright (C) 2007 - 2008 Richard Purdie
  6. #
  7. # SPDX-License-Identifier: GPL-2.0-only
  8. #
  9. import sys
  10. try:
  11. import gi
  12. gi.require_version('Gtk', '3.0')
  13. from gi.repository import Gtk, Gdk, GObject
  14. except ValueError:
  15. sys.exit("FATAL: Gtk version needs to be 3.0")
  16. except ImportError:
  17. sys.exit("FATAL: Gtk ui could not load the required gi python module")
  18. import threading
  19. from xmlrpc import client
  20. import bb
  21. import bb.event
  22. # Package Model
  23. (COL_PKG_NAME) = (0)
  24. # Dependency Model
  25. (TYPE_DEP, TYPE_RDEP) = (0, 1)
  26. (COL_DEP_TYPE, COL_DEP_PARENT, COL_DEP_PACKAGE) = (0, 1, 2)
  27. class PackageDepView(Gtk.TreeView):
  28. def __init__(self, model, dep_type, label):
  29. Gtk.TreeView.__init__(self)
  30. self.current = None
  31. self.dep_type = dep_type
  32. self.filter_model = model.filter_new()
  33. self.filter_model.set_visible_func(self._filter, data=None)
  34. self.set_model(self.filter_model)
  35. self.append_column(Gtk.TreeViewColumn(label, Gtk.CellRendererText(), text=COL_DEP_PACKAGE))
  36. def _filter(self, model, iter, data):
  37. this_type = model[iter][COL_DEP_TYPE]
  38. package = model[iter][COL_DEP_PARENT]
  39. if this_type != self.dep_type: return False
  40. return package == self.current
  41. def set_current_package(self, package):
  42. self.current = package
  43. self.filter_model.refilter()
  44. class PackageReverseDepView(Gtk.TreeView):
  45. def __init__(self, model, label):
  46. Gtk.TreeView.__init__(self)
  47. self.current = None
  48. self.filter_model = model.filter_new()
  49. self.filter_model.set_visible_func(self._filter)
  50. # The introspected API was fixed but we can't rely on a pygobject that hides this.
  51. # https://gitlab.gnome.org/GNOME/pygobject/-/commit/9cdbc56fbac4db2de78dc080934b8f0a7efc892a
  52. if hasattr(Gtk.TreeModelSort, "new_with_model"):
  53. self.sort_model = Gtk.TreeModelSort.new_with_model(self.filter_model)
  54. else:
  55. self.sort_model = self.filter_model.sort_new_with_model()
  56. self.sort_model.set_sort_column_id(COL_DEP_PARENT, Gtk.SortType.ASCENDING)
  57. self.set_model(self.sort_model)
  58. self.append_column(Gtk.TreeViewColumn(label, Gtk.CellRendererText(), text=COL_DEP_PARENT))
  59. def _filter(self, model, iter, data):
  60. package = model[iter][COL_DEP_PACKAGE]
  61. return package == self.current
  62. def set_current_package(self, package):
  63. self.current = package
  64. self.filter_model.refilter()
  65. class DepExplorer(Gtk.Window):
  66. def __init__(self):
  67. Gtk.Window.__init__(self)
  68. self.set_title("Task Dependency Explorer")
  69. self.set_default_size(500, 500)
  70. self.connect("delete-event", Gtk.main_quit)
  71. # Create the data models
  72. self.pkg_model = Gtk.ListStore(GObject.TYPE_STRING)
  73. self.pkg_model.set_sort_column_id(COL_PKG_NAME, Gtk.SortType.ASCENDING)
  74. self.depends_model = Gtk.ListStore(GObject.TYPE_INT, GObject.TYPE_STRING, GObject.TYPE_STRING)
  75. self.depends_model.set_sort_column_id(COL_DEP_PACKAGE, Gtk.SortType.ASCENDING)
  76. pane = Gtk.HPaned()
  77. pane.set_position(250)
  78. self.add(pane)
  79. # The master list of packages
  80. scrolled = Gtk.ScrolledWindow()
  81. scrolled.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
  82. scrolled.set_shadow_type(Gtk.ShadowType.IN)
  83. self.pkg_treeview = Gtk.TreeView(self.pkg_model)
  84. self.pkg_treeview.get_selection().connect("changed", self.on_cursor_changed)
  85. column = Gtk.TreeViewColumn("Package", Gtk.CellRendererText(), text=COL_PKG_NAME)
  86. self.pkg_treeview.append_column(column)
  87. scrolled.add(self.pkg_treeview)
  88. self.search_entry = Gtk.SearchEntry.new()
  89. self.pkg_treeview.set_search_entry(self.search_entry)
  90. left_panel = Gtk.VPaned()
  91. left_panel.add(self.search_entry)
  92. left_panel.add(scrolled)
  93. pane.add1(left_panel)
  94. box = Gtk.VBox(homogeneous=True, spacing=4)
  95. # Task Depends
  96. scrolled = Gtk.ScrolledWindow()
  97. scrolled.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
  98. scrolled.set_shadow_type(Gtk.ShadowType.IN)
  99. self.dep_treeview = PackageDepView(self.depends_model, TYPE_DEP, "Dependencies")
  100. self.dep_treeview.connect("row-activated", self.on_package_activated, COL_DEP_PACKAGE)
  101. scrolled.add(self.dep_treeview)
  102. box.add(scrolled)
  103. pane.add2(box)
  104. # Reverse Task Depends
  105. scrolled = Gtk.ScrolledWindow()
  106. scrolled.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
  107. scrolled.set_shadow_type(Gtk.ShadowType.IN)
  108. self.revdep_treeview = PackageReverseDepView(self.depends_model, "Dependent Tasks")
  109. self.revdep_treeview.connect("row-activated", self.on_package_activated, COL_DEP_PARENT)
  110. scrolled.add(self.revdep_treeview)
  111. box.add(scrolled)
  112. pane.add2(box)
  113. self.show_all()
  114. self.search_entry.grab_focus()
  115. def on_package_activated(self, treeview, path, column, data_col):
  116. model = treeview.get_model()
  117. package = model.get_value(model.get_iter(path), data_col)
  118. pkg_path = []
  119. def finder(model, path, iter, needle):
  120. package = model.get_value(iter, COL_PKG_NAME)
  121. if package == needle:
  122. pkg_path.append(path)
  123. return True
  124. else:
  125. return False
  126. self.pkg_model.foreach(finder, package)
  127. if pkg_path:
  128. self.pkg_treeview.get_selection().select_path(pkg_path[0])
  129. self.pkg_treeview.scroll_to_cell(pkg_path[0])
  130. def on_cursor_changed(self, selection):
  131. (model, it) = selection.get_selected()
  132. if it is None:
  133. current_package = None
  134. else:
  135. current_package = model.get_value(it, COL_PKG_NAME)
  136. self.dep_treeview.set_current_package(current_package)
  137. self.revdep_treeview.set_current_package(current_package)
  138. def parse(self, depgraph):
  139. for task in depgraph["tdepends"]:
  140. self.pkg_model.insert(0, (task,))
  141. for depend in depgraph["tdepends"][task]:
  142. self.depends_model.insert (0, (TYPE_DEP, task, depend))
  143. class gtkthread(threading.Thread):
  144. quit = threading.Event()
  145. def __init__(self, shutdown):
  146. threading.Thread.__init__(self)
  147. self.setDaemon(True)
  148. self.shutdown = shutdown
  149. if not Gtk.init_check()[0]:
  150. sys.stderr.write("Gtk+ init failed. Make sure DISPLAY variable is set.\n")
  151. gtkthread.quit.set()
  152. def run(self):
  153. GObject.threads_init()
  154. Gdk.threads_init()
  155. Gtk.main()
  156. gtkthread.quit.set()
  157. def main(server, eventHandler, params):
  158. shutdown = 0
  159. gtkgui = gtkthread(shutdown)
  160. gtkgui.start()
  161. try:
  162. params.updateFromServer(server)
  163. cmdline = params.parseActions()
  164. if not cmdline:
  165. print("Nothing to do. Use 'bitbake world' to build everything, or run 'bitbake --help' for usage information.")
  166. return 1
  167. if 'msg' in cmdline and cmdline['msg']:
  168. print(cmdline['msg'])
  169. return 1
  170. cmdline = cmdline['action']
  171. if not cmdline or cmdline[0] != "generateDotGraph":
  172. print("This UI requires the -g option")
  173. return 1
  174. ret, error = server.runCommand(["generateDepTreeEvent", cmdline[1], cmdline[2]])
  175. if error:
  176. print("Error running command '%s': %s" % (cmdline, error))
  177. return 1
  178. elif not ret:
  179. print("Error running command '%s': returned %s" % (cmdline, ret))
  180. return 1
  181. except client.Fault as x:
  182. print("XMLRPC Fault getting commandline:\n %s" % x)
  183. return
  184. if gtkthread.quit.isSet():
  185. return
  186. Gdk.threads_enter()
  187. dep = DepExplorer()
  188. bardialog = Gtk.Dialog(parent=dep,
  189. flags=Gtk.DialogFlags.MODAL|Gtk.DialogFlags.DESTROY_WITH_PARENT)
  190. bardialog.set_default_size(400, 50)
  191. box = bardialog.get_content_area()
  192. pbar = Gtk.ProgressBar()
  193. box.pack_start(pbar, True, True, 0)
  194. bardialog.show_all()
  195. bardialog.connect("delete-event", Gtk.main_quit)
  196. Gdk.threads_leave()
  197. progress_total = 0
  198. while True:
  199. try:
  200. event = eventHandler.waitEvent(0.25)
  201. if gtkthread.quit.isSet():
  202. _, error = server.runCommand(["stateForceShutdown"])
  203. if error:
  204. print('Unable to cleanly stop: %s' % error)
  205. break
  206. if event is None:
  207. continue
  208. if isinstance(event, bb.event.CacheLoadStarted):
  209. progress_total = event.total
  210. Gdk.threads_enter()
  211. bardialog.set_title("Loading Cache")
  212. pbar.set_fraction(0.0)
  213. Gdk.threads_leave()
  214. if isinstance(event, bb.event.CacheLoadProgress):
  215. x = event.current
  216. Gdk.threads_enter()
  217. pbar.set_fraction(x * 1.0 / progress_total)
  218. Gdk.threads_leave()
  219. continue
  220. if isinstance(event, bb.event.CacheLoadCompleted):
  221. continue
  222. if isinstance(event, bb.event.ParseStarted):
  223. progress_total = event.total
  224. if progress_total == 0:
  225. continue
  226. Gdk.threads_enter()
  227. pbar.set_fraction(0.0)
  228. bardialog.set_title("Processing recipes")
  229. Gdk.threads_leave()
  230. if isinstance(event, bb.event.ParseProgress):
  231. x = event.current
  232. Gdk.threads_enter()
  233. pbar.set_fraction(x * 1.0 / progress_total)
  234. Gdk.threads_leave()
  235. continue
  236. if isinstance(event, bb.event.ParseCompleted):
  237. Gdk.threads_enter()
  238. bardialog.set_title("Generating dependency tree")
  239. Gdk.threads_leave()
  240. continue
  241. if isinstance(event, bb.event.DepTreeGenerated):
  242. Gdk.threads_enter()
  243. bardialog.hide()
  244. dep.parse(event._depgraph)
  245. Gdk.threads_leave()
  246. if isinstance(event, bb.command.CommandCompleted):
  247. continue
  248. if isinstance(event, bb.event.NoProvider):
  249. print(str(event))
  250. _, error = server.runCommand(["stateShutdown"])
  251. if error:
  252. print('Unable to cleanly shutdown: %s' % error)
  253. break
  254. if isinstance(event, bb.command.CommandFailed):
  255. print(str(event))
  256. return event.exitcode
  257. if isinstance(event, bb.command.CommandExit):
  258. return event.exitcode
  259. if isinstance(event, bb.cooker.CookerExit):
  260. break
  261. continue
  262. except EnvironmentError as ioerror:
  263. # ignore interrupted io
  264. if ioerror.args[0] == 4:
  265. pass
  266. except KeyboardInterrupt:
  267. if shutdown == 2:
  268. print("\nThird Keyboard Interrupt, exit.\n")
  269. break
  270. if shutdown == 1:
  271. print("\nSecond Keyboard Interrupt, stopping...\n")
  272. _, error = server.runCommand(["stateForceShutdown"])
  273. if error:
  274. print('Unable to cleanly stop: %s' % error)
  275. if shutdown == 0:
  276. print("\nKeyboard Interrupt, closing down...\n")
  277. _, error = server.runCommand(["stateShutdown"])
  278. if error:
  279. print('Unable to cleanly shutdown: %s' % error)
  280. shutdown = shutdown + 1
  281. pass