Actual source code: err.c

petsc-master 2020-11-24
Report Typos and Errors

  2: /*
  3:       Code that allows one to set the error handlers
  4: */
  5: #include <petsc/private/petscimpl.h>
  6: #include <petscviewer.h>

  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: };

 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];

 37:   *idx = 1;
 38:   for (i=2; i<n; i++) {
 39:     PetscFixFilename(PetscAbortSourceFiles[i],subpath);
 40:     PetscStrendswith(filepath,subpath,&match);
 41:     if (match) {*idx = i; break;}
 42:   }
 43:   return(0);
 44: }

 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: };

 53: static EH eh = NULL;

 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.

 59:    Not Collective

 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

 70:    Options Database Key:
 71: .   -on_error_emacs <machinename>

 73:    Level: developer

 75:    Notes:
 76:    You must put (server-start) in your .emacs file for the emacsclient software to work

 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)

 83:    Notes for experienced users:
 84:    Use PetscPushErrorHandler() to set the desired error handler.

 86:    Developer Note:
 87:    Since this is an error handler it cannot call CHKERRQ(); thus we just return if an error is detected.


 90: .seealso: PetscError(), PetscPushErrorHandler(), PetscPopErrorHandler(), PetscAttachDebuggerErrorHandler(),
 91:           PetscAbortErrorHandler(), PetscMPIAbortErrorHandler(), PetscTraceBackErrorHandler(), PetscReturnErrorHandler()
 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: {
 96:   char           command[PETSC_MAX_PATH_LEN];
 97:   const char     *pdir;
 98:   FILE           *fp;

101:   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:   PetscPOpen(MPI_COMM_WORLD,(char*)ctx,command,"r",&fp);if (ierr) PetscFunctionReturn(ierr);
105:   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:   PetscPopErrorHandler();if (ierr) PetscFunctionReturn(ierr); /* remove this handler from the stack of handlers */
110:   if (!eh) {
111:     PetscTraceBackErrorHandler(comm,line,fun,file,n,p,mess,NULL);if (ierr) PetscFunctionReturn(ierr);
112:   } else {
113:     (*eh->handler)(comm,line,fun,file,n,p,mess,eh->ctx);if (ierr) PetscFunctionReturn(ierr);
114:   }
115:   PetscFunctionReturn(ierr);
116: }

118: /*@C
119:    PetscPushErrorHandler - Sets a routine to be called on detection of errors.

121:    Not Collective

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.)

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);

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

139:    Options Database Keys:
140: +   -on_error_attach_debugger <noxterm,gdb or dbx>
141: -   -on_error_abort

143:    Level: intermediate

145:    Notes:
146:    The currently available PETSc error handlers include PetscTraceBackErrorHandler(),
147:    PetscAttachDebuggerErrorHandler(), PetscAbortErrorHandler(), and PetscMPIAbortErrorHandler(), PetscReturnErrorHandler().

149:    Fortran Notes:
150:     You can only push one error handler from Fortran before poping it.

152: .seealso: PetscPopErrorHandler(), PetscAttachDebuggerErrorHandler(), PetscAbortErrorHandler(), PetscTraceBackErrorHandler(), PetscPushSignalHandler()

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;

161:   PetscNew(&neweh);
162:   if (eh) neweh->previous = eh;
163:   else    neweh->previous = NULL;
164:   neweh->handler = handler;
165:   neweh->ctx     = ctx;
166:   eh             = neweh;
167:   return(0);
168: }

170: /*@
171:    PetscPopErrorHandler - Removes the latest error handler that was
172:    pushed with PetscPushErrorHandler().

174:    Not Collective

176:    Level: intermediate

178: .seealso: PetscPushErrorHandler()
179: @*/
180: PetscErrorCode  PetscPopErrorHandler(void)
181: {
182:   EH             tmp;

186:   if (!eh) return(0);
187:   tmp  = eh;
188:   eh   = eh->previous;
189:   PetscFree(tmp);
190:   return(0);
191: }

