xref: /petsc/src/sys/objects/init.c (revision 0f1503a698da0451f8f2e3e02a165d4e1f526457)
1 /*
2 
3    This file defines part of the initialization of PETSc
4 
5   This file uses regular malloc and free because it cannot be known
6   what malloc is being used until it has already processed the input.
7 */
8 #include <petsc/private/petscimpl.h> /*I  "petscsys.h"   I*/
9 
10 #if defined(PETSC_HAVE_SYS_SYSINFO_H)
11 #include <sys/sysinfo.h>
12 #endif
13 #if defined(PETSC_HAVE_UNISTD_H)
14 #include <unistd.h>
15 #endif
16 
17 /* ------------------------Nasty global variables -------------------------------*/
18 /*
19      Indicates if PETSc started up MPI, or it was
20    already started before PETSc was initialized.
21 */
22 PetscBool   PetscBeganMPI                 = PETSC_FALSE;
23 PetscBool   PetscErrorHandlingInitialized = PETSC_FALSE;
24 PetscBool   PetscInitializeCalled         = PETSC_FALSE;
25 PetscBool   PetscFinalizeCalled           = PETSC_FALSE;
26 
27 PetscMPIInt PetscGlobalRank               = -1;
28 PetscMPIInt PetscGlobalSize               = -1;
29 
30 #if defined(PETSC_HAVE_KOKKOS)
31 PetscBool   PetscBeganKokkos              = PETSC_FALSE;
32 #endif
33 
34 #if defined(PETSC_HAVE_NVSHMEM)
35 PetscBool   PetscBeganNvshmem             = PETSC_FALSE;
36 PetscBool   PetscNvshmemInitialized       = PETSC_FALSE;
37 #endif
38 
39 PetscBool   use_gpu_aware_mpi             = PetscDefined(HAVE_MPIUNI) ? PETSC_FALSE : PETSC_TRUE;
40 
41 #if defined(PETSC_HAVE_COMPLEX)
42 #if defined(PETSC_COMPLEX_INSTANTIATE)
43 template <> class std::complex<double>; /* instantiate complex template class */
44 #endif
45 
46 /*MC
47    PETSC_i - the imaginary number i
48 
49    Synopsis:
50    #include <petscsys.h>
51    PetscComplex PETSC_i;
52 
53    Level: beginner
54 
55    Note:
56    Complex numbers are automatically available if PETSc located a working complex implementation
57 
58 .seealso: PetscRealPart(), PetscImaginaryPart(), PetscRealPartComplex(), PetscImaginaryPartComplex()
59 M*/
60 PetscComplex PETSC_i;
61 MPI_Datatype MPIU___COMPLEX128 = 0;
62 #endif /* PETSC_HAVE_COMPLEX */
63 #if defined(PETSC_USE_REAL___FLOAT128)
64 MPI_Datatype MPIU___FLOAT128 = 0;
65 #elif defined(PETSC_USE_REAL___FP16)
66 MPI_Datatype MPIU___FP16 = 0;
67 #endif
68 MPI_Datatype MPIU_2SCALAR = 0;
69 MPI_Datatype MPIU_REAL_INT = 0;
70 MPI_Datatype MPIU_SCALAR_INT = 0;
71 #if defined(PETSC_USE_64BIT_INDICES)
72 MPI_Datatype MPIU_2INT = 0;
73 #endif
74 MPI_Datatype MPI_4INT = 0;
75 MPI_Datatype MPIU_4INT = 0;
76 MPI_Datatype MPIU_BOOL;
77 MPI_Datatype MPIU_ENUM;
78 MPI_Datatype MPIU_FORTRANADDR;
79 MPI_Datatype MPIU_SIZE_T;
80 
81 /*
82        Function that is called to display all error messages
83 */
84 PetscErrorCode (*PetscErrorPrintf)(const char [],...)          = PetscErrorPrintfDefault;
85 PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char [],...)  = PetscHelpPrintfDefault;
86 PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list)    = PetscVFPrintfDefault;
87 
88 /* ------------------------------------------------------------------------------*/
89 /*
90    Optional file where all PETSc output from various prints is saved
91 */
92 PETSC_INTERN FILE *petsc_history;
93 FILE *petsc_history = NULL;
94 
95 PetscErrorCode  PetscOpenHistoryFile(const char filename[],FILE **fd)
96 {
97   PetscErrorCode ierr;
98   PetscMPIInt    rank,size;
99   char           pfile[PETSC_MAX_PATH_LEN],pname[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN],date[64];
100   char           version[256];
101 
102   PetscFunctionBegin;
103   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRMPI(ierr);
104   if (rank == 0) {
105     char        arch[10];
106     int         err;
107 
108     ierr = PetscGetArchType(arch,10);CHKERRQ(ierr);
109     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
110     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
111     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRMPI(ierr);
112     if (filename) {
113       ierr = PetscFixFilename(filename,fname);CHKERRQ(ierr);
114     } else {
115       ierr = PetscGetHomeDirectory(pfile,sizeof(pfile));CHKERRQ(ierr);
116       ierr = PetscStrlcat(pfile,"/.petschistory",sizeof(pfile));CHKERRQ(ierr);
117       ierr = PetscFixFilename(pfile,fname);CHKERRQ(ierr);
118     }
119 
120     *fd = fopen(fname,"a");
121     if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file: %s",fname);
122 
123     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"----------------------------------------\n");CHKERRQ(ierr);
124     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s %s\n",version,date);CHKERRQ(ierr);
125     ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr);
126     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s on a %s, %d proc. with options:\n",pname,arch,size);CHKERRQ(ierr);
127     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"----------------------------------------\n");CHKERRQ(ierr);
128 
129     err = fflush(*fd);
130     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
131   }
132   PetscFunctionReturn(0);
133 }
134 
135 PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE **fd)
136 {
137   PetscErrorCode ierr;
138   PetscMPIInt    rank;
139   char           date[64];
140   int            err;
141 
142   PetscFunctionBegin;
143   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRMPI(ierr);
144   if (rank == 0) {
145     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
146     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"----------------------------------------\n");CHKERRQ(ierr);
147     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"Finished at %s\n",date);CHKERRQ(ierr);
148     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"----------------------------------------\n");CHKERRQ(ierr);
149     err  = fflush(*fd);
150     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
151     err = fclose(*fd);
152     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
153   }
154   PetscFunctionReturn(0);
155 }
156 
157 /* ------------------------------------------------------------------------------*/
158 
159 /*
160    This is ugly and probably belongs somewhere else, but I want to
161   be able to put a true MPI abort error handler with command line args.
162 
163     This is so MPI errors in the debugger will leave all the stack
164   frames. The default MP_Abort() cleans up and exits thus providing no useful information
165   in the debugger hence we call abort() instead of MPI_Abort().
166 */
167 
168 void Petsc_MPI_AbortOnError(MPI_Comm *comm,PetscMPIInt *flag,...)
169 {
170   PetscFunctionBegin;
171   (*PetscErrorPrintf)("MPI error %d\n",*flag);
172   abort();
173 }
174 
175 void Petsc_MPI_DebuggerOnError(MPI_Comm *comm,PetscMPIInt *flag,...)
176 {
177   PetscErrorCode ierr;
178 
179   PetscFunctionBegin;
180   (*PetscErrorPrintf)("MPI error %d\n",*flag);
181   ierr = PetscAttachDebugger();
182   if (ierr) PETSCABORT(*comm,*flag); /* hopeless so get out */
183 }
184 
185 /*@C
186    PetscEnd - Calls PetscFinalize() and then ends the program. This is useful if one
187      wishes a clean exit somewhere deep in the program.
188 
189    Collective on PETSC_COMM_WORLD
190 
191    Options Database Keys are the same as for PetscFinalize()
192 
193    Level: advanced
194 
195    Note:
196    See PetscInitialize() for more general runtime options.
197 
198 .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscFinalize()
199 @*/
200 PetscErrorCode  PetscEnd(void)
201 {
202   PetscFunctionBegin;
203   PetscFinalize();
204   exit(0);
205   return 0;
206 }
207 
208 PetscBool PetscOptionsPublish = PETSC_FALSE;
209 PETSC_INTERN PetscErrorCode PetscSetUseHBWMalloc_Private(void);
210 PETSC_INTERN PetscBool      petscsetmallocvisited;
211 static       char           emacsmachinename[256];
212 
213 PetscErrorCode (*PetscExternalVersionFunction)(MPI_Comm) = NULL;
214 PetscErrorCode (*PetscExternalHelpFunction)(MPI_Comm)    = NULL;
215 
216 #if PetscDefined(USE_LOG)
217 #include <petscviewer.h>
218 #endif
219 
220 /*@C
221    PetscSetHelpVersionFunctions - Sets functions that print help and version information
222    before the PETSc help and version information is printed. Must call BEFORE PetscInitialize().
223    This routine enables a "higher-level" package that uses PETSc to print its messages first.
224 
225    Input Parameters:
226 +  help - the help function (may be NULL)
227 -  version - the version function (may be NULL)
228 
229    Level: developer
230 
231 @*/
232 PetscErrorCode  PetscSetHelpVersionFunctions(PetscErrorCode (*help)(MPI_Comm),PetscErrorCode (*version)(MPI_Comm))
233 {
234   PetscFunctionBegin;
235   PetscExternalHelpFunction    = help;
236   PetscExternalVersionFunction = version;
237   PetscFunctionReturn(0);
238 }
239 
240 #if defined(PETSC_USE_LOG)
241 PETSC_INTERN PetscBool   PetscObjectsLog;
242 #endif
243 
244 PETSC_INTERN PetscErrorCode  PetscOptionsCheckInitial_Private(const char help[])
245 {
246   char              string[64];
247   MPI_Comm          comm = PETSC_COMM_WORLD;
248   PetscBool         flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,flag,hasHelp;
249   PetscErrorCode    ierr;
250   PetscReal         si;
251   PetscInt          intensity;
252   int               i;
253   PetscMPIInt       rank;
254   char              version[256];
255 #if defined(PETSC_USE_LOG)
256   char              mname[PETSC_MAX_PATH_LEN];
257   PetscViewerFormat format;
258   PetscBool         flg4 = PETSC_FALSE;
259 #endif
260 
261   PetscFunctionBegin;
262   ierr = MPI_Comm_rank(comm,&rank);CHKERRMPI(ierr);
263 
264   /*
265      Setup building of stack frames for all function calls
266   */
267   if (PetscDefined(USE_DEBUG) && !PetscDefined(HAVE_THREADSAFETY)) {
268     ierr = PetscOptionsGetBool(NULL,NULL,"-checkstack",&flg1,NULL);CHKERRQ(ierr);
269     ierr = PetscStackSetCheck(flg1);CHKERRQ(ierr);
270   }
271 
272 #if !defined(PETSC_HAVE_THREADSAFETY)
273   if (!(PETSC_RUNNING_ON_VALGRIND)) {
274     /*
275       Setup the memory management; support for tracing malloc() usage
276     */
277     PetscBool mdebug = PETSC_FALSE, eachcall = PETSC_FALSE, initializenan = PETSC_FALSE, mlog = PETSC_FALSE;
278 
279     if (PetscDefined(USE_DEBUG)) {
280       mdebug        = PETSC_TRUE;
281       initializenan = PETSC_TRUE;
282       ierr   = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
283     } else {
284       /* don't warn about unused option */
285       ierr = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
286       flg1 = PETSC_FALSE;
287     }
288     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg2,&flg3);CHKERRQ(ierr);
289     if (flg1 || flg2) {
290       mdebug        = PETSC_TRUE;
291       eachcall      = PETSC_TRUE;
292       initializenan = PETSC_TRUE;
293     } else if (flg3 && !flg2) {
294       mdebug        = PETSC_FALSE;
295       eachcall      = PETSC_FALSE;
296       initializenan = PETSC_FALSE;
297     }
298 
299     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_requested_size",&flg1,&flg2);CHKERRQ(ierr);
300     if (flg2) {ierr = PetscMallocLogRequestedSizeSet(flg1);CHKERRQ(ierr);}
301 
302     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_view",&mlog);CHKERRQ(ierr);
303     if (mlog) {
304       mdebug = PETSC_TRUE;
305     }
306     /* the next line is deprecated */
307     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc",&mdebug,NULL);CHKERRQ(ierr);
308     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_dump",&mdebug,NULL);CHKERRQ(ierr);
309     ierr = PetscOptionsGetBool(NULL,NULL,"-log_view_memory",&mdebug,NULL);CHKERRQ(ierr);
310     if (mdebug) {
311       ierr = PetscMallocSetDebug(eachcall,initializenan);CHKERRQ(ierr);
312     }
313     if (mlog) {
314       PetscReal logthreshold = 0;
315       ierr = PetscOptionsGetReal(NULL,NULL,"-malloc_view_threshold",&logthreshold,NULL);CHKERRQ(ierr);
316       ierr = PetscMallocViewSet(logthreshold);CHKERRQ(ierr);
317     }
318 #if defined(PETSC_USE_LOG)
319     ierr = PetscOptionsGetBool(NULL,NULL,"-log_view_memory",&PetscLogMemory,NULL);CHKERRQ(ierr);
320 #endif
321   }
322 
323   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_coalesce",&flg1,&flg2);CHKERRQ(ierr);
324   if (flg2) {ierr = PetscMallocSetCoalesce(flg1);CHKERRQ(ierr);}
325   flg1 = PETSC_FALSE;
326   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_hbw",&flg1,NULL);CHKERRQ(ierr);
327   /* ignore this option if malloc is already set */
328   if (flg1 && !petscsetmallocvisited) {ierr = PetscSetUseHBWMalloc_Private();CHKERRQ(ierr);}
329 
330   flg1 = PETSC_FALSE;
331   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg1,NULL);CHKERRQ(ierr);
332   if (!flg1) {
333     flg1 = PETSC_FALSE;
334     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg1,NULL);CHKERRQ(ierr);
335   }
336   if (flg1) {
337     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
338   }
339 #endif
340 
341 #if defined(PETSC_USE_LOG)
342   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&PetscObjectsLog);CHKERRQ(ierr);
343 #endif
344 
345   /*
346       Set the display variable for graphics
347   */
348   ierr = PetscSetDisplay();CHKERRQ(ierr);
349 
350   /*
351      Print main application help message
352   */
353   ierr = PetscOptionsHasHelp(NULL,&hasHelp);CHKERRQ(ierr);
354   if (help && hasHelp) {
355     ierr = PetscPrintf(comm,"%s",help);CHKERRQ(ierr);
356     ierr = PetscPrintf(comm,"----------------------------------------\n");CHKERRQ(ierr);
357   }
358 
359   /*
360       Print the PETSc version information
361   */
362   ierr = PetscOptionsHasName(NULL,NULL,"-version",&flg1);CHKERRQ(ierr);
363   if (flg1 || hasHelp) {
364     /*
365        Print "higher-level" package version message
366     */
367     if (PetscExternalVersionFunction) {
368       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
369     }
370 
371     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
372     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
373     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
374     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
375     ierr = (*PetscHelpPrintf)(comm,"See docs/faq.html for problems.\n");CHKERRQ(ierr);
376     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
377     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
378     ierr = (*PetscHelpPrintf)(comm,"----------------------------------------\n");CHKERRQ(ierr);
379   }
380 
381   /*
382        Print "higher-level" package help message
383   */
384   if (hasHelp) {
385     PetscBool hasHelpIntro;
386 
387     if (PetscExternalHelpFunction) {
388       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
389     }
390     ierr = PetscOptionsHasHelpIntro_Internal(NULL,&hasHelpIntro);CHKERRQ(ierr);
391     if (hasHelpIntro) {
392       ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
393       ierr = PetscFreeMPIResources();CHKERRQ(ierr);
394       ierr = MPI_Finalize();CHKERRMPI(ierr);
395       exit(0);
396     }
397   }
398 
399   /*
400       Setup the error handling
401   */
402   flg1 = PETSC_FALSE;
403   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_abort",&flg1,NULL);CHKERRQ(ierr);
404   if (flg1) {
405     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_ARE_FATAL);CHKERRMPI(ierr);
406     ierr = PetscPushErrorHandler(PetscAbortErrorHandler,NULL);CHKERRQ(ierr);
407   }
408   flg1 = PETSC_FALSE;
409   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_mpiabort",&flg1,NULL);CHKERRQ(ierr);
410   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,NULL);CHKERRQ(ierr);}
411   flg1 = PETSC_FALSE;
412   ierr = PetscOptionsGetBool(NULL,NULL,"-mpi_return_on_error",&flg1,NULL);CHKERRQ(ierr);
413   if (flg1) {
414     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_RETURN);CHKERRMPI(ierr);
415   }
416   flg1 = PETSC_FALSE;
417   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
418   if (!flg1) {ierr = PetscPushSignalHandler(PetscSignalHandlerDefault,(void*)0);CHKERRQ(ierr);}
419 
420   /*
421       Setup debugger information
422   */
423   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
424   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_attach_debugger",string,sizeof(string),&flg1);CHKERRQ(ierr);
425   if (flg1) {
426     MPI_Errhandler err_handler;
427 
428     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
429     ierr = MPI_Comm_create_errhandler(Petsc_MPI_DebuggerOnError,&err_handler);CHKERRMPI(ierr);
430     ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRMPI(ierr);
431     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,NULL);CHKERRQ(ierr);
432   }
433   ierr = PetscOptionsGetString(NULL,NULL,"-debug_terminal",string,sizeof(string),&flg1);CHKERRQ(ierr);
434   if (flg1) { ierr = PetscSetDebugTerminal(string);CHKERRQ(ierr); }
435   ierr = PetscOptionsGetString(NULL,NULL,"-start_in_debugger",string,sizeof(string),&flg1);CHKERRQ(ierr);
436   ierr = PetscOptionsGetString(NULL,NULL,"-stop_for_debugger",string,sizeof(string),&flg2);CHKERRQ(ierr);
437   if (flg1 || flg2) {
438     PetscMPIInt    size;
439     PetscInt       lsize,*ranks;
440     MPI_Errhandler err_handler;
441     /*
442        we have to make sure that all processors have opened
443        connections to all other processors, otherwise once the
444        debugger has stated it is likely to receive a SIGUSR1
445        and kill the program.
446     */
447     ierr = MPI_Comm_size(comm,&size);CHKERRMPI(ierr);
448     if (size > 2) {
449       PetscMPIInt dummy = 0;
450       MPI_Status  status;
451       for (i=0; i<size; i++) {
452         if (rank != i) {
453           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,comm);CHKERRMPI(ierr);
454         }
455       }
456       for (i=0; i<size; i++) {
457         if (rank != i) {
458           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,comm,&status);CHKERRMPI(ierr);
459         }
460       }
461     }
462     /* check if this processor node should be in debugger */
463     ierr  = PetscMalloc1(size,&ranks);CHKERRQ(ierr);
464     lsize = size;
465     /* Deprecated in 3.14 */
466     ierr  = PetscOptionsGetIntArray(NULL,NULL,"-debugger_nodes",ranks,&lsize,&flag);CHKERRQ(ierr);
467     if (flag) {
468       const char * const quietopt="-options_suppress_deprecated_warnings";
469       char               msg[4096];
470       PetscBool          quiet = PETSC_FALSE;
471 
472       ierr = PetscOptionsGetBool(NULL,NULL,quietopt,&quiet,NULL);CHKERRQ(ierr);
473       if (!quiet) {
474         ierr = PetscStrcpy(msg,"** PETSc DEPRECATION WARNING ** : the option ");CHKERRQ(ierr);
475         ierr = PetscStrcat(msg,"-debugger_nodes");CHKERRQ(ierr);
476         ierr = PetscStrcat(msg," is deprecated as of version ");CHKERRQ(ierr);
477         ierr = PetscStrcat(msg,"3.14");CHKERRQ(ierr);
478         ierr = PetscStrcat(msg," and will be removed in a future release.");CHKERRQ(ierr);
479         ierr = PetscStrcat(msg," Please use the option ");CHKERRQ(ierr);
480         ierr = PetscStrcat(msg,"-debugger_ranks");CHKERRQ(ierr);
481         ierr = PetscStrcat(msg," instead.");CHKERRQ(ierr);
482         ierr = PetscStrcat(msg," (Silence this warning with ");CHKERRQ(ierr);
483         ierr = PetscStrcat(msg,quietopt);CHKERRQ(ierr);
484         ierr = PetscStrcat(msg,")\n");CHKERRQ(ierr);
485         ierr = PetscPrintf(comm,"%s",msg);CHKERRQ(ierr);
486       }
487     } else {
488       lsize = size;
489       ierr  = PetscOptionsGetIntArray(NULL,NULL,"-debugger_ranks",ranks,&lsize,&flag);CHKERRQ(ierr);
490     }
491     if (flag) {
492       for (i=0; i<lsize; i++) {
493         if (ranks[i] == rank) { flag = PETSC_FALSE; break; }
494       }
495     }
496     if (!flag) {
497       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
498       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,NULL);CHKERRQ(ierr);
499       if (flg1) {
500         ierr = PetscAttachDebugger();CHKERRQ(ierr);
501       } else {
502         ierr = PetscStopForDebugger();CHKERRQ(ierr);
503       }
504       ierr = MPI_Comm_create_errhandler(Petsc_MPI_AbortOnError,&err_handler);CHKERRMPI(ierr);
505       ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRMPI(ierr);
506     } else {
507       ierr = PetscWaitOnError();CHKERRQ(ierr);
508     }
509     ierr = PetscFree(ranks);CHKERRQ(ierr);
510   }
511 
512   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_emacs",emacsmachinename,sizeof(emacsmachinename),&flg1);CHKERRQ(ierr);
513   if (flg1 && rank == 0) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr);}
514 
515   /*
516         Setup profiling and logging
517   */
518 #if defined(PETSC_USE_INFO)
519   {
520     ierr = PetscInfoSetFromOptions(NULL);CHKERRQ(ierr);
521   }
522 #endif
523   ierr = PetscDetermineInitialFPTrap();
524   flg1 = PETSC_FALSE;
525   ierr = PetscOptionsGetBool(NULL,NULL,"-fp_trap",&flg1,&flag);CHKERRQ(ierr);
526   if (flag) {ierr = PetscSetFPTrap((PetscFPTrap)flg1);CHKERRQ(ierr);}
527   ierr = PetscOptionsGetInt(NULL,NULL,"-check_pointer_intensity",&intensity,&flag);CHKERRQ(ierr);
528   if (flag) {ierr = PetscCheckPointerSetIntensity(intensity);CHKERRQ(ierr);}
529 #if defined(PETSC_USE_LOG)
530   mname[0] = 0;
531   ierr = PetscOptionsGetString(NULL,NULL,"-history",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
532   if (flg1) {
533     if (mname[0]) {
534       ierr = PetscOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
535     } else {
536       ierr = PetscOpenHistoryFile(NULL,&petsc_history);CHKERRQ(ierr);
537     }
538   }
539 
540   ierr = PetscOptionsGetBool(NULL,NULL,"-log_sync",&PetscLogSyncOn,NULL);CHKERRQ(ierr);
541 
542 #if defined(PETSC_HAVE_MPE)
543   flg1 = PETSC_FALSE;
544   ierr = PetscOptionsHasName(NULL,NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
545   if (flg1) {ierr = PetscLogMPEBegin();CHKERRQ(ierr);}
546 #endif
547   flg1 = PETSC_FALSE;
548   flg3 = PETSC_FALSE;
549   ierr = PetscOptionsGetBool(NULL,NULL,"-log_all",&flg1,NULL);CHKERRQ(ierr);
550   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
551   if (flg1)                      { ierr = PetscLogAllBegin();CHKERRQ(ierr); }
552   else if (flg3)                 { ierr = PetscLogDefaultBegin();CHKERRQ(ierr);}
553 
554   ierr = PetscOptionsGetString(NULL,NULL,"-log_trace",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
555   if (flg1) {
556     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
557     FILE *file;
558     if (mname[0]) {
559       PetscSNPrintf(name,PETSC_MAX_PATH_LEN,"%s.%d",mname,rank);
560       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
561       file = fopen(fname,"w");
562       if (!file) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
563     } else file = PETSC_STDOUT;
564     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
565   }
566 
567   ierr = PetscOptionsGetViewer(comm,NULL,NULL,"-log_view",NULL,&format,&flg4);CHKERRQ(ierr);
568   if (flg4) {
569     if (format == PETSC_VIEWER_ASCII_XML || format == PETSC_VIEWER_ASCII_FLAMEGRAPH) {
570       ierr = PetscLogNestedBegin();CHKERRQ(ierr);
571     } else {
572       ierr = PetscLogDefaultBegin();CHKERRQ(ierr);
573     }
574   }
575   if (flg4 && (format == PETSC_VIEWER_ASCII_XML || format == PETSC_VIEWER_ASCII_FLAMEGRAPH)) {
576     PetscReal threshold = PetscRealConstant(0.01);
577     ierr = PetscOptionsGetReal(NULL,NULL,"-log_threshold",&threshold,&flg1);CHKERRQ(ierr);
578     if (flg1) {ierr = PetscLogSetThreshold((PetscLogDouble)threshold,NULL);CHKERRQ(ierr);}
579   }
580 #endif
581 
582   ierr = PetscOptionsGetBool(NULL,NULL,"-saws_options",&PetscOptionsPublish,NULL);CHKERRQ(ierr);
583   ierr = PetscOptionsGetBool(NULL,NULL,"-use_gpu_aware_mpi",&use_gpu_aware_mpi,NULL);CHKERRQ(ierr);
584 
585   /*
586        Print basic help message
587   */
588   if (hasHelp) {
589     ierr = (*PetscHelpPrintf)(comm,"Options for all PETSc programs:\n");CHKERRQ(ierr);
590     ierr = (*PetscHelpPrintf)(comm," -version: prints PETSc version\n");CHKERRQ(ierr);
591     ierr = (*PetscHelpPrintf)(comm," -help intro: prints example description and PETSc version, and exits\n");CHKERRQ(ierr);
592     ierr = (*PetscHelpPrintf)(comm," -help: prints example description, PETSc version, and available options for used routines\n");CHKERRQ(ierr);
593     ierr = (*PetscHelpPrintf)(comm," -on_error_abort: cause an abort when an error is detected. Useful \n ");CHKERRQ(ierr);
594     ierr = (*PetscHelpPrintf)(comm,"       only when run in the debugger\n");CHKERRQ(ierr);
595     ierr = (*PetscHelpPrintf)(comm," -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
596     ierr = (*PetscHelpPrintf)(comm,"       start the debugger in new xterm\n");CHKERRQ(ierr);
597     ierr = (*PetscHelpPrintf)(comm,"       unless noxterm is given\n");CHKERRQ(ierr);
598     ierr = (*PetscHelpPrintf)(comm," -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
599     ierr = (*PetscHelpPrintf)(comm,"       start all processes in the debugger\n");CHKERRQ(ierr);
600     ierr = (*PetscHelpPrintf)(comm," -on_error_emacs <machinename>\n");CHKERRQ(ierr);
601     ierr = (*PetscHelpPrintf)(comm,"    emacs jumps to error file\n");CHKERRQ(ierr);
602     ierr = (*PetscHelpPrintf)(comm," -debugger_ranks [n1,n2,..] Ranks to start in debugger\n");CHKERRQ(ierr);
603     ierr = (*PetscHelpPrintf)(comm," -debugger_pause [m] : delay (in seconds) to attach debugger\n");CHKERRQ(ierr);
604     ierr = (*PetscHelpPrintf)(comm," -stop_for_debugger : prints message on how to attach debugger manually\n");CHKERRQ(ierr);
605     ierr = (*PetscHelpPrintf)(comm,"                      waits the delay for you to attach\n");CHKERRQ(ierr);
606     ierr = (*PetscHelpPrintf)(comm," -display display: Location where X window graphics and debuggers are displayed\n");CHKERRQ(ierr);
607     ierr = (*PetscHelpPrintf)(comm," -no_signal_handler: do not trap error signals\n");CHKERRQ(ierr);
608     ierr = (*PetscHelpPrintf)(comm," -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n");CHKERRQ(ierr);
609     ierr = (*PetscHelpPrintf)(comm," -fp_trap: stop on floating point exceptions\n");CHKERRQ(ierr);
610     ierr = (*PetscHelpPrintf)(comm,"           note on IBM RS6000 this slows run greatly\n");CHKERRQ(ierr);
611     ierr = (*PetscHelpPrintf)(comm," -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n");CHKERRQ(ierr);
612     ierr = (*PetscHelpPrintf)(comm," -malloc: use PETSc error checking malloc (deprecated, use -malloc_debug)\n");CHKERRQ(ierr);
613     ierr = (*PetscHelpPrintf)(comm," -malloc no: don't use PETSc error checking malloc (deprecated, use -malloc_debug no)\n");CHKERRQ(ierr);
614     ierr = (*PetscHelpPrintf)(comm," -malloc_info: prints total memory usage\n");CHKERRQ(ierr);
615     ierr = (*PetscHelpPrintf)(comm," -malloc_view <optional filename>: keeps log of all memory allocations, displays in PetscFinalize()\n");CHKERRQ(ierr);
616     ierr = (*PetscHelpPrintf)(comm," -malloc_debug <true or false>: enables or disables extended checking for memory corruption\n");CHKERRQ(ierr);
617     ierr = (*PetscHelpPrintf)(comm," -options_view: dump list of options inputted\n");CHKERRQ(ierr);
618     ierr = (*PetscHelpPrintf)(comm," -options_left: dump list of unused options\n");CHKERRQ(ierr);
619     ierr = (*PetscHelpPrintf)(comm," -options_left no: don't dump list of unused options\n");CHKERRQ(ierr);
620     ierr = (*PetscHelpPrintf)(comm," -tmp tmpdir: alternative /tmp directory\n");CHKERRQ(ierr);
621     ierr = (*PetscHelpPrintf)(comm," -shared_tmp: tmp directory is shared by all processors\n");CHKERRQ(ierr);
622     ierr = (*PetscHelpPrintf)(comm," -not_shared_tmp: each processor has separate tmp directory\n");CHKERRQ(ierr);
623     ierr = (*PetscHelpPrintf)(comm," -memory_view: print memory usage at end of run\n");CHKERRQ(ierr);
624 #if defined(PETSC_USE_LOG)
625     ierr = (*PetscHelpPrintf)(comm," -get_total_flops: total flops over all processors\n");CHKERRQ(ierr);
626     ierr = (*PetscHelpPrintf)(comm," -log_view [:filename:[format]]: logging objects and events\n");CHKERRQ(ierr);
627     ierr = (*PetscHelpPrintf)(comm," -log_trace [filename]: prints trace of all PETSc calls\n");CHKERRQ(ierr);
628     ierr = (*PetscHelpPrintf)(comm," -log_exclude <list,of,classnames>: exclude given classes from logging\n");CHKERRQ(ierr);
629 #if defined(PETSC_HAVE_MPE)
630     ierr = (*PetscHelpPrintf)(comm," -log_mpe: Also create logfile viewable through Jumpshot\n");CHKERRQ(ierr);
631 #endif
632 #endif
633 #if defined(PETSC_USE_INFO)
634     ierr = (*PetscHelpPrintf)(comm," -info [filename][:[~]<list,of,classnames>[:[~]self]]: print verbose information\n");CHKERRQ(ierr);
635 #endif
636     ierr = (*PetscHelpPrintf)(comm," -options_file <file>: reads options from file\n");CHKERRQ(ierr);
637     ierr = (*PetscHelpPrintf)(comm," -options_monitor: monitor options to standard output, including that set previously e.g. in option files\n");CHKERRQ(ierr);
638     ierr = (*PetscHelpPrintf)(comm," -options_monitor_cancel: cancels all hardwired option monitors\n");CHKERRQ(ierr);
639     ierr = (*PetscHelpPrintf)(comm," -petsc_sleep n: sleeps n seconds before running program\n");CHKERRQ(ierr);
640   }
641 
642 #if defined(PETSC_HAVE_POPEN)
643   {
644   char machine[128];
645   ierr = PetscOptionsGetString(NULL,NULL,"-popen_machine",machine,sizeof(machine),&flg1);CHKERRQ(ierr);
646   if (flg1) {
647     ierr = PetscPOpenSetMachine(machine);CHKERRQ(ierr);
648   }
649   }
650 #endif
651 
652   ierr = PetscOptionsGetReal(NULL,NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
653   if (flg1) {
654     ierr = PetscSleep(si);CHKERRQ(ierr);
655   }
656   PetscFunctionReturn(0);
657 }
658