xref: /petsc/src/sys/error/err.c (revision 57b47c28e1f7534921d70b049522292aa9665180)
1e5c89e4eSSatish Balay /*
2e5c89e4eSSatish Balay       Code that allows one to set the error handlers
347d993e7Ssuyashtn       Portions of this code are under:
447d993e7Ssuyashtn       Copyright (c) 2022 Advanced Micro Devices, Inc. All rights reserved.
5e5c89e4eSSatish Balay */
6af0996ceSBarry Smith #include <petsc/private/petscimpl.h> /*I "petscsys.h" I*/
7665c2dedSJed Brown #include <petscviewer.h>
8e5c89e4eSSatish Balay 
9e5c89e4eSSatish Balay typedef struct _EH *EH;
10e5c89e4eSSatish Balay struct _EH {
11efca3c55SSatish Balay   PetscErrorCode (*handler)(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *);
12e5c89e4eSSatish Balay   void *ctx;
13e5c89e4eSSatish Balay   EH    previous;
14e5c89e4eSSatish Balay };
15e5c89e4eSSatish Balay 
1635f00c14SToby Isaac /* This is here to allow the traceback error handler (or potentially other error handlers)
1735f00c14SToby Isaac    to certify that PETSCABORT is being called on all MPI processes, and that it should be possible to call
1835f00c14SToby Isaac    MPI_Finalize() and exit().  This should only be used when `PetscCIEnabledPortabeErrorOutput == PETSC_TRUE`
1935f00c14SToby Isaac    to allow testing of error messages.  Do not rely on this for clean exit in production. */
2035f00c14SToby Isaac PetscBool petscabortmpifinalize = PETSC_FALSE;
2135f00c14SToby Isaac 
2202c9f0b5SLisandro Dalcin static EH eh = NULL;
23e5c89e4eSSatish Balay 
24e5c89e4eSSatish Balay /*@C
25e5c89e4eSSatish Balay   PetscEmacsClientErrorHandler - Error handler that uses the emacsclient program to
26a5b23f4aSJose E. Roman   load the file where the error occurred. Then calls the "previous" error handler.
27e5c89e4eSSatish Balay 
28cc4c1da9SBarry Smith   Not Collective, No Fortran Support
29e5c89e4eSSatish Balay 
30e5c89e4eSSatish Balay   Input Parameters:
31a5b23f4aSJose E. Roman + comm - communicator over which error occurred
326e25c4a1SBarry Smith . line - the line number of the error (usually indicated by `__LINE__` in the calling routine)
336e25c4a1SBarry Smith . file - the file in which the error was detected (usually indicated by `__FILE__` in the calling routine)
346e25c4a1SBarry Smith . fun  - the function name of the calling routine
35e5c89e4eSSatish Balay . mess - an error text string, usually just printed to the screen
36e5c89e4eSSatish Balay . n    - the generic error number
376e25c4a1SBarry Smith . p    - `PETSC_ERROR_INITIAL` indicates this is the first time the error handler is being called while `PETSC_ERROR_REPEAT` indicates it was previously called
38e5c89e4eSSatish Balay - ctx  - error handler context
39e5c89e4eSSatish Balay 
40e5c89e4eSSatish Balay   Options Database Key:
4110699b91SBarry Smith . -on_error_emacs <machinename> - will contact machinename to open the Emacs client there
42e5c89e4eSSatish Balay 
43e5c89e4eSSatish Balay   Level: developer
44e5c89e4eSSatish Balay 
45811af0c4SBarry Smith   Note:
46e5c89e4eSSatish Balay   You must put (server-start) in your .emacs file for the emacsclient software to work
47e5c89e4eSSatish Balay 
486e25c4a1SBarry Smith   Developer Note:
49811af0c4SBarry Smith   Since this is an error handler it cannot call `PetscCall()`; thus we just return if an error is detected.
50811af0c4SBarry Smith   But some of the functions it calls do perform error checking that may not be appropriate in a error handler call.
513bf036e2SBarry Smith 
52db781477SPatrick Sanan .seealso: `PetscError()`, `PetscPushErrorHandler()`, `PetscPopErrorHandler()`, `PetscAttachDebuggerErrorHandler()`,
536e25c4a1SBarry Smith           `PetscAbortErrorHandler()`, `PetscMPIAbortErrorHandler()`, `PetscTraceBackErrorHandler()`, `PetscReturnErrorHandler()`,
546e25c4a1SBarry Smith           `PetscErrorType`, `PETSC_ERROR_INITIAL`, `PETSC_ERROR_REPEAT`, `PetscErrorCode`
55e5c89e4eSSatish Balay  @*/
56d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscEmacsClientErrorHandler(MPI_Comm comm, int line, const char *fun, const char *file, PetscErrorCode n, PetscErrorType p, const char *mess, void *ctx)
57d71ae5a4SJacob Faibussowitsch {
58e5c89e4eSSatish Balay   PetscErrorCode ierr;
59e5c89e4eSSatish Balay   char           command[PETSC_MAX_PATH_LEN];
60e5c89e4eSSatish Balay   const char    *pdir;
61e5c89e4eSSatish Balay   FILE          *fp;
62e5c89e4eSSatish Balay 
639371c9d4SSatish Balay   ierr = PetscGetPetscDir(&pdir);
6411cc89d2SBarry Smith   if (ierr) return ierr;
65a364092eSJacob Faibussowitsch   ierr = PetscSNPrintf(command, PETSC_STATIC_ARRAY_LENGTH(command), "cd %s; emacsclient --no-wait +%d %s\n", pdir, line, file);
66a364092eSJacob Faibussowitsch   if (ierr) return ierr;
67e5c89e4eSSatish Balay #if defined(PETSC_HAVE_POPEN)
689371c9d4SSatish Balay   ierr = PetscPOpen(MPI_COMM_WORLD, (char *)ctx, command, "r", &fp);
6911cc89d2SBarry Smith   if (ierr) return ierr;
709371c9d4SSatish Balay   ierr = PetscPClose(MPI_COMM_WORLD, fp);
7111cc89d2SBarry Smith   if (ierr) return ierr;
72e5c89e4eSSatish Balay #else
73e32f2f54SBarry Smith   SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP_SYS, "Cannot run external programs on this machine");
74e5c89e4eSSatish Balay #endif
759371c9d4SSatish Balay   ierr = PetscPopErrorHandler();
7611cc89d2SBarry Smith   if (ierr) return ierr; /* remove this handler from the stack of handlers */
773bf036e2SBarry Smith   if (!eh) {
789371c9d4SSatish Balay     ierr = PetscTraceBackErrorHandler(comm, line, fun, file, n, p, mess, NULL);
7911cc89d2SBarry Smith     if (ierr) return ierr;
803bf036e2SBarry Smith   } else {
819371c9d4SSatish Balay     ierr = (*eh->handler)(comm, line, fun, file, n, p, mess, eh->ctx);
8211cc89d2SBarry Smith     if (ierr) return ierr;
833bf036e2SBarry Smith   }
843ba16761SJacob Faibussowitsch   return PETSC_SUCCESS;
85e5c89e4eSSatish Balay }
86e5c89e4eSSatish Balay 
87e5c89e4eSSatish Balay /*@C
88e5c89e4eSSatish Balay   PetscPushErrorHandler - Sets a routine to be called on detection of errors.
89e5c89e4eSSatish Balay 
90cc4c1da9SBarry Smith   Not Collective, No Fortran Support
91e5c89e4eSSatish Balay 
92e5c89e4eSSatish Balay   Input Parameters:
93e5c89e4eSSatish Balay + handler - error handler routine
94e5c89e4eSSatish Balay - ctx     - optional handler context that contains information needed by the handler (for
95e5c89e4eSSatish Balay             example file pointers for error messages etc.)
96e5c89e4eSSatish Balay 
9720f4b53cSBarry Smith   Calling sequence of `handler`:
98a5b23f4aSJose E. Roman + comm - communicator over which error occurred
996e25c4a1SBarry Smith . line - the line number of the error (usually indicated by `__LINE__` in the calling routine)
1006e25c4a1SBarry Smith . file - the file in which the error was detected (usually indicated by `__FILE__` in the calling routine)
1016e25c4a1SBarry Smith . fun  - the function name of the calling routine
102e5c89e4eSSatish Balay . n    - the generic error number (see list defined in include/petscerror.h)
10320f4b53cSBarry Smith . p    - `PETSC_ERROR_INITIAL` if error just detected, otherwise `PETSC_ERROR_REPEAT`
104e5c89e4eSSatish Balay . mess - an error text string, usually just printed to the screen
105e5c89e4eSSatish Balay - ctx  - the error handler context
106e5c89e4eSSatish Balay 
107e5c89e4eSSatish Balay   Options Database Keys:
1086e25c4a1SBarry Smith + -on_error_attach_debugger <noxterm,lldb or gdb> - starts up the debugger if an error occurs
10910699b91SBarry Smith - -on_error_abort                                 - aborts the program if an error occurs
110e5c89e4eSSatish Balay 
111e5c89e4eSSatish Balay   Level: intermediate
112e5c89e4eSSatish Balay 
113811af0c4SBarry Smith   Note:
114811af0c4SBarry Smith   The currently available PETSc error handlers include `PetscTraceBackErrorHandler()`,
1156e25c4a1SBarry Smith   `PetscAttachDebuggerErrorHandler()`, `PetscAbortErrorHandler()`, `PetscMPIAbortErrorHandler()`, and `PetscReturnErrorHandler()`.
116e93bc3c1Svictor 
1176e25c4a1SBarry Smith   Fortran Note:
1186e25c4a1SBarry Smith   You can only push a single error handler from Fortran before popping it.
1197850c7c0SBarry Smith 
1206e25c4a1SBarry Smith .seealso: `PetscPopErrorHandler()`, `PetscAttachDebuggerErrorHandler()`, `PetscAbortErrorHandler()`, `PetscTraceBackErrorHandler()`, `PetscPushSignalHandler()`,
1216e25c4a1SBarry Smith           `PetscErrorType`, `PETSC_ERROR_INITIAL`, `PETSC_ERROR_REPEAT`, `PetscErrorCode`
122e5c89e4eSSatish Balay @*/
12310450e9eSJacob Faibussowitsch PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm comm, int line, const char *fun, const char *file, PetscErrorCode n, PetscErrorType p, const char *mess, void *ctx), void *ctx)
124d71ae5a4SJacob Faibussowitsch {
125e5c89e4eSSatish Balay   EH neweh;
126e5c89e4eSSatish Balay 
127e5c89e4eSSatish Balay   PetscFunctionBegin;
1289566063dSJacob Faibussowitsch   PetscCall(PetscNew(&neweh));
129a297a907SKarl Rupp   if (eh) neweh->previous = eh;
13002c9f0b5SLisandro Dalcin   else neweh->previous = NULL;
131e5c89e4eSSatish Balay   neweh->handler = handler;
132e5c89e4eSSatish Balay   neweh->ctx     = ctx;
133e5c89e4eSSatish Balay   eh             = neweh;
1343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
135e5c89e4eSSatish Balay }
136e5c89e4eSSatish Balay 
137e30d2299SSatish Balay /*@
138e5c89e4eSSatish Balay   PetscPopErrorHandler - Removes the latest error handler that was
139811af0c4SBarry Smith   pushed with `PetscPushErrorHandler()`.
140e5c89e4eSSatish Balay 
141e5c89e4eSSatish Balay   Not Collective
142e5c89e4eSSatish Balay 
143e5c89e4eSSatish Balay   Level: intermediate
144e5c89e4eSSatish Balay 
145db781477SPatrick Sanan .seealso: `PetscPushErrorHandler()`
146e5c89e4eSSatish Balay @*/
147d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscPopErrorHandler(void)
148d71ae5a4SJacob Faibussowitsch {
149e5c89e4eSSatish Balay   EH tmp;
150e5c89e4eSSatish Balay 
151e5c89e4eSSatish Balay   PetscFunctionBegin;
1523ba16761SJacob Faibussowitsch   if (!eh) PetscFunctionReturn(PETSC_SUCCESS);
153e5c89e4eSSatish Balay   tmp = eh;
154e5c89e4eSSatish Balay   eh  = eh->previous;
1559566063dSJacob Faibussowitsch   PetscCall(PetscFree(tmp));
1563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
157e5c89e4eSSatish Balay }
158e5c89e4eSSatish Balay 
159e93bc3c1Svictor /*@C
16045b666d6SBarry Smith   PetscReturnErrorHandler - Error handler that causes a return without printing an error message.
161e93bc3c1Svictor 
162cc4c1da9SBarry Smith   Not Collective, No Fortran Support
163e93bc3c1Svictor 
164e93bc3c1Svictor   Input Parameters:
165e32f2f54SBarry Smith + comm - communicator over which error occurred
1666e25c4a1SBarry Smith . line - the line number of the error (usually indicated by `__LINE__` in the calling routine)
16710450e9eSJacob Faibussowitsch . fun  - the function name
1686e25c4a1SBarry Smith . file - the file in which the error was detected (usually indicated by `__FILE__` in the calling routine)
169e93bc3c1Svictor . mess - an error text string, usually just printed to the screen
170e93bc3c1Svictor . n    - the generic error number
1716e25c4a1SBarry Smith . p    - `PETSC_ERROR_INITIAL` indicates this is the first time the error handler is being called while `PETSC_ERROR_REPEAT` indicates it was previously called
172e93bc3c1Svictor - ctx  - error handler context
173e93bc3c1Svictor 
174e93bc3c1Svictor   Level: developer
175e93bc3c1Svictor 
176e93bc3c1Svictor   Notes:
1776e25c4a1SBarry Smith   Users do not directly employ this routine
178e93bc3c1Svictor 
1796e25c4a1SBarry Smith   Use `PetscPushErrorHandler()` to set the desired error handler.  The
1806e25c4a1SBarry Smith   currently available PETSc error handlers include `PetscTraceBackErrorHandler()`,
1816e25c4a1SBarry Smith   `PetscAttachDebuggerErrorHandler()`, and `PetscAbortErrorHandler()`.
182e93bc3c1Svictor 
183db781477SPatrick Sanan .seealso: `PetscPushErrorHandler()`, `PetscPopErrorHandler()`, `PetscError()`, `PetscAbortErrorHandler()`, `PetscMPIAbortErrorHandler()`, `PetscTraceBackErrorHandler()`,
1846e25c4a1SBarry Smith           `PetscAttachDebuggerErrorHandler()`, `PetscEmacsClientErrorHandler()`,
1856e25c4a1SBarry Smith           `PetscErrorType`, `PETSC_ERROR_INITIAL`, `PETSC_ERROR_REPEAT`, `PetscErrorCode`
186e93bc3c1Svictor  @*/
187d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscReturnErrorHandler(MPI_Comm comm, int line, const char *fun, const char *file, PetscErrorCode n, PetscErrorType p, const char *mess, void *ctx)
188d71ae5a4SJacob Faibussowitsch {
18910450e9eSJacob Faibussowitsch   (void)comm;
19010450e9eSJacob Faibussowitsch   (void)line;
19110450e9eSJacob Faibussowitsch   (void)fun;
19210450e9eSJacob Faibussowitsch   (void)file;
19310450e9eSJacob Faibussowitsch   (void)p;
19410450e9eSJacob Faibussowitsch   (void)mess;
19510450e9eSJacob Faibussowitsch   (void)ctx;
196362febeeSStefano Zampini   return n;
197e93bc3c1Svictor }
198e93bc3c1Svictor 
199e5c89e4eSSatish Balay static char PetscErrorBaseMessage[1024];
200e5c89e4eSSatish Balay /*
201e5c89e4eSSatish Balay        The numerical values for these are defined in include/petscerror.h; any changes
202e5c89e4eSSatish Balay    there must also be made here
203e5c89e4eSSatish Balay */
204e5c89e4eSSatish Balay static const char *PetscErrorStrings[] = {
205e5c89e4eSSatish Balay   /*55 */ "Out of memory",
206e5c89e4eSSatish Balay   "No support for this operation for this object type",
207e5c89e4eSSatish Balay   "No support for this operation on this system",
208e5c89e4eSSatish Balay   /*58 */ "Operation done in wrong order",
209e5c89e4eSSatish Balay   /*59 */ "Signal received",
210e5c89e4eSSatish Balay   /*60 */ "Nonconforming object sizes",
211e5c89e4eSSatish Balay   "Argument aliasing not permitted",
212e5c89e4eSSatish Balay   "Invalid argument",
213e5c89e4eSSatish Balay   /*63 */ "Argument out of range",
214a17b96a8SKyle Gerard Felker   "Corrupt argument: https://petsc.org/release/faq/#valgrind",
215e5c89e4eSSatish Balay   "Unable to open file",
216e5c89e4eSSatish Balay   "Read from file failed",
217e5c89e4eSSatish Balay   "Write to file failed",
218e5c89e4eSSatish Balay   "Invalid pointer",
219e5c89e4eSSatish Balay   /*69 */ "Arguments must have same type",
220a8b45ee7SBarry Smith   /*70 */ "Attempt to use a pointer that does not point to a valid accessible location",
221a17b96a8SKyle Gerard Felker   /*71 */ "Zero pivot in LU factorization: https://petsc.org/release/faq/#zeropivot",
222e5c89e4eSSatish Balay   /*72 */ "Floating point exception",
223e5c89e4eSSatish Balay   /*73 */ "Object is in wrong state",
224e5c89e4eSSatish Balay   "Corrupted Petsc object",
225e5c89e4eSSatish Balay   "Arguments are incompatible",
226e5c89e4eSSatish Balay   "Error in external library",
227e5c89e4eSSatish Balay   /*77 */ "Petsc has generated inconsistent data",
228a17b96a8SKyle Gerard Felker   "Memory corruption: https://petsc.org/release/faq/#valgrind",
229e5c89e4eSSatish Balay   "Unexpected data in file",
230e5c89e4eSSatish Balay   /*80 */ "Arguments must have same communicators",
231a17b96a8SKyle Gerard Felker   /*81 */ "Zero pivot in Cholesky factorization: https://petsc.org/release/faq/#zeropivot",
232e5c89e4eSSatish Balay   "",
233e5c89e4eSSatish Balay   "",
234a17b96a8SKyle Gerard Felker   "Overflow in integer operation: https://petsc.org/release/faq/#64-bit-indices",
235e5c89e4eSSatish Balay   /*85 */ "Null argument, when expecting valid pointer",
236a17b96a8SKyle Gerard Felker   /*86 */ "Unknown type. Check for miss-spelling or missing package: https://petsc.org/release/install/install/#external-packages",
2373d96e996SBarry Smith   /*87 */ "MPI library at runtime is not compatible with MPI used at compile time",
2388cda6cd7SBarry Smith   /*88 */ "Error in system call",
239a17b96a8SKyle Gerard Felker   /*89 */ "Object Type not set: https://petsc.org/release/faq/#object-type-not-set",
24073260a9bSLisandro Dalcin   /*90 */ "",
24173260a9bSLisandro Dalcin   /*   */ "",
242a17b96a8SKyle Gerard Felker   /*92 */ "See https://petsc.org/release/overview/linear_solve_table/ for possible LU and Cholesky solvers",
243f560318cSPatrick Sanan   /*93 */ "You cannot overwrite this option since that will conflict with other previously set options",
244691b26d3SBarry Smith   /*94 */ "Example/application run with number of MPI ranks it does not support",
245691b26d3SBarry Smith   /*95 */ "Missing or incorrect user input",
246e57d7714SBarry Smith   /*96 */ "GPU resources unavailable",
247764761abSStefano Zampini   /*97 */ "GPU error",
248e809461dSJacob Faibussowitsch   /*98 */ "General MPI error",
2494237731aSLisandro Dalcin   /*99 */ "PetscError() incorrectly returned an error code of 0",
2504237731aSLisandro Dalcin   /*   */ "",
2514237731aSLisandro Dalcin   /*101*/ "Unhandled Python Exception",
2524237731aSLisandro Dalcin   NULL};
253e5c89e4eSSatish Balay 
254e5c89e4eSSatish Balay /*@C
2553ba16761SJacob Faibussowitsch   PetscErrorMessage - Returns the text string associated with a PETSc error code.
256e5c89e4eSSatish Balay 
257cc4c1da9SBarry Smith   Not Collective, No Fortran Support
258e5c89e4eSSatish Balay 
259e5c89e4eSSatish Balay   Input Parameter:
260e5c89e4eSSatish Balay . errnum - the error code
261e5c89e4eSSatish Balay 
262d8d19677SJose E. Roman   Output Parameters:
2633ba16761SJacob Faibussowitsch + text     - the error message (`NULL` if not desired)
2643ba16761SJacob Faibussowitsch - specific - the specific error message that was set with `SETERRQ()` or
2653ba16761SJacob Faibussowitsch              `PetscError()`. (`NULL` if not desired)
266e5c89e4eSSatish Balay 
267e5c89e4eSSatish Balay   Level: developer
268e5c89e4eSSatish Balay 
2693ba16761SJacob Faibussowitsch .seealso: `PetscErrorCode`, `PetscPushErrorHandler()`, `PetscAttachDebuggerErrorHandler()`,
2703ba16761SJacob Faibussowitsch `PetscError()`, `SETERRQ()`, `PetscCall()` `PetscAbortErrorHandler()`,
2713ba16761SJacob Faibussowitsch `PetscTraceBackErrorHandler()`
272e5c89e4eSSatish Balay @*/
273cc4c1da9SBarry Smith PetscErrorCode PetscErrorMessage(PetscErrorCode errnum, const char *text[], char *specific[])
274d71ae5a4SJacob Faibussowitsch {
2753ba16761SJacob Faibussowitsch   PetscFunctionBegin;
2763ba16761SJacob Faibussowitsch   if (text) {
2773ba16761SJacob Faibussowitsch     if (errnum > PETSC_ERR_MIN_VALUE && errnum < PETSC_ERR_MAX_VALUE) {
278c35ec7c7SPierre Jolivet       size_t len;
279c35ec7c7SPierre Jolivet 
280c35ec7c7SPierre Jolivet       *text = PetscErrorStrings[errnum - PETSC_ERR_MIN_VALUE - 1];
281c35ec7c7SPierre Jolivet       PetscCall(PetscStrlen(*text, &len));
282c35ec7c7SPierre Jolivet       if (!len) *text = NULL;
2833ba16761SJacob Faibussowitsch     } else if (errnum == PETSC_ERR_BOOLEAN_MACRO_FAILURE) {
2843ba16761SJacob Faibussowitsch       /* this "error code" arises from failures in boolean macros, where the || operator is
2853ba16761SJacob Faibussowitsch          used to short-circuit the macro call in case of error. This has the side effect of
2863ba16761SJacob Faibussowitsch          "returning" either 0 (PETSC_SUCCESS) or 1 (PETSC_ERR_UNKNONWN):
287e5c89e4eSSatish Balay 
2883ba16761SJacob Faibussowitsch          #define PETSC_FOO(x) ((PetscErrorCode)(PetscBar(x) || PetscBaz(x)))
2893ba16761SJacob Faibussowitsch 
2903ba16761SJacob Faibussowitsch          If PetscBar() fails (returns nonzero) PetscBaz() is not executed but the result of
2913ba16761SJacob Faibussowitsch          this expression is boolean false, hence PETSC_ERR_UNNOWN
2923ba16761SJacob Faibussowitsch        */
2933ba16761SJacob Faibussowitsch       *text = "Error occurred in boolean shortcuit in macro";
2943ba16761SJacob Faibussowitsch     } else {
2953ba16761SJacob Faibussowitsch       *text = NULL;
2963ba16761SJacob Faibussowitsch     }
2973ba16761SJacob Faibussowitsch   }
298a297a907SKarl Rupp   if (specific) *specific = PetscErrorBaseMessage;
2993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
300e5c89e4eSSatish Balay }
301e5c89e4eSSatish Balay 
302984a1229SMatthew G. Knepley #if defined(PETSC_CLANGUAGE_CXX)
303984a1229SMatthew G. Knepley   /* C++ exceptions are formally not allowed to propagate through extern "C" code. In practice, far too much software
30415229ffcSPierre Jolivet  * would be broken if implementations did not handle it in some common cases. However, keep in mind
305984a1229SMatthew G. Knepley  *
306984a1229SMatthew G. Knepley  *   Rule 62. Don't allow exceptions to propagate across module boundaries
307984a1229SMatthew G. Knepley  *
308984a1229SMatthew G. Knepley  * in "C++ Coding Standards" by Sutter and Alexandrescu. (This accounts for part of the ongoing C++ binary interface
309984a1229SMatthew G. Knepley  * instability.) Having PETSc raise errors as C++ exceptions was probably misguided and should eventually be removed.
310984a1229SMatthew G. Knepley  *
311984a1229SMatthew G. Knepley  * Here is the problem: You have a C++ function call a PETSc function, and you would like to maintain the error message
312984a1229SMatthew G. Knepley  * and stack information from the PETSc error. You could make everyone write exactly this code in their C++, but that
313984a1229SMatthew G. Knepley  * seems crazy to me.
314984a1229SMatthew G. Knepley  */
315984a1229SMatthew G. Knepley   #include <sstream>
3164c94c282SMatthew G. Knepley   #include <stdexcept>
317d71ae5a4SJacob Faibussowitsch static void PetscCxxErrorThrow()
318d71ae5a4SJacob Faibussowitsch {
319984a1229SMatthew G. Knepley   const char *str;
320984a1229SMatthew G. Knepley   if (eh && eh->ctx) {
321984a1229SMatthew G. Knepley     std::ostringstream *msg;
322984a1229SMatthew G. Knepley     msg = (std::ostringstream *)eh->ctx;
323984a1229SMatthew G. Knepley     str = msg->str().c_str();
324984a1229SMatthew G. Knepley   } else str = "Error detected in C PETSc";
325984a1229SMatthew G. Knepley 
326984a1229SMatthew G. Knepley   throw std::runtime_error(str);
327984a1229SMatthew G. Knepley }
328984a1229SMatthew G. Knepley #endif
329984a1229SMatthew G. Knepley 
330e5c89e4eSSatish Balay /*@C
3316e25c4a1SBarry Smith   PetscError - Routine that is called when an error has been detected, usually called through the macro `SETERRQ`(`PETSC_COMM_SELF`,)` or by `PetscCall()`.
332e5c89e4eSSatish Balay 
333811af0c4SBarry Smith   Collective
334e5c89e4eSSatish Balay 
335e5c89e4eSSatish Balay   Input Parameters:
3366e25c4a1SBarry Smith + comm - communicator over which error occurred.  ALL MPI processes of this communicator MUST call this routine
3376e25c4a1SBarry Smith . line - the line number of the error (usually indicated by `__LINE__` in the calling routine)
3383de71b31SHong Zhang . func - the function name in which the error was detected
3396e25c4a1SBarry Smith . file - the file in which the error was detected (usually indicated by `__FILE__` in the calling routine)
340e5c89e4eSSatish Balay . n    - the generic error number
341811af0c4SBarry Smith . p    - `PETSC_ERROR_INITIAL` indicates the error was initially detected, `PETSC_ERROR_REPEAT` indicates this is a traceback from a previously detected error
342e5c89e4eSSatish Balay - mess - formatted message string - aka printf
343e5c89e4eSSatish Balay 
344811af0c4SBarry Smith   Options Database Keys:
3456e25c4a1SBarry Smith + -error_output_stdout - output the error messages to `stdout` instead of the default `stderr`
34645b666d6SBarry Smith - -error_output_none   - do not output the error messages
34745b666d6SBarry Smith 
348e5c89e4eSSatish Balay   Level: intermediate
349e5c89e4eSSatish Balay 
350e5c89e4eSSatish Balay   Notes:
351e809461dSJacob Faibussowitsch   PETSc error handling is done with error return codes. A non-zero return indicates an error
352e809461dSJacob Faibussowitsch   was detected. The return-value of this routine is what is ultimately returned by
353e809461dSJacob Faibussowitsch   `SETERRQ()`.
35445b666d6SBarry Smith 
3556e25c4a1SBarry Smith   Numerical errors (potential divide by zero, for example) are not managed by the
356e809461dSJacob Faibussowitsch   error return codes; they are managed via, for example, `KSPGetConvergedReason()` that
357e809461dSJacob Faibussowitsch   indicates if the solve was successful or not. The option `-ksp_error_if_not_converged`, for
358e809461dSJacob Faibussowitsch   example, turns numerical failures into hard errors managed via `PetscError()`.
35945b666d6SBarry Smith 
360e809461dSJacob Faibussowitsch   PETSc provides a rich supply of error handlers, see the list below, and users can also
361e809461dSJacob Faibussowitsch   provide their own error handlers.
362811af0c4SBarry Smith 
363e809461dSJacob Faibussowitsch   If the user sets their own error handler (via `PetscPushErrorHandler()`) they may return any
364e809461dSJacob Faibussowitsch   arbitrary value from it, but are encouraged to return nonzero values. If the return value is
365e809461dSJacob Faibussowitsch   zero, `SETERRQ()` will ignore the value and return `PETSC_ERR_RETURN` (a nonzero value)
366e809461dSJacob Faibussowitsch   instead.
367e809461dSJacob Faibussowitsch 
368e809461dSJacob Faibussowitsch   Most users need not directly use this routine and the error handlers, but can instead use
369e809461dSJacob Faibussowitsch   the simplified interface `PetscCall()` or `SETERRQ()`.
370e5c89e4eSSatish Balay 
3716e25c4a1SBarry Smith   Fortran Note:
372e3081792SBarry Smith   This routine is used differently from Fortran
3736e25c4a1SBarry Smith .vb
3746e25c4a1SBarry Smith   PetscError(MPI_Comm comm, PetscErrorCode n, PetscErrorType p, char *message)
3756e25c4a1SBarry Smith .ve
376e3081792SBarry Smith 
3776e25c4a1SBarry Smith   Developer Note:
378811af0c4SBarry Smith   Since this is called after an error condition it should not be calling any error handlers (currently it ignores any error codes)
3793bf036e2SBarry Smith   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
3803bf036e2SBarry Smith   but this annoying.
3813bf036e2SBarry Smith 
382db781477SPatrick Sanan .seealso: `PetscErrorCode`, `PetscPushErrorHandler()`, `PetscPopErrorHandler()`, `PetscTraceBackErrorHandler()`, `PetscAbortErrorHandler()`, `PetscMPIAbortErrorHandler()`,
383db781477SPatrick Sanan           `PetscReturnErrorHandler()`, `PetscAttachDebuggerErrorHandler()`, `PetscEmacsClientErrorHandler()`,
3846e25c4a1SBarry Smith           `SETERRQ()`, `PetscCall()`, `CHKMEMQ`, `PetscErrorMessage()`, `PETSCABORT()`, `PetscErrorType`, `PETSC_ERROR_INITIAL`, `PETSC_ERROR_REPEAT`
385e5c89e4eSSatish Balay @*/
386d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscError(MPI_Comm comm, int line, const char *func, const char *file, PetscErrorCode n, PetscErrorType p, const char *mess, ...)
387d71ae5a4SJacob Faibussowitsch {
388e5c89e4eSSatish Balay   va_list        Argp;
389c9a19010SBarry Smith   size_t         fullLength;
39002c9f0b5SLisandro Dalcin   char           buf[2048], *lbuf = NULL;
391fbfcfee5SBarry Smith   PetscBool      ismain;
3923bf036e2SBarry Smith   PetscErrorCode ierr;
393e5c89e4eSSatish Balay 
39439a651e2SJacob Faibussowitsch   if (!PetscErrorHandlingInitialized) return n;
3950d577829SBarry Smith   if (comm == MPI_COMM_NULL) comm = PETSC_COMM_SELF;
396e5c89e4eSSatish Balay 
397e5c89e4eSSatish Balay   /* Compose the message evaluating the print format */
398e5c89e4eSSatish Balay   if (mess) {
399e5c89e4eSSatish Balay     va_start(Argp, mess);
400dd460d27SBarry Smith     (void)PetscVSNPrintf(buf, 2048, mess, &fullLength, Argp);
401e5c89e4eSSatish Balay     va_end(Argp);
402e5c89e4eSSatish Balay     lbuf = buf;
403dd460d27SBarry Smith     if (p == PETSC_ERROR_INITIAL) (void)PetscStrncpy(PetscErrorBaseMessage, lbuf, sizeof(PetscErrorBaseMessage));
404e5c89e4eSSatish Balay   }
405e5c89e4eSSatish Balay 
406dd460d27SBarry Smith   if (p == PETSC_ERROR_INITIAL && n != PETSC_ERR_MEMC) (void)PetscMallocValidate(__LINE__, PETSC_FUNCTION_NAME, __FILE__);
4074ed0ab5bSBarry Smith 
40802c9f0b5SLisandro Dalcin   if (!eh) ierr = PetscTraceBackErrorHandler(comm, line, func, file, n, p, lbuf, NULL);
409efca3c55SSatish Balay   else ierr = (*eh->handler)(comm, line, func, file, n, p, lbuf, eh->ctx);
410362febeeSStefano Zampini   PetscStackClearTop;
411e5c89e4eSSatish Balay 
412e5c89e4eSSatish Balay   /*
413989c49a2SBarry Smith       If this is called from the main() routine we abort the program.
414989c49a2SBarry Smith       We cannot just return because them some MPI processes may continue to attempt to run
415989c49a2SBarry Smith       while this process simply exits.
416e5c89e4eSSatish Balay   */
41749c86fc7SBarry Smith   if (func) {
418dd460d27SBarry Smith     (void)PetscStrncmp(func, "main", 4, &ismain);
4197233276eSBarry Smith     if (ismain) {
420dd460d27SBarry Smith       if (petscwaitonerrorflg) (void)PetscSleep(1000);
421660278c0SBarry Smith       PETSCABORT(comm, ierr);
4227233276eSBarry Smith     }
42349c86fc7SBarry Smith   }
4242c280183SJed Brown #if defined(PETSC_CLANGUAGE_CXX)
425ad540459SPierre Jolivet   if (p == PETSC_ERROR_IN_CXX) PetscCxxErrorThrow();
426d736bfebSBarry Smith #endif
427362febeeSStefano Zampini   return ierr;
428e5c89e4eSSatish Balay }
429e5c89e4eSSatish Balay 
430ffeef943SBarry Smith /*@
431*57b47c28SJames Wright   PetscIntViewNumColumns - Prints an array of integers; useful for debugging.
432e5c89e4eSSatish Balay 
433c3339decSBarry Smith   Collective
434e5c89e4eSSatish Balay 
435e5c89e4eSSatish Balay   Input Parameters:
436e5c89e4eSSatish Balay + N      - number of integers in array
437*57b47c28SJames Wright . Ncol   - number of integers to print per row
438e5c89e4eSSatish Balay . idx    - array of integers
439811af0c4SBarry Smith - viewer - location to print array, `PETSC_VIEWER_STDOUT_WORLD`, `PETSC_VIEWER_STDOUT_SELF` or 0
440e5c89e4eSSatish Balay 
441e5c89e4eSSatish Balay   Level: intermediate
442e5c89e4eSSatish Balay 
443811af0c4SBarry Smith   Note:
444a3b724e8SBarry Smith   This may be called from within the debugger, passing 0 as the viewer
445300a7f5bSBarry Smith 
4466e25c4a1SBarry Smith   Developer Note:
4476e25c4a1SBarry Smith   `idx` cannot be const because may be passed to binary viewer where temporary byte swapping may be done
448811af0c4SBarry Smith 
449*57b47c28SJames Wright .seealso: `PetscViewer`, `PetscIntView()`, `PetscRealView()`
450e5c89e4eSSatish Balay @*/
451*57b47c28SJames Wright PetscErrorCode PetscIntViewNumColumns(PetscInt N, PetscInt Ncol, const PetscInt idx[], PetscViewer viewer)
452d71ae5a4SJacob Faibussowitsch {
453ca0c3be5SJacob Faibussowitsch   PetscMPIInt rank, size;
454*57b47c28SJames Wright   PetscInt    j, i, n = N / Ncol, p = N % Ncol;
455ace3abfcSBarry Smith   PetscBool   iascii, isbinary;
456e5c89e4eSSatish Balay   MPI_Comm    comm;
457e5c89e4eSSatish Balay 
458e5c89e4eSSatish Balay   PetscFunctionBegin;
459e5c89e4eSSatish Balay   if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF;
460*57b47c28SJames Wright   if (N) PetscAssertPointer(idx, 3);
461*57b47c28SJames Wright   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 4);
4629566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)viewer, &comm));
4639566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
4649566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
465e5c89e4eSSatish Balay 
4669566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
4679566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERBINARY, &isbinary));
468e5c89e4eSSatish Balay   if (iascii) {
4699566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushSynchronized(viewer));
470e5c89e4eSSatish Balay     for (i = 0; i < n; i++) {
471ca0c3be5SJacob Faibussowitsch       if (size > 1) {
472*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "[%d] %" PetscInt_FMT ":", rank, Ncol * i));
473ca0c3be5SJacob Faibussowitsch       } else {
474*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%" PetscInt_FMT ":", Ncol * i));
475ca0c3be5SJacob Faibussowitsch       }
476*57b47c28SJames Wright       for (j = 0; j < Ncol; j++) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %" PetscInt_FMT, idx[i * Ncol + j]));
4779566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n"));
478e5c89e4eSSatish Balay     }
479e5c89e4eSSatish Balay     if (p) {
480ca0c3be5SJacob Faibussowitsch       if (size > 1) {
481*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "[%d] %" PetscInt_FMT ":", rank, Ncol * n));
482ca0c3be5SJacob Faibussowitsch       } else {
483*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%" PetscInt_FMT ":", Ncol * n));
484ca0c3be5SJacob Faibussowitsch       }
485*57b47c28SJames Wright       for (i = 0; i < p; i++) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %" PetscInt_FMT, idx[Ncol * n + i]));
4869566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n"));
487e5c89e4eSSatish Balay     }
4889566063dSJacob Faibussowitsch     PetscCall(PetscViewerFlush(viewer));
4899566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopSynchronized(viewer));
4906805f65bSBarry Smith   } else if (isbinary) {
491ca0c3be5SJacob Faibussowitsch     PetscMPIInt *sizes, Ntotal, *displs, NN;
492e5c89e4eSSatish Balay     PetscInt    *array;
493783b601eSJed Brown 
4949566063dSJacob Faibussowitsch     PetscCall(PetscMPIIntCast(N, &NN));
495e5c89e4eSSatish Balay 
496e5c89e4eSSatish Balay     if (size > 1) {
497e5c89e4eSSatish Balay       if (rank) {
4989566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Gather(&NN, 1, MPI_INT, NULL, 0, MPI_INT, 0, comm));
499835f2295SStefano Zampini         PetscCallMPI(MPI_Gatherv(idx, NN, MPIU_INT, NULL, NULL, NULL, MPIU_INT, 0, comm));
500e5c89e4eSSatish Balay       } else {
5019566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(size, &sizes));
5029566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Gather(&NN, 1, MPI_INT, sizes, 1, MPI_INT, 0, comm));
503e5c89e4eSSatish Balay         Ntotal = sizes[0];
5049566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(size, &displs));
505e5c89e4eSSatish Balay         displs[0] = 0;
506e5c89e4eSSatish Balay         for (i = 1; i < size; i++) {
507e5c89e4eSSatish Balay           Ntotal += sizes[i];
508e5c89e4eSSatish Balay           displs[i] = displs[i - 1] + sizes[i - 1];
509e5c89e4eSSatish Balay         }
5109566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(Ntotal, &array));
511835f2295SStefano Zampini         PetscCallMPI(MPI_Gatherv(idx, NN, MPIU_INT, array, sizes, displs, MPIU_INT, 0, comm));
5129566063dSJacob Faibussowitsch         PetscCall(PetscViewerBinaryWrite(viewer, array, Ntotal, PETSC_INT));
5139566063dSJacob Faibussowitsch         PetscCall(PetscFree(sizes));
5149566063dSJacob Faibussowitsch         PetscCall(PetscFree(displs));
5159566063dSJacob Faibussowitsch         PetscCall(PetscFree(array));
516e5c89e4eSSatish Balay       }
517e5c89e4eSSatish Balay     } else {
5189566063dSJacob Faibussowitsch       PetscCall(PetscViewerBinaryWrite(viewer, idx, N, PETSC_INT));
519e5c89e4eSSatish Balay     }
520e5c89e4eSSatish Balay   } else {
521e5c89e4eSSatish Balay     const char *tname;
5229566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject)viewer, &tname));
52398921bdaSJacob Faibussowitsch     SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot handle that PetscViewer of type %s", tname);
524e5c89e4eSSatish Balay   }
5253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
526e5c89e4eSSatish Balay }
527e5c89e4eSSatish Balay 
528ffeef943SBarry Smith /*@
529*57b47c28SJames Wright   PetscRealViewNumColumns - Prints an array of doubles; useful for debugging.
530e5c89e4eSSatish Balay 
531c3339decSBarry Smith   Collective
532e5c89e4eSSatish Balay 
533e5c89e4eSSatish Balay   Input Parameters:
534811af0c4SBarry Smith + N      - number of `PetscReal` in array
535*57b47c28SJames Wright . Ncol   - number of `PetscReal` to print per row
536811af0c4SBarry Smith . idx    - array of `PetscReal`
537811af0c4SBarry Smith - viewer - location to print array, `PETSC_VIEWER_STDOUT_WORLD`, `PETSC_VIEWER_STDOUT_SELF` or 0
538e5c89e4eSSatish Balay 
539e5c89e4eSSatish Balay   Level: intermediate
540e5c89e4eSSatish Balay 
541811af0c4SBarry Smith   Note:
542a3b724e8SBarry Smith   This may be called from within the debugger, passing 0 as the viewer
543300a7f5bSBarry Smith 
5446e25c4a1SBarry Smith   Developer Note:
5456e25c4a1SBarry Smith   `idx` cannot be const because may be passed to binary viewer where temporary byte swapping may be done
546811af0c4SBarry Smith 
547*57b47c28SJames Wright .seealso: `PetscViewer`, `PetscRealView()`, `PetscIntView()`
548e5c89e4eSSatish Balay @*/
549*57b47c28SJames Wright PetscErrorCode PetscRealViewNumColumns(PetscInt N, PetscInt Ncol, const PetscReal idx[], PetscViewer viewer)
550d71ae5a4SJacob Faibussowitsch {
551ca0c3be5SJacob Faibussowitsch   PetscMPIInt rank, size;
552*57b47c28SJames Wright   PetscInt    j, i, n = N / Ncol, p = N % Ncol;
553ace3abfcSBarry Smith   PetscBool   iascii, isbinary;
554e5c89e4eSSatish Balay   MPI_Comm    comm;
555e5c89e4eSSatish Balay 
556e5c89e4eSSatish Balay   PetscFunctionBegin;
557e5c89e4eSSatish Balay   if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF;
558*57b47c28SJames Wright   if (N) PetscAssertPointer(idx, 3);
559*57b47c28SJames Wright   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 4);
5609566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)viewer, &comm));
5619566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
5629566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
563e5c89e4eSSatish Balay 
5649566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
5659566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERBINARY, &isbinary));
566e5c89e4eSSatish Balay   if (iascii) {
5671a989b97SToby Isaac     PetscInt tab;
5681a989b97SToby Isaac 
5699566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushSynchronized(viewer));
5709566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIGetTab(viewer, &tab));
571e5c89e4eSSatish Balay     for (i = 0; i < n; i++) {
5729566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISetTab(viewer, tab));
573ca0c3be5SJacob Faibussowitsch       if (size > 1) {
574*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "[%d] %2" PetscInt_FMT ":", rank, Ncol * i));
575ca0c3be5SJacob Faibussowitsch       } else {
576*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%2" PetscInt_FMT ":", Ncol * i));
577ca0c3be5SJacob Faibussowitsch       }
5789566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISetTab(viewer, 0));
579*57b47c28SJames Wright       for (j = 0; j < Ncol; j++) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %12.4e", (double)idx[i * Ncol + j]));
5809566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n"));
581e5c89e4eSSatish Balay     }
582e5c89e4eSSatish Balay     if (p) {
5839566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISetTab(viewer, tab));
584ca0c3be5SJacob Faibussowitsch       if (size > 1) {
585*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "[%d] %2" PetscInt_FMT ":", rank, Ncol * n));
586ca0c3be5SJacob Faibussowitsch       } else {
587*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%2" PetscInt_FMT ":", Ncol * n));
588ca0c3be5SJacob Faibussowitsch       }
5899566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISetTab(viewer, 0));
590*57b47c28SJames Wright       for (i = 0; i < p; i++) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %12.4e", (double)idx[Ncol * n + i]));
5919566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n"));
592e5c89e4eSSatish Balay     }
5939566063dSJacob Faibussowitsch     PetscCall(PetscViewerFlush(viewer));
5949566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIISetTab(viewer, tab));
5959566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopSynchronized(viewer));
5966805f65bSBarry Smith   } else if (isbinary) {
597ca0c3be5SJacob Faibussowitsch     PetscMPIInt *sizes, *displs, Ntotal, NN;
598e5c89e4eSSatish Balay     PetscReal   *array;
599e5c89e4eSSatish Balay 
6009566063dSJacob Faibussowitsch     PetscCall(PetscMPIIntCast(N, &NN));
601e5c89e4eSSatish Balay 
602e5c89e4eSSatish Balay     if (size > 1) {
603e5c89e4eSSatish Balay       if (rank) {
6049566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Gather(&NN, 1, MPI_INT, NULL, 0, MPI_INT, 0, comm));
605835f2295SStefano Zampini         PetscCallMPI(MPI_Gatherv(idx, NN, MPIU_REAL, NULL, NULL, NULL, MPIU_REAL, 0, comm));
606e5c89e4eSSatish Balay       } else {
6079566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(size, &sizes));
6089566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Gather(&NN, 1, MPI_INT, sizes, 1, MPI_INT, 0, comm));
609e5c89e4eSSatish Balay         Ntotal = sizes[0];
6109566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(size, &displs));
611e5c89e4eSSatish Balay         displs[0] = 0;
612e5c89e4eSSatish Balay         for (i = 1; i < size; i++) {
613e5c89e4eSSatish Balay           Ntotal += sizes[i];
614e5c89e4eSSatish Balay           displs[i] = displs[i - 1] + sizes[i - 1];
615e5c89e4eSSatish Balay         }
6169566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(Ntotal, &array));
617835f2295SStefano Zampini         PetscCallMPI(MPI_Gatherv(idx, NN, MPIU_REAL, array, sizes, displs, MPIU_REAL, 0, comm));
6189566063dSJacob Faibussowitsch         PetscCall(PetscViewerBinaryWrite(viewer, array, Ntotal, PETSC_REAL));
6199566063dSJacob Faibussowitsch         PetscCall(PetscFree(sizes));
6209566063dSJacob Faibussowitsch         PetscCall(PetscFree(displs));
6219566063dSJacob Faibussowitsch         PetscCall(PetscFree(array));
622e5c89e4eSSatish Balay       }
623e5c89e4eSSatish Balay     } else {
6249566063dSJacob Faibussowitsch       PetscCall(PetscViewerBinaryWrite(viewer, (void *)idx, N, PETSC_REAL));
625e5c89e4eSSatish Balay     }
626e5c89e4eSSatish Balay   } else {
627e5c89e4eSSatish Balay     const char *tname;
6289566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject)viewer, &tname));
62998921bdaSJacob Faibussowitsch     SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot handle that PetscViewer of type %s", tname);
630e5c89e4eSSatish Balay   }
6313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
632e5c89e4eSSatish Balay }
633e5c89e4eSSatish Balay 
634ffeef943SBarry Smith /*@
635*57b47c28SJames Wright   PetscScalarViewNumColumns - Prints an array of doubles; useful for debugging.
636e5c89e4eSSatish Balay 
637c3339decSBarry Smith   Collective
638e5c89e4eSSatish Balay 
639e5c89e4eSSatish Balay   Input Parameters:
640*57b47c28SJames Wright + N      - number of `PetscScalar` in array
641*57b47c28SJames Wright . Ncol   - number of `PetscScalar` to print per row
642*57b47c28SJames Wright . idx    - array of `PetscScalar`
643811af0c4SBarry Smith - viewer - location to print array, `PETSC_VIEWER_STDOUT_WORLD`, `PETSC_VIEWER_STDOUT_SELF` or 0
644e5c89e4eSSatish Balay 
645e5c89e4eSSatish Balay   Level: intermediate
646e5c89e4eSSatish Balay 
647811af0c4SBarry Smith   Note:
648a3b724e8SBarry Smith   This may be called from within the debugger, passing 0 as the viewer
649300a7f5bSBarry Smith 
6506e25c4a1SBarry Smith   Developer Note:
651*57b47c28SJames Wright   `idx` cannot be const because may be passed to binary viewer where temporary byte swapping may be done
652811af0c4SBarry Smith 
653*57b47c28SJames Wright .seealso: `PetscViewer`, `PetscRealView()`, `PetscScalarView()`, `PetscIntView()`
654e5c89e4eSSatish Balay @*/
655*57b47c28SJames Wright PetscErrorCode PetscScalarViewNumColumns(PetscInt N, PetscInt Ncol, const PetscScalar idx[], PetscViewer viewer)
656d71ae5a4SJacob Faibussowitsch {
657ca0c3be5SJacob Faibussowitsch   PetscMPIInt rank, size;
658*57b47c28SJames Wright   PetscInt    j, i, n = N / Ncol, p = N % Ncol;
659ace3abfcSBarry Smith   PetscBool   iascii, isbinary;
660e5c89e4eSSatish Balay   MPI_Comm    comm;
661e5c89e4eSSatish Balay 
662e5c89e4eSSatish Balay   PetscFunctionBegin;
663e5c89e4eSSatish Balay   if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF;
664*57b47c28SJames Wright   if (N) PetscAssertPointer(idx, 3);
665*57b47c28SJames Wright   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 4);
6669566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)viewer, &comm));
6679566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
6689566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
669e5c89e4eSSatish Balay 
6709566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
6719566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERBINARY, &isbinary));
672e5c89e4eSSatish Balay   if (iascii) {
6739566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushSynchronized(viewer));
674e5c89e4eSSatish Balay     for (i = 0; i < n; i++) {
675ca0c3be5SJacob Faibussowitsch       if (size > 1) {
676*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "[%d] %2" PetscInt_FMT ":", rank, Ncol * i));
677ca0c3be5SJacob Faibussowitsch       } else {
678*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%2" PetscInt_FMT ":", Ncol * i));
679ca0c3be5SJacob Faibussowitsch       }
680*57b47c28SJames Wright       for (j = 0; j < Ncol; j++) {
681e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
682*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " (%12.4e,%12.4e)", (double)PetscRealPart(idx[i * Ncol + j]), (double)PetscImaginaryPart(idx[i * Ncol + j])));
683e5c89e4eSSatish Balay #else
684*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %12.4e", (double)idx[i * Ncol + j]));
685e5c89e4eSSatish Balay #endif
686e5c89e4eSSatish Balay       }
6879566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n"));
688e5c89e4eSSatish Balay     }
689e5c89e4eSSatish Balay     if (p) {
690ca0c3be5SJacob Faibussowitsch       if (size > 1) {
691*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "[%d] %2" PetscInt_FMT ":", rank, Ncol * n));
692ca0c3be5SJacob Faibussowitsch       } else {
693*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%2" PetscInt_FMT ":", Ncol * n));
694ca0c3be5SJacob Faibussowitsch       }
695e5c89e4eSSatish Balay       for (i = 0; i < p; i++) {
696e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
697*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " (%12.4e,%12.4e)", (double)PetscRealPart(idx[n * Ncol + i]), (double)PetscImaginaryPart(idx[n * Ncol + i])));
698e5c89e4eSSatish Balay #else
699*57b47c28SJames Wright         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %12.4e", (double)idx[Ncol * n + i]));
700e5c89e4eSSatish Balay #endif
701e5c89e4eSSatish Balay       }
7029566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n"));
703e5c89e4eSSatish Balay     }
7049566063dSJacob Faibussowitsch     PetscCall(PetscViewerFlush(viewer));
7059566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopSynchronized(viewer));
7066805f65bSBarry Smith   } else if (isbinary) {
707ca0c3be5SJacob Faibussowitsch     PetscMPIInt *sizes, Ntotal, *displs, NN;
708e5c89e4eSSatish Balay     PetscScalar *array;
709e5c89e4eSSatish Balay 
7109566063dSJacob Faibussowitsch     PetscCall(PetscMPIIntCast(N, &NN));
711e5c89e4eSSatish Balay 
712e5c89e4eSSatish Balay     if (size > 1) {
713e5c89e4eSSatish Balay       if (rank) {
7149566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Gather(&NN, 1, MPI_INT, NULL, 0, MPI_INT, 0, comm));
7159566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Gatherv((void *)idx, NN, MPIU_SCALAR, NULL, NULL, NULL, MPIU_SCALAR, 0, comm));
716e5c89e4eSSatish Balay       } else {
7179566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(size, &sizes));
7189566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Gather(&NN, 1, MPI_INT, sizes, 1, MPI_INT, 0, comm));
719e5c89e4eSSatish Balay         Ntotal = sizes[0];
7209566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(size, &displs));
721e5c89e4eSSatish Balay         displs[0] = 0;
722e5c89e4eSSatish Balay         for (i = 1; i < size; i++) {
723e5c89e4eSSatish Balay           Ntotal += sizes[i];
724e5c89e4eSSatish Balay           displs[i] = displs[i - 1] + sizes[i - 1];
725e5c89e4eSSatish Balay         }
7269566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(Ntotal, &array));
7279566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Gatherv((void *)idx, NN, MPIU_SCALAR, array, sizes, displs, MPIU_SCALAR, 0, comm));
7289566063dSJacob Faibussowitsch         PetscCall(PetscViewerBinaryWrite(viewer, array, Ntotal, PETSC_SCALAR));
7299566063dSJacob Faibussowitsch         PetscCall(PetscFree(sizes));
7309566063dSJacob Faibussowitsch         PetscCall(PetscFree(displs));
7319566063dSJacob Faibussowitsch         PetscCall(PetscFree(array));
732e5c89e4eSSatish Balay       }
733e5c89e4eSSatish Balay     } else {
7349566063dSJacob Faibussowitsch       PetscCall(PetscViewerBinaryWrite(viewer, (void *)idx, N, PETSC_SCALAR));
735e5c89e4eSSatish Balay     }
736e5c89e4eSSatish Balay   } else {
737e5c89e4eSSatish Balay     const char *tname;
7389566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject)viewer, &tname));
73998921bdaSJacob Faibussowitsch     SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot handle that PetscViewer of type %s", tname);
740e5c89e4eSSatish Balay   }
7413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
742e5c89e4eSSatish Balay }
743e5c89e4eSSatish Balay 
744*57b47c28SJames Wright /*@
745*57b47c28SJames Wright   PetscIntView - Prints an array of integers; useful for debugging.
746*57b47c28SJames Wright 
747*57b47c28SJames Wright   Collective
748*57b47c28SJames Wright 
749*57b47c28SJames Wright   Input Parameters:
750*57b47c28SJames Wright + N      - number of integers in array
751*57b47c28SJames Wright . idx    - array of integers
752*57b47c28SJames Wright - viewer - location to print array, `PETSC_VIEWER_STDOUT_WORLD`, `PETSC_VIEWER_STDOUT_SELF` or 0
753*57b47c28SJames Wright 
754*57b47c28SJames Wright   Level: intermediate
755*57b47c28SJames Wright 
756*57b47c28SJames Wright   Note:
757*57b47c28SJames Wright   This may be called from within the debugger, passing 0 as the viewer
758*57b47c28SJames Wright 
759*57b47c28SJames Wright   Same as `PetscIntViewNumColumns()` with 20 values per row
760*57b47c28SJames Wright 
761*57b47c28SJames Wright   Developer Note:
762*57b47c28SJames Wright   `idx` cannot be const because may be passed to binary viewer where temporary byte swapping may be done
763*57b47c28SJames Wright 
764*57b47c28SJames Wright .seealso: `PetscViewer`, `PetscIntViewNumColumns()`, `PetscRealView()`
765*57b47c28SJames Wright @*/
766*57b47c28SJames Wright PetscErrorCode PetscIntView(PetscInt N, const PetscInt idx[], PetscViewer viewer)
767*57b47c28SJames Wright {
768*57b47c28SJames Wright   PetscFunctionBegin;
769*57b47c28SJames Wright   PetscCall(PetscIntViewNumColumns(N, 20, idx, viewer));
770*57b47c28SJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
771*57b47c28SJames Wright }
772*57b47c28SJames Wright 
773*57b47c28SJames Wright /*@
774*57b47c28SJames Wright   PetscRealView - Prints an array of doubles; useful for debugging.
775*57b47c28SJames Wright 
776*57b47c28SJames Wright   Collective
777*57b47c28SJames Wright 
778*57b47c28SJames Wright   Input Parameters:
779*57b47c28SJames Wright + N      - number of `PetscReal` in array
780*57b47c28SJames Wright . idx    - array of `PetscReal`
781*57b47c28SJames Wright - viewer - location to print array, `PETSC_VIEWER_STDOUT_WORLD`, `PETSC_VIEWER_STDOUT_SELF` or 0
782*57b47c28SJames Wright 
783*57b47c28SJames Wright   Level: intermediate
784*57b47c28SJames Wright 
785*57b47c28SJames Wright   Note:
786*57b47c28SJames Wright   This may be called from within the debugger, passing 0 as the viewer
787*57b47c28SJames Wright 
788*57b47c28SJames Wright   Same as `PetscRealViewNumColumns()` with 5 values per row
789*57b47c28SJames Wright 
790*57b47c28SJames Wright   Developer Note:
791*57b47c28SJames Wright   `idx` cannot be const because may be passed to binary viewer where temporary byte swapping may be done
792*57b47c28SJames Wright 
793*57b47c28SJames Wright .seealso: `PetscViewer`, `PetscIntView()`
794*57b47c28SJames Wright @*/
795*57b47c28SJames Wright PetscErrorCode PetscRealView(PetscInt N, const PetscReal idx[], PetscViewer viewer)
796*57b47c28SJames Wright {
797*57b47c28SJames Wright   PetscFunctionBegin;
798*57b47c28SJames Wright   PetscCall(PetscRealViewNumColumns(N, 5, idx, viewer));
799*57b47c28SJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
800*57b47c28SJames Wright }
801*57b47c28SJames Wright 
802*57b47c28SJames Wright /*@
803*57b47c28SJames Wright   PetscScalarView - Prints an array of `PetscScalar`; useful for debugging.
804*57b47c28SJames Wright 
805*57b47c28SJames Wright   Collective
806*57b47c28SJames Wright 
807*57b47c28SJames Wright   Input Parameters:
808*57b47c28SJames Wright + N      - number of scalars in array
809*57b47c28SJames Wright . idx    - array of scalars
810*57b47c28SJames Wright - viewer - location to print array, `PETSC_VIEWER_STDOUT_WORLD`, `PETSC_VIEWER_STDOUT_SELF` or 0
811*57b47c28SJames Wright 
812*57b47c28SJames Wright   Level: intermediate
813*57b47c28SJames Wright 
814*57b47c28SJames Wright   Note:
815*57b47c28SJames Wright   This may be called from within the debugger, passing 0 as the viewer
816*57b47c28SJames Wright 
817*57b47c28SJames Wright   Same as `PetscScalarViewNumColumns()` with 3 values per row
818*57b47c28SJames Wright 
819*57b47c28SJames Wright   Developer Note:
820*57b47c28SJames Wright   `idx` cannot be const because may be passed to binary viewer where byte swapping may be done
821*57b47c28SJames Wright 
822*57b47c28SJames Wright .seealso: `PetscViewer`, `PetscIntView()`, `PetscRealView()`
823*57b47c28SJames Wright @*/
824*57b47c28SJames Wright PetscErrorCode PetscScalarView(PetscInt N, const PetscScalar idx[], PetscViewer viewer)
825*57b47c28SJames Wright {
826*57b47c28SJames Wright   PetscFunctionBegin;
827*57b47c28SJames Wright   PetscCall(PetscScalarViewNumColumns(N, 3, idx, viewer));
828*57b47c28SJames Wright   PetscFunctionReturn(PETSC_SUCCESS);
829*57b47c28SJames Wright }
830*57b47c28SJames Wright 
831e22e20c5SJunchao Zhang #if defined(PETSC_HAVE_CUDA)
8320e6b6b59SJacob Faibussowitsch   #include <petscdevice_cuda.h>
833d71ae5a4SJacob Faibussowitsch PETSC_EXTERN const char *PetscCUBLASGetErrorName(cublasStatus_t status)
834d71ae5a4SJacob Faibussowitsch {
835e22e20c5SJunchao Zhang   switch (status) {
836e22e20c5SJunchao Zhang   #if (CUDART_VERSION >= 8000) /* At least CUDA 8.0 of Sep. 2016 had these */
837d71ae5a4SJacob Faibussowitsch   case CUBLAS_STATUS_SUCCESS:
838d71ae5a4SJacob Faibussowitsch     return "CUBLAS_STATUS_SUCCESS";
839d71ae5a4SJacob Faibussowitsch   case CUBLAS_STATUS_NOT_INITIALIZED:
840d71ae5a4SJacob Faibussowitsch     return "CUBLAS_STATUS_NOT_INITIALIZED";
841d71ae5a4SJacob Faibussowitsch   case CUBLAS_STATUS_ALLOC_FAILED:
842d71ae5a4SJacob Faibussowitsch     return "CUBLAS_STATUS_ALLOC_FAILED";
843d71ae5a4SJacob Faibussowitsch   case CUBLAS_STATUS_INVALID_VALUE:
844d71ae5a4SJacob Faibussowitsch     return "CUBLAS_STATUS_INVALID_VALUE";
845d71ae5a4SJacob Faibussowitsch   case CUBLAS_STATUS_ARCH_MISMATCH:
846d71ae5a4SJacob Faibussowitsch     return "CUBLAS_STATUS_ARCH_MISMATCH";
847d71ae5a4SJacob Faibussowitsch   case CUBLAS_STATUS_MAPPING_ERROR:
848d71ae5a4SJacob Faibussowitsch     return "CUBLAS_STATUS_MAPPING_ERROR";
849d71ae5a4SJacob Faibussowitsch   case CUBLAS_STATUS_EXECUTION_FAILED:
850d71ae5a4SJacob Faibussowitsch     return "CUBLAS_STATUS_EXECUTION_FAILED";
851d71ae5a4SJacob Faibussowitsch   case CUBLAS_STATUS_INTERNAL_ERROR:
852d71ae5a4SJacob Faibussowitsch     return "CUBLAS_STATUS_INTERNAL_ERROR";
853d71ae5a4SJacob Faibussowitsch   case CUBLAS_STATUS_NOT_SUPPORTED:
854d71ae5a4SJacob Faibussowitsch     return "CUBLAS_STATUS_NOT_SUPPORTED";
855d71ae5a4SJacob Faibussowitsch   case CUBLAS_STATUS_LICENSE_ERROR:
856d71ae5a4SJacob Faibussowitsch     return "CUBLAS_STATUS_LICENSE_ERROR";
857e22e20c5SJunchao Zhang   #endif
858d71ae5a4SJacob Faibussowitsch   default:
859d71ae5a4SJacob Faibussowitsch     return "unknown error";
860e22e20c5SJunchao Zhang   }
861e22e20c5SJunchao Zhang }
862d71ae5a4SJacob Faibussowitsch PETSC_EXTERN const char *PetscCUSolverGetErrorName(cusolverStatus_t status)
863d71ae5a4SJacob Faibussowitsch {
864a4b895e1SBarry Smith   switch (status) {
865a4b895e1SBarry Smith   #if (CUDART_VERSION >= 8000) /* At least CUDA 8.0 of Sep. 2016 had these */
866d71ae5a4SJacob Faibussowitsch   case CUSOLVER_STATUS_SUCCESS:
867d71ae5a4SJacob Faibussowitsch     return "CUSOLVER_STATUS_SUCCESS";
868d71ae5a4SJacob Faibussowitsch   case CUSOLVER_STATUS_NOT_INITIALIZED:
869d71ae5a4SJacob Faibussowitsch     return "CUSOLVER_STATUS_NOT_INITIALIZED";
870d71ae5a4SJacob Faibussowitsch   case CUSOLVER_STATUS_INVALID_VALUE:
871d71ae5a4SJacob Faibussowitsch     return "CUSOLVER_STATUS_INVALID_VALUE";
872d71ae5a4SJacob Faibussowitsch   case CUSOLVER_STATUS_ARCH_MISMATCH:
873d71ae5a4SJacob Faibussowitsch     return "CUSOLVER_STATUS_ARCH_MISMATCH";
874d71ae5a4SJacob Faibussowitsch   case CUSOLVER_STATUS_INTERNAL_ERROR:
875d71ae5a4SJacob Faibussowitsch     return "CUSOLVER_STATUS_INTERNAL_ERROR";
876030f984aSJacob Faibussowitsch     #if (CUDART_VERSION >= 9000) /* CUDA 9.0 had these defined on June 2021 */
877d71ae5a4SJacob Faibussowitsch   case CUSOLVER_STATUS_ALLOC_FAILED:
878d71ae5a4SJacob Faibussowitsch     return "CUSOLVER_STATUS_ALLOC_FAILED";
879d71ae5a4SJacob Faibussowitsch   case CUSOLVER_STATUS_MAPPING_ERROR:
880d71ae5a4SJacob Faibussowitsch     return "CUSOLVER_STATUS_MAPPING_ERROR";
881d71ae5a4SJacob Faibussowitsch   case CUSOLVER_STATUS_EXECUTION_FAILED:
882d71ae5a4SJacob Faibussowitsch     return "CUSOLVER_STATUS_EXECUTION_FAILED";
883d71ae5a4SJacob Faibussowitsch   case CUSOLVER_STATUS_MATRIX_TYPE_NOT_SUPPORTED:
884d71ae5a4SJacob Faibussowitsch     return "CUSOLVER_STATUS_MATRIX_TYPE_NOT_SUPPORTED";
885d71ae5a4SJacob Faibussowitsch   case CUSOLVER_STATUS_NOT_SUPPORTED:
886d71ae5a4SJacob Faibussowitsch     return "CUSOLVER_STATUS_NOT_SUPPORTED ";
887d71ae5a4SJacob Faibussowitsch   case CUSOLVER_STATUS_ZERO_PIVOT:
888d71ae5a4SJacob Faibussowitsch     return "CUSOLVER_STATUS_ZERO_PIVOT";
889d71ae5a4SJacob Faibussowitsch   case CUSOLVER_STATUS_INVALID_LICENSE:
890d71ae5a4SJacob Faibussowitsch     return "CUSOLVER_STATUS_INVALID_LICENSE";
891a4b895e1SBarry Smith     #endif
892030f984aSJacob Faibussowitsch   #endif
893d71ae5a4SJacob Faibussowitsch   default:
894d71ae5a4SJacob Faibussowitsch     return "unknown error";
895030f984aSJacob Faibussowitsch   }
896030f984aSJacob Faibussowitsch }
897d71ae5a4SJacob Faibussowitsch PETSC_EXTERN const char *PetscCUFFTGetErrorName(cufftResult result)
898d71ae5a4SJacob Faibussowitsch {
899030f984aSJacob Faibussowitsch   switch (result) {
900d71ae5a4SJacob Faibussowitsch   case CUFFT_SUCCESS:
901d71ae5a4SJacob Faibussowitsch     return "CUFFT_SUCCESS";
902d71ae5a4SJacob Faibussowitsch   case CUFFT_INVALID_PLAN:
903d71ae5a4SJacob Faibussowitsch     return "CUFFT_INVALID_PLAN";
904d71ae5a4SJacob Faibussowitsch   case CUFFT_ALLOC_FAILED:
905d71ae5a4SJacob Faibussowitsch     return "CUFFT_ALLOC_FAILED";
906d71ae5a4SJacob Faibussowitsch   case CUFFT_INVALID_TYPE:
907d71ae5a4SJacob Faibussowitsch     return "CUFFT_INVALID_TYPE";
908d71ae5a4SJacob Faibussowitsch   case CUFFT_INVALID_VALUE:
909d71ae5a4SJacob Faibussowitsch     return "CUFFT_INVALID_VALUE";
910d71ae5a4SJacob Faibussowitsch   case CUFFT_INTERNAL_ERROR:
911d71ae5a4SJacob Faibussowitsch     return "CUFFT_INTERNAL_ERROR";
912d71ae5a4SJacob Faibussowitsch   case CUFFT_EXEC_FAILED:
913d71ae5a4SJacob Faibussowitsch     return "CUFFT_EXEC_FAILED";
914d71ae5a4SJacob Faibussowitsch   case CUFFT_SETUP_FAILED:
915d71ae5a4SJacob Faibussowitsch     return "CUFFT_SETUP_FAILED";
916d71ae5a4SJacob Faibussowitsch   case CUFFT_INVALID_SIZE:
917d71ae5a4SJacob Faibussowitsch     return "CUFFT_INVALID_SIZE";
918d71ae5a4SJacob Faibussowitsch   case CUFFT_UNALIGNED_DATA:
919d71ae5a4SJacob Faibussowitsch     return "CUFFT_UNALIGNED_DATA";
920d71ae5a4SJacob Faibussowitsch   case CUFFT_INCOMPLETE_PARAMETER_LIST:
921d71ae5a4SJacob Faibussowitsch     return "CUFFT_INCOMPLETE_PARAMETER_LIST";
922d71ae5a4SJacob Faibussowitsch   case CUFFT_INVALID_DEVICE:
923d71ae5a4SJacob Faibussowitsch     return "CUFFT_INVALID_DEVICE";
924d71ae5a4SJacob Faibussowitsch   case CUFFT_PARSE_ERROR:
925d71ae5a4SJacob Faibussowitsch     return "CUFFT_PARSE_ERROR";
926d71ae5a4SJacob Faibussowitsch   case CUFFT_NO_WORKSPACE:
927d71ae5a4SJacob Faibussowitsch     return "CUFFT_NO_WORKSPACE";
928d71ae5a4SJacob Faibussowitsch   case CUFFT_NOT_IMPLEMENTED:
929d71ae5a4SJacob Faibussowitsch     return "CUFFT_NOT_IMPLEMENTED";
930d71ae5a4SJacob Faibussowitsch   case CUFFT_LICENSE_ERROR:
931d71ae5a4SJacob Faibussowitsch     return "CUFFT_LICENSE_ERROR";
932d71ae5a4SJacob Faibussowitsch   case CUFFT_NOT_SUPPORTED:
933d71ae5a4SJacob Faibussowitsch     return "CUFFT_NOT_SUPPORTED";
934d71ae5a4SJacob Faibussowitsch   default:
935d71ae5a4SJacob Faibussowitsch     return "unknown error";
936a4b895e1SBarry Smith   }
937a4b895e1SBarry Smith }
938e22e20c5SJunchao Zhang #endif
93959af0bd3SScott Kruger 
94059af0bd3SScott Kruger #if defined(PETSC_HAVE_HIP)
9410e6b6b59SJacob Faibussowitsch   #include <petscdevice_hip.h>
942d71ae5a4SJacob Faibussowitsch PETSC_EXTERN const char *PetscHIPBLASGetErrorName(hipblasStatus_t status)
943d71ae5a4SJacob Faibussowitsch {
94459af0bd3SScott Kruger   switch (status) {
945d71ae5a4SJacob Faibussowitsch   case HIPBLAS_STATUS_SUCCESS:
946d71ae5a4SJacob Faibussowitsch     return "HIPBLAS_STATUS_SUCCESS";
947d71ae5a4SJacob Faibussowitsch   case HIPBLAS_STATUS_NOT_INITIALIZED:
948d71ae5a4SJacob Faibussowitsch     return "HIPBLAS_STATUS_NOT_INITIALIZED";
949d71ae5a4SJacob Faibussowitsch   case HIPBLAS_STATUS_ALLOC_FAILED:
950d71ae5a4SJacob Faibussowitsch     return "HIPBLAS_STATUS_ALLOC_FAILED";
951d71ae5a4SJacob Faibussowitsch   case HIPBLAS_STATUS_INVALID_VALUE:
952d71ae5a4SJacob Faibussowitsch     return "HIPBLAS_STATUS_INVALID_VALUE";
953d71ae5a4SJacob Faibussowitsch   case HIPBLAS_STATUS_ARCH_MISMATCH:
954d71ae5a4SJacob Faibussowitsch     return "HIPBLAS_STATUS_ARCH_MISMATCH";
955d71ae5a4SJacob Faibussowitsch   case HIPBLAS_STATUS_MAPPING_ERROR:
956d71ae5a4SJacob Faibussowitsch     return "HIPBLAS_STATUS_MAPPING_ERROR";
957d71ae5a4SJacob Faibussowitsch   case HIPBLAS_STATUS_EXECUTION_FAILED:
958d71ae5a4SJacob Faibussowitsch     return "HIPBLAS_STATUS_EXECUTION_FAILED";
959d71ae5a4SJacob Faibussowitsch   case HIPBLAS_STATUS_INTERNAL_ERROR:
960d71ae5a4SJacob Faibussowitsch     return "HIPBLAS_STATUS_INTERNAL_ERROR";
961d71ae5a4SJacob Faibussowitsch   case HIPBLAS_STATUS_NOT_SUPPORTED:
962d71ae5a4SJacob Faibussowitsch     return "HIPBLAS_STATUS_NOT_SUPPORTED";
963d71ae5a4SJacob Faibussowitsch   default:
964d71ae5a4SJacob Faibussowitsch     return "unknown error";
96559af0bd3SScott Kruger   }
96659af0bd3SScott Kruger }
96747d993e7Ssuyashtn PETSC_EXTERN const char *PetscHIPSPARSEGetErrorName(hipsparseStatus_t status)
96847d993e7Ssuyashtn {
96947d993e7Ssuyashtn   switch (status) {
97047d993e7Ssuyashtn   case HIPSPARSE_STATUS_SUCCESS:
97147d993e7Ssuyashtn     return "HIPSPARSE_STATUS_SUCCESS";
97247d993e7Ssuyashtn   case HIPSPARSE_STATUS_NOT_INITIALIZED:
97347d993e7Ssuyashtn     return "HIPSPARSE_STATUS_NOT_INITIALIZED";
97447d993e7Ssuyashtn   case HIPSPARSE_STATUS_ALLOC_FAILED:
97547d993e7Ssuyashtn     return "HIPSPARSE_STATUS_ALLOC_FAILED";
97647d993e7Ssuyashtn   case HIPSPARSE_STATUS_INVALID_VALUE:
97747d993e7Ssuyashtn     return "HIPSPARSE_STATUS_INVALID_VALUE";
97847d993e7Ssuyashtn   case HIPSPARSE_STATUS_ARCH_MISMATCH:
97947d993e7Ssuyashtn     return "HIPSPARSE_STATUS_ARCH_MISMATCH";
98047d993e7Ssuyashtn   case HIPSPARSE_STATUS_MAPPING_ERROR:
98147d993e7Ssuyashtn     return "HIPSPARSE_STATUS_MAPPING_ERROR";
98247d993e7Ssuyashtn   case HIPSPARSE_STATUS_EXECUTION_FAILED:
98347d993e7Ssuyashtn     return "HIPSPARSE_STATUS_EXECUTION_FAILED";
98447d993e7Ssuyashtn   case HIPSPARSE_STATUS_INTERNAL_ERROR:
98547d993e7Ssuyashtn     return "HIPSPARSE_STATUS_INTERNAL_ERROR";
98647d993e7Ssuyashtn   case HIPSPARSE_STATUS_MATRIX_TYPE_NOT_SUPPORTED:
98747d993e7Ssuyashtn     return "HIPSPARSE_STATUS_MATRIX_TYPE_NOT_SUPPORTED";
98847d993e7Ssuyashtn   case HIPSPARSE_STATUS_ZERO_PIVOT:
98947d993e7Ssuyashtn     return "HIPSPARSE_STATUS_ZERO_PIVOT";
99047d993e7Ssuyashtn   case HIPSPARSE_STATUS_NOT_SUPPORTED:
99147d993e7Ssuyashtn     return "HIPSPARSE_STATUS_NOT_SUPPORTED";
99247d993e7Ssuyashtn   case HIPSPARSE_STATUS_INSUFFICIENT_RESOURCES:
99347d993e7Ssuyashtn     return "HIPSPARSE_STATUS_INSUFFICIENT_RESOURCES";
99447d993e7Ssuyashtn   default:
99547d993e7Ssuyashtn     return "unknown error";
99647d993e7Ssuyashtn   }
99747d993e7Ssuyashtn }
99847d993e7Ssuyashtn PETSC_EXTERN const char *PetscHIPSolverGetErrorName(hipsolverStatus_t status)
99947d993e7Ssuyashtn {
100047d993e7Ssuyashtn   switch (status) {
100147d993e7Ssuyashtn   case HIPSOLVER_STATUS_SUCCESS:
100247d993e7Ssuyashtn     return "HIPSOLVER_STATUS_SUCCESS";
100347d993e7Ssuyashtn   case HIPSOLVER_STATUS_NOT_INITIALIZED:
100447d993e7Ssuyashtn     return "HIPSOLVER_STATUS_NOT_INITIALIZED";
100547d993e7Ssuyashtn   case HIPSOLVER_STATUS_ALLOC_FAILED:
100647d993e7Ssuyashtn     return "HIPSOLVER_STATUS_ALLOC_FAILED";
100747d993e7Ssuyashtn   case HIPSOLVER_STATUS_MAPPING_ERROR:
100847d993e7Ssuyashtn     return "HIPSOLVER_STATUS_MAPPING_ERROR";
100947d993e7Ssuyashtn   case HIPSOLVER_STATUS_INVALID_VALUE:
101047d993e7Ssuyashtn     return "HIPSOLVER_STATUS_INVALID_VALUE";
101147d993e7Ssuyashtn   case HIPSOLVER_STATUS_EXECUTION_FAILED:
101247d993e7Ssuyashtn     return "HIPSOLVER_STATUS_EXECUTION_FAILED";
101347d993e7Ssuyashtn   case HIPSOLVER_STATUS_INTERNAL_ERROR:
101447d993e7Ssuyashtn     return "HIPSOLVER_STATUS_INTERNAL_ERROR";
101547d993e7Ssuyashtn   case HIPSOLVER_STATUS_NOT_SUPPORTED:
101647d993e7Ssuyashtn     return "HIPSOLVER_STATUS_NOT_SUPPORTED ";
101747d993e7Ssuyashtn   case HIPSOLVER_STATUS_ARCH_MISMATCH:
101847d993e7Ssuyashtn     return "HIPSOLVER_STATUS_ARCH_MISMATCH";
101947d993e7Ssuyashtn   case HIPSOLVER_STATUS_HANDLE_IS_NULLPTR:
102047d993e7Ssuyashtn     return "HIPSOLVER_STATUS_HANDLE_IS_NULLPTR";
102147d993e7Ssuyashtn   case HIPSOLVER_STATUS_INVALID_ENUM:
102247d993e7Ssuyashtn     return "HIPSOLVER_STATUS_INVALID_ENUM";
102347d993e7Ssuyashtn   case HIPSOLVER_STATUS_UNKNOWN:
102447d993e7Ssuyashtn   default:
102547d993e7Ssuyashtn     return "HIPSOLVER_STATUS_UNKNOWN";
102647d993e7Ssuyashtn   }
102747d993e7Ssuyashtn }
102859af0bd3SScott Kruger #endif
1029db9cea48SBarry Smith 
1030aec76313SJacob Faibussowitsch /*@C
1031811af0c4SBarry Smith   PetscMPIErrorString - Given an MPI error code returns the `MPI_Error_string()` appropriately
1032db9cea48SBarry Smith   formatted for displaying with the PETSc error handlers.
1033db9cea48SBarry Smith 
1034cc4c1da9SBarry Smith   Not Collective, No Fortran Support
1035cc4c1da9SBarry Smith 
1036a1fd7ae3SBarry Smith   Input Parameters:
1037a1fd7ae3SBarry Smith + err  - the MPI error code
1038a1fd7ae3SBarry Smith - slen - length of `string`, should be at least as large as `MPI_MAX_ERROR_STRING`
1039db9cea48SBarry Smith 
1040db9cea48SBarry Smith   Output Parameter:
1041a1fd7ae3SBarry Smith . string - the MPI error message
1042db9cea48SBarry Smith 
104349c86fc7SBarry Smith   Level: developer
104449c86fc7SBarry Smith 
1045811af0c4SBarry Smith   Note:
1046db9cea48SBarry Smith   Does not return an error code or do error handling because it may be called from inside an error handler
1047db9cea48SBarry Smith 
104810450e9eSJacob Faibussowitsch .seealso: `PetscErrorCode` `PetscErrorMessage()`
1049db9cea48SBarry Smith @*/
1050a1fd7ae3SBarry Smith void PetscMPIErrorString(PetscMPIInt err, size_t slen, char *string)
1051d71ae5a4SJacob Faibussowitsch {
1052db9cea48SBarry Smith   char        errorstring[MPI_MAX_ERROR_STRING];
1053a1fd7ae3SBarry Smith   PetscMPIInt len;
1054a1fd7ae3SBarry Smith   size_t      j = 0;
1055db9cea48SBarry Smith 
1056db9cea48SBarry Smith   MPI_Error_string(err, (char *)errorstring, &len);
1057a1fd7ae3SBarry Smith   for (PetscMPIInt i = 0; i < len && j < slen - 2; i++) {
1058db9cea48SBarry Smith     string[j++] = errorstring[i];
1059db9cea48SBarry Smith     if (errorstring[i] == '\n') {
1060a1fd7ae3SBarry Smith       for (PetscMPIInt k = 0; k < 16 && j < slen - 2; k++) string[j++] = ' ';
1061db9cea48SBarry Smith     }
1062db9cea48SBarry Smith   }
1063db9cea48SBarry Smith   string[j] = 0;
1064db9cea48SBarry Smith }
1065