xref: /petsc/config/PETSc/options/arch.py (revision daa3e6777e3a7cb2ec8b671e7d217f332174a485)
1import config.base
2import os
3import re
4
5class Configure(config.base.Configure):
6  def __init__(self, framework):
7    config.base.Configure.__init__(self, framework)
8    self.headerPrefix = 'PETSC'
9    self.substPrefix  = 'PETSC'
10    return
11
12  def __str1__(self):
13    if not hasattr(self, 'arch'):
14      return ''
15    desc = ['PETSc:']
16    desc.append('  PETSC_ARCH: '+str(self.arch))
17    return '\n'.join(desc)+'\n'
18
19  def setupHelp(self, help):
20    import nargs
21    help.addArgument('PETSc', '-PETSC_ARCH=<string>',     nargs.Arg(None, None, 'The configuration name'))
22    help.addArgument('PETSc', '-with-petsc-arch=<string>',nargs.Arg(None, None, 'The configuration name'))
23    help.addArgument('PETSc', '-force=<bool>',            nargs.ArgBool(None, 0, 'Bypass configure hash caching, and run to completion'))
24    return
25
26  def setupDependencies(self, framework):
27    self.sourceControl = framework.require('config.sourceControl',self)
28    self.petscdir = framework.require('PETSc.options.petscdir', self)
29    return
30
31  def setNativeArchitecture(self):
32    import sys
33    arch = 'arch-' + sys.platform.replace('cygwin','mswin')
34    # use opt/debug, c/c++ tags.s
35    arch+= '-'+self.framework.argDB['with-clanguage'].lower().replace('+','x')
36    if self.framework.argDB['with-debugging']:
37      arch += '-debug'
38    else:
39      arch += '-opt'
40    self.nativeArch = arch
41    return
42
43  def configureArchitecture(self):
44    '''Checks PETSC_ARCH and sets if not set'''
45    # Warn if PETSC_ARCH doesn't match env variable
46    if 'PETSC_ARCH' in self.framework.argDB and 'PETSC_ARCH' in os.environ and self.framework.argDB['PETSC_ARCH'] != os.environ['PETSC_ARCH']:
47      self.logPrintBox('''\
48Warning: PETSC_ARCH from environment does not match command-line or name of script.
49Warning: Using from command-line or name of script: %s, ignoring environment: %s''' % (str(self.framework.argDB['PETSC_ARCH']), str(os.environ['PETSC_ARCH'])))
50      os.environ['PETSC_ARCH'] = self.framework.argDB['PETSC_ARCH']
51    if 'with-petsc-arch' in self.framework.argDB:
52      self.arch = self.framework.argDB['with-petsc-arch']
53      msg = 'option -with-petsc-arch='+str(self.arch)
54    elif 'PETSC_ARCH' in self.framework.argDB:
55      self.arch = self.framework.argDB['PETSC_ARCH']
56      msg = 'option PETSC_ARCH='+str(self.arch)
57    elif 'PETSC_ARCH' in os.environ:
58      self.arch = os.environ['PETSC_ARCH']
59      msg = 'environment variable PETSC_ARCH='+str(self.arch)
60    else:
61      self.arch = self.nativeArch
62    if self.arch.find('/') >= 0 or self.arch.find('\\') >= 0:
63      raise RuntimeError('PETSC_ARCH should not contain path characters, but you have specified with '+msg)
64    if self.arch.startswith('-'):
65      raise RuntimeError('PETSC_ARCH should not start with "-", but you have specified with '+msg)
66    if self.arch.startswith('.'):
67      raise RuntimeError('PETSC_ARCH should not start with ".", but you have specified with '+msg)
68    if not len(self.arch):
69      raise RuntimeError('PETSC_ARCH cannot be empty string. Use a valid string or do not set one. Currently set with '+msg)
70    self.archBase = re.sub(r'^(\w+)[-_]?.*$', r'\1', self.arch)
71    return
72
73  def makeDependency(self,hash,hashfile,hashfilepackages):
74    '''Deletes the current hashfile and saves the hashfile names and its value in framework so that'''
75    '''framework.Configure can create the file upon success of configure'''
76    import os
77    if hash:
78      self.framework.hash = hash
79      self.framework.hashfile = hashfile
80      self.logPrint('Setting hashfile: '+hashfile)
81      if hashfilepackages: self.framework.hashfilepackages = hashfilepackages
82    try:
83      self.logPrint('Deleting configure hash file: '+hashfile)
84      os.remove(hashfile)
85      self.logPrint('Deleted configure hash file: '+hashfile)
86    except:
87      self.logPrint('Unable to delete configure hash file: '+hashfile)
88
89
90  def checkDependency(self):
91    '''Checks if files in config have changed, the command line options have changed or the PATH has changed'''
92    '''  By default - checks if configure needs to be run'''
93    '''  If --arch-hash it manages the same information but it:'''
94    '''     * computes a short hash for the configuration <hashvalue>'''
95    '''     * sets self.arch and PETSC_ARCH to arch-<hashvalue>'''
96    '''       This results in the downloaded packages being installed once to the arch-<hasvalue> directory'''
97    '''       and a new directory with a different hash is created if the configuration changes.'''
98    '''     This mode is intended mostly for testing to reduce reconfigure and recompile times (not currently used)'''
99    '''  If --package-prefix-hash=directory is provided'''
100    '''     * computes a short hash for the configuration <hashvalue>'''
101    '''     * puts the downloaded external packages into location directory/hash'''
102    '''       This results in the downloaded packages being installed once'''
103    '''       and a new directory with a different hash is created if the configuration changes.'''
104    '''     This mode is intended mostly for testing to reduce time of reinstalling external packages'''
105    import os
106    import sys
107    import hashlib
108    args = sorted(set(filter(lambda x: not (x.startswith('PETSC_ARCH') or x == '--force'),sys.argv[1:])))
109    hash = 'args:\n' + '\n'.join('    '+a for a in args) + '\n'
110    hash += 'PATH=' + os.environ.get('PATH', '') + '\n'
111    try:
112      for root, dirs, files in os.walk('config'):
113        if root == 'config':
114          dirs.remove('examples')
115        for f in files:
116          if not f.endswith('.py') or f.startswith('.') or f.startswith('#'):
117            continue
118          fname = os.path.join(root, f)
119          with open(fname,'rb') as f:
120            hash += hashlib.sha256(f.read()).hexdigest() + '  ' + fname + '\n'
121    except:
122      self.logPrint('Error generating file list/hash from config directory for configure hash, forcing new configuration')
123      return
124
125    hashfilepackages = None
126    # Generate short hash to use for the arch so the same arch can be reused if the configuration files don't change
127    if 'arch-hash' in self.argDB:
128      if self.argDB['prefix']:
129        raise RuntimeError('Cannot provide --prefix and --arch-hash')
130      if hasattr(self.argDB,'PETSC_ARCH'):
131        raise RuntimeError('Cannot provide PETSC_ARCH and --arch-hash')
132      if 'package-prefix-hash' in self.argDB:
133        raise RuntimeError('Cannot provide --arch-hash and --package-prefix-hash')
134      if os.getenv('PETSC_ARCH'):
135        raise RuntimeError('Do not set the environmental variable PETSC_ARCH and use --arch-hash')
136    if 'arch-hash' in self.argDB or 'package-prefix-hash' in self.argDB:
137      import hashlib
138      m = hashlib.md5()
139      m.update(hash)
140      hprefix = m.hexdigest()
141      if 'arch-hash' in self.argDB:
142        self.argDB['PETSC_ARCH'] = 'arch-'+hprefix[0:6]
143        self.arch = 'arch-'+hprefix[0:6]
144      else:
145        if not os.path.isdir(self.argDB['package-prefix-hash']):
146          raise RuntimeError('--package-prefix-hash '+self.argDB['package-prefix-hash']+' directory does not exist\n')
147        self.argDB['prefix'] = os.path.join(self.argDB['package-prefix-hash'],hprefix[0:6])
148        if not os.path.isdir(self.argDB['prefix']):
149          os.mkdir(self.argDB['prefix'])
150          hashfilepackages = os.path.join(self.argDB['prefix'],'configure-hash')
151        else:
152          try:
153            with open(os.path.join(self.argDB['prefix'],'configure-hash'), 'r') as f:
154              a = f.read()
155          except:
156            self.logPrint('No previous hashfilepackages found')
157            a = ''
158          if a == hash:
159            self.logPrint('Reusing download packages in '+self.argDB['prefix'])
160            self.argDB['package-prefix-hash'] = 'reuse' # indicates prefix libraries already built, no need to rebuild
161
162    hashfile = os.path.join(self.arch,'lib','petsc','conf','configure-hash')
163
164    if self.argDB['force']:
165      self.logPrint('Forcing a new configuration requested by use')
166      self.makeDependency(hash,hashfile,None)
167      return
168    a = ''
169    try:
170      with open(hashfile, 'r') as f:
171        a = f.read()
172    except:
173      self.logPrint('No previous hashfile found')
174      self.makeDependency(hash,hashfile,hashfilepackages)
175      return
176    if a == hash:
177      try:
178        self.logPrint('Attempting to save lib/petsc/conf/petscvariables file')
179        with open(os.path.join('lib','petsc','conf','petscvariables'), 'w') as g:
180          g.write('PETSC_ARCH='+self.arch+'\n')
181          g.write('PETSC_DIR='+self.petscdir.dir+'\n')
182          g.write('include $(PETSC_DIR)/$(PETSC_ARCH)/lib/petsc/conf/petscvariables\n')
183          self.logPrint('Saved lib/petsc/conf/petscvariables file')
184      except:
185        self.logPrint('Unable to save lib/petsc/conf/petscvariables file')
186      self.logPrint('configure hash file: '+hashfile+' matches; no need to run configure.')
187      print('Your configure options and state has not changed; no need to run configure')
188      print('However you can force a configure run using the option: --force')
189      sys.exit()
190    self.logPrint('configure hash file: '+hashfile+' does not match\n'+a+'\n---\n'+hash+'\n need to run configure')
191    self.makeDependency(hash,hashfile,hashfilepackages)
192
193  def configure(self):
194    self.executeTest(self.setNativeArchitecture)
195    self.executeTest(self.configureArchitecture)
196    # required by top-level configure.py
197    self.framework.arch = self.arch
198    self.checkDependency()
199    return
200