xref: /petsc/src/sys/objects/init.c (revision aba4c478dbfe659dc4eb6bc99941d517bcb613f6)
1e5c89e4eSSatish Balay /*
2e5c89e4eSSatish Balay 
3e5c89e4eSSatish Balay    This file defines part of the initialization of PETSc
4e5c89e4eSSatish Balay 
5540e20f2SPierre Jolivet   This file uses regular malloc and free because it cannot be known
6e5c89e4eSSatish Balay   what malloc is being used until it has already processed the input.
7e5c89e4eSSatish Balay */
8ef386f4bSSatish Balay 
9ef386f4bSSatish Balay #include <petscsys.h>        /*I  "petscsys.h"   I*/
10f67a399dSBarry Smith #include <petsc/private/petscimpl.h>
11022afb99SBarry Smith #include <petscvalgrind.h>
12665c2dedSJed Brown #include <petscviewer.h>
13fdc842d1SBarry Smith #if defined(PETSC_USE_LOG)
14fdc842d1SBarry Smith PETSC_INTERN PetscErrorCode PetscLogInitialize(void);
15fdc842d1SBarry Smith #endif
16ef386f4bSSatish Balay 
17ba61063dSBarry Smith #if defined(PETSC_HAVE_SYS_SYSINFO_H)
1851d315f7SKerry Stevens #include <sys/sysinfo.h>
19ba61063dSBarry Smith #endif
20121deb67SSatish Balay #if defined(PETSC_HAVE_UNISTD_H)
2151d315f7SKerry Stevens #include <unistd.h>
22121deb67SSatish Balay #endif
23d9b72601SDominic Meiser #if defined(PETSC_HAVE_CUDA)
24d9b72601SDominic Meiser #include <cuda_runtime.h>
257fd2f626SJose E. Roman #include <petsccublas.h>
26c2a741eeSJunchao Zhang #if defined(PETSC_HAVE_OMPI_MAJOR_VERSION)
27c2a741eeSJunchao Zhang #include "mpi-ext.h" /* Needed for OpenMPI CUDA-aware check */
28c2a741eeSJunchao Zhang #endif
29d9b72601SDominic Meiser #endif
30555d055bSBarry Smith 
31f0a7718cSKarl Rupp #if defined(PETSC_HAVE_VIENNACL)
32f0a7718cSKarl Rupp PETSC_EXTERN PetscErrorCode PetscViennaCLInit();
33f0a7718cSKarl Rupp #endif
34f0a7718cSKarl Rupp 
35e5c89e4eSSatish Balay /* ------------------------Nasty global variables -------------------------------*/
36e5c89e4eSSatish Balay /*
37e5c89e4eSSatish Balay      Indicates if PETSc started up MPI, or it was
38e5c89e4eSSatish Balay    already started before PETSc was initialized.
39e5c89e4eSSatish Balay */
400cbf60d0SJose E. Roman PetscBool   PetscBeganMPI         = PETSC_FALSE;
410cbf60d0SJose E. Roman PetscBool   PetscInitializeCalled = PETSC_FALSE;
420cbf60d0SJose E. Roman PetscBool   PetscFinalizeCalled   = PETSC_FALSE;
43bffec52eSKarl Rupp PetscBool   PetscCUDAInitialized  = PETSC_FALSE;
44d6f2c3cbSBarry Smith 
457087cfbeSBarry Smith PetscMPIInt PetscGlobalRank       = -1;
467087cfbeSBarry Smith PetscMPIInt PetscGlobalSize       = -1;
47ba61063dSBarry Smith 
48c2a741eeSJunchao Zhang PetscBool   use_gpu_aware_mpi     = PETSC_TRUE;
49c2a741eeSJunchao Zhang 
5050f81f78SJed Brown #if defined(PETSC_HAVE_COMPLEX)
51e5c89e4eSSatish Balay #if defined(PETSC_COMPLEX_INSTANTIATE)
52e5c89e4eSSatish Balay template <> class std::complex<double>; /* instantiate complex template class */
53e5c89e4eSSatish Balay #endif
542c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
55500d8756SSatish Balay MPI_Datatype MPIU_C_DOUBLE_COMPLEX;
56500d8756SSatish Balay MPI_Datatype MPIU_C_COMPLEX;
572c876bd9SBarry Smith #endif
588619c96cSJed Brown 
598619c96cSJed Brown /*MC
608619c96cSJed Brown    PETSC_i - the imaginary number i
618619c96cSJed Brown 
628619c96cSJed Brown    Synopsis:
638619c96cSJed Brown    #include <petscsys.h>
648619c96cSJed Brown    PetscComplex PETSC_i;
658619c96cSJed Brown 
668619c96cSJed Brown    Level: beginner
678619c96cSJed Brown 
688619c96cSJed Brown    Note:
698cd53115SBarry Smith    Complex numbers are automatically available if PETSc located a working complex implementation
708619c96cSJed Brown 
718619c96cSJed Brown .seealso: PetscRealPart(), PetscImaginaryPart(), PetscRealPartComplex(), PetscImaginaryPartComplex()
728619c96cSJed Brown M*/
7350f81f78SJed Brown PetscComplex PETSC_i;
74e5c89e4eSSatish Balay #endif
75ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
76c90a1750SBarry Smith MPI_Datatype MPIU___FLOAT128 = 0;
777c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
788c764dc5SJose Roman MPI_Datatype MPIU___COMPLEX128 = 0;
798c764dc5SJose Roman #endif
80570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
81570b7f6dSBarry Smith MPI_Datatype MPIU___FP16 = 0;
82c90a1750SBarry Smith #endif
837087cfbeSBarry Smith MPI_Datatype MPIU_2SCALAR = 0;
840354ff80SSatish Balay #if defined(PETSC_USE_64BIT_INDICES)
857087cfbeSBarry Smith MPI_Datatype MPIU_2INT = 0;
8644041f26SJed Brown #endif
878ad47952SJed Brown MPI_Datatype MPIU_BOOL;
888ad47952SJed Brown MPI_Datatype MPIU_ENUM;
897cdaf61dSJed Brown MPI_Datatype MPIU_FORTRANADDR;
90e316c87fSJed Brown MPI_Datatype MPIU_SIZE_T;
9175567043SBarry Smith 
92e5c89e4eSSatish Balay /*
93e5c89e4eSSatish Balay        Function that is called to display all error messages
94e5c89e4eSSatish Balay */
957087cfbeSBarry Smith PetscErrorCode (*PetscErrorPrintf)(const char [],...)          = PetscErrorPrintfDefault;
967087cfbeSBarry Smith PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char [],...)  = PetscHelpPrintfDefault;
977087cfbeSBarry Smith PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list)    = PetscVFPrintfDefault;
98bab1f7e6SVictor Minden /*
994cf1874eSKarl Rupp   This is needed to turn on/off GPU synchronization
1008b5db460SBarry Smith */
1014cf1874eSKarl Rupp PetscBool PetscViennaCLSynchronize = PETSC_FALSE;
10282f73ecaSAlejandro Lamas Daviña PetscBool PetscCUDASynchronize = PETSC_FALSE;
103bab1f7e6SVictor Minden 
104e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
105e5c89e4eSSatish Balay /*
106e5c89e4eSSatish Balay    Optional file where all PETSc output from various prints is saved
107e5c89e4eSSatish Balay */
10895c0884eSLisandro Dalcin PETSC_INTERN FILE *petsc_history;
1090298fd71SBarry Smith FILE *petsc_history = NULL;
110e5c89e4eSSatish Balay 
1117087cfbeSBarry Smith PetscErrorCode  PetscOpenHistoryFile(const char filename[],FILE **fd)
112e5c89e4eSSatish Balay {
113e5c89e4eSSatish Balay   PetscErrorCode ierr;
114e5c89e4eSSatish Balay   PetscMPIInt    rank,size;
115e5c89e4eSSatish Balay   char           pfile[PETSC_MAX_PATH_LEN],pname[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN],date[64];
116e5c89e4eSSatish Balay   char           version[256];
117e5c89e4eSSatish Balay 
118e5c89e4eSSatish Balay   PetscFunctionBegin;
119e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
120e5c89e4eSSatish Balay   if (!rank) {
121e5c89e4eSSatish Balay     char        arch[10];
122f56c2debSBarry Smith     int         err;
123f56c2debSBarry Smith 
124e5c89e4eSSatish Balay     ierr = PetscGetArchType(arch,10);CHKERRQ(ierr);
125e5c89e4eSSatish Balay     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
126a523d312SBarry Smith     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
127e5c89e4eSSatish Balay     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
128e5c89e4eSSatish Balay     if (filename) {
129e5c89e4eSSatish Balay       ierr = PetscFixFilename(filename,fname);CHKERRQ(ierr);
130e5c89e4eSSatish Balay     } else {
131589a23caSBarry Smith       ierr = PetscGetHomeDirectory(pfile,sizeof(pfile));CHKERRQ(ierr);
132589a23caSBarry Smith       ierr = PetscStrlcat(pfile,"/.petschistory",sizeof(pfile));CHKERRQ(ierr);
133e5c89e4eSSatish Balay       ierr = PetscFixFilename(pfile,fname);CHKERRQ(ierr);
134e5c89e4eSSatish Balay     }
135e5c89e4eSSatish Balay 
136a297a907SKarl Rupp     *fd = fopen(fname,"a");
137a297a907SKarl Rupp     if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file: %s",fname);
138a297a907SKarl Rupp 
139c0bb3764SVaclav Hapla     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"----------------------------------------\n");CHKERRQ(ierr);
140e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s %s\n",version,date);CHKERRQ(ierr);
141589a23caSBarry Smith     ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr);
142e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s on a %s, %d proc. with options:\n",pname,arch,size);CHKERRQ(ierr);
143c0bb3764SVaclav Hapla     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"----------------------------------------\n");CHKERRQ(ierr);
144a297a907SKarl Rupp 
145f56c2debSBarry Smith     err = fflush(*fd);
146e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
147e5c89e4eSSatish Balay   }
148e5c89e4eSSatish Balay   PetscFunctionReturn(0);
149e5c89e4eSSatish Balay }
150e5c89e4eSSatish Balay 
15195c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE **fd)
152e5c89e4eSSatish Balay {
153e5c89e4eSSatish Balay   PetscErrorCode ierr;
154e5c89e4eSSatish Balay   PetscMPIInt    rank;
155e5c89e4eSSatish Balay   char           date[64];
156f56c2debSBarry Smith   int            err;
157e5c89e4eSSatish Balay 
158e5c89e4eSSatish Balay   PetscFunctionBegin;
159e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
160e5c89e4eSSatish Balay   if (!rank) {
161e5c89e4eSSatish Balay     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
162c0bb3764SVaclav Hapla     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"----------------------------------------\n");CHKERRQ(ierr);
163e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"Finished at %s\n",date);CHKERRQ(ierr);
164c0bb3764SVaclav Hapla     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"----------------------------------------\n");CHKERRQ(ierr);
165f56c2debSBarry Smith     err  = fflush(*fd);
166e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
167f56c2debSBarry Smith     err = fclose(*fd);
168e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
169e5c89e4eSSatish Balay   }
170e5c89e4eSSatish Balay   PetscFunctionReturn(0);
171e5c89e4eSSatish Balay }
172e5c89e4eSSatish Balay 
173e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
174e5c89e4eSSatish Balay 
175e5c89e4eSSatish Balay /*
176e5c89e4eSSatish Balay    This is ugly and probably belongs somewhere else, but I want to
177e5c89e4eSSatish Balay   be able to put a true MPI abort error handler with command line args.
178e5c89e4eSSatish Balay 
179e5c89e4eSSatish Balay     This is so MPI errors in the debugger will leave all the stack
1803c311c98SBarry Smith   frames. The default MP_Abort() cleans up and exits thus providing no useful information
1813c311c98SBarry Smith   in the debugger hence we call abort() instead of MPI_Abort().
182e5c89e4eSSatish Balay */
183e5c89e4eSSatish Balay 
18433c7d699SBarry Smith void Petsc_MPI_AbortOnError(MPI_Comm *comm,PetscMPIInt *flag,...)
185e5c89e4eSSatish Balay {
186e5c89e4eSSatish Balay   PetscFunctionBegin;
1873c311c98SBarry Smith   (*PetscErrorPrintf)("MPI error %d\n",*flag);
188e5c89e4eSSatish Balay   abort();
189e5c89e4eSSatish Balay }
190e5c89e4eSSatish Balay 
19133c7d699SBarry Smith void Petsc_MPI_DebuggerOnError(MPI_Comm *comm,PetscMPIInt *flag,...)
192e5c89e4eSSatish Balay {
193e5c89e4eSSatish Balay   PetscErrorCode ierr;
194e5c89e4eSSatish Balay 
195e5c89e4eSSatish Balay   PetscFunctionBegin;
1963c311c98SBarry Smith   (*PetscErrorPrintf)("MPI error %d\n",*flag);
197e5c89e4eSSatish Balay   ierr = PetscAttachDebugger();
19841e02c4dSJunchao Zhang   if (ierr) PETSCABORT(*comm,*flag); /* hopeless so get out */
199e5c89e4eSSatish Balay }
200e5c89e4eSSatish Balay 
2017381773fSBarry Smith #if defined(PETSC_HAVE_CUDA)
2027381773fSBarry Smith /*@C
2037381773fSBarry Smith      PetscCUDAInitialize - Initializes the CUDA device and cuBLAS on the device
2047381773fSBarry Smith 
2057381773fSBarry Smith      Logically collective
2067381773fSBarry Smith 
2077381773fSBarry Smith   Input Parameter:
2087381773fSBarry Smith   comm - the MPI communicator that will utilize the CUDA devices
2097381773fSBarry Smith 
2107381773fSBarry Smith   Options Database:
211fb0502ccSJunchao Zhang +  -cuda_initialize <yes,no> - Default no. Do the initialization in PetscInitialize(). If -cuda_initialize no is used then the default initialization is done automatically
2129d90e779SBarry Smith                                when the first CUDA call is made unless you call PetscCUDAInitialize() before any CUDA operations are performed
2137381773fSBarry Smith .  -cuda_view - view information about the CUDA devices
2147381773fSBarry Smith .  -cuda_synchronize - wait at the end of asynchronize CUDA calls so that their time gets credited to the current event; default with -log_view
215c2a741eeSJunchao Zhang .  -cuda_set_device <gpu> - integer number of the device
216c2a741eeSJunchao Zhang -  -use_gpu_aware_mpi     - Assume the MPI is GPU-aware when communicating data on GPU
2177381773fSBarry Smith 
21890ea27d8SSatish Balay   Level: beginner
21990ea27d8SSatish Balay 
2207381773fSBarry Smith   Notes:
2217381773fSBarry Smith    Initializing cuBLAS takes about 1/2 second there it is done by default in PetscInitialize() before logging begins
2227381773fSBarry Smith 
2237381773fSBarry Smith @*/
2247381773fSBarry Smith PetscErrorCode PetscCUDAInitialize(MPI_Comm comm)
2257381773fSBarry Smith {
2267381773fSBarry Smith   PetscErrorCode        ierr;
2277381773fSBarry Smith   PetscInt              deviceOpt = 0;
2287381773fSBarry Smith   PetscBool             cuda_view_flag = PETSC_FALSE,flg;
2297381773fSBarry Smith   struct cudaDeviceProp prop;
2307381773fSBarry Smith   int                   devCount,device,devicecnt;
2317381773fSBarry Smith   cudaError_t           err = cudaSuccess;
2327381773fSBarry Smith   PetscMPIInt           rank,size;
2337381773fSBarry Smith 
2347381773fSBarry Smith   PetscFunctionBegin;
2357381773fSBarry Smith   ierr = PetscOptionsBegin(comm,NULL,"CUDA options","Sys");CHKERRQ(ierr);
2367381773fSBarry Smith   ierr = PetscOptionsInt("-cuda_set_device","Set all MPI ranks to use the specified CUDA device",NULL,deviceOpt,&deviceOpt,&flg);CHKERRQ(ierr);
2377381773fSBarry Smith   device = (int)deviceOpt;
2387381773fSBarry Smith   ierr = PetscOptionsDeprecated("-cuda_show_devices","-cuda_view","3.12",NULL);CHKERRQ(ierr);
2397381773fSBarry Smith   ierr = PetscOptionsName("-cuda_view","Display CUDA device information and assignments",NULL,&cuda_view_flag);CHKERRQ(ierr);
2407381773fSBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
2417381773fSBarry Smith   if (!PetscCUDAInitialized) {
2427381773fSBarry Smith     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
2437381773fSBarry Smith 
2447381773fSBarry Smith     if (size>1 && !flg) {
2457381773fSBarry Smith       /* check to see if we force multiple ranks to hit the same GPU */
2467381773fSBarry Smith       /* we're not using the same GPU on multiple MPI threads. So try to allocated different   GPUs to different processes */
2477381773fSBarry Smith 
2487381773fSBarry Smith       /* First get the device count */
2497381773fSBarry Smith       err = cudaGetDeviceCount(&devCount);
2507381773fSBarry Smith       if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
2517381773fSBarry Smith 
2527381773fSBarry Smith       /* next determine the rank and then set the device via a mod */
2537381773fSBarry Smith       ierr   = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2547381773fSBarry Smith       device = rank % devCount;
2557381773fSBarry Smith     }
2567381773fSBarry Smith     err = cudaSetDevice(device);
2577381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
2587381773fSBarry Smith 
2597381773fSBarry Smith     /* set the device flags so that it can map host memory */
2607381773fSBarry Smith     err = cudaSetDeviceFlags(cudaDeviceMapHost);
2617381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDeviceFlags %s",cudaGetErrorString(err));
2627381773fSBarry Smith 
2637381773fSBarry Smith     ierr = PetscCUBLASInitializeHandle();CHKERRQ(ierr);
2643bbda9c2SStefano Zampini     ierr = PetscCUSOLVERDnInitializeHandle();CHKERRQ(ierr);
2657381773fSBarry Smith     PetscCUDAInitialized = PETSC_TRUE;
2667381773fSBarry Smith   }
2677381773fSBarry Smith   if (cuda_view_flag) {
2687381773fSBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2697381773fSBarry Smith     err  = cudaGetDeviceCount(&devCount);
2707381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
2717381773fSBarry Smith     for (devicecnt = 0; devicecnt < devCount; ++devicecnt) {
2727381773fSBarry Smith       err = cudaGetDeviceProperties(&prop,devicecnt);
2737381773fSBarry Smith       if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceProperties %s",cudaGetErrorString(err));
2747381773fSBarry Smith       ierr = PetscPrintf(comm, "CUDA device %d: %s\n", devicecnt, prop.name);CHKERRQ(ierr);
2757381773fSBarry Smith     }
2767381773fSBarry Smith     ierr = PetscSynchronizedPrintf(comm,"[%d] Using CUDA device %d.\n",rank,device);CHKERRQ(ierr);
2777381773fSBarry Smith     ierr = PetscSynchronizedFlush(comm,PETSC_STDOUT);CHKERRQ(ierr);
2787381773fSBarry Smith   }
2797381773fSBarry Smith   PetscFunctionReturn(0);
2807381773fSBarry Smith }
2817381773fSBarry Smith #endif
2827381773fSBarry Smith 
283e5c89e4eSSatish Balay /*@C
284e5c89e4eSSatish Balay    PetscEnd - Calls PetscFinalize() and then ends the program. This is useful if one
285e5c89e4eSSatish Balay      wishes a clean exit somewhere deep in the program.
286e5c89e4eSSatish Balay 
287e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
288e5c89e4eSSatish Balay 
289e5c89e4eSSatish Balay    Options Database Keys are the same as for PetscFinalize()
290e5c89e4eSSatish Balay 
291e5c89e4eSSatish Balay    Level: advanced
292e5c89e4eSSatish Balay 
293e5c89e4eSSatish Balay    Note:
294e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
295e5c89e4eSSatish Balay 
29688c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscFinalize()
297e5c89e4eSSatish Balay @*/
2987087cfbeSBarry Smith PetscErrorCode  PetscEnd(void)
299e5c89e4eSSatish Balay {
300e5c89e4eSSatish Balay   PetscFunctionBegin;
301e5c89e4eSSatish Balay   PetscFinalize();
302e5c89e4eSSatish Balay   exit(0);
303e5c89e4eSSatish Balay   return 0;
304e5c89e4eSSatish Balay }
305e5c89e4eSSatish Balay 
306ace3abfcSBarry Smith PetscBool PetscOptionsPublish = PETSC_FALSE;
30795c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSetUseHBWMalloc_Private(void);
30895c0884eSLisandro Dalcin PETSC_INTERN PetscBool      petscsetmallocvisited;
309e5c89e4eSSatish Balay static       char           emacsmachinename[256];
310e5c89e4eSSatish Balay 
31102c9f0b5SLisandro Dalcin PetscErrorCode (*PetscExternalVersionFunction)(MPI_Comm) = NULL;
31202c9f0b5SLisandro Dalcin PetscErrorCode (*PetscExternalHelpFunction)(MPI_Comm)    = NULL;
313e5c89e4eSSatish Balay 
314e5c89e4eSSatish Balay /*@C
315e5c89e4eSSatish Balay    PetscSetHelpVersionFunctions - Sets functions that print help and version information
316e5c89e4eSSatish Balay    before the PETSc help and version information is printed. Must call BEFORE PetscInitialize().
317e5c89e4eSSatish Balay    This routine enables a "higher-level" package that uses PETSc to print its messages first.
318e5c89e4eSSatish Balay 
319e5c89e4eSSatish Balay    Input Parameter:
3200298fd71SBarry Smith +  help - the help function (may be NULL)
3210298fd71SBarry Smith -  version - the version function (may be NULL)
322e5c89e4eSSatish Balay 
323e5c89e4eSSatish Balay    Level: developer
324e5c89e4eSSatish Balay 
325e5c89e4eSSatish Balay @*/
3267087cfbeSBarry Smith PetscErrorCode  PetscSetHelpVersionFunctions(PetscErrorCode (*help)(MPI_Comm),PetscErrorCode (*version)(MPI_Comm))
327e5c89e4eSSatish Balay {
328e5c89e4eSSatish Balay   PetscFunctionBegin;
329e5c89e4eSSatish Balay   PetscExternalHelpFunction    = help;
330e5c89e4eSSatish Balay   PetscExternalVersionFunction = version;
331e5c89e4eSSatish Balay   PetscFunctionReturn(0);
332e5c89e4eSSatish Balay }
333e5c89e4eSSatish Balay 
33405df10baSBarry Smith #if defined(PETSC_USE_LOG)
33595c0884eSLisandro Dalcin PETSC_INTERN PetscBool   PetscObjectsLog;
33605df10baSBarry Smith #endif
33705df10baSBarry Smith 
338e781f417SStefano Zampini void PetscMPI_Comm_eh(MPI_Comm *comm, PetscMPIInt *err, ...)
339e781f417SStefano Zampini {
340e781f417SStefano Zampini   if (PetscUnlikely(*err)) {
341e781f417SStefano Zampini     PetscMPIInt len;
342e781f417SStefano Zampini     char        errstring[MPI_MAX_ERROR_STRING];
343e781f417SStefano Zampini 
344e781f417SStefano Zampini     MPI_Error_string(*err,errstring,&len);
345e781f417SStefano Zampini     PetscError(MPI_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,PETSC_MPI_ERROR_CODE,PETSC_ERROR_INITIAL,"Internal error in MPI: %s",errstring);
346e781f417SStefano Zampini   }
347e781f417SStefano Zampini   return;
348e781f417SStefano Zampini }
349e781f417SStefano Zampini 
35095c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode  PetscOptionsCheckInitial_Private(void)
351e5c89e4eSSatish Balay {
352e5ed2c37SJose E. Roman   char              string[64];
353e5c89e4eSSatish Balay   MPI_Comm          comm = PETSC_COMM_WORLD;
35467584ceeSBarry Smith   PetscBool         flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,flag;
355e5c89e4eSSatish Balay   PetscErrorCode    ierr;
35667584ceeSBarry Smith   PetscReal         si;
35728559dc8SJed Brown   PetscInt          intensity;
358e5c89e4eSSatish Balay   int               i;
359e5c89e4eSSatish Balay   PetscMPIInt       rank;
3607ca660e7SBarry Smith   char              version[256],helpoptions[256];
3612479a3a6SBarry Smith #if defined(PETSC_USE_LOG)
362e5ed2c37SJose E. Roman   char              mname[PETSC_MAX_PATH_LEN];
3632479a3a6SBarry Smith   PetscViewerFormat format;
36467584ceeSBarry Smith   PetscBool         flg4 = PETSC_FALSE;
36567584ceeSBarry Smith #endif
366012f15ecSRichard Tran Mills #if defined(PETSC_HAVE_CUDA)
367fb0502ccSJunchao Zhang   PetscBool         initCUDA = PETSC_FALSE,mpi_gpu_awareness;
368249d9b8bSJunchao Zhang   cudaError_t       cerr;
369249d9b8bSJunchao Zhang   int               devCount = 0;
370012f15ecSRichard Tran Mills #endif
3717381773fSBarry Smith 
372e5c89e4eSSatish Balay   PetscFunctionBegin;
37342218b76SBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
374e5c89e4eSSatish Balay 
37567584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
37692f119d6SBarry Smith   if (!(PETSC_RUNNING_ON_VALGRIND)) {
377e5c89e4eSSatish Balay     /*
378e5c89e4eSSatish Balay       Setup the memory management; support for tracing malloc() usage
379e5c89e4eSSatish Balay     */
380244bdbccSBarry Smith     PetscBool         mdebug = PETSC_FALSE, eachcall = PETSC_FALSE, initializenan = PETSC_FALSE, mlog = PETSC_FALSE;
38192f119d6SBarry Smith 
38276bd3646SJed Brown     if (PetscDefined(USE_DEBUG)) {
38392f119d6SBarry Smith       mdebug        = PETSC_TRUE;
38492f119d6SBarry Smith       initializenan = PETSC_TRUE;
38592f119d6SBarry Smith       ierr   = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
38676bd3646SJed Brown     } else {
38792f119d6SBarry Smith       /* don't warn about unused option */
38892f119d6SBarry Smith       ierr = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
38992f119d6SBarry Smith       flg1 = PETSC_FALSE;
39076bd3646SJed Brown     }
39179dccf82SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg2,&flg3);CHKERRQ(ierr);
39292f119d6SBarry Smith     if (flg1 || flg2) {
39392f119d6SBarry Smith       mdebug        = PETSC_TRUE;
39492f119d6SBarry Smith       eachcall      = PETSC_TRUE;
39592f119d6SBarry Smith       initializenan = PETSC_TRUE;
39679dccf82SBarry Smith     } else if (flg3 && !flg2) {
39779dccf82SBarry Smith       mdebug        = PETSC_FALSE;
39879dccf82SBarry Smith       eachcall      = PETSC_FALSE;
39979dccf82SBarry Smith       initializenan = PETSC_FALSE;
400e5c89e4eSSatish Balay     }
40192f119d6SBarry Smith 
40292f119d6SBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_view",&mlog);CHKERRQ(ierr);
40392f119d6SBarry Smith     if (mlog) {
40492f119d6SBarry Smith       mdebug = PETSC_TRUE;
40592f119d6SBarry Smith     }
40679dccf82SBarry Smith     /* the next line is deprecated */
40792f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc",&mdebug,NULL);CHKERRQ(ierr);
40892f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_dump",&mdebug,NULL);CHKERRQ(ierr);
40992f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-log_view_memory",&mdebug,NULL);CHKERRQ(ierr);
41092f119d6SBarry Smith     if (mdebug) {
41192f119d6SBarry Smith       ierr = PetscMallocSetDebug(eachcall,initializenan);CHKERRQ(ierr);
41292f119d6SBarry Smith     }
41392f119d6SBarry Smith     if (mlog) {
41492f119d6SBarry Smith       PetscReal logthreshold = 0;
41592f119d6SBarry Smith       ierr = PetscOptionsGetReal(NULL,NULL,"-malloc_view_threshold",&logthreshold,NULL);CHKERRQ(ierr);
41692f119d6SBarry Smith       ierr = PetscMallocViewSet(logthreshold);CHKERRQ(ierr);
41792f119d6SBarry Smith     }
4188b254c29SBarry Smith #if defined(PETSC_USE_LOG)
4198b254c29SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-log_view_memory",&PetscLogMemory,NULL);CHKERRQ(ierr);
4208b254c29SBarry Smith #endif
42192f119d6SBarry Smith   }
42292f119d6SBarry Smith 
423ba282f50SJed Brown   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_coalesce",&flg1,&flg2);CHKERRQ(ierr);
424ba282f50SJed Brown   if (flg2) {ierr = PetscMallocSetCoalesce(flg1);CHKERRQ(ierr);}
42590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
4262f21b5c6SHong Zhang   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_hbw",&flg1,NULL);CHKERRQ(ierr);
427cf6f3811SHong Zhang   /* ignore this option if malloc is already set */
428cf6f3811SHong Zhang   if (flg1 && !petscsetmallocvisited) {ierr = PetscSetUseHBWMalloc_Private();CHKERRQ(ierr);}
429e5c89e4eSSatish Balay 
43090d69ab7SBarry Smith   flg1 = PETSC_FALSE;
431c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg1,NULL);CHKERRQ(ierr);
4327783f70dSSatish Balay   if (!flg1) {
43390d69ab7SBarry Smith     flg1 = PETSC_FALSE;
434c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg1,NULL);CHKERRQ(ierr);
4357783f70dSSatish Balay   }
436e5c89e4eSSatish Balay   if (flg1) {
437e5c89e4eSSatish Balay     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
438e5c89e4eSSatish Balay   }
43967584ceeSBarry Smith #endif
440e5c89e4eSSatish Balay 
441b4427426SBarry Smith #if defined(PETSC_USE_LOG)
442c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&PetscObjectsLog);CHKERRQ(ierr);
443b4427426SBarry Smith #endif
44405df10baSBarry Smith 
445e5c89e4eSSatish Balay   /*
446e5c89e4eSSatish Balay       Set the display variable for graphics
447e5c89e4eSSatish Balay   */
448e5c89e4eSSatish Balay   ierr = PetscSetDisplay();CHKERRQ(ierr);
449e5c89e4eSSatish Balay 
45051dcc849SKerry Stevens   /*
451e5c89e4eSSatish Balay       Print the PETSc version information
452e5c89e4eSSatish Balay   */
453c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-v",&flg1);CHKERRQ(ierr);
454c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-version",&flg2);CHKERRQ(ierr);
4552d747510SLisandro Dalcin   ierr = PetscOptionsHasHelp(NULL,&flg3);CHKERRQ(ierr);
456e5c89e4eSSatish Balay   if (flg1 || flg2 || flg3) {
457e5c89e4eSSatish Balay 
458e5c89e4eSSatish Balay     /*
459e5c89e4eSSatish Balay        Print "higher-level" package version message
460e5c89e4eSSatish Balay     */
461e5c89e4eSSatish Balay     if (PetscExternalVersionFunction) {
462e5c89e4eSSatish Balay       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
463e5c89e4eSSatish Balay     }
464e5c89e4eSSatish Balay 
465a523d312SBarry Smith     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
466e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
467e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
468e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
46984e42920SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"See docs/faq.html for problems.\n");CHKERRQ(ierr);
470e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
471e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
472c0bb3764SVaclav Hapla     ierr = (*PetscHelpPrintf)(comm,"----------------------------------------\n");CHKERRQ(ierr);
4737ca660e7SBarry Smith   }
4747ca660e7SBarry Smith 
47594941ca7SBarry Smith   /*
47694941ca7SBarry Smith        Print "higher-level" package help message
47794941ca7SBarry Smith   */
47894941ca7SBarry Smith   if (flg3) {
47994941ca7SBarry Smith     if (PetscExternalHelpFunction) {
48094941ca7SBarry Smith       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
48194941ca7SBarry Smith     }
48294941ca7SBarry Smith   }
48394941ca7SBarry Smith 
4847ca660e7SBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-help",helpoptions,sizeof(helpoptions),&flg1);CHKERRQ(ierr);
4857ca660e7SBarry Smith   if (flg1) {
4867ca660e7SBarry Smith     ierr = PetscStrcmp(helpoptions,"intro",&flg2);CHKERRQ(ierr);
4877ca660e7SBarry Smith     if (flg2) {
488bdb346e9SBarry Smith       ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
489008a6e76SBarry Smith       ierr = PetscFreeMPIResources();CHKERRQ(ierr);
4907ca660e7SBarry Smith       ierr = MPI_Finalize();CHKERRQ(ierr);
4917ca660e7SBarry Smith       exit(0);
4927ca660e7SBarry Smith     }
493e5c89e4eSSatish Balay   }
494e5c89e4eSSatish Balay 
495e5c89e4eSSatish Balay   /*
496e5c89e4eSSatish Balay       Setup the error handling
497e5c89e4eSSatish Balay   */
49890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
499c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_abort",&flg1,NULL);CHKERRQ(ierr);
500b59baad1SJed Brown   if (flg1) {
50142218b76SBarry Smith     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_ARE_FATAL);CHKERRQ(ierr);
50202c9f0b5SLisandro Dalcin     ierr = PetscPushErrorHandler(PetscAbortErrorHandler,NULL);CHKERRQ(ierr);
503b59baad1SJed Brown   }
50490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
505c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_mpiabort",&flg1,NULL);CHKERRQ(ierr);
50602c9f0b5SLisandro Dalcin   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,NULL);CHKERRQ(ierr);}
50790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
508c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpi_return_on_error",&flg1,NULL);CHKERRQ(ierr);
509e5c89e4eSSatish Balay   if (flg1) {
510d54338ecSKarl Rupp     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_RETURN);CHKERRQ(ierr);
511e5c89e4eSSatish Balay   }
512e781f417SStefano Zampini   /* experimental */
513e781f417SStefano Zampini   flg1 = PETSC_FALSE;
514e781f417SStefano Zampini   ierr = PetscOptionsGetBool(NULL,NULL,"-mpi_return_error_string",&flg1,NULL);CHKERRQ(ierr);
515e781f417SStefano Zampini   if (flg1) {
516e781f417SStefano Zampini     MPI_Errhandler eh;
517e781f417SStefano Zampini 
518e781f417SStefano Zampini     ierr = MPI_Comm_create_errhandler(PetscMPI_Comm_eh,&eh);CHKERRQ(ierr);
519e781f417SStefano Zampini     ierr = MPI_Comm_set_errhandler(comm,eh);CHKERRQ(ierr);
520e781f417SStefano Zampini     ierr = MPI_Errhandler_free(&eh);CHKERRQ(ierr);
521e781f417SStefano Zampini   }
52290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
523c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
5248d359177SBarry Smith   if (!flg1) {ierr = PetscPushSignalHandler(PetscSignalHandlerDefault,(void*)0);CHKERRQ(ierr);}
525e5c89e4eSSatish Balay 
526e5c89e4eSSatish Balay   /*
527e5c89e4eSSatish Balay       Setup debugger information
528e5c89e4eSSatish Balay   */
529e5c89e4eSSatish Balay   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
530589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_attach_debugger",string,sizeof(string),&flg1);CHKERRQ(ierr);
531e5c89e4eSSatish Balay   if (flg1) {
532e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
533e5c89e4eSSatish Balay 
534e5c89e4eSSatish Balay     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
53533c7d699SBarry Smith     ierr = MPI_Comm_create_errhandler(Petsc_MPI_DebuggerOnError,&err_handler);CHKERRQ(ierr);
536d54338ecSKarl Rupp     ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
53702c9f0b5SLisandro Dalcin     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,NULL);CHKERRQ(ierr);
538e5c89e4eSSatish Balay   }
539589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-debug_terminal",string,sizeof(string),&flg1);CHKERRQ(ierr);
5405e96ac45SJed Brown   if (flg1) { ierr = PetscSetDebugTerminal(string);CHKERRQ(ierr); }
541589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-start_in_debugger",string,sizeof(string),&flg1);CHKERRQ(ierr);
542589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-stop_for_debugger",string,sizeof(string),&flg2);CHKERRQ(ierr);
543e5c89e4eSSatish Balay   if (flg1 || flg2) {
544e5c89e4eSSatish Balay     PetscMPIInt    size;
545e5c89e4eSSatish Balay     PetscInt       lsize,*nodes;
546e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
547e5c89e4eSSatish Balay     /*
548e5c89e4eSSatish Balay        we have to make sure that all processors have opened
549e5c89e4eSSatish Balay        connections to all other processors, otherwise once the
550e5c89e4eSSatish Balay        debugger has stated it is likely to receive a SIGUSR1
551e5c89e4eSSatish Balay        and kill the program.
552e5c89e4eSSatish Balay     */
55342218b76SBarry Smith     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
554e5c89e4eSSatish Balay     if (size > 2) {
555533163c2SBarry Smith       PetscMPIInt dummy = 0;
556e5c89e4eSSatish Balay       MPI_Status  status;
557e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
558e5c89e4eSSatish Balay         if (rank != i) {
55942218b76SBarry Smith           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,comm);CHKERRQ(ierr);
560e5c89e4eSSatish Balay         }
561e5c89e4eSSatish Balay       }
562e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
563e5c89e4eSSatish Balay         if (rank != i) {
56442218b76SBarry Smith           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,comm,&status);CHKERRQ(ierr);
565e5c89e4eSSatish Balay         }
566e5c89e4eSSatish Balay       }
567e5c89e4eSSatish Balay     }
568e5c89e4eSSatish Balay     /* check if this processor node should be in debugger */
569785e854fSJed Brown     ierr  = PetscMalloc1(size,&nodes);CHKERRQ(ierr);
570e5c89e4eSSatish Balay     lsize = size;
571c5929fdfSBarry Smith     ierr  = PetscOptionsGetIntArray(NULL,NULL,"-debugger_nodes",nodes,&lsize,&flag);CHKERRQ(ierr);
572e5c89e4eSSatish Balay     if (flag) {
573e5c89e4eSSatish Balay       for (i=0; i<lsize; i++) {
574e5c89e4eSSatish Balay         if (nodes[i] == rank) { flag = PETSC_FALSE; break; }
575e5c89e4eSSatish Balay       }
576e5c89e4eSSatish Balay     }
577e5c89e4eSSatish Balay     if (!flag) {
578e5c89e4eSSatish Balay       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
57902c9f0b5SLisandro Dalcin       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,NULL);CHKERRQ(ierr);
580e5c89e4eSSatish Balay       if (flg1) {
581e5c89e4eSSatish Balay         ierr = PetscAttachDebugger();CHKERRQ(ierr);
582e5c89e4eSSatish Balay       } else {
583e5c89e4eSSatish Balay         ierr = PetscStopForDebugger();CHKERRQ(ierr);
584e5c89e4eSSatish Balay       }
58533c7d699SBarry Smith       ierr = MPI_Comm_create_errhandler(Petsc_MPI_AbortOnError,&err_handler);CHKERRQ(ierr);
586d54338ecSKarl Rupp       ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
587e5c89e4eSSatish Balay     }
588e5c89e4eSSatish Balay     ierr = PetscFree(nodes);CHKERRQ(ierr);
589e5c89e4eSSatish Balay   }
590e5c89e4eSSatish Balay 
591589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_emacs",emacsmachinename,sizeof(emacsmachinename),&flg1);CHKERRQ(ierr);
592cb9801acSJed Brown   if (flg1 && !rank) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr);}
593e5c89e4eSSatish Balay 
594e5c89e4eSSatish Balay   /*
595e5c89e4eSSatish Balay         Setup profiling and logging
596e5c89e4eSSatish Balay   */
5976cf91177SBarry Smith #if defined(PETSC_USE_INFO)
5988bb29257SSatish Balay   {
599e94e781bSJacob Faibussowitsch     ierr = PetscInfoSetFromOptions(NULL);CHKERRQ(ierr);
600e5c89e4eSSatish Balay   }
601865f6aa8SSatish Balay #endif
602*aba4c478SBarry Smith   ierr = PetscDetermineInitialFPTrap();
603cc9df77eSBarry Smith   flg1 = PETSC_FALSE;
604cc9df77eSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-fp_trap",&flg1,&flag);CHKERRQ(ierr);
605cc9df77eSBarry Smith   if (flag) {ierr = PetscSetFPTrap((PetscFPTrap)flg1);CHKERRQ(ierr);}
606cc9df77eSBarry Smith   ierr = PetscOptionsGetInt(NULL,NULL,"-check_pointer_intensity",&intensity,&flag);CHKERRQ(ierr);
607cc9df77eSBarry Smith   if (flag) {ierr = PetscCheckPointerSetIntensity(intensity);CHKERRQ(ierr);}
608865f6aa8SSatish Balay #if defined(PETSC_USE_LOG)
609865f6aa8SSatish Balay   mname[0] = 0;
610589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-history",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
611865f6aa8SSatish Balay   if (flg1) {
612865f6aa8SSatish Balay     if (mname[0]) {
613f3dea69dSBarry Smith       ierr = PetscOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
614865f6aa8SSatish Balay     } else {
615706d7a88SBarry Smith       ierr = PetscOpenHistoryFile(NULL,&petsc_history);CHKERRQ(ierr);
616865f6aa8SSatish Balay     }
617865f6aa8SSatish Balay   }
618217044c2SLisandro Dalcin 
619217044c2SLisandro Dalcin   ierr = PetscOptionsGetBool(NULL,NULL,"-log_sync",&PetscLogSyncOn,NULL);CHKERRQ(ierr);
620217044c2SLisandro Dalcin 
621e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
62290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
623c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
624495fc317SBarry Smith   if (flg1) {ierr = PetscLogMPEBegin();CHKERRQ(ierr);}
625e5c89e4eSSatish Balay #endif
62690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
62790d69ab7SBarry Smith   flg3 = PETSC_FALSE;
628c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-log_all",&flg1,NULL);CHKERRQ(ierr);
629c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
630e5c89e4eSSatish Balay   if (flg1)                      { ierr = PetscLogAllBegin();CHKERRQ(ierr); }
631bb1d7374SBarry Smith   else if (flg3)                 { ierr = PetscLogDefaultBegin();CHKERRQ(ierr);}
632e5c89e4eSSatish Balay 
633589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_trace",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
634e5c89e4eSSatish Balay   if (flg1) {
635e5c89e4eSSatish Balay     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
636e5c89e4eSSatish Balay     FILE *file;
637e5c89e4eSSatish Balay     if (mname[0]) {
6382e924ca5SSatish Balay       PetscSNPrintf(name,PETSC_MAX_PATH_LEN,"%s.%d",mname,rank);
639e5c89e4eSSatish Balay       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
640e5c89e4eSSatish Balay       file = fopen(fname,"w");
641f3dea69dSBarry Smith       if (!file) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
642a297a907SKarl Rupp     } else file = PETSC_STDOUT;
643e5c89e4eSSatish Balay     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
644e5c89e4eSSatish Balay   }
645bb1d7374SBarry Smith 
64616413a6aSBarry Smith   ierr = PetscOptionsGetViewer(comm,NULL,NULL,"-log_view",NULL,&format,&flg4);CHKERRQ(ierr);
647bb1d7374SBarry Smith   if (flg4) {
648bb1d7374SBarry Smith     if (format == PETSC_VIEWER_ASCII_XML) {
649bb1d7374SBarry Smith       ierr = PetscLogNestedBegin();CHKERRQ(ierr);
650bb1d7374SBarry Smith     } else {
651bb1d7374SBarry Smith       ierr = PetscLogDefaultBegin();CHKERRQ(ierr);
652bb1d7374SBarry Smith     }
653eccbb886SLisandro Dalcin   }
654eccbb886SLisandro Dalcin   if (flg4 && format == PETSC_VIEWER_ASCII_XML) {
655eccbb886SLisandro Dalcin     PetscReal threshold = PetscRealConstant(0.01);
656eccbb886SLisandro Dalcin     ierr = PetscOptionsGetReal(NULL,NULL,"-log_threshold",&threshold,&flg1);CHKERRQ(ierr);
657eccbb886SLisandro Dalcin     if (flg1) {ierr = PetscLogSetThreshold((PetscLogDouble)threshold,NULL);CHKERRQ(ierr);}
658bb1d7374SBarry Smith   }
659e5c89e4eSSatish Balay #endif
660e5c89e4eSSatish Balay 
661c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saws_options",&PetscOptionsPublish,NULL);CHKERRQ(ierr);
662e5c89e4eSSatish Balay 
6634b0a73b2SBarry Smith #if defined(PETSC_HAVE_CUDA)
6648d4e85a7SStefano Zampini   /*
6658d4e85a7SStefano Zampini      If collecting logging information, by default, wait for GPU to complete its operations
6668d4e85a7SStefano Zampini      before returning to the CPU in order to get accurate timings of each event
6678d4e85a7SStefano Zampini   */
6688d4e85a7SStefano Zampini   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&PetscCUDASynchronize);CHKERRQ(ierr);
6698d4e85a7SStefano Zampini   if (!PetscCUDASynchronize) {
6708d4e85a7SStefano Zampini     ierr = PetscOptionsHasName(NULL,NULL,"-log_view",&PetscCUDASynchronize);CHKERRQ(ierr);
6718d4e85a7SStefano Zampini   }
6728d4e85a7SStefano Zampini 
6737381773fSBarry Smith   ierr = PetscOptionsBegin(comm,NULL,"CUDA initialize","Sys");CHKERRQ(ierr);
67447e6383dSRichard Tran Mills   ierr = PetscOptionsBool("-cuda_initialize","Initialize the CUDA devices and cuBLAS during PetscInitialize()",NULL,initCUDA,&initCUDA,NULL);CHKERRQ(ierr);
6758d4e85a7SStefano Zampini   ierr = PetscOptionsBool("-cuda_synchronize","Wait for the GPU to complete operations before returning to the CPU (on by default with -log_summary or -log_view)",NULL,PetscCUDASynchronize,&PetscCUDASynchronize,NULL);CHKERRQ(ierr);
676c2a741eeSJunchao Zhang   ierr = PetscOptionsBool("-use_gpu_aware_mpi","Use GPU-aware MPI",NULL,use_gpu_aware_mpi,&use_gpu_aware_mpi,NULL);CHKERRQ(ierr);
677012f15ecSRichard Tran Mills   ierr = PetscOptionsEnd();CHKERRQ(ierr);
67847e6383dSRichard Tran Mills   if (initCUDA) {ierr = PetscCUDAInitialize(PETSC_COMM_WORLD);CHKERRQ(ierr);}
679fe2aebe2SStefano Zampini   if (use_gpu_aware_mpi) {
680249d9b8bSJunchao Zhang     cerr = cudaGetDeviceCount(&devCount);{if (cerr != cudaErrorNoDevice) CHKERRCUDA(cerr);} /* Catch other errors */
681249d9b8bSJunchao Zhang     if (cerr == cudaErrorNoDevice) devCount = 0; /* CUDA does not say what devCount is under this error */
682fe2aebe2SStefano Zampini   }
683249d9b8bSJunchao Zhang   if (devCount > 0 && use_gpu_aware_mpi) { /* Only do the MPI GPU awareness check when there are GPU(s) */
684223490aaSJed Brown #if defined(PETSC_HAVE_OMPI_MAJOR_VERSION) && defined(MPIX_CUDA_AWARE_SUPPORT) && MPIX_CUDA_AWARE_SUPPORT
685223490aaSJed Brown     /* Trust OpenMPI's compile time cuda query interface */
686c2a741eeSJunchao Zhang     mpi_gpu_awareness = PETSC_TRUE;
687c2a741eeSJunchao Zhang #else
688223490aaSJed Brown     /* For other MPI implementations without cuda query API, we do a GPU MPI call to see if it segfaults.
689223490aaSJed Brown        Note that Spectrum MPI sets OMPI_MAJOR_VERSION and is CUDA-aware, but does not have MPIX_CUDA_AWARE_SUPPORT.
690223490aaSJed Brown     */
691223490aaSJed Brown     mpi_gpu_awareness = PetscCheckMpiGpuAwareness();
692c2a741eeSJunchao Zhang #endif
693c2a741eeSJunchao Zhang     if (!mpi_gpu_awareness) {
694c2a741eeSJunchao Zhang       (*PetscErrorPrintf)("PETSc is configured with GPU support, but your MPI is not GPU-aware. For better performance, please use a GPU-aware MPI.\n");
695c2a741eeSJunchao Zhang       (*PetscErrorPrintf)("For IBM Spectrum MPI on OLCF Summit, you may need jsrun --smpiargs=-gpu.\n");
696c2a741eeSJunchao Zhang       (*PetscErrorPrintf)("For OpenMPI, you need to configure it --with-cuda (https://www.open-mpi.org/faq/?category=buildcuda)\n");
697c2a741eeSJunchao Zhang       (*PetscErrorPrintf)("For MVAPICH2-GDR, you need to set MV2_USE_CUDA=1 (http://mvapich.cse.ohio-state.edu/userguide/gdr/)\n");
698c2a741eeSJunchao Zhang       (*PetscErrorPrintf)("For Cray-MPICH, you need to set MPICH_RDMA_ENABLED_CUDA=1 (https://www.olcf.ornl.gov/tutorials/gpudirect-mpich-enabled-cuda/)\n");
699c2a741eeSJunchao Zhang       (*PetscErrorPrintf)("If you do not care, use option -use_gpu_aware_mpi 0, then PETSc will copy data from GPU to CPU for communication.\n");
700c2a741eeSJunchao Zhang       PETSCABORT(PETSC_COMM_WORLD,PETSC_ERR_LIB);
701c2a741eeSJunchao Zhang     }
702c2a741eeSJunchao Zhang   }
7034b0a73b2SBarry Smith #endif
7044b0a73b2SBarry Smith 
705e5c89e4eSSatish Balay   /*
706e5c89e4eSSatish Balay        Print basic help message
707e5c89e4eSSatish Balay   */
7082d747510SLisandro Dalcin   ierr = PetscOptionsHasHelp(NULL,&flg1);CHKERRQ(ierr);
709e5c89e4eSSatish Balay   if (flg1) {
710e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Options for all PETSc programs:\n");CHKERRQ(ierr);
711301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -help: prints help method for each option\n");CHKERRQ(ierr);
712301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -on_error_abort: cause an abort when an error is detected. Useful \n ");CHKERRQ(ierr);
713301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm,"       only when run in the debugger\n");CHKERRQ(ierr);
714e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
715e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start the debugger in new xterm\n");CHKERRQ(ierr);
716e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       unless noxterm is given\n");CHKERRQ(ierr);
717e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
718e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start all processes in the debugger\n");CHKERRQ(ierr);
719e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_emacs <machinename>\n");CHKERRQ(ierr);
720e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"    emacs jumps to error file\n");CHKERRQ(ierr);
721e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_nodes [n1,n2,..] Nodes to start in debugger\n");CHKERRQ(ierr);
722e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_pause [m] : delay (in seconds) to attach debugger\n");CHKERRQ(ierr);
723e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -stop_for_debugger : prints message on how to attach debugger manually\n");CHKERRQ(ierr);
724e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"                      waits the delay for you to attach\n");CHKERRQ(ierr);
7251cda70a7SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -display display: Location where X window graphics and debuggers are displayed\n");CHKERRQ(ierr);
726e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -no_signal_handler: do not trap error signals\n");CHKERRQ(ierr);
727e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n");CHKERRQ(ierr);
728e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -fp_trap: stop on floating point exceptions\n");CHKERRQ(ierr);
729e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"           note on IBM RS6000 this slows run greatly\n");CHKERRQ(ierr);
730e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n");CHKERRQ(ierr);
73179dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc: use PETSc error checking malloc (deprecated, use -malloc_debug)\n");CHKERRQ(ierr);
73279dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc no: don't use PETSc error checking malloc (deprecated, use -malloc_debug no)\n");CHKERRQ(ierr);
7334161f2a3SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_info: prints total memory usage\n");CHKERRQ(ierr);
73492f119d6SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_view <optional filename>: keeps log of all memory allocations, displays in PetscFinalize()\n");CHKERRQ(ierr);
73579dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_debug <true or false>: enables or disables extended checking for memory corruption\n");CHKERRQ(ierr);
73626a7e8d4SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -options_view: dump list of options inputted\n");CHKERRQ(ierr);
737e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left: dump list of unused options\n");CHKERRQ(ierr);
738e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left no: don't dump list of unused options\n");CHKERRQ(ierr);
739e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -tmp tmpdir: alternative /tmp directory\n");CHKERRQ(ierr);
740e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -shared_tmp: tmp directory is shared by all processors\n");CHKERRQ(ierr);
741a8c7a070SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -not_shared_tmp: each processor has separate tmp directory\n");CHKERRQ(ierr);
7420841954dSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -memory_view: print memory usage at end of run\n");CHKERRQ(ierr);
743e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
744e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -get_total_flops: total flops over all processors\n");CHKERRQ(ierr);
745185ae32fSMatthew G. Knepley     ierr = (*PetscHelpPrintf)(comm," -log_view [:filename:[format]]: logging objects and events\n");CHKERRQ(ierr);
746e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_trace [filename]: prints trace of all PETSc calls\n");CHKERRQ(ierr);
74756071f75SVaclav Hapla     ierr = (*PetscHelpPrintf)(comm," -log_exclude <list,of,classnames>: exclude given classes from logging\n");CHKERRQ(ierr);
748e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
749495fc317SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -log_mpe: Also create logfile viewable through Jumpshot\n");CHKERRQ(ierr);
750e5c89e4eSSatish Balay #endif
751e94e781bSJacob Faibussowitsch #endif
752e94e781bSJacob Faibussowitsch #if defined(PETSC_USE_INFO)
753fe9b927eSVaclav Hapla     ierr = (*PetscHelpPrintf)(comm," -info [filename][:[~]<list,of,classnames>[:[~]self]]: print verbose information\n");CHKERRQ(ierr);
754e5c89e4eSSatish Balay #endif
755e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -v: prints PETSc version number and release date\n");CHKERRQ(ierr);
756e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_file <file>: reads options from file\n");CHKERRQ(ierr);
757e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -petsc_sleep n: sleeps n seconds before running program\n");CHKERRQ(ierr);
758e5c89e4eSSatish Balay   }
759e5c89e4eSSatish Balay 
76074ba8654SBarry Smith #if defined(PETSC_HAVE_POPEN)
76174ba8654SBarry Smith   {
76274ba8654SBarry Smith   char machine[128];
763589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-popen_machine",machine,sizeof(machine),&flg1);CHKERRQ(ierr);
76474ba8654SBarry Smith   if (flg1) {
76574ba8654SBarry Smith     ierr = PetscPOpenSetMachine(machine);CHKERRQ(ierr);
76674ba8654SBarry Smith   }
76774ba8654SBarry Smith   }
76874ba8654SBarry Smith #endif
76974ba8654SBarry Smith 
770c5929fdfSBarry Smith   ierr = PetscOptionsGetReal(NULL,NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
771e5c89e4eSSatish Balay   if (flg1) {
772e5c89e4eSSatish Balay     ierr = PetscSleep(si);CHKERRQ(ierr);
773e5c89e4eSSatish Balay   }
774e5c89e4eSSatish Balay 
775fdc842d1SBarry Smith #if defined(PETSC_HAVE_VIENNACL)
776c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
777f14045dbSBarry Smith   if (!flg3) {
778c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-log_view",&flg3);CHKERRQ(ierr);
779f14045dbSBarry Smith   }
780c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-viennacl_synchronize",&flg3,NULL);CHKERRQ(ierr);
781f14045dbSBarry Smith   PetscViennaCLSynchronize = flg3;
782fdc842d1SBarry Smith   ierr = PetscViennaCLInit();CHKERRQ(ierr);
7834cf1874eSKarl Rupp #endif
78482f73ecaSAlejandro Lamas Daviña 
785fdc842d1SBarry Smith   /*
786fdc842d1SBarry Smith      Creates the logging data structures; this is enabled even if logging is not turned on
787fdc842d1SBarry Smith      This is the last thing we do before returning to the user code to prevent having the
788fdc842d1SBarry Smith      logging numbers contaminated by any startup time associated with MPI and the GPUs
789fdc842d1SBarry Smith   */
790fdc842d1SBarry Smith #if defined(PETSC_USE_LOG)
791fdc842d1SBarry Smith   ierr = PetscLogInitialize();CHKERRQ(ierr);
792f0a7718cSKarl Rupp #endif
793f0a7718cSKarl Rupp 
794e5c89e4eSSatish Balay   PetscFunctionReturn(0);
795e5c89e4eSSatish Balay }
796