1#!/usr/bin/env python 2 3import os 4from distutils.sysconfig import parse_makefile 5import sys 6import logging 7sys.path.insert(0, os.path.abspath(os.path.dirname(__file__))) 8from collections import defaultdict 9 10AUTODIRS = set('ftn-auto ftn-custom f90-custom'.split()) # Automatically recurse into these, if they exist 11SKIPDIRS = set('benchmarks'.split()) # Skip these during the build 12NOWARNDIRS = set('tests tutorials'.split()) # Do not warn about mismatch in these 13 14def pathsplit(path): 15 """Recursively split a path, returns a tuple""" 16 stem, basename = os.path.split(path) 17 if stem == '': 18 return (basename,) 19 if stem == path: # fixed point, likely '/' 20 return (path,) 21 return pathsplit(stem) + (basename,) 22 23class Mistakes(object): 24 def __init__(self, log, verbose=False): 25 self.mistakes = [] 26 self.verbose = verbose 27 self.log = log 28 29 def compareDirLists(self,root, mdirs, dirs): 30 if NOWARNDIRS.intersection(pathsplit(root)): 31 return 32 smdirs = set(mdirs) 33 sdirs = set(dirs).difference(AUTODIRS) 34 if not smdirs.issubset(sdirs): 35 self.mistakes.append('Makefile contains directory not on filesystem: %s: %r' % (root, sorted(smdirs - sdirs))) 36 if not self.verbose: return 37 if smdirs != sdirs: 38 from sys import stderr 39 stderr.write('Directory mismatch at %s:\n\t%s: %r\n\t%s: %r\n\t%s: %r\n' 40 % (root, 41 'in makefile ',sorted(smdirs), 42 'on filesystem ',sorted(sdirs), 43 'symmetric diff',sorted(smdirs.symmetric_difference(sdirs)))) 44 45 def compareSourceLists(self, root, msources, files): 46 if NOWARNDIRS.intersection(pathsplit(root)): 47 return 48 smsources = set(msources) 49 ssources = set(f for f in files if os.path.splitext(f)[1] in ['.c', '.cxx', '.cc', '.cu', '.cpp', '.F']) 50 if not smsources.issubset(ssources): 51 self.mistakes.append('Makefile contains file not on filesystem: %s: %r' % (root, sorted(smsources - ssources))) 52 if not self.verbose: return 53 if smsources != ssources: 54 from sys import stderr 55 stderr.write('Source mismatch at %s:\n\t%s: %r\n\t%s: %r\n\t%s: %r\n' 56 % (root, 57 'in makefile ',sorted(smsources), 58 'on filesystem ',sorted(ssources), 59 'symmetric diff',sorted(smsources.symmetric_difference(ssources)))) 60 61 def summary(self): 62 for m in self.mistakes: 63 self.log.write(m + '\n') 64 if self.mistakes: 65 raise RuntimeError('PETSc makefiles contain mistakes or files are missing on filesystem.\n%s\nPossible reasons:\n\t1. Files were deleted locally, try "hg revert filename" or "git checkout filename".\n\t2. Files were deleted from repository, but were not removed from makefile. Send mail to petsc-maint@mcs.anl.gov.\n\t3. Someone forgot to "add" new files to the repository. Send mail to petsc-maint@mcs.anl.gov.' % ('\n'.join(self.mistakes))) 66 67def stripsplit(line): 68 return line[len('#requires'):].replace("'","").split() 69 70PetscPKGS = 'sys vec mat dm ksp snes ts tao'.split() 71LANGS = dict(c='C', cxx='CXX', cpp='CPP', cu='CU', F='F', F90='F90') 72 73class debuglogger(object): 74 def __init__(self, log): 75 self._log = log 76 77 def write(self, string): 78 self._log.debug(string) 79 80class Petsc(object): 81 def __init__(self, petsc_dir=None, petsc_arch=None, pkg_dir=None, pkg_name=None, pkg_arch=None, pkg_pkgs=None, verbose=False): 82 if petsc_dir is None: 83 petsc_dir = os.environ.get('PETSC_DIR') 84 if petsc_dir is None: 85 try: 86 petsc_dir = parse_makefile(os.path.join('lib','petsc','conf', 'petscvariables')).get('PETSC_DIR') 87 finally: 88 if petsc_dir is None: 89 raise RuntimeError('Could not determine PETSC_DIR, please set in environment') 90 if petsc_arch is None: 91 petsc_arch = os.environ.get('PETSC_ARCH') 92 if petsc_arch is None: 93 try: 94 petsc_arch = parse_makefile(os.path.join(petsc_dir, 'lib','petsc','conf', 'petscvariables')).get('PETSC_ARCH') 95 finally: 96 if petsc_arch is None: 97 raise RuntimeError('Could not determine PETSC_ARCH, please set in environment') 98 self.petsc_dir = os.path.normpath(petsc_dir) 99 self.petsc_arch = petsc_arch.rstrip(os.sep) 100 self.pkg_dir = pkg_dir 101 self.pkg_name = pkg_name 102 self.pkg_arch = pkg_arch 103 if self.pkg_dir is None: 104 self.pkg_dir = petsc_dir 105 self.pkg_name = 'petsc' 106 self.pkg_arch = self.petsc_arch 107 if self.pkg_name is None: 108 self.pkg_name = os.path.basename(os.path.normpath(self.pkg_dir)) 109 if self.pkg_arch is None: 110 self.pkg_arch = self.petsc_arch 111 self.pkg_pkgs = PetscPKGS 112 if pkg_pkgs is not None: 113 self.pkg_pkgs += list(set(pkg_pkgs.split(','))-set(self.pkg_pkgs)) 114 self.read_conf() 115 try: 116 logging.basicConfig(filename=self.pkg_arch_path('lib',self.pkg_name,'conf', 'gmake.log'), level=logging.DEBUG) 117 except IOError: 118 # Disable logging if path is not writeable (e.g., prefix install) 119 logging.basicConfig(filename='/dev/null', level=logging.DEBUG) 120 self.log = logging.getLogger('gmakegen') 121 self.mistakes = Mistakes(debuglogger(self.log), verbose=verbose) 122 self.gendeps = [] 123 124 def arch_path(self, *args): 125 return os.path.join(self.petsc_dir, self.petsc_arch, *args) 126 127 def pkg_arch_path(self, *args): 128 return os.path.join(self.pkg_dir, self.pkg_arch, *args) 129 130 def read_conf(self): 131 self.conf = dict() 132 for line in open(self.arch_path('include', 'petscconf.h')): 133 if line.startswith('#define '): 134 define = line[len('#define '):] 135 space = define.find(' ') 136 key = define[:space] 137 val = define[space+1:] 138 self.conf[key] = val 139 self.conf.update(parse_makefile(self.arch_path('lib','petsc','conf', 'petscvariables'))) 140 # allow parsing package additional configurations (if any) 141 if self.pkg_name != 'petsc' : 142 f = self.pkg_arch_path('include', self.pkg_name + 'conf.h') 143 if os.path.isfile(f): 144 for line in open(self.pkg_arch_path('include', self.pkg_name + 'conf.h')): 145 if line.startswith('#define '): 146 define = line[len('#define '):] 147 space = define.find(' ') 148 key = define[:space] 149 val = define[space+1:] 150 self.conf[key] = val 151 f = self.pkg_arch_path('lib',self.pkg_name,'conf', self.pkg_name + 'variables') 152 if os.path.isfile(f): 153 self.conf.update(parse_makefile(self.pkg_arch_path('lib',self.pkg_name,'conf', self.pkg_name + 'variables'))) 154 self.have_fortran = int(self.conf.get('PETSC_HAVE_FORTRAN', '0')) 155 156 def inconf(self, key, val): 157 if key in ['package', 'function', 'define']: 158 return self.conf.get(val) 159 elif key == 'precision': 160 return val == self.conf['PETSC_PRECISION'] 161 elif key == 'scalar': 162 return val == self.conf['PETSC_SCALAR'] 163 elif key == 'language': 164 return val == self.conf['PETSC_LANGUAGE'] 165 raise RuntimeError('Unknown conf check: %s %s' % (key, val)) 166 167 def relpath(self, root, src): 168 return os.path.relpath(os.path.join(root, src), self.pkg_dir) 169 170 def get_sources(self, makevars): 171 """Return dict {lang: list_of_source_files}""" 172 source = dict() 173 for lang, sourcelang in LANGS.items(): 174 source[lang] = [f for f in makevars.get('SOURCE'+sourcelang,'').split() if f.endswith(lang)] 175 return source 176 177 def gen_pkg(self, pkg): 178 pkgsrcs = dict() 179 for lang in LANGS: 180 pkgsrcs[lang] = [] 181 for root, dirs, files in os.walk(os.path.join(self.pkg_dir, 'src', pkg)): 182 dirs.sort() 183 files.sort() 184 makefile = os.path.join(root,'makefile') 185 if not os.path.exists(makefile): 186 dirs[:] = [] 187 continue 188 mklines = open(makefile) 189 conditions = set(tuple(stripsplit(line)) for line in mklines if line.startswith('#requires')) 190 mklines.close() 191 if not all(self.inconf(key, val) for key, val in conditions): 192 dirs[:] = [] 193 continue 194 makevars = parse_makefile(makefile) 195 mdirs = makevars.get('DIRS','').split() # Directories specified in the makefile 196 self.mistakes.compareDirLists(root, mdirs, dirs) # diagnostic output to find unused directories 197 candidates = set(mdirs).union(AUTODIRS).difference(SKIPDIRS) 198 dirs[:] = list(candidates.intersection(dirs)) 199 allsource = [] 200 def mkrel(src): 201 return self.relpath(root, src) 202 source = self.get_sources(makevars) 203 for lang, s in source.items(): 204 pkgsrcs[lang] += [mkrel(t) for t in s] 205 allsource += s 206 self.mistakes.compareSourceLists(root, allsource, files) # Diagnostic output about unused source files 207 self.gendeps.append(self.relpath(root, 'makefile')) 208 return pkgsrcs 209 210 def gen_gnumake(self, fd): 211 def write(stem, srcs): 212 for lang in LANGS: 213 fd.write('%(stem)s.%(lang)s := %(srcs)s\n' % dict(stem=stem, lang=lang, srcs=' '.join(srcs[lang]))) 214 for pkg in self.pkg_pkgs: 215 srcs = self.gen_pkg(pkg) 216 write('srcs-' + pkg, srcs) 217 return self.gendeps 218 219 def gen_ninja(self, fd): 220 libobjs = [] 221 for pkg in self.pkg_pkgs: 222 srcs = self.gen_pkg(pkg) 223 for lang in LANGS: 224 for src in srcs[lang]: 225 obj = '$objdir/%s.o' % src 226 fd.write('build %(obj)s : %(lang)s_COMPILE %(src)s\n' % dict(obj=obj, lang=lang.upper(), src=os.path.join(self.pkg_dir,src))) 227 libobjs.append(obj) 228 fd.write('\n') 229 fd.write('build $libdir/libpetsc.so : %s_LINK_SHARED %s\n\n' % ('CF'[self.have_fortran], ' '.join(libobjs))) 230 fd.write('build petsc : phony || $libdir/libpetsc.so\n\n') 231 232 def summary(self): 233 self.mistakes.summary() 234 235def WriteGnuMake(petsc): 236 arch_files = petsc.pkg_arch_path('lib',petsc.pkg_name,'conf', 'files') 237 fd = open(arch_files, 'w') 238 gendeps = petsc.gen_gnumake(fd) 239 fd.write('\n') 240 fd.write('# Dependency to regenerate this file\n') 241 fd.write('%s : %s %s\n' % (os.path.relpath(arch_files, petsc.pkg_dir), 242 os.path.relpath(__file__, os.path.realpath(petsc.pkg_dir)), 243 ' '.join(gendeps))) 244 fd.write('\n') 245 fd.write('# Dummy dependencies in case makefiles are removed\n') 246 fd.write(''.join([dep + ':\n' for dep in gendeps])) 247 fd.close() 248 249def WriteNinja(petsc): 250 conf = dict() 251 parse_makefile(os.path.join(petsc.petsc_dir, 'lib', 'petsc','conf', 'variables'), conf) 252 parse_makefile(petsc.arch_path('lib','petsc','conf', 'petscvariables'), conf) 253 build_ninja = petsc.arch_path('build.ninja') 254 fd = open(build_ninja, 'w') 255 fd.write('objdir = obj-ninja\n') 256 fd.write('libdir = lib\n') 257 fd.write('c_compile = %(PCC)s\n' % conf) 258 fd.write('c_flags = %(PETSC_CC_INCLUDES)s %(PCC_FLAGS)s %(CCPPFLAGS)s\n' % conf) 259 fd.write('c_link = %(PCC_LINKER)s\n' % conf) 260 fd.write('c_link_flags = %(PCC_LINKER_FLAGS)s\n' % conf) 261 if petsc.have_fortran: 262 fd.write('f_compile = %(FC)s\n' % conf) 263 fd.write('f_flags = %(PETSC_FC_INCLUDES)s %(FC_FLAGS)s %(FCPPFLAGS)s\n' % conf) 264 fd.write('f_link = %(FC_LINKER)s\n' % conf) 265 fd.write('f_link_flags = %(FC_LINKER_FLAGS)s\n' % conf) 266 fd.write('petsc_external_lib = %(PETSC_EXTERNAL_LIB_BASIC)s\n' % conf) 267 fd.write('python = %(PYTHON)s\n' % conf) 268 fd.write('\n') 269 fd.write('rule C_COMPILE\n' 270 ' command = $c_compile -MMD -MF $out.d $c_flags -c $in -o $out\n' 271 ' description = CC $out\n' 272 ' depfile = $out.d\n' 273 # ' deps = gcc\n') # 'gcc' is default, 'msvc' only recognized by newer versions of ninja 274 '\n') 275 fd.write('rule C_LINK_SHARED\n' 276 ' command = $c_link $c_link_flags -shared -o $out $in $petsc_external_lib\n' 277 ' description = CLINK_SHARED $out\n' 278 '\n') 279 if petsc.have_fortran: 280 fd.write('rule F_COMPILE\n' 281 ' command = $f_compile -MMD -MF $out.d $f_flags -c $in -o $out\n' 282 ' description = FC $out\n' 283 ' depfile = $out.d\n' 284 '\n') 285 fd.write('rule F_LINK_SHARED\n' 286 ' command = $f_link $f_link_flags -shared -o $out $in $petsc_external_lib\n' 287 ' description = FLINK_SHARED $out\n' 288 '\n') 289 fd.write('rule GEN_NINJA\n' 290 ' command = $python $in --output=ninja\n' 291 ' generator = 1\n' 292 '\n') 293 petsc.gen_ninja(fd) 294 fd.write('\n') 295 fd.write('build %s : GEN_NINJA | %s %s %s %s\n' % (build_ninja, 296 os.path.abspath(__file__), 297 os.path.join(petsc.petsc_dir, 'lib','petsc','conf', 'variables'), 298 petsc.arch_path('lib','petsc','conf', 'petscvariables'), 299 ' '.join(os.path.join(petsc.pkg_dir, dep) for dep in petsc.gendeps))) 300 301def main(petsc_dir=None, petsc_arch=None, pkg_dir=None, pkg_name=None, pkg_arch=None, pkg_pkgs=None, output=None, verbose=False): 302 if output is None: 303 output = 'gnumake' 304 writer = dict(gnumake=WriteGnuMake, ninja=WriteNinja) 305 petsc = Petsc(petsc_dir=petsc_dir, petsc_arch=petsc_arch, pkg_dir=pkg_dir, pkg_name=pkg_name, pkg_arch=pkg_arch, pkg_pkgs=pkg_pkgs, verbose=verbose) 306 writer[output](petsc) 307 petsc.summary() 308 309if __name__ == '__main__': 310 import optparse 311 parser = optparse.OptionParser() 312 parser.add_option('--verbose', help='Show mismatches between makefiles and the filesystem', action='store_true', default=False) 313 parser.add_option('--petsc-arch', help='Set PETSC_ARCH different from environment', default=os.environ.get('PETSC_ARCH')) 314 parser.add_option('--pkg-dir', help='Set the directory of the package (different from PETSc) you want to generate the makefile rules for', default=None) 315 parser.add_option('--pkg-name', help='Set the name of the package you want to generate the makefile rules for', default=None) 316 parser.add_option('--pkg-arch', help='Set the package arch name you want to generate the makefile rules for', default=None) 317 parser.add_option('--pkg-pkgs', help='Set the package folders (comma separated list, different from the usual sys,vec,mat etc) you want to generate the makefile rules for', default=None) 318 parser.add_option('--output', help='Location to write output file', default=None) 319 opts, extra_args = parser.parse_args() 320 if extra_args: 321 import sys 322 sys.stderr.write('Unknown arguments: %s\n' % ' '.join(extra_args)) 323 exit(1) 324 main(petsc_arch=opts.petsc_arch, pkg_dir=opts.pkg_dir, pkg_name=opts.pkg_name, pkg_arch=opts.pkg_arch, pkg_pkgs=opts.pkg_pkgs, output=opts.output, verbose=opts.verbose) 325