193: /*@C
194:   PetscReturnErrorHandler - Error handler that causes a return without printing an error message.

196:    Not Collective

198:    Input Parameters:
199: +  comm - communicator over which error occurred
200: .  line - the line number of the error (indicated by __LINE__)
201: .  file - the file in which the error was detected (indicated by __FILE__)
202: .  mess - an error text string, usually just printed to the screen
203: .  n - the generic error number
204: .  p - specific error number
205: -  ctx - error handler context

207:    Level: developer

209:    Notes:
210:    Most users need not directly employ this routine and the other error
211:    handlers, but can instead use the simplified interface SETERRQ, which has
212:    the calling sequence
213: $     SETERRQ(comm,number,mess)

215:    PetscIgnoreErrorHandler() does the same thing as this function, but is deprecated, you should use this function.

217:    Use PetscPushErrorHandler() to set the desired error handler.

219: .seealso:  PetscPushErrorHandler(), PetscPopErrorHandler(), PetscError(), PetscAbortErrorHandler(), PetscMPIAbortErrorHandler(), PetscTraceBackErrorHandler(),
220:            PetscAttachDebuggerErrorHandler(), PetscEmacsClientErrorHandler()
221:  @*/
222: PetscErrorCode  PetscReturnErrorHandler(MPI_Comm comm,int line,const char *fun,const char *file,PetscErrorCode n,PetscErrorType p,const char *mess,void *ctx)
223: {
225:   PetscFunctionReturn(n);
226: }

228: static char PetscErrorBaseMessage[1024];
229: /*
230:        The numerical values for these are defined in include/petscerror.h; any changes
231:    there must also be made here
232: */
233: static const char *PetscErrorStrings[] = {
234:   /*55 */ "Out of memory",
235:           "No support for this operation for this object type",
236:           "No support for this operation on this system",
237:   /*58 */ "Operation done in wrong order",
238:   /*59 */ "Signal received",
239:   /*60 */ "Nonconforming object sizes",
240:           "Argument aliasing not permitted",
241:           "Invalid argument",
242:   /*63 */ "Argument out of range",
243:           "Corrupt argument: https://www.mcs.anl.gov/petsc/documentation/faq.html#valgrind",
244:           "Unable to open file",
245:           "Read from file failed",
246:           "Write to file failed",
247:           "Invalid pointer",
248:   /*69 */ "Arguments must have same type",
249:   /*70 */ "Attempt to use a pointer that does not point to a valid accessible location",
250:   /*71 */ "Zero pivot in LU factorization: https://www.mcs.anl.gov/petsc/documentation/faq.html#zeropivot",
251:   /*72 */ "Floating point exception",
252:   /*73 */ "Object is in wrong state",
253:           "Corrupted Petsc object",
254:           "Arguments are incompatible",
255:           "Error in external library",
256:   /*77 */ "Petsc has generated inconsistent data",
257:           "Memory corruption: https://www.mcs.anl.gov/petsc/documentation/installation.html#valgrind",
258:           "Unexpected data in file",
259:   /*80 */ "Arguments must have same communicators",
260:   /*81 */ "Zero pivot in Cholesky factorization: https://www.mcs.anl.gov/petsc/documentation/faq.html#zeropivot",
261:           "  ",
262:           "  ",
263:           "Overflow in integer operation: https://www.mcs.anl.gov/petsc/documentation/faq.html#64-bit-indices",
264:   /*85 */ "Null argument, when expecting valid pointer",
265:   /*86 */ "Unknown type. Check for miss-spelling or missing package: https://www.mcs.anl.gov/petsc/documentation/installation.html#external",
266:   /*87 */ "MPI library at runtime is not compatible with MPI used at compile time",
267:   /*88 */ "Error in system call",
268:   /*89 */ "Object Type not set: https://www.mcs.anl.gov/petsc/documentation/faq.html#objecttypenotset",
269:   /*90 */ "  ",
270:   /*   */ "  ",
271:   /*92 */ "See https://www.mcs.anl.gov/petsc/documentation/linearsolvertable.html for possible LU and Cholesky solvers",
272:   /*93 */ "You cannot overwrite this option since that will conflict with other previously set options",
273:   /*94 */ "Example/application run with number of MPI ranks it does not support",
274:   /*95 */ "Missing or incorrect user input ",
275:   /*96 */ "GPU resources unavailable ",
276:   /*97 */ "GPU error ",
277: };

