blob: 773c58287bb8cf97a8571c2909ba01e97624c619 [file] [log] [blame]
Mike Frysinger9f7e4ee2013-03-13 15:43:03 -04001#!/usr/bin/python
Mike Frysinger0a647fc2012-08-06 14:36:05 -04002# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
David Jamesfcb70ef2011-02-02 16:02:30 -08003# Use of this source code is governed by a BSD-style license that can be
4# found in the LICENSE file.
5
6"""Program to run emerge in parallel, for significant speedup.
7
8Usage:
David James386ccd12011-05-04 20:17:42 -07009 ./parallel_emerge [--board=BOARD] [--workon=PKGS]
David Jamesfcb70ef2011-02-02 16:02:30 -080010 [--force-remote-binary=PKGS] [emerge args] package
11
David James78b6cd92012-04-02 21:36:12 -070012This script runs multiple emerge processes in parallel, using appropriate
13Portage APIs. It is faster than standard emerge because it has a
14multiprocess model instead of an asynchronous model.
David Jamesfcb70ef2011-02-02 16:02:30 -080015"""
16
17import codecs
18import copy
19import errno
Brian Harring8294d652012-05-23 02:20:52 -070020import gc
David James8c7e5e32011-06-28 11:26:03 -070021import heapq
David Jamesfcb70ef2011-02-02 16:02:30 -080022import multiprocessing
23import os
Mike Frysinger1ae28092013-10-17 17:17:22 -040024try:
25 import Queue
26except ImportError:
27 # Python-3 renamed to "queue". We still use Queue to avoid collisions
28 # with naming variables as "queue". Maybe we'll transition at some point.
29 # pylint: disable=F0401
30 import queue as Queue
David Jamesfcb70ef2011-02-02 16:02:30 -080031import signal
32import sys
33import tempfile
Brian Harring8294d652012-05-23 02:20:52 -070034import threading
David Jamesfcb70ef2011-02-02 16:02:30 -080035import time
36import traceback
David Jamesfcb70ef2011-02-02 16:02:30 -080037
Thiago Goncalesf4acc422013-07-17 10:26:35 -070038from chromite.lib import cros_build_lib
39
David Jamesfcb70ef2011-02-02 16:02:30 -080040# If PORTAGE_USERNAME isn't specified, scrape it from the $HOME variable. On
41# Chromium OS, the default "portage" user doesn't have the necessary
42# permissions. It'd be easier if we could default to $USERNAME, but $USERNAME
43# is "root" here because we get called through sudo.
44#
45# We need to set this before importing any portage modules, because portage
46# looks up "PORTAGE_USERNAME" at import time.
47#
48# NOTE: .bashrc sets PORTAGE_USERNAME = $USERNAME, so most people won't
49# encounter this case unless they have an old chroot or blow away the
50# environment by running sudo without the -E specifier.
51if "PORTAGE_USERNAME" not in os.environ:
52 homedir = os.environ.get("HOME")
53 if homedir:
54 os.environ["PORTAGE_USERNAME"] = os.path.basename(homedir)
55
56# Portage doesn't expose dependency trees in its public API, so we have to
57# make use of some private APIs here. These modules are found under
58# /usr/lib/portage/pym/.
59#
60# TODO(davidjames): Update Portage to expose public APIs for these features.
David James321490a2012-12-17 12:05:56 -080061# pylint: disable=W0212
David Jamesfcb70ef2011-02-02 16:02:30 -080062from _emerge.actions import adjust_configs
63from _emerge.actions import load_emerge_config
64from _emerge.create_depgraph_params import create_depgraph_params
David James386ccd12011-05-04 20:17:42 -070065from _emerge.depgraph import backtrack_depgraph
Mike Frysinger901eaad2012-10-10 18:18:03 -040066try:
67 from _emerge.main import clean_logs
68except ImportError:
69 # Older portage versions did not provide clean_logs, so stub it.
70 # We need this if running in an older chroot that hasn't yet upgraded
71 # the portage version.
72 clean_logs = lambda x: None
David Jamesfcb70ef2011-02-02 16:02:30 -080073from _emerge.main import emerge_main
74from _emerge.main import parse_opts
75from _emerge.Package import Package
76from _emerge.Scheduler import Scheduler
David Jamesfcb70ef2011-02-02 16:02:30 -080077from _emerge.stdout_spinner import stdout_spinner
David James386ccd12011-05-04 20:17:42 -070078from portage._global_updates import _global_updates
David Jamesfcb70ef2011-02-02 16:02:30 -080079import portage
80import portage.debug
Mike Frysinger91d7da92013-02-19 15:53:46 -050081from portage.versions import vercmp
82
David Jamesfcb70ef2011-02-02 16:02:30 -080083
David Jamesfcb70ef2011-02-02 16:02:30 -080084def Usage():
85 """Print usage."""
86 print "Usage:"
David James386ccd12011-05-04 20:17:42 -070087 print " ./parallel_emerge [--board=BOARD] [--workon=PKGS]"
David Jamesfcb70ef2011-02-02 16:02:30 -080088 print " [--rebuild] [emerge args] package"
89 print
90 print "Packages specified as workon packages are always built from source."
David Jamesfcb70ef2011-02-02 16:02:30 -080091 print
92 print "The --workon argument is mainly useful when you want to build and"
93 print "install packages that you are working on unconditionally, but do not"
94 print "to have to rev the package to indicate you want to build it from"
95 print "source. The build_packages script will automatically supply the"
96 print "workon argument to emerge, ensuring that packages selected using"
97 print "cros-workon are rebuilt."
98 print
99 print "The --rebuild option rebuilds packages whenever their dependencies"
100 print "are changed. This ensures that your build is correct."
David Jamesfcb70ef2011-02-02 16:02:30 -0800101
102
David Jamesfcb70ef2011-02-02 16:02:30 -0800103# Global start time
104GLOBAL_START = time.time()
105
David James7358d032011-05-19 10:40:03 -0700106# Whether process has been killed by a signal.
107KILLED = multiprocessing.Event()
108
David Jamesfcb70ef2011-02-02 16:02:30 -0800109
110class EmergeData(object):
111 """This simple struct holds various emerge variables.
112
113 This struct helps us easily pass emerge variables around as a unit.
114 These variables are used for calculating dependencies and installing
115 packages.
116 """
117
David Jamesbf1e3442011-05-28 07:44:20 -0700118 __slots__ = ["action", "cmdline_packages", "depgraph", "favorites",
119 "mtimedb", "opts", "root_config", "scheduler_graph",
120 "settings", "spinner", "trees"]
David Jamesfcb70ef2011-02-02 16:02:30 -0800121
122 def __init__(self):
123 # The action the user requested. If the user is installing packages, this
124 # is None. If the user is doing anything other than installing packages,
125 # this will contain the action name, which will map exactly to the
126 # long-form name of the associated emerge option.
127 #
128 # Example: If you call parallel_emerge --unmerge package, the action name
129 # will be "unmerge"
130 self.action = None
131
132 # The list of packages the user passed on the command-line.
133 self.cmdline_packages = None
134
135 # The emerge dependency graph. It'll contain all the packages involved in
136 # this merge, along with their versions.
137 self.depgraph = None
138
David Jamesbf1e3442011-05-28 07:44:20 -0700139 # The list of candidates to add to the world file.
140 self.favorites = None
141
David Jamesfcb70ef2011-02-02 16:02:30 -0800142 # A dict of the options passed to emerge. This dict has been cleaned up
143 # a bit by parse_opts, so that it's a bit easier for the emerge code to
144 # look at the options.
145 #
146 # Emerge takes a few shortcuts in its cleanup process to make parsing of
147 # the options dict easier. For example, if you pass in "--usepkg=n", the
148 # "--usepkg" flag is just left out of the dictionary altogether. Because
149 # --usepkg=n is the default, this makes parsing easier, because emerge
150 # can just assume that if "--usepkg" is in the dictionary, it's enabled.
151 #
152 # These cleanup processes aren't applied to all options. For example, the
153 # --with-bdeps flag is passed in as-is. For a full list of the cleanups
154 # applied by emerge, see the parse_opts function in the _emerge.main
155 # package.
156 self.opts = None
157
158 # A dictionary used by portage to maintain global state. This state is
159 # loaded from disk when portage starts up, and saved to disk whenever we
160 # call mtimedb.commit().
161 #
162 # This database contains information about global updates (i.e., what
163 # version of portage we have) and what we're currently doing. Portage
164 # saves what it is currently doing in this database so that it can be
165 # resumed when you call it with the --resume option.
166 #
167 # parallel_emerge does not save what it is currently doing in the mtimedb,
168 # so we do not support the --resume option.
169 self.mtimedb = None
170
171 # The portage configuration for our current root. This contains the portage
172 # settings (see below) and the three portage trees for our current root.
173 # (The three portage trees are explained below, in the documentation for
174 # the "trees" member.)
175 self.root_config = None
176
177 # The scheduler graph is used by emerge to calculate what packages to
178 # install. We don't actually install any deps, so this isn't really used,
179 # but we pass it in to the Scheduler object anyway.
180 self.scheduler_graph = None
181
182 # Portage settings for our current session. Most of these settings are set
183 # in make.conf inside our current install root.
184 self.settings = None
185
186 # The spinner, which spews stuff to stdout to indicate that portage is
187 # doing something. We maintain our own spinner, so we set the portage
188 # spinner to "silent" mode.
189 self.spinner = None
190
191 # The portage trees. There are separate portage trees for each root. To get
192 # the portage tree for the current root, you can look in self.trees[root],
193 # where root = self.settings["ROOT"].
194 #
195 # In each root, there are three trees: vartree, porttree, and bintree.
196 # - vartree: A database of the currently-installed packages.
197 # - porttree: A database of ebuilds, that can be used to build packages.
198 # - bintree: A database of binary packages.
199 self.trees = None
200
201
202class DepGraphGenerator(object):
203 """Grab dependency information about packages from portage.
204
205 Typical usage:
206 deps = DepGraphGenerator()
207 deps.Initialize(sys.argv[1:])
208 deps_tree, deps_info = deps.GenDependencyTree()
209 deps_graph = deps.GenDependencyGraph(deps_tree, deps_info)
210 deps.PrintTree(deps_tree)
211 PrintDepsMap(deps_graph)
212 """
213
Thiago Goncalesf4acc422013-07-17 10:26:35 -0700214 __slots__ = ["board", "emerge", "package_db", "show_output", "unpack_only"]
David Jamesfcb70ef2011-02-02 16:02:30 -0800215
216 def __init__(self):
217 self.board = None
218 self.emerge = EmergeData()
David Jamesfcb70ef2011-02-02 16:02:30 -0800219 self.package_db = {}
David Jamesfcb70ef2011-02-02 16:02:30 -0800220 self.show_output = False
Thiago Goncalesf4acc422013-07-17 10:26:35 -0700221 self.unpack_only = False
David Jamesfcb70ef2011-02-02 16:02:30 -0800222
223 def ParseParallelEmergeArgs(self, argv):
224 """Read the parallel emerge arguments from the command-line.
225
226 We need to be compatible with emerge arg format. We scrape arguments that
227 are specific to parallel_emerge, and pass through the rest directly to
228 emerge.
229 Args:
230 argv: arguments list
231 Returns:
232 Arguments that don't belong to parallel_emerge
233 """
234 emerge_args = []
235 for arg in argv:
236 # Specifically match arguments that are specific to parallel_emerge, and
237 # pass through the rest.
238 if arg.startswith("--board="):
239 self.board = arg.replace("--board=", "")
240 elif arg.startswith("--workon="):
241 workon_str = arg.replace("--workon=", "")
David James7a1ea4b2011-10-13 15:06:41 -0700242 emerge_args.append("--reinstall-atoms=%s" % workon_str)
243 emerge_args.append("--usepkg-exclude=%s" % workon_str)
David Jamesfcb70ef2011-02-02 16:02:30 -0800244 elif arg.startswith("--force-remote-binary="):
245 force_remote_binary = arg.replace("--force-remote-binary=", "")
David James7a1ea4b2011-10-13 15:06:41 -0700246 emerge_args.append("--useoldpkg-atoms=%s" % force_remote_binary)
David Jamesfcb70ef2011-02-02 16:02:30 -0800247 elif arg == "--show-output":
248 self.show_output = True
David James386ccd12011-05-04 20:17:42 -0700249 elif arg == "--rebuild":
David James7a1ea4b2011-10-13 15:06:41 -0700250 emerge_args.append("--rebuild-if-unbuilt")
Thiago Goncalesf4acc422013-07-17 10:26:35 -0700251 elif arg == "--unpackonly":
252 emerge_args.append("--fetchonly")
253 self.unpack_only = True
David Jamesfcb70ef2011-02-02 16:02:30 -0800254 else:
255 # Not one of our options, so pass through to emerge.
256 emerge_args.append(arg)
257
David James386ccd12011-05-04 20:17:42 -0700258 # These packages take a really long time to build, so, for expediency, we
259 # are blacklisting them from automatic rebuilds because one of their
260 # dependencies needs to be recompiled.
261 for pkg in ("chromeos-base/chromeos-chrome", "media-plugins/o3d",
262 "dev-java/icedtea"):
David James7a1ea4b2011-10-13 15:06:41 -0700263 emerge_args.append("--rebuild-exclude=%s" % pkg)
David Jamesfcb70ef2011-02-02 16:02:30 -0800264
265 return emerge_args
266
267 def Initialize(self, args):
268 """Initializer. Parses arguments and sets up portage state."""
269
270 # Parse and strip out args that are just intended for parallel_emerge.
271 emerge_args = self.ParseParallelEmergeArgs(args)
272
273 # Setup various environment variables based on our current board. These
274 # variables are normally setup inside emerge-${BOARD}, but since we don't
275 # call that script, we have to set it up here. These variables serve to
276 # point our tools at /build/BOARD and to setup cross compiles to the
277 # appropriate board as configured in toolchain.conf.
278 if self.board:
279 os.environ["PORTAGE_CONFIGROOT"] = "/build/" + self.board
280 os.environ["PORTAGE_SYSROOT"] = "/build/" + self.board
281 os.environ["SYSROOT"] = "/build/" + self.board
David Jamesfcb70ef2011-02-02 16:02:30 -0800282
283 # Although CHROMEOS_ROOT isn't specific to boards, it's normally setup
284 # inside emerge-${BOARD}, so we set it up here for compatibility. It
285 # will be going away soon as we migrate to CROS_WORKON_SRCROOT.
286 os.environ.setdefault("CHROMEOS_ROOT", os.environ["HOME"] + "/trunk")
287
288 # Turn off interactive delays
289 os.environ["EBEEP_IGNORE"] = "1"
290 os.environ["EPAUSE_IGNORE"] = "1"
Mike Frysinger0a647fc2012-08-06 14:36:05 -0400291 os.environ["CLEAN_DELAY"] = "0"
David Jamesfcb70ef2011-02-02 16:02:30 -0800292
293 # Parse the emerge options.
David Jamesea3ca332011-05-26 11:48:29 -0700294 action, opts, cmdline_packages = parse_opts(emerge_args, silent=True)
David Jamesfcb70ef2011-02-02 16:02:30 -0800295
296 # Set environment variables based on options. Portage normally sets these
297 # environment variables in emerge_main, but we can't use that function,
298 # because it also does a bunch of other stuff that we don't want.
299 # TODO(davidjames): Patch portage to move this logic into a function we can
300 # reuse here.
301 if "--debug" in opts:
302 os.environ["PORTAGE_DEBUG"] = "1"
303 if "--config-root" in opts:
304 os.environ["PORTAGE_CONFIGROOT"] = opts["--config-root"]
305 if "--root" in opts:
306 os.environ["ROOT"] = opts["--root"]
307 if "--accept-properties" in opts:
308 os.environ["ACCEPT_PROPERTIES"] = opts["--accept-properties"]
309
David Jamesfcb70ef2011-02-02 16:02:30 -0800310 # If we're installing packages to the board, and we're not using the
David James927a56d2012-04-03 11:26:39 -0700311 # official flag, we can disable vardb locks. This is safe because we
312 # only run up to one instance of parallel_emerge in parallel.
David Jamesfcb70ef2011-02-02 16:02:30 -0800313 if self.board and os.environ.get("CHROMEOS_OFFICIAL") != "1":
314 os.environ.setdefault("PORTAGE_LOCKS", "false")
David Jamesfcb70ef2011-02-02 16:02:30 -0800315
316 # Now that we've setup the necessary environment variables, we can load the
317 # emerge config from disk.
318 settings, trees, mtimedb = load_emerge_config()
319
David Jamesea3ca332011-05-26 11:48:29 -0700320 # Add in EMERGE_DEFAULT_OPTS, if specified.
321 tmpcmdline = []
322 if "--ignore-default-opts" not in opts:
323 tmpcmdline.extend(settings["EMERGE_DEFAULT_OPTS"].split())
324 tmpcmdline.extend(emerge_args)
325 action, opts, cmdline_packages = parse_opts(tmpcmdline)
326
327 # If we're installing to the board, we want the --root-deps option so that
328 # portage will install the build dependencies to that location as well.
329 if self.board:
330 opts.setdefault("--root-deps", True)
331
David Jamesfcb70ef2011-02-02 16:02:30 -0800332 # Check whether our portage tree is out of date. Typically, this happens
333 # when you're setting up a new portage tree, such as in setup_board and
334 # make_chroot. In that case, portage applies a bunch of global updates
335 # here. Once the updates are finished, we need to commit any changes
336 # that the global update made to our mtimedb, and reload the config.
337 #
338 # Portage normally handles this logic in emerge_main, but again, we can't
339 # use that function here.
340 if _global_updates(trees, mtimedb["updates"]):
341 mtimedb.commit()
342 settings, trees, mtimedb = load_emerge_config(trees=trees)
343
344 # Setup implied options. Portage normally handles this logic in
345 # emerge_main.
346 if "--buildpkgonly" in opts or "buildpkg" in settings.features:
347 opts.setdefault("--buildpkg", True)
348 if "--getbinpkgonly" in opts:
349 opts.setdefault("--usepkgonly", True)
350 opts.setdefault("--getbinpkg", True)
351 if "getbinpkg" in settings.features:
352 # Per emerge_main, FEATURES=getbinpkg overrides --getbinpkg=n
353 opts["--getbinpkg"] = True
354 if "--getbinpkg" in opts or "--usepkgonly" in opts:
355 opts.setdefault("--usepkg", True)
356 if "--fetch-all-uri" in opts:
357 opts.setdefault("--fetchonly", True)
358 if "--skipfirst" in opts:
359 opts.setdefault("--resume", True)
360 if "--buildpkgonly" in opts:
361 # --buildpkgonly will not merge anything, so it overrides all binary
362 # package options.
363 for opt in ("--getbinpkg", "--getbinpkgonly",
364 "--usepkg", "--usepkgonly"):
365 opts.pop(opt, None)
366 if (settings.get("PORTAGE_DEBUG", "") == "1" and
367 "python-trace" in settings.features):
368 portage.debug.set_trace(True)
369
370 # Complain about unsupported options
David James386ccd12011-05-04 20:17:42 -0700371 for opt in ("--ask", "--ask-enter-invalid", "--resume", "--skipfirst"):
David Jamesfcb70ef2011-02-02 16:02:30 -0800372 if opt in opts:
373 print "%s is not supported by parallel_emerge" % opt
374 sys.exit(1)
375
376 # Make emerge specific adjustments to the config (e.g. colors!)
377 adjust_configs(opts, trees)
378
379 # Save our configuration so far in the emerge object
380 emerge = self.emerge
381 emerge.action, emerge.opts = action, opts
382 emerge.settings, emerge.trees, emerge.mtimedb = settings, trees, mtimedb
383 emerge.cmdline_packages = cmdline_packages
384 root = settings["ROOT"]
385 emerge.root_config = trees[root]["root_config"]
386
David James386ccd12011-05-04 20:17:42 -0700387 if "--usepkg" in opts:
David Jamesfcb70ef2011-02-02 16:02:30 -0800388 emerge.trees[root]["bintree"].populate("--getbinpkg" in opts)
389
David Jamesfcb70ef2011-02-02 16:02:30 -0800390 def CreateDepgraph(self, emerge, packages):
391 """Create an emerge depgraph object."""
392 # Setup emerge options.
393 emerge_opts = emerge.opts.copy()
394
David James386ccd12011-05-04 20:17:42 -0700395 # Ask portage to build a dependency graph. with the options we specified
396 # above.
David Jamesfcb70ef2011-02-02 16:02:30 -0800397 params = create_depgraph_params(emerge_opts, emerge.action)
David Jamesbf1e3442011-05-28 07:44:20 -0700398 success, depgraph, favorites = backtrack_depgraph(
David James386ccd12011-05-04 20:17:42 -0700399 emerge.settings, emerge.trees, emerge_opts, params, emerge.action,
400 packages, emerge.spinner)
401 emerge.depgraph = depgraph
David Jamesfcb70ef2011-02-02 16:02:30 -0800402
David James386ccd12011-05-04 20:17:42 -0700403 # Is it impossible to honor the user's request? Bail!
404 if not success:
405 depgraph.display_problems()
406 sys.exit(1)
David Jamesfcb70ef2011-02-02 16:02:30 -0800407
408 emerge.depgraph = depgraph
David Jamesbf1e3442011-05-28 07:44:20 -0700409 emerge.favorites = favorites
David Jamesfcb70ef2011-02-02 16:02:30 -0800410
David Jamesdeebd692011-05-09 17:02:52 -0700411 # Prime and flush emerge caches.
412 root = emerge.settings["ROOT"]
413 vardb = emerge.trees[root]["vartree"].dbapi
David James0bdc5de2011-05-12 16:22:26 -0700414 if "--pretend" not in emerge.opts:
415 vardb.counter_tick()
David Jamesdeebd692011-05-09 17:02:52 -0700416 vardb.flush_cache()
417
David James386ccd12011-05-04 20:17:42 -0700418 def GenDependencyTree(self):
David Jamesfcb70ef2011-02-02 16:02:30 -0800419 """Get dependency tree info from emerge.
420
David Jamesfcb70ef2011-02-02 16:02:30 -0800421 Returns:
422 Dependency tree
423 """
424 start = time.time()
425
426 emerge = self.emerge
427
428 # Create a list of packages to merge
429 packages = set(emerge.cmdline_packages[:])
David Jamesfcb70ef2011-02-02 16:02:30 -0800430
431 # Tell emerge to be quiet. We print plenty of info ourselves so we don't
432 # need any extra output from portage.
433 portage.util.noiselimit = -1
434
435 # My favorite feature: The silent spinner. It doesn't spin. Ever.
436 # I'd disable the colors by default too, but they look kind of cool.
437 emerge.spinner = stdout_spinner()
438 emerge.spinner.update = emerge.spinner.update_quiet
439
440 if "--quiet" not in emerge.opts:
441 print "Calculating deps..."
442
443 self.CreateDepgraph(emerge, packages)
444 depgraph = emerge.depgraph
445
446 # Build our own tree from the emerge digraph.
447 deps_tree = {}
448 digraph = depgraph._dynamic_config.digraph
David James3f778802011-08-25 19:31:45 -0700449 root = emerge.settings["ROOT"]
450 final_db = depgraph._dynamic_config.mydbapi[root]
David Jamesfcb70ef2011-02-02 16:02:30 -0800451 for node, node_deps in digraph.nodes.items():
452 # Calculate dependency packages that need to be installed first. Each
453 # child on the digraph is a dependency. The "operation" field specifies
454 # what we're doing (e.g. merge, uninstall, etc.). The "priorities" array
455 # contains the type of dependency (e.g. build, runtime, runtime_post,
456 # etc.)
457 #
David Jamesfcb70ef2011-02-02 16:02:30 -0800458 # Portage refers to the identifiers for packages as a CPV. This acronym
459 # stands for Component/Path/Version.
460 #
461 # Here's an example CPV: chromeos-base/power_manager-0.0.1-r1
462 # Split up, this CPV would be:
463 # C -- Component: chromeos-base
464 # P -- Path: power_manager
465 # V -- Version: 0.0.1-r1
466 #
467 # We just refer to CPVs as packages here because it's easier.
468 deps = {}
469 for child, priorities in node_deps[0].items():
David James3f778802011-08-25 19:31:45 -0700470 if isinstance(child, Package) and child.root == root:
471 cpv = str(child.cpv)
472 action = str(child.operation)
473
474 # If we're uninstalling a package, check whether Portage is
475 # installing a replacement. If so, just depend on the installation
476 # of the new package, because the old package will automatically
477 # be uninstalled at that time.
478 if action == "uninstall":
479 for pkg in final_db.match_pkgs(child.slot_atom):
480 cpv = str(pkg.cpv)
481 action = "merge"
482 break
483
484 deps[cpv] = dict(action=action,
485 deptypes=[str(x) for x in priorities],
486 deps={})
David Jamesfcb70ef2011-02-02 16:02:30 -0800487
488 # We've built our list of deps, so we can add our package to the tree.
David James3f778802011-08-25 19:31:45 -0700489 if isinstance(node, Package) and node.root == root:
David Jamesfcb70ef2011-02-02 16:02:30 -0800490 deps_tree[str(node.cpv)] = dict(action=str(node.operation),
491 deps=deps)
492
David Jamesfcb70ef2011-02-02 16:02:30 -0800493 # Ask portage for its install plan, so that we can only throw out
David James386ccd12011-05-04 20:17:42 -0700494 # dependencies that portage throws out.
David Jamesfcb70ef2011-02-02 16:02:30 -0800495 deps_info = {}
496 for pkg in depgraph.altlist():
497 if isinstance(pkg, Package):
David James3f778802011-08-25 19:31:45 -0700498 assert pkg.root == root
David Jamesfcb70ef2011-02-02 16:02:30 -0800499 self.package_db[pkg.cpv] = pkg
500
David Jamesfcb70ef2011-02-02 16:02:30 -0800501 # Save off info about the package
David James386ccd12011-05-04 20:17:42 -0700502 deps_info[str(pkg.cpv)] = {"idx": len(deps_info)}
David Jamesfcb70ef2011-02-02 16:02:30 -0800503
504 seconds = time.time() - start
505 if "--quiet" not in emerge.opts:
506 print "Deps calculated in %dm%.1fs" % (seconds / 60, seconds % 60)
507
508 return deps_tree, deps_info
509
510 def PrintTree(self, deps, depth=""):
511 """Print the deps we have seen in the emerge output.
512
513 Args:
514 deps: Dependency tree structure.
515 depth: Allows printing the tree recursively, with indentation.
516 """
517 for entry in sorted(deps):
518 action = deps[entry]["action"]
519 print "%s %s (%s)" % (depth, entry, action)
520 self.PrintTree(deps[entry]["deps"], depth=depth + " ")
521
David James386ccd12011-05-04 20:17:42 -0700522 def GenDependencyGraph(self, deps_tree, deps_info):
David Jamesfcb70ef2011-02-02 16:02:30 -0800523 """Generate a doubly linked dependency graph.
524
525 Args:
526 deps_tree: Dependency tree structure.
527 deps_info: More details on the dependencies.
528 Returns:
529 Deps graph in the form of a dict of packages, with each package
530 specifying a "needs" list and "provides" list.
531 """
532 emerge = self.emerge
David Jamesfcb70ef2011-02-02 16:02:30 -0800533
David Jamesfcb70ef2011-02-02 16:02:30 -0800534 # deps_map is the actual dependency graph.
535 #
536 # Each package specifies a "needs" list and a "provides" list. The "needs"
537 # list indicates which packages we depend on. The "provides" list
538 # indicates the reverse dependencies -- what packages need us.
539 #
540 # We also provide some other information in the dependency graph:
541 # - action: What we're planning on doing with this package. Generally,
542 # "merge", "nomerge", or "uninstall"
David Jamesfcb70ef2011-02-02 16:02:30 -0800543 deps_map = {}
544
545 def ReverseTree(packages):
546 """Convert tree to digraph.
547
548 Take the tree of package -> requirements and reverse it to a digraph of
549 buildable packages -> packages they unblock.
550 Args:
551 packages: Tree(s) of dependencies.
552 Returns:
553 Unsanitized digraph.
554 """
David James8c7e5e32011-06-28 11:26:03 -0700555 binpkg_phases = set(["setup", "preinst", "postinst"])
David James3f778802011-08-25 19:31:45 -0700556 needed_dep_types = set(["blocker", "buildtime", "runtime"])
David Jamesfcb70ef2011-02-02 16:02:30 -0800557 for pkg in packages:
558
559 # Create an entry for the package
560 action = packages[pkg]["action"]
David James8c7e5e32011-06-28 11:26:03 -0700561 default_pkg = {"needs": {}, "provides": set(), "action": action,
562 "nodeps": False, "binary": False}
David Jamesfcb70ef2011-02-02 16:02:30 -0800563 this_pkg = deps_map.setdefault(pkg, default_pkg)
564
David James8c7e5e32011-06-28 11:26:03 -0700565 if pkg in deps_info:
566 this_pkg["idx"] = deps_info[pkg]["idx"]
567
568 # If a package doesn't have any defined phases that might use the
569 # dependent packages (i.e. pkg_setup, pkg_preinst, or pkg_postinst),
570 # we can install this package before its deps are ready.
571 emerge_pkg = self.package_db.get(pkg)
572 if emerge_pkg and emerge_pkg.type_name == "binary":
573 this_pkg["binary"] = True
Mike Frysinger91d7da92013-02-19 15:53:46 -0500574 if 0 <= vercmp(portage.VERSION, "2.1.11.50"):
575 defined_phases = emerge_pkg.defined_phases
576 else:
577 defined_phases = emerge_pkg.metadata.defined_phases
David James8c7e5e32011-06-28 11:26:03 -0700578 defined_binpkg_phases = binpkg_phases.intersection(defined_phases)
579 if not defined_binpkg_phases:
580 this_pkg["nodeps"] = True
581
David Jamesfcb70ef2011-02-02 16:02:30 -0800582 # Create entries for dependencies of this package first.
583 ReverseTree(packages[pkg]["deps"])
584
585 # Add dependencies to this package.
586 for dep, dep_item in packages[pkg]["deps"].iteritems():
David James8c7e5e32011-06-28 11:26:03 -0700587 # We only need to enforce strict ordering of dependencies if the
David James3f778802011-08-25 19:31:45 -0700588 # dependency is a blocker, or is a buildtime or runtime dependency.
589 # (I.e., ignored, optional, and runtime_post dependencies don't
590 # depend on ordering.)
David James8c7e5e32011-06-28 11:26:03 -0700591 dep_types = dep_item["deptypes"]
592 if needed_dep_types.intersection(dep_types):
593 deps_map[dep]["provides"].add(pkg)
594 this_pkg["needs"][dep] = "/".join(dep_types)
David Jamesfcb70ef2011-02-02 16:02:30 -0800595
David James3f778802011-08-25 19:31:45 -0700596 # If there's a blocker, Portage may need to move files from one
597 # package to another, which requires editing the CONTENTS files of
598 # both packages. To avoid race conditions while editing this file,
599 # the two packages must not be installed in parallel, so we can't
600 # safely ignore dependencies. See http://crosbug.com/19328
601 if "blocker" in dep_types:
602 this_pkg["nodeps"] = False
603
David Jamesfcb70ef2011-02-02 16:02:30 -0800604 def FindCycles():
605 """Find cycles in the dependency tree.
606
607 Returns:
608 A dict mapping cyclic packages to a dict of the deps that cause
609 cycles. For each dep that causes cycles, it returns an example
610 traversal of the graph that shows the cycle.
611 """
612
613 def FindCyclesAtNode(pkg, cycles, unresolved, resolved):
614 """Find cycles in cyclic dependencies starting at specified package.
615
616 Args:
617 pkg: Package identifier.
618 cycles: A dict mapping cyclic packages to a dict of the deps that
619 cause cycles. For each dep that causes cycles, it returns an
620 example traversal of the graph that shows the cycle.
621 unresolved: Nodes that have been visited but are not fully processed.
622 resolved: Nodes that have been visited and are fully processed.
623 """
624 pkg_cycles = cycles.get(pkg)
625 if pkg in resolved and not pkg_cycles:
626 # If we already looked at this package, and found no cyclic
627 # dependencies, we can stop now.
628 return
629 unresolved.append(pkg)
630 for dep in deps_map[pkg]["needs"]:
631 if dep in unresolved:
632 idx = unresolved.index(dep)
633 mycycle = unresolved[idx:] + [dep]
David James321490a2012-12-17 12:05:56 -0800634 for i in xrange(len(mycycle) - 1):
David Jamesfcb70ef2011-02-02 16:02:30 -0800635 pkg1, pkg2 = mycycle[i], mycycle[i+1]
636 cycles.setdefault(pkg1, {}).setdefault(pkg2, mycycle)
637 elif not pkg_cycles or dep not in pkg_cycles:
638 # Looks like we haven't seen this edge before.
639 FindCyclesAtNode(dep, cycles, unresolved, resolved)
640 unresolved.pop()
641 resolved.add(pkg)
642
643 cycles, unresolved, resolved = {}, [], set()
644 for pkg in deps_map:
645 FindCyclesAtNode(pkg, cycles, unresolved, resolved)
646 return cycles
647
David James386ccd12011-05-04 20:17:42 -0700648 def RemoveUnusedPackages():
David Jamesfcb70ef2011-02-02 16:02:30 -0800649 """Remove installed packages, propagating dependencies."""
David Jamesfcb70ef2011-02-02 16:02:30 -0800650 # Schedule packages that aren't on the install list for removal
651 rm_pkgs = set(deps_map.keys()) - set(deps_info.keys())
652
David Jamesfcb70ef2011-02-02 16:02:30 -0800653 # Remove the packages we don't want, simplifying the graph and making
654 # it easier for us to crack cycles.
655 for pkg in sorted(rm_pkgs):
656 this_pkg = deps_map[pkg]
657 needs = this_pkg["needs"]
658 provides = this_pkg["provides"]
659 for dep in needs:
660 dep_provides = deps_map[dep]["provides"]
661 dep_provides.update(provides)
662 dep_provides.discard(pkg)
663 dep_provides.discard(dep)
664 for target in provides:
665 target_needs = deps_map[target]["needs"]
666 target_needs.update(needs)
667 target_needs.pop(pkg, None)
668 target_needs.pop(target, None)
669 del deps_map[pkg]
670
671 def PrintCycleBreak(basedep, dep, mycycle):
672 """Print details about a cycle that we are planning on breaking.
673
674 We are breaking a cycle where dep needs basedep. mycycle is an
675 example cycle which contains dep -> basedep."""
676
David Jamesfcb70ef2011-02-02 16:02:30 -0800677 needs = deps_map[dep]["needs"]
678 depinfo = needs.get(basedep, "deleted")
David Jamesfcb70ef2011-02-02 16:02:30 -0800679
David James3f778802011-08-25 19:31:45 -0700680 # It's OK to swap install order for blockers, as long as the two
681 # packages aren't installed in parallel. If there is a cycle, then
682 # we know the packages depend on each other already, so we can drop the
683 # blocker safely without printing a warning.
684 if depinfo == "blocker":
685 return
686
David Jamesfcb70ef2011-02-02 16:02:30 -0800687 # Notify the user that we're breaking a cycle.
688 print "Breaking %s -> %s (%s)" % (dep, basedep, depinfo)
689
690 # Show cycle.
David James321490a2012-12-17 12:05:56 -0800691 for i in xrange(len(mycycle) - 1):
David Jamesfcb70ef2011-02-02 16:02:30 -0800692 pkg1, pkg2 = mycycle[i], mycycle[i+1]
693 needs = deps_map[pkg1]["needs"]
694 depinfo = needs.get(pkg2, "deleted")
695 if pkg1 == dep and pkg2 == basedep:
696 depinfo = depinfo + ", deleting"
697 print " %s -> %s (%s)" % (pkg1, pkg2, depinfo)
698
699 def SanitizeTree():
700 """Remove circular dependencies.
701
702 We prune all dependencies involved in cycles that go against the emerge
703 ordering. This has a nice property: we're guaranteed to merge
704 dependencies in the same order that portage does.
705
706 Because we don't treat any dependencies as "soft" unless they're killed
707 by a cycle, we pay attention to a larger number of dependencies when
708 merging. This hurts performance a bit, but helps reliability.
709 """
710 start = time.time()
711 cycles = FindCycles()
712 while cycles:
713 for dep, mycycles in cycles.iteritems():
714 for basedep, mycycle in mycycles.iteritems():
715 if deps_info[basedep]["idx"] >= deps_info[dep]["idx"]:
Matt Tennant08797302011-10-17 16:18:45 -0700716 if "--quiet" not in emerge.opts:
717 PrintCycleBreak(basedep, dep, mycycle)
David Jamesfcb70ef2011-02-02 16:02:30 -0800718 del deps_map[dep]["needs"][basedep]
719 deps_map[basedep]["provides"].remove(dep)
720 cycles = FindCycles()
721 seconds = time.time() - start
722 if "--quiet" not in emerge.opts and seconds >= 0.1:
723 print "Tree sanitized in %dm%.1fs" % (seconds / 60, seconds % 60)
724
David James8c7e5e32011-06-28 11:26:03 -0700725 def FindRecursiveProvides(pkg, seen):
726 """Find all nodes that require a particular package.
727
728 Assumes that graph is acyclic.
729
730 Args:
731 pkg: Package identifier.
732 seen: Nodes that have been visited so far.
733 """
734 if pkg in seen:
735 return
736 seen.add(pkg)
737 info = deps_map[pkg]
738 info["tprovides"] = info["provides"].copy()
739 for dep in info["provides"]:
740 FindRecursiveProvides(dep, seen)
741 info["tprovides"].update(deps_map[dep]["tprovides"])
742
David Jamesa22906f2011-05-04 19:53:26 -0700743 ReverseTree(deps_tree)
David Jamesa22906f2011-05-04 19:53:26 -0700744
David James386ccd12011-05-04 20:17:42 -0700745 # We need to remove unused packages so that we can use the dependency
746 # ordering of the install process to show us what cycles to crack.
747 RemoveUnusedPackages()
David Jamesfcb70ef2011-02-02 16:02:30 -0800748 SanitizeTree()
David James8c7e5e32011-06-28 11:26:03 -0700749 seen = set()
750 for pkg in deps_map:
751 FindRecursiveProvides(pkg, seen)
David Jamesfcb70ef2011-02-02 16:02:30 -0800752 return deps_map
753
754 def PrintInstallPlan(self, deps_map):
755 """Print an emerge-style install plan.
756
757 The install plan lists what packages we're installing, in order.
758 It's useful for understanding what parallel_emerge is doing.
759
760 Args:
761 deps_map: The dependency graph.
762 """
763
764 def InstallPlanAtNode(target, deps_map):
765 nodes = []
766 nodes.append(target)
767 for dep in deps_map[target]["provides"]:
768 del deps_map[dep]["needs"][target]
769 if not deps_map[dep]["needs"]:
770 nodes.extend(InstallPlanAtNode(dep, deps_map))
771 return nodes
772
773 deps_map = copy.deepcopy(deps_map)
774 install_plan = []
775 plan = set()
776 for target, info in deps_map.iteritems():
777 if not info["needs"] and target not in plan:
778 for item in InstallPlanAtNode(target, deps_map):
779 plan.add(item)
780 install_plan.append(self.package_db[item])
781
782 for pkg in plan:
783 del deps_map[pkg]
784
785 if deps_map:
786 print "Cyclic dependencies:", " ".join(deps_map)
787 PrintDepsMap(deps_map)
788 sys.exit(1)
789
790 self.emerge.depgraph.display(install_plan)
791
792
793def PrintDepsMap(deps_map):
794 """Print dependency graph, for each package list it's prerequisites."""
795 for i in sorted(deps_map):
796 print "%s: (%s) needs" % (i, deps_map[i]["action"])
797 needs = deps_map[i]["needs"]
798 for j in sorted(needs):
799 print " %s" % (j)
800 if not needs:
801 print " no dependencies"
802
803
804class EmergeJobState(object):
805 __slots__ = ["done", "filename", "last_notify_timestamp", "last_output_seek",
806 "last_output_timestamp", "pkgname", "retcode", "start_timestamp",
Thiago Goncalesf4acc422013-07-17 10:26:35 -0700807 "target", "fetch_only", "unpack_only"]
David Jamesfcb70ef2011-02-02 16:02:30 -0800808
809 def __init__(self, target, pkgname, done, filename, start_timestamp,
Thiago Goncalesf4acc422013-07-17 10:26:35 -0700810 retcode=None, fetch_only=False, unpack_only=False):
David Jamesfcb70ef2011-02-02 16:02:30 -0800811
812 # The full name of the target we're building (e.g.
813 # chromeos-base/chromeos-0.0.1-r60)
814 self.target = target
815
816 # The short name of the target we're building (e.g. chromeos-0.0.1-r60)
817 self.pkgname = pkgname
818
819 # Whether the job is done. (True if the job is done; false otherwise.)
820 self.done = done
821
822 # The filename where output is currently stored.
823 self.filename = filename
824
825 # The timestamp of the last time we printed the name of the log file. We
826 # print this at the beginning of the job, so this starts at
827 # start_timestamp.
828 self.last_notify_timestamp = start_timestamp
829
830 # The location (in bytes) of the end of the last complete line we printed.
831 # This starts off at zero. We use this to jump to the right place when we
832 # print output from the same ebuild multiple times.
833 self.last_output_seek = 0
834
835 # The timestamp of the last time we printed output. Since we haven't
836 # printed output yet, this starts at zero.
837 self.last_output_timestamp = 0
838
839 # The return code of our job, if the job is actually finished.
840 self.retcode = retcode
841
Brian Harring0be85c62012-03-17 19:52:12 -0700842 # Was this just a fetch job?
843 self.fetch_only = fetch_only
844
David Jamesfcb70ef2011-02-02 16:02:30 -0800845 # The timestamp when our job started.
846 self.start_timestamp = start_timestamp
847
Thiago Goncalesf4acc422013-07-17 10:26:35 -0700848 # No emerge, only unpack packages.
849 self.unpack_only = unpack_only
850
David Jamesfcb70ef2011-02-02 16:02:30 -0800851
David James321490a2012-12-17 12:05:56 -0800852def KillHandler(_signum, _frame):
David James7358d032011-05-19 10:40:03 -0700853 # Kill self and all subprocesses.
854 os.killpg(0, signal.SIGKILL)
855
David Jamesfcb70ef2011-02-02 16:02:30 -0800856def SetupWorkerSignals():
David James321490a2012-12-17 12:05:56 -0800857 def ExitHandler(_signum, _frame):
David James7358d032011-05-19 10:40:03 -0700858 # Set KILLED flag.
859 KILLED.set()
David James13cead42011-05-18 16:22:01 -0700860
David James7358d032011-05-19 10:40:03 -0700861 # Remove our signal handlers so we don't get called recursively.
862 signal.signal(signal.SIGINT, KillHandler)
863 signal.signal(signal.SIGTERM, KillHandler)
David Jamesfcb70ef2011-02-02 16:02:30 -0800864
865 # Ensure that we exit quietly and cleanly, if possible, when we receive
866 # SIGTERM or SIGINT signals. By default, when the user hits CTRL-C, all
867 # of the child processes will print details about KeyboardInterrupt
868 # exceptions, which isn't very helpful.
869 signal.signal(signal.SIGINT, ExitHandler)
870 signal.signal(signal.SIGTERM, ExitHandler)
871
David James6b29d052012-11-02 10:27:27 -0700872def EmergeProcess(output, *args, **kwargs):
David James1ed3e252011-10-05 20:26:15 -0700873 """Merge a package in a subprocess.
874
875 Args:
David James1ed3e252011-10-05 20:26:15 -0700876 output: Temporary file to write output.
David James6b29d052012-11-02 10:27:27 -0700877 *args: Arguments to pass to Scheduler constructor.
878 **kwargs: Keyword arguments to pass to Scheduler constructor.
David James1ed3e252011-10-05 20:26:15 -0700879
880 Returns:
881 The exit code returned by the subprocess.
882 """
883 pid = os.fork()
884 if pid == 0:
885 try:
886 # Sanity checks.
887 if sys.stdout.fileno() != 1: raise Exception("sys.stdout.fileno() != 1")
888 if sys.stderr.fileno() != 2: raise Exception("sys.stderr.fileno() != 2")
889
890 # - Redirect 1 (stdout) and 2 (stderr) at our temporary file.
891 # - Redirect 0 to point at sys.stdin. In this case, sys.stdin
892 # points at a file reading os.devnull, because multiprocessing mucks
893 # with sys.stdin.
894 # - Leave the sys.stdin and output filehandles alone.
895 fd_pipes = {0: sys.stdin.fileno(),
896 1: output.fileno(),
897 2: output.fileno(),
898 sys.stdin.fileno(): sys.stdin.fileno(),
899 output.fileno(): output.fileno()}
David Jamesa249eef2013-07-19 14:03:45 -0700900 if 0 <= vercmp(portage.VERSION, "2.1.11.50"):
901 portage.process._setup_pipes(fd_pipes, close_fds=False)
902 else:
903 portage.process._setup_pipes(fd_pipes)
David James1ed3e252011-10-05 20:26:15 -0700904
905 # Portage doesn't like when sys.stdin.fileno() != 0, so point sys.stdin
906 # at the filehandle we just created in _setup_pipes.
907 if sys.stdin.fileno() != 0:
David James6b29d052012-11-02 10:27:27 -0700908 sys.__stdin__ = sys.stdin = os.fdopen(0, "r")
909
910 scheduler = Scheduler(*args, **kwargs)
911
912 # Enable blocker handling even though we're in --nodeps mode. This
913 # allows us to unmerge the blocker after we've merged the replacement.
914 scheduler._opts_ignore_blockers = frozenset()
David James1ed3e252011-10-05 20:26:15 -0700915
916 # Actually do the merge.
917 retval = scheduler.merge()
918
919 # We catch all exceptions here (including SystemExit, KeyboardInterrupt,
920 # etc) so as to ensure that we don't confuse the multiprocessing module,
921 # which expects that all forked children exit with os._exit().
David James321490a2012-12-17 12:05:56 -0800922 # pylint: disable=W0702
David James1ed3e252011-10-05 20:26:15 -0700923 except:
924 traceback.print_exc(file=output)
925 retval = 1
926 sys.stdout.flush()
927 sys.stderr.flush()
928 output.flush()
929 os._exit(retval)
930 else:
931 # Return the exit code of the subprocess.
932 return os.waitpid(pid, 0)[1]
David Jamesfcb70ef2011-02-02 16:02:30 -0800933
Thiago Goncalesf4acc422013-07-17 10:26:35 -0700934
935def UnpackPackage(pkg_state):
936 """Unpacks package described by pkg_state.
937
938 Args:
939 pkg_state: EmergeJobState object describing target.
940
941 Returns:
942 Exit code returned by subprocess.
943 """
944 pkgdir = os.environ.get("PKGDIR",
945 os.path.join(os.environ["SYSROOT"], "packages"))
946 root = os.environ.get("ROOT", os.environ["SYSROOT"])
947 path = os.path.join(pkgdir, pkg_state.target + ".tbz2")
948 comp = cros_build_lib.FindCompressor(cros_build_lib.COMP_BZIP2)
949 cmd = [comp, "-dc"]
950 if comp.endswith("pbzip2"):
951 cmd.append("--ignore-trailing-garbage=1")
952 cmd.append(path)
953
954 result = cros_build_lib.RunCommand(cmd, cwd=root, stdout_to_pipe=True,
955 print_cmd=False, error_code_ok=True)
956
957 # If we were not successful, return now and don't attempt untar.
958 if result.returncode:
959 return result.returncode
960
961 cmd = ["sudo", "tar", "-xf", "-", "-C", root]
962 result = cros_build_lib.RunCommand(cmd, cwd=root, input=result.output,
963 print_cmd=False, error_code_ok=True)
964
965 return result.returncode
966
967
968def EmergeWorker(task_queue, job_queue, emerge, package_db, fetch_only=False,
969 unpack_only=False):
David Jamesfcb70ef2011-02-02 16:02:30 -0800970 """This worker emerges any packages given to it on the task_queue.
971
972 Args:
973 task_queue: The queue of tasks for this worker to do.
974 job_queue: The queue of results from the worker.
975 emerge: An EmergeData() object.
976 package_db: A dict, mapping package ids to portage Package objects.
Brian Harring0be85c62012-03-17 19:52:12 -0700977 fetch_only: A bool, indicating if we should just fetch the target.
Thiago Goncalesf4acc422013-07-17 10:26:35 -0700978 unpack_only: A bool, indicating if we should just unpack the target.
David Jamesfcb70ef2011-02-02 16:02:30 -0800979
980 It expects package identifiers to be passed to it via task_queue. When
981 a task is started, it pushes the (target, filename) to the started_queue.
982 The output is stored in filename. When a merge starts or finishes, we push
983 EmergeJobState objects to the job_queue.
984 """
985
986 SetupWorkerSignals()
987 settings, trees, mtimedb = emerge.settings, emerge.trees, emerge.mtimedb
David Jamesdeebd692011-05-09 17:02:52 -0700988
989 # Disable flushing of caches to save on I/O.
David James7a1ea4b2011-10-13 15:06:41 -0700990 root = emerge.settings["ROOT"]
991 vardb = emerge.trees[root]["vartree"].dbapi
992 vardb._flush_cache_enabled = False
Brian Harring0be85c62012-03-17 19:52:12 -0700993 bindb = emerge.trees[root]["bintree"].dbapi
994 # Might be a set, might be a list, might be None; no clue, just use shallow
995 # copy to ensure we can roll it back.
996 original_remotepkgs = copy.copy(bindb.bintree._remotepkgs)
David Jamesdeebd692011-05-09 17:02:52 -0700997
David Jamesfcb70ef2011-02-02 16:02:30 -0800998 opts, spinner = emerge.opts, emerge.spinner
999 opts["--nodeps"] = True
Brian Harring0be85c62012-03-17 19:52:12 -07001000 if fetch_only:
1001 opts["--fetchonly"] = True
1002
David Jamesfcb70ef2011-02-02 16:02:30 -08001003 while True:
1004 # Wait for a new item to show up on the queue. This is a blocking wait,
1005 # so if there's nothing to do, we just sit here.
Brian Harring0be85c62012-03-17 19:52:12 -07001006 pkg_state = task_queue.get()
1007 if pkg_state is None:
David Jamesfcb70ef2011-02-02 16:02:30 -08001008 # If target is None, this means that the main thread wants us to quit.
1009 # The other workers need to exit too, so we'll push the message back on
1010 # to the queue so they'll get it too.
Brian Harring0be85c62012-03-17 19:52:12 -07001011 task_queue.put(None)
David Jamesfcb70ef2011-02-02 16:02:30 -08001012 return
David James7358d032011-05-19 10:40:03 -07001013 if KILLED.is_set():
1014 return
1015
Brian Harring0be85c62012-03-17 19:52:12 -07001016 target = pkg_state.target
1017
David Jamesfcb70ef2011-02-02 16:02:30 -08001018 db_pkg = package_db[target]
Brian Harring0be85c62012-03-17 19:52:12 -07001019
1020 if db_pkg.type_name == "binary":
1021 if not fetch_only and pkg_state.fetched_successfully:
1022 # Ensure portage doesn't think our pkg is remote- else it'll force
1023 # a redownload of it (even if the on-disk file is fine). In-memory
1024 # caching basically, implemented dumbly.
1025 bindb.bintree._remotepkgs = None
1026 else:
1027 bindb.bintree_remotepkgs = original_remotepkgs
1028
David Jamesfcb70ef2011-02-02 16:02:30 -08001029 db_pkg.root_config = emerge.root_config
1030 install_list = [db_pkg]
1031 pkgname = db_pkg.pf
1032 output = tempfile.NamedTemporaryFile(prefix=pkgname + "-", delete=False)
David James01b1e0f2012-06-07 17:18:05 -07001033 os.chmod(output.name, 644)
David Jamesfcb70ef2011-02-02 16:02:30 -08001034 start_timestamp = time.time()
Brian Harring0be85c62012-03-17 19:52:12 -07001035 job = EmergeJobState(target, pkgname, False, output.name, start_timestamp,
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001036 fetch_only=fetch_only, unpack_only=unpack_only)
David Jamesfcb70ef2011-02-02 16:02:30 -08001037 job_queue.put(job)
1038 if "--pretend" in opts:
1039 retcode = 0
1040 else:
David Jamesfcb70ef2011-02-02 16:02:30 -08001041 try:
David James386ccd12011-05-04 20:17:42 -07001042 emerge.scheduler_graph.mergelist = install_list
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001043 if unpack_only:
1044 retcode = UnpackPackage(pkg_state)
1045 else:
1046 retcode = EmergeProcess(output, settings, trees, mtimedb, opts,
1047 spinner, favorites=emerge.favorites,
1048 graph_config=emerge.scheduler_graph)
David Jamesfcb70ef2011-02-02 16:02:30 -08001049 except Exception:
1050 traceback.print_exc(file=output)
1051 retcode = 1
David James1ed3e252011-10-05 20:26:15 -07001052 output.close()
David Jamesfcb70ef2011-02-02 16:02:30 -08001053
David James7358d032011-05-19 10:40:03 -07001054 if KILLED.is_set():
1055 return
1056
David Jamesfcb70ef2011-02-02 16:02:30 -08001057 job = EmergeJobState(target, pkgname, True, output.name, start_timestamp,
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001058 retcode, fetch_only=fetch_only,
1059 unpack_only=unpack_only)
David Jamesfcb70ef2011-02-02 16:02:30 -08001060 job_queue.put(job)
1061
1062
1063class LinePrinter(object):
1064 """Helper object to print a single line."""
1065
1066 def __init__(self, line):
1067 self.line = line
1068
David James321490a2012-12-17 12:05:56 -08001069 def Print(self, _seek_locations):
David Jamesfcb70ef2011-02-02 16:02:30 -08001070 print self.line
1071
1072
1073class JobPrinter(object):
1074 """Helper object to print output of a job."""
1075
1076 def __init__(self, job, unlink=False):
1077 """Print output of job.
1078
1079 If unlink is True, unlink the job output file when done."""
1080 self.current_time = time.time()
1081 self.job = job
1082 self.unlink = unlink
1083
1084 def Print(self, seek_locations):
1085
1086 job = self.job
1087
1088 # Calculate how long the job has been running.
1089 seconds = self.current_time - job.start_timestamp
1090
1091 # Note that we've printed out the job so far.
1092 job.last_output_timestamp = self.current_time
1093
1094 # Note that we're starting the job
1095 info = "job %s (%dm%.1fs)" % (job.pkgname, seconds / 60, seconds % 60)
1096 last_output_seek = seek_locations.get(job.filename, 0)
1097 if last_output_seek:
1098 print "=== Continue output for %s ===" % info
1099 else:
1100 print "=== Start output for %s ===" % info
1101
1102 # Print actual output from job
1103 f = codecs.open(job.filename, encoding='utf-8', errors='replace')
1104 f.seek(last_output_seek)
1105 prefix = job.pkgname + ":"
1106 for line in f:
1107
1108 # Save off our position in the file
1109 if line and line[-1] == "\n":
1110 last_output_seek = f.tell()
1111 line = line[:-1]
1112
1113 # Print our line
1114 print prefix, line.encode('utf-8', 'replace')
1115 f.close()
1116
1117 # Save our last spot in the file so that we don't print out the same
1118 # location twice.
1119 seek_locations[job.filename] = last_output_seek
1120
1121 # Note end of output section
1122 if job.done:
1123 print "=== Complete: %s ===" % info
1124 else:
1125 print "=== Still running: %s ===" % info
1126
1127 if self.unlink:
1128 os.unlink(job.filename)
1129
1130
1131def PrintWorker(queue):
1132 """A worker that prints stuff to the screen as requested."""
1133
David James321490a2012-12-17 12:05:56 -08001134 def ExitHandler(_signum, _frame):
David James7358d032011-05-19 10:40:03 -07001135 # Set KILLED flag.
1136 KILLED.set()
1137
David Jamesfcb70ef2011-02-02 16:02:30 -08001138 # Switch to default signal handlers so that we'll die after two signals.
David James7358d032011-05-19 10:40:03 -07001139 signal.signal(signal.SIGINT, KillHandler)
1140 signal.signal(signal.SIGTERM, KillHandler)
David Jamesfcb70ef2011-02-02 16:02:30 -08001141
1142 # Don't exit on the first SIGINT / SIGTERM, because the parent worker will
1143 # handle it and tell us when we need to exit.
1144 signal.signal(signal.SIGINT, ExitHandler)
1145 signal.signal(signal.SIGTERM, ExitHandler)
1146
1147 # seek_locations is a map indicating the position we are at in each file.
1148 # It starts off empty, but is set by the various Print jobs as we go along
1149 # to indicate where we left off in each file.
1150 seek_locations = {}
1151 while True:
1152 try:
1153 job = queue.get()
1154 if job:
1155 job.Print(seek_locations)
David Jamesbccf8eb2011-07-27 14:06:06 -07001156 sys.stdout.flush()
David Jamesfcb70ef2011-02-02 16:02:30 -08001157 else:
1158 break
1159 except IOError as ex:
1160 if ex.errno == errno.EINTR:
1161 # Looks like we received a signal. Keep printing.
1162 continue
1163 raise
1164
Brian Harring867e2362012-03-17 04:05:17 -07001165
Brian Harring0be85c62012-03-17 19:52:12 -07001166class TargetState(object):
Brian Harring867e2362012-03-17 04:05:17 -07001167
Brian Harring0be85c62012-03-17 19:52:12 -07001168 __slots__ = ("target", "info", "score", "prefetched", "fetched_successfully")
Brian Harring867e2362012-03-17 04:05:17 -07001169
David James321490a2012-12-17 12:05:56 -08001170 def __init__(self, target, info):
Brian Harring867e2362012-03-17 04:05:17 -07001171 self.target, self.info = target, info
Brian Harring0be85c62012-03-17 19:52:12 -07001172 self.fetched_successfully = False
1173 self.prefetched = False
David James321490a2012-12-17 12:05:56 -08001174 self.score = None
Brian Harring867e2362012-03-17 04:05:17 -07001175 self.update_score()
1176
1177 def __cmp__(self, other):
1178 return cmp(self.score, other.score)
1179
1180 def update_score(self):
1181 self.score = (
1182 -len(self.info["tprovides"]),
Brian Harring0be85c62012-03-17 19:52:12 -07001183 len(self.info["needs"]),
Brian Harring11c5eeb2012-03-18 11:02:39 -07001184 not self.info["binary"],
Brian Harring867e2362012-03-17 04:05:17 -07001185 -len(self.info["provides"]),
1186 self.info["idx"],
1187 self.target,
1188 )
1189
1190
1191class ScoredHeap(object):
1192
Brian Harring0be85c62012-03-17 19:52:12 -07001193 __slots__ = ("heap", "_heap_set")
1194
Brian Harring867e2362012-03-17 04:05:17 -07001195 def __init__(self, initial=()):
Brian Harring0be85c62012-03-17 19:52:12 -07001196 self.heap = list()
1197 self._heap_set = set()
1198 if initial:
1199 self.multi_put(initial)
Brian Harring867e2362012-03-17 04:05:17 -07001200
1201 def get(self):
Brian Harring0be85c62012-03-17 19:52:12 -07001202 item = heapq.heappop(self.heap)
1203 self._heap_set.remove(item.target)
1204 return item
Brian Harring867e2362012-03-17 04:05:17 -07001205
Brian Harring0be85c62012-03-17 19:52:12 -07001206 def put(self, item):
1207 if not isinstance(item, TargetState):
1208 raise ValueError("Item %r isn't a TargetState" % (item,))
1209 heapq.heappush(self.heap, item)
1210 self._heap_set.add(item.target)
Brian Harring867e2362012-03-17 04:05:17 -07001211
Brian Harring0be85c62012-03-17 19:52:12 -07001212 def multi_put(self, sequence):
1213 sequence = list(sequence)
1214 self.heap.extend(sequence)
1215 self._heap_set.update(x.target for x in sequence)
Brian Harring867e2362012-03-17 04:05:17 -07001216 self.sort()
1217
David James5c9996d2012-03-24 10:50:46 -07001218 def sort(self):
1219 heapq.heapify(self.heap)
1220
Brian Harring0be85c62012-03-17 19:52:12 -07001221 def __contains__(self, target):
1222 return target in self._heap_set
1223
1224 def __nonzero__(self):
1225 return bool(self.heap)
1226
Brian Harring867e2362012-03-17 04:05:17 -07001227 def __len__(self):
1228 return len(self.heap)
1229
1230
David Jamesfcb70ef2011-02-02 16:02:30 -08001231class EmergeQueue(object):
1232 """Class to schedule emerge jobs according to a dependency graph."""
1233
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001234 def __init__(self, deps_map, emerge, package_db, show_output, unpack_only):
David Jamesfcb70ef2011-02-02 16:02:30 -08001235 # Store the dependency graph.
1236 self._deps_map = deps_map
Brian Harring0be85c62012-03-17 19:52:12 -07001237 self._state_map = {}
David Jamesfcb70ef2011-02-02 16:02:30 -08001238 # Initialize the running queue to empty
Brian Harring0be85c62012-03-17 19:52:12 -07001239 self._build_jobs = {}
1240 self._build_ready = ScoredHeap()
1241 self._fetch_jobs = {}
1242 self._fetch_ready = ScoredHeap()
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001243 self._unpack_jobs = {}
1244 self._unpack_ready = ScoredHeap()
David Jamesfcb70ef2011-02-02 16:02:30 -08001245 # List of total package installs represented in deps_map.
1246 install_jobs = [x for x in deps_map if deps_map[x]["action"] == "merge"]
1247 self._total_jobs = len(install_jobs)
1248 self._show_output = show_output
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001249 self._unpack_only = unpack_only
David Jamesfcb70ef2011-02-02 16:02:30 -08001250
1251 if "--pretend" in emerge.opts:
1252 print "Skipping merge because of --pretend mode."
1253 sys.exit(0)
1254
David James7358d032011-05-19 10:40:03 -07001255 # Set a process group so we can easily terminate all children.
1256 os.setsid()
1257
David Jamesfcb70ef2011-02-02 16:02:30 -08001258 # Setup scheduler graph object. This is used by the child processes
1259 # to help schedule jobs.
1260 emerge.scheduler_graph = emerge.depgraph.schedulerGraph()
1261
1262 # Calculate how many jobs we can run in parallel. We don't want to pass
1263 # the --jobs flag over to emerge itself, because that'll tell emerge to
1264 # hide its output, and said output is quite useful for debugging hung
1265 # jobs.
1266 procs = min(self._total_jobs,
1267 emerge.opts.pop("--jobs", multiprocessing.cpu_count()))
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001268 self._build_procs = self._unpack_procs = self._fetch_procs = max(1, procs)
David James8c7e5e32011-06-28 11:26:03 -07001269 self._load_avg = emerge.opts.pop("--load-average", None)
David Jamesfcb70ef2011-02-02 16:02:30 -08001270 self._job_queue = multiprocessing.Queue()
1271 self._print_queue = multiprocessing.Queue()
Brian Harring0be85c62012-03-17 19:52:12 -07001272
1273 self._fetch_queue = multiprocessing.Queue()
1274 args = (self._fetch_queue, self._job_queue, emerge, package_db, True)
1275 self._fetch_pool = multiprocessing.Pool(self._fetch_procs, EmergeWorker,
1276 args)
1277
1278 self._build_queue = multiprocessing.Queue()
1279 args = (self._build_queue, self._job_queue, emerge, package_db)
1280 self._build_pool = multiprocessing.Pool(self._build_procs, EmergeWorker,
1281 args)
1282
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001283 if self._unpack_only:
1284 # Unpack pool only required on unpack_only jobs.
1285 self._unpack_queue = multiprocessing.Queue()
1286 args = (self._unpack_queue, self._job_queue, emerge, package_db, False,
1287 True)
1288 self._unpack_pool = multiprocessing.Pool(self._unpack_procs, EmergeWorker,
1289 args)
1290
David Jamesfcb70ef2011-02-02 16:02:30 -08001291 self._print_worker = multiprocessing.Process(target=PrintWorker,
1292 args=[self._print_queue])
1293 self._print_worker.start()
1294
1295 # Initialize the failed queue to empty.
1296 self._retry_queue = []
1297 self._failed = set()
1298
David Jamesfcb70ef2011-02-02 16:02:30 -08001299 # Setup an exit handler so that we print nice messages if we are
1300 # terminated.
1301 self._SetupExitHandler()
1302
1303 # Schedule our jobs.
Brian Harring0be85c62012-03-17 19:52:12 -07001304 self._state_map.update(
1305 (pkg, TargetState(pkg, data)) for pkg, data in deps_map.iteritems())
1306 self._fetch_ready.multi_put(self._state_map.itervalues())
David Jamesfcb70ef2011-02-02 16:02:30 -08001307
1308 def _SetupExitHandler(self):
1309
David James321490a2012-12-17 12:05:56 -08001310 def ExitHandler(signum, _frame):
David James7358d032011-05-19 10:40:03 -07001311 # Set KILLED flag.
1312 KILLED.set()
David Jamesfcb70ef2011-02-02 16:02:30 -08001313
1314 # Kill our signal handlers so we don't get called recursively
David James7358d032011-05-19 10:40:03 -07001315 signal.signal(signal.SIGINT, KillHandler)
1316 signal.signal(signal.SIGTERM, KillHandler)
David Jamesfcb70ef2011-02-02 16:02:30 -08001317
1318 # Print our current job status
Brian Harring0be85c62012-03-17 19:52:12 -07001319 for job in self._build_jobs.itervalues():
David Jamesfcb70ef2011-02-02 16:02:30 -08001320 if job:
1321 self._print_queue.put(JobPrinter(job, unlink=True))
1322
1323 # Notify the user that we are exiting
1324 self._Print("Exiting on signal %s" % signum)
David James7358d032011-05-19 10:40:03 -07001325 self._print_queue.put(None)
1326 self._print_worker.join()
David Jamesfcb70ef2011-02-02 16:02:30 -08001327
1328 # Kill child threads, then exit.
David James7358d032011-05-19 10:40:03 -07001329 os.killpg(0, signal.SIGKILL)
David Jamesfcb70ef2011-02-02 16:02:30 -08001330 sys.exit(1)
1331
1332 # Print out job status when we are killed
1333 signal.signal(signal.SIGINT, ExitHandler)
1334 signal.signal(signal.SIGTERM, ExitHandler)
1335
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001336 def _ScheduleUnpack(self, pkg_state):
1337 self._unpack_jobs[pkg_state.target] = None
1338 self._unpack_queue.put(pkg_state)
1339
Brian Harring0be85c62012-03-17 19:52:12 -07001340 def _Schedule(self, pkg_state):
David Jamesfcb70ef2011-02-02 16:02:30 -08001341 # We maintain a tree of all deps, if this doesn't need
David James8c7e5e32011-06-28 11:26:03 -07001342 # to be installed just free up its children and continue.
David Jamesfcb70ef2011-02-02 16:02:30 -08001343 # It is possible to reinstall deps of deps, without reinstalling
1344 # first level deps, like so:
1345 # chromeos (merge) -> eselect (nomerge) -> python (merge)
Brian Harring0be85c62012-03-17 19:52:12 -07001346 this_pkg = pkg_state.info
1347 target = pkg_state.target
1348 if pkg_state.info is not None:
1349 if this_pkg["action"] == "nomerge":
1350 self._Finish(target)
1351 elif target not in self._build_jobs:
1352 # Kick off the build if it's marked to be built.
1353 self._build_jobs[target] = None
1354 self._build_queue.put(pkg_state)
1355 return True
David Jamesfcb70ef2011-02-02 16:02:30 -08001356
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001357 def _ScheduleLoop(self, unpack_only=False):
1358 if unpack_only:
1359 ready_queue = self._unpack_ready
1360 jobs_queue = self._unpack_jobs
1361 procs = self._unpack_procs
1362 else:
1363 ready_queue = self._build_ready
1364 jobs_queue = self._build_jobs
1365 procs = self._build_procs
1366
David James8c7e5e32011-06-28 11:26:03 -07001367 # If the current load exceeds our desired load average, don't schedule
1368 # more than one job.
1369 if self._load_avg and os.getloadavg()[0] > self._load_avg:
1370 needed_jobs = 1
1371 else:
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001372 needed_jobs = procs
David James8c7e5e32011-06-28 11:26:03 -07001373
1374 # Schedule more jobs.
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001375 while ready_queue and len(jobs_queue) < needed_jobs:
1376 state = ready_queue.get()
1377 if unpack_only:
1378 self._ScheduleUnpack(state)
1379 else:
1380 if state.target not in self._failed:
1381 self._Schedule(state)
David Jamesfcb70ef2011-02-02 16:02:30 -08001382
1383 def _Print(self, line):
1384 """Print a single line."""
1385 self._print_queue.put(LinePrinter(line))
1386
1387 def _Status(self):
1388 """Print status."""
1389 current_time = time.time()
1390 no_output = True
1391
1392 # Print interim output every minute if --show-output is used. Otherwise,
1393 # print notifications about running packages every 2 minutes, and print
1394 # full output for jobs that have been running for 60 minutes or more.
1395 if self._show_output:
1396 interval = 60
1397 notify_interval = 0
1398 else:
1399 interval = 60 * 60
1400 notify_interval = 60 * 2
David James321490a2012-12-17 12:05:56 -08001401 for job in self._build_jobs.itervalues():
David Jamesfcb70ef2011-02-02 16:02:30 -08001402 if job:
1403 last_timestamp = max(job.start_timestamp, job.last_output_timestamp)
1404 if last_timestamp + interval < current_time:
1405 self._print_queue.put(JobPrinter(job))
1406 job.last_output_timestamp = current_time
1407 no_output = False
1408 elif (notify_interval and
1409 job.last_notify_timestamp + notify_interval < current_time):
1410 job_seconds = current_time - job.start_timestamp
1411 args = (job.pkgname, job_seconds / 60, job_seconds % 60, job.filename)
1412 info = "Still building %s (%dm%.1fs). Logs in %s" % args
1413 job.last_notify_timestamp = current_time
1414 self._Print(info)
1415 no_output = False
1416
1417 # If we haven't printed any messages yet, print a general status message
1418 # here.
1419 if no_output:
1420 seconds = current_time - GLOBAL_START
Brian Harring0be85c62012-03-17 19:52:12 -07001421 fjobs, fready = len(self._fetch_jobs), len(self._fetch_ready)
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001422 ujobs, uready = len(self._unpack_jobs), len(self._unpack_ready)
Brian Harring0be85c62012-03-17 19:52:12 -07001423 bjobs, bready = len(self._build_jobs), len(self._build_ready)
1424 retries = len(self._retry_queue)
1425 pending = max(0, len(self._deps_map) - fjobs - bjobs)
1426 line = "Pending %s/%s, " % (pending, self._total_jobs)
1427 if fjobs or fready:
1428 line += "Fetching %s/%s, " % (fjobs, fready + fjobs)
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001429 if ujobs or uready:
1430 line += "Unpacking %s/%s, " % (ujobs, uready + ujobs)
Brian Harring0be85c62012-03-17 19:52:12 -07001431 if bjobs or bready or retries:
1432 line += "Building %s/%s, " % (bjobs, bready + bjobs)
1433 if retries:
1434 line += "Retrying %s, " % (retries,)
David James8c7e5e32011-06-28 11:26:03 -07001435 load = " ".join(str(x) for x in os.getloadavg())
Brian Harring0be85c62012-03-17 19:52:12 -07001436 line += ("[Time %dm%.1fs Load %s]" % (seconds/60, seconds %60, load))
1437 self._Print(line)
David Jamesfcb70ef2011-02-02 16:02:30 -08001438
1439 def _Finish(self, target):
David James8c7e5e32011-06-28 11:26:03 -07001440 """Mark a target as completed and unblock dependencies."""
1441 this_pkg = self._deps_map[target]
1442 if this_pkg["needs"] and this_pkg["nodeps"]:
1443 # We got installed, but our deps have not been installed yet. Dependent
1444 # packages should only be installed when our needs have been fully met.
1445 this_pkg["action"] = "nomerge"
1446 else:
David James8c7e5e32011-06-28 11:26:03 -07001447 for dep in this_pkg["provides"]:
1448 dep_pkg = self._deps_map[dep]
Brian Harring0be85c62012-03-17 19:52:12 -07001449 state = self._state_map[dep]
David James8c7e5e32011-06-28 11:26:03 -07001450 del dep_pkg["needs"][target]
Brian Harring0be85c62012-03-17 19:52:12 -07001451 state.update_score()
1452 if not state.prefetched:
1453 if dep in self._fetch_ready:
1454 # If it's not currently being fetched, update the prioritization
1455 self._fetch_ready.sort()
1456 elif not dep_pkg["needs"]:
David James8c7e5e32011-06-28 11:26:03 -07001457 if dep_pkg["nodeps"] and dep_pkg["action"] == "nomerge":
1458 self._Finish(dep)
1459 else:
Brian Harring0be85c62012-03-17 19:52:12 -07001460 self._build_ready.put(self._state_map[dep])
David James8c7e5e32011-06-28 11:26:03 -07001461 self._deps_map.pop(target)
David Jamesfcb70ef2011-02-02 16:02:30 -08001462
1463 def _Retry(self):
David James8c7e5e32011-06-28 11:26:03 -07001464 while self._retry_queue:
Brian Harring0be85c62012-03-17 19:52:12 -07001465 state = self._retry_queue.pop(0)
1466 if self._Schedule(state):
1467 self._Print("Retrying emerge of %s." % state.target)
David James8c7e5e32011-06-28 11:26:03 -07001468 break
David Jamesfcb70ef2011-02-02 16:02:30 -08001469
Brian Harringa43f5952012-04-12 01:19:34 -07001470 def _Shutdown(self):
David Jamesfcb70ef2011-02-02 16:02:30 -08001471 # Tell emerge workers to exit. They all exit when 'None' is pushed
1472 # to the queue.
Brian Harring0be85c62012-03-17 19:52:12 -07001473
Brian Harringa43f5952012-04-12 01:19:34 -07001474 # Shutdown the workers first; then jobs (which is how they feed things back)
1475 # then finally the print queue.
Brian Harring0be85c62012-03-17 19:52:12 -07001476
Brian Harringa43f5952012-04-12 01:19:34 -07001477 def _stop(queue, pool):
1478 if pool is None:
1479 return
1480 try:
1481 queue.put(None)
1482 pool.close()
1483 pool.join()
1484 finally:
1485 pool.terminate()
Brian Harring0be85c62012-03-17 19:52:12 -07001486
Brian Harringa43f5952012-04-12 01:19:34 -07001487 _stop(self._fetch_queue, self._fetch_pool)
1488 self._fetch_queue = self._fetch_pool = None
Brian Harring0be85c62012-03-17 19:52:12 -07001489
Brian Harringa43f5952012-04-12 01:19:34 -07001490 _stop(self._build_queue, self._build_pool)
1491 self._build_queue = self._build_pool = None
1492
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001493 if self._unpack_only:
1494 _stop(self._unpack_queue, self._unpack_pool)
1495 self._unpack_queue = self._unpack_pool = None
1496
Brian Harringa43f5952012-04-12 01:19:34 -07001497 if self._job_queue is not None:
1498 self._job_queue.close()
1499 self._job_queue = None
David Jamesfcb70ef2011-02-02 16:02:30 -08001500
1501 # Now that our workers are finished, we can kill the print queue.
Brian Harringa43f5952012-04-12 01:19:34 -07001502 if self._print_worker is not None:
1503 try:
1504 self._print_queue.put(None)
1505 self._print_queue.close()
1506 self._print_worker.join()
1507 finally:
1508 self._print_worker.terminate()
1509 self._print_queue = self._print_worker = None
David Jamesfcb70ef2011-02-02 16:02:30 -08001510
1511 def Run(self):
1512 """Run through the scheduled ebuilds.
1513
1514 Keep running so long as we have uninstalled packages in the
1515 dependency graph to merge.
1516 """
Brian Harringa43f5952012-04-12 01:19:34 -07001517 if not self._deps_map:
1518 return
1519
Brian Harring0be85c62012-03-17 19:52:12 -07001520 # Start the fetchers.
1521 for _ in xrange(min(self._fetch_procs, len(self._fetch_ready))):
1522 state = self._fetch_ready.get()
1523 self._fetch_jobs[state.target] = None
1524 self._fetch_queue.put(state)
1525
1526 # Print an update, then get going.
1527 self._Status()
1528
David Jamese703d0f2012-01-12 16:27:45 -08001529 retried = set()
David Jamesfcb70ef2011-02-02 16:02:30 -08001530 while self._deps_map:
1531 # Check here that we are actually waiting for something.
Brian Harring0be85c62012-03-17 19:52:12 -07001532 if (self._build_queue.empty() and
David Jamesfcb70ef2011-02-02 16:02:30 -08001533 self._job_queue.empty() and
Brian Harring0be85c62012-03-17 19:52:12 -07001534 not self._fetch_jobs and
1535 not self._fetch_ready and
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001536 not self._unpack_jobs and
1537 not self._unpack_ready and
Brian Harring0be85c62012-03-17 19:52:12 -07001538 not self._build_jobs and
1539 not self._build_ready and
David Jamesfcb70ef2011-02-02 16:02:30 -08001540 self._deps_map):
1541 # If we have failed on a package, retry it now.
1542 if self._retry_queue:
1543 self._Retry()
1544 else:
David Jamesfcb70ef2011-02-02 16:02:30 -08001545 # Tell the user why we're exiting.
1546 if self._failed:
Mike Frysingerf2ff9172012-11-01 18:47:41 -04001547 print 'Packages failed:\n\t%s' % '\n\t'.join(self._failed)
David James0eae23e2012-07-03 15:04:25 -07001548 status_file = os.environ.get("PARALLEL_EMERGE_STATUS_FILE")
1549 if status_file:
David James321490a2012-12-17 12:05:56 -08001550 failed_pkgs = set(portage.versions.cpv_getkey(x)
1551 for x in self._failed)
David James0eae23e2012-07-03 15:04:25 -07001552 with open(status_file, "a") as f:
1553 f.write("%s\n" % " ".join(failed_pkgs))
David Jamesfcb70ef2011-02-02 16:02:30 -08001554 else:
1555 print "Deadlock! Circular dependencies!"
1556 sys.exit(1)
1557
David James321490a2012-12-17 12:05:56 -08001558 for _ in xrange(12):
David Jamesa74289a2011-08-12 10:41:24 -07001559 try:
1560 job = self._job_queue.get(timeout=5)
1561 break
1562 except Queue.Empty:
1563 # Check if any more jobs can be scheduled.
1564 self._ScheduleLoop()
1565 else:
Brian Harring706747c2012-03-16 03:04:31 -07001566 # Print an update every 60 seconds.
David Jamesfcb70ef2011-02-02 16:02:30 -08001567 self._Status()
1568 continue
1569
1570 target = job.target
1571
Brian Harring0be85c62012-03-17 19:52:12 -07001572 if job.fetch_only:
1573 if not job.done:
1574 self._fetch_jobs[job.target] = job
1575 else:
1576 state = self._state_map[job.target]
1577 state.prefetched = True
1578 state.fetched_successfully = (job.retcode == 0)
1579 del self._fetch_jobs[job.target]
1580 self._Print("Fetched %s in %2.2fs"
1581 % (target, time.time() - job.start_timestamp))
1582
1583 if self._show_output or job.retcode != 0:
1584 self._print_queue.put(JobPrinter(job, unlink=True))
1585 else:
1586 os.unlink(job.filename)
1587 # Failure or not, let build work with it next.
1588 if not self._deps_map[job.target]["needs"]:
1589 self._build_ready.put(state)
1590 self._ScheduleLoop()
1591
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001592 if self._unpack_only and job.retcode == 0:
1593 self._unpack_ready.put(state)
1594 self._ScheduleLoop(unpack_only=True)
1595
Brian Harring0be85c62012-03-17 19:52:12 -07001596 if self._fetch_ready:
1597 state = self._fetch_ready.get()
1598 self._fetch_queue.put(state)
1599 self._fetch_jobs[state.target] = None
1600 else:
1601 # Minor optimization; shut down fetchers early since we know
1602 # the queue is empty.
1603 self._fetch_queue.put(None)
1604 continue
1605
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001606 if job.unpack_only:
1607 if not job.done:
1608 self._unpack_jobs[target] = job
1609 else:
1610 del self._unpack_jobs[target]
1611 self._Print("Unpacked %s in %2.2fs"
1612 % (target, time.time() - job.start_timestamp))
1613 if self._show_output or job.retcode != 0:
1614 self._print_queue.put(JobPrinter(job, unlink=True))
1615 else:
1616 os.unlink(job.filename)
1617 if self._unpack_ready:
1618 state = self._unpack_ready.get()
1619 self._unpack_queue.put(state)
1620 self._unpack_jobs[state.target] = None
1621 continue
1622
David Jamesfcb70ef2011-02-02 16:02:30 -08001623 if not job.done:
Brian Harring0be85c62012-03-17 19:52:12 -07001624 self._build_jobs[target] = job
David Jamesfcb70ef2011-02-02 16:02:30 -08001625 self._Print("Started %s (logged in %s)" % (target, job.filename))
1626 continue
1627
1628 # Print output of job
1629 if self._show_output or job.retcode != 0:
1630 self._print_queue.put(JobPrinter(job, unlink=True))
1631 else:
1632 os.unlink(job.filename)
Brian Harring0be85c62012-03-17 19:52:12 -07001633 del self._build_jobs[target]
David Jamesfcb70ef2011-02-02 16:02:30 -08001634
1635 seconds = time.time() - job.start_timestamp
1636 details = "%s (in %dm%.1fs)" % (target, seconds / 60, seconds % 60)
David James32420cc2011-08-25 21:32:46 -07001637 previously_failed = target in self._failed
David Jamesfcb70ef2011-02-02 16:02:30 -08001638
1639 # Complain if necessary.
1640 if job.retcode != 0:
1641 # Handle job failure.
David James32420cc2011-08-25 21:32:46 -07001642 if previously_failed:
David Jamesfcb70ef2011-02-02 16:02:30 -08001643 # If this job has failed previously, give up.
1644 self._Print("Failed %s. Your build has failed." % details)
1645 else:
1646 # Queue up this build to try again after a long while.
David Jamese703d0f2012-01-12 16:27:45 -08001647 retried.add(target)
Brian Harring0be85c62012-03-17 19:52:12 -07001648 self._retry_queue.append(self._state_map[target])
David Jamesfcb70ef2011-02-02 16:02:30 -08001649 self._failed.add(target)
1650 self._Print("Failed %s, retrying later." % details)
1651 else:
David James32420cc2011-08-25 21:32:46 -07001652 if previously_failed:
1653 # Remove target from list of failed packages.
1654 self._failed.remove(target)
1655
1656 self._Print("Completed %s" % details)
1657
1658 # Mark as completed and unblock waiting ebuilds.
1659 self._Finish(target)
1660
1661 if previously_failed and self._retry_queue:
David Jamesfcb70ef2011-02-02 16:02:30 -08001662 # If we have successfully retried a failed package, and there
1663 # are more failed packages, try the next one. We will only have
1664 # one retrying package actively running at a time.
1665 self._Retry()
1666
David Jamesfcb70ef2011-02-02 16:02:30 -08001667
David James8c7e5e32011-06-28 11:26:03 -07001668 # Schedule pending jobs and print an update.
1669 self._ScheduleLoop()
1670 self._Status()
David Jamesfcb70ef2011-02-02 16:02:30 -08001671
David Jamese703d0f2012-01-12 16:27:45 -08001672 # If packages were retried, output a warning.
1673 if retried:
1674 self._Print("")
1675 self._Print("WARNING: The following packages failed the first time,")
1676 self._Print("but succeeded upon retry. This might indicate incorrect")
1677 self._Print("dependencies.")
1678 for pkg in retried:
1679 self._Print(" %s" % pkg)
1680 self._Print("@@@STEP_WARNINGS@@@")
1681 self._Print("")
1682
David Jamesfcb70ef2011-02-02 16:02:30 -08001683 # Tell child threads to exit.
1684 self._Print("Merge complete")
David Jamesfcb70ef2011-02-02 16:02:30 -08001685
1686
Brian Harring30675052012-02-29 12:18:22 -08001687def main(argv):
Brian Harring8294d652012-05-23 02:20:52 -07001688 try:
1689 return real_main(argv)
1690 finally:
1691 # Work around multiprocessing sucking and not cleaning up after itself.
1692 # http://bugs.python.org/issue4106;
1693 # Step one; ensure GC is ran *prior* to the VM starting shutdown.
1694 gc.collect()
1695 # Step two; go looking for those threads and try to manually reap
1696 # them if we can.
1697 for x in threading.enumerate():
1698 # Filter on the name, and ident; if ident is None, the thread
1699 # wasn't started.
1700 if x.name == 'QueueFeederThread' and x.ident is not None:
1701 x.join(1)
David Jamesfcb70ef2011-02-02 16:02:30 -08001702
Brian Harring8294d652012-05-23 02:20:52 -07001703
1704def real_main(argv):
Brian Harring30675052012-02-29 12:18:22 -08001705 parallel_emerge_args = argv[:]
David Jamesfcb70ef2011-02-02 16:02:30 -08001706 deps = DepGraphGenerator()
Brian Harring30675052012-02-29 12:18:22 -08001707 deps.Initialize(parallel_emerge_args)
David Jamesfcb70ef2011-02-02 16:02:30 -08001708 emerge = deps.emerge
1709
1710 if emerge.action is not None:
Brian Harring30675052012-02-29 12:18:22 -08001711 argv = deps.ParseParallelEmergeArgs(argv)
Brian Harring8294d652012-05-23 02:20:52 -07001712 return emerge_main(argv)
David Jamesfcb70ef2011-02-02 16:02:30 -08001713 elif not emerge.cmdline_packages:
1714 Usage()
Brian Harring8294d652012-05-23 02:20:52 -07001715 return 1
David Jamesfcb70ef2011-02-02 16:02:30 -08001716
1717 # Unless we're in pretend mode, there's not much point running without
1718 # root access. We need to be able to install packages.
1719 #
1720 # NOTE: Even if you're running --pretend, it's a good idea to run
1721 # parallel_emerge with root access so that portage can write to the
1722 # dependency cache. This is important for performance.
David James321490a2012-12-17 12:05:56 -08001723 if "--pretend" not in emerge.opts and portage.data.secpass < 2:
David Jamesfcb70ef2011-02-02 16:02:30 -08001724 print "parallel_emerge: superuser access is required."
Brian Harring8294d652012-05-23 02:20:52 -07001725 return 1
David Jamesfcb70ef2011-02-02 16:02:30 -08001726
1727 if "--quiet" not in emerge.opts:
1728 cmdline_packages = " ".join(emerge.cmdline_packages)
David Jamesfcb70ef2011-02-02 16:02:30 -08001729 print "Starting fast-emerge."
1730 print " Building package %s on %s" % (cmdline_packages,
1731 deps.board or "root")
David Jamesfcb70ef2011-02-02 16:02:30 -08001732
David James386ccd12011-05-04 20:17:42 -07001733 deps_tree, deps_info = deps.GenDependencyTree()
David Jamesfcb70ef2011-02-02 16:02:30 -08001734
1735 # You want me to be verbose? I'll give you two trees! Twice as much value.
1736 if "--tree" in emerge.opts and "--verbose" in emerge.opts:
1737 deps.PrintTree(deps_tree)
1738
David James386ccd12011-05-04 20:17:42 -07001739 deps_graph = deps.GenDependencyGraph(deps_tree, deps_info)
David Jamesfcb70ef2011-02-02 16:02:30 -08001740
1741 # OK, time to print out our progress so far.
1742 deps.PrintInstallPlan(deps_graph)
1743 if "--tree" in emerge.opts:
1744 PrintDepsMap(deps_graph)
1745
1746 # Are we upgrading portage? If so, and there are more packages to merge,
1747 # schedule a restart of parallel_emerge to merge the rest. This ensures that
1748 # we pick up all updates to portage settings before merging any more
1749 # packages.
1750 portage_upgrade = False
1751 root = emerge.settings["ROOT"]
1752 final_db = emerge.depgraph._dynamic_config.mydbapi[root]
1753 if root == "/":
1754 for db_pkg in final_db.match_pkgs("sys-apps/portage"):
1755 portage_pkg = deps_graph.get(db_pkg.cpv)
David James0ff16f22012-11-02 14:18:07 -07001756 if portage_pkg:
David Jamesfcb70ef2011-02-02 16:02:30 -08001757 portage_upgrade = True
1758 if "--quiet" not in emerge.opts:
1759 print "Upgrading portage first, then restarting..."
1760
David James0ff16f22012-11-02 14:18:07 -07001761 # Upgrade Portage first, then the rest of the packages.
1762 #
1763 # In order to grant the child permission to run setsid, we need to run sudo
1764 # again. We preserve SUDO_USER here in case an ebuild depends on it.
1765 if portage_upgrade:
1766 # Calculate what arguments to use when re-invoking.
1767 args = ["sudo", "-E", "SUDO_USER=%s" % os.environ.get("SUDO_USER", "")]
1768 args += [os.path.abspath(sys.argv[0])] + parallel_emerge_args
1769 args += ["--exclude=sys-apps/portage"]
1770
1771 # First upgrade Portage.
1772 passthrough_args = ("--quiet", "--pretend", "--verbose")
1773 emerge_args = [k for k in emerge.opts if k in passthrough_args]
1774 ret = emerge_main(emerge_args + ["portage"])
1775 if ret != 0:
1776 return ret
1777
1778 # Now upgrade the rest.
1779 os.execvp(args[0], args)
1780
David Jamesfcb70ef2011-02-02 16:02:30 -08001781 # Run the queued emerges.
Thiago Goncalesf4acc422013-07-17 10:26:35 -07001782 scheduler = EmergeQueue(deps_graph, emerge, deps.package_db, deps.show_output,
1783 deps.unpack_only)
Brian Harringa43f5952012-04-12 01:19:34 -07001784 try:
1785 scheduler.Run()
1786 finally:
1787 scheduler._Shutdown()
David James97ce8902011-08-16 09:51:05 -07001788 scheduler = None
David Jamesfcb70ef2011-02-02 16:02:30 -08001789
Mike Frysingerd20a6e22012-10-04 19:01:10 -04001790 clean_logs(emerge.settings)
1791
David Jamesfcb70ef2011-02-02 16:02:30 -08001792 print "Done"
Brian Harring8294d652012-05-23 02:20:52 -07001793 return 0