utils/llvm-compilers-check

   1 #!/usr/bin/python3
   2 ##===- utils/llvmbuild - Build the LLVM project ----------------*-python-*-===##
   3 #
   4 #                     The LLVM Compiler Infrastructure
   5 #
   6 # This file is distributed under the University of Illinois Open Source
   7 # License. See LICENSE.TXT for details.
   8 #
   9 ##===----------------------------------------------------------------------===##
  10 #
  11 # This script builds many different flavors of the LLVM ecosystem.  It
  12 # will build LLVM, Clang and dragonegg as well as run tests on them.
  13 # This script is convenient to use to check builds and tests before
  14 # committing changes to the upstream repository
  15 #
  16 # A typical source setup uses three trees and looks like this:
  17 #
  18 # official
  19 #   dragonegg
  20 #   llvm
  21 #     tools
  22 #       clang
  23 # staging
  24 #   dragonegg
  25 #   llvm
  26 #     tools
  27 #       clang
  28 # commit
  29 #   dragonegg
  30 #   llvm
  31 #     tools
  32 #       clang
  33 #
  34 # In a typical workflow, the "official" tree always contains unchanged
  35 # sources from the main LLVM project repositories.  The "staging" tree
  36 # is where local work is done.  A set of changes resides there waiting
  37 # to be moved upstream.  The "commit" tree is where changes from
  38 # "staging" make their way upstream.  Individual incremental changes
  39 # from "staging" are applied to "commit" and committed upstream after
  40 # a successful build and test run.  A successful build is one in which
  41 # testing results in no more failures than seen in the testing of the
  42 # "official" tree.
  43 #
  44 # A build may be invoked as such:
  45 #
  46 # llvmbuild --src=~/llvm/commit --src=~/llvm/staging --src=~/llvm/official
  47 #   --build=debug --build=release --build=paranoid
  48 #   --prefix=/home/greened/install --builddir=/home/greened/build
  49 #
  50 # This will build the LLVM ecosystem, including LLVM, Clangand
  51 # dragonegg, putting build results in ~/build and installing tools in
  52 # ~/install.  llvm-compilers-check creates separate build and install
  53 # directories for each source/build flavor.  In the above example,
  54 # llvmbuild will build debug, release and paranoid (debug+checks)
  55 # flavors from each source tree (official, staging and commit) for a
  56 # total of nine builds.  All builds will be run in parallel.
  57 #
  58 # The user may control parallelism via the --jobs and --threads
  59 # switches.  --jobs tells llvm-compilers-checl the maximum total
  60 # number of builds to activate in parallel.  The user may think of it
  61 # as equivalent to the GNU make -j switch.  --threads tells
  62 # llvm-compilers-check how many worker threads to use to accomplish
  63 # those builds.  If --threads is less than --jobs, --threads workers
  64 # will be launched and each one will pick a source/flavor combination
  65 # to build.  Then llvm-compilers-check will invoke GNU make with -j
  66 # (--jobs / --threads) to use up the remaining job capacity.  Once a
  67 # worker is finished with a build, it will pick another combination
  68 # off the list and start building it.
  69 #
  70 ##===----------------------------------------------------------------------===##
  71
  72 import optparse
  73 import os
  74 import sys
  75 import threading
  76 import queue
  77 import logging
  78 import traceback
  79 import subprocess
  80 import re
  81
  82 # TODO: Use shutil.which when it is available (3.2 or later)
  83 def find_executable(executable, path=None):
  84     """Try to find 'executable' in the directories listed in 'path' (a
  85     string listing directories separated by 'os.pathsep'; defaults to
  86     os.environ['PATH']).  Returns the complete filename or None if not
  87     found
  88     """
  89     if path is None:
  90         path = os.environ['PATH']
  91     paths = path.split(os.pathsep)
  92     extlist = ['']
  93     if os.name == 'os2':
  94         (base, ext) = os.path.splitext(executable)
  95         # executable files on OS/2 can have an arbitrary extension, but
  96         # .exe is automatically appended if no dot is present in the name
  97         if not ext:
  98             executable = executable + ".exe"
  99     elif sys.platform == 'win32':
 100         pathext = os.environ['PATHEXT'].lower().split(os.pathsep)
 101         (base, ext) = os.path.splitext(executable)
 102         if ext.lower() not in pathext:
 103             extlist = pathext
 104     for ext in extlist:
 105         execname = executable + ext
 106         if os.path.isfile(execname):
 107             return execname
 108         else:
 109             for p in paths:
 110                 f = os.path.join(p, execname)
 111                 if os.path.isfile(f):
 112                     return f
 113     else:
 114         return None
 115
 116 def is_executable(fpath):
 117     return os.path.exists(fpath) and os.access(fpath, os.X_OK)
 118
 119 def add_options(parser):
 120     parser.add_option("-v", "--verbose", action="store_true",
 121                       default=False,
 122                       help=("Output informational messages"
 123                             " [default: %default]"))
 124     parser.add_option("--src", action="append",
 125                       help=("Top-level source directory [default: %default]"))
 126     parser.add_option("--build", action="append",
 127                       help=("Build types to run [default: %default]"))
 128     parser.add_option("--cc", default=find_executable("cc"),
 129                       help=("The C compiler to use [default: %default]"))
 130     parser.add_option("--cxx", default=find_executable("c++"),
 131                       help=("The C++ compiler to use [default: %default]"))
 132     parser.add_option("--threads", default=4, type="int",
 133                       help=("The number of worker threads to use "
 134                             "[default: %default]"))
 135     parser.add_option("--jobs", "-j", default=8, type="int",
 136                       help=("The number of simultaneous build jobs "
 137                             "[default: %default]"))
 138     parser.add_option("--prefix",
 139                       help=("Root install directory [default: %default]"))
 140     parser.add_option("--builddir",
 141                       help=("Root build directory [default: %default]"))
 142     parser.add_option("--extra-llvm-config-flags", default="",
 143                       help=("Extra flags to pass to llvm configure [default: %default]"))
 144     parser.add_option("--force-configure", default=False, action="store_true",
 145                       help=("Force reconfigure of all components"))
 146     parser.add_option("--no-dragonegg", default=False, action="store_true",
 147                       help=("Do not build dragonegg"))
 148     parser.add_option("--no-install", default=False, action="store_true",
 149                       help=("Do not do installs"))
 150     return
 151
 152 def check_options(parser, options, valid_builds):
 153     # See if we're building valid flavors.
 154     for build in options.build:
 155         if (build not in valid_builds):
 156             parser.error("'" + build + "' is not a valid build flavor "
 157                          + str(valid_builds))
 158
 159     # See if we can find source directories.
 160     for src in options.src:
 161         for component in components:
 162             component = component.rstrip("2")
 163             compsrc = src + "/" + component
 164             if (not os.path.isdir(compsrc)):
 165                 parser.error("'" + compsrc + "' does not exist")
 166
 167     # See if we can find the compilers
 168     options.cc = find_executable(options.cc)
 169     options.cxx = find_executable(options.cxx)
 170
 171     return
 172
 173 # Find a unique short name for the given set of paths.  This searches
 174 # back through path components until it finds unique component names
 175 # among all given paths.
 176 def get_path_abbrevs(paths):
 177     # Find the number of common starting characters in the last component
 178     # of the paths.
 179     unique_paths = list(paths)
 180
 181     class NotFoundException(Exception): pass
 182
 183     # Find a unique component of each path.
 184     unique_bases = unique_paths[:]
 185     found = 0
 186     while len(unique_paths) > 0:
 187         bases = [os.path.basename(src) for src in unique_paths]
 188         components = { c for c in bases }
 189         # Account for single entry in paths.
 190         if len(components) > 1 or len(components) == len(bases):
 191             # We found something unique.
 192             for c in components:
 193                 if bases.count(c) == 1:
 194                    index = bases.index(c)
 195                    unique_bases[index] = c
 196                    # Remove the corresponding path from the set under
 197                    # consideration.
 198                    unique_paths[index] = None
 199             unique_paths = [ p for p in unique_paths if p is not None ]
 200         unique_paths = [os.path.dirname(src) for src in unique_paths]
 201
 202     if len(unique_paths) > 0:
 203         raise NotFoundException()
 204
 205     abbrevs = dict(zip(paths, [base for base in unique_bases]))
 206
 207     return abbrevs
 208
 209 # Given a set of unique names, find a short character sequence that
 210 # uniquely identifies them.
 211 def get_short_abbrevs(unique_bases):
 212     # Find a unique start character for each path base.
 213     my_unique_bases = unique_bases[:]
 214     unique_char_starts = unique_bases[:]
 215     while len(my_unique_bases) > 0:
 216         for start, char_tuple in enumerate(zip(*[base
 217                                                  for base in my_unique_bases])):
 218             chars = { c for c in char_tuple }
 219             # Account for single path.
 220             if len(chars) > 1 or len(chars) == len(char_tuple):
 221                 # We found something unique.
 222                 for c in chars:
 223                     if char_tuple.count(c) == 1:
 224                         index = char_tuple.index(c)
 225                         unique_char_starts[index] = start
 226                         # Remove the corresponding path from the set under
 227                         # consideration.
 228                         my_unique_bases[index] = None
 229                 my_unique_bases = [ b for b in my_unique_bases
 230                                     if b is not None ]
 231                 break
 232
 233     if len(my_unique_bases) > 0:
 234         raise NotFoundException()
 235
 236     abbrevs = [abbrev[start_index:start_index+3]
 237                for abbrev, start_index
 238                in zip([base for base in unique_bases],
 239                       [index for index in unique_char_starts])]
 240
 241     abbrevs = dict(zip(unique_bases, abbrevs))
 242
 243     return abbrevs
 244
 245 class Builder(threading.Thread):
 246     class ExecutableNotFound(Exception): pass
 247     class FileNotExecutable(Exception): pass
 248
 249     def __init__(self, work_queue, jobs,
 250                  build_abbrev, source_abbrev,
 251                  options):
 252         super().__init__()
 253         self.work_queue = work_queue
 254         self.jobs = jobs
 255         self.cc = options.cc
 256         self.cxx = options.cxx
 257         self.build_abbrev = build_abbrev
 258         self.source_abbrev = source_abbrev
 259         self.build_prefix = options.builddir
 260         self.install_prefix = options.prefix
 261         self.options = options
 262         self.component_abbrev = dict(
 263             llvm="llvm",
 264             dragonegg="degg")
 265     def run(self):
 266         while True:
 267             try:
 268                 source, build = self.work_queue.get()
 269                 self.dobuild(source, build)
 270             except:
 271                 traceback.print_exc()
 272             finally:
 273                 self.work_queue.task_done()
 274
 275     def execute(self, command, execdir, env, component):
 276         prefix = self.component_abbrev[component.replace("-", "_")]
 277         pwd = os.getcwd()
 278         if not os.path.exists(execdir):
 279             os.makedirs(execdir)
 280
 281         execenv = os.environ.copy()
 282
 283         for key, value in env.items():
 284             execenv[key] = value
 285
 286         self.logger.debug("[" + prefix + "] " + "env " + str(env) + " "
 287                           + " ".join(command));
 288
 289         try:
 290             proc = subprocess.Popen(command,
 291                                     cwd=execdir,
 292                                     env=execenv,
 293                                     stdout=subprocess.PIPE,
 294                                     stderr=subprocess.STDOUT)
 295
 296             line = proc.stdout.readline()
 297             while line:
 298                 self.logger.info("[" + prefix + "] "
 299                                  + str(line, "utf-8").rstrip())
 300                 line = proc.stdout.readline()
 301
 302         except:
 303             traceback.print_exc()
 304
 305     # Get a list of C++ include directories to pass to clang.
 306     def get_includes(self):
 307         # Assume we're building with g++ for now.
 308         command = [self.cxx]
 309         command += ["-v", "-x", "c++", "/dev/null", "-fsyntax-only"]
 310         includes = []
 311         self.logger.debug(command)
 312         try:
 313             proc = subprocess.Popen(command,
 314                                     stdout=subprocess.PIPE,
 315                                     stderr=subprocess.STDOUT)
 316
 317             gather = False
 318             line = proc.stdout.readline()
 319             while line:
 320                 self.logger.debug(line)
 321                 if re.search("End of search list", str(line)) is not None:
 322                     self.logger.debug("Stop Gather")
 323                     gather = False
 324                 if gather:
 325                     includes.append(str(line, "utf-8").strip())
 326                 if re.search("#include <...> search starts", str(line)) is not None:
 327                     self.logger.debug("Start Gather")
 328                     gather = True
 329                 line = proc.stdout.readline()
 330         except:
 331             traceback.print_exc()
 332         self.logger.debug(includes)
 333         return includes
 334
 335     def dobuild(self, source, build):
 336         build_suffix = ""
 337
 338         ssabbrev = get_short_abbrevs([ab for ab in self.source_abbrev.values()])
 339
 340         prefix = "[" + ssabbrev[self.source_abbrev[source]] + "-" + self.build_abbrev[build] + "]"
 341         self.install_prefix += "/" + self.source_abbrev[source] + "/" + build
 342         build_suffix += "/" + self.source_abbrev[source] + "/" + build
 343
 344         self.logger = logging.getLogger(prefix)
 345
 346         self.logger.debug(self.install_prefix)
 347
 348         # Assume we're building with gcc for now.
 349         cxxincludes = self.get_includes()
 350         cxxroot = cxxincludes[0]
 351         cxxarch = os.path.basename(cxxincludes[1])
 352
 353         configure_flags = dict(
 354             llvm=dict(debug=["--prefix=" + self.install_prefix,
 355                              "--with-extra-options=-Werror",
 356                              "--enable-assertions",
 357                              "--disable-optimized",
 358                              "--with-cxx-include-root=" + cxxroot,
 359                              "--with-cxx-include-arch=" + cxxarch],
 360                       release=["--prefix=" + self.install_prefix,
 361                                "--with-extra-options=-Werror",
 362                                "--enable-optimized",
 363                                "--with-cxx-include-root=" + cxxroot,
 364                                "--with-cxx-include-arch=" + cxxarch],
 365                       paranoid=["--prefix=" + self.install_prefix,
 366                                 "--with-extra-options=-Werror",
 367                                 "--enable-assertions",
 368                                 "--enable-expensive-checks",
 369                                 "--disable-optimized",
 370                                 "--with-cxx-include-root=" + cxxroot,
 371                                 "--with-cxx-include-arch=" + cxxarch]),
 372             dragonegg=dict(debug=[],
 373                            release=[],
 374                            paranoid=[]))
 375
 376         configure_env = dict(
 377             llvm=dict(debug=dict(CC=self.cc,
 378                                  CXX=self.cxx),
 379                       release=dict(CC=self.cc,
 380                                    CXX=self.cxx),
 381                       paranoid=dict(CC=self.cc,
 382                                     CXX=self.cxx)),
 383             dragonegg=dict(debug=dict(CC=self.cc,
 384                                       CXX=self.cxx),
 385                            release=dict(CC=self.cc,
 386                                         CXX=self.cxx),
 387                            paranoid=dict(CC=self.cc,
 388                                          CXX=self.cxx)))
 389
 390         make_flags = dict(
 391             llvm=dict(debug=["-j" + str(self.jobs)],
 392                       release=["-j" + str(self.jobs)],
 393                       paranoid=["-j" + str(self.jobs)]),
 394             dragonegg=dict(debug=["-j" + str(self.jobs)],
 395                            release=["-j" + str(self.jobs)],
 396                            paranoid=["-j" + str(self.jobs)]))
 397
 398         make_env = dict(
 399             llvm=dict(debug=dict(),
 400                       release=dict(),
 401                       paranoid=dict()),
 402             dragonegg=dict(debug=dict(GCC=self.cc,
 403                                       LLVM_CONFIG=self.install_prefix + "/bin/llvm-config"),
 404                            release=dict(GCC=self.cc,
 405                                         LLVM_CONFIG=self.install_prefix + "/bin/llvm-config"),
 406                            paranoid=dict(GCC=self.cc,
 407                                          LLVM_CONFIG=self.install_prefix + "/bin/llvm-config")))
 408
 409         make_install_flags = dict(
 410             llvm=dict(debug=["install"],
 411                       release=["install"],
 412                       paranoid=["install"]),
 413             dragonegg=dict(debug=["install"],
 414                            release=["install"],
 415                            paranoid=["install"]))
 416
 417         make_install_env = dict(
 418             llvm=dict(debug=dict(),
 419                       release=dict(),
 420                       paranoid=dict()),
 421             dragonegg=dict(debug=dict(),
 422                            release=dict(),
 423                            paranoid=dict()))
 424
 425         make_check_flags = dict(
 426             llvm=dict(debug=["check"],
 427                       release=["check"],
 428                       paranoid=["check"]),
 429             dragonegg=dict(debug=["check"],
 430                            release=["check"],
 431                            paranoid=["check"]))
 432
 433         make_check_env = dict(
 434             llvm=dict(debug=dict(),
 435                       release=dict(),
 436                       paranoid=dict()),
 437             dragonegg=dict(debug=dict(),
 438                            release=dict(),
 439                            paranoid=dict()))
 440
 441         for component in components:
 442             comp = component[:]
 443
 444             if (self.options.no_dragonegg):
 445                 if (comp == 'dragonegg'):
 446                     self.logger.info("Skipping " + component + " in "
 447                                      + builddir)
 448                     continue
 449
 450             srcdir = source + "/" + comp.rstrip("2")
 451             builddir = self.build_prefix + "/" + comp + "/" + build_suffix
 452             installdir = self.install_prefix
 453
 454             comp_key = comp.replace("-", "_")
 455
 456             config_args = configure_flags[comp_key][build][:]
 457             config_args.extend(getattr(self.options,
 458                                        "extra_" + comp_key.rstrip("2")
 459                                        + "_config_flags",
 460                                        "").split())
 461
 462             self.logger.info("Configuring " + component + " in " + builddir)
 463             self.configure(component, srcdir, builddir,
 464                            config_args,
 465                            configure_env[comp_key][build])
 466
 467             self.logger.info("Building " + component + " in " + builddir)
 468             self.logger.info("Build: make " + str(make_flags[comp_key][build]))
 469             self.make(component, srcdir, builddir,
 470                       make_flags[comp_key][build],
 471                       make_env[comp_key][build])
 472
 473             if (not self.options.no_install):
 474                 self.logger.info("Installing " + component + " in " + installdir)
 475                 self.make(component, srcdir, builddir,
 476                           make_install_flags[comp_key][build],
 477                           make_install_env[comp_key][build])
 478
 479             self.logger.info("Testing " + component + " in " + builddir)
 480             self.logger.info("Test: make "
 481                              + str(make_check_flags[comp_key][build]))
 482             self.make(component, srcdir, builddir,
 483                       make_check_flags[comp_key][build],
 484                       make_check_env[comp_key][build])
 485
 486
 487     def configure(self, component, srcdir, builddir, flags, env):
 488         self.logger.debug("Configure " + str(flags) + " " + str(srcdir) + " -> "
 489                           + str(builddir))
 490
 491         configure_files = dict(
 492             llvm=[(srcdir + "/configure", builddir + "/Makefile")],
 493             dragonegg=[("","")])
 494
 495
 496         doconfig = False
 497         for conf, mf in configure_files[component.replace("-", "_")]:
 498             if not os.path.exists(conf):
 499                 return
 500             if os.path.exists(conf) and os.path.exists(mf):
 501                 confstat = os.stat(conf)
 502                 makestat = os.stat(mf)
 503                 if confstat.st_mtime > makestat.st_mtime:
 504                     doconfig = True
 505                     break
 506             else:
 507                 doconfig = True
 508                 break
 509
 510         if not doconfig and not self.options.force_configure:
 511             return
 512
 513         program = srcdir + "/configure"
 514         if not is_executable(program):
 515             return
 516
 517         args = [program]
 518         args += ["--verbose"]
 519         args += flags
 520         self.execute(args, builddir, env, component)
 521
 522     def make(self, component, srcdir, builddir, flags, env):
 523         program = find_executable("make")
 524         if program is None:
 525             raise ExecutableNotFound
 526
 527         if not is_executable(program):
 528             raise FileNotExecutable
 529
 530         args = [program]
 531         args += flags
 532         self.execute(args, builddir, env, component)
 533
 534 # Global constants
 535 build_abbrev = dict(debug="dbg", release="opt", paranoid="par")
 536 components = ["llvm", "dragonegg"]
 537
 538 # Parse options
 539 parser = optparse.OptionParser(version="%prog 1.0")
 540 add_options(parser)
 541 (options, args) = parser.parse_args()
 542 check_options(parser, options, build_abbrev.keys());
 543
 544 if options.verbose:
 545     logging.basicConfig(level=logging.DEBUG,
 546                         format='%(name)-13s: %(message)s')
 547 else:
 548     logging.basicConfig(level=logging.INFO,
 549                         format='%(name)-13s: %(message)s')
 550
 551 source_abbrev = get_path_abbrevs(set(options.src))
 552
 553 work_queue = queue.Queue()
 554
 555 jobs = options.jobs // options.threads
 556 if jobs == 0:
 557     jobs = 1
 558
 559 numthreads = options.threads
 560
 561 logging.getLogger().info("Building with " + str(options.jobs) + " jobs and "
 562                          + str(numthreads) + " threads using " + str(jobs)
 563                          + " make jobs")
 564
 565 logging.getLogger().info("CC  = " + str(options.cc))
 566 logging.getLogger().info("CXX = " + str(options.cxx))
 567
 568 for t in range(numthreads):
 569     builder = Builder(work_queue, jobs,
 570                       build_abbrev, source_abbrev,
 571                       options)
 572     builder.daemon = True
 573     builder.start()
 574
 575 for build in set(options.build):
 576     for source in set(options.src):
 577         work_queue.put((source, build))
 578
 579 work_queue.join()