2 # ex:ts=4:sw=4:sts=4:et
3 # -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
5 BitBake 'RunQueue' implementation
7 Handles preparation and execution of a queue of tasks
9 Copyright (C) 2006 Richard Purdie
11 This program is free software; you can redistribute it and/or modify it under
12 the terms of the GNU General Public License version 2 as published by the Free
15 This program is distributed in the hope that it will be useful, but WITHOUT
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License along with
22 from bb import msg, data, fetch, event, mkdirhier, utils
26 class TaskFailure(Exception):
27 """Exception raised when a task in a runqueue fails"""
29 def __init__(self, fnid, fn, taskname):
30 self.args = fnid, fn, taskname
34 BitBake Run Queue implementation
39 def reset_runqueue(self):
42 self.runq_depends = []
43 self.runq_revdeps = []
47 def get_user_idstring(self, task, taskData):
48 fn = taskData.fn_index[self.runq_fnid[task]]
49 taskname = self.runq_task[task]
50 return "%s, %s" % (fn, taskname)
52 def prepare_runqueue(self, cfgData, dataCache, taskData, targets):
54 Turn a set of taskData into a RunQueue and compute data needed
55 to optimise the execution order.
56 targets is list of paired values - a provider name and the task to run
64 bb.msg.note(1, bb.msg.domain.RunQueue, "Preparing Runqueue")
66 for task in range(len(taskData.tasks_name)):
67 fnid = taskData.tasks_fnid[task]
68 fn = taskData.fn_index[fnid]
69 task_deps = dataCache.task_deps[fn]
71 if fnid not in taskData.failed_fnids:
73 depends = taskData.tasks_tdepends[task]
76 if 'deptask' in task_deps and taskData.tasks_name[task] in task_deps['deptask']:
77 taskname = task_deps['deptask'][taskData.tasks_name[task]]
78 for depid in taskData.depids[fnid]:
79 if depid in taskData.build_targets:
80 depdata = taskData.build_targets[depid][0]
82 dep = taskData.fn_index[depdata]
83 depends.append(taskData.gettask_id(dep, taskname))
85 # Resolve Runtime Depends
86 if 'rdeptask' in task_deps and taskData.tasks_name[task] in task_deps['rdeptask']:
87 taskname = task_deps['rdeptask'][taskData.tasks_name[task]]
88 for depid in taskData.rdepids[fnid]:
89 if depid in taskData.run_targets:
90 depdata = taskData.run_targets[depid][0]
92 dep = taskData.fn_index[depdata]
93 depends.append(taskData.gettask_id(dep, taskname))
95 def add_recursive_run(rdepid):
97 Add runtime depends of rdepid to depends, if
98 we've not see it before
99 (calls itself recursively)
101 if str(rdepid) in rdep_seen:
103 rdep_seen.append(rdepid)
104 if rdepid in taskData.run_targets:
105 depdata = taskData.run_targets[rdepid][0]
107 dep = taskData.fn_index[depdata]
108 taskid = taskData.gettask_id(dep, taskname)
109 depends.append(taskid)
110 fnid = taskData.tasks_fnid[taskid]
111 for nextdepid in taskData.rdepids[fnid]:
112 if nextdepid not in rdep_seen:
113 add_recursive_run(nextdepid)
115 # Resolve Recursive Runtime Depends
116 if 'recrdeptask' in task_deps and taskData.tasks_name[task] in task_deps['recrdeptask']:
118 taskname = task_deps['recrdeptask'][taskData.tasks_name[task]]
119 for rdepid in taskData.rdepids[fnid]:
120 add_recursive_run(rdepid)
122 #Prune self references
125 bb.msg.debug(2, bb.msg.domain.RunQueue, "Task %s (%s %s) contains self reference! %s" % (task, taskData.fn_index[taskData.tasks_fnid[task]], taskData.tasks_name[task], depends))
132 self.runq_fnid.append(taskData.tasks_fnid[task])
133 self.runq_task.append(taskData.tasks_name[task])
134 self.runq_depends.append(Set(depends))
135 self.runq_revdeps.append(Set())
136 self.runq_weight.append(0)
138 runq_weight1.append(0)
142 bb.msg.note(2, bb.msg.domain.RunQueue, "Marking Active Tasks")
144 def mark_active(listid, depth):
146 Mark an item as active along with its depends
147 (calls itself recursively)
150 if runq_build[listid] == 1:
153 runq_build[listid] = 1
155 depends = self.runq_depends[listid]
156 for depend in depends:
157 mark_active(depend, depth+1)
159 for target in targets:
160 targetid = taskData.getbuild_id(target[0])
161 if targetid in taskData.failed_deps:
164 fnid = taskData.build_targets[targetid][0]
165 if fnid in taskData.failed_fnids:
168 fnids = taskData.matches_in_list(self.runq_fnid, fnid)
169 tasks = taskData.matches_in_list(self.runq_task, target[1])
171 listid = taskData.both_contain(fnids, tasks)
173 mark_active(listid, 1)
175 # Prune inactive tasks
178 for listid in range(len(self.runq_fnid)):
179 if runq_build[listid-delcount] == 1:
180 maps.append(listid-delcount)
182 del self.runq_fnid[listid-delcount]
183 del self.runq_task[listid-delcount]
184 del self.runq_depends[listid-delcount]
185 del self.runq_weight[listid-delcount]
186 del runq_weight1[listid-delcount]
187 del runq_build[listid-delcount]
188 del runq_done[listid-delcount]
189 del self.runq_revdeps[listid-delcount]
190 delcount = delcount + 1
193 bb.msg.note(2, bb.msg.domain.RunQueue, "Pruned %s inactive tasks, %s left" % (delcount, len(self.runq_fnid)))
195 for listid in range(len(self.runq_fnid)):
197 origdeps = self.runq_depends[listid]
198 for origdep in origdeps:
199 if maps[origdep] == -1:
200 bb.msg.fatal(bb.msg.domain.RunQueue, "Invalid mapping - Should never happen!")
201 newdeps.append(maps[origdep])
202 self.runq_depends[listid] = Set(newdeps)
204 bb.msg.note(2, bb.msg.domain.RunQueue, "Assign Weightings")
206 for listid in range(len(self.runq_fnid)):
207 for dep in self.runq_depends[listid]:
208 self.runq_revdeps[dep].add(listid)
211 for listid in range(len(self.runq_fnid)):
212 revdeps = self.runq_revdeps[listid]
213 if len(revdeps) == 0:
214 runq_done[listid] = 1
215 self.runq_weight[listid] = 1
216 endpoints.append(listid)
218 if dep in self.runq_depends[listid]:
219 #self.dump_data(taskData)
220 bb.msg.fatal(bb.msg.domain.RunQueue, "Task %s (%s) has circular dependency on %s (%s)" % (taskData.fn_index[self.runq_fnid[dep]], self.runq_task[dep] , taskData.fn_index[self.runq_fnid[listid]], self.runq_task[listid]))
221 runq_weight1[listid] = len(revdeps)
223 bb.msg.note(2, bb.msg.domain.RunQueue, "Compute totals (have %s endpoint(s))" % len(endpoints))
227 for listid in endpoints:
228 for revdep in self.runq_depends[listid]:
229 self.runq_weight[revdep] = self.runq_weight[revdep] + self.runq_weight[listid]
230 runq_weight1[revdep] = runq_weight1[revdep] - 1
231 if runq_weight1[revdep] == 0:
232 next_points.append(revdep)
233 runq_done[revdep] = 1
234 endpoints = next_points
235 if len(next_points) == 0:
239 for task in range(len(self.runq_fnid)):
240 if runq_done[task] == 0:
242 def print_chain(taskid):
244 for revdep in self.runq_revdeps[taskid]:
245 if runq_done[revdep] == 0:
246 bb.msg.error(bb.msg.domain.RunQueue, "Task %s (%s) (depends: %s)" % (revdep, self.get_user_idstring(revdep, taskData), self.runq_depends[revdep]))
247 if revdep not in seen:
250 bb.msg.fatal(bb.msg.domain.RunQueue, "Task %s (%s) not processed!\nThis is probably a circular dependency (the chain might be printed above)." % (task, self.get_user_idstring(task, taskData)))
251 if runq_weight1[task] != 0:
252 bb.msg.fatal(bb.msg.domain.RunQueue, "Task %s (%s) count not zero!" % (task, self.get_user_idstring(task, taskData)))
254 # Make a weight sorted map
255 from copy import deepcopy
257 sortweight = deepcopy(self.runq_weight)
259 copyweight = deepcopy(self.runq_weight)
262 for weight in sortweight:
263 idx = copyweight.index(weight)
264 self.prio_map.append(idx)
266 self.prio_map.reverse()
268 def execute_runqueue(self, cooker, cfgData, dataCache, taskData, runlist):
270 Run the tasks in a queue prepared by prepare_runqueue
271 Upon failure, optionally try to recover the build using any alternate providers
272 (if the abort on failure configuration option isn't set)
278 self.execute_runqueue_internal(cooker, cfgData, dataCache, taskData)
280 except bb.runqueue.TaskFailure, (fnid, taskData.fn_index[fnid], taskname):
283 taskData.fail_fnid(fnid)
284 self.reset_runqueue()
285 self.prepare_runqueue(cfgData, dataCache, taskData, runlist)
286 failures = failures + 1
288 def execute_runqueue_internal(self, cooker, cfgData, dataCache, taskData):
290 Run the tasks in a queue prepared by prepare_runqueue
293 bb.msg.note(1, bb.msg.domain.RunQueue, "Executing runqueue")
301 def get_next_task(data):
303 Return the id of the highest priority task that is buildable
305 for task1 in range(len(data.runq_fnid)):
306 task = data.prio_map[task1]
307 if runq_running[task] == 1:
309 if runq_buildable[task] == 1:
313 def task_complete(data, task):
315 Mark a task as completed
316 Look at the reverse dependencies and mark any task with
317 completed dependencies as buildable
319 runq_complete[task] = 1
320 for revdep in data.runq_revdeps[task]:
321 if runq_running[revdep] == 1:
323 if runq_buildable[revdep] == 1:
326 for dep in data.runq_depends[revdep]:
327 if runq_complete[dep] != 1:
330 runq_buildable[revdep] = 1
331 fn = taskData.fn_index[self.runq_fnid[revdep]]
332 taskname = self.runq_task[revdep]
333 bb.msg.debug(1, bb.msg.domain.RunQueue, "Marking task %s (%s, %s) as buildable" % (revdep, fn, taskname))
335 # Mark initial buildable tasks
336 for task in range(len(self.runq_fnid)):
337 runq_running.append(0)
338 runq_complete.append(0)
339 if len(self.runq_depends[task]) == 0:
340 runq_buildable.append(1)
342 runq_buildable.append(0)
345 number_tasks = int(bb.data.getVar("BB_NUMBER_THREADS", cfgData) or 1)
349 task = get_next_task(self)
351 fn = taskData.fn_index[self.runq_fnid[task]]
352 taskname = self.runq_task[task]
354 if bb.build.stamp_is_current_cache(dataCache, fn, taskname):
355 targetid = taskData.gettask_id(fn, taskname)
356 if not (targetid in taskData.external_targets and cooker.configuration.force):
357 bb.msg.debug(2, bb.msg.domain.RunQueue, "Stamp current task %s (%s)" % (task, self.get_user_idstring(task, taskData)))
358 runq_running[task] = 1
359 task_complete(self, task)
362 bb.msg.debug(1, bb.msg.domain.RunQueue, "Running task %s (%s)" % (task, self.get_user_idstring(task, taskData)))
366 bb.msg.fatal(bb.msg.domain.RunQueue, "fork failed: %d (%s)" % (e.errno, e.strerror))
368 cooker.configuration.cmd = taskname[3:]
370 cooker.tryBuild(fn, False)
372 bb.msg.error(bb.msg.domain.Build, "Build of " + fn + " " + taskname + " failed")
375 build_pids[pid] = task
376 runq_running[task] = 1
377 active_builds = active_builds + 1
378 if active_builds < number_tasks:
380 if active_builds > 0:
381 result = os.waitpid(-1, 0)
382 active_builds = active_builds - 1
384 bb.msg.error(bb.msg.domain.RunQueue, "Task %s (%s) failed" % (build_pids[result[0]], self.get_user_idstring(build_pids[result[0]], taskData)))
385 raise bb.runqueue.TaskFailure(self.runq_fnid[build_pids[result[0]]], taskData.fn_index[self.runq_fnid[build_pids[result[0]]]], self.runq_task[build_pids[result[0]]])
386 task_complete(self, build_pids[result[0]])
387 del build_pids[result[0]]
393 bb.msg.error(bb.msg.domain.RunQueue, "Exception received")
394 if active_builds > 0:
395 while active_builds > 0:
396 bb.msg.note(1, bb.msg.domain.RunQueue, "Waiting for %s active tasks to finish" % active_builds)
398 for k, v in build_pids.iteritems():
399 bb.msg.note(1, bb.msg.domain.RunQueue, "%s: %s (%s)" % (tasknum, self.get_user_idstring(v, taskData), k))
400 tasknum = tasknum + 1
401 result = os.waitpid(-1, 0)
402 del build_pids[result[0]]
403 active_builds = active_builds - 1
407 for task in range(len(self.runq_fnid)):
408 if runq_buildable[task] == 0:
409 bb.msg.error(bb.msg.domain.RunQueue, "Task %s never buildable!" % task)
410 if runq_running[task] == 0:
411 bb.msg.error(bb.msg.domain.RunQueue, "Task %s never ran!" % task)
412 if runq_complete[task] == 0:
413 bb.msg.error(bb.msg.domain.RunQueue, "Task %s never completed!" % task)
417 def dump_data(self, taskQueue):
419 Dump some debug information on the internal data structures
421 bb.msg.debug(3, bb.msg.domain.RunQueue, "run_tasks:")
422 for task in range(len(self.runq_fnid)):
423 bb.msg.debug(3, bb.msg.domain.RunQueue, " (%s)%s - %s: %s Deps %s RevDeps %s" % (task,
424 taskQueue.fn_index[self.runq_fnid[task]],
425 self.runq_task[task],
426 self.runq_weight[task],
427 self.runq_depends[task],
428 self.runq_revdeps[task]))
430 bb.msg.debug(3, bb.msg.domain.RunQueue, "sorted_tasks:")
431 for task1 in range(len(self.runq_fnid)):
432 if task1 in self.prio_map:
433 task = self.prio_map[task1]
434 bb.msg.debug(3, bb.msg.domain.RunQueue, " (%s)%s - %s: %s Deps %s RevDeps %s" % (task,
435 taskQueue.fn_index[self.runq_fnid[task]],
436 self.runq_task[task],
437 self.runq_weight[task],
438 self.runq_depends[task],
439 self.runq_revdeps[task]))