xref: /petsc/src/sys/objects/init.c (revision 90ea27d85c8dcdde8fa966bec004607d0323175a)
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>
253bbda9c2SStefano Zampini PETSC_EXTERN PetscErrorCode PetscCUBLASInitializeHandle(void);
263bbda9c2SStefano Zampini PETSC_EXTERN PetscErrorCode PetscCUSOLVERDnInitializeHandle(void);
27d9b72601SDominic Meiser #endif
28555d055bSBarry Smith 
29f0a7718cSKarl Rupp #if defined(PETSC_HAVE_VIENNACL)
30f0a7718cSKarl Rupp PETSC_EXTERN PetscErrorCode PetscViennaCLInit();
31f0a7718cSKarl Rupp #endif
32f0a7718cSKarl Rupp 
33e5c89e4eSSatish Balay /* ------------------------Nasty global variables -------------------------------*/
34e5c89e4eSSatish Balay /*
35e5c89e4eSSatish Balay      Indicates if PETSc started up MPI, or it was
36e5c89e4eSSatish Balay    already started before PETSc was initialized.
37e5c89e4eSSatish Balay */
380cbf60d0SJose E. Roman PetscBool   PetscBeganMPI         = PETSC_FALSE;
390cbf60d0SJose E. Roman PetscBool   PetscInitializeCalled = PETSC_FALSE;
400cbf60d0SJose E. Roman PetscBool   PetscFinalizeCalled   = PETSC_FALSE;
41bffec52eSKarl Rupp PetscBool   PetscCUDAInitialized  = PETSC_FALSE;
42d6f2c3cbSBarry Smith 
437087cfbeSBarry Smith PetscMPIInt PetscGlobalRank       = -1;
447087cfbeSBarry Smith PetscMPIInt PetscGlobalSize       = -1;
45ba61063dSBarry Smith 
4650f81f78SJed Brown #if defined(PETSC_HAVE_COMPLEX)
47e5c89e4eSSatish Balay #if defined(PETSC_COMPLEX_INSTANTIATE)
48e5c89e4eSSatish Balay template <> class std::complex<double>; /* instantiate complex template class */
49e5c89e4eSSatish Balay #endif
502c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
51500d8756SSatish Balay MPI_Datatype MPIU_C_DOUBLE_COMPLEX;
52500d8756SSatish Balay MPI_Datatype MPIU_C_COMPLEX;
532c876bd9SBarry Smith #endif
548619c96cSJed Brown 
558619c96cSJed Brown /*MC
568619c96cSJed Brown    PETSC_i - the imaginary number i
578619c96cSJed Brown 
588619c96cSJed Brown    Synopsis:
598619c96cSJed Brown    #include <petscsys.h>
608619c96cSJed Brown    PetscComplex PETSC_i;
618619c96cSJed Brown 
628619c96cSJed Brown    Level: beginner
638619c96cSJed Brown 
648619c96cSJed Brown    Note:
658cd53115SBarry Smith    Complex numbers are automatically available if PETSc located a working complex implementation
668619c96cSJed Brown 
678619c96cSJed Brown .seealso: PetscRealPart(), PetscImaginaryPart(), PetscRealPartComplex(), PetscImaginaryPartComplex()
688619c96cSJed Brown M*/
6950f81f78SJed Brown PetscComplex PETSC_i;
70e5c89e4eSSatish Balay #endif
71ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
72c90a1750SBarry Smith MPI_Datatype MPIU___FLOAT128 = 0;
737c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
748c764dc5SJose Roman MPI_Datatype MPIU___COMPLEX128 = 0;
758c764dc5SJose Roman #endif
76570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
77570b7f6dSBarry Smith MPI_Datatype MPIU___FP16 = 0;
78c90a1750SBarry Smith #endif
797087cfbeSBarry Smith MPI_Datatype MPIU_2SCALAR = 0;
800354ff80SSatish Balay #if defined(PETSC_USE_64BIT_INDICES)
817087cfbeSBarry Smith MPI_Datatype MPIU_2INT = 0;
8244041f26SJed Brown #endif
838ad47952SJed Brown MPI_Datatype MPIU_BOOL;
848ad47952SJed Brown MPI_Datatype MPIU_ENUM;
857cdaf61dSJed Brown MPI_Datatype MPIU_FORTRANADDR;
86e316c87fSJed Brown MPI_Datatype MPIU_SIZE_T;
8775567043SBarry Smith 
88e5c89e4eSSatish Balay /*
89e5c89e4eSSatish Balay        Function that is called to display all error messages
90e5c89e4eSSatish Balay */
917087cfbeSBarry Smith PetscErrorCode (*PetscErrorPrintf)(const char [],...)          = PetscErrorPrintfDefault;
927087cfbeSBarry Smith PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char [],...)  = PetscHelpPrintfDefault;
937087cfbeSBarry Smith PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list)    = PetscVFPrintfDefault;
94bab1f7e6SVictor Minden /*
954cf1874eSKarl Rupp   This is needed to turn on/off GPU synchronization
968b5db460SBarry Smith */
974cf1874eSKarl Rupp PetscBool PetscViennaCLSynchronize = PETSC_FALSE;
9882f73ecaSAlejandro Lamas Daviña PetscBool PetscCUDASynchronize = PETSC_FALSE;
99bab1f7e6SVictor Minden 
100e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
101e5c89e4eSSatish Balay /*
102e5c89e4eSSatish Balay    Optional file where all PETSc output from various prints is saved
103e5c89e4eSSatish Balay */
10495c0884eSLisandro Dalcin PETSC_INTERN FILE *petsc_history;
1050298fd71SBarry Smith FILE *petsc_history = NULL;
106e5c89e4eSSatish Balay 
1077087cfbeSBarry Smith PetscErrorCode  PetscOpenHistoryFile(const char filename[],FILE **fd)
108e5c89e4eSSatish Balay {
109e5c89e4eSSatish Balay   PetscErrorCode ierr;
110e5c89e4eSSatish Balay   PetscMPIInt    rank,size;
111e5c89e4eSSatish Balay   char           pfile[PETSC_MAX_PATH_LEN],pname[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN],date[64];
112e5c89e4eSSatish Balay   char           version[256];
113e5c89e4eSSatish Balay 
114e5c89e4eSSatish Balay   PetscFunctionBegin;
115e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
116e5c89e4eSSatish Balay   if (!rank) {
117e5c89e4eSSatish Balay     char        arch[10];
118f56c2debSBarry Smith     int         err;
119f56c2debSBarry Smith 
120e5c89e4eSSatish Balay     ierr = PetscGetArchType(arch,10);CHKERRQ(ierr);
121e5c89e4eSSatish Balay     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
122a523d312SBarry Smith     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
123e5c89e4eSSatish Balay     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
124e5c89e4eSSatish Balay     if (filename) {
125e5c89e4eSSatish Balay       ierr = PetscFixFilename(filename,fname);CHKERRQ(ierr);
126e5c89e4eSSatish Balay     } else {
127e5c89e4eSSatish Balay       ierr = PetscGetHomeDirectory(pfile,240);CHKERRQ(ierr);
128e5c89e4eSSatish Balay       ierr = PetscStrcat(pfile,"/.petschistory");CHKERRQ(ierr);
129e5c89e4eSSatish Balay       ierr = PetscFixFilename(pfile,fname);CHKERRQ(ierr);
130e5c89e4eSSatish Balay     }
131e5c89e4eSSatish Balay 
132a297a907SKarl Rupp     *fd = fopen(fname,"a");
133a297a907SKarl Rupp     if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file: %s",fname);
134a297a907SKarl Rupp 
135e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
136e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s %s\n",version,date);CHKERRQ(ierr);
137e5c89e4eSSatish Balay     ierr = PetscGetProgramName(pname,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
138e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s on a %s, %d proc. with options:\n",pname,arch,size);CHKERRQ(ierr);
139e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
140a297a907SKarl Rupp 
141f56c2debSBarry Smith     err = fflush(*fd);
142e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
143e5c89e4eSSatish Balay   }
144e5c89e4eSSatish Balay   PetscFunctionReturn(0);
145e5c89e4eSSatish Balay }
146e5c89e4eSSatish Balay 
14795c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE **fd)
148e5c89e4eSSatish Balay {
149e5c89e4eSSatish Balay   PetscErrorCode ierr;
150e5c89e4eSSatish Balay   PetscMPIInt    rank;
151e5c89e4eSSatish Balay   char           date[64];
152f56c2debSBarry Smith   int            err;
153e5c89e4eSSatish Balay 
154e5c89e4eSSatish Balay   PetscFunctionBegin;
155e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
156e5c89e4eSSatish Balay   if (!rank) {
157e5c89e4eSSatish Balay     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
158e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
159e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"Finished at %s\n",date);CHKERRQ(ierr);
160e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
161f56c2debSBarry Smith     err  = fflush(*fd);
162e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
163f56c2debSBarry Smith     err = fclose(*fd);
164e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
165e5c89e4eSSatish Balay   }
166e5c89e4eSSatish Balay   PetscFunctionReturn(0);
167e5c89e4eSSatish Balay }
168e5c89e4eSSatish Balay 
169e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
170e5c89e4eSSatish Balay 
171e5c89e4eSSatish Balay /*
172e5c89e4eSSatish Balay    This is ugly and probably belongs somewhere else, but I want to
173e5c89e4eSSatish Balay   be able to put a true MPI abort error handler with command line args.
174e5c89e4eSSatish Balay 
175e5c89e4eSSatish Balay     This is so MPI errors in the debugger will leave all the stack
1763c311c98SBarry Smith   frames. The default MP_Abort() cleans up and exits thus providing no useful information
1773c311c98SBarry Smith   in the debugger hence we call abort() instead of MPI_Abort().
178e5c89e4eSSatish Balay */
179e5c89e4eSSatish Balay 
18033c7d699SBarry Smith void Petsc_MPI_AbortOnError(MPI_Comm *comm,PetscMPIInt *flag,...)
181e5c89e4eSSatish Balay {
182e5c89e4eSSatish Balay   PetscFunctionBegin;
1833c311c98SBarry Smith   (*PetscErrorPrintf)("MPI error %d\n",*flag);
184e5c89e4eSSatish Balay   abort();
185e5c89e4eSSatish Balay }
186e5c89e4eSSatish Balay 
18733c7d699SBarry Smith void Petsc_MPI_DebuggerOnError(MPI_Comm *comm,PetscMPIInt *flag,...)
188e5c89e4eSSatish Balay {
189e5c89e4eSSatish Balay   PetscErrorCode ierr;
190e5c89e4eSSatish Balay 
191e5c89e4eSSatish Balay   PetscFunctionBegin;
1923c311c98SBarry Smith   (*PetscErrorPrintf)("MPI error %d\n",*flag);
193e5c89e4eSSatish Balay   ierr = PetscAttachDebugger();
194a297a907SKarl Rupp   if (ierr) MPI_Abort(*comm,*flag); /* hopeless so get out */
195e5c89e4eSSatish Balay }
196e5c89e4eSSatish Balay 
1977381773fSBarry Smith #if defined(PETSC_HAVE_CUDA)
1987381773fSBarry Smith /*@C
1997381773fSBarry Smith      PetscCUDAInitialize - Initializes the CUDA device and cuBLAS on the device
2007381773fSBarry Smith 
2017381773fSBarry Smith      Logically collective
2027381773fSBarry Smith 
2037381773fSBarry Smith   Input Parameter:
2047381773fSBarry Smith   comm - the MPI communicator that will utilize the CUDA devices
2057381773fSBarry Smith 
2067381773fSBarry Smith   Options Database:
2079d90e779SBarry Smith +  -cuda_initialize <default yes,no> - do the initialization in PetscInitialize(). If -cuda_initialize no is used then the default initialization is done automatically
2089d90e779SBarry Smith                                when the first CUDA call is made unless you call PetscCUDAInitialize() before any CUDA operations are performed
2097381773fSBarry Smith .  -cuda_view - view information about the CUDA devices
2107381773fSBarry 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
2117381773fSBarry Smith -  -cuda_set_device <gpu> - integer number of the device
2127381773fSBarry Smith 
213*90ea27d8SSatish Balay   Level: beginner
214*90ea27d8SSatish Balay 
2157381773fSBarry Smith   Notes:
2167381773fSBarry Smith    Initializing cuBLAS takes about 1/2 second there it is done by default in PetscInitialize() before logging begins
2177381773fSBarry Smith 
2187381773fSBarry Smith @*/
2197381773fSBarry Smith PetscErrorCode PetscCUDAInitialize(MPI_Comm comm)
2207381773fSBarry Smith {
2217381773fSBarry Smith   PetscErrorCode        ierr;
2227381773fSBarry Smith   PetscInt              deviceOpt = 0;
2237381773fSBarry Smith   PetscBool             cuda_view_flag = PETSC_FALSE,flg;
2247381773fSBarry Smith   struct cudaDeviceProp prop;
2257381773fSBarry Smith   int                   devCount,device,devicecnt;
2267381773fSBarry Smith   cudaError_t           err = cudaSuccess;
2277381773fSBarry Smith   PetscMPIInt           rank,size;
2287381773fSBarry Smith 
2297381773fSBarry Smith   PetscFunctionBegin;
2307381773fSBarry Smith   /*
2317381773fSBarry Smith      If collecting logging information, by default, wait for GPU to complete its operations
2327381773fSBarry Smith      before returning to the CPU in order to get accurate timings of each event
2337381773fSBarry Smith   */
2347381773fSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&PetscCUDASynchronize);CHKERRQ(ierr);
2357381773fSBarry Smith   if (!PetscCUDASynchronize) {
2367381773fSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-log_view",&PetscCUDASynchronize);CHKERRQ(ierr);
2377381773fSBarry Smith   }
2387381773fSBarry Smith 
2397381773fSBarry Smith   ierr = PetscOptionsBegin(comm,NULL,"CUDA options","Sys");CHKERRQ(ierr);
2407381773fSBarry Smith   ierr = PetscOptionsInt("-cuda_set_device","Set all MPI ranks to use the specified CUDA device",NULL,deviceOpt,&deviceOpt,&flg);CHKERRQ(ierr);
2417381773fSBarry Smith   device = (int)deviceOpt;
2427381773fSBarry Smith   ierr = PetscOptionsBool("-cuda_synchronize","Wait for the GPU to complete operations before returning to the CPU",NULL,PetscCUDASynchronize,&PetscCUDASynchronize,NULL);CHKERRQ(ierr);
2437381773fSBarry Smith   ierr = PetscOptionsDeprecated("-cuda_show_devices","-cuda_view","3.12",NULL);CHKERRQ(ierr);
2447381773fSBarry Smith   ierr = PetscOptionsName("-cuda_view","Display CUDA device information and assignments",NULL,&cuda_view_flag);CHKERRQ(ierr);
2457381773fSBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
2467381773fSBarry Smith   if (!PetscCUDAInitialized) {
2477381773fSBarry Smith     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
2487381773fSBarry Smith 
2497381773fSBarry Smith     if (size>1 && !flg) {
2507381773fSBarry Smith       /* check to see if we force multiple ranks to hit the same GPU */
2517381773fSBarry Smith       /* we're not using the same GPU on multiple MPI threads. So try to allocated different   GPUs to different processes */
2527381773fSBarry Smith 
2537381773fSBarry Smith       /* First get the device count */
2547381773fSBarry Smith       err   = cudaGetDeviceCount(&devCount);
2557381773fSBarry Smith       if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
2567381773fSBarry Smith 
2577381773fSBarry Smith       /* next determine the rank and then set the device via a mod */
2587381773fSBarry Smith       ierr   = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2597381773fSBarry Smith       device = rank % devCount;
2607381773fSBarry Smith     }
2617381773fSBarry Smith     err = cudaSetDevice(device);
2627381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
2637381773fSBarry Smith 
2647381773fSBarry Smith     /* set the device flags so that it can map host memory */
2657381773fSBarry Smith     err = cudaSetDeviceFlags(cudaDeviceMapHost);
2667381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDeviceFlags %s",cudaGetErrorString(err));
2677381773fSBarry Smith 
2687381773fSBarry Smith     ierr = PetscCUBLASInitializeHandle();CHKERRQ(ierr);
2693bbda9c2SStefano Zampini     ierr = PetscCUSOLVERDnInitializeHandle();CHKERRQ(ierr);
2707381773fSBarry Smith     PetscCUDAInitialized = PETSC_TRUE;
2717381773fSBarry Smith   }
2727381773fSBarry Smith   if (cuda_view_flag) {
2737381773fSBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2747381773fSBarry Smith     err  = cudaGetDeviceCount(&devCount);
2757381773fSBarry Smith     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
2767381773fSBarry Smith     for (devicecnt = 0; devicecnt < devCount; ++devicecnt) {
2777381773fSBarry Smith       err = cudaGetDeviceProperties(&prop,devicecnt);
2787381773fSBarry Smith       if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceProperties %s",cudaGetErrorString(err));
2797381773fSBarry Smith       ierr = PetscPrintf(comm, "CUDA device %d: %s\n", devicecnt, prop.name);CHKERRQ(ierr);
2807381773fSBarry Smith     }
2817381773fSBarry Smith     ierr = PetscSynchronizedPrintf(comm,"[%d] Using CUDA device %d.\n",rank,device);CHKERRQ(ierr);
2827381773fSBarry Smith     ierr = PetscSynchronizedFlush(comm,PETSC_STDOUT);CHKERRQ(ierr);
2837381773fSBarry Smith   }
2847381773fSBarry Smith   PetscFunctionReturn(0);
2857381773fSBarry Smith }
2867381773fSBarry Smith #endif
2877381773fSBarry Smith 
288e5c89e4eSSatish Balay /*@C
289e5c89e4eSSatish Balay    PetscEnd - Calls PetscFinalize() and then ends the program. This is useful if one
290e5c89e4eSSatish Balay      wishes a clean exit somewhere deep in the program.
291e5c89e4eSSatish Balay 
292e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
293e5c89e4eSSatish Balay 
294e5c89e4eSSatish Balay    Options Database Keys are the same as for PetscFinalize()
295e5c89e4eSSatish Balay 
296e5c89e4eSSatish Balay    Level: advanced
297e5c89e4eSSatish Balay 
298e5c89e4eSSatish Balay    Note:
299e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
300e5c89e4eSSatish Balay 
30188c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscFinalize()
302e5c89e4eSSatish Balay @*/
3037087cfbeSBarry Smith PetscErrorCode  PetscEnd(void)
304e5c89e4eSSatish Balay {
305e5c89e4eSSatish Balay   PetscFunctionBegin;
306e5c89e4eSSatish Balay   PetscFinalize();
307e5c89e4eSSatish Balay   exit(0);
308e5c89e4eSSatish Balay   return 0;
309e5c89e4eSSatish Balay }
310e5c89e4eSSatish Balay 
311ace3abfcSBarry Smith PetscBool PetscOptionsPublish = PETSC_FALSE;
31295c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSetUseHBWMalloc_Private(void);
31395c0884eSLisandro Dalcin PETSC_INTERN PetscBool      petscsetmallocvisited;
314e5c89e4eSSatish Balay static       char           emacsmachinename[256];
315e5c89e4eSSatish Balay 
316e5c89e4eSSatish Balay PetscErrorCode (*PetscExternalVersionFunction)(MPI_Comm) = 0;
317e5c89e4eSSatish Balay PetscErrorCode (*PetscExternalHelpFunction)(MPI_Comm)    = 0;
318e5c89e4eSSatish Balay 
319e5c89e4eSSatish Balay /*@C
320e5c89e4eSSatish Balay    PetscSetHelpVersionFunctions - Sets functions that print help and version information
321e5c89e4eSSatish Balay    before the PETSc help and version information is printed. Must call BEFORE PetscInitialize().
322e5c89e4eSSatish Balay    This routine enables a "higher-level" package that uses PETSc to print its messages first.
323e5c89e4eSSatish Balay 
324e5c89e4eSSatish Balay    Input Parameter:
3250298fd71SBarry Smith +  help - the help function (may be NULL)
3260298fd71SBarry Smith -  version - the version function (may be NULL)
327e5c89e4eSSatish Balay 
328e5c89e4eSSatish Balay    Level: developer
329e5c89e4eSSatish Balay 
330e5c89e4eSSatish Balay @*/
3317087cfbeSBarry Smith PetscErrorCode  PetscSetHelpVersionFunctions(PetscErrorCode (*help)(MPI_Comm),PetscErrorCode (*version)(MPI_Comm))
332e5c89e4eSSatish Balay {
333e5c89e4eSSatish Balay   PetscFunctionBegin;
334e5c89e4eSSatish Balay   PetscExternalHelpFunction    = help;
335e5c89e4eSSatish Balay   PetscExternalVersionFunction = version;
336e5c89e4eSSatish Balay   PetscFunctionReturn(0);
337e5c89e4eSSatish Balay }
338e5c89e4eSSatish Balay 
33905df10baSBarry Smith #if defined(PETSC_USE_LOG)
34095c0884eSLisandro Dalcin PETSC_INTERN PetscBool   PetscObjectsLog;
34105df10baSBarry Smith #endif
34205df10baSBarry Smith 
34395c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode  PetscOptionsCheckInitial_Private(void)
344e5c89e4eSSatish Balay {
345e5c89e4eSSatish Balay   char              string[64],mname[PETSC_MAX_PATH_LEN],*f;
346e5c89e4eSSatish Balay   MPI_Comm          comm = PETSC_COMM_WORLD;
34767584ceeSBarry Smith   PetscBool         flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,flag;
348e5c89e4eSSatish Balay   PetscErrorCode    ierr;
34967584ceeSBarry Smith   PetscReal         si;
35028559dc8SJed Brown   PetscInt          intensity;
351e5c89e4eSSatish Balay   int               i;
352e5c89e4eSSatish Balay   PetscMPIInt       rank;
3537ca660e7SBarry Smith   char              version[256],helpoptions[256];
3542479a3a6SBarry Smith #if defined(PETSC_USE_LOG)
3552479a3a6SBarry Smith   PetscViewerFormat format;
35667584ceeSBarry Smith   PetscBool         flg4 = PETSC_FALSE;
35767584ceeSBarry Smith #endif
358012f15ecSRichard Tran Mills #if defined(PETSC_HAVE_CUDA)
3597381773fSBarry Smith   PetscBool         initCuda = PETSC_TRUE;
360012f15ecSRichard Tran Mills #endif
3617381773fSBarry Smith 
362e5c89e4eSSatish Balay   PetscFunctionBegin;
36342218b76SBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
364e5c89e4eSSatish Balay 
36567584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
36692f119d6SBarry Smith   if (!(PETSC_RUNNING_ON_VALGRIND)) {
367e5c89e4eSSatish Balay     /*
368e5c89e4eSSatish Balay       Setup the memory management; support for tracing malloc() usage
369e5c89e4eSSatish Balay     */
370244bdbccSBarry Smith     PetscBool         mdebug = PETSC_FALSE, eachcall = PETSC_FALSE, initializenan = PETSC_FALSE, mlog = PETSC_FALSE;
37192f119d6SBarry Smith 
3728bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
37392f119d6SBarry Smith     mdebug        = PETSC_TRUE;
37492f119d6SBarry Smith     initializenan = PETSC_TRUE;
37592f119d6SBarry Smith     ierr   = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
376e5c89e4eSSatish Balay #else
37792f119d6SBarry Smith     /* don't warn about unused option */
37892f119d6SBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
37992f119d6SBarry Smith     flg1 = PETSC_FALSE;
380e5c89e4eSSatish Balay #endif
38179dccf82SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg2,&flg3);CHKERRQ(ierr);
38292f119d6SBarry Smith     if (flg1 || flg2) {
38392f119d6SBarry Smith       mdebug        = PETSC_TRUE;
38492f119d6SBarry Smith       eachcall      = PETSC_TRUE;
38592f119d6SBarry Smith       initializenan = PETSC_TRUE;
38679dccf82SBarry Smith     } else if (flg3 && !flg2) {
38779dccf82SBarry Smith       mdebug        = PETSC_FALSE;
38879dccf82SBarry Smith       eachcall      = PETSC_FALSE;
38979dccf82SBarry Smith       initializenan = PETSC_FALSE;
390e5c89e4eSSatish Balay     }
39192f119d6SBarry Smith 
39292f119d6SBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_view",&mlog);CHKERRQ(ierr);
39392f119d6SBarry Smith     if (mlog) {
39492f119d6SBarry Smith       mdebug = PETSC_TRUE;
39592f119d6SBarry Smith     }
39679dccf82SBarry Smith     /* the next line is deprecated */
39792f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc",&mdebug,NULL);CHKERRQ(ierr);
39892f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_dump",&mdebug,NULL);CHKERRQ(ierr);
39992f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-log_view_memory",&mdebug,NULL);CHKERRQ(ierr);
40092f119d6SBarry Smith     if (mdebug) {
40192f119d6SBarry Smith       ierr = PetscMallocSetDebug(eachcall,initializenan);CHKERRQ(ierr);
40292f119d6SBarry Smith     }
40392f119d6SBarry Smith     if (mlog) {
40492f119d6SBarry Smith       PetscReal logthreshold = 0;
40592f119d6SBarry Smith       ierr = PetscOptionsGetReal(NULL,NULL,"-malloc_view_threshold",&logthreshold,NULL);CHKERRQ(ierr);
40692f119d6SBarry Smith       ierr = PetscMallocViewSet(logthreshold);CHKERRQ(ierr);
40792f119d6SBarry Smith     }
40892f119d6SBarry Smith   }
40992f119d6SBarry Smith 
410ba282f50SJed Brown   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_coalesce",&flg1,&flg2);CHKERRQ(ierr);
411ba282f50SJed Brown   if (flg2) {ierr = PetscMallocSetCoalesce(flg1);CHKERRQ(ierr);}
41290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
4132f21b5c6SHong Zhang   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_hbw",&flg1,NULL);CHKERRQ(ierr);
414cf6f3811SHong Zhang   /* ignore this option if malloc is already set */
415cf6f3811SHong Zhang   if (flg1 && !petscsetmallocvisited) {ierr = PetscSetUseHBWMalloc_Private();CHKERRQ(ierr);}
416e5c89e4eSSatish Balay 
41790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
418c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg1,NULL);CHKERRQ(ierr);
4197783f70dSSatish Balay   if (!flg1) {
42090d69ab7SBarry Smith     flg1 = PETSC_FALSE;
421c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg1,NULL);CHKERRQ(ierr);
4227783f70dSSatish Balay   }
423e5c89e4eSSatish Balay   if (flg1) {
424e5c89e4eSSatish Balay     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
425e5c89e4eSSatish Balay   }
42667584ceeSBarry Smith #endif
427e5c89e4eSSatish Balay 
428b4427426SBarry Smith #if defined(PETSC_USE_LOG)
429c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&PetscObjectsLog);CHKERRQ(ierr);
430b4427426SBarry Smith #endif
43105df10baSBarry Smith 
432e5c89e4eSSatish Balay   /*
433e5c89e4eSSatish Balay       Set the display variable for graphics
434e5c89e4eSSatish Balay   */
435e5c89e4eSSatish Balay   ierr = PetscSetDisplay();CHKERRQ(ierr);
436e5c89e4eSSatish Balay 
43751dcc849SKerry Stevens   /*
438e5c89e4eSSatish Balay       Print the PETSc version information
439e5c89e4eSSatish Balay   */
440c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-v",&flg1);CHKERRQ(ierr);
441c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-version",&flg2);CHKERRQ(ierr);
4422d747510SLisandro Dalcin   ierr = PetscOptionsHasHelp(NULL,&flg3);CHKERRQ(ierr);
443e5c89e4eSSatish Balay   if (flg1 || flg2 || flg3) {
444e5c89e4eSSatish Balay 
445e5c89e4eSSatish Balay     /*
446e5c89e4eSSatish Balay        Print "higher-level" package version message
447e5c89e4eSSatish Balay     */
448e5c89e4eSSatish Balay     if (PetscExternalVersionFunction) {
449e5c89e4eSSatish Balay       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
450e5c89e4eSSatish Balay     }
451e5c89e4eSSatish Balay 
452a523d312SBarry Smith     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
4537ca660e7SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------------------------------------\n");CHKERRQ(ierr);
454e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
455e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
456e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
45784e42920SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"See docs/faq.html for problems.\n");CHKERRQ(ierr);
458e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
459e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
4607ca660e7SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------------------------------------\n");CHKERRQ(ierr);
4617ca660e7SBarry Smith   }
4627ca660e7SBarry Smith 
46394941ca7SBarry Smith   /*
46494941ca7SBarry Smith        Print "higher-level" package help message
46594941ca7SBarry Smith   */
46694941ca7SBarry Smith   if (flg3) {
46794941ca7SBarry Smith     if (PetscExternalHelpFunction) {
46894941ca7SBarry Smith       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
46994941ca7SBarry Smith     }
47094941ca7SBarry Smith   }
47194941ca7SBarry Smith 
4727ca660e7SBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-help",helpoptions,sizeof(helpoptions),&flg1);CHKERRQ(ierr);
4737ca660e7SBarry Smith   if (flg1) {
4747ca660e7SBarry Smith     ierr = PetscStrcmp(helpoptions,"intro",&flg2);CHKERRQ(ierr);
4757ca660e7SBarry Smith     if (flg2) {
476bdb346e9SBarry Smith       ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
477008a6e76SBarry Smith       ierr = PetscFreeMPIResources();CHKERRQ(ierr);
4787ca660e7SBarry Smith       ierr = MPI_Finalize();CHKERRQ(ierr);
4797ca660e7SBarry Smith       exit(0);
4807ca660e7SBarry Smith     }
481e5c89e4eSSatish Balay   }
482e5c89e4eSSatish Balay 
483e5c89e4eSSatish Balay   /*
484e5c89e4eSSatish Balay       Setup the error handling
485e5c89e4eSSatish Balay   */
48690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
487c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_abort",&flg1,NULL);CHKERRQ(ierr);
488b59baad1SJed Brown   if (flg1) {
48942218b76SBarry Smith     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_ARE_FATAL);CHKERRQ(ierr);
490b59baad1SJed Brown     ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
491b59baad1SJed Brown   }
49290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
493c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_mpiabort",&flg1,NULL);CHKERRQ(ierr);
494cb9801acSJed Brown   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,0);CHKERRQ(ierr);}
49590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
496c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpi_return_on_error",&flg1,NULL);CHKERRQ(ierr);
497e5c89e4eSSatish Balay   if (flg1) {
498d54338ecSKarl Rupp     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_RETURN);CHKERRQ(ierr);
499e5c89e4eSSatish Balay   }
50090d69ab7SBarry Smith   flg1 = PETSC_FALSE;
501c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
5028d359177SBarry Smith   if (!flg1) {ierr = PetscPushSignalHandler(PetscSignalHandlerDefault,(void*)0);CHKERRQ(ierr);}
50396cc47afSJed Brown   flg1 = PETSC_FALSE;
504a9acdec7SBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-fp_trap",&flg1,&flag);CHKERRQ(ierr);
505a9acdec7SBarry Smith   if (flag) {ierr = PetscSetFPTrap((PetscFPTrap)flg1);CHKERRQ(ierr);}
506c5929fdfSBarry Smith   ierr = PetscOptionsGetInt(NULL,NULL,"-check_pointer_intensity",&intensity,&flag);CHKERRQ(ierr);
50728559dc8SJed Brown   if (flag) {ierr = PetscCheckPointerSetIntensity(intensity);CHKERRQ(ierr);}
508e5c89e4eSSatish Balay 
509e5c89e4eSSatish Balay   /*
510e5c89e4eSSatish Balay       Setup debugger information
511e5c89e4eSSatish Balay   */
512e5c89e4eSSatish Balay   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
513c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_attach_debugger",string,64,&flg1);CHKERRQ(ierr);
514e5c89e4eSSatish Balay   if (flg1) {
515e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
516e5c89e4eSSatish Balay 
517e5c89e4eSSatish Balay     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
51833c7d699SBarry Smith     ierr = MPI_Comm_create_errhandler(Petsc_MPI_DebuggerOnError,&err_handler);CHKERRQ(ierr);
519d54338ecSKarl Rupp     ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
520e5c89e4eSSatish Balay     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,0);CHKERRQ(ierr);
521e5c89e4eSSatish Balay   }
522c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-debug_terminal",string,64,&flg1);CHKERRQ(ierr);
5235e96ac45SJed Brown   if (flg1) { ierr = PetscSetDebugTerminal(string);CHKERRQ(ierr); }
524c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-start_in_debugger",string,64,&flg1);CHKERRQ(ierr);
525c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-stop_for_debugger",string,64,&flg2);CHKERRQ(ierr);
526e5c89e4eSSatish Balay   if (flg1 || flg2) {
527e5c89e4eSSatish Balay     PetscMPIInt    size;
528e5c89e4eSSatish Balay     PetscInt       lsize,*nodes;
529e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
530e5c89e4eSSatish Balay     /*
531e5c89e4eSSatish Balay        we have to make sure that all processors have opened
532e5c89e4eSSatish Balay        connections to all other processors, otherwise once the
533e5c89e4eSSatish Balay        debugger has stated it is likely to receive a SIGUSR1
534e5c89e4eSSatish Balay        and kill the program.
535e5c89e4eSSatish Balay     */
53642218b76SBarry Smith     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
537e5c89e4eSSatish Balay     if (size > 2) {
538533163c2SBarry Smith       PetscMPIInt dummy = 0;
539e5c89e4eSSatish Balay       MPI_Status  status;
540e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
541e5c89e4eSSatish Balay         if (rank != i) {
54242218b76SBarry Smith           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,comm);CHKERRQ(ierr);
543e5c89e4eSSatish Balay         }
544e5c89e4eSSatish Balay       }
545e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
546e5c89e4eSSatish Balay         if (rank != i) {
54742218b76SBarry Smith           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,comm,&status);CHKERRQ(ierr);
548e5c89e4eSSatish Balay         }
549e5c89e4eSSatish Balay       }
550e5c89e4eSSatish Balay     }
551e5c89e4eSSatish Balay     /* check if this processor node should be in debugger */
552785e854fSJed Brown     ierr  = PetscMalloc1(size,&nodes);CHKERRQ(ierr);
553e5c89e4eSSatish Balay     lsize = size;
554c5929fdfSBarry Smith     ierr  = PetscOptionsGetIntArray(NULL,NULL,"-debugger_nodes",nodes,&lsize,&flag);CHKERRQ(ierr);
555e5c89e4eSSatish Balay     if (flag) {
556e5c89e4eSSatish Balay       for (i=0; i<lsize; i++) {
557e5c89e4eSSatish Balay         if (nodes[i] == rank) { flag = PETSC_FALSE; break; }
558e5c89e4eSSatish Balay       }
559e5c89e4eSSatish Balay     }
560e5c89e4eSSatish Balay     if (!flag) {
561e5c89e4eSSatish Balay       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
562e5c89e4eSSatish Balay       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
563e5c89e4eSSatish Balay       if (flg1) {
564e5c89e4eSSatish Balay         ierr = PetscAttachDebugger();CHKERRQ(ierr);
565e5c89e4eSSatish Balay       } else {
566e5c89e4eSSatish Balay         ierr = PetscStopForDebugger();CHKERRQ(ierr);
567e5c89e4eSSatish Balay       }
56833c7d699SBarry Smith       ierr = MPI_Comm_create_errhandler(Petsc_MPI_AbortOnError,&err_handler);CHKERRQ(ierr);
569d54338ecSKarl Rupp       ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
570e5c89e4eSSatish Balay     }
571e5c89e4eSSatish Balay     ierr = PetscFree(nodes);CHKERRQ(ierr);
572e5c89e4eSSatish Balay   }
573e5c89e4eSSatish Balay 
574c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_emacs",emacsmachinename,128,&flg1);CHKERRQ(ierr);
575cb9801acSJed Brown   if (flg1 && !rank) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr);}
576e5c89e4eSSatish Balay 
577e5c89e4eSSatish Balay   /*
578e5c89e4eSSatish Balay         Setup profiling and logging
579e5c89e4eSSatish Balay   */
5806cf91177SBarry Smith #if defined(PETSC_USE_INFO)
5818bb29257SSatish Balay   {
582e5c89e4eSSatish Balay     char logname[PETSC_MAX_PATH_LEN]; logname[0] = 0;
583c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-info",logname,250,&flg1);CHKERRQ(ierr);
5848bb29257SSatish Balay     if (flg1 && logname[0]) {
585fcc2139eSBarry Smith       ierr = PetscInfoAllow(PETSC_TRUE,logname);CHKERRQ(ierr);
5868bb29257SSatish Balay     } else if (flg1) {
5870298fd71SBarry Smith       ierr = PetscInfoAllow(PETSC_TRUE,NULL);CHKERRQ(ierr);
588e5c89e4eSSatish Balay     }
589e5c89e4eSSatish Balay   }
590865f6aa8SSatish Balay #endif
591865f6aa8SSatish Balay #if defined(PETSC_USE_LOG)
592865f6aa8SSatish Balay   mname[0] = 0;
593c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-history",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
594865f6aa8SSatish Balay   if (flg1) {
595865f6aa8SSatish Balay     if (mname[0]) {
596f3dea69dSBarry Smith       ierr = PetscOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
597865f6aa8SSatish Balay     } else {
598706d7a88SBarry Smith       ierr = PetscOpenHistoryFile(NULL,&petsc_history);CHKERRQ(ierr);
599865f6aa8SSatish Balay     }
600865f6aa8SSatish Balay   }
601217044c2SLisandro Dalcin 
602217044c2SLisandro Dalcin   ierr = PetscOptionsGetBool(NULL,NULL,"-log_sync",&PetscLogSyncOn,NULL);CHKERRQ(ierr);
603217044c2SLisandro Dalcin 
604e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
60590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
606c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
607495fc317SBarry Smith   if (flg1) {ierr = PetscLogMPEBegin();CHKERRQ(ierr);}
608e5c89e4eSSatish Balay #endif
60990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
61090d69ab7SBarry Smith   flg3 = PETSC_FALSE;
611c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-log_all",&flg1,NULL);CHKERRQ(ierr);
612c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
613e5c89e4eSSatish Balay   if (flg1)                      { ierr = PetscLogAllBegin();CHKERRQ(ierr); }
614bb1d7374SBarry Smith   else if (flg3)                 { ierr = PetscLogDefaultBegin();CHKERRQ(ierr);}
615e5c89e4eSSatish Balay 
616c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_trace",mname,250,&flg1);CHKERRQ(ierr);
617e5c89e4eSSatish Balay   if (flg1) {
618e5c89e4eSSatish Balay     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
619e5c89e4eSSatish Balay     FILE *file;
620e5c89e4eSSatish Balay     if (mname[0]) {
6212e924ca5SSatish Balay       PetscSNPrintf(name,PETSC_MAX_PATH_LEN,"%s.%d",mname,rank);
622e5c89e4eSSatish Balay       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
623e5c89e4eSSatish Balay       file = fopen(fname,"w");
624f3dea69dSBarry Smith       if (!file) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
625a297a907SKarl Rupp     } else file = PETSC_STDOUT;
626e5c89e4eSSatish Balay     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
627e5c89e4eSSatish Balay   }
628bb1d7374SBarry Smith 
62916413a6aSBarry Smith   ierr = PetscOptionsGetViewer(comm,NULL,NULL,"-log_view",NULL,&format,&flg4);CHKERRQ(ierr);
630bb1d7374SBarry Smith   if (flg4) {
631bb1d7374SBarry Smith     if (format == PETSC_VIEWER_ASCII_XML) {
632bb1d7374SBarry Smith       ierr = PetscLogNestedBegin();CHKERRQ(ierr);
633bb1d7374SBarry Smith     } else {
634bb1d7374SBarry Smith       ierr = PetscLogDefaultBegin();CHKERRQ(ierr);
635bb1d7374SBarry Smith     }
636eccbb886SLisandro Dalcin   }
637eccbb886SLisandro Dalcin   if (flg4 && format == PETSC_VIEWER_ASCII_XML) {
638eccbb886SLisandro Dalcin     PetscReal threshold = PetscRealConstant(0.01);
639eccbb886SLisandro Dalcin     ierr = PetscOptionsGetReal(NULL,NULL,"-log_threshold",&threshold,&flg1);CHKERRQ(ierr);
640eccbb886SLisandro Dalcin     if (flg1) {ierr = PetscLogSetThreshold((PetscLogDouble)threshold,NULL);CHKERRQ(ierr);}
641bb1d7374SBarry Smith   }
642e5c89e4eSSatish Balay #endif
643e5c89e4eSSatish Balay 
644c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saws_options",&PetscOptionsPublish,NULL);CHKERRQ(ierr);
645e5c89e4eSSatish Balay 
6464b0a73b2SBarry Smith #if defined(PETSC_HAVE_CUDA)
6477381773fSBarry Smith   ierr = PetscOptionsBegin(comm,NULL,"CUDA initialize","Sys");CHKERRQ(ierr);
6487381773fSBarry Smith   ierr = PetscOptionsBool("-cuda_initialize","Initialize the CUDA devices and cuBLAS during PetscInitialize()",NULL,initCuda,&initCuda,NULL);CHKERRQ(ierr);
649012f15ecSRichard Tran Mills   ierr = PetscOptionsEnd();CHKERRQ(ierr);
6507381773fSBarry Smith   if (initCuda) {ierr = PetscCUDAInitialize(PETSC_COMM_WORLD);CHKERRQ(ierr);}
6514b0a73b2SBarry Smith #endif
6524b0a73b2SBarry Smith 
653e5c89e4eSSatish Balay   /*
654e5c89e4eSSatish Balay        Print basic help message
655e5c89e4eSSatish Balay   */
6562d747510SLisandro Dalcin   ierr = PetscOptionsHasHelp(NULL,&flg1);CHKERRQ(ierr);
657e5c89e4eSSatish Balay   if (flg1) {
658e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Options for all PETSc programs:\n");CHKERRQ(ierr);
659301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -help: prints help method for each option\n");CHKERRQ(ierr);
660301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -on_error_abort: cause an abort when an error is detected. Useful \n ");CHKERRQ(ierr);
661301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm,"       only when run in the debugger\n");CHKERRQ(ierr);
662e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
663e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start the debugger in new xterm\n");CHKERRQ(ierr);
664e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       unless noxterm is given\n");CHKERRQ(ierr);
665e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
666e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start all processes in the debugger\n");CHKERRQ(ierr);
667e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_emacs <machinename>\n");CHKERRQ(ierr);
668e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"    emacs jumps to error file\n");CHKERRQ(ierr);
669e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_nodes [n1,n2,..] Nodes to start in debugger\n");CHKERRQ(ierr);
670e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_pause [m] : delay (in seconds) to attach debugger\n");CHKERRQ(ierr);
671e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -stop_for_debugger : prints message on how to attach debugger manually\n");CHKERRQ(ierr);
672e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"                      waits the delay for you to attach\n");CHKERRQ(ierr);
6731cda70a7SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -display display: Location where X window graphics and debuggers are displayed\n");CHKERRQ(ierr);
674e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -no_signal_handler: do not trap error signals\n");CHKERRQ(ierr);
675e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n");CHKERRQ(ierr);
676e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -fp_trap: stop on floating point exceptions\n");CHKERRQ(ierr);
677e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"           note on IBM RS6000 this slows run greatly\n");CHKERRQ(ierr);
678e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n");CHKERRQ(ierr);
67979dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc: use PETSc error checking malloc (deprecated, use -malloc_debug)\n");CHKERRQ(ierr);
68079dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc no: don't use PETSc error checking malloc (deprecated, use -malloc_debug no)\n");CHKERRQ(ierr);
6814161f2a3SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_info: prints total memory usage\n");CHKERRQ(ierr);
68292f119d6SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_view <optional filename>: keeps log of all memory allocations, displays in PetscFinalize()\n");CHKERRQ(ierr);
68379dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_debug <true or false>: enables or disables extended checking for memory corruption\n");CHKERRQ(ierr);
68426a7e8d4SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -options_view: dump list of options inputted\n");CHKERRQ(ierr);
685e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left: dump list of unused options\n");CHKERRQ(ierr);
686e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left no: don't dump list of unused options\n");CHKERRQ(ierr);
687e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -tmp tmpdir: alternative /tmp directory\n");CHKERRQ(ierr);
688e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -shared_tmp: tmp directory is shared by all processors\n");CHKERRQ(ierr);
689a8c7a070SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -not_shared_tmp: each processor has separate tmp directory\n");CHKERRQ(ierr);
6900841954dSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -memory_view: print memory usage at end of run\n");CHKERRQ(ierr);
691e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
692e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -get_total_flops: total flops over all processors\n");CHKERRQ(ierr);
693185ae32fSMatthew G. Knepley     ierr = (*PetscHelpPrintf)(comm," -log_view [:filename:[format]]: logging objects and events\n");CHKERRQ(ierr);
694e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_trace [filename]: prints trace of all PETSc calls\n");CHKERRQ(ierr);
695e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
696495fc317SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -log_mpe: Also create logfile viewable through Jumpshot\n");CHKERRQ(ierr);
697e5c89e4eSSatish Balay #endif
6986cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info <optional filename>: print informative messages about the calculations\n");CHKERRQ(ierr);
699e5c89e4eSSatish Balay #endif
700e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -v: prints PETSc version number and release date\n");CHKERRQ(ierr);
701e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_file <file>: reads options from file\n");CHKERRQ(ierr);
702e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -petsc_sleep n: sleeps n seconds before running program\n");CHKERRQ(ierr);
703e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
704e5c89e4eSSatish Balay   }
705e5c89e4eSSatish Balay 
70674ba8654SBarry Smith #if defined(PETSC_HAVE_POPEN)
70774ba8654SBarry Smith   {
70874ba8654SBarry Smith   char machine[128];
709c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-popen_machine",machine,128,&flg1);CHKERRQ(ierr);
71074ba8654SBarry Smith   if (flg1) {
71174ba8654SBarry Smith     ierr = PetscPOpenSetMachine(machine);CHKERRQ(ierr);
71274ba8654SBarry Smith   }
71374ba8654SBarry Smith   }
71474ba8654SBarry Smith #endif
71574ba8654SBarry Smith 
716c5929fdfSBarry Smith   ierr = PetscOptionsGetReal(NULL,NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
717e5c89e4eSSatish Balay   if (flg1) {
718e5c89e4eSSatish Balay     ierr = PetscSleep(si);CHKERRQ(ierr);
719e5c89e4eSSatish Balay   }
720e5c89e4eSSatish Balay 
721c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-info_exclude",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
7222ea1be5dSBarry Smith   if (flg1) {
723e5c89e4eSSatish Balay     ierr = PetscStrstr(mname,"null",&f);CHKERRQ(ierr);
724e5c89e4eSSatish Balay     if (f) {
725ecd8bba6SJed Brown       ierr = PetscInfoDeactivateClass(0);CHKERRQ(ierr);
726e5c89e4eSSatish Balay     }
7272ea1be5dSBarry Smith   }
728827f890bSBarry Smith 
729fdc842d1SBarry Smith #if defined(PETSC_HAVE_VIENNACL)
730c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
731f14045dbSBarry Smith   if (!flg3) {
732c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-log_view",&flg3);CHKERRQ(ierr);
733f14045dbSBarry Smith   }
734c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-viennacl_synchronize",&flg3,NULL);CHKERRQ(ierr);
735f14045dbSBarry Smith   PetscViennaCLSynchronize = flg3;
736fdc842d1SBarry Smith   ierr = PetscViennaCLInit();CHKERRQ(ierr);
7374cf1874eSKarl Rupp #endif
73882f73ecaSAlejandro Lamas Daviña 
739fdc842d1SBarry Smith   /*
740fdc842d1SBarry Smith      Creates the logging data structures; this is enabled even if logging is not turned on
741fdc842d1SBarry Smith      This is the last thing we do before returning to the user code to prevent having the
742fdc842d1SBarry Smith      logging numbers contaminated by any startup time associated with MPI and the GPUs
743fdc842d1SBarry Smith   */
744fdc842d1SBarry Smith #if defined(PETSC_USE_LOG)
745fdc842d1SBarry Smith   ierr = PetscLogInitialize();CHKERRQ(ierr);
746f0a7718cSKarl Rupp #endif
747f0a7718cSKarl Rupp 
748e5c89e4eSSatish Balay   PetscFunctionReturn(0);
749e5c89e4eSSatish Balay }
750