462 lines
12 KiB
Python
462 lines
12 KiB
Python
# ex:ts=4:sw=4:sts=4:et
|
|
# -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
|
|
"""
|
|
BitBake 'Event' implementation
|
|
|
|
Classes and functions for manipulating 'events' in the
|
|
BitBake build tools.
|
|
"""
|
|
|
|
# Copyright (C) 2003, 2004 Chris Larson
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License version 2 as
|
|
# published by the Free Software Foundation.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License along
|
|
# with this program; if not, write to the Free Software Foundation, Inc.,
|
|
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
|
import os, sys
|
|
import warnings
|
|
try:
|
|
import cPickle as pickle
|
|
except ImportError:
|
|
import pickle
|
|
import logging
|
|
import atexit
|
|
import traceback
|
|
import bb.utils
|
|
|
|
# This is the pid for which we should generate the event. This is set when
|
|
# the runqueue forks off.
|
|
worker_pid = 0
|
|
worker_pipe = None
|
|
|
|
logger = logging.getLogger('BitBake.Event')
|
|
|
|
class Event(object):
|
|
"""Base class for events"""
|
|
|
|
def __init__(self):
|
|
self.pid = worker_pid
|
|
|
|
NotHandled = 0
|
|
Handled = 1
|
|
|
|
Registered = 10
|
|
AlreadyRegistered = 14
|
|
|
|
# Internal
|
|
_handlers = {}
|
|
_ui_handlers = {}
|
|
_ui_handler_seq = 0
|
|
|
|
# For compatibility
|
|
bb.utils._context["NotHandled"] = NotHandled
|
|
bb.utils._context["Handled"] = Handled
|
|
|
|
def execute_handler(name, handler, event, d):
|
|
event.data = d
|
|
try:
|
|
ret = handler(event)
|
|
except bb.parse.SkipPackage:
|
|
raise
|
|
except Exception:
|
|
etype, value, tb = sys.exc_info()
|
|
logger.error("Execution of event handler '%s' failed" % name,
|
|
exc_info=(etype, value, tb.tb_next))
|
|
raise
|
|
except SystemExit as exc:
|
|
if exc.code != 0:
|
|
logger.error("Execution of event handler '%s' failed" % name)
|
|
raise
|
|
finally:
|
|
del event.data
|
|
|
|
if ret is not None:
|
|
warnings.warn("Using Handled/NotHandled in event handlers is deprecated",
|
|
DeprecationWarning, stacklevel = 2)
|
|
|
|
def fire_class_handlers(event, d):
|
|
if isinstance(event, logging.LogRecord):
|
|
return
|
|
|
|
for name, handler in _handlers.iteritems():
|
|
try:
|
|
execute_handler(name, handler, event, d)
|
|
except Exception:
|
|
continue
|
|
|
|
ui_queue = []
|
|
@atexit.register
|
|
def print_ui_queue():
|
|
"""If we're exiting before a UI has been spawned, display any queued
|
|
LogRecords to the console."""
|
|
logger = logging.getLogger("BitBake")
|
|
if not _ui_handlers:
|
|
from bb.msg import BBLogFormatter
|
|
console = logging.StreamHandler(sys.stdout)
|
|
console.setFormatter(BBLogFormatter("%(levelname)s: %(message)s"))
|
|
logger.handlers = [console]
|
|
for event in ui_queue:
|
|
if isinstance(event, logging.LogRecord):
|
|
logger.handle(event)
|
|
|
|
def fire_ui_handlers(event, d):
|
|
if not _ui_handlers:
|
|
# No UI handlers registered yet, queue up the messages
|
|
ui_queue.append(event)
|
|
return
|
|
|
|
errors = []
|
|
for h in _ui_handlers:
|
|
#print "Sending event %s" % event
|
|
try:
|
|
# We use pickle here since it better handles object instances
|
|
# which xmlrpc's marshaller does not. Events *must* be serializable
|
|
# by pickle.
|
|
if hasattr(_ui_handlers[h].event, "sendpickle"):
|
|
_ui_handlers[h].event.sendpickle((pickle.dumps(event)))
|
|
else:
|
|
_ui_handlers[h].event.send(event)
|
|
except:
|
|
errors.append(h)
|
|
for h in errors:
|
|
del _ui_handlers[h]
|
|
|
|
def fire(event, d):
|
|
"""Fire off an Event"""
|
|
|
|
# We can fire class handlers in the worker process context and this is
|
|
# desired so they get the task based datastore.
|
|
# UI handlers need to be fired in the server context so we defer this. They
|
|
# don't have a datastore so the datastore context isn't a problem.
|
|
|
|
fire_class_handlers(event, d)
|
|
if worker_pid != 0:
|
|
worker_fire(event, d)
|
|
else:
|
|
fire_ui_handlers(event, d)
|
|
|
|
def worker_fire(event, d):
|
|
data = "<event>" + pickle.dumps(event) + "</event>"
|
|
worker_pipe.write(data)
|
|
|
|
def fire_from_worker(event, d):
|
|
if not event.startswith("<event>") or not event.endswith("</event>"):
|
|
print("Error, not an event %s" % event)
|
|
return
|
|
event = pickle.loads(event[7:-8])
|
|
fire_ui_handlers(event, d)
|
|
|
|
noop = lambda _: None
|
|
def register(name, handler):
|
|
"""Register an Event handler"""
|
|
|
|
# already registered
|
|
if name in _handlers:
|
|
return AlreadyRegistered
|
|
|
|
if handler is not None:
|
|
# handle string containing python code
|
|
if isinstance(handler, basestring):
|
|
tmp = "def %s(e):\n%s" % (name, handler)
|
|
try:
|
|
code = compile(tmp, "%s(e)" % name, "exec")
|
|
except SyntaxError:
|
|
logger.error("Unable to register event handler '%s':\n%s", name,
|
|
''.join(traceback.format_exc(limit=0)))
|
|
_handlers[name] = noop
|
|
return
|
|
env = {}
|
|
bb.utils.simple_exec(code, env)
|
|
func = bb.utils.better_eval(name, env)
|
|
_handlers[name] = func
|
|
else:
|
|
_handlers[name] = handler
|
|
|
|
return Registered
|
|
|
|
def remove(name, handler):
|
|
"""Remove an Event handler"""
|
|
_handlers.pop(name)
|
|
|
|
def register_UIHhandler(handler):
|
|
bb.event._ui_handler_seq = bb.event._ui_handler_seq + 1
|
|
_ui_handlers[_ui_handler_seq] = handler
|
|
return _ui_handler_seq
|
|
|
|
def unregister_UIHhandler(handlerNum):
|
|
if handlerNum in _ui_handlers:
|
|
del _ui_handlers[handlerNum]
|
|
return
|
|
|
|
def getName(e):
|
|
"""Returns the name of a class or class instance"""
|
|
if getattr(e, "__name__", None) == None:
|
|
return e.__class__.__name__
|
|
else:
|
|
return e.__name__
|
|
|
|
class ConfigParsed(Event):
|
|
"""Configuration Parsing Complete"""
|
|
|
|
class RecipeEvent(Event):
|
|
def __init__(self, fn):
|
|
self.fn = fn
|
|
Event.__init__(self)
|
|
|
|
class RecipePreFinalise(RecipeEvent):
|
|
""" Recipe Parsing Complete but not yet finialised"""
|
|
|
|
class RecipeParsed(RecipeEvent):
|
|
""" Recipe Parsing Complete """
|
|
|
|
class StampUpdate(Event):
|
|
"""Trigger for any adjustment of the stamp files to happen"""
|
|
|
|
def __init__(self, targets, stampfns):
|
|
self._targets = targets
|
|
self._stampfns = stampfns
|
|
Event.__init__(self)
|
|
|
|
def getStampPrefix(self):
|
|
return self._stampfns
|
|
|
|
def getTargets(self):
|
|
return self._targets
|
|
|
|
stampPrefix = property(getStampPrefix)
|
|
targets = property(getTargets)
|
|
|
|
class BuildBase(Event):
|
|
"""Base class for bbmake run events"""
|
|
|
|
def __init__(self, n, p, failures = 0):
|
|
self._name = n
|
|
self._pkgs = p
|
|
Event.__init__(self)
|
|
self._failures = failures
|
|
|
|
def getPkgs(self):
|
|
return self._pkgs
|
|
|
|
def setPkgs(self, pkgs):
|
|
self._pkgs = pkgs
|
|
|
|
def getName(self):
|
|
return self._name
|
|
|
|
def setName(self, name):
|
|
self._name = name
|
|
|
|
def getCfg(self):
|
|
return self.data
|
|
|
|
def setCfg(self, cfg):
|
|
self.data = cfg
|
|
|
|
def getFailures(self):
|
|
"""
|
|
Return the number of failed packages
|
|
"""
|
|
return self._failures
|
|
|
|
pkgs = property(getPkgs, setPkgs, None, "pkgs property")
|
|
name = property(getName, setName, None, "name property")
|
|
cfg = property(getCfg, setCfg, None, "cfg property")
|
|
|
|
|
|
|
|
|
|
|
|
class BuildStarted(BuildBase):
|
|
"""bbmake build run started"""
|
|
|
|
|
|
class BuildCompleted(BuildBase):
|
|
"""bbmake build run completed"""
|
|
|
|
|
|
|
|
|
|
class NoProvider(Event):
|
|
"""No Provider for an Event"""
|
|
|
|
def __init__(self, item, runtime=False, dependees=None, reasons=[]):
|
|
Event.__init__(self)
|
|
self._item = item
|
|
self._runtime = runtime
|
|
self._dependees = dependees
|
|
self._reasons = reasons
|
|
|
|
def getItem(self):
|
|
return self._item
|
|
|
|
def isRuntime(self):
|
|
return self._runtime
|
|
|
|
class MultipleProviders(Event):
|
|
"""Multiple Providers"""
|
|
|
|
def __init__(self, item, candidates, runtime = False):
|
|
Event.__init__(self)
|
|
self._item = item
|
|
self._candidates = candidates
|
|
self._is_runtime = runtime
|
|
|
|
def isRuntime(self):
|
|
"""
|
|
Is this a runtime issue?
|
|
"""
|
|
return self._is_runtime
|
|
|
|
def getItem(self):
|
|
"""
|
|
The name for the to be build item
|
|
"""
|
|
return self._item
|
|
|
|
def getCandidates(self):
|
|
"""
|
|
Get the possible Candidates for a PROVIDER.
|
|
"""
|
|
return self._candidates
|
|
|
|
class ParseStarted(Event):
|
|
"""Recipe parsing for the runqueue has begun"""
|
|
def __init__(self, total):
|
|
Event.__init__(self)
|
|
self.total = total
|
|
|
|
class ParseCompleted(Event):
|
|
"""Recipe parsing for the runqueue has completed"""
|
|
|
|
def __init__(self, cached, parsed, skipped, masked, virtuals, errors, total):
|
|
Event.__init__(self)
|
|
self.cached = cached
|
|
self.parsed = parsed
|
|
self.skipped = skipped
|
|
self.virtuals = virtuals
|
|
self.masked = masked
|
|
self.errors = errors
|
|
self.sofar = cached + parsed
|
|
self.total = total
|
|
|
|
class ParseProgress(Event):
|
|
"""Recipe parsing progress"""
|
|
|
|
def __init__(self, current):
|
|
self.current = current
|
|
|
|
class CacheLoadStarted(Event):
|
|
"""Loading of the dependency cache has begun"""
|
|
def __init__(self, total):
|
|
Event.__init__(self)
|
|
self.total = total
|
|
|
|
class CacheLoadProgress(Event):
|
|
"""Cache loading progress"""
|
|
def __init__(self, current):
|
|
Event.__init__(self)
|
|
self.current = current
|
|
|
|
class CacheLoadCompleted(Event):
|
|
"""Cache loading is complete"""
|
|
def __init__(self, total, num_entries):
|
|
Event.__init__(self)
|
|
self.total = total
|
|
self.num_entries = num_entries
|
|
|
|
|
|
class DepTreeGenerated(Event):
|
|
"""
|
|
Event when a dependency tree has been generated
|
|
"""
|
|
|
|
def __init__(self, depgraph):
|
|
Event.__init__(self)
|
|
self._depgraph = depgraph
|
|
|
|
class TargetsTreeGenerated(Event):
|
|
"""
|
|
Event when a set of buildable targets has been generated
|
|
"""
|
|
def __init__(self, model):
|
|
Event.__init__(self)
|
|
self._model = model
|
|
|
|
class FilesMatchingFound(Event):
|
|
"""
|
|
Event when a list of files matching the supplied pattern has
|
|
been generated
|
|
"""
|
|
def __init__(self, pattern, matches):
|
|
Event.__init__(self)
|
|
self._pattern = pattern
|
|
self._matches = matches
|
|
|
|
class ConfigFilesFound(Event):
|
|
"""
|
|
Event when a list of appropriate config files has been generated
|
|
"""
|
|
def __init__(self, variable, values):
|
|
Event.__init__(self)
|
|
self._variable = variable
|
|
self._values = values
|
|
|
|
class ConfigFilePathFound(Event):
|
|
"""
|
|
Event when a path for a config file has been found
|
|
"""
|
|
def __init__(self, path):
|
|
Event.__init__(self)
|
|
self._path = path
|
|
|
|
class MsgBase(Event):
|
|
"""Base class for messages"""
|
|
|
|
def __init__(self, msg):
|
|
self._message = msg
|
|
Event.__init__(self)
|
|
|
|
class MsgDebug(MsgBase):
|
|
"""Debug Message"""
|
|
|
|
class MsgNote(MsgBase):
|
|
"""Note Message"""
|
|
|
|
class MsgWarn(MsgBase):
|
|
"""Warning Message"""
|
|
|
|
class MsgError(MsgBase):
|
|
"""Error Message"""
|
|
|
|
class MsgFatal(MsgBase):
|
|
"""Fatal Message"""
|
|
|
|
class MsgPlain(MsgBase):
|
|
"""General output"""
|
|
|
|
class LogHandler(logging.Handler):
|
|
"""Dispatch logging messages as bitbake events"""
|
|
|
|
def emit(self, record):
|
|
if record.exc_info:
|
|
etype, value, tb = record.exc_info
|
|
if hasattr(tb, 'tb_next'):
|
|
tb = list(bb.exceptions.extract_traceback(tb, context=3))
|
|
record.bb_exc_info = (etype, value, tb)
|
|
record.exc_info = None
|
|
fire(record, None)
|
|
|
|
def filter(self, record):
|
|
record.taskpid = worker_pid
|
|
return True
|