279: /*@C
280:    PetscErrorMessage - returns the text string associated with a PETSc error code.

282:    Not Collective

284:    Input Parameter:
285: .   errnum - the error code

287:    Output Parameter:
288: +  text - the error message (NULL if not desired)
289: -  specific - the specific error message that was set with SETERRxxx() or PetscError().  (NULL if not desired)

291:    Level: developer

293: .seealso:  PetscPushErrorHandler(), PetscAttachDebuggerErrorHandler(), PetscError(), SETERRQ(), CHKERRQ()
294:           PetscAbortErrorHandler(), PetscTraceBackErrorHandler()
295:  @*/
296: PetscErrorCode  PetscErrorMessage(int errnum,const char *text[],char **specific)
297: {
299:   if (text && errnum > PETSC_ERR_MIN_VALUE && errnum < PETSC_ERR_MAX_VALUE) *text = PetscErrorStrings[errnum-PETSC_ERR_MIN_VALUE-1];
300:   else if (text) *text = NULL;

302:   if (specific) *specific = PetscErrorBaseMessage;
303:   return(0);
304: }

306: #if defined(PETSC_CLANGUAGE_CXX)
307: /* C++ exceptions are formally not allowed to propagate through extern "C" code. In practice, far too much software
308:  * would be broken if implementations did not handle it it some common cases. However, keep in mind
309:  *
310:  *   Rule 62. Don't allow exceptions to propagate across module boundaries
311:  *
312:  * in "C++ Coding Standards" by Sutter and Alexandrescu. (This accounts for part of the ongoing C++ binary interface
313:  * instability.) Having PETSc raise errors as C++ exceptions was probably misguided and should eventually be removed.
314:  *
315:  * Here is the problem: You have a C++ function call a PETSc function, and you would like to maintain the error message
316:  * and stack information from the PETSc error. You could make everyone write exactly this code in their C++, but that
317:  * seems crazy to me.
318:  */
319: #include <sstream>
320: #include <stdexcept>
321: static void PetscCxxErrorThrow() {
322:   const char *str;
323:   if (eh && eh->ctx) {
324:     std::ostringstream *msg;
325:     msg = (std::ostringstream*) eh->ctx;
326:     str = msg->str().c_str();
327:   } else str = "Error detected in C PETSc";

329:   throw std::runtime_error(str);
330: }
331: #endif

333: /*@C
334:    PetscError - Routine that is called when an error has been detected, usually called through the macro SETERRQ(PETSC_COMM_SELF,).

336:   Collective on comm

338:    Input Parameters:
339: +  comm - communicator over which error occurred.  ALL ranks of this communicator MUST call this routine
340: .  line - the line number of the error (indicated by __LINE__)
341: .  func - the function name in which the error was detected
342: .  file - the file in which the error was detected (indicated by __FILE__)
343: .  n - the generic error number
344: .  p - PETSC_ERROR_INITIAL indicates the error was initially detected, PETSC_ERROR_REPEAT indicates this is a traceback from a previously detected error
345: -  mess - formatted message string - aka printf

347:   Options Database:
348: +  -error_output_stdout - output the error messages to stdout instead of the default stderr
349: -  -error_output_none - do not output the error messages

351:   Level: intermediate

353:    Notes:
354:    PETSc error handling is done with error return codes. A non-zero return indicates an error was detected. Errors are generally not something that the code
355:    can recover from. Note that numerical errors (potential divide by zero, for example) are not managed by the error return codes; they are managed via, for example,
356:    KSPGetConvergedReason() that indicates if the solve was successful or not. The option -ksp_error_if_not_converged, for example, turns numerical failures into
357:    hard errors managed via PetscError().

359:    PETSc provides a rich supply of error handlers, see the list below, and users can also provide their own error handlers.

361:    Most users need not directly use this routine and the error handlers, but
362:    can instead use the simplified interface SETERRQ, which has the calling
363:    sequence
364: $     SETERRQ(comm,n,mess)

366:    Fortran Note:
367:    This routine is used differently from Fortran
368: $    PetscError(MPI_Comm comm,PetscErrorCode n,PetscErrorType p,char *message)

370:    Set the error handler with PetscPushErrorHandler().

372:    Developer Note: Since this is called after an error condition it should not be calling any error handlers (currently it ignores any error codes)
373:    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
374:    but this annoying.

376: .seealso: PetscErrorCode, PetscPushErrorHandler(), PetscPopErrorHandler(), PetscTraceBackErrorHandler(),  PetscAbortErrorHandler(), PetscMPIAbortErrorHandler(),
377:           PetscReturnErrorHandler(), PetscAttachDebuggerErrorHandler(), PetscEmacsClientErrorHandler(),
378:           SETERRQ(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), PetscErrorMessage(), PETSCABORT()
379: @*/
380: PetscErrorCode PetscError(MPI_Comm comm,int line,const char *func,const char *file,PetscErrorCode n,PetscErrorType p,const char *mess,...)
381: {
382:   va_list        Argp;
383:   size_t         fullLength;
384:   char           buf[2048],*lbuf = NULL;
385:   PetscBool      ismain;

389:   if (!func) func = "User provided function";
390:   if (!file) file = "User file";
391:   if (comm == MPI_COMM_NULL) comm = PETSC_COMM_SELF;

393:   /* Compose the message evaluating the print format */
394:   if (mess) {
395:     va_start(Argp,mess);
396:     PetscVSNPrintf(buf,2048,mess,&fullLength,Argp);
397:     va_end(Argp);
398:     lbuf = buf;
399:     if (p == PETSC_ERROR_INITIAL) PetscStrncpy(PetscErrorBaseMessage,lbuf,1023);
400:   }

402:   if (p == PETSC_ERROR_INITIAL && n != PETSC_ERR_MEMC) PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__);

