taskexp.py 12 KB

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