| # |
| # Copyright (C) 2003, 2004 Chris Larson |
| # Copyright (C) 2003, 2004 Phil Blundell |
| # Copyright (C) 2003 - 2005 Michael 'Mickey' Lauer |
| # Copyright (C) 2005 Holger Hans Peter Freyther |
| # Copyright (C) 2005 ROAD GmbH |
| # Copyright (C) 2006 Richard Purdie |
| # |
| # SPDX-License-Identifier: GPL-2.0-only |
| # |
| |
| import logging |
| import os |
| import re |
| import sys |
| import hashlib |
| from functools import wraps |
| import bb |
| from bb import data |
| import bb.parse |
| |
| logger = logging.getLogger("BitBake") |
| parselog = logging.getLogger("BitBake.Parsing") |
| |
| class ConfigParameters(object): |
| def __init__(self, argv=None): |
| self.options, targets = self.parseCommandLine(argv or sys.argv) |
| self.environment = self.parseEnvironment() |
| |
| self.options.pkgs_to_build = targets or [] |
| |
| for key, val in self.options.__dict__.items(): |
| setattr(self, key, val) |
| |
| def parseCommandLine(self, argv=sys.argv): |
| raise Exception("Caller must implement commandline option parsing") |
| |
| def parseEnvironment(self): |
| return os.environ.copy() |
| |
| def updateFromServer(self, server): |
| if not self.options.cmd: |
| defaulttask, error = server.runCommand(["getVariable", "BB_DEFAULT_TASK"]) |
| if error: |
| raise Exception("Unable to get the value of BB_DEFAULT_TASK from the server: %s" % error) |
| self.options.cmd = defaulttask or "build" |
| _, error = server.runCommand(["setConfig", "cmd", self.options.cmd]) |
| if error: |
| raise Exception("Unable to set configuration option 'cmd' on the server: %s" % error) |
| |
| if not self.options.pkgs_to_build: |
| bbpkgs, error = server.runCommand(["getVariable", "BBTARGETS"]) |
| if error: |
| raise Exception("Unable to get the value of BBTARGETS from the server: %s" % error) |
| if bbpkgs: |
| self.options.pkgs_to_build.extend(bbpkgs.split()) |
| |
| def updateToServer(self, server, environment): |
| options = {} |
| for o in ["halt", "force", "invalidate_stamp", |
| "dry_run", "dump_signatures", |
| "extra_assume_provided", "profile", |
| "prefile", "postfile", "server_timeout", |
| "nosetscene", "setsceneonly", "skipsetscene", |
| "runall", "runonly", "writeeventlog"]: |
| options[o] = getattr(self.options, o) |
| |
| options['build_verbose_shell'] = self.options.verbose |
| options['build_verbose_stdout'] = self.options.verbose |
| options['default_loglevel'] = bb.msg.loggerDefaultLogLevel |
| options['debug_domains'] = bb.msg.loggerDefaultDomains |
| |
| ret, error = server.runCommand(["updateConfig", options, environment, sys.argv]) |
| if error: |
| raise Exception("Unable to update the server configuration with local parameters: %s" % error) |
| |
| def parseActions(self): |
| # Parse any commandline into actions |
| action = {'action':None, 'msg':None} |
| if self.options.show_environment: |
| if 'world' in self.options.pkgs_to_build: |
| action['msg'] = "'world' is not a valid target for --environment." |
| elif 'universe' in self.options.pkgs_to_build: |
| action['msg'] = "'universe' is not a valid target for --environment." |
| elif len(self.options.pkgs_to_build) > 1: |
| action['msg'] = "Only one target can be used with the --environment option." |
| elif self.options.buildfile and len(self.options.pkgs_to_build) > 0: |
| action['msg'] = "No target should be used with the --environment and --buildfile options." |
| elif self.options.pkgs_to_build: |
| action['action'] = ["showEnvironmentTarget", self.options.pkgs_to_build] |
| else: |
| action['action'] = ["showEnvironment", self.options.buildfile] |
| elif self.options.buildfile is not None: |
| action['action'] = ["buildFile", self.options.buildfile, self.options.cmd] |
| elif self.options.revisions_changed: |
| action['action'] = ["compareRevisions"] |
| elif self.options.show_versions: |
| action['action'] = ["showVersions"] |
| elif self.options.parse_only: |
| action['action'] = ["parseFiles"] |
| elif self.options.dot_graph: |
| if self.options.pkgs_to_build: |
| action['action'] = ["generateDotGraph", self.options.pkgs_to_build, self.options.cmd] |
| else: |
| action['msg'] = "Please specify a package name for dependency graph generation." |
| else: |
| if self.options.pkgs_to_build: |
| action['action'] = ["buildTargets", self.options.pkgs_to_build, self.options.cmd] |
| else: |
| #action['msg'] = "Nothing to do. Use 'bitbake world' to build everything, or run 'bitbake --help' for usage information." |
| action = None |
| self.options.initialaction = action |
| return action |
| |
| class CookerConfiguration(object): |
| """ |
| Manages build options and configurations for one run |
| """ |
| |
| def __init__(self): |
| self.debug_domains = bb.msg.loggerDefaultDomains |
| self.default_loglevel = bb.msg.loggerDefaultLogLevel |
| self.extra_assume_provided = [] |
| self.prefile = [] |
| self.postfile = [] |
| self.cmd = None |
| self.halt = True |
| self.force = False |
| self.profile = False |
| self.nosetscene = False |
| self.setsceneonly = False |
| self.skipsetscene = False |
| self.invalidate_stamp = False |
| self.dump_signatures = [] |
| self.build_verbose_shell = False |
| self.build_verbose_stdout = False |
| self.dry_run = False |
| self.tracking = False |
| self.writeeventlog = False |
| self.limited_deps = False |
| self.runall = [] |
| self.runonly = [] |
| |
| self.env = {} |
| |
| def __getstate__(self): |
| state = {} |
| for key in self.__dict__.keys(): |
| state[key] = getattr(self, key) |
| return state |
| |
| def __setstate__(self,state): |
| for k in state: |
| setattr(self, k, state[k]) |
| |
| |
| def catch_parse_error(func): |
| """Exception handling bits for our parsing""" |
| @wraps(func) |
| def wrapped(fn, *args): |
| try: |
| return func(fn, *args) |
| except IOError as exc: |
| import traceback |
| parselog.critical(traceback.format_exc()) |
| parselog.critical("Unable to parse %s: %s" % (fn, exc)) |
| raise bb.BBHandledException() |
| except bb.data_smart.ExpansionError as exc: |
| import traceback |
| |
| bbdir = os.path.dirname(__file__) + os.sep |
| exc_class, exc, tb = sys.exc_info() |
| for tb in iter(lambda: tb.tb_next, None): |
| # Skip frames in bitbake itself, we only want the metadata |
| fn, _, _, _ = traceback.extract_tb(tb, 1)[0] |
| if not fn.startswith(bbdir): |
| break |
| parselog.critical("Unable to parse %s" % fn, exc_info=(exc_class, exc, tb)) |
| raise bb.BBHandledException() |
| except bb.parse.ParseError as exc: |
| parselog.critical(str(exc)) |
| raise bb.BBHandledException() |
| return wrapped |
| |
| @catch_parse_error |
| def parse_config_file(fn, data, include=True): |
| return bb.parse.handle(fn, data, include) |
| |
| @catch_parse_error |
| def _inherit(bbclass, data): |
| bb.parse.BBHandler.inherit(bbclass, "configuration INHERITs", 0, data) |
| return data |
| |
| def findConfigFile(configfile, data): |
| search = [] |
| bbpath = data.getVar("BBPATH") |
| if bbpath: |
| for i in bbpath.split(":"): |
| search.append(os.path.join(i, "conf", configfile)) |
| path = os.getcwd() |
| while path != "/": |
| search.append(os.path.join(path, "conf", configfile)) |
| path, _ = os.path.split(path) |
| |
| for i in search: |
| if os.path.exists(i): |
| return i |
| |
| return None |
| |
| # |
| # We search for a conf/bblayers.conf under an entry in BBPATH or in cwd working |
| # up to /. If that fails, bitbake would fall back to cwd. |
| # |
| |
| def findTopdir(): |
| d = bb.data.init() |
| bbpath = None |
| if 'BBPATH' in os.environ: |
| bbpath = os.environ['BBPATH'] |
| d.setVar('BBPATH', bbpath) |
| |
| layerconf = findConfigFile("bblayers.conf", d) |
| if layerconf: |
| return os.path.dirname(os.path.dirname(layerconf)) |
| |
| return os.path.abspath(os.getcwd()) |
| |
| class CookerDataBuilder(object): |
| |
| def __init__(self, cookercfg, worker = False): |
| |
| self.prefiles = cookercfg.prefile |
| self.postfiles = cookercfg.postfile |
| self.tracking = cookercfg.tracking |
| |
| bb.utils.set_context(bb.utils.clean_context()) |
| bb.event.set_class_handlers(bb.event.clean_class_handlers()) |
| self.basedata = bb.data.init() |
| if self.tracking: |
| self.basedata.enableTracking() |
| |
| # Keep a datastore of the initial environment variables and their |
| # values from when BitBake was launched to enable child processes |
| # to use environment variables which have been cleaned from the |
| # BitBake processes env |
| self.savedenv = bb.data.init() |
| for k in cookercfg.env: |
| self.savedenv.setVar(k, cookercfg.env[k]) |
| if k in bb.data_smart.bitbake_renamed_vars: |
| bb.error('Variable %s from the shell environment has been renamed to %s' % (k, bb.data_smart.bitbake_renamed_vars[k])) |
| bb.fatal("Exiting to allow enviroment variables to be corrected") |
| |
| filtered_keys = bb.utils.approved_variables() |
| bb.data.inheritFromOS(self.basedata, self.savedenv, filtered_keys) |
| self.basedata.setVar("BB_ORIGENV", self.savedenv) |
| |
| if worker: |
| self.basedata.setVar("BB_WORKERCONTEXT", "1") |
| |
| self.data = self.basedata |
| self.mcdata = {} |
| |
| def parseBaseConfiguration(self, worker=False): |
| data_hash = hashlib.sha256() |
| try: |
| self.data = self.parseConfigurationFiles(self.prefiles, self.postfiles) |
| |
| if self.data.getVar("BB_WORKERCONTEXT", False) is None and not worker: |
| bb.fetch.fetcher_init(self.data) |
| bb.parse.init_parser(self.data) |
| bb.codeparser.parser_cache_init(self.data) |
| |
| bb.event.fire(bb.event.ConfigParsed(), self.data) |
| |
| reparse_cnt = 0 |
| while self.data.getVar("BB_INVALIDCONF", False) is True: |
| if reparse_cnt > 20: |
| logger.error("Configuration has been re-parsed over 20 times, " |
| "breaking out of the loop...") |
| raise Exception("Too deep config re-parse loop. Check locations where " |
| "BB_INVALIDCONF is being set (ConfigParsed event handlers)") |
| self.data.setVar("BB_INVALIDCONF", False) |
| self.data = self.parseConfigurationFiles(self.prefiles, self.postfiles) |
| reparse_cnt += 1 |
| bb.event.fire(bb.event.ConfigParsed(), self.data) |
| |
| bb.parse.init_parser(self.data) |
| data_hash.update(self.data.get_hash().encode('utf-8')) |
| self.mcdata[''] = self.data |
| |
| multiconfig = (self.data.getVar("BBMULTICONFIG") or "").split() |
| for config in multiconfig: |
| if config[0].isdigit(): |
| bb.fatal("Multiconfig name '%s' is invalid as multiconfigs cannot start with a digit" % config) |
| mcdata = self.parseConfigurationFiles(self.prefiles, self.postfiles, config) |
| bb.event.fire(bb.event.ConfigParsed(), mcdata) |
| self.mcdata[config] = mcdata |
| data_hash.update(mcdata.get_hash().encode('utf-8')) |
| if multiconfig: |
| bb.event.fire(bb.event.MultiConfigParsed(self.mcdata), self.data) |
| |
| self.data_hash = data_hash.hexdigest() |
| except (SyntaxError, bb.BBHandledException): |
| raise bb.BBHandledException() |
| except bb.data_smart.ExpansionError as e: |
| logger.error(str(e)) |
| raise bb.BBHandledException() |
| except Exception: |
| logger.exception("Error parsing configuration files") |
| raise bb.BBHandledException() |
| |
| |
| # Handle obsolete variable names |
| d = self.data |
| renamedvars = d.getVarFlags('BB_RENAMED_VARIABLES') or {} |
| renamedvars.update(bb.data_smart.bitbake_renamed_vars) |
| issues = False |
| for v in renamedvars: |
| if d.getVar(v) != None or d.hasOverrides(v): |
| issues = True |
| loginfo = {} |
| history = d.varhistory.get_variable_refs(v) |
| for h in history: |
| for line in history[h]: |
| loginfo = {'file' : h, 'line' : line} |
| bb.data.data_smart._print_rename_error(v, loginfo, renamedvars) |
| if not history: |
| bb.data.data_smart._print_rename_error(v, loginfo, renamedvars) |
| if issues: |
| raise bb.BBHandledException() |
| |
| # Create a copy so we can reset at a later date when UIs disconnect |
| self.origdata = self.data |
| self.data = bb.data.createCopy(self.origdata) |
| self.mcdata[''] = self.data |
| |
| def reset(self): |
| # We may not have run parseBaseConfiguration() yet |
| if not hasattr(self, 'origdata'): |
| return |
| self.data = bb.data.createCopy(self.origdata) |
| self.mcdata[''] = self.data |
| |
| def _findLayerConf(self, data): |
| return findConfigFile("bblayers.conf", data) |
| |
| def parseConfigurationFiles(self, prefiles, postfiles, mc = "default"): |
| data = bb.data.createCopy(self.basedata) |
| data.setVar("BB_CURRENT_MC", mc) |
| |
| # Parse files for loading *before* bitbake.conf and any includes |
| for f in prefiles: |
| data = parse_config_file(f, data) |
| |
| layerconf = self._findLayerConf(data) |
| if layerconf: |
| parselog.debug(2, "Found bblayers.conf (%s)", layerconf) |
| # By definition bblayers.conf is in conf/ of TOPDIR. |
| # We may have been called with cwd somewhere else so reset TOPDIR |
| data.setVar("TOPDIR", os.path.dirname(os.path.dirname(layerconf))) |
| data = parse_config_file(layerconf, data) |
| |
| layers = (data.getVar('BBLAYERS') or "").split() |
| broken_layers = [] |
| |
| if not layers: |
| bb.fatal("The bblayers.conf file doesn't contain any BBLAYERS definition") |
| |
| data = bb.data.createCopy(data) |
| approved = bb.utils.approved_variables() |
| |
| # Check whether present layer directories exist |
| for layer in layers: |
| if not os.path.isdir(layer): |
| broken_layers.append(layer) |
| |
| if broken_layers: |
| parselog.critical("The following layer directories do not exist:") |
| for layer in broken_layers: |
| parselog.critical(" %s", layer) |
| parselog.critical("Please check BBLAYERS in %s" % (layerconf)) |
| raise bb.BBHandledException() |
| |
| for layer in layers: |
| parselog.debug(2, "Adding layer %s", layer) |
| if 'HOME' in approved and '~' in layer: |
| layer = os.path.expanduser(layer) |
| if layer.endswith('/'): |
| layer = layer.rstrip('/') |
| data.setVar('LAYERDIR', layer) |
| data.setVar('LAYERDIR_RE', re.escape(layer)) |
| data = parse_config_file(os.path.join(layer, "conf", "layer.conf"), data) |
| data.expandVarref('LAYERDIR') |
| data.expandVarref('LAYERDIR_RE') |
| |
| data.delVar('LAYERDIR_RE') |
| data.delVar('LAYERDIR') |
| |
| bbfiles_dynamic = (data.getVar('BBFILES_DYNAMIC') or "").split() |
| collections = (data.getVar('BBFILE_COLLECTIONS') or "").split() |
| invalid = [] |
| for entry in bbfiles_dynamic: |
| parts = entry.split(":", 1) |
| if len(parts) != 2: |
| invalid.append(entry) |
| continue |
| l, f = parts |
| invert = l[0] == "!" |
| if invert: |
| l = l[1:] |
| if (l in collections and not invert) or (l not in collections and invert): |
| data.appendVar("BBFILES", " " + f) |
| if invalid: |
| bb.fatal("BBFILES_DYNAMIC entries must be of the form {!}<collection name>:<filename pattern>, not:\n %s" % "\n ".join(invalid)) |
| |
| layerseries = set((data.getVar("LAYERSERIES_CORENAMES") or "").split()) |
| collections_tmp = collections[:] |
| for c in collections: |
| collections_tmp.remove(c) |
| if c in collections_tmp: |
| bb.fatal("Found duplicated BBFILE_COLLECTIONS '%s', check bblayers.conf or layer.conf to fix it." % c) |
| compat = set((data.getVar("LAYERSERIES_COMPAT_%s" % c) or "").split()) |
| if compat and not layerseries: |
| bb.fatal("No core layer found to work with layer '%s'. Missing entry in bblayers.conf?" % c) |
| if compat and not (compat & layerseries): |
| bb.fatal("Layer %s is not compatible with the core layer which only supports these series: %s (layer is compatible with %s)" |
| % (c, " ".join(layerseries), " ".join(compat))) |
| elif not compat and not data.getVar("BB_WORKERCONTEXT"): |
| bb.warn("Layer %s should set LAYERSERIES_COMPAT_%s in its conf/layer.conf file to list the core layer names it is compatible with." % (c, c)) |
| |
| if not data.getVar("BBPATH"): |
| msg = "The BBPATH variable is not set" |
| if not layerconf: |
| msg += (" and bitbake did not find a conf/bblayers.conf file in" |
| " the expected location.\nMaybe you accidentally" |
| " invoked bitbake from the wrong directory?") |
| raise SystemExit(msg) |
| |
| if not data.getVar("TOPDIR"): |
| data.setVar("TOPDIR", os.path.abspath(os.getcwd())) |
| |
| data = parse_config_file(os.path.join("conf", "bitbake.conf"), data) |
| |
| # Parse files for loading *after* bitbake.conf and any includes |
| for p in postfiles: |
| data = parse_config_file(p, data) |
| |
| # Handle any INHERITs and inherit the base class |
| bbclasses = ["base"] + (data.getVar('INHERIT') or "").split() |
| for bbclass in bbclasses: |
| data = _inherit(bbclass, data) |
| |
| # Normally we only register event handlers at the end of parsing .bb files |
| # We register any handlers we've found so far here... |
| for var in data.getVar('__BBHANDLERS', False) or []: |
| handlerfn = data.getVarFlag(var, "filename", False) |
| if not handlerfn: |
| parselog.critical("Undefined event handler function '%s'" % var) |
| raise bb.BBHandledException() |
| handlerln = int(data.getVarFlag(var, "lineno", False)) |
| bb.event.register(var, data.getVar(var, False), (data.getVarFlag(var, "eventmask") or "").split(), handlerfn, handlerln, data) |
| |
| data.setVar('BBINCLUDED',bb.parse.get_file_depends(data)) |
| |
| return data |
| |