404:   if (!eh) PetscTraceBackErrorHandler(comm,line,func,file,n,p,lbuf,NULL);
405:   else     (*eh->handler)(comm,line,func,file,n,p,lbuf,eh->ctx);

407:   /*
408:       If this is called from the main() routine we call MPI_Abort() instead of
409:     return to allow the parallel program to be properly shutdown.

411:     Does not call PETSCABORT() since that would provide the wrong source file and line number information
412:   */
413:   PetscStrncmp(func,"main",4,&ismain);
414:   if (ismain) {
415:     PetscMPIInt errcode;
416:     errcode = (PetscMPIInt)(0 + line*1000 + ierr);
417:     if (petscwaitonerrorflg) {PetscSleep(1000);}
418:     MPI_Abort(comm,errcode);
419:   }

421: #if defined(PETSC_CLANGUAGE_CXX)
422:   if (p == PETSC_ERROR_IN_CXX) {
423:     PetscCxxErrorThrow();
424:   }
425: #endif
426:   PetscFunctionReturn(ierr);
427: }

429: /* -------------------------------------------------------------------------*/

431: /*@C
432:     PetscIntView - Prints an array of integers; useful for debugging.

434:     Collective on PetscViewer

436:     Input Parameters:
437: +   N - number of integers in array
438: .   idx - array of integers
439: -   viewer - location to print array,  PETSC_VIEWER_STDOUT_WORLD, PETSC_VIEWER_STDOUT_SELF or 0

441:   Level: intermediate

443:     Developer Notes:
444:     idx cannot be const because may be passed to binary viewer where byte swapping is done

446: .seealso: PetscRealView()
447: @*/
448: PetscErrorCode  PetscIntView(PetscInt N,const PetscInt idx[],PetscViewer viewer)
449: {
451:   PetscMPIInt    rank,size;
452:   PetscInt       j,i,n = N/20,p = N % 20;
453:   PetscBool      iascii,isbinary;
454:   MPI_Comm       comm;

457:   if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF;
460:   PetscObjectGetComm((PetscObject)viewer,&comm);
461:   MPI_Comm_size(comm,&size);
462:   MPI_Comm_rank(comm,&rank);

464:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);
465:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);
466:   if (iascii) {
467:     PetscViewerASCIIPushSynchronized(viewer);
468:     for (i=0; i<n; i++) {
469:       if (size > 1) {
470:         PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %D:", rank, 20*i);
471:       } else {
472:         PetscViewerASCIISynchronizedPrintf(viewer,"%D:",20*i);
473:       }
474:       for (j=0; j<20; j++) {
475:         PetscViewerASCIISynchronizedPrintf(viewer," %D",idx[i*20+j]);
476:       }
477:       PetscViewerASCIISynchronizedPrintf(viewer,"\n");
478:     }
479:     if (p) {
480:       if (size > 1) {
481:         PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %D:",rank ,20*n);
482:       } else {
483:         PetscViewerASCIISynchronizedPrintf(viewer,"%D:",20*n);
484:       }
485:       for (i=0; i<p; i++) { PetscViewerASCIISynchronizedPrintf(viewer," %D",idx[20*n+i]);}
486:       PetscViewerASCIISynchronizedPrintf(viewer,"\n");
487:     }
488:     PetscViewerFlush(viewer);
489:     PetscViewerASCIIPopSynchronized(viewer);
490:   } else if (isbinary) {
491:     PetscMPIInt *sizes,Ntotal,*displs,NN;
492:     PetscInt    *array;

494:     PetscMPIIntCast(N,&NN);

496:     if (size > 1) {
497:       if (rank) {
498:         MPI_Gather(&NN,1,MPI_INT,NULL,0,MPI_INT,0,comm);
499:         MPI_Gatherv((void*)idx,NN,MPIU_INT,NULL,NULL,NULL,MPIU_INT,0,comm);
500:       } else {
501:         PetscMalloc1(size,&sizes);
502:         MPI_Gather(&NN,1,MPI_INT,sizes,1,MPI_INT,0,comm);
503:         Ntotal    = sizes[0];
504:         PetscMalloc1(size,&displs);
505:         displs[0] = 0;
506:         for (i=1; i<size; i++) {
507:           Ntotal   += sizes[i];
508:           displs[i] =  displs[i-1] + sizes[i-1];
509:         }
510:         PetscMalloc1(Ntotal,&array);
511:         MPI_Gatherv((void*)idx,NN,MPIU_INT,array,sizes,displs,MPIU_INT,0,comm);
512:         PetscViewerBinaryWrite(viewer,array,Ntotal,PETSC_INT);
513:         PetscFree(sizes);
514:         PetscFree(displs);
515:         PetscFree(array);
516:       }
517:     } else {
518:       PetscViewerBinaryWrite(viewer,idx,N,PETSC_INT);
519:     }
520:   } else {
521:     const char *tname;
522:     PetscObjectGetName((PetscObject)viewer,&tname);
523:     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Cannot handle that PetscViewer of type %s",tname);
524:   }
525:   return(0);
526: }

