xref: /petsc/src/sys/error/err.c (revision e57d7714c1ef65e98802735ba860ff395287aedb)
1 
2 /*
3       Code that allows one to set the error handlers
4 */
5 #include <petsc/private/petscimpl.h>           /*I "petscsys.h" I*/
6 #include <petscviewer.h>
7 
8 /* A table of Petsc source files containing calls to PETSCABORT. We assume this table will
9    stay stable for a while. When things changed, we just need to add new files to the table.
10  */
11 static const char* PetscAbortSourceFiles[] = {
12   "Souce code of main",          /* 0 */
13   "Not Found",                  /* 1, not found in petsc, but may be in users' code if they called PETSCABORT. */
14   "sys/error/adebug.c",
15   "src/sys/error/errstop.c",
16   "sys/error/fp.c",
17   "sys/error/signal.c",           /* 5 */
18   "sys/ftn-custom/zutils.c",
19   "sys/logging/utils/stagelog.c",
20   "sys/mpiuni/mpitime.c",
21   "sys/objects/init.c",
22   "sys/objects/pinit.c",            /* 10 */
23   "vec/vec/interface/dlregisvec.c",
24   "vec/vec/utils/comb.c"
25 };
26 
27 /* Find index of the soure file where a PETSCABORT was called. */
28 PetscErrorCode PetscAbortFindSourceFile_Private(const char* filepath, PetscInt *idx)
29 {
30   PetscErrorCode  ierr;
31   PetscInt        i,n = sizeof(PetscAbortSourceFiles)/sizeof(PetscAbortSourceFiles[0]);
32   PetscBool       match;
33   char            subpath[256];
34 
35   PetscFunctionBegin;
36   PetscValidIntPointer(idx,2);
37   *idx = 1;
38   for (i=2; i<n; i++) {
39     ierr = PetscFixFilename(PetscAbortSourceFiles[i],subpath);CHKERRQ(ierr);
40     ierr = PetscStrendswith(filepath,subpath,&match);CHKERRQ(ierr);
41     if (match) {*idx = i; break;}
42   }
43   PetscFunctionReturn(0);
44 }
45 
46 typedef struct _EH *EH;
47 struct _EH {
48   PetscErrorCode (*handler)(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
49   void           *ctx;
50   EH             previous;
51 };
52 
53 static EH eh = NULL;
54 
55 /*@C
56    PetscEmacsClientErrorHandler - Error handler that uses the emacsclient program to
57     load the file where the error occured. Then calls the "previous" error handler.
58 
59    Not Collective
60 
61    Input Parameters:
62 +  comm - communicator over which error occured
63 .  line - the line number of the error (indicated by __LINE__)
64 .  file - the file in which the error was detected (indicated by __FILE__)
65 .  mess - an error text string, usually just printed to the screen
66 .  n - the generic error number
67 .  p - specific error number
68 -  ctx - error handler context
69 
70    Options Database Key:
71 .   -on_error_emacs <machinename>
72 
73    Level: developer
74 
75    Notes:
76    You must put (server-start) in your .emacs file for the emacsclient software to work
77 
78    Most users need not directly employ this routine and the other error
79    handlers, but can instead use the simplified interface SETERRQ, which has
80    the calling sequence
81 $     SETERRQ(PETSC_COMM_SELF,number,p,mess)
82 
83    Notes for experienced users:
84    Use PetscPushErrorHandler() to set the desired error handler.
85 
86    Developer Note:
87    Since this is an error handler it cannot call CHKERRQ(); thus we just return if an error is detected.
88 
89 
90 .seealso:  PetscPushErrorHandler(), PetscAttachDebuggerErrorHandler(),
91           PetscAbortErrorHandler()
92  @*/
93 PetscErrorCode  PetscEmacsClientErrorHandler(MPI_Comm comm,int line,const char *fun,const char *file,PetscErrorCode n,PetscErrorType p,const char *mess,void *ctx)
94 {
95   PetscErrorCode ierr;
96   char           command[PETSC_MAX_PATH_LEN];
97   const char     *pdir;
98   FILE           *fp;
99 
100   PetscFunctionBegin;
101   ierr = PetscGetPetscDir(&pdir);if (ierr) PetscFunctionReturn(ierr);
102   sprintf(command,"cd %s; emacsclient --no-wait +%d %s\n",pdir,line,file);
103 #if defined(PETSC_HAVE_POPEN)
104   ierr = PetscPOpen(MPI_COMM_WORLD,(char*)ctx,command,"r",&fp);if (ierr) PetscFunctionReturn(ierr);
105   ierr = PetscPClose(MPI_COMM_WORLD,fp);if (ierr) PetscFunctionReturn(ierr);
106 #else
107   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP_SYS,"Cannot run external programs on this machine");
108 #endif
109   ierr = PetscPopErrorHandler();if (ierr) PetscFunctionReturn(ierr); /* remove this handler from the stack of handlers */
110   if (!eh) {
111     ierr = PetscTraceBackErrorHandler(comm,line,fun,file,n,p,mess,NULL);if (ierr) PetscFunctionReturn(ierr);
112   } else {
113     ierr = (*eh->handler)(comm,line,fun,file,n,p,mess,eh->ctx);if (ierr) PetscFunctionReturn(ierr);
114   }
115   PetscFunctionReturn(ierr);
116 }
117 
118 /*@C
119    PetscPushErrorHandler - Sets a routine to be called on detection of errors.
120 
121    Not Collective
122 
123    Input Parameters:
124 +  handler - error handler routine
125 -  ctx - optional handler context that contains information needed by the handler (for
126          example file pointers for error messages etc.)
127 
128    Calling sequence of handler:
129 $    int handler(MPI_Comm comm,int line,char *func,char *file,PetscErrorCode n,int p,char *mess,void *ctx);
130 
131 +  comm - communicator over which error occured
132 .  line - the line number of the error (indicated by __LINE__)
133 .  file - the file in which the error was detected (indicated by __FILE__)
134 .  n - the generic error number (see list defined in include/petscerror.h)
135 .  p - PETSC_ERROR_INITIAL if error just detected, otherwise PETSC_ERROR_REPEAT
136 .  mess - an error text string, usually just printed to the screen
137 -  ctx - the error handler context
138 
139    Options Database Keys:
140 +   -on_error_attach_debugger <noxterm,gdb or dbx>
141 -   -on_error_abort
142 
143    Level: intermediate
144 
145    Notes:
146    The currently available PETSc error handlers include PetscTraceBackErrorHandler(),
147    PetscAttachDebuggerErrorHandler(), PetscAbortErrorHandler(), and PetscMPIAbortErrorHandler(), PetscReturnErrorHandler().
148 
149    Fortran Notes:
150     You can only push one error handler from Fortran before poping it.
151 
152 .seealso: PetscPopErrorHandler(), PetscAttachDebuggerErrorHandler(), PetscAbortErrorHandler(), PetscTraceBackErrorHandler(), PetscPushSignalHandler()
153 
154 @*/
155 PetscErrorCode  PetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*),void *ctx)
156 {
157   EH             neweh;
158   PetscErrorCode ierr;
159 
160   PetscFunctionBegin;
161   ierr = PetscNew(&neweh);CHKERRQ(ierr);
162   if (eh) neweh->previous = eh;
163   else    neweh->previous = NULL;
164   neweh->handler = handler;
165   neweh->ctx     = ctx;
166   eh             = neweh;
167   PetscFunctionReturn(0);
168 }
169 
170 /*@
171    PetscPopErrorHandler - Removes the latest error handler that was
172    pushed with PetscPushErrorHandler().
173 
174    Not Collective
175 
176    Level: intermediate
177 
178 .seealso: PetscPushErrorHandler()
179 @*/
180 PetscErrorCode  PetscPopErrorHandler(void)
181 {
182   EH             tmp;
183   PetscErrorCode ierr;
184 
185   PetscFunctionBegin;
186   if (!eh) PetscFunctionReturn(0);
187   tmp  = eh;
188   eh   = eh->previous;
189   ierr = PetscFree(tmp);CHKERRQ(ierr);
190   PetscFunctionReturn(0);
191 }
192 
193 /*@C
194   PetscReturnErrorHandler - Error handler that causes a return to the current
195   level.
196 
197    Not Collective
198 
199    Input Parameters:
200 +  comm - communicator over which error occurred
201 .  line - the line number of the error (indicated by __LINE__)
202 .  file - the file in which the error was detected (indicated by __FILE__)
203 .  mess - an error text string, usually just printed to the screen
204 .  n - the generic error number
205 .  p - specific error number
206 -  ctx - error handler context
207 
208    Level: developer
209 
210    Notes:
211    Most users need not directly employ this routine and the other error
212    handlers, but can instead use the simplified interface SETERRQ, which has
213    the calling sequence
214 $     SETERRQ(comm,number,mess)
215 
216    Notes for experienced users:
217    This routine is good for catching errors such as zero pivots in preconditioners
218    or breakdown of iterative methods. It is not appropriate for memory violations
219    and similar errors.
220 
221    Use PetscPushErrorHandler() to set the desired error handler.  The
222    currently available PETSc error handlers include PetscTraceBackErrorHandler(),
223    PetscAttachDebuggerErrorHandler(), PetscAbortErrorHandler(), and PetscAbortErrorHandler()
224 
225 .seealso:  PetscPushErrorHandler(), PetscPopErrorHandler().
226  @*/
227 
228 PetscErrorCode  PetscReturnErrorHandler(MPI_Comm comm,int line,const char *fun,const char *file,PetscErrorCode n,PetscErrorType p,const char *mess,void *ctx)
229 {
230   PetscFunctionBegin;
231   PetscFunctionReturn(n);
232 }
233 
234 static char PetscErrorBaseMessage[1024];
235 /*
236        The numerical values for these are defined in include/petscerror.h; any changes
237    there must also be made here
238 */
239 static const char *PetscErrorStrings[] = {
240   /*55 */ "Out of memory",
241           "No support for this operation for this object type",
242           "No support for this operation on this system",
243   /*58 */ "Operation done in wrong order",
244   /*59 */ "Signal received",
245   /*60 */ "Nonconforming object sizes",
246           "Argument aliasing not permitted",
247           "Invalid argument",
248   /*63 */ "Argument out of range",
249           "Corrupt argument: https://www.mcs.anl.gov/petsc/documentation/faq.html#valgrind",
250           "Unable to open file",
251           "Read from file failed",
252           "Write to file failed",
253           "Invalid pointer",
254   /*69 */ "Arguments must have same type",
255   /*70 */ "Attempt to use a pointer that does not point to a valid accessible location",
256   /*71 */ "Zero pivot in LU factorization: https://www.mcs.anl.gov/petsc/documentation/faq.html#zeropivot",
257   /*72 */ "Floating point exception",
258   /*73 */ "Object is in wrong state",
259           "Corrupted Petsc object",
260           "Arguments are incompatible",
261           "Error in external library",
262   /*77 */ "Petsc has generated inconsistent data",
263           "Memory corruption: https://www.mcs.anl.gov/petsc/documentation/installation.html#valgrind",
264           "Unexpected data in file",
265   /*80 */ "Arguments must have same communicators",
266   /*81 */ "Zero pivot in Cholesky factorization: https://www.mcs.anl.gov/petsc/documentation/faq.html#zeropivot",
267           "  ",
268           "  ",
269           "Overflow in integer operation: https://www.mcs.anl.gov/petsc/documentation/faq.html#64-bit-indices",
270   /*85 */ "Null argument, when expecting valid pointer",
271   /*86 */ "Unknown type. Check for miss-spelling or missing package: https://www.mcs.anl.gov/petsc/documentation/installation.html#external",
272   /*87 */ "MPI library at runtime is not compatible with MPI used at compile time",
273   /*88 */ "Error in system call",
274   /*89 */ "Object Type not set: https://www.mcs.anl.gov/petsc/documentation/faq.html#objecttypenotset",
275   /*90 */ "  ",
276   /*   */ "  ",
277   /*92 */ "See https://www.mcs.anl.gov/petsc/documentation/linearsolvertable.html for possible LU and Cholesky solvers",
278   /*93 */ "You cannot overwrite this option since that will conflict with other previously set options",
279   /*94 */ "Example/application run with number of MPI ranks it does not support",
280   /*95 */ "Missing or incorrect user input ",
281   /*96 */ "GPU resources unavailable ",
282 };
283 
284 /*@C
285    PetscErrorMessage - returns the text string associated with a PETSc error code.
286 
287    Not Collective
288 
289    Input Parameter:
290 .   errnum - the error code
291 
292    Output Parameter:
293 +  text - the error message (NULL if not desired)
294 -  specific - the specific error message that was set with SETERRxxx() or PetscError().  (NULL if not desired)
295 
296    Level: developer
297 
298 .seealso:  PetscPushErrorHandler(), PetscAttachDebuggerErrorHandler(), PetscError(), SETERRQ(), CHKERRQ()
299           PetscAbortErrorHandler(), PetscTraceBackErrorHandler()
300  @*/
301 PetscErrorCode  PetscErrorMessage(int errnum,const char *text[],char **specific)
302 {
303   PetscFunctionBegin;
304   if (text && errnum > PETSC_ERR_MIN_VALUE && errnum < PETSC_ERR_MAX_VALUE) *text = PetscErrorStrings[errnum-PETSC_ERR_MIN_VALUE-1];
305   else if (text) *text = NULL;
306 
307   if (specific) *specific = PetscErrorBaseMessage;
308   PetscFunctionReturn(0);
309 }
310 
311 #if defined(PETSC_CLANGUAGE_CXX)
312 /* C++ exceptions are formally not allowed to propagate through extern "C" code. In practice, far too much software
313  * would be broken if implementations did not handle it it some common cases. However, keep in mind
314  *
315  *   Rule 62. Don't allow exceptions to propagate across module boundaries
316  *
317  * in "C++ Coding Standards" by Sutter and Alexandrescu. (This accounts for part of the ongoing C++ binary interface
318  * instability.) Having PETSc raise errors as C++ exceptions was probably misguided and should eventually be removed.
319  *
320  * Here is the problem: You have a C++ function call a PETSc function, and you would like to maintain the error message
321  * and stack information from the PETSc error. You could make everyone write exactly this code in their C++, but that
322  * seems crazy to me.
323  */
324 #include <sstream>
325 #include <stdexcept>
326 static void PetscCxxErrorThrow() {
327   const char *str;
328   if (eh && eh->ctx) {
329     std::ostringstream *msg;
330     msg = (std::ostringstream*) eh->ctx;
331     str = msg->str().c_str();
332   } else str = "Error detected in C PETSc";
333 
334   throw std::runtime_error(str);
335 }
336 #endif
337 
338 /*@C
339    PetscError - Routine that is called when an error has been detected,
340    usually called through the macro SETERRQ(PETSC_COMM_SELF,).
341 
342    Not Collective
343 
344    Input Parameters:
345 +  comm - communicator over which error occurred.  ALL ranks of this communicator MUST call this routine
346 .  line - the line number of the error (indicated by __LINE__)
347 .  func - the function name in which the error was detected
348 .  file - the file in which the error was detected (indicated by __FILE__)
349 .  n - the generic error number
350 .  p - PETSC_ERROR_INITIAL indicates the error was initially detected, PETSC_ERROR_REPEAT indicates this is a traceback from a previously detected error
351 -  mess - formatted message string - aka printf
352 
353   Level: intermediate
354 
355    Notes:
356    Most users need not directly use this routine and the error handlers, but
357    can instead use the simplified interface SETERRQ, which has the calling
358    sequence
359 $     SETERRQ(comm,n,mess)
360 
361    Fortran Note:
362    This routine is used differently from Fortran
363 $    PetscError(MPI_Comm comm,PetscErrorCode n,PetscErrorType p,char *message)
364 
365    Experienced users can set the error handler with PetscPushErrorHandler().
366 
367    Developer Note: Since this is called after an error condition it should not be calling any error handlers (currently it ignores any error codes)
368    BUT this routine does call regular PETSc functions that may call error handlers, this is problematic and could be fixed by never calling other PETSc routines
369    but this annoying.
370 
371 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), SETERRQ(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), PetscErrorMessage(), PETSCABORT()
372 @*/
373 PetscErrorCode PetscError(MPI_Comm comm,int line,const char *func,const char *file,PetscErrorCode n,PetscErrorType p,const char *mess,...)
374 {
375   va_list        Argp;
376   size_t         fullLength;
377   char           buf[2048],*lbuf = NULL;
378   PetscBool      ismain;
379   PetscErrorCode ierr;
380 
381   PetscFunctionBegin;
382   if (!func) func = "User provided function";
383   if (!file) file = "User file";
384   if (comm == MPI_COMM_NULL) comm = PETSC_COMM_SELF;
385 
386   /* Compose the message evaluating the print format */
387   if (mess) {
388     va_start(Argp,mess);
389     PetscVSNPrintf(buf,2048,mess,&fullLength,Argp);
390     va_end(Argp);
391     lbuf = buf;
392     if (p == PETSC_ERROR_INITIAL) PetscStrncpy(PetscErrorBaseMessage,lbuf,1023);
393   }
394 
395   if (!eh) ierr = PetscTraceBackErrorHandler(comm,line,func,file,n,p,lbuf,NULL);
396   else     ierr = (*eh->handler)(comm,line,func,file,n,p,lbuf,eh->ctx);
397 
398   /*
399       If this is called from the main() routine we call MPI_Abort() instead of
400     return to allow the parallel program to be properly shutdown.
401 
402     Does not call PETSCABORT() since that would provide the wrong source file and line number information
403   */
404   PetscStrncmp(func,"main",4,&ismain);
405   if (ismain) {
406     PetscMPIInt errcode;
407     errcode = (PetscMPIInt)(0 + line*1000 + ierr);
408     if (petscwaitonerror) {PetscSleep(1000);}
409     MPI_Abort(comm,errcode);
410   }
411 
412 #if defined(PETSC_CLANGUAGE_CXX)
413   if (p == PETSC_ERROR_IN_CXX) {
414     PetscCxxErrorThrow();
415   }
416 #endif
417   PetscFunctionReturn(ierr);
418 }
419 
420 /* -------------------------------------------------------------------------*/
421 
422 /*@C
423     PetscIntView - Prints an array of integers; useful for debugging.
424 
425     Collective on PetscViewer
426 
427     Input Parameters:
428 +   N - number of integers in array
429 .   idx - array of integers
430 -   viewer - location to print array,  PETSC_VIEWER_STDOUT_WORLD, PETSC_VIEWER_STDOUT_SELF or 0
431 
432   Level: intermediate
433 
434     Developer Notes:
435     idx cannot be const because may be passed to binary viewer where byte swapping is done
436 
437 .seealso: PetscRealView()
438 @*/
439 PetscErrorCode  PetscIntView(PetscInt N,const PetscInt idx[],PetscViewer viewer)
440 {
441   PetscErrorCode ierr;
442   PetscMPIInt    rank,size;
443   PetscInt       j,i,n = N/20,p = N % 20;
444   PetscBool      iascii,isbinary;
445   MPI_Comm       comm;
446 
447   PetscFunctionBegin;
448   if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF;
449   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,3);
450   if (N) PetscValidIntPointer(idx,2);
451   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
452   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
453   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
454 
455   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
456   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
457   if (iascii) {
458     ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
459     for (i=0; i<n; i++) {
460       if (size > 1) {
461         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %D:", rank, 20*i);CHKERRQ(ierr);
462       } else {
463         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%D:",20*i);CHKERRQ(ierr);
464       }
465       for (j=0; j<20; j++) {
466         ierr = PetscViewerASCIISynchronizedPrintf(viewer," %D",idx[i*20+j]);CHKERRQ(ierr);
467       }
468       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"\n");CHKERRQ(ierr);
469     }
470     if (p) {
471       if (size > 1) {
472         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %D:",rank ,20*n);CHKERRQ(ierr);
473       } else {
474         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%D:",20*n);CHKERRQ(ierr);
475       }
476       for (i=0; i<p; i++) { ierr = PetscViewerASCIISynchronizedPrintf(viewer," %D",idx[20*n+i]);CHKERRQ(ierr);}
477       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"\n");CHKERRQ(ierr);
478     }
479     ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
480     ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
481   } else if (isbinary) {
482     PetscMPIInt *sizes,Ntotal,*displs,NN;
483     PetscInt    *array;
484 
485     ierr = PetscMPIIntCast(N,&NN);CHKERRQ(ierr);
486 
487     if (size > 1) {
488       if (rank) {
489         ierr = MPI_Gather(&NN,1,MPI_INT,NULL,0,MPI_INT,0,comm);CHKERRQ(ierr);
490         ierr = MPI_Gatherv((void*)idx,NN,MPIU_INT,NULL,NULL,NULL,MPIU_INT,0,comm);CHKERRQ(ierr);
491       } else {
492         ierr      = PetscMalloc1(size,&sizes);CHKERRQ(ierr);
493         ierr      = MPI_Gather(&NN,1,MPI_INT,sizes,1,MPI_INT,0,comm);CHKERRQ(ierr);
494         Ntotal    = sizes[0];
495         ierr      = PetscMalloc1(size,&displs);CHKERRQ(ierr);
496         displs[0] = 0;
497         for (i=1; i<size; i++) {
498           Ntotal   += sizes[i];
499           displs[i] =  displs[i-1] + sizes[i-1];
500         }
501         ierr = PetscMalloc1(Ntotal,&array);CHKERRQ(ierr);
502         ierr = MPI_Gatherv((void*)idx,NN,MPIU_INT,array,sizes,displs,MPIU_INT,0,comm);CHKERRQ(ierr);
503         ierr = PetscViewerBinaryWrite(viewer,array,Ntotal,PETSC_INT);CHKERRQ(ierr);
504         ierr = PetscFree(sizes);CHKERRQ(ierr);
505         ierr = PetscFree(displs);CHKERRQ(ierr);
506         ierr = PetscFree(array);CHKERRQ(ierr);
507       }
508     } else {
509       ierr = PetscViewerBinaryWrite(viewer,idx,N,PETSC_INT);CHKERRQ(ierr);
510     }
511   } else {
512     const char *tname;
513     ierr = PetscObjectGetName((PetscObject)viewer,&tname);CHKERRQ(ierr);
514     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Cannot handle that PetscViewer of type %s",tname);
515   }
516   PetscFunctionReturn(0);
517 }
518 
519 /*@C
520     PetscRealView - Prints an array of doubles; useful for debugging.
521 
522     Collective on PetscViewer
523 
524     Input Parameters:
525 +   N - number of PetscReal in array
526 .   idx - array of PetscReal
527 -   viewer - location to print array,  PETSC_VIEWER_STDOUT_WORLD, PETSC_VIEWER_STDOUT_SELF or 0
528 
529   Level: intermediate
530 
531     Developer Notes:
532     idx cannot be const because may be passed to binary viewer where byte swapping is done
533 
534 .seealso: PetscIntView()
535 @*/
536 PetscErrorCode  PetscRealView(PetscInt N,const PetscReal idx[],PetscViewer viewer)
537 {
538   PetscErrorCode ierr;
539   PetscMPIInt    rank,size;
540   PetscInt       j,i,n = N/5,p = N % 5;
541   PetscBool      iascii,isbinary;
542   MPI_Comm       comm;
543 
544   PetscFunctionBegin;
545   if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF;
546   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,3);
547   PetscValidScalarPointer(idx,2);
548   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
549   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
550   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
551 
552   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
553   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
554   if (iascii) {
555     PetscInt tab;
556 
557     ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
558     ierr = PetscViewerASCIIGetTab(viewer, &tab);CHKERRQ(ierr);
559     for (i=0; i<n; i++) {
560       ierr = PetscViewerASCIISetTab(viewer, tab);CHKERRQ(ierr);
561       if (size > 1) {
562         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %2d:",rank ,(int)5*i);CHKERRQ(ierr);
563       } else {
564         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%2d:",(int)5*i);CHKERRQ(ierr);
565       }
566       ierr = PetscViewerASCIISetTab(viewer, 0);CHKERRQ(ierr);
567       for (j=0; j<5; j++) {
568         ierr = PetscViewerASCIISynchronizedPrintf(viewer," %12.4e",(double)idx[i*5+j]);CHKERRQ(ierr);
569       }
570       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"\n");CHKERRQ(ierr);
571     }
572     if (p) {
573       ierr = PetscViewerASCIISetTab(viewer, tab);CHKERRQ(ierr);
574       if (size > 1) {
575         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %2d:",rank ,(int)5*n);CHKERRQ(ierr);
576       } else {
577         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%2d:",(int)5*n);CHKERRQ(ierr);
578       }
579       ierr = PetscViewerASCIISetTab(viewer, 0);CHKERRQ(ierr);
580       for (i=0; i<p; i++) { PetscViewerASCIISynchronizedPrintf(viewer," %12.4e",(double)idx[5*n+i]);CHKERRQ(ierr);}
581       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"\n");CHKERRQ(ierr);
582     }
583     ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
584     ierr = PetscViewerASCIISetTab(viewer, tab);CHKERRQ(ierr);
585     ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
586   } else if (isbinary) {
587     PetscMPIInt *sizes,*displs, Ntotal,NN;
588     PetscReal   *array;
589 
590     ierr = PetscMPIIntCast(N,&NN);CHKERRQ(ierr);
591 
592     if (size > 1) {
593       if (rank) {
594         ierr = MPI_Gather(&NN,1,MPI_INT,NULL,0,MPI_INT,0,comm);CHKERRQ(ierr);
595         ierr = MPI_Gatherv((PetscReal*)idx,NN,MPIU_REAL,NULL,NULL,NULL,MPIU_REAL,0,comm);CHKERRQ(ierr);
596       } else {
597         ierr      = PetscMalloc1(size,&sizes);CHKERRQ(ierr);
598         ierr      = MPI_Gather(&NN,1,MPI_INT,sizes,1,MPI_INT,0,comm);CHKERRQ(ierr);
599         Ntotal    = sizes[0];
600         ierr      = PetscMalloc1(size,&displs);CHKERRQ(ierr);
601         displs[0] = 0;
602         for (i=1; i<size; i++) {
603           Ntotal   += sizes[i];
604           displs[i] =  displs[i-1] + sizes[i-1];
605         }
606         ierr = PetscMalloc1(Ntotal,&array);CHKERRQ(ierr);
607         ierr = MPI_Gatherv((PetscReal*)idx,NN,MPIU_REAL,array,sizes,displs,MPIU_REAL,0,comm);CHKERRQ(ierr);
608         ierr = PetscViewerBinaryWrite(viewer,array,Ntotal,PETSC_REAL);CHKERRQ(ierr);
609         ierr = PetscFree(sizes);CHKERRQ(ierr);
610         ierr = PetscFree(displs);CHKERRQ(ierr);
611         ierr = PetscFree(array);CHKERRQ(ierr);
612       }
613     } else {
614       ierr = PetscViewerBinaryWrite(viewer,(void*) idx,N,PETSC_REAL);CHKERRQ(ierr);
615     }
616   } else {
617     const char *tname;
618     ierr = PetscObjectGetName((PetscObject)viewer,&tname);CHKERRQ(ierr);
619     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Cannot handle that PetscViewer of type %s",tname);
620   }
621   PetscFunctionReturn(0);
622 }
623 
624 /*@C
625     PetscScalarView - Prints an array of scalars; useful for debugging.
626 
627     Collective on PetscViewer
628 
629     Input Parameters:
630 +   N - number of scalars in array
631 .   idx - array of scalars
632 -   viewer - location to print array,  PETSC_VIEWER_STDOUT_WORLD, PETSC_VIEWER_STDOUT_SELF or 0
633 
634   Level: intermediate
635 
636     Developer Notes:
637     idx cannot be const because may be passed to binary viewer where byte swapping is done
638 
639 .seealso: PetscIntView(), PetscRealView()
640 @*/
641 PetscErrorCode  PetscScalarView(PetscInt N,const PetscScalar idx[],PetscViewer viewer)
642 {
643   PetscErrorCode ierr;
644   PetscMPIInt    rank,size;
645   PetscInt       j,i,n = N/3,p = N % 3;
646   PetscBool      iascii,isbinary;
647   MPI_Comm       comm;
648 
649   PetscFunctionBegin;
650   if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF;
651   PetscValidHeader(viewer,3);
652   if (N) PetscValidScalarPointer(idx,2);
653   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
654   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
655   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
656 
657   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
658   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
659   if (iascii) {
660     ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
661     for (i=0; i<n; i++) {
662       if (size > 1) {
663         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %2d:",rank ,3*i);CHKERRQ(ierr);
664       } else {
665         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%2d:",3*i);CHKERRQ(ierr);
666       }
667       for (j=0; j<3; j++) {
668 #if defined(PETSC_USE_COMPLEX)
669         ierr = PetscViewerASCIISynchronizedPrintf(viewer," (%12.4e,%12.4e)", (double)PetscRealPart(idx[i*3+j]),(double)PetscImaginaryPart(idx[i*3+j]));CHKERRQ(ierr);
670 #else
671         ierr = PetscViewerASCIISynchronizedPrintf(viewer," %12.4e",(double)idx[i*3+j]);CHKERRQ(ierr);
672 #endif
673       }
674       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"\n");CHKERRQ(ierr);
675     }
676     if (p) {
677       if (size > 1) {
678         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %2d:",rank ,3*n);CHKERRQ(ierr);
679       } else {
680         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%2d:",3*n);CHKERRQ(ierr);
681       }
682       for (i=0; i<p; i++) {
683 #if defined(PETSC_USE_COMPLEX)
684         ierr = PetscViewerASCIISynchronizedPrintf(viewer," (%12.4e,%12.4e)", (double)PetscRealPart(idx[n*3+i]),(double)PetscImaginaryPart(idx[n*3+i]));CHKERRQ(ierr);
685 #else
686         ierr = PetscViewerASCIISynchronizedPrintf(viewer," %12.4e",(double)idx[3*n+i]);CHKERRQ(ierr);
687 #endif
688       }
689       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"\n");CHKERRQ(ierr);
690     }
691     ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
692     ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
693   } else if (isbinary) {
694     PetscMPIInt *sizes,Ntotal,*displs,NN;
695     PetscScalar *array;
696 
697     ierr = PetscMPIIntCast(N,&NN);CHKERRQ(ierr);
698 
699     if (size > 1) {
700       if (rank) {
701         ierr = MPI_Gather(&NN,1,MPI_INT,NULL,0,MPI_INT,0,comm);CHKERRQ(ierr);
702         ierr = MPI_Gatherv((void*)idx,NN,MPIU_SCALAR,NULL,NULL,NULL,MPIU_SCALAR,0,comm);CHKERRQ(ierr);
703       } else {
704         ierr      = PetscMalloc1(size,&sizes);CHKERRQ(ierr);
705         ierr      = MPI_Gather(&NN,1,MPI_INT,sizes,1,MPI_INT,0,comm);CHKERRQ(ierr);
706         Ntotal    = sizes[0];
707         ierr      = PetscMalloc1(size,&displs);CHKERRQ(ierr);
708         displs[0] = 0;
709         for (i=1; i<size; i++) {
710           Ntotal   += sizes[i];
711           displs[i] =  displs[i-1] + sizes[i-1];
712         }
713         ierr = PetscMalloc1(Ntotal,&array);CHKERRQ(ierr);
714         ierr = MPI_Gatherv((void*)idx,NN,MPIU_SCALAR,array,sizes,displs,MPIU_SCALAR,0,comm);CHKERRQ(ierr);
715         ierr = PetscViewerBinaryWrite(viewer,array,Ntotal,PETSC_SCALAR);CHKERRQ(ierr);
716         ierr = PetscFree(sizes);CHKERRQ(ierr);
717         ierr = PetscFree(displs);CHKERRQ(ierr);
718         ierr = PetscFree(array);CHKERRQ(ierr);
719       }
720     } else {
721       ierr = PetscViewerBinaryWrite(viewer,(void*) idx,N,PETSC_SCALAR);CHKERRQ(ierr);
722     }
723   } else {
724     const char *tname;
725     ierr = PetscObjectGetName((PetscObject)viewer,&tname);CHKERRQ(ierr);
726     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Cannot handle that PetscViewer of type %s",tname);
727   }
728   PetscFunctionReturn(0);
729 }
730 
731 #if defined(PETSC_HAVE_CUDA)
732 #include <petsccublas.h>
733 PETSC_EXTERN const char* PetscCUBLASGetErrorName(cublasStatus_t status)
734 {
735   switch(status) {
736 #if (CUDART_VERSION >= 8000) /* At least CUDA 8.0 of Sep. 2016 had these */
737     case CUBLAS_STATUS_SUCCESS:          return "CUBLAS_STATUS_SUCCESS";
738     case CUBLAS_STATUS_NOT_INITIALIZED:  return "CUBLAS_STATUS_NOT_INITIALIZED";
739     case CUBLAS_STATUS_ALLOC_FAILED:     return "CUBLAS_STATUS_ALLOC_FAILED";
740     case CUBLAS_STATUS_INVALID_VALUE:    return "CUBLAS_STATUS_INVALID_VALUE";
741     case CUBLAS_STATUS_ARCH_MISMATCH:    return "CUBLAS_STATUS_ARCH_MISMATCH";
742     case CUBLAS_STATUS_MAPPING_ERROR:    return "CUBLAS_STATUS_MAPPING_ERROR";
743     case CUBLAS_STATUS_EXECUTION_FAILED: return "CUBLAS_STATUS_EXECUTION_FAILED";
744     case CUBLAS_STATUS_INTERNAL_ERROR:   return "CUBLAS_STATUS_INTERNAL_ERROR";
745     case CUBLAS_STATUS_NOT_SUPPORTED:    return "CUBLAS_STATUS_NOT_SUPPORTED";
746     case CUBLAS_STATUS_LICENSE_ERROR:    return "CUBLAS_STATUS_LICENSE_ERROR";
747 #endif
748     default:                             return "unknown error";
749   }
750 }
751 #endif
752