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 /*@ 43157b47c28SJames 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 43757b47c28SJames 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 446*100c51b5SJames Wright This API may be removed in the future. 447*100c51b5SJames Wright 4486e25c4a1SBarry Smith Developer Note: 4496e25c4a1SBarry Smith `idx` cannot be const because may be passed to binary viewer where temporary byte swapping may be done 450811af0c4SBarry Smith 45157b47c28SJames Wright .seealso: `PetscViewer`, `PetscIntView()`, `PetscRealView()` 452e5c89e4eSSatish Balay @*/ 45357b47c28SJames Wright PetscErrorCode PetscIntViewNumColumns(PetscInt N, PetscInt Ncol, const PetscInt idx[], PetscViewer viewer) 454d71ae5a4SJacob Faibussowitsch { 455ca0c3be5SJacob Faibussowitsch PetscMPIInt rank, size; 45657b47c28SJames Wright PetscInt j, i, n = N / Ncol, p = N % Ncol; 457ace3abfcSBarry Smith PetscBool iascii, isbinary; 458e5c89e4eSSatish Balay MPI_Comm comm; 459e5c89e4eSSatish Balay 460e5c89e4eSSatish Balay PetscFunctionBegin; 461e5c89e4eSSatish Balay if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF; 46257b47c28SJames Wright if (N) PetscAssertPointer(idx, 3); 46357b47c28SJames Wright PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 4); 4649566063dSJacob Faibussowitsch PetscCall(PetscObjectGetComm((PetscObject)viewer, &comm)); 4659566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 4669566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 467e5c89e4eSSatish Balay 4689566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii)); 4699566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERBINARY, &isbinary)); 470e5c89e4eSSatish Balay if (iascii) { 4719566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 472e5c89e4eSSatish Balay for (i = 0; i < n; i++) { 473ca0c3be5SJacob Faibussowitsch if (size > 1) { 47457b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "[%d] %" PetscInt_FMT ":", rank, Ncol * i)); 475ca0c3be5SJacob Faibussowitsch } else { 47657b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%" PetscInt_FMT ":", Ncol * i)); 477ca0c3be5SJacob Faibussowitsch } 47857b47c28SJames Wright for (j = 0; j < Ncol; j++) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %" PetscInt_FMT, idx[i * Ncol + j])); 4799566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n")); 480e5c89e4eSSatish Balay } 481e5c89e4eSSatish Balay if (p) { 482ca0c3be5SJacob Faibussowitsch if (size > 1) { 48357b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "[%d] %" PetscInt_FMT ":", rank, Ncol * n)); 484ca0c3be5SJacob Faibussowitsch } else { 48557b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%" PetscInt_FMT ":", Ncol * n)); 486ca0c3be5SJacob Faibussowitsch } 48757b47c28SJames Wright for (i = 0; i < p; i++) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %" PetscInt_FMT, idx[Ncol * n + i])); 4889566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n")); 489e5c89e4eSSatish Balay } 4909566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 4919566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 4926805f65bSBarry Smith } else if (isbinary) { 493ca0c3be5SJacob Faibussowitsch PetscMPIInt *sizes, Ntotal, *displs, NN; 494e5c89e4eSSatish Balay PetscInt *array; 495783b601eSJed Brown 4969566063dSJacob Faibussowitsch PetscCall(PetscMPIIntCast(N, &NN)); 497e5c89e4eSSatish Balay 498e5c89e4eSSatish Balay if (size > 1) { 499e5c89e4eSSatish Balay if (rank) { 5009566063dSJacob Faibussowitsch PetscCallMPI(MPI_Gather(&NN, 1, MPI_INT, NULL, 0, MPI_INT, 0, comm)); 501835f2295SStefano Zampini PetscCallMPI(MPI_Gatherv(idx, NN, MPIU_INT, NULL, NULL, NULL, MPIU_INT, 0, comm)); 502e5c89e4eSSatish Balay } else { 5039566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(size, &sizes)); 5049566063dSJacob Faibussowitsch PetscCallMPI(MPI_Gather(&NN, 1, MPI_INT, sizes, 1, MPI_INT, 0, comm)); 505e5c89e4eSSatish Balay Ntotal = sizes[0]; 5069566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(size, &displs)); 507e5c89e4eSSatish Balay displs[0] = 0; 508e5c89e4eSSatish Balay for (i = 1; i < size; i++) { 509e5c89e4eSSatish Balay Ntotal += sizes[i]; 510e5c89e4eSSatish Balay displs[i] = displs[i - 1] + sizes[i - 1]; 511e5c89e4eSSatish Balay } 5129566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(Ntotal, &array)); 513835f2295SStefano Zampini PetscCallMPI(MPI_Gatherv(idx, NN, MPIU_INT, array, sizes, displs, MPIU_INT, 0, comm)); 5149566063dSJacob Faibussowitsch PetscCall(PetscViewerBinaryWrite(viewer, array, Ntotal, PETSC_INT)); 5159566063dSJacob Faibussowitsch PetscCall(PetscFree(sizes)); 5169566063dSJacob Faibussowitsch PetscCall(PetscFree(displs)); 5179566063dSJacob Faibussowitsch PetscCall(PetscFree(array)); 518e5c89e4eSSatish Balay } 519e5c89e4eSSatish Balay } else { 5209566063dSJacob Faibussowitsch PetscCall(PetscViewerBinaryWrite(viewer, idx, N, PETSC_INT)); 521e5c89e4eSSatish Balay } 522e5c89e4eSSatish Balay } else { 523e5c89e4eSSatish Balay const char *tname; 5249566063dSJacob Faibussowitsch PetscCall(PetscObjectGetName((PetscObject)viewer, &tname)); 52598921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot handle that PetscViewer of type %s", tname); 526e5c89e4eSSatish Balay } 5273ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 528e5c89e4eSSatish Balay } 529e5c89e4eSSatish Balay 530ffeef943SBarry Smith /*@ 53157b47c28SJames Wright PetscRealViewNumColumns - Prints an array of doubles; useful for debugging. 532e5c89e4eSSatish Balay 533c3339decSBarry Smith Collective 534e5c89e4eSSatish Balay 535e5c89e4eSSatish Balay Input Parameters: 536811af0c4SBarry Smith + N - number of `PetscReal` in array 53757b47c28SJames Wright . Ncol - number of `PetscReal` to print per row 538811af0c4SBarry Smith . idx - array of `PetscReal` 539811af0c4SBarry Smith - viewer - location to print array, `PETSC_VIEWER_STDOUT_WORLD`, `PETSC_VIEWER_STDOUT_SELF` or 0 540e5c89e4eSSatish Balay 541e5c89e4eSSatish Balay Level: intermediate 542e5c89e4eSSatish Balay 543811af0c4SBarry Smith Note: 544a3b724e8SBarry Smith This may be called from within the debugger, passing 0 as the viewer 545300a7f5bSBarry Smith 546*100c51b5SJames Wright This API may be removed in the future. 547*100c51b5SJames Wright 5486e25c4a1SBarry Smith Developer Note: 5496e25c4a1SBarry Smith `idx` cannot be const because may be passed to binary viewer where temporary byte swapping may be done 550811af0c4SBarry Smith 55157b47c28SJames Wright .seealso: `PetscViewer`, `PetscRealView()`, `PetscIntView()` 552e5c89e4eSSatish Balay @*/ 55357b47c28SJames Wright PetscErrorCode PetscRealViewNumColumns(PetscInt N, PetscInt Ncol, const PetscReal idx[], PetscViewer viewer) 554d71ae5a4SJacob Faibussowitsch { 555ca0c3be5SJacob Faibussowitsch PetscMPIInt rank, size; 55657b47c28SJames Wright PetscInt j, i, n = N / Ncol, p = N % Ncol; 557ace3abfcSBarry Smith PetscBool iascii, isbinary; 558e5c89e4eSSatish Balay MPI_Comm comm; 559e5c89e4eSSatish Balay 560e5c89e4eSSatish Balay PetscFunctionBegin; 561e5c89e4eSSatish Balay if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF; 56257b47c28SJames Wright if (N) PetscAssertPointer(idx, 3); 56357b47c28SJames Wright PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 4); 5649566063dSJacob Faibussowitsch PetscCall(PetscObjectGetComm((PetscObject)viewer, &comm)); 5659566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 5669566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 567e5c89e4eSSatish Balay 5689566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii)); 5699566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERBINARY, &isbinary)); 570e5c89e4eSSatish Balay if (iascii) { 5711a989b97SToby Isaac PetscInt tab; 5721a989b97SToby Isaac 5739566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 5749566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIGetTab(viewer, &tab)); 575e5c89e4eSSatish Balay for (i = 0; i < n; i++) { 5769566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISetTab(viewer, tab)); 577ca0c3be5SJacob Faibussowitsch if (size > 1) { 57857b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "[%d] %2" PetscInt_FMT ":", rank, Ncol * i)); 579ca0c3be5SJacob Faibussowitsch } else { 58057b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%2" PetscInt_FMT ":", Ncol * i)); 581ca0c3be5SJacob Faibussowitsch } 5829566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISetTab(viewer, 0)); 58357b47c28SJames Wright for (j = 0; j < Ncol; j++) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %12.4e", (double)idx[i * Ncol + j])); 5849566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n")); 585e5c89e4eSSatish Balay } 586e5c89e4eSSatish Balay if (p) { 5879566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISetTab(viewer, tab)); 588ca0c3be5SJacob Faibussowitsch if (size > 1) { 58957b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "[%d] %2" PetscInt_FMT ":", rank, Ncol * n)); 590ca0c3be5SJacob Faibussowitsch } else { 59157b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%2" PetscInt_FMT ":", Ncol * n)); 592ca0c3be5SJacob Faibussowitsch } 5939566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISetTab(viewer, 0)); 59457b47c28SJames Wright for (i = 0; i < p; i++) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %12.4e", (double)idx[Ncol * n + i])); 5959566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n")); 596e5c89e4eSSatish Balay } 5979566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 5989566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISetTab(viewer, tab)); 5999566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 6006805f65bSBarry Smith } else if (isbinary) { 601ca0c3be5SJacob Faibussowitsch PetscMPIInt *sizes, *displs, Ntotal, NN; 602e5c89e4eSSatish Balay PetscReal *array; 603e5c89e4eSSatish Balay 6049566063dSJacob Faibussowitsch PetscCall(PetscMPIIntCast(N, &NN)); 605e5c89e4eSSatish Balay 606e5c89e4eSSatish Balay if (size > 1) { 607e5c89e4eSSatish Balay if (rank) { 6089566063dSJacob Faibussowitsch PetscCallMPI(MPI_Gather(&NN, 1, MPI_INT, NULL, 0, MPI_INT, 0, comm)); 609835f2295SStefano Zampini PetscCallMPI(MPI_Gatherv(idx, NN, MPIU_REAL, NULL, NULL, NULL, MPIU_REAL, 0, comm)); 610e5c89e4eSSatish Balay } else { 6119566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(size, &sizes)); 6129566063dSJacob Faibussowitsch PetscCallMPI(MPI_Gather(&NN, 1, MPI_INT, sizes, 1, MPI_INT, 0, comm)); 613e5c89e4eSSatish Balay Ntotal = sizes[0]; 6149566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(size, &displs)); 615e5c89e4eSSatish Balay displs[0] = 0; 616e5c89e4eSSatish Balay for (i = 1; i < size; i++) { 617e5c89e4eSSatish Balay Ntotal += sizes[i]; 618e5c89e4eSSatish Balay displs[i] = displs[i - 1] + sizes[i - 1]; 619e5c89e4eSSatish Balay } 6209566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(Ntotal, &array)); 621835f2295SStefano Zampini PetscCallMPI(MPI_Gatherv(idx, NN, MPIU_REAL, array, sizes, displs, MPIU_REAL, 0, comm)); 6229566063dSJacob Faibussowitsch PetscCall(PetscViewerBinaryWrite(viewer, array, Ntotal, PETSC_REAL)); 6239566063dSJacob Faibussowitsch PetscCall(PetscFree(sizes)); 6249566063dSJacob Faibussowitsch PetscCall(PetscFree(displs)); 6259566063dSJacob Faibussowitsch PetscCall(PetscFree(array)); 626e5c89e4eSSatish Balay } 627e5c89e4eSSatish Balay } else { 6289566063dSJacob Faibussowitsch PetscCall(PetscViewerBinaryWrite(viewer, (void *)idx, N, PETSC_REAL)); 629e5c89e4eSSatish Balay } 630e5c89e4eSSatish Balay } else { 631e5c89e4eSSatish Balay const char *tname; 6329566063dSJacob Faibussowitsch PetscCall(PetscObjectGetName((PetscObject)viewer, &tname)); 63398921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot handle that PetscViewer of type %s", tname); 634e5c89e4eSSatish Balay } 6353ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 636e5c89e4eSSatish Balay } 637e5c89e4eSSatish Balay 638ffeef943SBarry Smith /*@ 63957b47c28SJames Wright PetscScalarViewNumColumns - Prints an array of doubles; useful for debugging. 640e5c89e4eSSatish Balay 641c3339decSBarry Smith Collective 642e5c89e4eSSatish Balay 643e5c89e4eSSatish Balay Input Parameters: 64457b47c28SJames Wright + N - number of `PetscScalar` in array 64557b47c28SJames Wright . Ncol - number of `PetscScalar` to print per row 64657b47c28SJames Wright . idx - array of `PetscScalar` 647811af0c4SBarry Smith - viewer - location to print array, `PETSC_VIEWER_STDOUT_WORLD`, `PETSC_VIEWER_STDOUT_SELF` or 0 648e5c89e4eSSatish Balay 649e5c89e4eSSatish Balay Level: intermediate 650e5c89e4eSSatish Balay 651811af0c4SBarry Smith Note: 652a3b724e8SBarry Smith This may be called from within the debugger, passing 0 as the viewer 653300a7f5bSBarry Smith 654*100c51b5SJames Wright This API may be removed in the future. 655*100c51b5SJames Wright 6566e25c4a1SBarry Smith Developer Note: 65757b47c28SJames Wright `idx` cannot be const because may be passed to binary viewer where temporary byte swapping may be done 658811af0c4SBarry Smith 65957b47c28SJames Wright .seealso: `PetscViewer`, `PetscRealView()`, `PetscScalarView()`, `PetscIntView()` 660e5c89e4eSSatish Balay @*/ 66157b47c28SJames Wright PetscErrorCode PetscScalarViewNumColumns(PetscInt N, PetscInt Ncol, const PetscScalar idx[], PetscViewer viewer) 662d71ae5a4SJacob Faibussowitsch { 663ca0c3be5SJacob Faibussowitsch PetscMPIInt rank, size; 66457b47c28SJames Wright PetscInt j, i, n = N / Ncol, p = N % Ncol; 665ace3abfcSBarry Smith PetscBool iascii, isbinary; 666e5c89e4eSSatish Balay MPI_Comm comm; 667e5c89e4eSSatish Balay 668e5c89e4eSSatish Balay PetscFunctionBegin; 669e5c89e4eSSatish Balay if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF; 67057b47c28SJames Wright if (N) PetscAssertPointer(idx, 3); 67157b47c28SJames Wright PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 4); 6729566063dSJacob Faibussowitsch PetscCall(PetscObjectGetComm((PetscObject)viewer, &comm)); 6739566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 6749566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 675e5c89e4eSSatish Balay 6769566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii)); 6779566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERBINARY, &isbinary)); 678e5c89e4eSSatish Balay if (iascii) { 6799566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 680e5c89e4eSSatish Balay for (i = 0; i < n; i++) { 681ca0c3be5SJacob Faibussowitsch if (size > 1) { 68257b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "[%d] %2" PetscInt_FMT ":", rank, Ncol * i)); 683ca0c3be5SJacob Faibussowitsch } else { 68457b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%2" PetscInt_FMT ":", Ncol * i)); 685ca0c3be5SJacob Faibussowitsch } 68657b47c28SJames Wright for (j = 0; j < Ncol; j++) { 687e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX) 68857b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " (%12.4e,%12.4e)", (double)PetscRealPart(idx[i * Ncol + j]), (double)PetscImaginaryPart(idx[i * Ncol + j]))); 689e5c89e4eSSatish Balay #else 69057b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %12.4e", (double)idx[i * Ncol + j])); 691e5c89e4eSSatish Balay #endif 692e5c89e4eSSatish Balay } 6939566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n")); 694e5c89e4eSSatish Balay } 695e5c89e4eSSatish Balay if (p) { 696ca0c3be5SJacob Faibussowitsch if (size > 1) { 69757b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "[%d] %2" PetscInt_FMT ":", rank, Ncol * n)); 698ca0c3be5SJacob Faibussowitsch } else { 69957b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%2" PetscInt_FMT ":", Ncol * n)); 700ca0c3be5SJacob Faibussowitsch } 701e5c89e4eSSatish Balay for (i = 0; i < p; i++) { 702e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX) 70357b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " (%12.4e,%12.4e)", (double)PetscRealPart(idx[n * Ncol + i]), (double)PetscImaginaryPart(idx[n * Ncol + i]))); 704e5c89e4eSSatish Balay #else 70557b47c28SJames Wright PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %12.4e", (double)idx[Ncol * n + i])); 706e5c89e4eSSatish Balay #endif 707e5c89e4eSSatish Balay } 7089566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n")); 709e5c89e4eSSatish Balay } 7109566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 7119566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 7126805f65bSBarry Smith } else if (isbinary) { 713ca0c3be5SJacob Faibussowitsch PetscMPIInt *sizes, Ntotal, *displs, NN; 714e5c89e4eSSatish Balay PetscScalar *array; 715e5c89e4eSSatish Balay 7169566063dSJacob Faibussowitsch PetscCall(PetscMPIIntCast(N, &NN)); 717e5c89e4eSSatish Balay 718e5c89e4eSSatish Balay if (size > 1) { 719e5c89e4eSSatish Balay if (rank) { 7209566063dSJacob Faibussowitsch PetscCallMPI(MPI_Gather(&NN, 1, MPI_INT, NULL, 0, MPI_INT, 0, comm)); 7219566063dSJacob Faibussowitsch PetscCallMPI(MPI_Gatherv((void *)idx, NN, MPIU_SCALAR, NULL, NULL, NULL, MPIU_SCALAR, 0, comm)); 722e5c89e4eSSatish Balay } else { 7239566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(size, &sizes)); 7249566063dSJacob Faibussowitsch PetscCallMPI(MPI_Gather(&NN, 1, MPI_INT, sizes, 1, MPI_INT, 0, comm)); 725e5c89e4eSSatish Balay Ntotal = sizes[0]; 7269566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(size, &displs)); 727e5c89e4eSSatish Balay displs[0] = 0; 728e5c89e4eSSatish Balay for (i = 1; i < size; i++) { 729e5c89e4eSSatish Balay Ntotal += sizes[i]; 730e5c89e4eSSatish Balay displs[i] = displs[i - 1] + sizes[i - 1]; 731e5c89e4eSSatish Balay } 7329566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(Ntotal, &array)); 7339566063dSJacob Faibussowitsch PetscCallMPI(MPI_Gatherv((void *)idx, NN, MPIU_SCALAR, array, sizes, displs, MPIU_SCALAR, 0, comm)); 7349566063dSJacob Faibussowitsch PetscCall(PetscViewerBinaryWrite(viewer, array, Ntotal, PETSC_SCALAR)); 7359566063dSJacob Faibussowitsch PetscCall(PetscFree(sizes)); 7369566063dSJacob Faibussowitsch PetscCall(PetscFree(displs)); 7379566063dSJacob Faibussowitsch PetscCall(PetscFree(array)); 738e5c89e4eSSatish Balay } 739e5c89e4eSSatish Balay } else { 7409566063dSJacob Faibussowitsch PetscCall(PetscViewerBinaryWrite(viewer, (void *)idx, N, PETSC_SCALAR)); 741e5c89e4eSSatish Balay } 742e5c89e4eSSatish Balay } else { 743e5c89e4eSSatish Balay const char *tname; 7449566063dSJacob Faibussowitsch PetscCall(PetscObjectGetName((PetscObject)viewer, &tname)); 74598921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot handle that PetscViewer of type %s", tname); 746e5c89e4eSSatish Balay } 7473ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 748e5c89e4eSSatish Balay } 749e5c89e4eSSatish Balay 75057b47c28SJames Wright /*@ 75157b47c28SJames Wright PetscIntView - Prints an array of integers; useful for debugging. 75257b47c28SJames Wright 75357b47c28SJames Wright Collective 75457b47c28SJames Wright 75557b47c28SJames Wright Input Parameters: 75657b47c28SJames Wright + N - number of integers in array 75757b47c28SJames Wright . idx - array of integers 75857b47c28SJames Wright - viewer - location to print array, `PETSC_VIEWER_STDOUT_WORLD`, `PETSC_VIEWER_STDOUT_SELF` or 0 75957b47c28SJames Wright 76057b47c28SJames Wright Level: intermediate 76157b47c28SJames Wright 76257b47c28SJames Wright Note: 76357b47c28SJames Wright This may be called from within the debugger, passing 0 as the viewer 76457b47c28SJames Wright 765*100c51b5SJames Wright This API may be removed in the future. 766*100c51b5SJames Wright 76757b47c28SJames Wright Same as `PetscIntViewNumColumns()` with 20 values per row 76857b47c28SJames Wright 76957b47c28SJames Wright Developer Note: 77057b47c28SJames Wright `idx` cannot be const because may be passed to binary viewer where temporary byte swapping may be done 77157b47c28SJames Wright 77257b47c28SJames Wright .seealso: `PetscViewer`, `PetscIntViewNumColumns()`, `PetscRealView()` 77357b47c28SJames Wright @*/ 77457b47c28SJames Wright PetscErrorCode PetscIntView(PetscInt N, const PetscInt idx[], PetscViewer viewer) 77557b47c28SJames Wright { 77657b47c28SJames Wright PetscFunctionBegin; 77757b47c28SJames Wright PetscCall(PetscIntViewNumColumns(N, 20, idx, viewer)); 77857b47c28SJames Wright PetscFunctionReturn(PETSC_SUCCESS); 77957b47c28SJames Wright } 78057b47c28SJames Wright 78157b47c28SJames Wright /*@ 78257b47c28SJames Wright PetscRealView - Prints an array of doubles; useful for debugging. 78357b47c28SJames Wright 78457b47c28SJames Wright Collective 78557b47c28SJames Wright 78657b47c28SJames Wright Input Parameters: 78757b47c28SJames Wright + N - number of `PetscReal` in array 78857b47c28SJames Wright . idx - array of `PetscReal` 78957b47c28SJames Wright - viewer - location to print array, `PETSC_VIEWER_STDOUT_WORLD`, `PETSC_VIEWER_STDOUT_SELF` or 0 79057b47c28SJames Wright 79157b47c28SJames Wright Level: intermediate 79257b47c28SJames Wright 79357b47c28SJames Wright Note: 79457b47c28SJames Wright This may be called from within the debugger, passing 0 as the viewer 79557b47c28SJames Wright 796*100c51b5SJames Wright This API may be removed in the future. 797*100c51b5SJames Wright 79857b47c28SJames Wright Same as `PetscRealViewNumColumns()` with 5 values per row 79957b47c28SJames Wright 80057b47c28SJames Wright Developer Note: 80157b47c28SJames Wright `idx` cannot be const because may be passed to binary viewer where temporary byte swapping may be done 80257b47c28SJames Wright 80357b47c28SJames Wright .seealso: `PetscViewer`, `PetscIntView()` 80457b47c28SJames Wright @*/ 80557b47c28SJames Wright PetscErrorCode PetscRealView(PetscInt N, const PetscReal idx[], PetscViewer viewer) 80657b47c28SJames Wright { 80757b47c28SJames Wright PetscFunctionBegin; 80857b47c28SJames Wright PetscCall(PetscRealViewNumColumns(N, 5, idx, viewer)); 80957b47c28SJames Wright PetscFunctionReturn(PETSC_SUCCESS); 81057b47c28SJames Wright } 81157b47c28SJames Wright 81257b47c28SJames Wright /*@ 81357b47c28SJames Wright PetscScalarView - Prints an array of `PetscScalar`; useful for debugging. 81457b47c28SJames Wright 81557b47c28SJames Wright Collective 81657b47c28SJames Wright 81757b47c28SJames Wright Input Parameters: 81857b47c28SJames Wright + N - number of scalars in array 81957b47c28SJames Wright . idx - array of scalars 82057b47c28SJames Wright - viewer - location to print array, `PETSC_VIEWER_STDOUT_WORLD`, `PETSC_VIEWER_STDOUT_SELF` or 0 82157b47c28SJames Wright 82257b47c28SJames Wright Level: intermediate 82357b47c28SJames Wright 82457b47c28SJames Wright Note: 82557b47c28SJames Wright This may be called from within the debugger, passing 0 as the viewer 82657b47c28SJames Wright 827*100c51b5SJames Wright This API may be removed in the future. 828*100c51b5SJames Wright 82957b47c28SJames Wright Same as `PetscScalarViewNumColumns()` with 3 values per row 83057b47c28SJames Wright 83157b47c28SJames Wright Developer Note: 83257b47c28SJames Wright `idx` cannot be const because may be passed to binary viewer where byte swapping may be done 83357b47c28SJames Wright 83457b47c28SJames Wright .seealso: `PetscViewer`, `PetscIntView()`, `PetscRealView()` 83557b47c28SJames Wright @*/ 83657b47c28SJames Wright PetscErrorCode PetscScalarView(PetscInt N, const PetscScalar idx[], PetscViewer viewer) 83757b47c28SJames Wright { 83857b47c28SJames Wright PetscFunctionBegin; 83957b47c28SJames Wright PetscCall(PetscScalarViewNumColumns(N, 3, idx, viewer)); 84057b47c28SJames Wright PetscFunctionReturn(PETSC_SUCCESS); 84157b47c28SJames Wright } 84257b47c28SJames Wright 843e22e20c5SJunchao Zhang #if defined(PETSC_HAVE_CUDA) 8440e6b6b59SJacob Faibussowitsch #include <petscdevice_cuda.h> 845d71ae5a4SJacob Faibussowitsch PETSC_EXTERN const char *PetscCUBLASGetErrorName(cublasStatus_t status) 846d71ae5a4SJacob Faibussowitsch { 847e22e20c5SJunchao Zhang switch (status) { 848e22e20c5SJunchao Zhang #if (CUDART_VERSION >= 8000) /* At least CUDA 8.0 of Sep. 2016 had these */ 849d71ae5a4SJacob Faibussowitsch case CUBLAS_STATUS_SUCCESS: 850d71ae5a4SJacob Faibussowitsch return "CUBLAS_STATUS_SUCCESS"; 851d71ae5a4SJacob Faibussowitsch case CUBLAS_STATUS_NOT_INITIALIZED: 852d71ae5a4SJacob Faibussowitsch return "CUBLAS_STATUS_NOT_INITIALIZED"; 853d71ae5a4SJacob Faibussowitsch case CUBLAS_STATUS_ALLOC_FAILED: 854d71ae5a4SJacob Faibussowitsch return "CUBLAS_STATUS_ALLOC_FAILED"; 855d71ae5a4SJacob Faibussowitsch case CUBLAS_STATUS_INVALID_VALUE: 856d71ae5a4SJacob Faibussowitsch return "CUBLAS_STATUS_INVALID_VALUE"; 857d71ae5a4SJacob Faibussowitsch case CUBLAS_STATUS_ARCH_MISMATCH: 858d71ae5a4SJacob Faibussowitsch return "CUBLAS_STATUS_ARCH_MISMATCH"; 859d71ae5a4SJacob Faibussowitsch case CUBLAS_STATUS_MAPPING_ERROR: 860d71ae5a4SJacob Faibussowitsch return "CUBLAS_STATUS_MAPPING_ERROR"; 861d71ae5a4SJacob Faibussowitsch case CUBLAS_STATUS_EXECUTION_FAILED: 862d71ae5a4SJacob Faibussowitsch return "CUBLAS_STATUS_EXECUTION_FAILED"; 863d71ae5a4SJacob Faibussowitsch case CUBLAS_STATUS_INTERNAL_ERROR: 864d71ae5a4SJacob Faibussowitsch return "CUBLAS_STATUS_INTERNAL_ERROR"; 865d71ae5a4SJacob Faibussowitsch case CUBLAS_STATUS_NOT_SUPPORTED: 866d71ae5a4SJacob Faibussowitsch return "CUBLAS_STATUS_NOT_SUPPORTED"; 867d71ae5a4SJacob Faibussowitsch case CUBLAS_STATUS_LICENSE_ERROR: 868d71ae5a4SJacob Faibussowitsch return "CUBLAS_STATUS_LICENSE_ERROR"; 869e22e20c5SJunchao Zhang #endif 870d71ae5a4SJacob Faibussowitsch default: 871d71ae5a4SJacob Faibussowitsch return "unknown error"; 872e22e20c5SJunchao Zhang } 873e22e20c5SJunchao Zhang } 874d71ae5a4SJacob Faibussowitsch PETSC_EXTERN const char *PetscCUSolverGetErrorName(cusolverStatus_t status) 875d71ae5a4SJacob Faibussowitsch { 876a4b895e1SBarry Smith switch (status) { 877a4b895e1SBarry Smith #if (CUDART_VERSION >= 8000) /* At least CUDA 8.0 of Sep. 2016 had these */ 878d71ae5a4SJacob Faibussowitsch case CUSOLVER_STATUS_SUCCESS: 879d71ae5a4SJacob Faibussowitsch return "CUSOLVER_STATUS_SUCCESS"; 880d71ae5a4SJacob Faibussowitsch case CUSOLVER_STATUS_NOT_INITIALIZED: 881d71ae5a4SJacob Faibussowitsch return "CUSOLVER_STATUS_NOT_INITIALIZED"; 882d71ae5a4SJacob Faibussowitsch case CUSOLVER_STATUS_INVALID_VALUE: 883d71ae5a4SJacob Faibussowitsch return "CUSOLVER_STATUS_INVALID_VALUE"; 884d71ae5a4SJacob Faibussowitsch case CUSOLVER_STATUS_ARCH_MISMATCH: 885d71ae5a4SJacob Faibussowitsch return "CUSOLVER_STATUS_ARCH_MISMATCH"; 886d71ae5a4SJacob Faibussowitsch case CUSOLVER_STATUS_INTERNAL_ERROR: 887d71ae5a4SJacob Faibussowitsch return "CUSOLVER_STATUS_INTERNAL_ERROR"; 888030f984aSJacob Faibussowitsch #if (CUDART_VERSION >= 9000) /* CUDA 9.0 had these defined on June 2021 */ 889d71ae5a4SJacob Faibussowitsch case CUSOLVER_STATUS_ALLOC_FAILED: 890d71ae5a4SJacob Faibussowitsch return "CUSOLVER_STATUS_ALLOC_FAILED"; 891d71ae5a4SJacob Faibussowitsch case CUSOLVER_STATUS_MAPPING_ERROR: 892d71ae5a4SJacob Faibussowitsch return "CUSOLVER_STATUS_MAPPING_ERROR"; 893d71ae5a4SJacob Faibussowitsch case CUSOLVER_STATUS_EXECUTION_FAILED: 894d71ae5a4SJacob Faibussowitsch return "CUSOLVER_STATUS_EXECUTION_FAILED"; 895d71ae5a4SJacob Faibussowitsch case CUSOLVER_STATUS_MATRIX_TYPE_NOT_SUPPORTED: 896d71ae5a4SJacob Faibussowitsch return "CUSOLVER_STATUS_MATRIX_TYPE_NOT_SUPPORTED"; 897d71ae5a4SJacob Faibussowitsch case CUSOLVER_STATUS_NOT_SUPPORTED: 898d71ae5a4SJacob Faibussowitsch return "CUSOLVER_STATUS_NOT_SUPPORTED "; 899d71ae5a4SJacob Faibussowitsch case CUSOLVER_STATUS_ZERO_PIVOT: 900d71ae5a4SJacob Faibussowitsch return "CUSOLVER_STATUS_ZERO_PIVOT"; 901d71ae5a4SJacob Faibussowitsch case CUSOLVER_STATUS_INVALID_LICENSE: 902d71ae5a4SJacob Faibussowitsch return "CUSOLVER_STATUS_INVALID_LICENSE"; 903a4b895e1SBarry Smith #endif 904030f984aSJacob Faibussowitsch #endif 905d71ae5a4SJacob Faibussowitsch default: 906d71ae5a4SJacob Faibussowitsch return "unknown error"; 907030f984aSJacob Faibussowitsch } 908030f984aSJacob Faibussowitsch } 909d71ae5a4SJacob Faibussowitsch PETSC_EXTERN const char *PetscCUFFTGetErrorName(cufftResult result) 910d71ae5a4SJacob Faibussowitsch { 911030f984aSJacob Faibussowitsch switch (result) { 912d71ae5a4SJacob Faibussowitsch case CUFFT_SUCCESS: 913d71ae5a4SJacob Faibussowitsch return "CUFFT_SUCCESS"; 914d71ae5a4SJacob Faibussowitsch case CUFFT_INVALID_PLAN: 915d71ae5a4SJacob Faibussowitsch return "CUFFT_INVALID_PLAN"; 916d71ae5a4SJacob Faibussowitsch case CUFFT_ALLOC_FAILED: 917d71ae5a4SJacob Faibussowitsch return "CUFFT_ALLOC_FAILED"; 918d71ae5a4SJacob Faibussowitsch case CUFFT_INVALID_TYPE: 919d71ae5a4SJacob Faibussowitsch return "CUFFT_INVALID_TYPE"; 920d71ae5a4SJacob Faibussowitsch case CUFFT_INVALID_VALUE: 921d71ae5a4SJacob Faibussowitsch return "CUFFT_INVALID_VALUE"; 922d71ae5a4SJacob Faibussowitsch case CUFFT_INTERNAL_ERROR: 923d71ae5a4SJacob Faibussowitsch return "CUFFT_INTERNAL_ERROR"; 924d71ae5a4SJacob Faibussowitsch case CUFFT_EXEC_FAILED: 925d71ae5a4SJacob Faibussowitsch return "CUFFT_EXEC_FAILED"; 926d71ae5a4SJacob Faibussowitsch case CUFFT_SETUP_FAILED: 927d71ae5a4SJacob Faibussowitsch return "CUFFT_SETUP_FAILED"; 928d71ae5a4SJacob Faibussowitsch case CUFFT_INVALID_SIZE: 929d71ae5a4SJacob Faibussowitsch return "CUFFT_INVALID_SIZE"; 930d71ae5a4SJacob Faibussowitsch case CUFFT_UNALIGNED_DATA: 931d71ae5a4SJacob Faibussowitsch return "CUFFT_UNALIGNED_DATA"; 932d71ae5a4SJacob Faibussowitsch case CUFFT_INCOMPLETE_PARAMETER_LIST: 933d71ae5a4SJacob Faibussowitsch return "CUFFT_INCOMPLETE_PARAMETER_LIST"; 934d71ae5a4SJacob Faibussowitsch case CUFFT_INVALID_DEVICE: 935d71ae5a4SJacob Faibussowitsch return "CUFFT_INVALID_DEVICE"; 936d71ae5a4SJacob Faibussowitsch case CUFFT_PARSE_ERROR: 937d71ae5a4SJacob Faibussowitsch return "CUFFT_PARSE_ERROR"; 938d71ae5a4SJacob Faibussowitsch case CUFFT_NO_WORKSPACE: 939d71ae5a4SJacob Faibussowitsch return "CUFFT_NO_WORKSPACE"; 940d71ae5a4SJacob Faibussowitsch case CUFFT_NOT_IMPLEMENTED: 941d71ae5a4SJacob Faibussowitsch return "CUFFT_NOT_IMPLEMENTED"; 942d71ae5a4SJacob Faibussowitsch case CUFFT_LICENSE_ERROR: 943d71ae5a4SJacob Faibussowitsch return "CUFFT_LICENSE_ERROR"; 944d71ae5a4SJacob Faibussowitsch case CUFFT_NOT_SUPPORTED: 945d71ae5a4SJacob Faibussowitsch return "CUFFT_NOT_SUPPORTED"; 946d71ae5a4SJacob Faibussowitsch default: 947d71ae5a4SJacob Faibussowitsch return "unknown error"; 948a4b895e1SBarry Smith } 949a4b895e1SBarry Smith } 950e22e20c5SJunchao Zhang #endif 95159af0bd3SScott Kruger 95259af0bd3SScott Kruger #if defined(PETSC_HAVE_HIP) 9530e6b6b59SJacob Faibussowitsch #include <petscdevice_hip.h> 954d71ae5a4SJacob Faibussowitsch PETSC_EXTERN const char *PetscHIPBLASGetErrorName(hipblasStatus_t status) 955d71ae5a4SJacob Faibussowitsch { 95659af0bd3SScott Kruger switch (status) { 957d71ae5a4SJacob Faibussowitsch case HIPBLAS_STATUS_SUCCESS: 958d71ae5a4SJacob Faibussowitsch return "HIPBLAS_STATUS_SUCCESS"; 959d71ae5a4SJacob Faibussowitsch case HIPBLAS_STATUS_NOT_INITIALIZED: 960d71ae5a4SJacob Faibussowitsch return "HIPBLAS_STATUS_NOT_INITIALIZED"; 961d71ae5a4SJacob Faibussowitsch case HIPBLAS_STATUS_ALLOC_FAILED: 962d71ae5a4SJacob Faibussowitsch return "HIPBLAS_STATUS_ALLOC_FAILED"; 963d71ae5a4SJacob Faibussowitsch case HIPBLAS_STATUS_INVALID_VALUE: 964d71ae5a4SJacob Faibussowitsch return "HIPBLAS_STATUS_INVALID_VALUE"; 965d71ae5a4SJacob Faibussowitsch case HIPBLAS_STATUS_ARCH_MISMATCH: 966d71ae5a4SJacob Faibussowitsch return "HIPBLAS_STATUS_ARCH_MISMATCH"; 967d71ae5a4SJacob Faibussowitsch case HIPBLAS_STATUS_MAPPING_ERROR: 968d71ae5a4SJacob Faibussowitsch return "HIPBLAS_STATUS_MAPPING_ERROR"; 969d71ae5a4SJacob Faibussowitsch case HIPBLAS_STATUS_EXECUTION_FAILED: 970d71ae5a4SJacob Faibussowitsch return "HIPBLAS_STATUS_EXECUTION_FAILED"; 971d71ae5a4SJacob Faibussowitsch case HIPBLAS_STATUS_INTERNAL_ERROR: 972d71ae5a4SJacob Faibussowitsch return "HIPBLAS_STATUS_INTERNAL_ERROR"; 973d71ae5a4SJacob Faibussowitsch case HIPBLAS_STATUS_NOT_SUPPORTED: 974d71ae5a4SJacob Faibussowitsch return "HIPBLAS_STATUS_NOT_SUPPORTED"; 975d71ae5a4SJacob Faibussowitsch default: 976d71ae5a4SJacob Faibussowitsch return "unknown error"; 97759af0bd3SScott Kruger } 97859af0bd3SScott Kruger } 97947d993e7Ssuyashtn PETSC_EXTERN const char *PetscHIPSPARSEGetErrorName(hipsparseStatus_t status) 98047d993e7Ssuyashtn { 98147d993e7Ssuyashtn switch (status) { 98247d993e7Ssuyashtn case HIPSPARSE_STATUS_SUCCESS: 98347d993e7Ssuyashtn return "HIPSPARSE_STATUS_SUCCESS"; 98447d993e7Ssuyashtn case HIPSPARSE_STATUS_NOT_INITIALIZED: 98547d993e7Ssuyashtn return "HIPSPARSE_STATUS_NOT_INITIALIZED"; 98647d993e7Ssuyashtn case HIPSPARSE_STATUS_ALLOC_FAILED: 98747d993e7Ssuyashtn return "HIPSPARSE_STATUS_ALLOC_FAILED"; 98847d993e7Ssuyashtn case HIPSPARSE_STATUS_INVALID_VALUE: 98947d993e7Ssuyashtn return "HIPSPARSE_STATUS_INVALID_VALUE"; 99047d993e7Ssuyashtn case HIPSPARSE_STATUS_ARCH_MISMATCH: 99147d993e7Ssuyashtn return "HIPSPARSE_STATUS_ARCH_MISMATCH"; 99247d993e7Ssuyashtn case HIPSPARSE_STATUS_MAPPING_ERROR: 99347d993e7Ssuyashtn return "HIPSPARSE_STATUS_MAPPING_ERROR"; 99447d993e7Ssuyashtn case HIPSPARSE_STATUS_EXECUTION_FAILED: 99547d993e7Ssuyashtn return "HIPSPARSE_STATUS_EXECUTION_FAILED"; 99647d993e7Ssuyashtn case HIPSPARSE_STATUS_INTERNAL_ERROR: 99747d993e7Ssuyashtn return "HIPSPARSE_STATUS_INTERNAL_ERROR"; 99847d993e7Ssuyashtn case HIPSPARSE_STATUS_MATRIX_TYPE_NOT_SUPPORTED: 99947d993e7Ssuyashtn return "HIPSPARSE_STATUS_MATRIX_TYPE_NOT_SUPPORTED"; 100047d993e7Ssuyashtn case HIPSPARSE_STATUS_ZERO_PIVOT: 100147d993e7Ssuyashtn return "HIPSPARSE_STATUS_ZERO_PIVOT"; 100247d993e7Ssuyashtn case HIPSPARSE_STATUS_NOT_SUPPORTED: 100347d993e7Ssuyashtn return "HIPSPARSE_STATUS_NOT_SUPPORTED"; 100447d993e7Ssuyashtn case HIPSPARSE_STATUS_INSUFFICIENT_RESOURCES: 100547d993e7Ssuyashtn return "HIPSPARSE_STATUS_INSUFFICIENT_RESOURCES"; 100647d993e7Ssuyashtn default: 100747d993e7Ssuyashtn return "unknown error"; 100847d993e7Ssuyashtn } 100947d993e7Ssuyashtn } 101047d993e7Ssuyashtn PETSC_EXTERN const char *PetscHIPSolverGetErrorName(hipsolverStatus_t status) 101147d993e7Ssuyashtn { 101247d993e7Ssuyashtn switch (status) { 101347d993e7Ssuyashtn case HIPSOLVER_STATUS_SUCCESS: 101447d993e7Ssuyashtn return "HIPSOLVER_STATUS_SUCCESS"; 101547d993e7Ssuyashtn case HIPSOLVER_STATUS_NOT_INITIALIZED: 101647d993e7Ssuyashtn return "HIPSOLVER_STATUS_NOT_INITIALIZED"; 101747d993e7Ssuyashtn case HIPSOLVER_STATUS_ALLOC_FAILED: 101847d993e7Ssuyashtn return "HIPSOLVER_STATUS_ALLOC_FAILED"; 101947d993e7Ssuyashtn case HIPSOLVER_STATUS_MAPPING_ERROR: 102047d993e7Ssuyashtn return "HIPSOLVER_STATUS_MAPPING_ERROR"; 102147d993e7Ssuyashtn case HIPSOLVER_STATUS_INVALID_VALUE: 102247d993e7Ssuyashtn return "HIPSOLVER_STATUS_INVALID_VALUE"; 102347d993e7Ssuyashtn case HIPSOLVER_STATUS_EXECUTION_FAILED: 102447d993e7Ssuyashtn return "HIPSOLVER_STATUS_EXECUTION_FAILED"; 102547d993e7Ssuyashtn case HIPSOLVER_STATUS_INTERNAL_ERROR: 102647d993e7Ssuyashtn return "HIPSOLVER_STATUS_INTERNAL_ERROR"; 102747d993e7Ssuyashtn case HIPSOLVER_STATUS_NOT_SUPPORTED: 102847d993e7Ssuyashtn return "HIPSOLVER_STATUS_NOT_SUPPORTED "; 102947d993e7Ssuyashtn case HIPSOLVER_STATUS_ARCH_MISMATCH: 103047d993e7Ssuyashtn return "HIPSOLVER_STATUS_ARCH_MISMATCH"; 103147d993e7Ssuyashtn case HIPSOLVER_STATUS_HANDLE_IS_NULLPTR: 103247d993e7Ssuyashtn return "HIPSOLVER_STATUS_HANDLE_IS_NULLPTR"; 103347d993e7Ssuyashtn case HIPSOLVER_STATUS_INVALID_ENUM: 103447d993e7Ssuyashtn return "HIPSOLVER_STATUS_INVALID_ENUM"; 103547d993e7Ssuyashtn case HIPSOLVER_STATUS_UNKNOWN: 103647d993e7Ssuyashtn default: 103747d993e7Ssuyashtn return "HIPSOLVER_STATUS_UNKNOWN"; 103847d993e7Ssuyashtn } 103947d993e7Ssuyashtn } 104059af0bd3SScott Kruger #endif 1041db9cea48SBarry Smith 1042aec76313SJacob Faibussowitsch /*@C 1043811af0c4SBarry Smith PetscMPIErrorString - Given an MPI error code returns the `MPI_Error_string()` appropriately 1044db9cea48SBarry Smith formatted for displaying with the PETSc error handlers. 1045db9cea48SBarry Smith 1046cc4c1da9SBarry Smith Not Collective, No Fortran Support 1047cc4c1da9SBarry Smith 1048a1fd7ae3SBarry Smith Input Parameters: 1049a1fd7ae3SBarry Smith + err - the MPI error code 1050a1fd7ae3SBarry Smith - slen - length of `string`, should be at least as large as `MPI_MAX_ERROR_STRING` 1051db9cea48SBarry Smith 1052db9cea48SBarry Smith Output Parameter: 1053a1fd7ae3SBarry Smith . string - the MPI error message 1054db9cea48SBarry Smith 105549c86fc7SBarry Smith Level: developer 105649c86fc7SBarry Smith 1057811af0c4SBarry Smith Note: 1058db9cea48SBarry Smith Does not return an error code or do error handling because it may be called from inside an error handler 1059db9cea48SBarry Smith 106010450e9eSJacob Faibussowitsch .seealso: `PetscErrorCode` `PetscErrorMessage()` 1061db9cea48SBarry Smith @*/ 1062a1fd7ae3SBarry Smith void PetscMPIErrorString(PetscMPIInt err, size_t slen, char *string) 1063d71ae5a4SJacob Faibussowitsch { 1064db9cea48SBarry Smith char errorstring[MPI_MAX_ERROR_STRING]; 1065a1fd7ae3SBarry Smith PetscMPIInt len; 1066a1fd7ae3SBarry Smith size_t j = 0; 1067db9cea48SBarry Smith 1068db9cea48SBarry Smith MPI_Error_string(err, (char *)errorstring, &len); 1069a1fd7ae3SBarry Smith for (PetscMPIInt i = 0; i < len && j < slen - 2; i++) { 1070db9cea48SBarry Smith string[j++] = errorstring[i]; 1071db9cea48SBarry Smith if (errorstring[i] == '\n') { 1072a1fd7ae3SBarry Smith for (PetscMPIInt k = 0; k < 16 && j < slen - 2; k++) string[j++] = ' '; 1073db9cea48SBarry Smith } 1074db9cea48SBarry Smith } 1075db9cea48SBarry Smith string[j] = 0; 1076db9cea48SBarry Smith } 1077