528: /*@C
529:     PetscRealView - Prints an array of doubles; useful for debugging.

531:     Collective on PetscViewer

533:     Input Parameters:
534: +   N - number of PetscReal in array
535: .   idx - array of PetscReal
536: -   viewer - location to print array,  PETSC_VIEWER_STDOUT_WORLD, PETSC_VIEWER_STDOUT_SELF or 0

538:   Level: intermediate

540:     Developer Notes:
541:     idx cannot be const because may be passed to binary viewer where byte swapping is done

543: .seealso: PetscIntView()
544: @*/
545: PetscErrorCode  PetscRealView(PetscInt N,const PetscReal idx[],PetscViewer viewer)
546: {
548:   PetscMPIInt    rank,size;
549:   PetscInt       j,i,n = N/5,p = N % 5;
550:   PetscBool      iascii,isbinary;
551:   MPI_Comm       comm;

554:   if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF;
557:   PetscObjectGetComm((PetscObject)viewer,&comm);
558:   MPI_Comm_size(comm,&size);
559:   MPI_Comm_rank(comm,&rank);

561:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);
562:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);
563:   if (iascii) {
564:     PetscInt tab;

566:     PetscViewerASCIIPushSynchronized(viewer);
567:     PetscViewerASCIIGetTab(viewer, &tab);
568:     for (i=0; i<n; i++) {
569:       PetscViewerASCIISetTab(viewer, tab);
570:       if (size > 1) {
571:         PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %2d:",rank ,(int)5*i);
572:       } else {
573:         PetscViewerASCIISynchronizedPrintf(viewer,"%2d:",(int)5*i);
574:       }
575:       PetscViewerASCIISetTab(viewer, 0);
576:       for (j=0; j<5; j++) {
577:         PetscViewerASCIISynchronizedPrintf(viewer," %12.4e",(double)idx[i*5+j]);
578:       }
579:       PetscViewerASCIISynchronizedPrintf(viewer,"\n");
580:     }
581:     if (p) {
582:       PetscViewerASCIISetTab(viewer, tab);
583:       if (size > 1) {
584:         PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %2d:",rank ,(int)5*n);
585:       } else {
586:         PetscViewerASCIISynchronizedPrintf(viewer,"%2d:",(int)5*n);
587:       }
588:       PetscViewerASCIISetTab(viewer, 0);
589:       for (i=0; i<p; i++) { PetscViewerASCIISynchronizedPrintf(viewer," %12.4e",(double)idx[5*n+i]);}
590:       PetscViewerASCIISynchronizedPrintf(viewer,"\n");
591:     }
592:     PetscViewerFlush(viewer);
593:     PetscViewerASCIISetTab(viewer, tab);
594:     PetscViewerASCIIPopSynchronized(viewer);
595:   } else if (isbinary) {
596:     PetscMPIInt *sizes,*displs, Ntotal,NN;
597:     PetscReal   *array;

599:     PetscMPIIntCast(N,&NN);

601:     if (size > 1) {
602:       if (rank) {
603:         MPI_Gather(&NN,1,MPI_INT,NULL,0,MPI_INT,0,comm);
604:         MPI_Gatherv((PetscReal*)idx,NN,MPIU_REAL,NULL,NULL,NULL,MPIU_REAL,0,comm);
605:       } else {
606:         PetscMalloc1(size,&sizes);
607:         MPI_Gather(&NN,1,MPI_INT,sizes,1,MPI_INT,0,comm);
608:         Ntotal    = sizes[0];
609:         PetscMalloc1(size,&displs);
610:         displs[0] = 0;
611:         for (i=1; i<size; i++) {
612:           Ntotal   += sizes[i];
613:           displs[i] =  displs[i-1] + sizes[i-1];
614:         }
615:         PetscMalloc1(Ntotal,&array);
616:         MPI_Gatherv((PetscReal*)idx,NN,MPIU_REAL,array,sizes,displs,MPIU_REAL,0,comm);
617:         PetscViewerBinaryWrite(viewer,array,Ntotal,PETSC_REAL);
618:         PetscFree(sizes);
619:         PetscFree(displs);
620:         PetscFree(array);
621:       }
622:     } else {
623:       PetscViewerBinaryWrite(viewer,(void*) idx,N,PETSC_REAL);
624:     }
625:   } else {
626:     const char *tname;
627:     PetscObjectGetName((PetscObject)viewer,&tname);
628:     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Cannot handle that PetscViewer of type %s",tname);
629:   }
630:   return(0);
631: }

