xref: /petsc/config/BuildSystem/config/packages/MUMPS.py (revision f13dfd9ea68e0ddeee984e65c377a1819eab8a8a)
1import config.package
2
3class Configure(config.package.Package):
4  def __init__(self, framework):
5    config.package.Package.__init__(self, framework)
6    self.version          = '5.6.2'
7    self.minversion       = '5.2.1'
8    self.versionname      = 'MUMPS_VERSION'
9    self.requiresversion  = 1
10    self.gitcommit        = 'v'+self.version
11    self.download         = ['https://graal.ens-lyon.fr/MUMPS/MUMPS_'+self.version+'.tar.gz',
12                             'https://web.cels.anl.gov/projects/petsc/download/externalpackages/MUMPS_'+self.version+'.tar.gz']
13    self.downloaddirnames = ['petsc-pkg-mumps','MUMPS']
14    self.buildLanguages   = ['C','FC']
15    self.precisions       = ['single','double']
16    self.downloadonWindows= 1
17    self.hastests         = 1
18    self.hastestsdatafiles= 1
19    self.license          = 'https://mumps-solver.org/index.php?page=dwnld#form'
20    return
21
22  def setupHelp(self, help):
23    import nargs
24    config.package.Package.setupHelp(self, help)
25    help.addArgument('MUMPS', '-with-mumps-serial', nargs.ArgBool(None, 0, 'Use serial build of MUMPS'))
26    help.addArgument('MUMPS', '-download-mumps-avoid-mpi-in-place', nargs.ArgBool(None, 0, 'Let MUMPS not use MPI_IN_PLACE. Since MUMPS-5.6.2, it can be used to avoid a bug in MPICH older than 4.0b1'))
27    return
28
29  def setupDependencies(self, framework):
30    config.package.Package.setupDependencies(self, framework)
31    self.flibs            = framework.require('config.packages.flibs',self)
32    self.blasLapack       = framework.require('config.packages.BlasLapack',self)
33    self.mpi              = framework.require('config.packages.MPI',self)
34    self.metis            = framework.require('config.packages.metis',self)
35    self.parmetis         = framework.require('config.packages.parmetis',self)
36    self.ptscotch         = framework.require('config.packages.PTScotch',self)
37    self.scalapack        = framework.require('config.packages.scalapack',self)
38    self.hwloc            = framework.require('config.packages.hwloc',self)
39    self.openmp           = framework.require('config.packages.openmp',self)
40    self.scalartypes      = framework.require('PETSc.options.scalarTypes',self)
41    if self.argDB['with-mumps-serial']:
42      self.deps           = [self.blasLapack,self.flibs]
43      self.odeps          = [self.metis,self.openmp]
44    else:
45      self.deps           = [self.scalapack,self.mpi,self.blasLapack,self.flibs]
46      self.odeps          = [self.metis,self.parmetis,self.ptscotch,self.hwloc,self.openmp]
47    return
48
49  def configureLibrary(self):
50    for arg in ['with-64-bit-blas-indices','known-64-bit-blas-indices']:
51      if self.argDB.get(arg):
52        raise RuntimeError('MUMPS cannot be used with %s' % arg)
53    if self.scalartypes.precision == 'single':
54      if self.scalartypes.scalartype == 'real': l = 's'
55      else: l = 'c'
56    else:
57      if self.scalartypes.scalartype == 'real': l = 'd'
58      else: l = 'z'
59    self.functions = [l+'mumps_c']
60    self.includes  = [l+'mumps_c.h']
61    liblist_common = [['libmumps_common.a','libpord.a','libpthread.a'],
62                     ['libmumps_common.a','libpord.a'],
63                     ['libmumps_common.a','libpord.a','libmpiseq.a'],
64                     ['libmumps_common.a','libpord.a','libpthread.a','libmpiseq.a']]
65    self.liblist   = []
66    for libc in liblist_common:
67       self.liblist.append(['lib'+l+'mumps.a'] + libc)
68    config.package.Package.configureLibrary(self)
69
70  def consistencyChecks(self):
71    config.package.Package.consistencyChecks(self)
72    if self.argDB['with-'+self.package] or self.argDB['download-'+self.package]:
73      if self.mpi.usingMPIUni and not self.argDB['with-mumps-serial']:
74        raise RuntimeError('Since you are building without MPI you must use --with-mumps-serial to install the correct MUMPS.')
75    if self.argDB['with-mumps-serial']:
76      if not self.mpi.usingMPIUni:
77        raise RuntimeError('Serial MUMPS version is only compatible with MPIUni\nReconfigure using --with-mpi=0')
78    return
79
80  def Install(self):
81    import os
82
83    if self.openmp.found:
84      #  MUMPS has no make flags for turning on/off OpenMP it just uses it if it can
85      self.usesopenmp = 'yes'
86      # use OMP_NUM_THREADS to control the number of threads used
87
88    if not self.fortran.FortranDefineCompilerOption:
89      raise RuntimeError('Fortran compiler cannot handle preprocessing directives from command line.')
90    g = open(os.path.join(self.packageDir,'Makefile.inc'),'w')
91    g.write('LPORDDIR   = $(topdir)/PORD/lib/\n')
92    g.write('IPORD      = -I$(topdir)/PORD/include/\n')
93    g.write('LPORD      = -L$(LPORDDIR) -lpord\n')
94    g.write('PLAT       = \n')
95    orderingsc = '-Dpord'
96    orderingsf = self.fortran.FortranDefineCompilerOption+'pord'
97    # Disable threads on BGL
98    if self.libraries.isBGL():
99      orderingsc += ' -DWITHOUT_PTHREAD'
100    if self.metis.found:
101      g.write('IMETIS = '+self.headers.toString(self.metis.include)+'\n')
102      g.write('LMETIS = '+self.libraries.toString(self.metis.lib)+'\n')
103      orderingsc += ' -Dmetis'
104      orderingsf += ' '+self.fortran.FortranDefineCompilerOption+'metis'
105    if self.parmetis.found:
106      g.write('IPARMETIS = '+self.headers.toString(self.parmetis.include)+'\n')
107      g.write('LPARMETIS = '+self.libraries.toString(self.parmetis.lib)+'\n')
108      orderingsc += ' -Dparmetis'
109      orderingsf += ' '+self.fortran.FortranDefineCompilerOption+'parmetis'
110    if self.ptscotch.found:
111      g.write('ISCOTCH = '+self.headers.toString(self.ptscotch.include)+'\n')
112      g.write('LSCOTCH = '+self.libraries.toString(self.ptscotch.lib)+'\n')
113      orderingsc += ' -Dscotch  -Dptscotch'
114      orderingsf += ' '+self.fortran.FortranDefineCompilerOption+'scotch '+self.fortran.FortranDefineCompilerOption+'ptscotch'
115
116    g.write('ORDERINGSC = '+orderingsc+'\n')
117    g.write('ORDERINGSF = '+orderingsf+'\n')
118    g.write('LORDERINGS  = $(LPARMETIS) $(LMETIS) $(LPORD) $(LSCOTCH)\n')
119    g.write('IORDERINGSC = $(IPARMETIS) $(IMETIS) $(IPORD) $(ISCOTCH)\n')
120    g.write('IORDERINGSF = $(ISCOTCH)\n')
121
122    g.write('RM = /bin/rm -f\n')
123    self.pushLanguage('C')
124    g.write('CC = '+self.getCompiler()+'\n')
125    g.write('OPTC    = '+self.updatePackageCFlags(self.getCompilerFlags())+'\n')
126    g.write('OUTC = -o \n')
127    self.popLanguage()
128    if not self.fortran.fortranIsF90:
129      raise RuntimeError('Installing MUMPS requires a F90 compiler')
130    self.pushLanguage('FC')
131    g.write('FC = '+self.getCompiler()+'\n')
132    g.write('FL = '+self.getCompiler()+'\n')
133    g.write('OPTF    = '+self.updatePackageFFlags(self.getCompilerFlags())+'\n')
134    if self.blasLapack.checkForRoutine('dgemmt'):
135      g.write('OPTF   += -DGEMMT_AVAILABLE\n')
136    g.write('OUTF = -o \n')
137    self.popLanguage()
138
139    # set fortran name mangling
140    # this mangling information is for both BLAS and the Fortran compiler so cannot use the BlasLapack mangling flag
141    if self.compilers.fortranManglingDoubleUnderscore:
142      g.write('CDEFS   = -DAdd__\n')
143    elif self.compilers.fortranMangling == 'underscore':
144      g.write('CDEFS   = -DAdd_\n')
145    elif self.compilers.fortranMangling == 'caps':
146      g.write('CDEFS   = -DUPPPER\n')
147
148    g.write('AR      = '+self.setCompilers.AR+' '+self.setCompilers.AR_FLAGS+' \n')
149    g.write('LIBEXT  = .'+self.setCompilers.AR_LIB_SUFFIX+'\n')
150    g.write('RANLIB  = '+self.setCompilers.RANLIB+'\n')
151    g.write('SCALAP  = '+self.libraries.toString(self.scalapack.lib)+'\n')
152    if not self.argDB['with-mumps-serial']:
153      g.write('INCPAR  = '+self.headers.toString(self.mpi.include)+'\n')
154      g.write('LIBPAR  = $(SCALAP) '+self.libraries.toString(self.mpi.lib)+'\n')
155    else:
156      g.write('INCPAR  = -I../libseq\n')
157    g.write('INCSEQ  = -I$(topdir)/libseq\n')
158    g.write('LIBSEQ  =  $(LAPACK) -L$(topdir)/libseq -lmpiseq\n')
159    g.write('LIBBLAS = '+self.libraries.toString(self.blasLapack.dlib)+'\n')
160    g.write('OPTL    = '+self.getLinkerFlags()+'\n')
161    g.write('INCS = $(INCPAR)\n')
162    g.write('LIBS = $(LIBPAR)\n')
163    if self.argDB['with-mumps-serial']:
164      g.write('LIBSEQNEEDED = libseqneeded\n')
165      g.write('LIBS = $(LIBSEQ)\n')
166    else:
167      g.write('LIBSEQNEEDED =\n')
168      if self.openmp.found and self.hwloc.found:
169        g.write('LIBS += '+self.libraries.toString(self.hwloc.lib)+'\n')
170        g.write('OPTF += -DUSE_LIBHWLOC\n')
171        g.write('OPTC += -DUSE_LIBHWLOC\n')
172      # To avoid a bug related to MPI_IN_PLACE and old MPICH releases, see MR 4410
173      self.avoid_mpi_in_place = 0
174      if 'download-mumps-avoid-mpi-in-place' in self.framework.clArgDB: # user-provided value takes precedence
175        self.avoid_mpi_in_place = self.framework.clArgDB['download-mumps-avoid-mpi-in-place']
176      elif hasattr(self.mpi, 'mpich_numversion') and int(self.mpi.mpich_numversion) < 40000101:
177        self.avoid_mpi_in_place = 1
178      if self.avoid_mpi_in_place:
179        g.write('CDEFS += -DAVOID_MPI_IN_PLACE') # only take effect since mumps-5.6.2
180        self.addDefine('HAVE_MUMPS_AVOID_MPI_IN_PLACE', 1)
181    g.close()
182    if self.installNeeded('Makefile.inc'):
183      try:
184        output1,err1,ret1  = config.package.Package.executeShellCommand('make clean', cwd=self.packageDir, timeout=60, log = self.log)
185      except RuntimeError as e:
186        pass
187      try:
188        self.logPrintBox('Compiling MUMPS; this may take several minutes')
189        output2,err2,ret2 = config.package.Package.executeShellCommand(self.make.make_jnp+' prerequisites', cwd=self.packageDir, timeout=2500, log = self.log)
190        output3,err3,ret3 = config.package.Package.executeShellCommand(self.make.make_jnp+' all', cwd=os.path.join(self.packageDir,'src'), timeout=2500, log = self.log)
191        libDir     = self.libDir
192        includeDir = os.path.join(self.installDir, self.includedir)
193        self.logPrintBox('Installing MUMPS; this may take several minutes')
194        output,err,ret = config.package.Package.executeShellCommandSeq(
195          ['mkdir -p '+libDir+' '+includeDir,
196           'cp -f lib/*.* '+libDir+'/.',
197           'cp -f include/*.* '+includeDir+'/.'
198          ], cwd=self.packageDir, timeout=60, log = self.log)
199        if self.argDB['with-mumps-serial']:
200          output,err,ret = config.package.Package.executeShellCommand(['cp', '-f', 'libseq/libmpiseq.a', libDir+'/.'], cwd=self.packageDir, timeout=60, log = self.log)
201      except RuntimeError as e:
202        self.logPrint('Error running make on MUMPS: '+str(e))
203        raise RuntimeError('Error running make on MUMPS')
204      self.postInstall(output1+err1+output2+err2+output3+err3,'Makefile.inc')
205    return self.installDir
206
207