xref: /petsc/config/BuildSystem/config/compilerFlags.py (revision eab890ac70e3f8cf2d8ed246aa467cd84d643ced)
1import config.base
2
3import re
4import os
5
6class Configure(config.base.Configure):
7  def __init__(self, framework):
8    config.base.Configure.__init__(self, framework)
9    self.headerPrefix = ''
10    self.substPrefix  = ''
11    self.version = {}
12    self.rejected = {}
13    return
14
15  def __str__(self):
16    return ''
17
18  def setupHelp(self, help):
19    import nargs
20    help.addArgument('Compiler Flags', '-optionsModule=<module name>', nargs.Arg(None, 'config.compilerOptions', 'The Python module used to determine compiler options and versions'))
21    help.addArgument('Compiler Flags', '-with-debugging=<bool>', nargs.ArgBool(None, 1, 'Specify debugging version of libraries'))
22    help.addArgument('Compiler Flags', '-C_VERSION=<string>',   nargs.Arg(None, 'Unknown', 'The version of the C compiler'))
23    help.addArgument('Compiler Flags', '-CXX_VERSION=<string>', nargs.Arg(None, 'Unknown', 'The version of the C++ compiler'))
24    help.addArgument('Compiler Flags', '-FC_VERSION=<string>',  nargs.Arg(None, 'Unknown', 'The version of the Fortran compiler'))
25    help.addArgument('Compiler Flags', '-CUDA_VERSION=<string>',nargs.Arg(None, 'Unknown', 'The version of the CUDA compiler'))
26    help.addArgument('Compiler Flags', '-COPTFLAGS=<string>',   nargs.Arg(None, None, 'Override the debugging/optimization flags for the C compiler'))
27    help.addArgument('Compiler Flags', '-CXXOPTFLAGS=<string>', nargs.Arg(None, None, 'Override the debugging/optimization flags for the C++ compiler'))
28    help.addArgument('Compiler Flags', '-FOPTFLAGS=<string>',   nargs.Arg(None, None, 'Override the debugging/optimization flags for the Fortran compiler'))
29    help.addArgument('Compiler Flags', '-CUDAOPTFLAGS=<string>',   nargs.Arg(None, None, 'Override the debugging/optimization flags for the CUDA compiler'))
30    # not sure where to put this, currently gcov is handled in ../compilerOptions.py
31    help.addArgument('Compiler Flags', '-with-gcov=<bool>', nargs.ArgBool(None, 0, 'Specify that GNUs coverage tool gcov is used'))
32    return
33
34  def setupDependencies(self, framework):
35    config.base.Configure.setupDependencies(self, framework)
36    self.setCompilers = framework.require('config.setCompilers', self)
37    return
38
39  def getOptionalFlagsName(self, language, compilerOnly = 0):
40    if language == 'C':
41      flagsArg = 'COPTFLAGS'
42    elif language == 'Cxx':
43      if compilerOnly:
44        flagsArg = 'CXX_CXXOPTFLAGS'
45      else:
46        flagsArg = 'CXXOPTFLAGS'
47    elif language == 'FC':
48      flagsArg = 'FOPTFLAGS'
49    elif language == 'CUDA':
50      flagsArg = 'CUDAOPTFLAGS'
51    else:
52      raise RuntimeError('Unknown language: '+language)
53    return flagsArg
54
55  def hasOptFlags(self,flags):
56    for flag in flags.split():
57      if flag.startswith('-g') or flag.startswith('-O') or flag in ['-fast']:
58        return 1
59    return 0
60
61  def getOptionsObject(self):
62    '''Get a configure object which will return default options for each compiler'''
63    options = None
64    try:
65      mod     = __import__(self.argDB['optionsModule'], locals(), globals(), ['CompilerOptions'])
66      options = mod.CompilerOptions(self.framework)
67    except ImportError:
68      self.logPrint('ERROR: Failed to load user options module '+str(self.argDB['optionsModule']))
69    return options
70
71  def configureCompilerFlags(self):
72    '''Get the default compiler flags'''
73    self.debugging = self.argDB['with-debugging']
74    bopts = ['']
75    if self.debugging:
76      bopts.append('g')
77    else:
78      bopts.append('O')
79    options = self.getOptionsObject()
80    if not options:
81      return
82    self.setCompilers.saveLog()
83    options.saveLog()
84    for language, compiler in [('C', 'CC'), ('Cxx', 'CXX'), ('FC', 'FC'), ('CUDA', 'CUDAC')]:
85      if not hasattr(self.setCompilers, compiler):
86        continue
87      self.setCompilers.pushLanguage(language)
88      flagsName = self.getCompilerFlagsName(language)
89      try:
90        self.version[language] = self.argDB[language.upper()+'_VERSION']
91        if self.version[language] == 'Unknown':
92          self.version[language] = options.getCompilerVersion(language, self.setCompilers.getCompiler())
93      except RuntimeError:
94        pass
95      try:
96        self.rejected[language] = []
97        for bopt in bopts:
98          if not bopt == '' and self.getOptionalFlagsName(language) in self.argDB:
99            # treat user supplied options as single option - as it could include options separated by spaces '-tp k8-64'
100            flags = [self.argDB[self.getOptionalFlagsName(language)]]
101          elif not bopt == '' and self.hasOptFlags(getattr(self.setCompilers,flagsName)):
102            self.logPrint('Optimization options found in '+flagsName+ '. Skipping setting defaults')
103            flags = []
104          elif bopt == '' and flagsName in self.argDB:
105            self.logPrint('Ignoring default options which were overridden using --'+flagsName+ ' ' + self.argDB[flagsName])
106            flags = []
107          else:
108            flags = options.getCompilerFlags(language, self.setCompilers.getCompiler(), bopt)
109          for testFlag in flags:
110            if isinstance(testFlag,tuple):
111              testFlag = ' '.join(testFlag)
112            try:
113              self.logPrint('Trying '+language+' compiler flag '+testFlag)
114              self.setCompilers.addCompilerFlag(testFlag)
115            except RuntimeError:
116              self.logPrint('Rejected '+language+' compiler flag '+testFlag)
117              self.rejected[language].append(testFlag)
118      except RuntimeError:
119        pass
120      self.setCompilers.popLanguage()
121    self.logWrite(self.setCompilers.restoreLog())
122    self.logWrite(options.restoreLog())
123    return
124
125  def configure(self):
126    self.executeTest(self.configureCompilerFlags)
127    return
128