bin/bitbake: Add better environmental variable handling. By default it will now only...
[bitbake.git] / bin / bitbake
1 #!/usr/bin/env python
2 # ex:ts=4:sw=4:sts=4:et
3 # -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
4 #
5 # Copyright (C) 2003, 2004  Chris Larson
6 # Copyright (C) 2003, 2004  Phil Blundell
7 # Copyright (C) 2003 - 2005 Michael 'Mickey' Lauer
8 # Copyright (C) 2005        Holger Hans Peter Freyther
9 # Copyright (C) 2005        ROAD GmbH
10 # Copyright (C) 2006        Richard Purdie
11 #
12 # This program is free software; you can redistribute it and/or modify
13 # it under the terms of the GNU General Public License version 2 as
14 # published by the Free Software Foundation.
15 #
16 # This program is distributed in the hope that it will be useful,
17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 # GNU General Public License for more details.
20 #
21 # You should have received a copy of the GNU General Public License along
22 # with this program; if not, write to the Free Software Foundation, Inc.,
23 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24
25 import sys, os, getopt, re, time, optparse, xmlrpclib
26 sys.path.insert(0,os.path.join(os.path.dirname(os.path.dirname(sys.argv[0])), 'lib'))
27 import bb
28 from bb import cooker
29 from bb import daemonize
30 from bb import ui
31 from bb.ui import uievent
32
33 __version__ = "1.9.0"
34
35 #============================================================================#
36 # BBOptions
37 #============================================================================#
38 class BBConfiguration( object ):
39     """
40     Manages build options and configurations for one run
41     """
42     def __init__( self, options ):
43         for key, val in options.__dict__.items():
44             setattr( self, key, val )
45
46
47 #============================================================================#
48 # main
49 #============================================================================#
50
51 def main():
52     return_value = 0
53     pythonver = sys.version_info
54     if pythonver[0] < 2 or (pythonver[0] == 2 and pythonver[1] < 5):
55         print "Sorry, bitbake needs python 2.5 or later."
56         sys.exit(1)
57
58     parser = optparse.OptionParser( version = "BitBake Build Tool Core version %s, %%prog version %s" % ( bb.__version__, __version__ ),
59     usage = """%prog [options] [package ...]
60
61 Executes the specified task (default is 'build') for a given set of BitBake files.
62 It expects that BBFILES is defined, which is a space separated list of files to
63 be executed.  BBFILES does support wildcards.
64 Default BBFILES are the .bb files in the current directory.""" )
65
66     parser.add_option( "-b", "--buildfile", help = "execute the task against this .bb file, rather than a package from BBFILES.",
67                action = "store", dest = "buildfile", default = None )
68
69     parser.add_option( "-k", "--continue", help = "continue as much as possible after an error. While the target that failed, and those that depend on it, cannot be remade, the other dependencies of these targets can be processed all the same.",
70                action = "store_false", dest = "abort", default = True )
71
72     parser.add_option( "-f", "--force", help = "force run of specified cmd, regardless of stamp status",
73                action = "store_true", dest = "force", default = False )
74
75     parser.add_option( "-i", "--interactive", help = "drop into the interactive mode also called the BitBake shell.",
76                action = "store_true", dest = "interactive", default = False )
77
78     parser.add_option( "-c", "--cmd", help = "Specify task to execute. Note that this only executes the specified task for the providee and the packages it depends on, i.e. 'compile' does not implicitly call stage for the dependencies (IOW: use only if you know what you are doing). Depending on the base.bbclass a listtasks tasks is defined and will show available tasks",
79                action = "store", dest = "cmd" )
80
81     parser.add_option( "-r", "--read", help = "read the specified file before bitbake.conf",
82                action = "append", dest = "file", default = [] )
83
84     parser.add_option( "-v", "--verbose", help = "output more chit-chat to the terminal",
85                action = "store_true", dest = "verbose", default = False )
86
87     parser.add_option( "-D", "--debug", help = "Increase the debug level. You can specify this more than once.",
88                action = "count", dest="debug", default = 0)
89
90     parser.add_option( "-n", "--dry-run", help = "don't execute, just go through the motions",
91                action = "store_true", dest = "dry_run", default = False )
92
93     parser.add_option( "-p", "--parse-only", help = "quit after parsing the BB files (developers only)",
94                action = "store_true", dest = "parse_only", default = False )
95
96     parser.add_option( "-d", "--disable-psyco", help = "disable using the psyco just-in-time compiler (not recommended)",
97                action = "store_true", dest = "disable_psyco", default = False )
98
99     parser.add_option( "-s", "--show-versions", help = "show current and preferred versions of all packages",
100                action = "store_true", dest = "show_versions", default = False )
101
102     parser.add_option( "-e", "--environment", help = "show the global or per-package environment (this is what used to be bbread)",
103                action = "store_true", dest = "show_environment", default = False )
104
105     parser.add_option( "-g", "--graphviz", help = "emit the dependency trees of the specified packages in the dot syntax",
106                 action = "store_true", dest = "dot_graph", default = False )
107
108     parser.add_option( "-I", "--ignore-deps", help = """Assume these dependencies don't exist and are already provided (equivalent to ASSUME_PROVIDED). Useful to make dependency graphs more appealing""",
109                 action = "append", dest = "extra_assume_provided", default = [] )
110
111     parser.add_option( "-l", "--log-domains", help = """Show debug logging for the specified logging domains""",
112                 action = "append", dest = "debug_domains", default = [] )
113
114     parser.add_option( "-P", "--profile", help = "profile the command and print a report",
115                action = "store_true", dest = "profile", default = False )
116
117     parser.add_option( "-u", "--ui", help = "userinterface to use",
118                action = "store", dest = "ui")
119
120     options, args = parser.parse_args(sys.argv)
121
122     configuration = BBConfiguration(options)
123     configuration.pkgs_to_build = []
124     configuration.pkgs_to_build.extend(args[1:])
125
126
127     # Work out which UI(s) to use
128     curseUI = False
129     depexplorerUI = False
130     if configuration.ui:
131         if configuration.ui == "ncurses":
132             curseUI = True
133         elif configuration.ui == "knotty" or configuration.ui == "tty" or configuration.ui == "file":
134             curseUI = False
135         elif configuration.ui == "depexp":
136             depexplorerUI = True
137         else:
138             print "FATAL: Invalid user interface '%s' specified.\nValid interfaces are 'ncurses', 'depexp' or the default, 'knotty'." % configuration.ui
139             sys.exit(1)
140
141
142     cooker = bb.cooker.BBCooker(configuration)
143
144     # Optionally clean up the environment
145     if 'BB_PRESERVE_ENV' not in os.environ:
146         if 'BB_ENV_WHITELIST' in os.environ:
147             good_vars = os.environ['BB_ENV_WHITELIST'].split()
148         else:
149             good_vars = bb.utils.preserved_envvars_list()
150         if 'BB_ENV_EXTRAWHITE' in os.environ:
151             good_vars.extend(os.environ['BB_ENV_EXTRAWHITE'].split())
152         bb.utils.filter_environment(good_vars)
153
154     cooker.parseConfiguration()
155     host = cooker.server.host
156     port = cooker.server.port
157
158     # Save a logfile for cooker somewhere
159     t = bb.data.getVar('TMPDIR', cooker.configuration.data, True)
160     if not t:
161        bb.msg.fatal(bb.msg.domain.Build, "TMPDIR not set")
162     t = os.path.join(t, "cooker")
163     bb.mkdirhier(t)
164     cooker_logfile = "%s/log.cooker.%s" % (t, str(os.getpid()))
165
166     daemonize.createDaemon(cooker.serve, cooker_logfile)
167     del cooker
168
169     # Setup a connection to the server (cooker)
170     server = xmlrpclib.Server("http://%s:%s" % (host, port),  allow_none=True)
171     # Setup an event receiving queue
172     eventHandler = uievent.BBUIEventQueue(server)
173
174     # Launch the UI
175     try:
176         # Disable UIs that need a terminal
177         if not os.isatty(sys.stdout.fileno()):
178             curseUI = False
179
180         if curseUI:
181             try:
182                 import curses
183             except ImportError, details:
184                 curseUI = False
185
186         if curseUI:
187             from bb.ui import ncurses
188             ncurses.init(server, eventHandler)
189         elif depexplorerUI:
190             from bb.ui import depexplorer
191             depexplorer.init(server, eventHandler)
192         else:
193             from bb.ui import knotty
194             return_value = knotty.init(server, eventHandler)
195
196     finally:
197         # Don't wait for server indefinitely
198         import socket
199         socket.setdefaulttimeout(2) 
200         try:
201             eventHandler.system_quit()
202         except:
203             pass
204         try:
205             server.terminateServer()
206         except:
207             pass
208         return return_value
209
210 if __name__ == "__main__":
211     print """WARNING, WARNING, WARNING
212 This is a Bitbake from the Unstable/Development 1.9 Branch. This software contains gaping security holes and is dangerous to use!
213 You might want to use the bitbake-1.8 stable branch (if you are not a BitBake developer or tester). I'm going to sleep 5 seconds now to make sure you see that."""
214     import time
215     time.sleep(5)
216     ret = main()
217     sys.exit(ret)