util/compile

   1 #!/usr/bin/env python3
   2 # Copyright (c) 2006 The Regents of The University of Michigan
   3 # All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions are
   7 # met: redistributions of source code must retain the above copyright
   8 # notice, this list of conditions and the following disclaimer;
   9 # redistributions in binary form must reproduce the above copyright
  10 # notice, this list of conditions and the following disclaimer in the
  11 # documentation and/or other materials provided with the distribution;
  12 # neither the name of the copyright holders nor the names of its
  13 # contributors may be used to endorse or promote products derived from
  14 # this software without specific prior written permission.
  15 #
  16 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27
  28 import os, re, sys
  29 from os.path import isdir, isfile, join as joinpath
  30
  31 homedir = os.environ['HOME']
  32
  33 def do_compile():
  34     #
  35     # Find SCons
  36     #
  37     search_dirs = [ joinpath(homedir, 'local/lib'), '/opt/local/lib',
  38                     '/usr/local/lib', '/usr/lib' ]
  39
  40     if os.environ.has_key("SCONS_LIB_DIR"):
  41         search_dirs.append(os.environ["SCONS_LIB_DIR"])
  42
  43     local = re.compile(r'^scons-local-([0-9]*)\.([0-9]*)\.([0-9]*)$')
  44     standard = re.compile(r'^scons-([0-9]*)\.([0-9]*)\.([0-9]*)$')
  45
  46     scons_dirs = []
  47     for dir in search_dirs:
  48         if not isdir(dir):
  49             continue
  50
  51         entries = os.listdir(dir)
  52         for entry in entries:
  53             if not entry.startswith('scons'):
  54                 continue
  55
  56             version = (0,0,0)
  57             path = joinpath(dir, entry)
  58
  59             match = local.search(entry)
  60             if not match:
  61                 match = standard.search(entry)
  62
  63             if match:
  64                 version = match.group(1), match.group(2), match.group(3)
  65
  66             scons_dirs.append((version, path))
  67
  68     scons_dirs.sort()
  69     scons_dirs.reverse()
  70
  71     if not scons_dirs:
  72         print >>sys.stderr, \
  73               "could not find scons in the following dirs: %s" % search_dirs
  74         sys.exit(1)
  75
  76     sys.path = [ scons_dirs[0][1] ] + sys.path
  77
  78     # invoke SCons
  79     import SCons.Script
  80     SCons.Script.main()
  81
  82 #
  83 # do argument parsing
  84 #
  85 progname = sys.argv[0]
  86
  87 import optparse
  88
  89 usage = '''%prog [compile options] <version> [SCons options]
  90
  91 %prog assumes that the user has a directory called ~/m5/<version> where
  92 the source tree resides, and a directory called ~/build, where %prog
  93 will create ~/build/<version> if it does not exist and build the resulting
  94 simulators there.
  95
  96 If ~/build is set up in such a way that it points to a local disk on
  97 each host, compiles will be very efficient.  For example:
  98 ~/build -> /z/<username>/.build  (Assuming that /z is a local disk and
  99 not NFS mounted, whereas your home directory is NFS mounted).
 100 '''
 101 version = '%prog 0.1'
 102 parser = optparse.OptionParser(usage=usage, version=version,
 103                                formatter=optparse.TitledHelpFormatter())
 104 parser.disable_interspersed_args()
 105
 106 # current option group
 107 group = None
 108
 109 def set_group(*args, **kwargs):
 110     '''set the current option group'''
 111     global group
 112     if not args and not kwargs:
 113         group = None
 114     else:
 115         group = parser.add_option_group(*args, **kwargs)
 116
 117 def add_option(*args, **kwargs):
 118     if group:
 119         return group.add_option(*args, **kwargs)
 120     else:
 121         return parser.add_option(*args, **kwargs)
 122
 123 def bool_option(name, default, help):
 124     '''add a boolean option called --name and --no-name.
 125     Display help depending on which is the default'''
 126
 127     tname = '--%s' % name
 128     fname = '--no-%s' % name
 129     dest = name.replace('-', '_')
 130     if default:
 131         thelp = optparse.SUPPRESS_HELP
 132         fhelp = help
 133     else:
 134         thelp = help
 135         fhelp = optparse.SUPPRESS_HELP
 136
 137     add_option(tname, action="store_true", default=default, help=thelp)
 138     add_option(fname, action="store_false", dest=dest, help=fhelp)
 139
 140 add_option('-n', '--no-compile', default=False, action='store_true',
 141            help="don't actually compile, just echo SCons command line")
 142 add_option('--everything', default=False, action='store_true',
 143            help="compile everything that can be compiled")
 144 add_option('-E', "--experimental", action='store_true', default=False,
 145            help="enable experimental builds")
 146 add_option('-v', "--verbose", default=False, action='store_true',
 147            help="be verbose")
 148
 149 set_group("Output binary types")
 150 bool_option("debug", default=False, help="compile debug binaries")
 151 bool_option("opt", default=False, help="compile opt binaries")
 152 bool_option("fast", default=False, help="compile fast binaries")
 153 bool_option("prof", default=False, help="compile profile binaries")
 154 add_option('-a', "--all-bin", default=False, action='store_true',
 155            help="compile debug, opt, and fast binaries")
 156
 157 set_group("ISA options")
 158 bool_option("mips", default=False, help="compile MIPS")
 159 bool_option("sparc", default=False, help="compile SPARC")
 160 add_option('-i', "--all-isa", default=False, action='store_true',
 161            help="compile all ISAs")
 162
 163 set_group("Emulation options")
 164 bool_option("syscall", default=True,
 165             help="Do not compile System Call Emulation mode")
 166 bool_option("fullsys", default=True,
 167             help="Do not compile Full System mode")
 168
 169 def usage(exitcode=None):
 170     parser.print_help()
 171     if exitcode is not None:
 172         sys.exit(exitcode)
 173
 174 (options, args) = parser.parse_args()
 175
 176 if options.everything:
 177     options.all_bin = True
 178     options.prof = True
 179     options.all_isa = True
 180
 181 if options.all_bin:
 182     options.debug = True
 183     options.opt = True
 184     options.fast = True
 185
 186 binaries = []
 187 if options.debug:
 188     binaries.append('m5.debug')
 189 if options.opt:
 190     binaries.append('m5.opt')
 191 if options.fast:
 192     binaries.append('m5.fast')
 193 if options.prof:
 194     binaries.append('m5.prof')
 195
 196 if not binaries:
 197     binaries.append('m5.debug')
 198
 199 if options.all_isa:
 200     options.mips = True
 201     options.sparc = True
 202
 203 isas = []
 204 if options.mips:
 205     isas.append('mips')
 206 if options.sparc:
 207     isas.append('sparc')
 208
 209 modes = []
 210 if options.syscall:
 211     modes.append('syscall')
 212 if options.fullsys:
 213     modes.append('fullsys')
 214
 215 if not modes:
 216     sys.exit("must specify at least one mode")
 217
 218 #
 219 # Convert options into SCons command line arguments
 220 #
 221
 222 # valid combinations of ISA and emulation mode
 223 valid = {
 224     ('mips',  'syscall') : 'MIPS_SE',
 225     ('sparc', 'syscall') : 'SPARC_SE' }
 226
 227 # experimental combinations of ISA and emulation mode
 228 experiment = { ('mips', 'fullsys') : 'MIPS_FS',
 229                ('sparc', 'fullsys') : 'SPARC_FS' }
 230
 231 if options.experimental:
 232     valid.update(experiment)
 233
 234 builds = []
 235 for isa in isas:
 236     for mode in modes:
 237         try:
 238             build = valid[(isa, mode)]
 239             builds.append(build)
 240         except KeyError:
 241             pass
 242
 243 if not builds:
 244     sys.exit("must specify at least one valid combination of ISA and mode")
 245
 246 if not args:
 247     usage(2)
 248
 249 version = args[0]
 250 del args[0]
 251
 252 for bin in binaries:
 253     for build in builds:
 254         args.append('%s/%s' % (build, bin))
 255
 256 #
 257 # set up compile
 258 #
 259 build_base = joinpath(homedir, 'build')
 260 m5_base = joinpath(homedir, 'm5')
 261
 262 if not isdir(build_base):
 263     sys.exit('build directory %s not found' % build_base)
 264
 265 if not isdir(m5_base):
 266     sys.exit('m5 base directory %s not found' % m5_base)
 267
 268 m5_dir = joinpath(m5_base, version)
 269 if not isdir(m5_dir):
 270     sys.exit('source directory %s not found' % m5_dir)
 271
 272 # support M5 1.x
 273 oldstyle = isfile(joinpath(m5_dir, 'SConscript'))
 274 if oldstyle:
 275     ext_dir = joinpath(m5_base, 'ext')
 276     test_dir = joinpath(m5_base, 'test.' + version)
 277
 278     if not isdir(ext_dir):
 279         sys.exit('ext directory not found at %s' % ext_dir)
 280
 281     if not isdir(test_dir):
 282         sys.exit('test directory not found at %s' % test_dir)
 283
 284 build_dir = joinpath(build_base, version)
 285 if not isdir(build_dir):
 286     os.mkdir(build_dir)
 287     # need some symlinks for m5 1.x
 288     if oldstyle:
 289         os.symlink(m5_dir, joinpath(build_dir, 'm5'))
 290         os.symlink(ext_dir, joinpath(build_dir, 'ext'))
 291         os.symlink(test_dir, joinpath(build_dir, 'test'))
 292         os.symlink(joinpath(m5_dir, 'build', 'SConstruct'),
 293                    joinpath(build_dir, 'SConstruct'))
 294         os.symlink(joinpath(m5_dir, 'build', 'default_options'),
 295                    joinpath(build_dir, 'default_options'))
 296
 297 sys.argv = [ progname ]
 298 if oldstyle:
 299     os.chdir(build_dir)
 300     sys.argv.extend(args)
 301 else:
 302     os.chdir(m5_dir)
 303     for arg in args:
 304         if not arg.startswith('-') and '=' not in arg:
 305             arg = joinpath(build_dir, 'build', arg)
 306         sys.argv.append(arg)
 307
 308 if options.no_compile or options.verbose:
 309     for arg in sys.argv[1:]:
 310         print arg
 311
 312 if not options.no_compile:
 313     do_compile()