633: /*@C
634:     PetscScalarView - Prints an array of scalars; useful for debugging.

636:     Collective on PetscViewer

638:     Input Parameters:
639: +   N - number of scalars in array
640: .   idx - array of scalars
641: -   viewer - location to print array,  PETSC_VIEWER_STDOUT_WORLD, PETSC_VIEWER_STDOUT_SELF or 0

643:   Level: intermediate

645:     Developer Notes:
646:     idx cannot be const because may be passed to binary viewer where byte swapping is done

648: .seealso: PetscIntView(), PetscRealView()
649: @*/
650: PetscErrorCode  PetscScalarView(PetscInt N,const PetscScalar idx[],PetscViewer viewer)
651: {
653:   PetscMPIInt    rank,size;
654:   PetscInt       j,i,n = N/3,p = N % 3;
655:   PetscBool      iascii,isbinary;
656:   MPI_Comm       comm;

659:   if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF;
662:   PetscObjectGetComm((PetscObject)viewer,&comm);
663:   MPI_Comm_size(comm,&size);
664:   MPI_Comm_rank(comm,&rank);

666:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);
667:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);
668:   if (iascii) {
669:     PetscViewerASCIIPushSynchronized(viewer);
670:     for (i=0; i<n; i++) {
671:       if (size > 1) {
672:         PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %2d:",rank ,3*i);
673:       } else {
674:         PetscViewerASCIISynchronizedPrintf(viewer,"%2d:",3*i);
675:       }
676:       for (j=0; j<3; j++) {
677: #if defined(PETSC_USE_COMPLEX)
678:         PetscViewerASCIISynchronizedPrintf(viewer," (%12.4e,%12.4e)", (double)PetscRealPart(idx[i*3+j]),(double)PetscImaginaryPart(idx[i*3+j]));
679: #else
680:         PetscViewerASCIISynchronizedPrintf(viewer," %12.4e",(double)idx[i*3+j]);
681: #endif
682:       }
683:       PetscViewerASCIISynchronizedPrintf(viewer,"\n");
684:     }
685:     if (p) {
686:       if (size > 1) {
687:         PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %2d:",rank ,3*n);
688:       } else {
689:         PetscViewerASCIISynchronizedPrintf(viewer,"%2d:",3*n);
690:       }
691:       for (i=0; i<p; i++) {
692: #if defined(PETSC_USE_COMPLEX)
693:         PetscViewerASCIISynchronizedPrintf(viewer," (%12.4e,%12.4e)", (double)PetscRealPart(idx[n*3+i]),(double)PetscImaginaryPart(idx[n*3+i]));
694: #else
695:         PetscViewerASCIISynchronizedPrintf(viewer," %12.4e",(double)idx[3*n+i]);
696: #endif
697:       }
698:       PetscViewerASCIISynchronizedPrintf(viewer,"\n");
699:     }
700:     PetscViewerFlush(viewer);
701:     PetscViewerASCIIPopSynchronized(viewer);
702:   } else if (isbinary) {
703:     PetscMPIInt *sizes,Ntotal,*displs,NN;
704:     PetscScalar *array;

706:     PetscMPIIntCast(N,&NN);

708:     if (size > 1) {
709:       if (rank) {
710:         MPI_Gather(&NN,1,MPI_INT,NULL,0,MPI_INT,0,comm);
711:         MPI_Gatherv((void*)idx,NN,MPIU_SCALAR,NULL,NULL,NULL,MPIU_SCALAR,0,comm);
712:       } else {
713:         PetscMalloc1(size,&sizes);
714:         MPI_Gather(&NN,1,MPI_INT,sizes,1,MPI_INT,0,comm);
715:         Ntotal    = sizes[0];
716:         PetscMalloc1(size,&displs);
717:         displs[0] = 0;
718:         for (i=1; i<size; i++) {
719:           Ntotal   += sizes[i];
720:           displs[i] =  displs[i-1] + sizes[i-1];
721:         }
722:         PetscMalloc1(Ntotal,&array);
723:         MPI_Gatherv((void*)idx,NN,MPIU_SCALAR,array,sizes,displs,MPIU_SCALAR,0,comm);
724:         PetscViewerBinaryWrite(viewer,array,Ntotal,PETSC_SCALAR);
725:         PetscFree(sizes);
726:         PetscFree(displs);
727:         PetscFree(array);
728:       }
729:     } else {
730:       PetscViewerBinaryWrite(viewer,(void*) idx,N,PETSC_SCALAR);
731:     }
732:   } else {
733:     const char *tname;
734:     PetscObjectGetName((PetscObject)viewer,&tname);
735:     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Cannot handle that PetscViewer of type %s",tname);
736:   }
737:   return(0);
738: }

