xref: /petsc/src/sys/objects/init.c (revision e781f417fcf720434fa4fe36100d85efa81bd61c)
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>
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();
19341e02c4dSJunchao Zhang   if (ierr) PETSCABORT(*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:
2069d90e779SBarry Smith +  -cuda_initialize <default yes,no> - do the initialization in PetscInitialize(). If -cuda_initialize no is used then the default initialization is done automatically
2079d90e779SBarry Smith                                when the first CUDA call is made unless you call PetscCUDAInitialize() before any CUDA operations are performed
2087381773fSBarry Smith .  -cuda_view - view information about the CUDA devices
2097381773fSBarry 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
2107381773fSBarry Smith -  -cuda_set_device <gpu> - integer number of the device
2117381773fSBarry Smith 
21290ea27d8SSatish Balay   Level: beginner
21390ea27d8SSatish Balay 
2147381773fSBarry Smith   Notes:
2157381773fSBarry Smith    Initializing cuBLAS takes about 1/2 second there it is done by default in PetscInitialize() before logging begins
2167381773fSBarry Smith 
2177381773fSBarry Smith @*/
2187381773fSBarry Smith PetscErrorCode PetscCUDAInitialize(MPI_Comm comm)
2197381773fSBarry Smith {
2207381773fSBarry Smith   PetscErrorCode        ierr;
2217381773fSBarry Smith   PetscInt              deviceOpt = 0;
2227381773fSBarry Smith   PetscBool             cuda_view_flag = PETSC_FALSE,flg;
2237381773fSBarry Smith   struct cudaDeviceProp prop;
2247381773fSBarry Smith   int                   devCount,device,devicecnt;
2257381773fSBarry Smith   cudaError_t           err = cudaSuccess;
2267381773fSBarry Smith   PetscMPIInt           rank,size;
2277381773fSBarry Smith 
2287381773fSBarry Smith   PetscFunctionBegin;
2297381773fSBarry Smith   /*
2307381773fSBarry Smith      If collecting logging information, by default, wait for GPU to complete its operations
2317381773fSBarry Smith      before returning to the CPU in order to get accurate timings of each event
2327381773fSBarry Smith   */
2337381773fSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&PetscCUDASynchronize);CHKERRQ(ierr);
2347381773fSBarry Smith   if (!PetscCUDASynchronize) {
2357381773fSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-log_view",&PetscCUDASynchronize);CHKERRQ(ierr);
2367381773fSBarry Smith   }
2377381773fSBarry Smith 
2387381773fSBarry Smith   ierr = PetscOptionsBegin(comm,NULL,"CUDA options","Sys");CHKERRQ(ierr);
2397381773fSBarry Smith   ierr = PetscOptionsInt("-cuda_set_device","Set all MPI ranks to use the specified CUDA device",NULL,deviceOpt,&deviceOpt,&flg);CHKERRQ(ierr);
2407381773fSBarry Smith   device = (int)deviceOpt;
2417381773fSBarry Smith   ierr = PetscOptionsBool("-cuda_synchronize","Wait for the GPU to complete operations before returning to the CPU",NULL,PetscCUDASynchronize,&PetscCUDASynchronize,NULL);CHKERRQ(ierr);
2427381773fSBarry Smith   ierr = PetscOptionsDeprecated("-cuda_show_devices","-cuda_view","3.12",NULL);CHKERRQ(ierr);
2437381773fSBarry Smith   ierr = PetscOptionsName("-cuda_view","Display CUDA device information and assignments",NULL,&cuda_view_flag);CHKERRQ(ierr);
2447381773fSBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
2457381773fSBarry Smith   if (!PetscCUDAInitialized) {
2467381773fSBarry Smith     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
2477381773fSBarry Smith 
2487381773fSBarry Smith     if (size>1 && !flg) {
2497381773fSBarry Smith       /* check to see if we force multiple ranks to hit the same GPU */
2507381773fSBarry Smith       /* we're not using the same GPU on multiple MPI threads. So try to allocated different   GPUs to different processes */
2517381773fSBarry Smith 
2527381773fSBarry Smith       /* First get the device count */
2537381773fSBarry Smith       err   = cudaGetDeviceCount(&devCount);
2547381773fSBarry Smith       if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
2557381773fSBarry Smith 
2567381773fSBarry Smith       /* next determine the rank and then set the device via a mod */
2577381773fSBarry Smith       ierr   = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2587381773fSBarry Smith       device = rank % devCount;
2597381773fSBarry Smith     }
2607381773fSBarry Smith     err = cudaSetDevice(device);
2617381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
2627381773fSBarry Smith 
2637381773fSBarry Smith     /* set the device flags so that it can map host memory */
2647381773fSBarry Smith     err = cudaSetDeviceFlags(cudaDeviceMapHost);
2657381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDeviceFlags %s",cudaGetErrorString(err));
2667381773fSBarry Smith 
2677381773fSBarry Smith     ierr = PetscCUBLASInitializeHandle();CHKERRQ(ierr);
2683bbda9c2SStefano Zampini     ierr = PetscCUSOLVERDnInitializeHandle();CHKERRQ(ierr);
2697381773fSBarry Smith     PetscCUDAInitialized = PETSC_TRUE;
2707381773fSBarry Smith   }
2717381773fSBarry Smith   if (cuda_view_flag) {
2727381773fSBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2737381773fSBarry Smith     err  = cudaGetDeviceCount(&devCount);
2747381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
2757381773fSBarry Smith     for (devicecnt = 0; devicecnt < devCount; ++devicecnt) {
2767381773fSBarry Smith       err = cudaGetDeviceProperties(&prop,devicecnt);
2777381773fSBarry Smith       if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceProperties %s",cudaGetErrorString(err));
2787381773fSBarry Smith       ierr = PetscPrintf(comm, "CUDA device %d: %s\n", devicecnt, prop.name);CHKERRQ(ierr);
2797381773fSBarry Smith     }
2807381773fSBarry Smith     ierr = PetscSynchronizedPrintf(comm,"[%d] Using CUDA device %d.\n",rank,device);CHKERRQ(ierr);
2817381773fSBarry Smith     ierr = PetscSynchronizedFlush(comm,PETSC_STDOUT);CHKERRQ(ierr);
2827381773fSBarry Smith   }
2837381773fSBarry Smith   PetscFunctionReturn(0);
2847381773fSBarry Smith }
2857381773fSBarry Smith #endif
2867381773fSBarry Smith 
287e5c89e4eSSatish Balay /*@C
288e5c89e4eSSatish Balay    PetscEnd - Calls PetscFinalize() and then ends the program. This is useful if one
289e5c89e4eSSatish Balay      wishes a clean exit somewhere deep in the program.
290e5c89e4eSSatish Balay 
291e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
292e5c89e4eSSatish Balay 
293e5c89e4eSSatish Balay    Options Database Keys are the same as for PetscFinalize()
294e5c89e4eSSatish Balay 
295e5c89e4eSSatish Balay    Level: advanced
296e5c89e4eSSatish Balay 
297e5c89e4eSSatish Balay    Note:
298e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
299e5c89e4eSSatish Balay 
30088c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscFinalize()
301e5c89e4eSSatish Balay @*/
3027087cfbeSBarry Smith PetscErrorCode  PetscEnd(void)
303e5c89e4eSSatish Balay {
304e5c89e4eSSatish Balay   PetscFunctionBegin;
305e5c89e4eSSatish Balay   PetscFinalize();
306e5c89e4eSSatish Balay   exit(0);
307e5c89e4eSSatish Balay   return 0;
308e5c89e4eSSatish Balay }
309e5c89e4eSSatish Balay 
310ace3abfcSBarry Smith PetscBool PetscOptionsPublish = PETSC_FALSE;
31195c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSetUseHBWMalloc_Private(void);
31295c0884eSLisandro Dalcin PETSC_INTERN PetscBool      petscsetmallocvisited;
313e5c89e4eSSatish Balay static       char           emacsmachinename[256];
314e5c89e4eSSatish Balay 
315e5c89e4eSSatish Balay PetscErrorCode (*PetscExternalVersionFunction)(MPI_Comm) = 0;
316e5c89e4eSSatish Balay PetscErrorCode (*PetscExternalHelpFunction)(MPI_Comm)    = 0;
317e5c89e4eSSatish Balay 
318e5c89e4eSSatish Balay /*@C
319e5c89e4eSSatish Balay    PetscSetHelpVersionFunctions - Sets functions that print help and version information
320e5c89e4eSSatish Balay    before the PETSc help and version information is printed. Must call BEFORE PetscInitialize().
321e5c89e4eSSatish Balay    This routine enables a "higher-level" package that uses PETSc to print its messages first.
322e5c89e4eSSatish Balay 
323e5c89e4eSSatish Balay    Input Parameter:
3240298fd71SBarry Smith +  help - the help function (may be NULL)
3250298fd71SBarry Smith -  version - the version function (may be NULL)
326e5c89e4eSSatish Balay 
327e5c89e4eSSatish Balay    Level: developer
328e5c89e4eSSatish Balay 
329e5c89e4eSSatish Balay @*/
3307087cfbeSBarry Smith PetscErrorCode  PetscSetHelpVersionFunctions(PetscErrorCode (*help)(MPI_Comm),PetscErrorCode (*version)(MPI_Comm))
331e5c89e4eSSatish Balay {
332e5c89e4eSSatish Balay   PetscFunctionBegin;
333e5c89e4eSSatish Balay   PetscExternalHelpFunction    = help;
334e5c89e4eSSatish Balay   PetscExternalVersionFunction = version;
335e5c89e4eSSatish Balay   PetscFunctionReturn(0);
336e5c89e4eSSatish Balay }
337e5c89e4eSSatish Balay 
33805df10baSBarry Smith #if defined(PETSC_USE_LOG)
33995c0884eSLisandro Dalcin PETSC_INTERN PetscBool   PetscObjectsLog;
34005df10baSBarry Smith #endif
34105df10baSBarry Smith 
342*e781f417SStefano Zampini void PetscMPI_Comm_eh(MPI_Comm *comm, PetscMPIInt *err, ...)
343*e781f417SStefano Zampini {
344*e781f417SStefano Zampini   if (PetscUnlikely(*err)) {
345*e781f417SStefano Zampini     PetscMPIInt len;
346*e781f417SStefano Zampini     char        errstring[MPI_MAX_ERROR_STRING];
347*e781f417SStefano Zampini 
348*e781f417SStefano Zampini     MPI_Error_string(*err,errstring,&len);
349*e781f417SStefano Zampini     PetscError(MPI_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,PETSC_MPI_ERROR_CODE,PETSC_ERROR_INITIAL,"Internal error in MPI: %s",errstring);
350*e781f417SStefano Zampini   }
351*e781f417SStefano Zampini   return;
352*e781f417SStefano Zampini }
353*e781f417SStefano Zampini 
35495c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode  PetscOptionsCheckInitial_Private(void)
355e5c89e4eSSatish Balay {
356e5c89e4eSSatish Balay   char              string[64],mname[PETSC_MAX_PATH_LEN],*f;
357e5c89e4eSSatish Balay   MPI_Comm          comm = PETSC_COMM_WORLD;
35867584ceeSBarry Smith   PetscBool         flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,flag;
359e5c89e4eSSatish Balay   PetscErrorCode    ierr;
36067584ceeSBarry Smith   PetscReal         si;
36128559dc8SJed Brown   PetscInt          intensity;
362e5c89e4eSSatish Balay   int               i;
363e5c89e4eSSatish Balay   PetscMPIInt       rank;
3647ca660e7SBarry Smith   char              version[256],helpoptions[256];
3652479a3a6SBarry Smith #if defined(PETSC_USE_LOG)
3662479a3a6SBarry Smith   PetscViewerFormat format;
36767584ceeSBarry Smith   PetscBool         flg4 = PETSC_FALSE;
36867584ceeSBarry Smith #endif
369012f15ecSRichard Tran Mills #if defined(PETSC_HAVE_CUDA)
3707381773fSBarry Smith   PetscBool         initCuda = PETSC_TRUE;
371012f15ecSRichard Tran Mills #endif
3727381773fSBarry Smith 
373e5c89e4eSSatish Balay   PetscFunctionBegin;
37442218b76SBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
375e5c89e4eSSatish Balay 
37667584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
37792f119d6SBarry Smith   if (!(PETSC_RUNNING_ON_VALGRIND)) {
378e5c89e4eSSatish Balay     /*
379e5c89e4eSSatish Balay       Setup the memory management; support for tracing malloc() usage
380e5c89e4eSSatish Balay     */
381244bdbccSBarry Smith     PetscBool         mdebug = PETSC_FALSE, eachcall = PETSC_FALSE, initializenan = PETSC_FALSE, mlog = PETSC_FALSE;
38292f119d6SBarry Smith 
3838bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
38492f119d6SBarry Smith     mdebug        = PETSC_TRUE;
38592f119d6SBarry Smith     initializenan = PETSC_TRUE;
38692f119d6SBarry Smith     ierr   = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
387e5c89e4eSSatish Balay #else
38892f119d6SBarry Smith     /* don't warn about unused option */
38992f119d6SBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
39092f119d6SBarry Smith     flg1 = PETSC_FALSE;
391e5c89e4eSSatish Balay #endif
39279dccf82SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg2,&flg3);CHKERRQ(ierr);
39392f119d6SBarry Smith     if (flg1 || flg2) {
39492f119d6SBarry Smith       mdebug        = PETSC_TRUE;
39592f119d6SBarry Smith       eachcall      = PETSC_TRUE;
39692f119d6SBarry Smith       initializenan = PETSC_TRUE;
39779dccf82SBarry Smith     } else if (flg3 && !flg2) {
39879dccf82SBarry Smith       mdebug        = PETSC_FALSE;
39979dccf82SBarry Smith       eachcall      = PETSC_FALSE;
40079dccf82SBarry Smith       initializenan = PETSC_FALSE;
401e5c89e4eSSatish Balay     }
40292f119d6SBarry Smith 
40392f119d6SBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_view",&mlog);CHKERRQ(ierr);
40492f119d6SBarry Smith     if (mlog) {
40592f119d6SBarry Smith       mdebug = PETSC_TRUE;
40692f119d6SBarry Smith     }
40779dccf82SBarry Smith     /* the next line is deprecated */
40892f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc",&mdebug,NULL);CHKERRQ(ierr);
40992f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_dump",&mdebug,NULL);CHKERRQ(ierr);
41092f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-log_view_memory",&mdebug,NULL);CHKERRQ(ierr);
41192f119d6SBarry Smith     if (mdebug) {
41292f119d6SBarry Smith       ierr = PetscMallocSetDebug(eachcall,initializenan);CHKERRQ(ierr);
41392f119d6SBarry Smith     }
41492f119d6SBarry Smith     if (mlog) {
41592f119d6SBarry Smith       PetscReal logthreshold = 0;
41692f119d6SBarry Smith       ierr = PetscOptionsGetReal(NULL,NULL,"-malloc_view_threshold",&logthreshold,NULL);CHKERRQ(ierr);
41792f119d6SBarry Smith       ierr = PetscMallocViewSet(logthreshold);CHKERRQ(ierr);
41892f119d6SBarry Smith     }
41992f119d6SBarry Smith   }
42092f119d6SBarry Smith 
421ba282f50SJed Brown   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_coalesce",&flg1,&flg2);CHKERRQ(ierr);
422ba282f50SJed Brown   if (flg2) {ierr = PetscMallocSetCoalesce(flg1);CHKERRQ(ierr);}
42390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
4242f21b5c6SHong Zhang   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_hbw",&flg1,NULL);CHKERRQ(ierr);
425cf6f3811SHong Zhang   /* ignore this option if malloc is already set */
426cf6f3811SHong Zhang   if (flg1 && !petscsetmallocvisited) {ierr = PetscSetUseHBWMalloc_Private();CHKERRQ(ierr);}
427e5c89e4eSSatish Balay 
42890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
429c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg1,NULL);CHKERRQ(ierr);
4307783f70dSSatish Balay   if (!flg1) {
43190d69ab7SBarry Smith     flg1 = PETSC_FALSE;
432c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg1,NULL);CHKERRQ(ierr);
4337783f70dSSatish Balay   }
434e5c89e4eSSatish Balay   if (flg1) {
435e5c89e4eSSatish Balay     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
436e5c89e4eSSatish Balay   }
43767584ceeSBarry Smith #endif
438e5c89e4eSSatish Balay 
439b4427426SBarry Smith #if defined(PETSC_USE_LOG)
440c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&PetscObjectsLog);CHKERRQ(ierr);
441b4427426SBarry Smith #endif
44205df10baSBarry Smith 
443e5c89e4eSSatish Balay   /*
444e5c89e4eSSatish Balay       Set the display variable for graphics
445e5c89e4eSSatish Balay   */
446e5c89e4eSSatish Balay   ierr = PetscSetDisplay();CHKERRQ(ierr);
447e5c89e4eSSatish Balay 
44851dcc849SKerry Stevens   /*
449e5c89e4eSSatish Balay       Print the PETSc version information
450e5c89e4eSSatish Balay   */
451c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-v",&flg1);CHKERRQ(ierr);
452c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-version",&flg2);CHKERRQ(ierr);
4532d747510SLisandro Dalcin   ierr = PetscOptionsHasHelp(NULL,&flg3);CHKERRQ(ierr);
454e5c89e4eSSatish Balay   if (flg1 || flg2 || flg3) {
455e5c89e4eSSatish Balay 
456e5c89e4eSSatish Balay     /*
457e5c89e4eSSatish Balay        Print "higher-level" package version message
458e5c89e4eSSatish Balay     */
459e5c89e4eSSatish Balay     if (PetscExternalVersionFunction) {
460e5c89e4eSSatish Balay       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
461e5c89e4eSSatish Balay     }
462e5c89e4eSSatish Balay 
463a523d312SBarry Smith     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
4647ca660e7SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------------------------------------\n");CHKERRQ(ierr);
465e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
466e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
467e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
46884e42920SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"See docs/faq.html for problems.\n");CHKERRQ(ierr);
469e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
470e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
4717ca660e7SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------------------------------------\n");CHKERRQ(ierr);
4727ca660e7SBarry Smith   }
4737ca660e7SBarry Smith 
47494941ca7SBarry Smith   /*
47594941ca7SBarry Smith        Print "higher-level" package help message
47694941ca7SBarry Smith   */
47794941ca7SBarry Smith   if (flg3) {
47894941ca7SBarry Smith     if (PetscExternalHelpFunction) {
47994941ca7SBarry Smith       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
48094941ca7SBarry Smith     }
48194941ca7SBarry Smith   }
48294941ca7SBarry Smith 
4837ca660e7SBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-help",helpoptions,sizeof(helpoptions),&flg1);CHKERRQ(ierr);
4847ca660e7SBarry Smith   if (flg1) {
4857ca660e7SBarry Smith     ierr = PetscStrcmp(helpoptions,"intro",&flg2);CHKERRQ(ierr);
4867ca660e7SBarry Smith     if (flg2) {
487bdb346e9SBarry Smith       ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
488008a6e76SBarry Smith       ierr = PetscFreeMPIResources();CHKERRQ(ierr);
4897ca660e7SBarry Smith       ierr = MPI_Finalize();CHKERRQ(ierr);
4907ca660e7SBarry Smith       exit(0);
4917ca660e7SBarry Smith     }
492e5c89e4eSSatish Balay   }
493e5c89e4eSSatish Balay 
494e5c89e4eSSatish Balay   /*
495e5c89e4eSSatish Balay       Setup the error handling
496e5c89e4eSSatish Balay   */
49790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
498c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_abort",&flg1,NULL);CHKERRQ(ierr);
499b59baad1SJed Brown   if (flg1) {
50042218b76SBarry Smith     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_ARE_FATAL);CHKERRQ(ierr);
501b59baad1SJed Brown     ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
502b59baad1SJed Brown   }
50390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
504c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_mpiabort",&flg1,NULL);CHKERRQ(ierr);
505cb9801acSJed Brown   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,0);CHKERRQ(ierr);}
50690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
507c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpi_return_on_error",&flg1,NULL);CHKERRQ(ierr);
508e5c89e4eSSatish Balay   if (flg1) {
509d54338ecSKarl Rupp     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_RETURN);CHKERRQ(ierr);
510e5c89e4eSSatish Balay   }
511*e781f417SStefano Zampini   /* experimental */
512*e781f417SStefano Zampini   flg1 = PETSC_FALSE;
513*e781f417SStefano Zampini   ierr = PetscOptionsGetBool(NULL,NULL,"-mpi_return_error_string",&flg1,NULL);CHKERRQ(ierr);
514*e781f417SStefano Zampini   if (flg1) {
515*e781f417SStefano Zampini     MPI_Errhandler eh;
516*e781f417SStefano Zampini 
517*e781f417SStefano Zampini     ierr = MPI_Comm_create_errhandler(PetscMPI_Comm_eh,&eh);CHKERRQ(ierr);
518*e781f417SStefano Zampini     ierr = MPI_Comm_set_errhandler(comm,eh);CHKERRQ(ierr);
519*e781f417SStefano Zampini     ierr = MPI_Errhandler_free(&eh);CHKERRQ(ierr);
520*e781f417SStefano Zampini   }
52190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
522c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
5238d359177SBarry Smith   if (!flg1) {ierr = PetscPushSignalHandler(PetscSignalHandlerDefault,(void*)0);CHKERRQ(ierr);}
52496cc47afSJed Brown   flg1 = PETSC_FALSE;
525a9acdec7SBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-fp_trap",&flg1,&flag);CHKERRQ(ierr);
526a9acdec7SBarry Smith   if (flag) {ierr = PetscSetFPTrap((PetscFPTrap)flg1);CHKERRQ(ierr);}
527c5929fdfSBarry Smith   ierr = PetscOptionsGetInt(NULL,NULL,"-check_pointer_intensity",&intensity,&flag);CHKERRQ(ierr);
52828559dc8SJed Brown   if (flag) {ierr = PetscCheckPointerSetIntensity(intensity);CHKERRQ(ierr);}
529e5c89e4eSSatish Balay 
530e5c89e4eSSatish Balay   /*
531e5c89e4eSSatish Balay       Setup debugger information
532e5c89e4eSSatish Balay   */
533e5c89e4eSSatish Balay   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
534c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_attach_debugger",string,64,&flg1);CHKERRQ(ierr);
535e5c89e4eSSatish Balay   if (flg1) {
536e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
537e5c89e4eSSatish Balay 
538e5c89e4eSSatish Balay     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
53933c7d699SBarry Smith     ierr = MPI_Comm_create_errhandler(Petsc_MPI_DebuggerOnError,&err_handler);CHKERRQ(ierr);
540d54338ecSKarl Rupp     ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
541e5c89e4eSSatish Balay     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,0);CHKERRQ(ierr);
542e5c89e4eSSatish Balay   }
543c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-debug_terminal",string,64,&flg1);CHKERRQ(ierr);
5445e96ac45SJed Brown   if (flg1) { ierr = PetscSetDebugTerminal(string);CHKERRQ(ierr); }
545c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-start_in_debugger",string,64,&flg1);CHKERRQ(ierr);
546c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-stop_for_debugger",string,64,&flg2);CHKERRQ(ierr);
547e5c89e4eSSatish Balay   if (flg1 || flg2) {
548e5c89e4eSSatish Balay     PetscMPIInt    size;
549e5c89e4eSSatish Balay     PetscInt       lsize,*nodes;
550e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
551e5c89e4eSSatish Balay     /*
552e5c89e4eSSatish Balay        we have to make sure that all processors have opened
553e5c89e4eSSatish Balay        connections to all other processors, otherwise once the
554e5c89e4eSSatish Balay        debugger has stated it is likely to receive a SIGUSR1
555e5c89e4eSSatish Balay        and kill the program.
556e5c89e4eSSatish Balay     */
55742218b76SBarry Smith     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
558e5c89e4eSSatish Balay     if (size > 2) {
559533163c2SBarry Smith       PetscMPIInt dummy = 0;
560e5c89e4eSSatish Balay       MPI_Status  status;
561e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
562e5c89e4eSSatish Balay         if (rank != i) {
56342218b76SBarry Smith           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,comm);CHKERRQ(ierr);
564e5c89e4eSSatish Balay         }
565e5c89e4eSSatish Balay       }
566e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
567e5c89e4eSSatish Balay         if (rank != i) {
56842218b76SBarry Smith           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,comm,&status);CHKERRQ(ierr);
569e5c89e4eSSatish Balay         }
570e5c89e4eSSatish Balay       }
571e5c89e4eSSatish Balay     }
572e5c89e4eSSatish Balay     /* check if this processor node should be in debugger */
573785e854fSJed Brown     ierr  = PetscMalloc1(size,&nodes);CHKERRQ(ierr);
574e5c89e4eSSatish Balay     lsize = size;
575c5929fdfSBarry Smith     ierr  = PetscOptionsGetIntArray(NULL,NULL,"-debugger_nodes",nodes,&lsize,&flag);CHKERRQ(ierr);
576e5c89e4eSSatish Balay     if (flag) {
577e5c89e4eSSatish Balay       for (i=0; i<lsize; i++) {
578e5c89e4eSSatish Balay         if (nodes[i] == rank) { flag = PETSC_FALSE; break; }
579e5c89e4eSSatish Balay       }
580e5c89e4eSSatish Balay     }
581e5c89e4eSSatish Balay     if (!flag) {
582e5c89e4eSSatish Balay       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
583e5c89e4eSSatish Balay       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
584e5c89e4eSSatish Balay       if (flg1) {
585e5c89e4eSSatish Balay         ierr = PetscAttachDebugger();CHKERRQ(ierr);
586e5c89e4eSSatish Balay       } else {
587e5c89e4eSSatish Balay         ierr = PetscStopForDebugger();CHKERRQ(ierr);
588e5c89e4eSSatish Balay       }
58933c7d699SBarry Smith       ierr = MPI_Comm_create_errhandler(Petsc_MPI_AbortOnError,&err_handler);CHKERRQ(ierr);
590d54338ecSKarl Rupp       ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
591e5c89e4eSSatish Balay     }
592e5c89e4eSSatish Balay     ierr = PetscFree(nodes);CHKERRQ(ierr);
593e5c89e4eSSatish Balay   }
594e5c89e4eSSatish Balay 
595c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_emacs",emacsmachinename,128,&flg1);CHKERRQ(ierr);
596cb9801acSJed Brown   if (flg1 && !rank) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr);}
597e5c89e4eSSatish Balay 
598e5c89e4eSSatish Balay   /*
599e5c89e4eSSatish Balay         Setup profiling and logging
600e5c89e4eSSatish Balay   */
6016cf91177SBarry Smith #if defined(PETSC_USE_INFO)
6028bb29257SSatish Balay   {
603e5c89e4eSSatish Balay     char logname[PETSC_MAX_PATH_LEN]; logname[0] = 0;
604c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-info",logname,250,&flg1);CHKERRQ(ierr);
6058bb29257SSatish Balay     if (flg1 && logname[0]) {
606fcc2139eSBarry Smith       ierr = PetscInfoAllow(PETSC_TRUE,logname);CHKERRQ(ierr);
6078bb29257SSatish Balay     } else if (flg1) {
6080298fd71SBarry Smith       ierr = PetscInfoAllow(PETSC_TRUE,NULL);CHKERRQ(ierr);
609e5c89e4eSSatish Balay     }
610e5c89e4eSSatish Balay   }
611865f6aa8SSatish Balay #endif
612865f6aa8SSatish Balay #if defined(PETSC_USE_LOG)
613865f6aa8SSatish Balay   mname[0] = 0;
614c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-history",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
615865f6aa8SSatish Balay   if (flg1) {
616865f6aa8SSatish Balay     if (mname[0]) {
617f3dea69dSBarry Smith       ierr = PetscOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
618865f6aa8SSatish Balay     } else {
619706d7a88SBarry Smith       ierr = PetscOpenHistoryFile(NULL,&petsc_history);CHKERRQ(ierr);
620865f6aa8SSatish Balay     }
621865f6aa8SSatish Balay   }
622217044c2SLisandro Dalcin 
623217044c2SLisandro Dalcin   ierr = PetscOptionsGetBool(NULL,NULL,"-log_sync",&PetscLogSyncOn,NULL);CHKERRQ(ierr);
624217044c2SLisandro Dalcin 
625e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
62690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
627c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
628495fc317SBarry Smith   if (flg1) {ierr = PetscLogMPEBegin();CHKERRQ(ierr);}
629e5c89e4eSSatish Balay #endif
63090d69ab7SBarry Smith   flg1 = PETSC_FALSE;
63190d69ab7SBarry Smith   flg3 = PETSC_FALSE;
632c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-log_all",&flg1,NULL);CHKERRQ(ierr);
633c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
634e5c89e4eSSatish Balay   if (flg1)                      { ierr = PetscLogAllBegin();CHKERRQ(ierr); }
635bb1d7374SBarry Smith   else if (flg3)                 { ierr = PetscLogDefaultBegin();CHKERRQ(ierr);}
636e5c89e4eSSatish Balay 
637c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_trace",mname,250,&flg1);CHKERRQ(ierr);
638e5c89e4eSSatish Balay   if (flg1) {
639e5c89e4eSSatish Balay     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
640e5c89e4eSSatish Balay     FILE *file;
641e5c89e4eSSatish Balay     if (mname[0]) {
6422e924ca5SSatish Balay       PetscSNPrintf(name,PETSC_MAX_PATH_LEN,"%s.%d",mname,rank);
643e5c89e4eSSatish Balay       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
644e5c89e4eSSatish Balay       file = fopen(fname,"w");
645f3dea69dSBarry Smith       if (!file) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
646a297a907SKarl Rupp     } else file = PETSC_STDOUT;
647e5c89e4eSSatish Balay     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
648e5c89e4eSSatish Balay   }
649bb1d7374SBarry Smith 
65016413a6aSBarry Smith   ierr = PetscOptionsGetViewer(comm,NULL,NULL,"-log_view",NULL,&format,&flg4);CHKERRQ(ierr);
651bb1d7374SBarry Smith   if (flg4) {
652bb1d7374SBarry Smith     if (format == PETSC_VIEWER_ASCII_XML) {
653bb1d7374SBarry Smith       ierr = PetscLogNestedBegin();CHKERRQ(ierr);
654bb1d7374SBarry Smith     } else {
655bb1d7374SBarry Smith       ierr = PetscLogDefaultBegin();CHKERRQ(ierr);
656bb1d7374SBarry Smith     }
657eccbb886SLisandro Dalcin   }
658eccbb886SLisandro Dalcin   if (flg4 && format == PETSC_VIEWER_ASCII_XML) {
659eccbb886SLisandro Dalcin     PetscReal threshold = PetscRealConstant(0.01);
660eccbb886SLisandro Dalcin     ierr = PetscOptionsGetReal(NULL,NULL,"-log_threshold",&threshold,&flg1);CHKERRQ(ierr);
661eccbb886SLisandro Dalcin     if (flg1) {ierr = PetscLogSetThreshold((PetscLogDouble)threshold,NULL);CHKERRQ(ierr);}
662bb1d7374SBarry Smith   }
663e5c89e4eSSatish Balay #endif
664e5c89e4eSSatish Balay 
665c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saws_options",&PetscOptionsPublish,NULL);CHKERRQ(ierr);
666e5c89e4eSSatish Balay 
6674b0a73b2SBarry Smith #if defined(PETSC_HAVE_CUDA)
6687381773fSBarry Smith   ierr = PetscOptionsBegin(comm,NULL,"CUDA initialize","Sys");CHKERRQ(ierr);
6697381773fSBarry Smith   ierr = PetscOptionsBool("-cuda_initialize","Initialize the CUDA devices and cuBLAS during PetscInitialize()",NULL,initCuda,&initCuda,NULL);CHKERRQ(ierr);
670012f15ecSRichard Tran Mills   ierr = PetscOptionsEnd();CHKERRQ(ierr);
6717381773fSBarry Smith   if (initCuda) {ierr = PetscCUDAInitialize(PETSC_COMM_WORLD);CHKERRQ(ierr);}
6724b0a73b2SBarry Smith #endif
6734b0a73b2SBarry Smith 
674e5c89e4eSSatish Balay   /*
675e5c89e4eSSatish Balay        Print basic help message
676e5c89e4eSSatish Balay   */
6772d747510SLisandro Dalcin   ierr = PetscOptionsHasHelp(NULL,&flg1);CHKERRQ(ierr);
678e5c89e4eSSatish Balay   if (flg1) {
679e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Options for all PETSc programs:\n");CHKERRQ(ierr);
680301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -help: prints help method for each option\n");CHKERRQ(ierr);
681301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -on_error_abort: cause an abort when an error is detected. Useful \n ");CHKERRQ(ierr);
682301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm,"       only when run in the debugger\n");CHKERRQ(ierr);
683e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
684e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start the debugger in new xterm\n");CHKERRQ(ierr);
685e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       unless noxterm is given\n");CHKERRQ(ierr);
686e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
687e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start all processes in the debugger\n");CHKERRQ(ierr);
688e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_emacs <machinename>\n");CHKERRQ(ierr);
689e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"    emacs jumps to error file\n");CHKERRQ(ierr);
690e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_nodes [n1,n2,..] Nodes to start in debugger\n");CHKERRQ(ierr);
691e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_pause [m] : delay (in seconds) to attach debugger\n");CHKERRQ(ierr);
692e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -stop_for_debugger : prints message on how to attach debugger manually\n");CHKERRQ(ierr);
693e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"                      waits the delay for you to attach\n");CHKERRQ(ierr);
6941cda70a7SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -display display: Location where X window graphics and debuggers are displayed\n");CHKERRQ(ierr);
695e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -no_signal_handler: do not trap error signals\n");CHKERRQ(ierr);
696e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n");CHKERRQ(ierr);
697e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -fp_trap: stop on floating point exceptions\n");CHKERRQ(ierr);
698e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"           note on IBM RS6000 this slows run greatly\n");CHKERRQ(ierr);
699e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n");CHKERRQ(ierr);
70079dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc: use PETSc error checking malloc (deprecated, use -malloc_debug)\n");CHKERRQ(ierr);
70179dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc no: don't use PETSc error checking malloc (deprecated, use -malloc_debug no)\n");CHKERRQ(ierr);
7024161f2a3SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_info: prints total memory usage\n");CHKERRQ(ierr);
70392f119d6SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_view <optional filename>: keeps log of all memory allocations, displays in PetscFinalize()\n");CHKERRQ(ierr);
70479dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_debug <true or false>: enables or disables extended checking for memory corruption\n");CHKERRQ(ierr);
70526a7e8d4SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -options_view: dump list of options inputted\n");CHKERRQ(ierr);
706e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left: dump list of unused options\n");CHKERRQ(ierr);
707e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left no: don't dump list of unused options\n");CHKERRQ(ierr);
708e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -tmp tmpdir: alternative /tmp directory\n");CHKERRQ(ierr);
709e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -shared_tmp: tmp directory is shared by all processors\n");CHKERRQ(ierr);
710a8c7a070SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -not_shared_tmp: each processor has separate tmp directory\n");CHKERRQ(ierr);
7110841954dSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -memory_view: print memory usage at end of run\n");CHKERRQ(ierr);
712e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
713e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -get_total_flops: total flops over all processors\n");CHKERRQ(ierr);
714185ae32fSMatthew G. Knepley     ierr = (*PetscHelpPrintf)(comm," -log_view [:filename:[format]]: logging objects and events\n");CHKERRQ(ierr);
715e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_trace [filename]: prints trace of all PETSc calls\n");CHKERRQ(ierr);
716e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
717495fc317SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -log_mpe: Also create logfile viewable through Jumpshot\n");CHKERRQ(ierr);
718e5c89e4eSSatish Balay #endif
7196cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info <optional filename>: print informative messages about the calculations\n");CHKERRQ(ierr);
720e5c89e4eSSatish Balay #endif
721e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -v: prints PETSc version number and release date\n");CHKERRQ(ierr);
722e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_file <file>: reads options from file\n");CHKERRQ(ierr);
723e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -petsc_sleep n: sleeps n seconds before running program\n");CHKERRQ(ierr);
724e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
725e5c89e4eSSatish Balay   }
726e5c89e4eSSatish Balay 
72774ba8654SBarry Smith #if defined(PETSC_HAVE_POPEN)
72874ba8654SBarry Smith   {
72974ba8654SBarry Smith   char machine[128];
730c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-popen_machine",machine,128,&flg1);CHKERRQ(ierr);
73174ba8654SBarry Smith   if (flg1) {
73274ba8654SBarry Smith     ierr = PetscPOpenSetMachine(machine);CHKERRQ(ierr);
73374ba8654SBarry Smith   }
73474ba8654SBarry Smith   }
73574ba8654SBarry Smith #endif
73674ba8654SBarry Smith 
737c5929fdfSBarry Smith   ierr = PetscOptionsGetReal(NULL,NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
738e5c89e4eSSatish Balay   if (flg1) {
739e5c89e4eSSatish Balay     ierr = PetscSleep(si);CHKERRQ(ierr);
740e5c89e4eSSatish Balay   }
741e5c89e4eSSatish Balay 
742c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-info_exclude",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
7432ea1be5dSBarry Smith   if (flg1) {
744e5c89e4eSSatish Balay     ierr = PetscStrstr(mname,"null",&f);CHKERRQ(ierr);
745e5c89e4eSSatish Balay     if (f) {
746ecd8bba6SJed Brown       ierr = PetscInfoDeactivateClass(0);CHKERRQ(ierr);
747e5c89e4eSSatish Balay     }
7482ea1be5dSBarry Smith   }
749827f890bSBarry Smith 
750fdc842d1SBarry Smith #if defined(PETSC_HAVE_VIENNACL)
751c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
752f14045dbSBarry Smith   if (!flg3) {
753c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-log_view",&flg3);CHKERRQ(ierr);
754f14045dbSBarry Smith   }
755c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-viennacl_synchronize",&flg3,NULL);CHKERRQ(ierr);
756f14045dbSBarry Smith   PetscViennaCLSynchronize = flg3;
757fdc842d1SBarry Smith   ierr = PetscViennaCLInit();CHKERRQ(ierr);
7584cf1874eSKarl Rupp #endif
75982f73ecaSAlejandro Lamas Daviña 
760fdc842d1SBarry Smith   /*
761fdc842d1SBarry Smith      Creates the logging data structures; this is enabled even if logging is not turned on
762fdc842d1SBarry Smith      This is the last thing we do before returning to the user code to prevent having the
763fdc842d1SBarry Smith      logging numbers contaminated by any startup time associated with MPI and the GPUs
764fdc842d1SBarry Smith   */
765fdc842d1SBarry Smith #if defined(PETSC_USE_LOG)
766fdc842d1SBarry Smith   ierr = PetscLogInitialize();CHKERRQ(ierr);
767f0a7718cSKarl Rupp #endif
768f0a7718cSKarl Rupp 
769e5c89e4eSSatish Balay   PetscFunctionReturn(0);
770e5c89e4eSSatish Balay }
771