xref: /petsc/src/sys/objects/init.c (revision 8bf1f09cdf323e0dde0681283d9fd31df880e47d)
1 /*
2 
3    This file defines part of the initialization of PETSc
4 
5   This file uses regular malloc and free because it cannot known
6   what malloc is being used until it has already processed the input.
7 */
8 
9 #include <petscsys.h>        /*I  "petscsys.h"   I*/
10 
11 #ifndef _GNU_SOURCE
12 #define _GNU_SOURCE
13 #endif
14 #if defined(PETSC_HAVE_SCHED_H)
15 #ifndef __USE_GNU
16 #define __USE_GNU
17 #endif
18 #include <sched.h>
19 #endif
20 
21 #if defined(PETSC_HAVE_SYS_SYSINFO_H)
22 #include <sys/sysinfo.h>
23 #endif
24 #if defined(PETSC_HAVE_UNISTD_H)
25 #include <unistd.h>
26 #endif
27 #if defined(PETSC_HAVE_STDLIB_H)
28 #include <stdlib.h>
29 #endif
30 #if defined(PETSC_HAVE_MALLOC_H)
31 #include <malloc.h>
32 #endif
33 #if defined(PETSC_HAVE_VALGRIND)
34 #  include <valgrind/valgrind.h>
35 #  define PETSC_RUNNING_ON_VALGRIND RUNNING_ON_VALGRIND
36 #else
37 #  define PETSC_RUNNING_ON_VALGRIND PETSC_FALSE
38 #endif
39 
40 /* ------------------------Nasty global variables -------------------------------*/
41 /*
42      Indicates if PETSc started up MPI, or it was
43    already started before PETSc was initialized.
44 */
45 PetscBool    PetscBeganMPI         = PETSC_FALSE;
46 PetscBool    PetscInitializeCalled = PETSC_FALSE;
47 PetscBool    PetscFinalizeCalled   = PETSC_FALSE;
48 PetscMPIInt  PetscGlobalRank = -1;
49 PetscMPIInt  PetscGlobalSize = -1;
50 
51 #if defined(PETSC_USE_COMPLEX)
52 #if defined(PETSC_COMPLEX_INSTANTIATE)
53 template <> class std::complex<double>; /* instantiate complex template class */
54 #endif
55 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
56 MPI_Datatype   MPIU_C_DOUBLE_COMPLEX;
57 MPI_Datatype   MPIU_C_COMPLEX;
58 #endif
59 PetscScalar    PETSC_i;
60 #else
61 PetscScalar    PETSC_i = 0.0;
62 #endif
63 #if defined(PETSC_USE_REAL___FLOAT128)
64 MPI_Datatype   MPIU___FLOAT128 = 0;
65 #endif
66 MPI_Datatype   MPIU_2SCALAR = 0;
67 MPI_Datatype   MPIU_2INT = 0;
68 
69 /*
70        Function that is called to display all error messages
71 */
72 PetscErrorCode  (*PetscErrorPrintf)(const char [],...)          = PetscErrorPrintfDefault;
73 PetscErrorCode  (*PetscHelpPrintf)(MPI_Comm,const char [],...)  = PetscHelpPrintfDefault;
74 #if defined(PETSC_HAVE_MATLAB_ENGINE)
75 PetscErrorCode  (*PetscVFPrintf)(FILE*,const char[],va_list)    = PetscVFPrintf_Matlab;
76 #else
77 PetscErrorCode  (*PetscVFPrintf)(FILE*,const char[],va_list)    = PetscVFPrintfDefault;
78 #endif
79 /*
80   This is needed to turn on/off cusp synchronization
81 */
82 PetscBool   PetscCUSPSynchronize = PETSC_FALSE;
83 
84 /* ------------------------------------------------------------------------------*/
85 /*
86    Optional file where all PETSc output from various prints is saved
87 */
88 FILE *petsc_history = PETSC_NULL;
89 
90 #undef __FUNCT__
91 #define __FUNCT__ "PetscOpenHistoryFile"
92 PetscErrorCode  PetscOpenHistoryFile(const char filename[],FILE **fd)
93 {
94   PetscErrorCode ierr;
95   PetscMPIInt    rank,size;
96   char           pfile[PETSC_MAX_PATH_LEN],pname[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN],date[64];
97   char           version[256];
98 
99   PetscFunctionBegin;
100   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
101   if (!rank) {
102     char        arch[10];
103     int         err;
104     PetscViewer viewer;
105 
106     ierr = PetscGetArchType(arch,10);CHKERRQ(ierr);
107     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
108     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
109     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
110     if (filename) {
111       ierr = PetscFixFilename(filename,fname);CHKERRQ(ierr);
112     } else {
113       ierr = PetscGetHomeDirectory(pfile,240);CHKERRQ(ierr);
114       ierr = PetscStrcat(pfile,"/.petschistory");CHKERRQ(ierr);
115       ierr = PetscFixFilename(pfile,fname);CHKERRQ(ierr);
116     }
117 
118     *fd = fopen(fname,"a"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file: %s",fname);
119     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
120     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s %s\n",version,date);CHKERRQ(ierr);
121     ierr = PetscGetProgramName(pname,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
122     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s on a %s, %d proc. with options:\n",pname,arch,size);CHKERRQ(ierr);
123     ierr = PetscViewerASCIIOpenWithFILE(PETSC_COMM_WORLD,*fd,&viewer);CHKERRQ(ierr);
124     ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
125     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
126     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
127     err = fflush(*fd);
128     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
129   }
130   PetscFunctionReturn(0);
131 }
132 
133 #undef __FUNCT__
134 #define __FUNCT__ "PetscCloseHistoryFile"
135 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);CHKERRQ(ierr);
144   if (!rank) {
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 #undef __FUNCT__
169 #define __FUNCT__ "Petsc_MPI_AbortOnError"
170 void Petsc_MPI_AbortOnError(MPI_Comm *comm,PetscMPIInt *flag)
171 {
172   PetscFunctionBegin;
173   (*PetscErrorPrintf)("MPI error %d\n",*flag);
174   abort();
175 }
176 
177 #undef __FUNCT__
178 #define __FUNCT__ "Petsc_MPI_DebuggerOnError"
179 void Petsc_MPI_DebuggerOnError(MPI_Comm *comm,PetscMPIInt *flag)
180 {
181   PetscErrorCode ierr;
182 
183   PetscFunctionBegin;
184   (*PetscErrorPrintf)("MPI error %d\n",*flag);
185   ierr = PetscAttachDebugger();
186   if (ierr) { /* hopeless so get out */
187     MPI_Abort(*comm,*flag);
188   }
189 }
190 
191 #undef __FUNCT__
192 #define __FUNCT__ "PetscEnd"
193 /*@C
194    PetscEnd - Calls PetscFinalize() and then ends the program. This is useful if one
195      wishes a clean exit somewhere deep in the program.
196 
197    Collective on PETSC_COMM_WORLD
198 
199    Options Database Keys are the same as for PetscFinalize()
200 
201    Level: advanced
202 
203    Note:
204    See PetscInitialize() for more general runtime options.
205 
206 .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscFinalize()
207 @*/
208 PetscErrorCode  PetscEnd(void)
209 {
210   PetscFunctionBegin;
211   PetscFinalize();
212   exit(0);
213   return 0;
214 }
215 
216 PetscBool    PetscOptionsPublish = PETSC_FALSE;
217 extern PetscErrorCode        PetscSetUseTrMalloc_Private(void);
218 extern PetscBool  petscsetmallocvisited;
219 static char       emacsmachinename[256];
220 
221 PetscErrorCode (*PetscExternalVersionFunction)(MPI_Comm) = 0;
222 PetscErrorCode (*PetscExternalHelpFunction)(MPI_Comm)    = 0;
223 
224 #undef __FUNCT__
225 #define __FUNCT__ "PetscSetHelpVersionFunctions"
226 /*@C
227    PetscSetHelpVersionFunctions - Sets functions that print help and version information
228    before the PETSc help and version information is printed. Must call BEFORE PetscInitialize().
229    This routine enables a "higher-level" package that uses PETSc to print its messages first.
230 
231    Input Parameter:
232 +  help - the help function (may be PETSC_NULL)
233 -  version - the version function (may be PETSC_NULL)
234 
235    Level: developer
236 
237    Concepts: package help message
238 
239 @*/
240 PetscErrorCode  PetscSetHelpVersionFunctions(PetscErrorCode (*help)(MPI_Comm),PetscErrorCode (*version)(MPI_Comm))
241 {
242   PetscFunctionBegin;
243   PetscExternalHelpFunction    = help;
244   PetscExternalVersionFunction = version;
245   PetscFunctionReturn(0);
246 }
247 
248 #if defined(PETSC_HAVE_PTHREADCLASSES)
249 extern PetscErrorCode PetscOptionsCheckInitial_Private_Pthread(void);
250 #endif
251 
252 #if defined(PETSC_HAVE_CUDA)
253 #include <cublas.h>
254 #endif
255 
256 #undef __FUNCT__
257 #define __FUNCT__ "PetscOptionsCheckInitial_Private"
258 PetscErrorCode  PetscOptionsCheckInitial_Private(void)
259 {
260   char           string[64],mname[PETSC_MAX_PATH_LEN],*f;
261   MPI_Comm       comm = PETSC_COMM_WORLD;
262   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,flg4 = PETSC_FALSE,flag,flgz,flgzout;
263   PetscErrorCode ierr;
264   PetscReal      si;
265   int            i;
266   PetscMPIInt    rank;
267   char           version[256];
268 
269   PetscFunctionBegin;
270   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
271 
272   /*
273       Setup the memory management; support for tracing malloc() usage
274   */
275   ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_log",&flg3);CHKERRQ(ierr);
276 #if defined(PETSC_USE_DEBUG)
277   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc",&flg1,&flg2);CHKERRQ(ierr);
278   if ((!flg2 || flg1) && !petscsetmallocvisited) {
279     if (flg2 || !(PETSC_RUNNING_ON_VALGRIND)) {
280       /* turn off default -malloc if valgrind is being used */
281       ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
282     }
283   }
284 #else
285   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc_dump",&flg1,PETSC_NULL);CHKERRQ(ierr);
286   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc",&flg2,PETSC_NULL);CHKERRQ(ierr);
287   if (flg1 || flg2 || flg3) {ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);}
288 #endif
289   if (flg3) {
290     ierr = PetscMallocSetDumpLog();CHKERRQ(ierr);
291   }
292   flg1 = PETSC_FALSE;
293   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc_debug",&flg1,PETSC_NULL);CHKERRQ(ierr);
294   if (flg1) {
295     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
296     ierr = PetscMallocDebug(PETSC_TRUE);CHKERRQ(ierr);
297   }
298   flg1 = PETSC_FALSE;
299   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc_test",&flg1,PETSC_NULL);CHKERRQ(ierr);
300 #if defined(PETSC_USE_DEBUG)
301   if (flg1 && !PETSC_RUNNING_ON_VALGRIND) {
302     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
303     ierr = PetscMallocSetDumpLog();CHKERRQ(ierr);
304     ierr = PetscMallocDebug(PETSC_TRUE);CHKERRQ(ierr);
305   }
306 #endif
307 
308   flg1 = PETSC_FALSE;
309   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc_info",&flg1,PETSC_NULL);CHKERRQ(ierr);
310   if (!flg1) {
311     flg1 = PETSC_FALSE;
312     ierr = PetscOptionsGetBool(PETSC_NULL,"-memory_info",&flg1,PETSC_NULL);CHKERRQ(ierr);
313   }
314   if (flg1) {
315     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
316   }
317 
318   /*
319       Set the display variable for graphics
320   */
321   ierr = PetscSetDisplay();CHKERRQ(ierr);
322 
323   /*
324       Print the PETSc version information
325   */
326   ierr = PetscOptionsHasName(PETSC_NULL,"-v",&flg1);CHKERRQ(ierr);
327   ierr = PetscOptionsHasName(PETSC_NULL,"-version",&flg2);CHKERRQ(ierr);
328   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg3);CHKERRQ(ierr);
329   if (flg1 || flg2 || flg3){
330 
331     /*
332        Print "higher-level" package version message
333     */
334     if (PetscExternalVersionFunction) {
335       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
336     }
337 
338     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
339     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------\
340 ------------------------------\n");CHKERRQ(ierr);
341     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
342     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
343     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
344     ierr = (*PetscHelpPrintf)(comm,"See docs/faq.html for problems.\n");CHKERRQ(ierr);
345     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
346     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
347     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------\
348 ------------------------------\n");CHKERRQ(ierr);
349   }
350 
351   /*
352        Print "higher-level" package help message
353   */
354   if (flg3){
355     if (PetscExternalHelpFunction) {
356       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
357     }
358   }
359 
360   /*
361       Setup the error handling
362   */
363   flg1 = PETSC_FALSE;
364   ierr = PetscOptionsGetBool(PETSC_NULL,"-on_error_abort",&flg1,PETSC_NULL);CHKERRQ(ierr);
365   if (flg1) {
366     ierr = MPI_Errhandler_set(PETSC_COMM_WORLD,MPI_ERRORS_ARE_FATAL);CHKERRQ(ierr);
367     ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
368   }
369   flg1 = PETSC_FALSE;
370   ierr = PetscOptionsGetBool(PETSC_NULL,"-on_error_mpiabort",&flg1,PETSC_NULL);CHKERRQ(ierr);
371   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,0);CHKERRQ(ierr);}
372   flg1 = PETSC_FALSE;
373   ierr = PetscOptionsGetBool(PETSC_NULL,"-mpi_return_on_error",&flg1,PETSC_NULL);CHKERRQ(ierr);
374   if (flg1) {
375     ierr = MPI_Errhandler_set(comm,MPI_ERRORS_RETURN);CHKERRQ(ierr);
376   }
377   flg1 = PETSC_FALSE;
378   ierr = PetscOptionsGetBool(PETSC_NULL,"-no_signal_handler",&flg1,PETSC_NULL);CHKERRQ(ierr);
379   if (!flg1) {ierr = PetscPushSignalHandler(PetscDefaultSignalHandler,(void*)0);CHKERRQ(ierr);}
380   flg1 = PETSC_FALSE;
381   ierr = PetscOptionsGetBool(PETSC_NULL,"-fp_trap",&flg1,PETSC_NULL);CHKERRQ(ierr);
382   if (flg1) {ierr = PetscSetFPTrap(PETSC_FP_TRAP_ON);CHKERRQ(ierr);}
383 
384   /*
385       Setup debugger information
386   */
387   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
388   ierr = PetscOptionsGetString(PETSC_NULL,"-on_error_attach_debugger",string,64,&flg1);CHKERRQ(ierr);
389   if (flg1) {
390     MPI_Errhandler err_handler;
391 
392     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
393     ierr = MPI_Errhandler_create((MPI_Handler_function*)Petsc_MPI_DebuggerOnError,&err_handler);CHKERRQ(ierr);
394     ierr = MPI_Errhandler_set(comm,err_handler);CHKERRQ(ierr);
395     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,0);CHKERRQ(ierr);
396   }
397   ierr = PetscOptionsGetString(PETSC_NULL,"-debug_terminal",string,64,&flg1);CHKERRQ(ierr);
398   if (flg1) { ierr = PetscSetDebugTerminal(string);CHKERRQ(ierr); }
399   ierr = PetscOptionsGetString(PETSC_NULL,"-start_in_debugger",string,64,&flg1);CHKERRQ(ierr);
400   ierr = PetscOptionsGetString(PETSC_NULL,"-stop_for_debugger",string,64,&flg2);CHKERRQ(ierr);
401   if (flg1 || flg2) {
402     PetscMPIInt    size;
403     PetscInt       lsize,*nodes;
404     MPI_Errhandler err_handler;
405     /*
406        we have to make sure that all processors have opened
407        connections to all other processors, otherwise once the
408        debugger has stated it is likely to receive a SIGUSR1
409        and kill the program.
410     */
411     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
412     if (size > 2) {
413       PetscMPIInt dummy = 0;
414       MPI_Status  status;
415       for (i=0; i<size; i++) {
416         if (rank != i) {
417           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,PETSC_COMM_WORLD);CHKERRQ(ierr);
418         }
419       }
420       for (i=0; i<size; i++) {
421         if (rank != i) {
422           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,PETSC_COMM_WORLD,&status);CHKERRQ(ierr);
423         }
424       }
425     }
426     /* check if this processor node should be in debugger */
427     ierr  = PetscMalloc(size*sizeof(PetscInt),&nodes);CHKERRQ(ierr);
428     lsize = size;
429     ierr  = PetscOptionsGetIntArray(PETSC_NULL,"-debugger_nodes",nodes,&lsize,&flag);CHKERRQ(ierr);
430     if (flag) {
431       for (i=0; i<lsize; i++) {
432         if (nodes[i] == rank) { flag = PETSC_FALSE; break; }
433       }
434     }
435     if (!flag) {
436       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
437       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
438       if (flg1) {
439         ierr = PetscAttachDebugger();CHKERRQ(ierr);
440       } else {
441         ierr = PetscStopForDebugger();CHKERRQ(ierr);
442       }
443       ierr = MPI_Errhandler_create((MPI_Handler_function*)Petsc_MPI_AbortOnError,&err_handler);CHKERRQ(ierr);
444       ierr = MPI_Errhandler_set(comm,err_handler);CHKERRQ(ierr);
445     }
446     ierr = PetscFree(nodes);CHKERRQ(ierr);
447   }
448 
449   ierr = PetscOptionsGetString(PETSC_NULL,"-on_error_emacs",emacsmachinename,128,&flg1);CHKERRQ(ierr);
450   if (flg1 && !rank) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr);}
451 
452 #if defined(PETSC_USE_SOCKET_VIEWER)
453   /*
454     Activates new sockets for zope if needed
455   */
456   ierr = PetscOptionsHasName(PETSC_NULL,"-zope", &flgz);CHKERRQ(ierr);
457   ierr = PetscOptionsHasName(PETSC_NULL,"-nostdout", &flgzout);CHKERRQ(ierr);
458   if (flgz){
459     int  sockfd;
460     char hostname[256];
461     char username[256];
462     int  remoteport = 9999;
463 
464     ierr = PetscOptionsGetString(PETSC_NULL, "-zope", hostname, 256, &flgz);CHKERRQ(ierr);
465     if (!hostname[0]){
466       ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
467     }
468     ierr = PetscOpenSocket(hostname, remoteport, &sockfd);CHKERRQ(ierr);
469     ierr = PetscGetUserName(username, 256);CHKERRQ(ierr);
470     PETSC_ZOPEFD = fdopen(sockfd, "w");
471     if (flgzout){
472       PETSC_STDOUT = PETSC_ZOPEFD;
473       fprintf(PETSC_STDOUT, "<<<user>>> %s\n",username);
474       fprintf(PETSC_STDOUT, "<<<start>>>");
475     } else {
476       fprintf(PETSC_ZOPEFD, "<<<user>>> %s\n",username);
477       fprintf(PETSC_ZOPEFD, "<<<start>>>");
478     }
479   }
480 #endif
481 #if defined(PETSC_USE_SERVER)
482   ierr = PetscOptionsHasName(PETSC_NULL,"-server", &flgz);CHKERRQ(ierr);
483   if (flgz){
484     PetscInt port = PETSC_DECIDE;
485     ierr = PetscOptionsGetInt(PETSC_NULL,"-server",&port,PETSC_NULL);CHKERRQ(ierr);
486     ierr = PetscWebServe(PETSC_COMM_WORLD,(int)port);CHKERRQ(ierr);
487   }
488 #endif
489 
490   /*
491         Setup profiling and logging
492   */
493 #if defined (PETSC_USE_INFO)
494   {
495     char logname[PETSC_MAX_PATH_LEN]; logname[0] = 0;
496     ierr = PetscOptionsGetString(PETSC_NULL,"-info",logname,250,&flg1);CHKERRQ(ierr);
497     if (flg1 && logname[0]) {
498       ierr = PetscInfoAllow(PETSC_TRUE,logname);CHKERRQ(ierr);
499     } else if (flg1) {
500       ierr = PetscInfoAllow(PETSC_TRUE,PETSC_NULL);CHKERRQ(ierr);
501     }
502   }
503 #endif
504 #if defined(PETSC_USE_LOG)
505   mname[0] = 0;
506   ierr = PetscOptionsGetString(PETSC_NULL,"-history",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
507   if (flg1) {
508     if (mname[0]) {
509       ierr = PetscOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
510     } else {
511       ierr = PetscOpenHistoryFile(0,&petsc_history);CHKERRQ(ierr);
512     }
513   }
514 #if defined(PETSC_HAVE_MPE)
515   flg1 = PETSC_FALSE;
516   ierr = PetscOptionsHasName(PETSC_NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
517   if (flg1) PetscLogMPEBegin();
518 #endif
519   flg1 = PETSC_FALSE;
520   flg2 = PETSC_FALSE;
521   flg3 = PETSC_FALSE;
522   ierr = PetscOptionsGetBool(PETSC_NULL,"-log_all",&flg1,PETSC_NULL);CHKERRQ(ierr);
523   ierr = PetscOptionsGetBool(PETSC_NULL,"-log",&flg2,PETSC_NULL);CHKERRQ(ierr);
524   ierr = PetscOptionsHasName(PETSC_NULL,"-log_summary",&flg3);CHKERRQ(ierr);
525   ierr = PetscOptionsHasName(PETSC_NULL,"-log_summary_python",&flg4);CHKERRQ(ierr);
526   if (flg1)                      {  ierr = PetscLogAllBegin();CHKERRQ(ierr); }
527   else if (flg2 || flg3 || flg4) {  ierr = PetscLogBegin();CHKERRQ(ierr);}
528 
529   ierr = PetscOptionsGetString(PETSC_NULL,"-log_trace",mname,250,&flg1);CHKERRQ(ierr);
530   if (flg1) {
531     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
532     FILE *file;
533     if (mname[0]) {
534       sprintf(name,"%s.%d",mname,rank);
535       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
536       file = fopen(fname,"w");
537       if (!file) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
538     } else {
539       file = PETSC_STDOUT;
540     }
541     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
542   }
543 #endif
544 
545   /*
546       Setup building of stack frames for all function calls
547   */
548 #if defined(PETSC_USE_DEBUG)
549   ierr = PetscStackCreate();CHKERRQ(ierr);
550 #endif
551 
552   ierr = PetscOptionsGetBool(PETSC_NULL,"-options_gui",&PetscOptionsPublish,PETSC_NULL);CHKERRQ(ierr);
553 
554 #if defined(PETSC_HAVE_CUDA)
555   ierr = PetscOptionsHasName(PETSC_NULL,"-cuda_show_devices",&flg1);CHKERRQ(ierr);
556   if (flg1) {
557     struct cudaDeviceProp prop;
558     int devCount;
559     int device;
560 
561     ierr = cudaGetDeviceCount(&devCount);CHKERRQ(ierr);
562     for(device = 0; device < devCount; ++device) {
563       ierr = cudaGetDeviceProperties(&prop, device);CHKERRQ(ierr);
564       ierr = PetscPrintf(PETSC_COMM_WORLD, "CUDA device %d: %s\n", device, prop.name);CHKERRQ(ierr);
565     }
566   }
567   {
568     int size;
569     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
570     if (size>1) {
571       int devCount, device, rank;
572       ierr = cudaGetDeviceCount(&devCount);CHKERRQ(ierr);
573       ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
574       device = rank % devCount;
575       ierr = cudaSetDevice(device);CHKERRQ(ierr);
576     }
577     else {
578       int device;
579       /* the code below works for serial GPU simulations */
580       ierr = PetscOptionsGetInt(PETSC_NULL,"-cuda_set_device", &device, &flg1);CHKERRQ(ierr);
581       if (flg1) {
582         ierr = cudaSetDevice(device);CHKERRQ(ierr);
583       }
584     }
585   }
586 #endif
587 
588 
589 #if defined(PETSC_HAVE_PTHREADCLASSES)
590   ierr = PetscOptionsCheckInitial_Private_Pthread();
591 #endif
592   /*
593        Print basic help message
594   */
595   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg1);CHKERRQ(ierr);
596   if (flg1) {
597     ierr = (*PetscHelpPrintf)(comm,"Options for all PETSc programs:\n");CHKERRQ(ierr);
598     ierr = (*PetscHelpPrintf)(comm," -help: prints help method for each option\n");CHKERRQ(ierr);
599     ierr = (*PetscHelpPrintf)(comm," -on_error_abort: cause an abort when an error is detected. Useful \n ");CHKERRQ(ierr);
600     ierr = (*PetscHelpPrintf)(comm,"       only when run in the debugger\n");CHKERRQ(ierr);
601     ierr = (*PetscHelpPrintf)(comm," -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
602     ierr = (*PetscHelpPrintf)(comm,"       start the debugger in new xterm\n");CHKERRQ(ierr);
603     ierr = (*PetscHelpPrintf)(comm,"       unless noxterm is given\n");CHKERRQ(ierr);
604     ierr = (*PetscHelpPrintf)(comm," -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
605     ierr = (*PetscHelpPrintf)(comm,"       start all processes in the debugger\n");CHKERRQ(ierr);
606     ierr = (*PetscHelpPrintf)(comm," -on_error_emacs <machinename>\n");CHKERRQ(ierr);
607     ierr = (*PetscHelpPrintf)(comm,"    emacs jumps to error file\n");CHKERRQ(ierr);
608     ierr = (*PetscHelpPrintf)(comm," -debugger_nodes [n1,n2,..] Nodes to start in debugger\n");CHKERRQ(ierr);
609     ierr = (*PetscHelpPrintf)(comm," -debugger_pause [m] : delay (in seconds) to attach debugger\n");CHKERRQ(ierr);
610     ierr = (*PetscHelpPrintf)(comm," -stop_for_debugger : prints message on how to attach debugger manually\n");CHKERRQ(ierr);
611     ierr = (*PetscHelpPrintf)(comm,"                      waits the delay for you to attach\n");CHKERRQ(ierr);
612     ierr = (*PetscHelpPrintf)(comm," -display display: Location where graphics and debuggers are displayed\n");CHKERRQ(ierr);
613     ierr = (*PetscHelpPrintf)(comm," -no_signal_handler: do not trap error signals\n");CHKERRQ(ierr);
614     ierr = (*PetscHelpPrintf)(comm," -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n");CHKERRQ(ierr);
615     ierr = (*PetscHelpPrintf)(comm," -fp_trap: stop on floating point exceptions\n");CHKERRQ(ierr);
616     ierr = (*PetscHelpPrintf)(comm,"           note on IBM RS6000 this slows run greatly\n");CHKERRQ(ierr);
617     ierr = (*PetscHelpPrintf)(comm," -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n");CHKERRQ(ierr);
618     ierr = (*PetscHelpPrintf)(comm," -malloc: use our error checking malloc\n");CHKERRQ(ierr);
619     ierr = (*PetscHelpPrintf)(comm," -malloc no: don't use error checking malloc\n");CHKERRQ(ierr);
620     ierr = (*PetscHelpPrintf)(comm," -malloc_info: prints total memory usage\n");CHKERRQ(ierr);
621     ierr = (*PetscHelpPrintf)(comm," -malloc_log: keeps log of all memory allocations\n");CHKERRQ(ierr);
622     ierr = (*PetscHelpPrintf)(comm," -malloc_debug: enables extended checking for memory corruption\n");CHKERRQ(ierr);
623     ierr = (*PetscHelpPrintf)(comm," -options_table: dump list of options inputted\n");CHKERRQ(ierr);
624     ierr = (*PetscHelpPrintf)(comm," -options_left: dump list of unused options\n");CHKERRQ(ierr);
625     ierr = (*PetscHelpPrintf)(comm," -options_left no: don't dump list of unused options\n");CHKERRQ(ierr);
626     ierr = (*PetscHelpPrintf)(comm," -tmp tmpdir: alternative /tmp directory\n");CHKERRQ(ierr);
627     ierr = (*PetscHelpPrintf)(comm," -shared_tmp: tmp directory is shared by all processors\n");CHKERRQ(ierr);
628     ierr = (*PetscHelpPrintf)(comm," -not_shared_tmp: each processor has separate tmp directory\n");CHKERRQ(ierr);
629     ierr = (*PetscHelpPrintf)(comm," -memory_info: print memory usage at end of run\n");CHKERRQ(ierr);
630     ierr = (*PetscHelpPrintf)(comm," -server <port>: Run PETSc webserver (default port is 8080) see PetscWebServe()\n");CHKERRQ(ierr);
631 #if defined(PETSC_USE_LOG)
632     ierr = (*PetscHelpPrintf)(comm," -get_total_flops: total flops over all processors\n");CHKERRQ(ierr);
633     ierr = (*PetscHelpPrintf)(comm," -log[_all _summary _summary_python]: logging objects and events\n");CHKERRQ(ierr);
634     ierr = (*PetscHelpPrintf)(comm," -log_trace [filename]: prints trace of all PETSc calls\n");CHKERRQ(ierr);
635 #if defined(PETSC_HAVE_MPE)
636     ierr = (*PetscHelpPrintf)(comm," -log_mpe: Also create logfile viewable through upshot\n");CHKERRQ(ierr);
637 #endif
638     ierr = (*PetscHelpPrintf)(comm," -info <optional filename>: print informative messages about the calculations\n");CHKERRQ(ierr);
639 #endif
640     ierr = (*PetscHelpPrintf)(comm," -v: prints PETSc version number and release date\n");CHKERRQ(ierr);
641     ierr = (*PetscHelpPrintf)(comm," -options_file <file>: reads options from file\n");CHKERRQ(ierr);
642     ierr = (*PetscHelpPrintf)(comm," -petsc_sleep n: sleeps n seconds before running program\n");CHKERRQ(ierr);
643     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
644   }
645 
646   ierr = PetscOptionsGetReal(PETSC_NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
647   if (flg1) {
648     ierr = PetscSleep(si);CHKERRQ(ierr);
649   }
650 
651   ierr = PetscOptionsGetString(PETSC_NULL,"-info_exclude",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
652   ierr = PetscStrstr(mname,"null",&f);CHKERRQ(ierr);
653   if (f) {
654     ierr = PetscInfoDeactivateClass(0);CHKERRQ(ierr);
655   }
656 
657 #if defined(PETSC_HAVE_CUSP)
658   ierr = PetscOptionsHasName(PETSC_NULL,"-log_summary",&flg3);CHKERRQ(ierr);
659   if (flg3) flg1 = PETSC_TRUE;
660   else flg1 = PETSC_FALSE;
661   ierr = PetscOptionsGetBool(PETSC_NULL,"-cusp_synchronize",&flg1,PETSC_NULL);CHKERRQ(ierr);
662   if (flg1) PetscCUSPSynchronize = PETSC_TRUE;
663 #endif
664 
665   PetscFunctionReturn(0);
666 }
667 
668