1
0
mirror of https://git.yoctoproject.org/poky synced 2026-06-02 01:19:52 +00:00

bitbake: knotty/uihelper: Switch from pids to tids for Task event management

We've seen cases where a task can execute with a given pid, complete
and a new task can start using the same pid before the UI handler has
had time to adapt.

Traceback (most recent call last):
  File "/home/pokybuild/yocto-worker/qemux86-alt/build/bitbake/lib/bb/ui/knotty.py", line 484, in main
    helper.eventHandler(event)
  File "/home/pokybuild/yocto-worker/qemux86-alt/build/bitbake/lib/bb/ui/uihelper.py", line 30, in eventHandler
    del self.running_tasks[event.pid]
KeyError: 13490

This means using pids to match up events on the UI side is a bad
idea. Change the code to use task ids instead. There is a small
amount of fuzzy matching for the progress information since there
is no task information there and we don't want the overhead of a task
ID in every event, however since pid reuse is unlikely, we can live
with a progress bar not quite working properly in a corner case like
this.

[YOCTO #13667]

(Bitbake rev: a109d034cf4fc059fd5a1e1d03246dac65522dd6)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit e427eafa1bb04008d12100ccc5c862122bba53e0)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Richard Purdie
2019-12-03 22:01:25 +00:00
parent afd0025290
commit cbb4636125
3 changed files with 43 additions and 33 deletions
+13 -12
View File
@@ -57,8 +57,9 @@ builtins['os'] = os
class TaskBase(event.Event): class TaskBase(event.Event):
"""Base class for task events""" """Base class for task events"""
def __init__(self, t, logfile, d): def __init__(self, t, fn, logfile, d):
self._task = t self._task = t
self._fn = fn
self._package = d.getVar("PF") self._package = d.getVar("PF")
self._mc = d.getVar("BB_CURRENT_MC") self._mc = d.getVar("BB_CURRENT_MC")
self.taskfile = d.getVar("FILE") self.taskfile = d.getVar("FILE")
@@ -81,8 +82,8 @@ class TaskBase(event.Event):
class TaskStarted(TaskBase): class TaskStarted(TaskBase):
"""Task execution started""" """Task execution started"""
def __init__(self, t, logfile, taskflags, d): def __init__(self, t, fn, logfile, taskflags, d):
super(TaskStarted, self).__init__(t, logfile, d) super(TaskStarted, self).__init__(t, fn, logfile, d)
self.taskflags = taskflags self.taskflags = taskflags
class TaskSucceeded(TaskBase): class TaskSucceeded(TaskBase):
@@ -91,9 +92,9 @@ class TaskSucceeded(TaskBase):
class TaskFailed(TaskBase): class TaskFailed(TaskBase):
"""Task execution failed""" """Task execution failed"""
def __init__(self, task, logfile, metadata, errprinted = False): def __init__(self, task, fn, logfile, metadata, errprinted = False):
self.errprinted = errprinted self.errprinted = errprinted
super(TaskFailed, self).__init__(task, logfile, metadata) super(TaskFailed, self).__init__(task, fn, logfile, metadata)
class TaskFailedSilent(TaskBase): class TaskFailedSilent(TaskBase):
"""Task execution failed (silently)""" """Task execution failed (silently)"""
@@ -103,8 +104,8 @@ class TaskFailedSilent(TaskBase):
class TaskInvalid(TaskBase): class TaskInvalid(TaskBase):
def __init__(self, task, metadata): def __init__(self, task, fn, metadata):
super(TaskInvalid, self).__init__(task, None, metadata) super(TaskInvalid, self).__init__(task, fn, None, metadata)
self._message = "No such task '%s'" % task self._message = "No such task '%s'" % task
class TaskProgress(event.Event): class TaskProgress(event.Event):
@@ -572,7 +573,7 @@ def _exec_task(fn, task, d, quieterr):
try: try:
try: try:
event.fire(TaskStarted(task, logfn, flags, localdata), localdata) event.fire(TaskStarted(task, fn, logfn, flags, localdata), localdata)
except (bb.BBHandledException, SystemExit): except (bb.BBHandledException, SystemExit):
return 1 return 1
@@ -583,15 +584,15 @@ def _exec_task(fn, task, d, quieterr):
for func in (postfuncs or '').split(): for func in (postfuncs or '').split():
exec_func(func, localdata) exec_func(func, localdata)
except bb.BBHandledException: except bb.BBHandledException:
event.fire(TaskFailed(task, logfn, localdata, True), localdata) event.fire(TaskFailed(task, fn, logfn, localdata, True), localdata)
return 1 return 1
except Exception as exc: except Exception as exc:
if quieterr: if quieterr:
event.fire(TaskFailedSilent(task, logfn, localdata), localdata) event.fire(TaskFailedSilent(task, fn, logfn, localdata), localdata)
else: else:
errprinted = errchk.triggered errprinted = errchk.triggered
logger.error(str(exc)) logger.error(str(exc))
event.fire(TaskFailed(task, logfn, localdata, errprinted), localdata) event.fire(TaskFailed(task, fn, logfn, localdata, errprinted), localdata)
return 1 return 1
finally: finally:
sys.stdout.flush() sys.stdout.flush()
@@ -614,7 +615,7 @@ def _exec_task(fn, task, d, quieterr):
logger.debug(2, "Zero size logfn %s, removing", logfn) logger.debug(2, "Zero size logfn %s, removing", logfn)
bb.utils.remove(logfn) bb.utils.remove(logfn)
bb.utils.remove(loglink) bb.utils.remove(loglink)
event.fire(TaskSucceeded(task, logfn, localdata), localdata) event.fire(TaskSucceeded(task, fn, logfn, localdata), localdata)
if not localdata.getVarFlag(task, 'nostamp', False) and not localdata.getVarFlag(task, 'selfstamp', False): if not localdata.getVarFlag(task, 'nostamp', False) and not localdata.getVarFlag(task, 'selfstamp', False):
make_stamp(task, localdata) make_stamp(task, localdata)
+6 -6
View File
@@ -255,19 +255,19 @@ class TerminalFilter(object):
start_time = activetasks[t].get("starttime", None) start_time = activetasks[t].get("starttime", None)
if not pbar or pbar.bouncing != (progress < 0): if not pbar or pbar.bouncing != (progress < 0):
if progress < 0: if progress < 0:
pbar = BBProgress("0: %s (pid %s) " % (activetasks[t]["title"], t), 100, widgets=[progressbar.BouncingSlider(), ''], extrapos=2, resize_handler=self.sigwinch_handle) pbar = BBProgress("0: %s (pid %s) " % (activetasks[t]["title"], activetasks[t]["pid"]), 100, widgets=[progressbar.BouncingSlider(), ''], extrapos=2, resize_handler=self.sigwinch_handle)
pbar.bouncing = True pbar.bouncing = True
else: else:
pbar = BBProgress("0: %s (pid %s) " % (activetasks[t]["title"], t), 100, widgets=[progressbar.Percentage(), ' ', progressbar.Bar(), ''], extrapos=4, resize_handler=self.sigwinch_handle) pbar = BBProgress("0: %s (pid %s) " % (activetasks[t]["title"], activetasks[t]["pid"]), 100, widgets=[progressbar.Percentage(), ' ', progressbar.Bar(), ''], extrapos=4, resize_handler=self.sigwinch_handle)
pbar.bouncing = False pbar.bouncing = False
activetasks[t]["progressbar"] = pbar activetasks[t]["progressbar"] = pbar
tasks.append((pbar, progress, rate, start_time)) tasks.append((pbar, progress, rate, start_time))
else: else:
start_time = activetasks[t].get("starttime", None) start_time = activetasks[t].get("starttime", None)
if start_time: if start_time:
tasks.append("%s - %s (pid %s)" % (activetasks[t]["title"], self.elapsed(currenttime - start_time), t)) tasks.append("%s - %s (pid %s)" % (activetasks[t]["title"], self.elapsed(currenttime - start_time), activetasks[t]["pid"]))
else: else:
tasks.append("%s (pid %s)" % (activetasks[t]["title"], t)) tasks.append("%s (pid %s)" % (activetasks[t]["title"], activetasks[t]["pid"]))
if self.main.shutdown: if self.main.shutdown:
content = "Waiting for %s running tasks to finish:" % len(activetasks) content = "Waiting for %s running tasks to finish:" % len(activetasks)
@@ -517,8 +517,8 @@ def main(server, eventHandler, params, tf = TerminalFilter):
continue continue
# Prefix task messages with recipe/task # Prefix task messages with recipe/task
if event.taskpid in helper.running_tasks and event.levelno != format.PLAIN: if event.taskpid in helper.pidmap and event.levelno != format.PLAIN:
taskinfo = helper.running_tasks[event.taskpid] taskinfo = helper.running_tasks[helper.pidmap[event.taskpid]]
event.msg = taskinfo['title'] + ': ' + event.msg event.msg = taskinfo['title'] + ': ' + event.msg
if hasattr(event, 'fn'): if hasattr(event, 'fn'):
event.msg = event.fn + ': ' + event.msg event.msg = event.fn + ': ' + event.msg
+24 -15
View File
@@ -15,39 +15,48 @@ class BBUIHelper:
# Running PIDs preserves the order tasks were executed in # Running PIDs preserves the order tasks were executed in
self.running_pids = [] self.running_pids = []
self.failed_tasks = [] self.failed_tasks = []
self.pidmap = {}
self.tasknumber_current = 0 self.tasknumber_current = 0
self.tasknumber_total = 0 self.tasknumber_total = 0
def eventHandler(self, event): def eventHandler(self, event):
# PIDs are a bad idea as they can be reused before we process all UI events.
# We maintain a 'fuzzy' match for TaskProgress since there is no other way to match
def removetid(pid, tid):
self.running_pids.remove(tid)
del self.running_tasks[tid]
if self.pidmap[pid] == tid:
del self.pidmap[pid]
self.needUpdate = True
if isinstance(event, bb.build.TaskStarted): if isinstance(event, bb.build.TaskStarted):
tid = event._fn + ":" + event._task
if event._mc != "default": if event._mc != "default":
self.running_tasks[event.pid] = { 'title' : "mc:%s:%s %s" % (event._mc, event._package, event._task), 'starttime' : time.time() } self.running_tasks[tid] = { 'title' : "mc:%s:%s %s" % (event._mc, event._package, event._task), 'starttime' : time.time(), 'pid' : event.pid }
else: else:
self.running_tasks[event.pid] = { 'title' : "%s %s" % (event._package, event._task), 'starttime' : time.time() } self.running_tasks[tid] = { 'title' : "%s %s" % (event._package, event._task), 'starttime' : time.time(), 'pid' : event.pid }
self.running_pids.append(event.pid) self.running_pids.append(tid)
self.pidmap[event.pid] = tid
self.needUpdate = True self.needUpdate = True
elif isinstance(event, bb.build.TaskSucceeded): elif isinstance(event, bb.build.TaskSucceeded):
del self.running_tasks[event.pid] tid = event._fn + ":" + event._task
self.running_pids.remove(event.pid) removetid(event.pid, tid)
self.needUpdate = True
elif isinstance(event, bb.build.TaskFailedSilent): elif isinstance(event, bb.build.TaskFailedSilent):
del self.running_tasks[event.pid] tid = event._fn + ":" + event._task
self.running_pids.remove(event.pid) removetid(event.pid, tid)
# Don't add to the failed tasks list since this is e.g. a setscene task failure # Don't add to the failed tasks list since this is e.g. a setscene task failure
self.needUpdate = True
elif isinstance(event, bb.build.TaskFailed): elif isinstance(event, bb.build.TaskFailed):
del self.running_tasks[event.pid] tid = event._fn + ":" + event._task
self.running_pids.remove(event.pid) removetid(event.pid, tid)
self.failed_tasks.append( { 'title' : "%s %s" % (event._package, event._task)}) self.failed_tasks.append( { 'title' : "%s %s" % (event._package, event._task)})
self.needUpdate = True
elif isinstance(event, bb.runqueue.runQueueTaskStarted): elif isinstance(event, bb.runqueue.runQueueTaskStarted):
self.tasknumber_current = event.stats.completed + event.stats.active + event.stats.failed + 1 self.tasknumber_current = event.stats.completed + event.stats.active + event.stats.failed + 1
self.tasknumber_total = event.stats.total self.tasknumber_total = event.stats.total
self.needUpdate = True self.needUpdate = True
elif isinstance(event, bb.build.TaskProgress): elif isinstance(event, bb.build.TaskProgress):
if event.pid > 0: if event.pid > 0 and event.pid in self.pidmap:
self.running_tasks[event.pid]['progress'] = event.progress self.running_tasks[self.pidmap[event.pid]]['progress'] = event.progress
self.running_tasks[event.pid]['rate'] = event.rate self.running_tasks[self.pidmap[event.pid]]['rate'] = event.rate
self.needUpdate = True self.needUpdate = True
else: else:
return False return False