xref: /petsc/config/PETSc/options/libraryOptions.py (revision 5b6bfdb9644f185dbf5e5a09b808ec241507e1e7)
1#!/usr/bin/env python
2from __future__ import generators
3import user
4import config.base
5import os
6
7class Configure(config.base.Configure):
8  def __init__(self, framework):
9    config.base.Configure.__init__(self, framework)
10    self.headerPrefix = ''
11    self.substPrefix  = ''
12    return
13
14  def __str__(self):
15    return ''
16
17  def setupHelp(self, help):
18    import nargs
19    help.addArgument('PETSc', '-with-log=<bool>',              nargs.ArgBool(None, 1, 'Activate logging code in PETSc'))
20    help.addArgument('PETSc', '-with-threadsafety=<bool>',     nargs.ArgBool(None, 0, 'Allow individual threads in PETSc to call PETSc routines'))
21    help.addArgument('PETSc', '-with-info=<bool>',             nargs.ArgBool(None, 1, 'Activate PetscInfo() (i.e. -info)  code in PETSc'))
22    help.addArgument('PETSc', '-with-ctable=<bool>',           nargs.ArgBool(None, 1, 'Activate CTABLE hashing for certain search functions - to conserve memory'))
23    help.addArgument('PETSc', '-with-fortran-kernels=<bool>',  nargs.ArgBool(None, 0, 'Use Fortran for linear algebra kernels'))
24    help.addArgument('PETSc', '-with-avx512-kernels=<bool>',   nargs.ArgBool(None, 0, 'Use AVX-512 intrinsics for linear algebra kernels when available'))
25    help.addArgument('PETSc', '-with-is-color-value-type=<char,short>',nargs.ArgString(None, 'short', 'char, short can store 256, 65536 colors'))
26    return
27
28  def setupDependencies(self, framework):
29    config.base.Configure.setupDependencies(self, framework)
30    self.debugging   = framework.require('PETSc.options.debugging', self)
31    self.compilers   = framework.require('config.compilers', self)
32    self.libraries   = framework.require('config.libraries', self)
33    self.types       = framework.require('config.types', self)
34    return
35
36
37
38  def configureLibraryOptions(self):
39    '''Sets PETSC_USE_DEBUG, PETSC_USE_INFO, PETSC_USE_LOG, PETSC_USE_CTABLE, PETSC_USE_FORTRAN_KERNELS, and PETSC_USE_AVX512_KERNELS'''
40    '''Also sets PETSC_AssertAlignx() in Fortran and PETSC_Alignx() in C for IBM BG/P compiler '''
41    if self.framework.argDB['with-threadsafety']:
42      self.addDefine('HAVE_THREADSAFETY',1)
43      self.useThreadSafety = 1
44    else:
45      self.useThreadSafety = 0
46
47    if self.useThreadSafety and self.framework.argDB['with-log']:
48      raise RuntimeError('Must use --with-log=0 with --with-threadsafety')
49
50    self.useLog   = self.framework.argDB['with-log']
51    self.addDefine('USE_LOG',   self.useLog)
52
53    if self.debugging.debugging:
54      if self.useThreadSafety:
55        raise RuntimeError('Must use --with-debugging=0 with --with-threadsafety')
56      self.addDefine('USE_DEBUG',1)
57    elif not config.setCompilers.Configure.isIBM(self.framework.getCompiler(), self.log):
58      # IBM XLC version 12.1 (BG/Q and POWER) miscompiles PetscMalloc3()
59      # by reordering "*(void**)&ptr = x" as though ptr was not modified
60      # by this statement.
61      self.addDefine('USE_MALLOC_COALESCED',1)
62
63    self.useInfo   = self.framework.argDB['with-info']
64    self.addDefine('USE_INFO',   self.useInfo)
65
66    self.useCtable = self.framework.argDB['with-ctable']
67    if self.useCtable:
68      self.addDefine('USE_CTABLE', '1')
69
70    # used in src/mat/impls/sbaij/seq/relax.h
71    self.libraries.saveLog()
72    if not self.libraries.isBGL():
73      self.addDefine('USE_BACKWARD_LOOP','1')
74    self.logWrite(self.libraries.restoreLog())
75
76    self.useFortranKernels = self.framework.argDB['with-fortran-kernels']
77    if not hasattr(self.compilers, 'FC') and self.useFortranKernels:
78      raise RuntimeError('Cannot use fortran kernels without a Fortran compiler')
79    if self.useFortranKernels:
80      self.addDefine('USE_FORTRAN_KERNELS', 1)
81      if self.libraries.isBGL():
82        self.addDefine('AssertAlignx(a,b)','call ALIGNX(a,b)')
83      else:
84        self.addDefine('AssertAlignx(a,b)','  ')
85
86    self.useAVX512Kernels = self.framework.argDB['with-avx512-kernels']
87    if self.useAVX512Kernels:
88      self.addDefine('USE_AVX512_KERNELS', 1)
89
90    if self.libraries.isBGL():
91      self.addDefine('Alignx(a,b)','__alignx(a,b)')
92    else:
93      self.addDefine('Alignx(a,b)','  ')
94    return
95
96  def configureISColorValueType(self):
97    '''Sets PETSC_IS_COLOR_VALUE_TYPE, MPIU_COLORING_VALUE, IS_COLORING_MAX required by ISColor'''
98    self.isColorValueType  = self.framework.argDB['with-is-color-value-type']
99    if self.isColorValueType != 'char' and self.isColorValueType != 'short':
100      raise RuntimeError('Incorrect --with-is-color-value-type value specified. Can be either char or short. Specified value is :'+self.isColorValueType)
101    if self.isColorValueType == 'char':
102      max = pow(2,self.types.sizes['known-sizeof-char']*self.types.bits_per_byte)-1
103      mpi_type = 'MPI_UNSIGNED_CHAR'
104      type_f = 'integer1'
105    else:
106      max = pow(2,self.types.sizes['known-sizeof-short']*self.types.bits_per_byte)-1
107      mpi_type = 'MPI_UNSIGNED_SHORT'
108      type_f = 'integer2'
109
110    self.framework.addDefine('MPIU_COLORING_VALUE',mpi_type)
111    self.framework.addDefine('IS_COLORING_MAX',max)
112    self.addDefine('IS_COLOR_VALUE_TYPE', self.isColorValueType)
113    self.addDefine('IS_COLOR_VALUE_TYPE_F', type_f)
114    return
115
116  def configure(self):
117    self.executeTest(self.configureLibraryOptions)
118    self.executeTest(self.configureISColorValueType)
119    return
120