build.py: Add support for cleaning directories before a task in the form: do_taskname...
[bitbake.git] / lib / bb / build.py
1 # ex:ts=4:sw=4:sts=4:et
2 # -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
3 #
4 # BitBake 'Build' implementation
5 #
6 # Core code for function execution and task handling in the
7 # BitBake build tools.
8 #
9 # Copyright (C) 2003, 2004  Chris Larson
10 #
11 # Based on Gentoo's portage.py.
12 #
13 # This program is free software; you can redistribute it and/or modify
14 # it under the terms of the GNU General Public License version 2 as
15 # published by the Free Software Foundation.
16 #
17 # This program is distributed in the hope that it will be useful,
18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 # GNU General Public License for more details.
21 #
22 # You should have received a copy of the GNU General Public License along
23 # with this program; if not, write to the Free Software Foundation, Inc.,
24 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #
26 #Based on functions from the base bb module, Copyright 2003 Holger Schurig
27
28 from bb import data, fetch, event, mkdirhier, utils
29 import bb, os
30
31 # events
32 class FuncFailed(Exception):
33     """Executed function failed"""
34
35 class EventException(Exception):
36     """Exception which is associated with an Event."""
37
38     def __init__(self, msg, event):
39         self.args = msg, event
40
41 class TaskBase(event.Event):
42     """Base class for task events"""
43
44     def __init__(self, t, d ):
45         self._task = t
46         event.Event.__init__(self, d)
47
48     def getTask(self):
49         return self._task
50
51     def setTask(self, task):
52         self._task = task
53
54     task = property(getTask, setTask, None, "task property")
55
56 class TaskStarted(TaskBase):
57     """Task execution started"""
58
59 class TaskSucceeded(TaskBase):
60     """Task execution completed"""
61
62 class TaskFailed(TaskBase):
63     """Task execution failed"""
64
65 class InvalidTask(TaskBase):
66     """Invalid Task"""
67
68 # functions
69
70 def exec_func(func, d, dirs = None):
71     """Execute an BB 'function'"""
72
73     body = data.getVar(func, d)
74     if not body:
75         return
76
77     cleandirs = (data.expand(data.getVarFlag(func, 'cleandirs', d), d) or "").split()
78     for cdir in cleandirs:
79         os.system("rm -rf %s" % cdir)
80
81     if not dirs:
82         dirs = (data.expand(data.getVarFlag(func, 'dirs', d), d) or "").split()
83     for adir in dirs:
84         mkdirhier(adir)
85
86     if len(dirs) > 0:
87         adir = dirs[-1]
88     else:
89         adir = data.getVar('B', d, 1)
90
91     adir = data.expand(adir, d)
92
93     try:
94         prevdir = os.getcwd()
95     except OSError:
96         prevdir = data.expand('${TOPDIR}', d)
97     if adir and os.access(adir, os.F_OK):
98         os.chdir(adir)
99
100     if data.getVarFlag(func, "python", d):
101         exec_func_python(func, d)
102     else:
103         exec_func_shell(func, d)
104
105     if os.path.exists(prevdir):
106         os.chdir(prevdir)
107
108 def exec_func_python(func, d):
109     """Execute a python BB 'function'"""
110     import re, os
111
112     tmp  = "def " + func + "():\n%s" % data.getVar(func, d)
113     tmp += '\n' + func + '()'
114     comp = utils.better_compile(tmp, func, bb.data.getVar('FILE', d, 1) )
115     prevdir = os.getcwd()
116     g = {} # globals
117     g['bb'] = bb
118     g['os'] = os
119     g['d'] = d
120     utils.better_exec(comp,g,tmp, bb.data.getVar('FILE',d,1))
121     if os.path.exists(prevdir):
122         os.chdir(prevdir)
123
124 def exec_func_shell(func, d):
125     """Execute a shell BB 'function' Returns true if execution was successful.
126
127     For this, it creates a bash shell script in the tmp dectory, writes the local
128     data into it and finally executes. The output of the shell will end in a log file and stdout.
129
130     Note on directory behavior.  The 'dirs' varflag should contain a list
131     of the directories you need created prior to execution.  The last
132     item in the list is where we will chdir/cd to.
133     """
134     import sys
135
136     deps = data.getVarFlag(func, 'deps', d)
137     check = data.getVarFlag(func, 'check', d)
138     interact = data.getVarFlag(func, 'interactive', d)
139     if check in globals():
140         if globals()[check](func, deps):
141             return
142
143     global logfile
144     t = data.getVar('T', d, 1)
145     if not t:
146         return 0
147     mkdirhier(t)
148     logfile = "%s/log.%s.%s" % (t, func, str(os.getpid()))
149     runfile = "%s/run.%s.%s" % (t, func, str(os.getpid()))
150
151     f = open(runfile, "w")
152     f.write("#!/bin/sh -e\n")
153     if bb.msg.debug_level['default'] > 0: f.write("set -x\n")
154     data.emit_env(f, d)
155
156     f.write("cd %s\n" % os.getcwd())
157     if func: f.write("%s\n" % func)
158     f.close()
159     os.chmod(runfile, 0775)
160     if not func:
161         bb.msg.error(bb.msg.domain.Build, "Function not specified")
162         raise FuncFailed()
163
164     # open logs
165     si = file('/dev/null', 'r')
166     try:
167         if bb.msg.debug_level['default'] > 0:
168             so = os.popen("tee \"%s\"" % logfile, "w")
169         else:
170             so = file(logfile, 'w')
171     except OSError, e:
172         bb.msg.error(bb.msg.domain.Build, "opening log file: %s" % e)
173         pass
174
175     se = so
176
177     if not interact:
178         # dup the existing fds so we dont lose them
179         osi = [os.dup(sys.stdin.fileno()), sys.stdin.fileno()]
180         oso = [os.dup(sys.stdout.fileno()), sys.stdout.fileno()]
181         ose = [os.dup(sys.stderr.fileno()), sys.stderr.fileno()]
182
183         # replace those fds with our own
184         os.dup2(si.fileno(), osi[1])
185         os.dup2(so.fileno(), oso[1])
186         os.dup2(se.fileno(), ose[1])
187
188     # execute function
189     prevdir = os.getcwd()
190     if data.getVarFlag(func, "fakeroot", d):
191         maybe_fakeroot = "PATH=\"%s\" fakeroot " % bb.data.getVar("PATH", d, 1)
192     else:
193         maybe_fakeroot = ''
194     lang_environment = "LC_ALL=C "
195     ret = os.system('%s%ssh -e %s' % (lang_environment, maybe_fakeroot, runfile))
196     try:
197         os.chdir(prevdir)
198     except:
199         pass
200
201     if not interact:
202         # restore the backups
203         os.dup2(osi[0], osi[1])
204         os.dup2(oso[0], oso[1])
205         os.dup2(ose[0], ose[1])
206
207         # close our logs
208         si.close()
209         so.close()
210         se.close()
211
212         # close the backup fds
213         os.close(osi[0])
214         os.close(oso[0])
215         os.close(ose[0])
216
217     if ret==0:
218         if bb.msg.debug_level['default'] > 0:
219             os.remove(runfile)
220 #            os.remove(logfile)
221         return
222     else:
223         bb.msg.error(bb.msg.domain.Build, "function %s failed" % func)
224         if data.getVar("BBINCLUDELOGS", d):
225             bb.msg.error(bb.msg.domain.Build, "log data follows (%s)" % logfile)
226             number_of_lines = data.getVar("BBINCLUDELOGS_LINES", d)
227             if number_of_lines:
228                 os.system('tail -n%s %s' % (number_of_lines, logfile))
229             else:
230                 f = open(logfile, "r")
231                 while True:
232                     l = f.readline()
233                     if l == '':
234                         break
235                     l = l.rstrip()
236                     print '| %s' % l
237                 f.close()
238         else:
239             bb.msg.error(bb.msg.domain.Build, "see log in %s" % logfile)
240         raise FuncFailed( logfile )
241
242
243 def exec_task(task, d):
244     """Execute an BB 'task'
245
246        The primary difference between executing a task versus executing
247        a function is that a task exists in the task digraph, and therefore
248        has dependencies amongst other tasks."""
249
250     # check if the task is in the graph..
251     task_graph = data.getVar('_task_graph', d)
252     if not task_graph:
253         task_graph = bb.digraph()
254         data.setVar('_task_graph', task_graph, d)
255     task_cache = data.getVar('_task_cache', d)
256     if not task_cache:
257         task_cache = []
258         data.setVar('_task_cache', task_cache, d)
259     if not task_graph.hasnode(task):
260         raise EventException("Missing node in task graph", InvalidTask(task, d))
261
262     # check whether this task needs executing..
263     if stamp_is_current(task, d):
264         return 1
265
266     # follow digraph path up, then execute our way back down
267     def execute(graph, item):
268         if data.getVarFlag(item, 'task', d):
269             if item in task_cache:
270                 return 1
271
272             if task != item:
273                 # deeper than toplevel, exec w/ deps
274                 exec_task(item, d)
275                 return 1
276
277             try:
278                 bb.msg.debug(1, bb.msg.domain.Build, "Executing task %s" % item)
279                 old_overrides = data.getVar('OVERRIDES', d, 0)
280                 localdata = data.createCopy(d)
281                 data.setVar('OVERRIDES', 'task_%s:%s' % (item, old_overrides), localdata)
282                 data.update_data(localdata)
283                 event.fire(TaskStarted(item, localdata))
284                 exec_func(item, localdata)
285                 event.fire(TaskSucceeded(item, localdata))
286                 task_cache.append(item)
287                 data.setVar('_task_cache', task_cache, d)
288             except FuncFailed, reason:
289                 bb.msg.note(1, bb.msg.domain.Build, "Task failed: %s" % reason )
290                 failedevent = TaskFailed(item, d)
291                 event.fire(failedevent)
292                 raise EventException("Function failed in task: %s" % reason, failedevent)
293
294     if data.getVarFlag(task, 'dontrundeps', d):
295         execute(None, task)
296     else:
297         task_graph.walkdown(task, execute)
298
299     # make stamp, or cause event and raise exception
300     if not data.getVarFlag(task, 'nostamp', d):
301         make_stamp(task, d)
302
303 def extract_stamp_data(d, fn):
304     """
305     Extracts stamp data from d which is either a data dictonary (fn unset) 
306     or a dataCache entry (fn set). 
307     """
308     if fn:
309         return (d.task_queues[fn], d.stamp[fn], d.task_deps[fn])
310     task_graph = data.getVar('_task_graph', d)
311     if not task_graph:
312         task_graph = bb.digraph()
313         data.setVar('_task_graph', task_graph, d)
314     return (task_graph, data.getVar('STAMP', d, 1), None)
315
316 def extract_stamp(d, fn):
317     """
318     Extracts stamp format which is either a data dictonary (fn unset) 
319     or a dataCache entry (fn set). 
320     """
321     if fn:
322         return d.stamp[fn]
323     return data.getVar('STAMP', d, 1)
324
325 def stamp_is_current(task, d, file_name = None, checkdeps = 1):
326     """
327     Check status of a given task's stamp. 
328     Returns 0 if it is not current and needs updating.
329     (d can be a data dict or dataCache)
330     """
331
332     (task_graph, stampfn, taskdep) = extract_stamp_data(d, file_name)
333
334     if not stampfn:
335         return 0
336
337     stampfile = "%s.%s" % (stampfn, task)
338     if not os.access(stampfile, os.F_OK):
339         return 0
340
341     if checkdeps == 0:
342         return 1
343
344     import stat
345     tasktime = os.stat(stampfile)[stat.ST_MTIME]
346
347     _deps = []
348     def checkStamp(graph, task):
349         # check for existance
350         if file_name:
351             if 'nostamp' in taskdep and task in taskdep['nostamp']:
352                 return 1
353         else:
354             if data.getVarFlag(task, 'nostamp', d):
355                 return 1
356
357         if not stamp_is_current(task, d, file_name, 0                                           ):
358             return 0
359
360         depfile = "%s.%s" % (stampfn, task)
361         deptime = os.stat(depfile)[stat.ST_MTIME]
362         if deptime > tasktime:
363             return 0
364         return 1
365
366     return task_graph.walkdown(task, checkStamp)
367
368 def stamp_internal(task, d, file_name):
369     """
370     Internal stamp helper function
371     Removes any stamp for the given task
372     Makes sure the stamp directory exists
373     Returns the stamp path+filename
374     """
375     stamp = extract_stamp(d, file_name)
376     if not stamp:
377         return
378     stamp = "%s.%s" % (stamp, task)
379     mkdirhier(os.path.dirname(stamp))
380     # Remove the file and recreate to force timestamp
381     # change on broken NFS filesystems
382     if os.access(stamp, os.F_OK):
383         os.remove(stamp)
384     return stamp
385
386 def make_stamp(task, d, file_name = None):
387     """
388     Creates/updates a stamp for a given task
389     (d can be a data dict or dataCache)
390     """
391     stamp = stamp_internal(task, d, file_name)
392     if stamp:
393         f = open(stamp, "w")
394         f.close()
395
396 def del_stamp(task, d, file_name = None):
397     """
398     Removes a stamp for a given task
399     (d can be a data dict or dataCache)
400     """
401     stamp_internal(task, d, file_name)
402
403 def add_tasks(tasklist, d):
404     task_graph = data.getVar('_task_graph', d)
405     task_deps = data.getVar('_task_deps', d)
406     if not task_graph:
407         task_graph = bb.digraph()
408     if not task_deps:
409         task_deps = {}
410
411     for task in tasklist:
412         deps = tasklist[task]
413         task = data.expand(task, d)
414
415         data.setVarFlag(task, 'task', 1, d)
416         task_graph.addnode(task, None)
417         for dep in deps:
418             dep = data.expand(dep, d)
419             if not task_graph.hasnode(dep):
420                 task_graph.addnode(dep, None)
421             task_graph.addnode(task, dep)
422
423         flags = data.getVarFlags(task, d)    
424         def getTask(name):
425             if name in flags:
426                 deptask = data.expand(flags[name], d)
427                 if not name in task_deps:
428                     task_deps[name] = {}
429                 task_deps[name][task] = deptask
430         getTask('depends')
431         getTask('deptask')
432         getTask('rdeptask')
433         getTask('recrdeptask')
434         getTask('nostamp')
435
436     # don't assume holding a reference
437     data.setVar('_task_graph', task_graph, d)
438     data.setVar('_task_deps', task_deps, d)
439
440 def remove_task(task, kill, d):
441     """Remove an BB 'task'.
442
443        If kill is 1, also remove tasks that depend on this task."""
444
445     task_graph = data.getVar('_task_graph', d)
446     if not task_graph:
447         task_graph = bb.digraph()
448     if not task_graph.hasnode(task):
449         return
450
451     data.delVarFlag(task, 'task', d)
452     ref = 1
453     if kill == 1:
454         ref = 2
455     task_graph.delnode(task, ref)
456     data.setVar('_task_graph', task_graph, d)
457
458 def task_exists(task, d):
459     task_graph = data.getVar('_task_graph', d)
460     if not task_graph:
461         task_graph = bb.digraph()
462         data.setVar('_task_graph', task_graph, d)
463     return task_graph.hasnode(task)