xref: /petsc/src/sys/objects/init.c (revision fe9b927e09a39b0a73bbc8a0216c6d46256193f7)
1e5c89e4eSSatish Balay /*
2e5c89e4eSSatish Balay 
3e5c89e4eSSatish Balay    This file defines part of the initialization of PETSc
4e5c89e4eSSatish Balay 
5f2d66bcaSShri Abhyankar   This file uses regular malloc and free because it cannot 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 {
131e5c89e4eSSatish Balay       ierr = PetscGetHomeDirectory(pfile,240);CHKERRQ(ierr);
132e5c89e4eSSatish Balay       ierr = PetscStrcat(pfile,"/.petschistory");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 
139e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
140e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s %s\n",version,date);CHKERRQ(ierr);
141e5c89e4eSSatish Balay     ierr = PetscGetProgramName(pname,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
142e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s on a %s, %d proc. with options:\n",pname,arch,size);CHKERRQ(ierr);
143e5c89e4eSSatish Balay     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);
162e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
163e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"Finished at %s\n",date);CHKERRQ(ierr);
164e5c89e4eSSatish Balay     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:
2119d90e779SBarry Smith +  -cuda_initialize <default yes,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   /*
2367381773fSBarry Smith      If collecting logging information, by default, wait for GPU to complete its operations
2377381773fSBarry Smith      before returning to the CPU in order to get accurate timings of each event
2387381773fSBarry Smith   */
2397381773fSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&PetscCUDASynchronize);CHKERRQ(ierr);
2407381773fSBarry Smith   if (!PetscCUDASynchronize) {
2417381773fSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-log_view",&PetscCUDASynchronize);CHKERRQ(ierr);
2427381773fSBarry Smith   }
2437381773fSBarry Smith 
2447381773fSBarry Smith   ierr = PetscOptionsBegin(comm,NULL,"CUDA options","Sys");CHKERRQ(ierr);
2457381773fSBarry Smith   ierr = PetscOptionsInt("-cuda_set_device","Set all MPI ranks to use the specified CUDA device",NULL,deviceOpt,&deviceOpt,&flg);CHKERRQ(ierr);
2467381773fSBarry Smith   device = (int)deviceOpt;
2477381773fSBarry Smith   ierr = PetscOptionsBool("-cuda_synchronize","Wait for the GPU to complete operations before returning to the CPU",NULL,PetscCUDASynchronize,&PetscCUDASynchronize,NULL);CHKERRQ(ierr);
2487381773fSBarry Smith   ierr = PetscOptionsDeprecated("-cuda_show_devices","-cuda_view","3.12",NULL);CHKERRQ(ierr);
2497381773fSBarry Smith   ierr = PetscOptionsName("-cuda_view","Display CUDA device information and assignments",NULL,&cuda_view_flag);CHKERRQ(ierr);
2507381773fSBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
2517381773fSBarry Smith   if (!PetscCUDAInitialized) {
2527381773fSBarry Smith     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
2537381773fSBarry Smith 
2547381773fSBarry Smith     if (size>1 && !flg) {
2557381773fSBarry Smith       /* check to see if we force multiple ranks to hit the same GPU */
2567381773fSBarry Smith       /* we're not using the same GPU on multiple MPI threads. So try to allocated different   GPUs to different processes */
2577381773fSBarry Smith 
2587381773fSBarry Smith       /* First get the device count */
2597381773fSBarry Smith       err   = cudaGetDeviceCount(&devCount);
2607381773fSBarry Smith       if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
2617381773fSBarry Smith 
2627381773fSBarry Smith       /* next determine the rank and then set the device via a mod */
2637381773fSBarry Smith       ierr   = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2647381773fSBarry Smith       device = rank % devCount;
2657381773fSBarry Smith     }
2667381773fSBarry Smith     err = cudaSetDevice(device);
2677381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
2687381773fSBarry Smith 
2697381773fSBarry Smith     /* set the device flags so that it can map host memory */
2707381773fSBarry Smith     err = cudaSetDeviceFlags(cudaDeviceMapHost);
2717381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDeviceFlags %s",cudaGetErrorString(err));
2727381773fSBarry Smith 
2737381773fSBarry Smith     ierr = PetscCUBLASInitializeHandle();CHKERRQ(ierr);
2743bbda9c2SStefano Zampini     ierr = PetscCUSOLVERDnInitializeHandle();CHKERRQ(ierr);
2757381773fSBarry Smith     PetscCUDAInitialized = PETSC_TRUE;
2767381773fSBarry Smith   }
2777381773fSBarry Smith   if (cuda_view_flag) {
2787381773fSBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2797381773fSBarry Smith     err  = cudaGetDeviceCount(&devCount);
2807381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
2817381773fSBarry Smith     for (devicecnt = 0; devicecnt < devCount; ++devicecnt) {
2827381773fSBarry Smith       err = cudaGetDeviceProperties(&prop,devicecnt);
2837381773fSBarry Smith       if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceProperties %s",cudaGetErrorString(err));
2847381773fSBarry Smith       ierr = PetscPrintf(comm, "CUDA device %d: %s\n", devicecnt, prop.name);CHKERRQ(ierr);
2857381773fSBarry Smith     }
2867381773fSBarry Smith     ierr = PetscSynchronizedPrintf(comm,"[%d] Using CUDA device %d.\n",rank,device);CHKERRQ(ierr);
2877381773fSBarry Smith     ierr = PetscSynchronizedFlush(comm,PETSC_STDOUT);CHKERRQ(ierr);
2887381773fSBarry Smith   }
2897381773fSBarry Smith   PetscFunctionReturn(0);
2907381773fSBarry Smith }
2917381773fSBarry Smith #endif
2927381773fSBarry Smith 
293e5c89e4eSSatish Balay /*@C
294e5c89e4eSSatish Balay    PetscEnd - Calls PetscFinalize() and then ends the program. This is useful if one
295e5c89e4eSSatish Balay      wishes a clean exit somewhere deep in the program.
296e5c89e4eSSatish Balay 
297e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
298e5c89e4eSSatish Balay 
299e5c89e4eSSatish Balay    Options Database Keys are the same as for PetscFinalize()
300e5c89e4eSSatish Balay 
301e5c89e4eSSatish Balay    Level: advanced
302e5c89e4eSSatish Balay 
303e5c89e4eSSatish Balay    Note:
304e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
305e5c89e4eSSatish Balay 
30688c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscFinalize()
307e5c89e4eSSatish Balay @*/
3087087cfbeSBarry Smith PetscErrorCode  PetscEnd(void)
309e5c89e4eSSatish Balay {
310e5c89e4eSSatish Balay   PetscFunctionBegin;
311e5c89e4eSSatish Balay   PetscFinalize();
312e5c89e4eSSatish Balay   exit(0);
313e5c89e4eSSatish Balay   return 0;
314e5c89e4eSSatish Balay }
315e5c89e4eSSatish Balay 
316ace3abfcSBarry Smith PetscBool PetscOptionsPublish = PETSC_FALSE;
31795c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSetUseHBWMalloc_Private(void);
31895c0884eSLisandro Dalcin PETSC_INTERN PetscBool      petscsetmallocvisited;
319e5c89e4eSSatish Balay static       char           emacsmachinename[256];
320e5c89e4eSSatish Balay 
32102c9f0b5SLisandro Dalcin PetscErrorCode (*PetscExternalVersionFunction)(MPI_Comm) = NULL;
32202c9f0b5SLisandro Dalcin PetscErrorCode (*PetscExternalHelpFunction)(MPI_Comm)    = NULL;
323e5c89e4eSSatish Balay 
324e5c89e4eSSatish Balay /*@C
325e5c89e4eSSatish Balay    PetscSetHelpVersionFunctions - Sets functions that print help and version information
326e5c89e4eSSatish Balay    before the PETSc help and version information is printed. Must call BEFORE PetscInitialize().
327e5c89e4eSSatish Balay    This routine enables a "higher-level" package that uses PETSc to print its messages first.
328e5c89e4eSSatish Balay 
329e5c89e4eSSatish Balay    Input Parameter:
3300298fd71SBarry Smith +  help - the help function (may be NULL)
3310298fd71SBarry Smith -  version - the version function (may be NULL)
332e5c89e4eSSatish Balay 
333e5c89e4eSSatish Balay    Level: developer
334e5c89e4eSSatish Balay 
335e5c89e4eSSatish Balay @*/
3367087cfbeSBarry Smith PetscErrorCode  PetscSetHelpVersionFunctions(PetscErrorCode (*help)(MPI_Comm),PetscErrorCode (*version)(MPI_Comm))
337e5c89e4eSSatish Balay {
338e5c89e4eSSatish Balay   PetscFunctionBegin;
339e5c89e4eSSatish Balay   PetscExternalHelpFunction    = help;
340e5c89e4eSSatish Balay   PetscExternalVersionFunction = version;
341e5c89e4eSSatish Balay   PetscFunctionReturn(0);
342e5c89e4eSSatish Balay }
343e5c89e4eSSatish Balay 
34405df10baSBarry Smith #if defined(PETSC_USE_LOG)
34595c0884eSLisandro Dalcin PETSC_INTERN PetscBool   PetscObjectsLog;
34605df10baSBarry Smith #endif
34705df10baSBarry Smith 
348e781f417SStefano Zampini void PetscMPI_Comm_eh(MPI_Comm *comm, PetscMPIInt *err, ...)
349e781f417SStefano Zampini {
350e781f417SStefano Zampini   if (PetscUnlikely(*err)) {
351e781f417SStefano Zampini     PetscMPIInt len;
352e781f417SStefano Zampini     char        errstring[MPI_MAX_ERROR_STRING];
353e781f417SStefano Zampini 
354e781f417SStefano Zampini     MPI_Error_string(*err,errstring,&len);
355e781f417SStefano Zampini     PetscError(MPI_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,PETSC_MPI_ERROR_CODE,PETSC_ERROR_INITIAL,"Internal error in MPI: %s",errstring);
356e781f417SStefano Zampini   }
357e781f417SStefano Zampini   return;
358e781f417SStefano Zampini }
359e781f417SStefano Zampini 
36095c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode  PetscOptionsCheckInitial_Private(void)
361e5c89e4eSSatish Balay {
362e94e781bSJacob Faibussowitsch   char              string[64],mname[PETSC_MAX_PATH_LEN];
363e5c89e4eSSatish Balay   MPI_Comm          comm = PETSC_COMM_WORLD;
36467584ceeSBarry Smith   PetscBool         flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,flag;
365e5c89e4eSSatish Balay   PetscErrorCode    ierr;
36667584ceeSBarry Smith   PetscReal         si;
36728559dc8SJed Brown   PetscInt          intensity;
368e5c89e4eSSatish Balay   int               i;
369e5c89e4eSSatish Balay   PetscMPIInt       rank;
3707ca660e7SBarry Smith   char              version[256],helpoptions[256];
3712479a3a6SBarry Smith #if defined(PETSC_USE_LOG)
3722479a3a6SBarry Smith   PetscViewerFormat format;
37367584ceeSBarry Smith   PetscBool         flg4 = PETSC_FALSE;
37467584ceeSBarry Smith #endif
375012f15ecSRichard Tran Mills #if defined(PETSC_HAVE_CUDA)
376b0d1f38aSSatish Balay   PetscBool         initCUDA = PETSC_TRUE,mpi_gpu_awareness;
377012f15ecSRichard Tran Mills #endif
3787381773fSBarry Smith 
379e5c89e4eSSatish Balay   PetscFunctionBegin;
38042218b76SBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
381e5c89e4eSSatish Balay 
38267584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
38392f119d6SBarry Smith   if (!(PETSC_RUNNING_ON_VALGRIND)) {
384e5c89e4eSSatish Balay     /*
385e5c89e4eSSatish Balay       Setup the memory management; support for tracing malloc() usage
386e5c89e4eSSatish Balay     */
387244bdbccSBarry Smith     PetscBool         mdebug = PETSC_FALSE, eachcall = PETSC_FALSE, initializenan = PETSC_FALSE, mlog = PETSC_FALSE;
38892f119d6SBarry Smith 
3898bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
39092f119d6SBarry Smith     mdebug        = PETSC_TRUE;
39192f119d6SBarry Smith     initializenan = PETSC_TRUE;
39292f119d6SBarry Smith     ierr   = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
393e5c89e4eSSatish Balay #else
39492f119d6SBarry Smith     /* don't warn about unused option */
39592f119d6SBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
39692f119d6SBarry Smith     flg1 = PETSC_FALSE;
397e5c89e4eSSatish Balay #endif
39879dccf82SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg2,&flg3);CHKERRQ(ierr);
39992f119d6SBarry Smith     if (flg1 || flg2) {
40092f119d6SBarry Smith       mdebug        = PETSC_TRUE;
40192f119d6SBarry Smith       eachcall      = PETSC_TRUE;
40292f119d6SBarry Smith       initializenan = PETSC_TRUE;
40379dccf82SBarry Smith     } else if (flg3 && !flg2) {
40479dccf82SBarry Smith       mdebug        = PETSC_FALSE;
40579dccf82SBarry Smith       eachcall      = PETSC_FALSE;
40679dccf82SBarry Smith       initializenan = PETSC_FALSE;
407e5c89e4eSSatish Balay     }
40892f119d6SBarry Smith 
40992f119d6SBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_view",&mlog);CHKERRQ(ierr);
41092f119d6SBarry Smith     if (mlog) {
41192f119d6SBarry Smith       mdebug = PETSC_TRUE;
41292f119d6SBarry Smith     }
41379dccf82SBarry Smith     /* the next line is deprecated */
41492f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc",&mdebug,NULL);CHKERRQ(ierr);
41592f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_dump",&mdebug,NULL);CHKERRQ(ierr);
41692f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-log_view_memory",&mdebug,NULL);CHKERRQ(ierr);
41792f119d6SBarry Smith     if (mdebug) {
41892f119d6SBarry Smith       ierr = PetscMallocSetDebug(eachcall,initializenan);CHKERRQ(ierr);
41992f119d6SBarry Smith     }
42092f119d6SBarry Smith     if (mlog) {
42192f119d6SBarry Smith       PetscReal logthreshold = 0;
42292f119d6SBarry Smith       ierr = PetscOptionsGetReal(NULL,NULL,"-malloc_view_threshold",&logthreshold,NULL);CHKERRQ(ierr);
42392f119d6SBarry Smith       ierr = PetscMallocViewSet(logthreshold);CHKERRQ(ierr);
42492f119d6SBarry Smith     }
4258b254c29SBarry Smith #if defined(PETSC_USE_LOG)
4268b254c29SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-log_view_memory",&PetscLogMemory,NULL);CHKERRQ(ierr);
4278b254c29SBarry Smith #endif
42892f119d6SBarry Smith   }
42992f119d6SBarry Smith 
430ba282f50SJed Brown   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_coalesce",&flg1,&flg2);CHKERRQ(ierr);
431ba282f50SJed Brown   if (flg2) {ierr = PetscMallocSetCoalesce(flg1);CHKERRQ(ierr);}
43290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
4332f21b5c6SHong Zhang   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_hbw",&flg1,NULL);CHKERRQ(ierr);
434cf6f3811SHong Zhang   /* ignore this option if malloc is already set */
435cf6f3811SHong Zhang   if (flg1 && !petscsetmallocvisited) {ierr = PetscSetUseHBWMalloc_Private();CHKERRQ(ierr);}
436e5c89e4eSSatish Balay 
43790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
438c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg1,NULL);CHKERRQ(ierr);
4397783f70dSSatish Balay   if (!flg1) {
44090d69ab7SBarry Smith     flg1 = PETSC_FALSE;
441c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg1,NULL);CHKERRQ(ierr);
4427783f70dSSatish Balay   }
443e5c89e4eSSatish Balay   if (flg1) {
444e5c89e4eSSatish Balay     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
445e5c89e4eSSatish Balay   }
44667584ceeSBarry Smith #endif
447e5c89e4eSSatish Balay 
448b4427426SBarry Smith #if defined(PETSC_USE_LOG)
449c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&PetscObjectsLog);CHKERRQ(ierr);
450b4427426SBarry Smith #endif
45105df10baSBarry Smith 
452e5c89e4eSSatish Balay   /*
453e5c89e4eSSatish Balay       Set the display variable for graphics
454e5c89e4eSSatish Balay   */
455e5c89e4eSSatish Balay   ierr = PetscSetDisplay();CHKERRQ(ierr);
456e5c89e4eSSatish Balay 
45751dcc849SKerry Stevens   /*
458e5c89e4eSSatish Balay       Print the PETSc version information
459e5c89e4eSSatish Balay   */
460c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-v",&flg1);CHKERRQ(ierr);
461c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-version",&flg2);CHKERRQ(ierr);
4622d747510SLisandro Dalcin   ierr = PetscOptionsHasHelp(NULL,&flg3);CHKERRQ(ierr);
463e5c89e4eSSatish Balay   if (flg1 || flg2 || flg3) {
464e5c89e4eSSatish Balay 
465e5c89e4eSSatish Balay     /*
466e5c89e4eSSatish Balay        Print "higher-level" package version message
467e5c89e4eSSatish Balay     */
468e5c89e4eSSatish Balay     if (PetscExternalVersionFunction) {
469e5c89e4eSSatish Balay       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
470e5c89e4eSSatish Balay     }
471e5c89e4eSSatish Balay 
472a523d312SBarry Smith     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
4737ca660e7SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------------------------------------\n");CHKERRQ(ierr);
474e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
475e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
476e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
47784e42920SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"See docs/faq.html for problems.\n");CHKERRQ(ierr);
478e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
479e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
4807ca660e7SBarry Smith   }
4817ca660e7SBarry Smith 
48294941ca7SBarry Smith   /*
48394941ca7SBarry Smith        Print "higher-level" package help message
48494941ca7SBarry Smith   */
48594941ca7SBarry Smith   if (flg3) {
48694941ca7SBarry Smith     if (PetscExternalHelpFunction) {
48794941ca7SBarry Smith       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
48894941ca7SBarry Smith     }
48994941ca7SBarry Smith   }
49094941ca7SBarry Smith 
4917ca660e7SBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-help",helpoptions,sizeof(helpoptions),&flg1);CHKERRQ(ierr);
4927ca660e7SBarry Smith   if (flg1) {
4937ca660e7SBarry Smith     ierr = PetscStrcmp(helpoptions,"intro",&flg2);CHKERRQ(ierr);
4947ca660e7SBarry Smith     if (flg2) {
495bdb346e9SBarry Smith       ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
496008a6e76SBarry Smith       ierr = PetscFreeMPIResources();CHKERRQ(ierr);
4977ca660e7SBarry Smith       ierr = MPI_Finalize();CHKERRQ(ierr);
4987ca660e7SBarry Smith       exit(0);
4997ca660e7SBarry Smith     }
500e5c89e4eSSatish Balay   }
501e5c89e4eSSatish Balay 
502e5c89e4eSSatish Balay   /*
503e5c89e4eSSatish Balay       Setup the error handling
504e5c89e4eSSatish Balay   */
50590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
506c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_abort",&flg1,NULL);CHKERRQ(ierr);
507b59baad1SJed Brown   if (flg1) {
50842218b76SBarry Smith     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_ARE_FATAL);CHKERRQ(ierr);
50902c9f0b5SLisandro Dalcin     ierr = PetscPushErrorHandler(PetscAbortErrorHandler,NULL);CHKERRQ(ierr);
510b59baad1SJed Brown   }
51190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
512c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_mpiabort",&flg1,NULL);CHKERRQ(ierr);
51302c9f0b5SLisandro Dalcin   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,NULL);CHKERRQ(ierr);}
51490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
515c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpi_return_on_error",&flg1,NULL);CHKERRQ(ierr);
516e5c89e4eSSatish Balay   if (flg1) {
517d54338ecSKarl Rupp     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_RETURN);CHKERRQ(ierr);
518e5c89e4eSSatish Balay   }
519e781f417SStefano Zampini   /* experimental */
520e781f417SStefano Zampini   flg1 = PETSC_FALSE;
521e781f417SStefano Zampini   ierr = PetscOptionsGetBool(NULL,NULL,"-mpi_return_error_string",&flg1,NULL);CHKERRQ(ierr);
522e781f417SStefano Zampini   if (flg1) {
523e781f417SStefano Zampini     MPI_Errhandler eh;
524e781f417SStefano Zampini 
525e781f417SStefano Zampini     ierr = MPI_Comm_create_errhandler(PetscMPI_Comm_eh,&eh);CHKERRQ(ierr);
526e781f417SStefano Zampini     ierr = MPI_Comm_set_errhandler(comm,eh);CHKERRQ(ierr);
527e781f417SStefano Zampini     ierr = MPI_Errhandler_free(&eh);CHKERRQ(ierr);
528e781f417SStefano Zampini   }
52990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
530c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
5318d359177SBarry Smith   if (!flg1) {ierr = PetscPushSignalHandler(PetscSignalHandlerDefault,(void*)0);CHKERRQ(ierr);}
53296cc47afSJed Brown   flg1 = PETSC_FALSE;
533a9acdec7SBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-fp_trap",&flg1,&flag);CHKERRQ(ierr);
534a9acdec7SBarry Smith   if (flag) {ierr = PetscSetFPTrap((PetscFPTrap)flg1);CHKERRQ(ierr);}
535c5929fdfSBarry Smith   ierr = PetscOptionsGetInt(NULL,NULL,"-check_pointer_intensity",&intensity,&flag);CHKERRQ(ierr);
53628559dc8SJed Brown   if (flag) {ierr = PetscCheckPointerSetIntensity(intensity);CHKERRQ(ierr);}
537e5c89e4eSSatish Balay 
538e5c89e4eSSatish Balay   /*
539e5c89e4eSSatish Balay       Setup debugger information
540e5c89e4eSSatish Balay   */
541e5c89e4eSSatish Balay   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
542c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_attach_debugger",string,64,&flg1);CHKERRQ(ierr);
543e5c89e4eSSatish Balay   if (flg1) {
544e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
545e5c89e4eSSatish Balay 
546e5c89e4eSSatish Balay     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
54733c7d699SBarry Smith     ierr = MPI_Comm_create_errhandler(Petsc_MPI_DebuggerOnError,&err_handler);CHKERRQ(ierr);
548d54338ecSKarl Rupp     ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
54902c9f0b5SLisandro Dalcin     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,NULL);CHKERRQ(ierr);
550e5c89e4eSSatish Balay   }
551c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-debug_terminal",string,64,&flg1);CHKERRQ(ierr);
5525e96ac45SJed Brown   if (flg1) { ierr = PetscSetDebugTerminal(string);CHKERRQ(ierr); }
553c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-start_in_debugger",string,64,&flg1);CHKERRQ(ierr);
554c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-stop_for_debugger",string,64,&flg2);CHKERRQ(ierr);
555e5c89e4eSSatish Balay   if (flg1 || flg2) {
556e5c89e4eSSatish Balay     PetscMPIInt    size;
557e5c89e4eSSatish Balay     PetscInt       lsize,*nodes;
558e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
559e5c89e4eSSatish Balay     /*
560e5c89e4eSSatish Balay        we have to make sure that all processors have opened
561e5c89e4eSSatish Balay        connections to all other processors, otherwise once the
562e5c89e4eSSatish Balay        debugger has stated it is likely to receive a SIGUSR1
563e5c89e4eSSatish Balay        and kill the program.
564e5c89e4eSSatish Balay     */
56542218b76SBarry Smith     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
566e5c89e4eSSatish Balay     if (size > 2) {
567533163c2SBarry Smith       PetscMPIInt dummy = 0;
568e5c89e4eSSatish Balay       MPI_Status  status;
569e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
570e5c89e4eSSatish Balay         if (rank != i) {
57142218b76SBarry Smith           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,comm);CHKERRQ(ierr);
572e5c89e4eSSatish Balay         }
573e5c89e4eSSatish Balay       }
574e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
575e5c89e4eSSatish Balay         if (rank != i) {
57642218b76SBarry Smith           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,comm,&status);CHKERRQ(ierr);
577e5c89e4eSSatish Balay         }
578e5c89e4eSSatish Balay       }
579e5c89e4eSSatish Balay     }
580e5c89e4eSSatish Balay     /* check if this processor node should be in debugger */
581785e854fSJed Brown     ierr  = PetscMalloc1(size,&nodes);CHKERRQ(ierr);
582e5c89e4eSSatish Balay     lsize = size;
583c5929fdfSBarry Smith     ierr  = PetscOptionsGetIntArray(NULL,NULL,"-debugger_nodes",nodes,&lsize,&flag);CHKERRQ(ierr);
584e5c89e4eSSatish Balay     if (flag) {
585e5c89e4eSSatish Balay       for (i=0; i<lsize; i++) {
586e5c89e4eSSatish Balay         if (nodes[i] == rank) { flag = PETSC_FALSE; break; }
587e5c89e4eSSatish Balay       }
588e5c89e4eSSatish Balay     }
589e5c89e4eSSatish Balay     if (!flag) {
590e5c89e4eSSatish Balay       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
59102c9f0b5SLisandro Dalcin       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,NULL);CHKERRQ(ierr);
592e5c89e4eSSatish Balay       if (flg1) {
593e5c89e4eSSatish Balay         ierr = PetscAttachDebugger();CHKERRQ(ierr);
594e5c89e4eSSatish Balay       } else {
595e5c89e4eSSatish Balay         ierr = PetscStopForDebugger();CHKERRQ(ierr);
596e5c89e4eSSatish Balay       }
59733c7d699SBarry Smith       ierr = MPI_Comm_create_errhandler(Petsc_MPI_AbortOnError,&err_handler);CHKERRQ(ierr);
598d54338ecSKarl Rupp       ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
599e5c89e4eSSatish Balay     }
600e5c89e4eSSatish Balay     ierr = PetscFree(nodes);CHKERRQ(ierr);
601e5c89e4eSSatish Balay   }
602e5c89e4eSSatish Balay 
603c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_emacs",emacsmachinename,128,&flg1);CHKERRQ(ierr);
604cb9801acSJed Brown   if (flg1 && !rank) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr);}
605e5c89e4eSSatish Balay 
606e5c89e4eSSatish Balay   /*
607e5c89e4eSSatish Balay         Setup profiling and logging
608e5c89e4eSSatish Balay   */
6096cf91177SBarry Smith #if defined(PETSC_USE_INFO)
6108bb29257SSatish Balay   {
611e94e781bSJacob Faibussowitsch     ierr = PetscInfoSetFromOptions(NULL);CHKERRQ(ierr);
612e5c89e4eSSatish Balay   }
613865f6aa8SSatish Balay #endif
614865f6aa8SSatish Balay #if defined(PETSC_USE_LOG)
615865f6aa8SSatish Balay   mname[0] = 0;
616c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-history",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
617865f6aa8SSatish Balay   if (flg1) {
618865f6aa8SSatish Balay     if (mname[0]) {
619f3dea69dSBarry Smith       ierr = PetscOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
620865f6aa8SSatish Balay     } else {
621706d7a88SBarry Smith       ierr = PetscOpenHistoryFile(NULL,&petsc_history);CHKERRQ(ierr);
622865f6aa8SSatish Balay     }
623865f6aa8SSatish Balay   }
624217044c2SLisandro Dalcin 
625217044c2SLisandro Dalcin   ierr = PetscOptionsGetBool(NULL,NULL,"-log_sync",&PetscLogSyncOn,NULL);CHKERRQ(ierr);
626217044c2SLisandro Dalcin 
627e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
62890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
629c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
630495fc317SBarry Smith   if (flg1) {ierr = PetscLogMPEBegin();CHKERRQ(ierr);}
631e5c89e4eSSatish Balay #endif
63290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
63390d69ab7SBarry Smith   flg3 = PETSC_FALSE;
634c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-log_all",&flg1,NULL);CHKERRQ(ierr);
635c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
636e5c89e4eSSatish Balay   if (flg1)                      { ierr = PetscLogAllBegin();CHKERRQ(ierr); }
637bb1d7374SBarry Smith   else if (flg3)                 { ierr = PetscLogDefaultBegin();CHKERRQ(ierr);}
638e5c89e4eSSatish Balay 
639c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_trace",mname,250,&flg1);CHKERRQ(ierr);
640e5c89e4eSSatish Balay   if (flg1) {
641e5c89e4eSSatish Balay     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
642e5c89e4eSSatish Balay     FILE *file;
643e5c89e4eSSatish Balay     if (mname[0]) {
6442e924ca5SSatish Balay       PetscSNPrintf(name,PETSC_MAX_PATH_LEN,"%s.%d",mname,rank);
645e5c89e4eSSatish Balay       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
646e5c89e4eSSatish Balay       file = fopen(fname,"w");
647f3dea69dSBarry Smith       if (!file) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
648a297a907SKarl Rupp     } else file = PETSC_STDOUT;
649e5c89e4eSSatish Balay     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
650e5c89e4eSSatish Balay   }
651bb1d7374SBarry Smith 
65216413a6aSBarry Smith   ierr = PetscOptionsGetViewer(comm,NULL,NULL,"-log_view",NULL,&format,&flg4);CHKERRQ(ierr);
653bb1d7374SBarry Smith   if (flg4) {
654bb1d7374SBarry Smith     if (format == PETSC_VIEWER_ASCII_XML) {
655bb1d7374SBarry Smith       ierr = PetscLogNestedBegin();CHKERRQ(ierr);
656bb1d7374SBarry Smith     } else {
657bb1d7374SBarry Smith       ierr = PetscLogDefaultBegin();CHKERRQ(ierr);
658bb1d7374SBarry Smith     }
659eccbb886SLisandro Dalcin   }
660eccbb886SLisandro Dalcin   if (flg4 && format == PETSC_VIEWER_ASCII_XML) {
661eccbb886SLisandro Dalcin     PetscReal threshold = PetscRealConstant(0.01);
662eccbb886SLisandro Dalcin     ierr = PetscOptionsGetReal(NULL,NULL,"-log_threshold",&threshold,&flg1);CHKERRQ(ierr);
663eccbb886SLisandro Dalcin     if (flg1) {ierr = PetscLogSetThreshold((PetscLogDouble)threshold,NULL);CHKERRQ(ierr);}
664bb1d7374SBarry Smith   }
665e5c89e4eSSatish Balay #endif
666e5c89e4eSSatish Balay 
667c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saws_options",&PetscOptionsPublish,NULL);CHKERRQ(ierr);
668e5c89e4eSSatish Balay 
6694b0a73b2SBarry Smith #if defined(PETSC_HAVE_CUDA)
6707381773fSBarry Smith   ierr = PetscOptionsBegin(comm,NULL,"CUDA initialize","Sys");CHKERRQ(ierr);
67147e6383dSRichard Tran Mills   ierr = PetscOptionsBool("-cuda_initialize","Initialize the CUDA devices and cuBLAS during PetscInitialize()",NULL,initCUDA,&initCUDA,NULL);CHKERRQ(ierr);
672c2a741eeSJunchao Zhang   ierr = PetscOptionsBool("-use_gpu_aware_mpi","Use GPU-aware MPI",NULL,use_gpu_aware_mpi,&use_gpu_aware_mpi,NULL);CHKERRQ(ierr);
673012f15ecSRichard Tran Mills   ierr = PetscOptionsEnd();CHKERRQ(ierr);
67447e6383dSRichard Tran Mills   if (initCUDA) {ierr = PetscCUDAInitialize(PETSC_COMM_WORLD);CHKERRQ(ierr);}
675c2a741eeSJunchao Zhang   if (use_gpu_aware_mpi) {
676c2a741eeSJunchao Zhang #if defined(PETSC_HAVE_OMPI_MAJOR_VERSION) /* Use OpenMPI's compile time cuda query interface */
677c2a741eeSJunchao Zhang #if defined(MPIX_CUDA_AWARE_SUPPORT) && MPIX_CUDA_AWARE_SUPPORT
678c2a741eeSJunchao Zhang     mpi_gpu_awareness = PETSC_TRUE;
679c2a741eeSJunchao Zhang #else
680c2a741eeSJunchao Zhang     mpi_gpu_awareness = PETSC_FALSE;
681c2a741eeSJunchao Zhang #endif
682c2a741eeSJunchao Zhang #else
683c2a741eeSJunchao Zhang     mpi_gpu_awareness = PetscCheckMpiGpuAwareness(); /* For other MPI implementations without cuda query API, we do a GPU MPI call to see if it segfaults */
684c2a741eeSJunchao Zhang #endif
685c2a741eeSJunchao Zhang     if (!mpi_gpu_awareness) {
686c2a741eeSJunchao 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");
687c2a741eeSJunchao Zhang       (*PetscErrorPrintf)("For IBM Spectrum MPI on OLCF Summit, you may need jsrun --smpiargs=-gpu.\n");
688c2a741eeSJunchao Zhang       (*PetscErrorPrintf)("For OpenMPI, you need to configure it --with-cuda (https://www.open-mpi.org/faq/?category=buildcuda)\n");
689c2a741eeSJunchao Zhang       (*PetscErrorPrintf)("For MVAPICH2-GDR, you need to set MV2_USE_CUDA=1 (http://mvapich.cse.ohio-state.edu/userguide/gdr/)\n");
690c2a741eeSJunchao 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");
691c2a741eeSJunchao 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");
692c2a741eeSJunchao Zhang       PETSCABORT(PETSC_COMM_WORLD,PETSC_ERR_LIB);
693c2a741eeSJunchao Zhang     }
694c2a741eeSJunchao Zhang   }
6954b0a73b2SBarry Smith #endif
6964b0a73b2SBarry Smith 
697e5c89e4eSSatish Balay   /*
698e5c89e4eSSatish Balay        Print basic help message
699e5c89e4eSSatish Balay   */
7002d747510SLisandro Dalcin   ierr = PetscOptionsHasHelp(NULL,&flg1);CHKERRQ(ierr);
701e5c89e4eSSatish Balay   if (flg1) {
70256071f75SVaclav Hapla     ierr = (*PetscHelpPrintf)(comm,"-------------------------------------------------\n");CHKERRQ(ierr);
703e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Options for all PETSc programs:\n");CHKERRQ(ierr);
704301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -help: prints help method for each option\n");CHKERRQ(ierr);
705301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -on_error_abort: cause an abort when an error is detected. Useful \n ");CHKERRQ(ierr);
706301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm,"       only when run in the debugger\n");CHKERRQ(ierr);
707e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
708e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start the debugger in new xterm\n");CHKERRQ(ierr);
709e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       unless noxterm is given\n");CHKERRQ(ierr);
710e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
711e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start all processes in the debugger\n");CHKERRQ(ierr);
712e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_emacs <machinename>\n");CHKERRQ(ierr);
713e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"    emacs jumps to error file\n");CHKERRQ(ierr);
714e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_nodes [n1,n2,..] Nodes to start in debugger\n");CHKERRQ(ierr);
715e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_pause [m] : delay (in seconds) to attach debugger\n");CHKERRQ(ierr);
716e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -stop_for_debugger : prints message on how to attach debugger manually\n");CHKERRQ(ierr);
717e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"                      waits the delay for you to attach\n");CHKERRQ(ierr);
7181cda70a7SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -display display: Location where X window graphics and debuggers are displayed\n");CHKERRQ(ierr);
719e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -no_signal_handler: do not trap error signals\n");CHKERRQ(ierr);
720e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n");CHKERRQ(ierr);
721e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -fp_trap: stop on floating point exceptions\n");CHKERRQ(ierr);
722e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"           note on IBM RS6000 this slows run greatly\n");CHKERRQ(ierr);
723e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n");CHKERRQ(ierr);
72479dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc: use PETSc error checking malloc (deprecated, use -malloc_debug)\n");CHKERRQ(ierr);
72579dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc no: don't use PETSc error checking malloc (deprecated, use -malloc_debug no)\n");CHKERRQ(ierr);
7264161f2a3SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_info: prints total memory usage\n");CHKERRQ(ierr);
72792f119d6SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_view <optional filename>: keeps log of all memory allocations, displays in PetscFinalize()\n");CHKERRQ(ierr);
72879dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_debug <true or false>: enables or disables extended checking for memory corruption\n");CHKERRQ(ierr);
72926a7e8d4SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -options_view: dump list of options inputted\n");CHKERRQ(ierr);
730e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left: dump list of unused options\n");CHKERRQ(ierr);
731e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left no: don't dump list of unused options\n");CHKERRQ(ierr);
732e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -tmp tmpdir: alternative /tmp directory\n");CHKERRQ(ierr);
733e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -shared_tmp: tmp directory is shared by all processors\n");CHKERRQ(ierr);
734a8c7a070SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -not_shared_tmp: each processor has separate tmp directory\n");CHKERRQ(ierr);
7350841954dSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -memory_view: print memory usage at end of run\n");CHKERRQ(ierr);
736e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
737e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -get_total_flops: total flops over all processors\n");CHKERRQ(ierr);
738185ae32fSMatthew G. Knepley     ierr = (*PetscHelpPrintf)(comm," -log_view [:filename:[format]]: logging objects and events\n");CHKERRQ(ierr);
739e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_trace [filename]: prints trace of all PETSc calls\n");CHKERRQ(ierr);
74056071f75SVaclav Hapla     ierr = (*PetscHelpPrintf)(comm," -log_exclude <list,of,classnames>: exclude given classes from logging\n");CHKERRQ(ierr);
741e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
742495fc317SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -log_mpe: Also create logfile viewable through Jumpshot\n");CHKERRQ(ierr);
743e5c89e4eSSatish Balay #endif
744e94e781bSJacob Faibussowitsch #endif
745e94e781bSJacob Faibussowitsch #if defined(PETSC_USE_INFO)
746*fe9b927eSVaclav Hapla     ierr = (*PetscHelpPrintf)(comm," -info [filename][:[~]<list,of,classnames>[:[~]self]]: print verbose information\n");CHKERRQ(ierr);
747e5c89e4eSSatish Balay #endif
748e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -v: prints PETSc version number and release date\n");CHKERRQ(ierr);
749e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_file <file>: reads options from file\n");CHKERRQ(ierr);
750e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -petsc_sleep n: sleeps n seconds before running program\n");CHKERRQ(ierr);
751e5c89e4eSSatish Balay   }
752e5c89e4eSSatish Balay 
75374ba8654SBarry Smith #if defined(PETSC_HAVE_POPEN)
75474ba8654SBarry Smith   {
75574ba8654SBarry Smith   char machine[128];
756c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-popen_machine",machine,128,&flg1);CHKERRQ(ierr);
75774ba8654SBarry Smith   if (flg1) {
75874ba8654SBarry Smith     ierr = PetscPOpenSetMachine(machine);CHKERRQ(ierr);
75974ba8654SBarry Smith   }
76074ba8654SBarry Smith   }
76174ba8654SBarry Smith #endif
76274ba8654SBarry Smith 
763c5929fdfSBarry Smith   ierr = PetscOptionsGetReal(NULL,NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
764e5c89e4eSSatish Balay   if (flg1) {
765e5c89e4eSSatish Balay     ierr = PetscSleep(si);CHKERRQ(ierr);
766e5c89e4eSSatish Balay   }
767e5c89e4eSSatish Balay 
768fdc842d1SBarry Smith #if defined(PETSC_HAVE_VIENNACL)
769c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
770f14045dbSBarry Smith   if (!flg3) {
771c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-log_view",&flg3);CHKERRQ(ierr);
772f14045dbSBarry Smith   }
773c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-viennacl_synchronize",&flg3,NULL);CHKERRQ(ierr);
774f14045dbSBarry Smith   PetscViennaCLSynchronize = flg3;
775fdc842d1SBarry Smith   ierr = PetscViennaCLInit();CHKERRQ(ierr);
7764cf1874eSKarl Rupp #endif
77782f73ecaSAlejandro Lamas Daviña 
778fdc842d1SBarry Smith   /*
779fdc842d1SBarry Smith      Creates the logging data structures; this is enabled even if logging is not turned on
780fdc842d1SBarry Smith      This is the last thing we do before returning to the user code to prevent having the
781fdc842d1SBarry Smith      logging numbers contaminated by any startup time associated with MPI and the GPUs
782fdc842d1SBarry Smith   */
783fdc842d1SBarry Smith #if defined(PETSC_USE_LOG)
784fdc842d1SBarry Smith   ierr = PetscLogInitialize();CHKERRQ(ierr);
785f0a7718cSKarl Rupp #endif
786f0a7718cSKarl Rupp 
787e5c89e4eSSatish Balay   PetscFunctionReturn(0);
788e5c89e4eSSatish Balay }
789