xref: /petsc/config/BuildSystem/config/compilerFlags.py (revision 110eb670ad89fbcadbea7d9f7f29d6f14def0543)
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      options.setup()
68    except ImportError:
69      self.logPrint('ERROR: Failed to load user options module '+str(self.argDB['optionsModule']))
70    return options
71
72  def configureCompilerFlags(self):
73    '''Get the default compiler flags'''
74    self.debugging = self.argDB['with-debugging']
75    bopts = ['']
76    if self.debugging:
77      bopts.append('g')
78    else:
79      bopts.append('O')
80    options = self.getOptionsObject()
81    if not options:
82      return
83    self.setCompilers.saveLog()
84    options.saveLog()
85    for language, compiler in [('C', 'CC'), ('Cxx', 'CXX'), ('FC', 'FC'), ('CUDA', 'CUDAC')]:
86      if not hasattr(self.setCompilers, compiler):
87        continue
88      self.setCompilers.pushLanguage(language)
89      flagsName = self.getCompilerFlagsName(language)
90      try:
91        self.version[language] = self.argDB[language.upper()+'_VERSION']
92        if self.version[language] == 'Unknown':
93          self.version[language] = options.getCompilerVersion(language, self.setCompilers.getCompiler())
94      except RuntimeError:
95        pass
96      try:
97        self.rejected[language] = []
98        for bopt in bopts:
99          if not bopt == '' and self.getOptionalFlagsName(language) in self.argDB:
100            # treat user supplied options as single option - as it could include options separated by spaces '-tp k8-64'
101            flags = [self.argDB[self.getOptionalFlagsName(language)]]
102          elif not bopt == '' and self.hasOptFlags(getattr(self.setCompilers,flagsName)):
103            self.logPrint('Optimization options found in '+flagsName+ '. Skipping setting defaults')
104            flags = []
105          elif bopt == '' and flagsName in self.argDB:
106            self.logPrint('Ignoring default options which were overridden using --'+flagsName+ ' ' + self.argDB[flagsName])
107            flags = []
108          else:
109            flags = options.getCompilerFlags(language, self.setCompilers.getCompiler(), bopt)
110          for testFlag in flags:
111            if isinstance(testFlag,tuple):
112              testFlag = ' '.join(testFlag)
113            try:
114              self.logPrint('Trying '+language+' compiler flag '+testFlag)
115              self.setCompilers.addCompilerFlag(testFlag)
116            except RuntimeError:
117              self.logPrint('Rejected '+language+' compiler flag '+testFlag)
118              self.rejected[language].append(testFlag)
119      except RuntimeError:
120        pass
121      self.setCompilers.popLanguage()
122    self.logWrite(self.setCompilers.restoreLog())
123    self.logWrite(options.restoreLog())
124    return
125
126  def configure(self):
127    self.executeTest(self.configureCompilerFlags)
128    return
129