xref: /petsc/src/sys/objects/init.c (revision 79dccf82ad67fbc2ef5f84ff58416d96c239ff80)
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>
25fdc842d1SBarry Smith extern PetscErrorCode PetscCUBLASInitializeHandle(void);
26d9b72601SDominic Meiser #endif
27555d055bSBarry Smith 
28f0a7718cSKarl Rupp #if defined(PETSC_HAVE_VIENNACL)
29f0a7718cSKarl Rupp PETSC_EXTERN PetscErrorCode PetscViennaCLInit();
30f0a7718cSKarl Rupp #endif
31f0a7718cSKarl Rupp 
32e5c89e4eSSatish Balay /* ------------------------Nasty global variables -------------------------------*/
33e5c89e4eSSatish Balay /*
34e5c89e4eSSatish Balay      Indicates if PETSc started up MPI, or it was
35e5c89e4eSSatish Balay    already started before PETSc was initialized.
36e5c89e4eSSatish Balay */
370cbf60d0SJose E. Roman PetscBool   PetscBeganMPI         = PETSC_FALSE;
380cbf60d0SJose E. Roman PetscBool   PetscInitializeCalled = PETSC_FALSE;
390cbf60d0SJose E. Roman PetscBool   PetscFinalizeCalled   = PETSC_FALSE;
40bffec52eSKarl Rupp PetscBool   PetscCUDAInitialized  = PETSC_FALSE;
41d6f2c3cbSBarry Smith 
427087cfbeSBarry Smith PetscMPIInt PetscGlobalRank       = -1;
437087cfbeSBarry Smith PetscMPIInt PetscGlobalSize       = -1;
44ba61063dSBarry Smith 
4550f81f78SJed Brown #if defined(PETSC_HAVE_COMPLEX)
46e5c89e4eSSatish Balay #if defined(PETSC_COMPLEX_INSTANTIATE)
47e5c89e4eSSatish Balay template <> class std::complex<double>; /* instantiate complex template class */
48e5c89e4eSSatish Balay #endif
492c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
50500d8756SSatish Balay MPI_Datatype MPIU_C_DOUBLE_COMPLEX;
51500d8756SSatish Balay MPI_Datatype MPIU_C_COMPLEX;
522c876bd9SBarry Smith #endif
538619c96cSJed Brown 
548619c96cSJed Brown /*MC
558619c96cSJed Brown    PETSC_i - the imaginary number i
568619c96cSJed Brown 
578619c96cSJed Brown    Synopsis:
588619c96cSJed Brown    #include <petscsys.h>
598619c96cSJed Brown    PetscComplex PETSC_i;
608619c96cSJed Brown 
618619c96cSJed Brown    Level: beginner
628619c96cSJed Brown 
638619c96cSJed Brown    Note:
648cd53115SBarry Smith    Complex numbers are automatically available if PETSc located a working complex implementation
658619c96cSJed Brown 
668619c96cSJed Brown .seealso: PetscRealPart(), PetscImaginaryPart(), PetscRealPartComplex(), PetscImaginaryPartComplex()
678619c96cSJed Brown M*/
6850f81f78SJed Brown PetscComplex PETSC_i;
69e5c89e4eSSatish Balay #endif
70ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
71c90a1750SBarry Smith MPI_Datatype MPIU___FLOAT128 = 0;
727c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
738c764dc5SJose Roman MPI_Datatype MPIU___COMPLEX128 = 0;
748c764dc5SJose Roman #endif
75570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
76570b7f6dSBarry Smith MPI_Datatype MPIU___FP16 = 0;
77c90a1750SBarry Smith #endif
787087cfbeSBarry Smith MPI_Datatype MPIU_2SCALAR = 0;
790354ff80SSatish Balay #if defined(PETSC_USE_64BIT_INDICES)
807087cfbeSBarry Smith MPI_Datatype MPIU_2INT = 0;
8144041f26SJed Brown #endif
828ad47952SJed Brown MPI_Datatype MPIU_BOOL;
838ad47952SJed Brown MPI_Datatype MPIU_ENUM;
847cdaf61dSJed Brown MPI_Datatype MPIU_FORTRANADDR;
85e316c87fSJed Brown MPI_Datatype MPIU_SIZE_T;
8675567043SBarry Smith 
87e5c89e4eSSatish Balay /*
88e5c89e4eSSatish Balay        Function that is called to display all error messages
89e5c89e4eSSatish Balay */
907087cfbeSBarry Smith PetscErrorCode (*PetscErrorPrintf)(const char [],...)          = PetscErrorPrintfDefault;
917087cfbeSBarry Smith PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char [],...)  = PetscHelpPrintfDefault;
927087cfbeSBarry Smith PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list)    = PetscVFPrintfDefault;
93bab1f7e6SVictor Minden /*
944cf1874eSKarl Rupp   This is needed to turn on/off GPU synchronization
958b5db460SBarry Smith */
964cf1874eSKarl Rupp PetscBool PetscViennaCLSynchronize = PETSC_FALSE;
9782f73ecaSAlejandro Lamas Daviña PetscBool PetscCUDASynchronize = PETSC_FALSE;
98bab1f7e6SVictor Minden 
99e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
100e5c89e4eSSatish Balay /*
101e5c89e4eSSatish Balay    Optional file where all PETSc output from various prints is saved
102e5c89e4eSSatish Balay */
10395c0884eSLisandro Dalcin PETSC_INTERN FILE *petsc_history;
1040298fd71SBarry Smith FILE *petsc_history = NULL;
105e5c89e4eSSatish Balay 
1067087cfbeSBarry Smith PetscErrorCode  PetscOpenHistoryFile(const char filename[],FILE **fd)
107e5c89e4eSSatish Balay {
108e5c89e4eSSatish Balay   PetscErrorCode ierr;
109e5c89e4eSSatish Balay   PetscMPIInt    rank,size;
110e5c89e4eSSatish Balay   char           pfile[PETSC_MAX_PATH_LEN],pname[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN],date[64];
111e5c89e4eSSatish Balay   char           version[256];
112e5c89e4eSSatish Balay 
113e5c89e4eSSatish Balay   PetscFunctionBegin;
114e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
115e5c89e4eSSatish Balay   if (!rank) {
116e5c89e4eSSatish Balay     char        arch[10];
117f56c2debSBarry Smith     int         err;
118f56c2debSBarry Smith 
119e5c89e4eSSatish Balay     ierr = PetscGetArchType(arch,10);CHKERRQ(ierr);
120e5c89e4eSSatish Balay     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
121a523d312SBarry Smith     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
122e5c89e4eSSatish Balay     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
123e5c89e4eSSatish Balay     if (filename) {
124e5c89e4eSSatish Balay       ierr = PetscFixFilename(filename,fname);CHKERRQ(ierr);
125e5c89e4eSSatish Balay     } else {
126e5c89e4eSSatish Balay       ierr = PetscGetHomeDirectory(pfile,240);CHKERRQ(ierr);
127e5c89e4eSSatish Balay       ierr = PetscStrcat(pfile,"/.petschistory");CHKERRQ(ierr);
128e5c89e4eSSatish Balay       ierr = PetscFixFilename(pfile,fname);CHKERRQ(ierr);
129e5c89e4eSSatish Balay     }
130e5c89e4eSSatish Balay 
131a297a907SKarl Rupp     *fd = fopen(fname,"a");
132a297a907SKarl Rupp     if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file: %s",fname);
133a297a907SKarl Rupp 
134e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
135e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s %s\n",version,date);CHKERRQ(ierr);
136e5c89e4eSSatish Balay     ierr = PetscGetProgramName(pname,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
137e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s on a %s, %d proc. with options:\n",pname,arch,size);CHKERRQ(ierr);
138e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
139a297a907SKarl Rupp 
140f56c2debSBarry Smith     err = fflush(*fd);
141e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
142e5c89e4eSSatish Balay   }
143e5c89e4eSSatish Balay   PetscFunctionReturn(0);
144e5c89e4eSSatish Balay }
145e5c89e4eSSatish Balay 
14695c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE **fd)
147e5c89e4eSSatish Balay {
148e5c89e4eSSatish Balay   PetscErrorCode ierr;
149e5c89e4eSSatish Balay   PetscMPIInt    rank;
150e5c89e4eSSatish Balay   char           date[64];
151f56c2debSBarry Smith   int            err;
152e5c89e4eSSatish Balay 
153e5c89e4eSSatish Balay   PetscFunctionBegin;
154e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
155e5c89e4eSSatish Balay   if (!rank) {
156e5c89e4eSSatish Balay     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
157e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
158e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"Finished at %s\n",date);CHKERRQ(ierr);
159e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
160f56c2debSBarry Smith     err  = fflush(*fd);
161e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
162f56c2debSBarry Smith     err = fclose(*fd);
163e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
164e5c89e4eSSatish Balay   }
165e5c89e4eSSatish Balay   PetscFunctionReturn(0);
166e5c89e4eSSatish Balay }
167e5c89e4eSSatish Balay 
168e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
169e5c89e4eSSatish Balay 
170e5c89e4eSSatish Balay /*
171e5c89e4eSSatish Balay    This is ugly and probably belongs somewhere else, but I want to
172e5c89e4eSSatish Balay   be able to put a true MPI abort error handler with command line args.
173e5c89e4eSSatish Balay 
174e5c89e4eSSatish Balay     This is so MPI errors in the debugger will leave all the stack
1753c311c98SBarry Smith   frames. The default MP_Abort() cleans up and exits thus providing no useful information
1763c311c98SBarry Smith   in the debugger hence we call abort() instead of MPI_Abort().
177e5c89e4eSSatish Balay */
178e5c89e4eSSatish Balay 
17933c7d699SBarry Smith void Petsc_MPI_AbortOnError(MPI_Comm *comm,PetscMPIInt *flag,...)
180e5c89e4eSSatish Balay {
181e5c89e4eSSatish Balay   PetscFunctionBegin;
1823c311c98SBarry Smith   (*PetscErrorPrintf)("MPI error %d\n",*flag);
183e5c89e4eSSatish Balay   abort();
184e5c89e4eSSatish Balay }
185e5c89e4eSSatish Balay 
18633c7d699SBarry Smith void Petsc_MPI_DebuggerOnError(MPI_Comm *comm,PetscMPIInt *flag,...)
187e5c89e4eSSatish Balay {
188e5c89e4eSSatish Balay   PetscErrorCode ierr;
189e5c89e4eSSatish Balay 
190e5c89e4eSSatish Balay   PetscFunctionBegin;
1913c311c98SBarry Smith   (*PetscErrorPrintf)("MPI error %d\n",*flag);
192e5c89e4eSSatish Balay   ierr = PetscAttachDebugger();
193a297a907SKarl Rupp   if (ierr) MPI_Abort(*comm,*flag); /* hopeless so get out */
194e5c89e4eSSatish Balay }
195e5c89e4eSSatish Balay 
1967381773fSBarry Smith #if defined(PETSC_HAVE_CUDA)
1977381773fSBarry Smith /*@C
1987381773fSBarry Smith      PetscCUDAInitialize - Initializes the CUDA device and cuBLAS on the device
1997381773fSBarry Smith 
2007381773fSBarry Smith      Logically collective
2017381773fSBarry Smith 
2027381773fSBarry Smith   Input Parameter:
2037381773fSBarry Smith   comm - the MPI communicator that will utilize the CUDA devices
2047381773fSBarry Smith 
2057381773fSBarry Smith   Options Database:
2067381773fSBarry Smith +  -cuda_initialize - do the initialization in PetscInitialize()
2077381773fSBarry Smith .  -cuda_view - view information about the CUDA devices
2087381773fSBarry 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
2097381773fSBarry Smith -  -cuda_set_device <gpu> - integer number of the device
2107381773fSBarry Smith 
2117381773fSBarry Smith   Notes:
2127381773fSBarry Smith    Initializing cuBLAS takes about 1/2 second there it is done by default in PetscInitialize() before logging begins
2137381773fSBarry Smith 
2147381773fSBarry Smith @*/
2157381773fSBarry Smith PetscErrorCode PetscCUDAInitialize(MPI_Comm comm)
2167381773fSBarry Smith {
2177381773fSBarry Smith   PetscErrorCode        ierr;
2187381773fSBarry Smith   PetscInt              deviceOpt = 0;
2197381773fSBarry Smith   PetscBool             cuda_view_flag = PETSC_FALSE,flg;
2207381773fSBarry Smith   struct cudaDeviceProp prop;
2217381773fSBarry Smith   int                   devCount,device,devicecnt;
2227381773fSBarry Smith   cudaError_t           err = cudaSuccess;
2237381773fSBarry Smith   PetscMPIInt           rank,size;
2247381773fSBarry Smith 
2257381773fSBarry Smith   PetscFunctionBegin;
2267381773fSBarry Smith   /*
2277381773fSBarry Smith      If collecting logging information, by default, wait for GPU to complete its operations
2287381773fSBarry Smith      before returning to the CPU in order to get accurate timings of each event
2297381773fSBarry Smith   */
2307381773fSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&PetscCUDASynchronize);CHKERRQ(ierr);
2317381773fSBarry Smith   if (!PetscCUDASynchronize) {
2327381773fSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-log_view",&PetscCUDASynchronize);CHKERRQ(ierr);
2337381773fSBarry Smith   }
2347381773fSBarry Smith 
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 = PetscOptionsBool("-cuda_synchronize","Wait for the GPU to complete operations before returning to the CPU",NULL,PetscCUDASynchronize,&PetscCUDASynchronize,NULL);CHKERRQ(ierr);
2397381773fSBarry Smith   ierr = PetscOptionsDeprecated("-cuda_show_devices","-cuda_view","3.12",NULL);CHKERRQ(ierr);
2407381773fSBarry Smith   ierr = PetscOptionsName("-cuda_view","Display CUDA device information and assignments",NULL,&cuda_view_flag);CHKERRQ(ierr);
2417381773fSBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
2427381773fSBarry Smith   if (!PetscCUDAInitialized) {
2437381773fSBarry Smith     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
2447381773fSBarry Smith 
2457381773fSBarry Smith     if (size>1 && !flg) {
2467381773fSBarry Smith       /* check to see if we force multiple ranks to hit the same GPU */
2477381773fSBarry Smith       /* we're not using the same GPU on multiple MPI threads. So try to allocated different   GPUs to different processes */
2487381773fSBarry Smith 
2497381773fSBarry Smith       /* First get the device count */
2507381773fSBarry Smith       err   = cudaGetDeviceCount(&devCount);
2517381773fSBarry Smith       if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
2527381773fSBarry Smith 
2537381773fSBarry Smith       /* next determine the rank and then set the device via a mod */
2547381773fSBarry Smith       ierr   = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2557381773fSBarry Smith       device = rank % devCount;
2567381773fSBarry Smith     }
2577381773fSBarry Smith     err = cudaSetDevice(device);
2587381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
2597381773fSBarry Smith 
2607381773fSBarry Smith     /* set the device flags so that it can map host memory */
2617381773fSBarry Smith     err = cudaSetDeviceFlags(cudaDeviceMapHost);
2627381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDeviceFlags %s",cudaGetErrorString(err));
2637381773fSBarry Smith 
2647381773fSBarry Smith     ierr = PetscCUBLASInitializeHandle();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 
311e5c89e4eSSatish Balay PetscErrorCode (*PetscExternalVersionFunction)(MPI_Comm) = 0;
312e5c89e4eSSatish Balay PetscErrorCode (*PetscExternalHelpFunction)(MPI_Comm)    = 0;
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 
33895c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode  PetscOptionsCheckInitial_Private(void)
339e5c89e4eSSatish Balay {
340e5c89e4eSSatish Balay   char              string[64],mname[PETSC_MAX_PATH_LEN],*f;
341e5c89e4eSSatish Balay   MPI_Comm          comm = PETSC_COMM_WORLD;
34267584ceeSBarry Smith   PetscBool         flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,flag;
343e5c89e4eSSatish Balay   PetscErrorCode    ierr;
34467584ceeSBarry Smith   PetscReal         si;
34528559dc8SJed Brown   PetscInt          intensity;
346e5c89e4eSSatish Balay   int               i;
347e5c89e4eSSatish Balay   PetscMPIInt       rank;
3487ca660e7SBarry Smith   char              version[256],helpoptions[256];
3492479a3a6SBarry Smith #if defined(PETSC_USE_LOG)
3502479a3a6SBarry Smith   PetscViewerFormat format;
35167584ceeSBarry Smith   PetscBool         flg4 = PETSC_FALSE;
35267584ceeSBarry Smith #endif
353012f15ecSRichard Tran Mills #if defined(PETSC_HAVE_CUDA)
3547381773fSBarry Smith   PetscBool         initCuda = PETSC_TRUE;
355012f15ecSRichard Tran Mills #endif
3567381773fSBarry Smith 
357e5c89e4eSSatish Balay   PetscFunctionBegin;
35842218b76SBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
359e5c89e4eSSatish Balay 
36067584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
36192f119d6SBarry Smith   if (!(PETSC_RUNNING_ON_VALGRIND)) {
362e5c89e4eSSatish Balay     /*
363e5c89e4eSSatish Balay       Setup the memory management; support for tracing malloc() usage
364e5c89e4eSSatish Balay     */
365244bdbccSBarry Smith     PetscBool         mdebug = PETSC_FALSE, eachcall = PETSC_FALSE, initializenan = PETSC_FALSE, mlog = PETSC_FALSE;
36692f119d6SBarry Smith 
3678bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
36892f119d6SBarry Smith     mdebug        = PETSC_TRUE;
36992f119d6SBarry Smith     initializenan = PETSC_TRUE;
37092f119d6SBarry Smith     ierr   = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
371e5c89e4eSSatish Balay #else
37292f119d6SBarry Smith     /* don't warn about unused option */
37392f119d6SBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
37492f119d6SBarry Smith     flg1 = PETSC_FALSE;
375e5c89e4eSSatish Balay #endif
376*79dccf82SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg2,&flg3);CHKERRQ(ierr);
37792f119d6SBarry Smith     if (flg1 || flg2) {
37892f119d6SBarry Smith       mdebug        = PETSC_TRUE;
37992f119d6SBarry Smith       eachcall      = PETSC_TRUE;
38092f119d6SBarry Smith       initializenan = PETSC_TRUE;
381*79dccf82SBarry Smith     } else if (flg3 && !flg2) {
382*79dccf82SBarry Smith       mdebug        = PETSC_FALSE;
383*79dccf82SBarry Smith       eachcall      = PETSC_FALSE;
384*79dccf82SBarry Smith       initializenan = PETSC_FALSE;
385e5c89e4eSSatish Balay     }
38692f119d6SBarry Smith 
38792f119d6SBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_view",&mlog);CHKERRQ(ierr);
38892f119d6SBarry Smith     if (mlog) {
38992f119d6SBarry Smith       mdebug = PETSC_TRUE;
39092f119d6SBarry Smith     }
391*79dccf82SBarry Smith     /* the next line is deprecated */
39292f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc",&mdebug,NULL);CHKERRQ(ierr);
39392f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_dump",&mdebug,NULL);CHKERRQ(ierr);
39492f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-log_view_memory",&mdebug,NULL);CHKERRQ(ierr);
39592f119d6SBarry Smith     if (mdebug) {
39692f119d6SBarry Smith       ierr = PetscMallocSetDebug(eachcall,initializenan);CHKERRQ(ierr);
39792f119d6SBarry Smith     }
39892f119d6SBarry Smith     if (mlog) {
39992f119d6SBarry Smith       PetscReal logthreshold = 0;
40092f119d6SBarry Smith       ierr = PetscOptionsGetReal(NULL,NULL,"-malloc_view_threshold",&logthreshold,NULL);CHKERRQ(ierr);
40192f119d6SBarry Smith       ierr = PetscMallocViewSet(logthreshold);CHKERRQ(ierr);
40292f119d6SBarry Smith     }
40392f119d6SBarry Smith   }
40492f119d6SBarry Smith 
405ba282f50SJed Brown   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_coalesce",&flg1,&flg2);CHKERRQ(ierr);
406ba282f50SJed Brown   if (flg2) {ierr = PetscMallocSetCoalesce(flg1);CHKERRQ(ierr);}
40790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
4082f21b5c6SHong Zhang   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_hbw",&flg1,NULL);CHKERRQ(ierr);
409cf6f3811SHong Zhang   /* ignore this option if malloc is already set */
410cf6f3811SHong Zhang   if (flg1 && !petscsetmallocvisited) {ierr = PetscSetUseHBWMalloc_Private();CHKERRQ(ierr);}
411e5c89e4eSSatish Balay 
41290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
413c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg1,NULL);CHKERRQ(ierr);
4147783f70dSSatish Balay   if (!flg1) {
41590d69ab7SBarry Smith     flg1 = PETSC_FALSE;
416c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg1,NULL);CHKERRQ(ierr);
4177783f70dSSatish Balay   }
418e5c89e4eSSatish Balay   if (flg1) {
419e5c89e4eSSatish Balay     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
420e5c89e4eSSatish Balay   }
42167584ceeSBarry Smith #endif
422e5c89e4eSSatish Balay 
423b4427426SBarry Smith #if defined(PETSC_USE_LOG)
424c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&PetscObjectsLog);CHKERRQ(ierr);
425b4427426SBarry Smith #endif
42605df10baSBarry Smith 
427e5c89e4eSSatish Balay   /*
428e5c89e4eSSatish Balay       Set the display variable for graphics
429e5c89e4eSSatish Balay   */
430e5c89e4eSSatish Balay   ierr = PetscSetDisplay();CHKERRQ(ierr);
431e5c89e4eSSatish Balay 
43251dcc849SKerry Stevens   /*
433e5c89e4eSSatish Balay       Print the PETSc version information
434e5c89e4eSSatish Balay   */
435c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-v",&flg1);CHKERRQ(ierr);
436c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-version",&flg2);CHKERRQ(ierr);
4372d747510SLisandro Dalcin   ierr = PetscOptionsHasHelp(NULL,&flg3);CHKERRQ(ierr);
438e5c89e4eSSatish Balay   if (flg1 || flg2 || flg3) {
439e5c89e4eSSatish Balay 
440e5c89e4eSSatish Balay     /*
441e5c89e4eSSatish Balay        Print "higher-level" package version message
442e5c89e4eSSatish Balay     */
443e5c89e4eSSatish Balay     if (PetscExternalVersionFunction) {
444e5c89e4eSSatish Balay       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
445e5c89e4eSSatish Balay     }
446e5c89e4eSSatish Balay 
447a523d312SBarry Smith     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
4487ca660e7SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------------------------------------\n");CHKERRQ(ierr);
449e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
450e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
451e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
45284e42920SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"See docs/faq.html for problems.\n");CHKERRQ(ierr);
453e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
454e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
4557ca660e7SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------------------------------------\n");CHKERRQ(ierr);
4567ca660e7SBarry Smith   }
4577ca660e7SBarry Smith 
45894941ca7SBarry Smith   /*
45994941ca7SBarry Smith        Print "higher-level" package help message
46094941ca7SBarry Smith   */
46194941ca7SBarry Smith   if (flg3) {
46294941ca7SBarry Smith     if (PetscExternalHelpFunction) {
46394941ca7SBarry Smith       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
46494941ca7SBarry Smith     }
46594941ca7SBarry Smith   }
46694941ca7SBarry Smith 
4677ca660e7SBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-help",helpoptions,sizeof(helpoptions),&flg1);CHKERRQ(ierr);
4687ca660e7SBarry Smith   if (flg1) {
4697ca660e7SBarry Smith     ierr = PetscStrcmp(helpoptions,"intro",&flg2);CHKERRQ(ierr);
4707ca660e7SBarry Smith     if (flg2) {
471bdb346e9SBarry Smith       ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
472008a6e76SBarry Smith       ierr = PetscFreeMPIResources();CHKERRQ(ierr);
4737ca660e7SBarry Smith       ierr = MPI_Finalize();CHKERRQ(ierr);
4747ca660e7SBarry Smith       exit(0);
4757ca660e7SBarry Smith     }
476e5c89e4eSSatish Balay   }
477e5c89e4eSSatish Balay 
478e5c89e4eSSatish Balay   /*
479e5c89e4eSSatish Balay       Setup the error handling
480e5c89e4eSSatish Balay   */
48190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
482c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_abort",&flg1,NULL);CHKERRQ(ierr);
483b59baad1SJed Brown   if (flg1) {
48442218b76SBarry Smith     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_ARE_FATAL);CHKERRQ(ierr);
485b59baad1SJed Brown     ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
486b59baad1SJed Brown   }
48790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
488c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_mpiabort",&flg1,NULL);CHKERRQ(ierr);
489cb9801acSJed Brown   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,0);CHKERRQ(ierr);}
49090d69ab7SBarry Smith   flg1 = PETSC_FALSE;
491c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpi_return_on_error",&flg1,NULL);CHKERRQ(ierr);
492e5c89e4eSSatish Balay   if (flg1) {
493d54338ecSKarl Rupp     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_RETURN);CHKERRQ(ierr);
494e5c89e4eSSatish Balay   }
49590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
496c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
4978d359177SBarry Smith   if (!flg1) {ierr = PetscPushSignalHandler(PetscSignalHandlerDefault,(void*)0);CHKERRQ(ierr);}
49896cc47afSJed Brown   flg1 = PETSC_FALSE;
499c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-fp_trap",&flg1,NULL);CHKERRQ(ierr);
50096cc47afSJed Brown   if (flg1) {ierr = PetscSetFPTrap(PETSC_FP_TRAP_ON);CHKERRQ(ierr);}
501c5929fdfSBarry Smith   ierr = PetscOptionsGetInt(NULL,NULL,"-check_pointer_intensity",&intensity,&flag);CHKERRQ(ierr);
50228559dc8SJed Brown   if (flag) {ierr = PetscCheckPointerSetIntensity(intensity);CHKERRQ(ierr);}
503e5c89e4eSSatish Balay 
504e5c89e4eSSatish Balay   /*
505e5c89e4eSSatish Balay       Setup debugger information
506e5c89e4eSSatish Balay   */
507e5c89e4eSSatish Balay   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
508c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_attach_debugger",string,64,&flg1);CHKERRQ(ierr);
509e5c89e4eSSatish Balay   if (flg1) {
510e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
511e5c89e4eSSatish Balay 
512e5c89e4eSSatish Balay     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
51333c7d699SBarry Smith     ierr = MPI_Comm_create_errhandler(Petsc_MPI_DebuggerOnError,&err_handler);CHKERRQ(ierr);
514d54338ecSKarl Rupp     ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
515e5c89e4eSSatish Balay     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,0);CHKERRQ(ierr);
516e5c89e4eSSatish Balay   }
517c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-debug_terminal",string,64,&flg1);CHKERRQ(ierr);
5185e96ac45SJed Brown   if (flg1) { ierr = PetscSetDebugTerminal(string);CHKERRQ(ierr); }
519c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-start_in_debugger",string,64,&flg1);CHKERRQ(ierr);
520c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-stop_for_debugger",string,64,&flg2);CHKERRQ(ierr);
521e5c89e4eSSatish Balay   if (flg1 || flg2) {
522e5c89e4eSSatish Balay     PetscMPIInt    size;
523e5c89e4eSSatish Balay     PetscInt       lsize,*nodes;
524e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
525e5c89e4eSSatish Balay     /*
526e5c89e4eSSatish Balay        we have to make sure that all processors have opened
527e5c89e4eSSatish Balay        connections to all other processors, otherwise once the
528e5c89e4eSSatish Balay        debugger has stated it is likely to receive a SIGUSR1
529e5c89e4eSSatish Balay        and kill the program.
530e5c89e4eSSatish Balay     */
53142218b76SBarry Smith     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
532e5c89e4eSSatish Balay     if (size > 2) {
533533163c2SBarry Smith       PetscMPIInt dummy = 0;
534e5c89e4eSSatish Balay       MPI_Status  status;
535e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
536e5c89e4eSSatish Balay         if (rank != i) {
53742218b76SBarry Smith           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,comm);CHKERRQ(ierr);
538e5c89e4eSSatish Balay         }
539e5c89e4eSSatish Balay       }
540e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
541e5c89e4eSSatish Balay         if (rank != i) {
54242218b76SBarry Smith           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,comm,&status);CHKERRQ(ierr);
543e5c89e4eSSatish Balay         }
544e5c89e4eSSatish Balay       }
545e5c89e4eSSatish Balay     }
546e5c89e4eSSatish Balay     /* check if this processor node should be in debugger */
547785e854fSJed Brown     ierr  = PetscMalloc1(size,&nodes);CHKERRQ(ierr);
548e5c89e4eSSatish Balay     lsize = size;
549c5929fdfSBarry Smith     ierr  = PetscOptionsGetIntArray(NULL,NULL,"-debugger_nodes",nodes,&lsize,&flag);CHKERRQ(ierr);
550e5c89e4eSSatish Balay     if (flag) {
551e5c89e4eSSatish Balay       for (i=0; i<lsize; i++) {
552e5c89e4eSSatish Balay         if (nodes[i] == rank) { flag = PETSC_FALSE; break; }
553e5c89e4eSSatish Balay       }
554e5c89e4eSSatish Balay     }
555e5c89e4eSSatish Balay     if (!flag) {
556e5c89e4eSSatish Balay       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
557e5c89e4eSSatish Balay       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
558e5c89e4eSSatish Balay       if (flg1) {
559e5c89e4eSSatish Balay         ierr = PetscAttachDebugger();CHKERRQ(ierr);
560e5c89e4eSSatish Balay       } else {
561e5c89e4eSSatish Balay         ierr = PetscStopForDebugger();CHKERRQ(ierr);
562e5c89e4eSSatish Balay       }
56333c7d699SBarry Smith       ierr = MPI_Comm_create_errhandler(Petsc_MPI_AbortOnError,&err_handler);CHKERRQ(ierr);
564d54338ecSKarl Rupp       ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
565e5c89e4eSSatish Balay     }
566e5c89e4eSSatish Balay     ierr = PetscFree(nodes);CHKERRQ(ierr);
567e5c89e4eSSatish Balay   }
568e5c89e4eSSatish Balay 
569c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_emacs",emacsmachinename,128,&flg1);CHKERRQ(ierr);
570cb9801acSJed Brown   if (flg1 && !rank) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr);}
571e5c89e4eSSatish Balay 
572e5c89e4eSSatish Balay   /*
573e5c89e4eSSatish Balay         Setup profiling and logging
574e5c89e4eSSatish Balay   */
5756cf91177SBarry Smith #if defined(PETSC_USE_INFO)
5768bb29257SSatish Balay   {
577e5c89e4eSSatish Balay     char logname[PETSC_MAX_PATH_LEN]; logname[0] = 0;
578c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-info",logname,250,&flg1);CHKERRQ(ierr);
5798bb29257SSatish Balay     if (flg1 && logname[0]) {
580fcc2139eSBarry Smith       ierr = PetscInfoAllow(PETSC_TRUE,logname);CHKERRQ(ierr);
5818bb29257SSatish Balay     } else if (flg1) {
5820298fd71SBarry Smith       ierr = PetscInfoAllow(PETSC_TRUE,NULL);CHKERRQ(ierr);
583e5c89e4eSSatish Balay     }
584e5c89e4eSSatish Balay   }
585865f6aa8SSatish Balay #endif
586865f6aa8SSatish Balay #if defined(PETSC_USE_LOG)
587865f6aa8SSatish Balay   mname[0] = 0;
588c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-history",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
589865f6aa8SSatish Balay   if (flg1) {
590865f6aa8SSatish Balay     if (mname[0]) {
591f3dea69dSBarry Smith       ierr = PetscOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
592865f6aa8SSatish Balay     } else {
593706d7a88SBarry Smith       ierr = PetscOpenHistoryFile(NULL,&petsc_history);CHKERRQ(ierr);
594865f6aa8SSatish Balay     }
595865f6aa8SSatish Balay   }
596217044c2SLisandro Dalcin 
597217044c2SLisandro Dalcin   ierr = PetscOptionsGetBool(NULL,NULL,"-log_sync",&PetscLogSyncOn,NULL);CHKERRQ(ierr);
598217044c2SLisandro Dalcin 
599e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
60090d69ab7SBarry Smith   flg1 = PETSC_FALSE;
601c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
602495fc317SBarry Smith   if (flg1) {ierr = PetscLogMPEBegin();CHKERRQ(ierr);}
603e5c89e4eSSatish Balay #endif
60490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
60590d69ab7SBarry Smith   flg3 = PETSC_FALSE;
606c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-log_all",&flg1,NULL);CHKERRQ(ierr);
607c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
608e5c89e4eSSatish Balay   if (flg1)                      { ierr = PetscLogAllBegin();CHKERRQ(ierr); }
609bb1d7374SBarry Smith   else if (flg3)                 { ierr = PetscLogDefaultBegin();CHKERRQ(ierr);}
610e5c89e4eSSatish Balay 
611c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_trace",mname,250,&flg1);CHKERRQ(ierr);
612e5c89e4eSSatish Balay   if (flg1) {
613e5c89e4eSSatish Balay     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
614e5c89e4eSSatish Balay     FILE *file;
615e5c89e4eSSatish Balay     if (mname[0]) {
6162e924ca5SSatish Balay       PetscSNPrintf(name,PETSC_MAX_PATH_LEN,"%s.%d",mname,rank);
617e5c89e4eSSatish Balay       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
618e5c89e4eSSatish Balay       file = fopen(fname,"w");
619f3dea69dSBarry Smith       if (!file) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
620a297a907SKarl Rupp     } else file = PETSC_STDOUT;
621e5c89e4eSSatish Balay     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
622e5c89e4eSSatish Balay   }
623bb1d7374SBarry Smith 
62416413a6aSBarry Smith   ierr = PetscOptionsGetViewer(comm,NULL,NULL,"-log_view",NULL,&format,&flg4);CHKERRQ(ierr);
625bb1d7374SBarry Smith   if (flg4) {
626bb1d7374SBarry Smith     if (format == PETSC_VIEWER_ASCII_XML) {
627bb1d7374SBarry Smith       ierr = PetscLogNestedBegin();CHKERRQ(ierr);
628bb1d7374SBarry Smith     } else {
629bb1d7374SBarry Smith       ierr = PetscLogDefaultBegin();CHKERRQ(ierr);
630bb1d7374SBarry Smith     }
631eccbb886SLisandro Dalcin   }
632eccbb886SLisandro Dalcin   if (flg4 && format == PETSC_VIEWER_ASCII_XML) {
633eccbb886SLisandro Dalcin     PetscReal threshold = PetscRealConstant(0.01);
634eccbb886SLisandro Dalcin     ierr = PetscOptionsGetReal(NULL,NULL,"-log_threshold",&threshold,&flg1);CHKERRQ(ierr);
635eccbb886SLisandro Dalcin     if (flg1) {ierr = PetscLogSetThreshold((PetscLogDouble)threshold,NULL);CHKERRQ(ierr);}
636bb1d7374SBarry Smith   }
637e5c89e4eSSatish Balay #endif
638e5c89e4eSSatish Balay 
639c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saws_options",&PetscOptionsPublish,NULL);CHKERRQ(ierr);
640e5c89e4eSSatish Balay 
6414b0a73b2SBarry Smith #if defined(PETSC_HAVE_CUDA)
6427381773fSBarry Smith   ierr = PetscOptionsBegin(comm,NULL,"CUDA initialize","Sys");CHKERRQ(ierr);
6437381773fSBarry Smith   ierr = PetscOptionsBool("-cuda_initialize","Initialize the CUDA devices and cuBLAS during PetscInitialize()",NULL,initCuda,&initCuda,NULL);CHKERRQ(ierr);
644012f15ecSRichard Tran Mills   ierr = PetscOptionsEnd();CHKERRQ(ierr);
6457381773fSBarry Smith   if (initCuda) {ierr = PetscCUDAInitialize(PETSC_COMM_WORLD);CHKERRQ(ierr);}
6464b0a73b2SBarry Smith #endif
6474b0a73b2SBarry Smith 
648e5c89e4eSSatish Balay   /*
649e5c89e4eSSatish Balay        Print basic help message
650e5c89e4eSSatish Balay   */
6512d747510SLisandro Dalcin   ierr = PetscOptionsHasHelp(NULL,&flg1);CHKERRQ(ierr);
652e5c89e4eSSatish Balay   if (flg1) {
653e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Options for all PETSc programs:\n");CHKERRQ(ierr);
654301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -help: prints help method for each option\n");CHKERRQ(ierr);
655301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -on_error_abort: cause an abort when an error is detected. Useful \n ");CHKERRQ(ierr);
656301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm,"       only when run in the debugger\n");CHKERRQ(ierr);
657e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
658e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start the debugger in new xterm\n");CHKERRQ(ierr);
659e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       unless noxterm is given\n");CHKERRQ(ierr);
660e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
661e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start all processes in the debugger\n");CHKERRQ(ierr);
662e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_emacs <machinename>\n");CHKERRQ(ierr);
663e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"    emacs jumps to error file\n");CHKERRQ(ierr);
664e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_nodes [n1,n2,..] Nodes to start in debugger\n");CHKERRQ(ierr);
665e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_pause [m] : delay (in seconds) to attach debugger\n");CHKERRQ(ierr);
666e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -stop_for_debugger : prints message on how to attach debugger manually\n");CHKERRQ(ierr);
667e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"                      waits the delay for you to attach\n");CHKERRQ(ierr);
6681cda70a7SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -display display: Location where X window graphics and debuggers are displayed\n");CHKERRQ(ierr);
669e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -no_signal_handler: do not trap error signals\n");CHKERRQ(ierr);
670e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n");CHKERRQ(ierr);
671e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -fp_trap: stop on floating point exceptions\n");CHKERRQ(ierr);
672e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"           note on IBM RS6000 this slows run greatly\n");CHKERRQ(ierr);
673e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n");CHKERRQ(ierr);
674*79dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc: use PETSc error checking malloc (deprecated, use -malloc_debug)\n");CHKERRQ(ierr);
675*79dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc no: don't use PETSc error checking malloc (deprecated, use -malloc_debug no)\n");CHKERRQ(ierr);
6764161f2a3SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_info: prints total memory usage\n");CHKERRQ(ierr);
67792f119d6SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_view <optional filename>: keeps log of all memory allocations, displays in PetscFinalize()\n");CHKERRQ(ierr);
678*79dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_debug <true or false>: enables or disables extended checking for memory corruption\n");CHKERRQ(ierr);
67926a7e8d4SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -options_view: dump list of options inputted\n");CHKERRQ(ierr);
680e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left: dump list of unused options\n");CHKERRQ(ierr);
681e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left no: don't dump list of unused options\n");CHKERRQ(ierr);
682e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -tmp tmpdir: alternative /tmp directory\n");CHKERRQ(ierr);
683e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -shared_tmp: tmp directory is shared by all processors\n");CHKERRQ(ierr);
684a8c7a070SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -not_shared_tmp: each processor has separate tmp directory\n");CHKERRQ(ierr);
6850841954dSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -memory_view: print memory usage at end of run\n");CHKERRQ(ierr);
686e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
687e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -get_total_flops: total flops over all processors\n");CHKERRQ(ierr);
688185ae32fSMatthew G. Knepley     ierr = (*PetscHelpPrintf)(comm," -log_view [:filename:[format]]: logging objects and events\n");CHKERRQ(ierr);
689e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_trace [filename]: prints trace of all PETSc calls\n");CHKERRQ(ierr);
690e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
691495fc317SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -log_mpe: Also create logfile viewable through Jumpshot\n");CHKERRQ(ierr);
692e5c89e4eSSatish Balay #endif
6936cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info <optional filename>: print informative messages about the calculations\n");CHKERRQ(ierr);
694e5c89e4eSSatish Balay #endif
695e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -v: prints PETSc version number and release date\n");CHKERRQ(ierr);
696e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_file <file>: reads options from file\n");CHKERRQ(ierr);
697e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -petsc_sleep n: sleeps n seconds before running program\n");CHKERRQ(ierr);
698e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
699e5c89e4eSSatish Balay   }
700e5c89e4eSSatish Balay 
70174ba8654SBarry Smith #if defined(PETSC_HAVE_POPEN)
70274ba8654SBarry Smith   {
70374ba8654SBarry Smith   char machine[128];
704c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-popen_machine",machine,128,&flg1);CHKERRQ(ierr);
70574ba8654SBarry Smith   if (flg1) {
70674ba8654SBarry Smith     ierr = PetscPOpenSetMachine(machine);CHKERRQ(ierr);
70774ba8654SBarry Smith   }
70874ba8654SBarry Smith   }
70974ba8654SBarry Smith #endif
71074ba8654SBarry Smith 
711c5929fdfSBarry Smith   ierr = PetscOptionsGetReal(NULL,NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
712e5c89e4eSSatish Balay   if (flg1) {
713e5c89e4eSSatish Balay     ierr = PetscSleep(si);CHKERRQ(ierr);
714e5c89e4eSSatish Balay   }
715e5c89e4eSSatish Balay 
716c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-info_exclude",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
7172ea1be5dSBarry Smith   if (flg1) {
718e5c89e4eSSatish Balay     ierr = PetscStrstr(mname,"null",&f);CHKERRQ(ierr);
719e5c89e4eSSatish Balay     if (f) {
720ecd8bba6SJed Brown       ierr = PetscInfoDeactivateClass(0);CHKERRQ(ierr);
721e5c89e4eSSatish Balay     }
7222ea1be5dSBarry Smith   }
723827f890bSBarry Smith 
724fdc842d1SBarry Smith #if defined(PETSC_HAVE_VIENNACL)
725c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
726f14045dbSBarry Smith   if (!flg3) {
727c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-log_view",&flg3);CHKERRQ(ierr);
728f14045dbSBarry Smith   }
729c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-viennacl_synchronize",&flg3,NULL);CHKERRQ(ierr);
730f14045dbSBarry Smith   PetscViennaCLSynchronize = flg3;
731fdc842d1SBarry Smith   ierr = PetscViennaCLInit();CHKERRQ(ierr);
7324cf1874eSKarl Rupp #endif
73382f73ecaSAlejandro Lamas Daviña 
734fdc842d1SBarry Smith   /*
735fdc842d1SBarry Smith      Creates the logging data structures; this is enabled even if logging is not turned on
736fdc842d1SBarry Smith      This is the last thing we do before returning to the user code to prevent having the
737fdc842d1SBarry Smith      logging numbers contaminated by any startup time associated with MPI and the GPUs
738fdc842d1SBarry Smith   */
739fdc842d1SBarry Smith #if defined(PETSC_USE_LOG)
740fdc842d1SBarry Smith   ierr = PetscLogInitialize();CHKERRQ(ierr);
741f0a7718cSKarl Rupp #endif
742f0a7718cSKarl Rupp 
743e5c89e4eSSatish Balay   PetscFunctionReturn(0);
744e5c89e4eSSatish Balay }
745