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