740: #if defined(PETSC_HAVE_CUDA)
741: #include <petsccublas.h>
742: PETSC_EXTERN const char* PetscCUBLASGetErrorName(cublasStatus_t status)
743: {
744:   switch(status) {
745: #if (CUDART_VERSION >= 8000) /* At least CUDA 8.0 of Sep. 2016 had these */
746:     case CUBLAS_STATUS_SUCCESS:          return "CUBLAS_STATUS_SUCCESS";
747:     case CUBLAS_STATUS_NOT_INITIALIZED:  return "CUBLAS_STATUS_NOT_INITIALIZED";
748:     case CUBLAS_STATUS_ALLOC_FAILED:     return "CUBLAS_STATUS_ALLOC_FAILED";
749:     case CUBLAS_STATUS_INVALID_VALUE:    return "CUBLAS_STATUS_INVALID_VALUE";
750:     case CUBLAS_STATUS_ARCH_MISMATCH:    return "CUBLAS_STATUS_ARCH_MISMATCH";
751:     case CUBLAS_STATUS_MAPPING_ERROR:    return "CUBLAS_STATUS_MAPPING_ERROR";
752:     case CUBLAS_STATUS_EXECUTION_FAILED: return "CUBLAS_STATUS_EXECUTION_FAILED";
753:     case CUBLAS_STATUS_INTERNAL_ERROR:   return "CUBLAS_STATUS_INTERNAL_ERROR";
754:     case CUBLAS_STATUS_NOT_SUPPORTED:    return "CUBLAS_STATUS_NOT_SUPPORTED";
755:     case CUBLAS_STATUS_LICENSE_ERROR:    return "CUBLAS_STATUS_LICENSE_ERROR";
756: #endif
757:     default:                             return "unknown error";
758:   }
759: }
760: #endif