bin/egencache

   1 #!/usr/bin/python
   2 # Copyright 2009-2010 Gentoo Foundation
   3 # Distributed under the terms of the GNU General Public License v2
   4
   5 from __future__ import print_function
   6
   7 import sys
   8 # This block ensures that ^C interrupts are handled quietly.
   9 try:
  10         import signal
  11
  12         def exithandler(signum,frame):
  13                 signal.signal(signal.SIGINT, signal.SIG_IGN)
  14                 signal.signal(signal.SIGTERM, signal.SIG_IGN)
  15                 sys.exit(1)
  16
  17         signal.signal(signal.SIGINT, exithandler)
  18         signal.signal(signal.SIGTERM, exithandler)
  19
  20 except KeyboardInterrupt:
  21         sys.exit(1)
  22
  23 import logging
  24 import optparse
  25
  26 try:
  27         import portage
  28 except ImportError:
  29         from os import path as osp
  30         sys.path.insert(0, osp.join(osp.dirname(osp.dirname(osp.realpath(__file__))), "pym"))
  31         import portage
  32
  33 from portage import os
  34 from _emerge.MetadataRegen import MetadataRegen
  35 from portage.cache.cache_errors import CacheError, StatCollision
  36 from portage.util import cmp_sort_key, writemsg_level
  37 from portage import cpv_getkey
  38 from portage.dep import Atom, isjustname
  39 from portage.versions import pkgcmp, pkgsplit
  40
  41 try:
  42         import xml.etree.ElementTree
  43 except ImportError:
  44         pass
  45 else:
  46         from repoman.utilities import parse_metadata_use
  47         from xml.parsers.expat import ExpatError
  48
  49 if sys.hexversion >= 0x3000000:
  50         long = int
  51
  52 def parse_args(args):
  53         usage = "egencache [options] <action> ... [atom] ..."
  54         parser = optparse.OptionParser(usage=usage)
  55
  56         actions = optparse.OptionGroup(parser, 'Actions')
  57         actions.add_option("--update",
  58                 action="store_true",
  59                 help="update metadata/cache/ (generate as necessary)")
  60         actions.add_option("--update-use-local-desc",
  61                 action="store_true",
  62                 help="update the use.local.desc file from metadata.xml")
  63         parser.add_option_group(actions)
  64
  65         common = optparse.OptionGroup(parser, 'Common options')
  66         common.add_option("--repo",
  67                 action="store",
  68                 help="name of repo to operate on (default repo is located at $PORTDIR)")
  69         common.add_option("--config-root",
  70                 help="location of portage config files",
  71                 dest="portage_configroot")
  72         common.add_option("--portdir",
  73                 help="override the portage tree location",
  74                 dest="portdir")
  75         common.add_option("--tolerant",
  76                 action="store_true",
  77                 help="exit successfully if only minor errors occurred")
  78         common.add_option("--ignore-default-opts",
  79                 action="store_true",
  80                 help="do not use the EGENCACHE_DEFAULT_OPTS environment variable")
  81         parser.add_option_group(common)
  82
  83         update = optparse.OptionGroup(parser, '--update options')
  84         update.add_option("--cache-dir",
  85                 help="location of the metadata cache",
  86                 dest="cache_dir")
  87         update.add_option("--jobs",
  88                 action="store",
  89                 help="max ebuild processes to spawn")
  90         update.add_option("--load-average",
  91                 action="store",
  92                 help="max load allowed when spawning multiple jobs",
  93                 dest="load_average")
  94         update.add_option("--rsync",
  95                 action="store_true",
  96                 help="enable rsync stat collision workaround " + \
  97                         "for bug 139134 (use with --update)")
  98         parser.add_option_group(update)
  99
 100         uld = optparse.OptionGroup(parser, '--update-use-local-desc options')
 101         uld.add_option("--use-local-desc-output",
 102                 help="output file for use.local.desc data (or '-' for stdout)",
 103                 dest="uld_output")
 104         parser.add_option_group(uld)
 105
 106         options, args = parser.parse_args(args)
 107
 108         if options.jobs:
 109                 jobs = None
 110                 try:
 111                         jobs = int(options.jobs)
 112                 except ValueError:
 113                         jobs = -1
 114
 115                 if jobs < 1:
 116                         parser.error("Invalid: --jobs='%s'" % \
 117                                 (options.jobs,))
 118
 119                 options.jobs = jobs
 120
 121         else:
 122                 options.jobs = None
 123
 124         if options.load_average:
 125                 try:
 126                         load_average = float(options.load_average)
 127                 except ValueError:
 128                         load_average = 0.0
 129
 130                 if load_average <= 0.0:
 131                         parser.error("Invalid: --load-average='%s'" % \
 132                                 (options.load_average,))
 133
 134                 options.load_average = load_average
 135
 136         else:
 137                 options.load_average = None
 138
 139         options.config_root = options.portage_configroot
 140         if options.config_root is not None and \
 141                 not os.path.isdir(options.config_root):
 142                 parser.error("Not a directory: --config-root='%s'" % \
 143                         (options.config_root,))
 144
 145         if options.cache_dir is not None and not os.path.isdir(options.cache_dir):
 146                 parser.error("Not a directory: --cache-dir='%s'" % \
 147                         (options.cache_dir,))
 148
 149         for atom in args:
 150                 try:
 151                         atom = portage.dep.Atom(atom)
 152                 except portage.exception.InvalidAtom:
 153                         parser.error('Invalid atom: %s' % (atom,))
 154
 155                 if not isjustname(atom):
 156                         parser.error('Atom is too specific: %s' % (atom,))
 157
 158         if options.update_use_local_desc:
 159                 try:
 160                         xml.etree.ElementTree
 161                 except NameError:
 162                         parser.error('--update-use-local-desc requires python with USE=xml!')
 163
 164         return parser, options, args
 165
 166 class GenCache(object):
 167         def __init__(self, portdb, cp_iter=None, max_jobs=None, max_load=None,
 168                 rsync=False):
 169                 self._portdb = portdb
 170                 # We can globally cleanse stale cache only if we
 171                 # iterate over every single cp.
 172                 self._global_cleanse = cp_iter is None
 173                 if cp_iter is not None:
 174                         self._cp_set = set(cp_iter)
 175                         cp_iter = iter(self._cp_set)
 176                         self._cp_missing = self._cp_set.copy()
 177                 else:
 178                         self._cp_set = None
 179                         self._cp_missing = set()
 180                 self._regen = MetadataRegen(portdb, cp_iter=cp_iter,
 181                         consumer=self._metadata_callback,
 182                         max_jobs=max_jobs, max_load=max_load)
 183                 self.returncode = os.EX_OK
 184                 metadbmodule = portdb.settings.load_best_module("portdbapi.metadbmodule")
 185                 self._trg_cache = metadbmodule(portdb.porttrees[0],
 186                         "metadata/cache", portage.auxdbkeys[:])
 187                 if rsync:
 188                         self._trg_cache.raise_stat_collision = True
 189                 try:
 190                         self._trg_cache.ec = \
 191                                 portdb._repo_info[portdb.porttrees[0]].eclass_db
 192                 except AttributeError:
 193                         pass
 194                 self._existing_nodes = set()
 195
 196         def _metadata_callback(self, cpv, ebuild_path, repo_path, metadata):
 197                 self._existing_nodes.add(cpv)
 198                 self._cp_missing.discard(cpv_getkey(cpv))
 199                 if metadata is not None:
 200                         if metadata.get('EAPI') == '0':
 201                                 del metadata['EAPI']
 202                         try:
 203                                 try:
 204                                         self._trg_cache[cpv] = metadata
 205                                 except StatCollision as sc:
 206                                         # If the content of a cache entry changes and neither the
 207                                         # file mtime nor size changes, it will prevent rsync from
 208                                         # detecting changes. Cache backends may raise this
 209                                         # exception from _setitem() if they detect this type of stat
 210                                         # collision. These exceptions are handled by bumping the
 211                                         # mtime on the ebuild (and the corresponding cache entry).
 212                                         # See bug #139134.
 213                                         max_mtime = sc.mtime
 214                                         for ec, (loc, ec_mtime) in metadata['_eclasses_'].items():
 215                                                 if max_mtime < ec_mtime:
 216                                                         max_mtime = ec_mtime
 217                                         if max_mtime == sc.mtime:
 218                                                 max_mtime += 1
 219                                         max_mtime = long(max_mtime)
 220                                         try:
 221                                                 os.utime(ebuild_path, (max_mtime, max_mtime))
 222                                         except OSError as e:
 223                                                 self.returncode |= 1
 224                                                 writemsg_level(
 225                                                         "%s writing target: %s\n" % (cpv, e),
 226                                                         level=logging.ERROR, noiselevel=-1)
 227                                         else:
 228                                                 metadata['_mtime_'] = max_mtime
 229                                                 self._trg_cache[cpv] = metadata
 230                                                 self._portdb.auxdb[repo_path][cpv] = metadata
 231
 232                         except CacheError as ce:
 233                                 self.returncode |= 1
 234                                 writemsg_level(
 235                                         "%s writing target: %s\n" % (cpv, ce),
 236                                         level=logging.ERROR, noiselevel=-1)
 237
 238         def run(self):
 239                 self._regen.run()
 240                 self.returncode |= self._regen.returncode
 241                 cp_missing = self._cp_missing
 242
 243                 trg_cache = self._trg_cache
 244                 dead_nodes = set()
 245                 if self._global_cleanse:
 246                         try:
 247                                 for cpv in trg_cache:
 248                                         cp = cpv_getkey(cpv)
 249                                         if cp is None:
 250                                                 self.returncode |= 1
 251                                                 writemsg_level(
 252                                                         "Unable to parse cp for '%s'\n"  % (cpv,),
 253                                                         level=logging.ERROR, noiselevel=-1)
 254                                         else:
 255                                                 dead_nodes.add(cpv)
 256                         except CacheError as ce:
 257                                 self.returncode |= 1
 258                                 writemsg_level(
 259                                         "Error listing cache entries for " + \
 260                                         "'%s/metadata/cache': %s, continuing...\n" % \
 261                                         (self._portdb.porttree_root, ce),
 262                                         level=logging.ERROR, noiselevel=-1)
 263
 264                 else:
 265                         cp_set = self._cp_set
 266                         try:
 267                                 for cpv in trg_cache:
 268                                         cp = cpv_getkey(cpv)
 269                                         if cp is None:
 270                                                 self.returncode |= 1
 271                                                 writemsg_level(
 272                                                         "Unable to parse cp for '%s'\n"  % (cpv,),
 273                                                         level=logging.ERROR, noiselevel=-1)
 274                                         else:
 275                                                 cp_missing.discard(cp)
 276                                                 if cp in cp_set:
 277                                                         dead_nodes.add(cpv)
 278                         except CacheError as ce:
 279                                 self.returncode |= 1
 280                                 writemsg_level(
 281                                         "Error listing cache entries for " + \
 282                                         "'%s/metadata/cache': %s, continuing...\n" % \
 283                                         (self._portdb.porttree_root, ce),
 284                                         level=logging.ERROR, noiselevel=-1)
 285
 286                 if cp_missing:
 287                         self.returncode |= 1
 288                         for cp in sorted(cp_missing):
 289                                 writemsg_level(
 290                                         "No ebuilds or cache entries found for '%s'\n"  % (cp,),
 291                                         level=logging.ERROR, noiselevel=-1)
 292
 293                 if dead_nodes:
 294                         dead_nodes.difference_update(self._existing_nodes)
 295                         for k in dead_nodes:
 296                                 try:
 297                                         del trg_cache[k]
 298                                 except KeyError:
 299                                         pass
 300                                 except CacheError as ce:
 301                                         self.returncode |= 1
 302                                         writemsg_level(
 303                                                 "%s deleting stale cache: %s\n" % (k, ce),
 304                                                 level=logging.ERROR, noiselevel=-1)
 305
 306                 if not trg_cache.autocommits:
 307                         try:
 308                                 trg_cache.commit()
 309                         except CacheError as ce:
 310                                 self.returncode |= 1
 311                                 writemsg_level(
 312                                         "committing target: %s\n" % (ce,),
 313                                         level=logging.ERROR, noiselevel=-1)
 314
 315 class GenUseLocalDesc(object):
 316         def __init__(self, portdb, output=None):
 317                 self.returncode = os.EX_OK
 318                 self._portdb = portdb
 319                 self._output = output
 320
 321         def run(self):
 322                 repo_path = self._portdb.porttrees[0]
 323                 ops = {'<':0, '<=':1, '=':2, '>=':3, '>':4}
 324
 325                 if self._output is None or self._output != '-':
 326                         if self._output is None:
 327                                 prof_path = os.path.join(repo_path, 'profiles')
 328                                 desc_path = os.path.join(prof_path, 'use.local.desc')
 329                                 try:
 330                                         os.mkdir(prof_path)
 331                                 except OSError:
 332                                         pass
 333                         else:
 334                                 desc_path = self._output
 335
 336                         try:
 337                                 output = open(desc_path, 'w')
 338                         except IOError as e:
 339                                 writemsg_level(
 340                                         "ERROR: failed to open output file: %s\n" % (e,),
 341                                         level=logging.ERROR, noiselevel=-1)
 342                                 self.returncode |= 2
 343                                 return
 344                 else:
 345                         output = sys.stdout
 346
 347                 output.write('''
 348 # This file is deprecated as per GLEP 56 in favor of metadata.xml. Please add
 349 # your descriptions to your package's metadata.xml ONLY.
 350 # * generated automatically using egencache *
 351
 352 '''.lstrip())
 353
 354                 # The cmp function no longer exists in python3, so we'll
 355                 # implement our own here under a slightly different name
 356                 # since we don't want any confusion given that we never
 357                 # want to rely on the builtin cmp function.
 358                 def cmp_func(a, b):
 359                         return (a > b) - (a < b)
 360
 361                 for cp in self._portdb.cp_all():
 362                         metadata_path = os.path.join(repo_path, cp, 'metadata.xml')
 363                         try:
 364                                 metadata = xml.etree.ElementTree.parse(metadata_path)
 365                         except IOError:
 366                                 pass
 367                         except (ExpatError, EnvironmentError) as e:
 368                                 writemsg_level(
 369                                         "ERROR: failed parsing %s/metadata.xml: %s\n" % (cp, e),
 370                                         level=logging.ERROR, noiselevel=-1)
 371                                 self.returncode |= 1
 372                         else:
 373                                 try:
 374                                         usedict = parse_metadata_use(metadata)
 375                                 except portage.exception.ParseError as e:
 376                                         writemsg_level(
 377                                                 "ERROR: failed parsing %s/metadata.xml: %s\n" % (cp, e),
 378                                                 level=logging.ERROR, noiselevel=-1)
 379                                         self.returncode |= 1
 380                                 else:
 381                                         for flag in sorted(usedict):
 382                                                 def atomcmp(atoma, atomb):
 383                                                         # None is better than an atom, that's why we reverse the args
 384                                                         if atoma is None or atomb is None:
 385                                                                 return cmp_func(atomb, atoma)
 386                                                         # Same for plain PNs (.operator is None then)
 387                                                         elif atoma.operator is None or atomb.operator is None:
 388                                                                 return cmp_func(atomb.operator, atoma.operator)
 389                                                         # Version matching
 390                                                         elif atoma.cpv != atomb.cpv:
 391                                                                 return pkgcmp(pkgsplit(atoma.cpv), pkgsplit(atomb.cpv))
 392                                                         # Versions match, let's fallback to operator matching
 393                                                         else:
 394                                                                 return cmp_func(ops.get(atoma.operator, -1),
 395                                                                         ops.get(atomb.operator, -1))
 396
 397                                                 def _Atom(key):
 398                                                         if key is not None:
 399                                                                 return Atom(key)
 400                                                         return None
 401
 402                                                 resdict = usedict[flag]
 403                                                 if len(resdict) == 1:
 404                                                         resdesc = next(iter(resdict.items()))[1]
 405                                                 else:
 406                                                         try:
 407                                                                 reskeys = dict((_Atom(k), k) for k in resdict)
 408                                                         except portage.exception.InvalidAtom as e:
 409                                                                 writemsg_level(
 410                                                                         "ERROR: failed parsing %s/metadata.xml: %s\n" % (cp, e),
 411                                                                         level=logging.ERROR, noiselevel=-1)
 412                                                                 self.returncode |= 1
 413                                                                 resdesc = next(iter(resdict.items()))[1]
 414                                                         else:
 415                                                                 resatoms = sorted(reskeys, key=cmp_sort_key(atomcmp))
 416                                                                 resdesc = resdict[reskeys[resatoms[-1]]]
 417
 418                                                 output.write('%s:%s - %s\n' % (cp, flag, resdesc))
 419
 420                 output.close()
 421
 422 def egencache_main(args):
 423         parser, options, atoms = parse_args(args)
 424
 425         config_root = options.config_root
 426         if config_root is None:
 427                 config_root = '/'
 428
 429         # The calling environment is ignored, so the program is
 430         # completely controlled by commandline arguments.
 431         env = {}
 432
 433         if options.repo is None:
 434                 env['PORTDIR_OVERLAY'] = ''
 435
 436         if options.cache_dir is not None:
 437                 env['PORTAGE_DEPCACHEDIR'] = options.cache_dir
 438
 439         if options.portdir is not None:
 440                 env['PORTDIR'] = options.portdir
 441
 442         settings = portage.config(config_root=config_root,
 443                 target_root='/', local_config=False, env=env)
 444
 445         default_opts = None
 446         if not options.ignore_default_opts:
 447                 default_opts = settings.get('EGENCACHE_DEFAULT_OPTS', '').split()
 448
 449         if default_opts:
 450                 parser, options, args = parse_args(default_opts + args)
 451
 452                 if options.config_root is not None:
 453                         config_root = options.config_root
 454
 455                 if options.cache_dir is not None:
 456                         env['PORTAGE_DEPCACHEDIR'] = options.cache_dir
 457
 458                 settings = portage.config(config_root=config_root,
 459                         target_root='/', local_config=False, env=env)
 460
 461         if not options.update and not options.update_use_local_desc:
 462                 parser.error('No action specified (--update ' + \
 463                         'and/or --update-use-local-desc)')
 464                 return 1
 465
 466         if options.update and 'metadata-transfer' not in settings.features:
 467                 writemsg_level("ecachegen: warning: " + \
 468                         "automatically enabling FEATURES=metadata-transfer\n",
 469                         level=logging.WARNING, noiselevel=-1)
 470                 settings.features.add('metadata-transfer')
 471
 472         settings.lock()
 473
 474         portdb = portage.portdbapi(mysettings=settings)
 475         if options.repo is not None:
 476                 repo_path = portdb.getRepositoryPath(options.repo)
 477                 if repo_path is None:
 478                         parser.error("Unable to locate repository named '%s'" % \
 479                                 (options.repo,))
 480                         return 1
 481
 482                 # Limit ebuilds to the specified repo.
 483                 portdb.porttrees = [repo_path]
 484
 485         ret = [os.EX_OK]
 486
 487         if options.update:
 488                 cp_iter = None
 489                 if atoms:
 490                         cp_iter = iter(atoms)
 491
 492                 gen_cache = GenCache(portdb, cp_iter=cp_iter,
 493                         max_jobs=options.jobs,
 494                         max_load=options.load_average,
 495                         rsync=options.rsync)
 496                 gen_cache.run()
 497                 ret.append(gen_cache.returncode)
 498
 499         if options.update_use_local_desc:
 500                 gen_desc = GenUseLocalDesc(portdb,
 501                         output=options.uld_output)
 502                 gen_desc.run()
 503                 ret.append(gen_desc.returncode)
 504
 505         if options.tolerant:
 506                 return ret[0]
 507         return max(ret)
 508
 509 if __name__ == "__main__":
 510         portage._disable_legacy_globals()
 511         portage.util.noiselimit = -1
 512         sys.exit(egencache_main(sys.argv[1:]))