Actual source code: petscerror.h

petsc-master 2019-04-19
Report Typos and Errors
  1: /*
  2:     Contains all error handling interfaces for PETSc.
  3: */

  7: /*
  8:      These are the generic error codes. These error codes are used
  9:      many different places in the PETSc source code. The string versions are
 10:      at src/sys/error/err.c any changes here must also be made there
 11:      These are also define in include/petsc/finclude/petscerror.h any CHANGES here
 12:      must be also made there.

 14: */
 15: #define PETSC_ERR_MIN_VALUE        54   /* should always be one less then the smallest value */

 17: #define PETSC_ERR_MEM              55   /* unable to allocate requested memory */
 18: #define PETSC_ERR_SUP              56   /* no support for requested operation */
 19: #define PETSC_ERR_SUP_SYS          57   /* no support for requested operation on this computer system */
 20: #define PETSC_ERR_ORDER            58   /* operation done in wrong order */
 21: #define PETSC_ERR_SIG              59   /* signal received */
 22: #define PETSC_ERR_FP               72   /* floating point exception */
 23: #define PETSC_ERR_COR              74   /* corrupted PETSc object */
 24: #define PETSC_ERR_LIB              76   /* error in library called by PETSc */
 25: #define PETSC_ERR_PLIB             77   /* PETSc library generated inconsistent data */
 26: #define PETSC_ERR_MEMC             78   /* memory corruption */
 27: #define PETSC_ERR_CONV_FAILED      82   /* iterative method (KSP or SNES) failed */
 28: #define PETSC_ERR_USER             83   /* user has not provided needed function */
 29: #define PETSC_ERR_SYS              88   /* error in system call */
 30: #define PETSC_ERR_POINTER          70   /* pointer does not point to valid address */
 31: #define PETSC_ERR_MPI_LIB_INCOMP   87   /* MPI library at runtime is not compatible with MPI user compiled with */

 33: #define PETSC_ERR_ARG_SIZ          60   /* nonconforming object sizes used in operation */
 34: #define PETSC_ERR_ARG_IDN          61   /* two arguments not allowed to be the same */
 35: #define PETSC_ERR_ARG_WRONG        62   /* wrong argument (but object probably ok) */
 36: #define PETSC_ERR_ARG_CORRUPT      64   /* null or corrupted PETSc object as argument */
 37: #define PETSC_ERR_ARG_OUTOFRANGE   63   /* input argument, out of range */
 38: #define PETSC_ERR_ARG_BADPTR       68   /* invalid pointer argument */
 39: #define PETSC_ERR_ARG_NOTSAMETYPE  69   /* two args must be same object type */
 40: #define PETSC_ERR_ARG_NOTSAMECOMM  80   /* two args must be same communicators */
 41: #define PETSC_ERR_ARG_WRONGSTATE   73   /* object in argument is in wrong state, e.g. unassembled mat */
 42: #define PETSC_ERR_ARG_TYPENOTSET   89   /* the type of the object has not yet been set */
 43: #define PETSC_ERR_ARG_INCOMP       75   /* two arguments are incompatible */
 44: #define PETSC_ERR_ARG_NULL         85   /* argument is null that should not be */
 45: #define PETSC_ERR_ARG_UNKNOWN_TYPE 86   /* type name doesn't match any registered type */

 47: #define PETSC_ERR_FILE_OPEN        65   /* unable to open file */
 48: #define PETSC_ERR_FILE_READ        66   /* unable to read from file */
 49: #define PETSC_ERR_FILE_WRITE       67   /* unable to write to file */
 50: #define PETSC_ERR_FILE_UNEXPECTED  79   /* unexpected data in file */

 52: #define PETSC_ERR_MAT_LU_ZRPVT     71   /* detected a zero pivot during LU factorization */
 53: #define PETSC_ERR_MAT_CH_ZRPVT     81   /* detected a zero pivot during Cholesky factorization */

 55: #define PETSC_ERR_INT_OVERFLOW     84

 57: #define PETSC_ERR_FLOP_COUNT       90
 58: #define PETSC_ERR_NOT_CONVERGED    91  /* solver did not converge */
 59: #define PETSC_ERR_MISSING_FACTOR   92  /* MatGetFactor() failed */
 60: #define PETSC_ERR_OPT_OVERWRITE    93  /* attempted to over wrote options which should not be changed */

 62: #define PETSC_ERR_MAX_VALUE        94  /* this is always the one more than the largest error code */

 64: #define PetscStringizeArg(a) #a
 65: #define PetscStringize(a) PetscStringizeArg(a)


 68: /*MC
 69:    SETERRQ - Macro to be called when an error has been detected,

 71:    Synopsis:
 72:    #include <petscsys.h>
 73:    PetscErrorCode SETERRQ(MPI_Comm comm,PetscErrorCode ierr,char *message)

 75:    Collective on MPI_Comm

 77:    Input Parameters:
 78: +  comm - A communicator, use PETSC_COMM_SELF unless you know all ranks of another communicator will detect the error
 79: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
 80: -  message - error message

 82:   Level: beginner

 84:    Notes:
 85:     Once the error handler is called the calling function is then returned from with the given error code.

 87:     See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments

 89:     Experienced users can set the error handler with PetscPushErrorHandler().

 91:    Concepts: error^setting condition

 93: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3()
 94: M*/
 95: #define SETERRQ(comm,ierr,s) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s)

 97: /*MC
 98:    SETERRMPI - Macro to be called when an error has been detected within an MPI callback function

100:    Synopsis:
101:    #include <petscsys.h>
102:    PetscErrorCode SETERRMPI(MPI_Comm comm,PetscErrorCode ierr,char *message)

104:    Collective on MPI_Comm

106:    Input Parameters:
107: +  comm - A communicator, use PETSC_COMM_SELF unless you know all ranks of another communicator will detect the error
108: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
109: -  message - error message

111:   Level: developer

113:    Notes:
114:     This macro is FOR USE IN MPI CALLBACK FUNCTIONS ONLY, such as those passed to MPI_Comm_create_keyval(). It always returns the error code PETSC_MPI_ERROR_CODE
115:     which is registered with MPI_Add_error_code() when PETSc is initialized.

117:    Concepts: error^setting condition

119: .seealso: SETERRQ(), CHKERRQ(), CHKERRMPI(), PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3()
120: M*/
121: #define SETERRMPI(comm,ierr,s) return (PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s),PETSC_MPI_ERROR_CODE)

123: /*MC
124:    SETERRQ1 - Macro that is called when an error has been detected,

126:    Synopsis:
127:    #include <petscsys.h>
128:    PetscErrorCode SETERRQ1(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg)

130:    Collective on MPI_Comm

132:    Input Parameters:
133: +  comm - A communicator, so that the error can be collective
134: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
135: .  message - error message in the printf format
136: -  arg - argument (for example an integer, string or double)

138:   Level: beginner

140:    Notes:
141:     Once the error handler is called the calling function is then returned from with the given error code.

143:    Experienced users can set the error handler with PetscPushErrorHandler().

145:    Concepts: error^setting condition

147: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3()
148: M*/
149: #define SETERRQ1(comm,ierr,s,a1) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1)

151: /*MC
152:    SETERRQ2 - Macro that is called when an error has been detected,

154:    Synopsis:
155:    #include <petscsys.h>
156:    PetscErrorCode SETERRQ2(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2)

158:    Collective on MPI_Comm

160:    Input Parameters:
161: +  comm - A communicator, so that the error can be collective
162: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
163: .  message - error message in the printf format
164: .  arg1 - argument (for example an integer, string or double)
165: -  arg2 - argument (for example an integer, string or double)

167:   Level: beginner

169:    Notes:
170:     Once the error handler is called the calling function is then returned from with the given error code.

172:    Experienced users can set the error handler with PetscPushErrorHandler().

174:    Concepts: error^setting condition

176: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3()
177: M*/
178: #define SETERRQ2(comm,ierr,s,a1,a2) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2)

180: /*MC
181:    SETERRQ3 - Macro that is called when an error has been detected,

183:    Synopsis:
184:    #include <petscsys.h>
185:    PetscErrorCode SETERRQ3(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)

187:    Collective on MPI_Comm

189:    Input Parameters:
190: +  comm - A communicator, so that the error can be collective
191: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
192: .  message - error message in the printf format
193: .  arg1 - argument (for example an integer, string or double)
194: .  arg2 - argument (for example an integer, string or double)
195: -  arg3 - argument (for example an integer, string or double)

197:   Level: beginner

199:    Notes:
200:     Once the error handler is called the calling function is then returned from with the given error code.

202:     There are also versions for 4, 5, 6 and 7 arguments.

204:    Experienced users can set the error handler with PetscPushErrorHandler().

206:    Concepts: error^setting condition

208: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
209: M*/
210: #define SETERRQ3(comm,ierr,s,a1,a2,a3) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3)

212: /*MC
213:    SETERRQ4 - Macro that is called when an error has been detected,

215:    Synopsis:
216:    #include <petscsys.h>
217:    PetscErrorCode SETERRQ4(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)

219:    Collective on MPI_Comm

221:    Input Parameters:
222: +  comm - A communicator, so that the error can be collective
223: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
224: .  message - error message in the printf format
225: .  arg1 - argument (for example an integer, string or double)
226: .  arg2 - argument (for example an integer, string or double)
227: .  arg3 - argument (for example an integer, string or double)
228: -  arg4 - argument (for example an integer, string or double)

230:   Level: beginner

232:    Notes:
233:     Once the error handler is called the calling function is then returned from with the given error code.

235:     There are also versions for 4, 5, 6 and 7 arguments.

237:    Experienced users can set the error handler with PetscPushErrorHandler().

239:    Concepts: error^setting condition

241: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
242: M*/
243: #define SETERRQ4(comm,ierr,s,a1,a2,a3,a4) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4)

245: /*MC
246:    SETERRQ5 - Macro that is called when an error has been detected,

248:    Synopsis:
249:    #include <petscsys.h>
250:    PetscErrorCode SETERRQ5(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)

252:    Collective on MPI_COmm

254:    Input Parameters:
255: +  comm - A communicator, so that the error can be collective
256: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
257: .  message - error message in the printf format
258: .  arg1 - argument (for example an integer, string or double)
259: .  arg2 - argument (for example an integer, string or double)
260: .  arg3 - argument (for example an integer, string or double)
261: .  arg4 - argument (for example an integer, string or double)
262: -  arg5 - argument (for example an integer, string or double)

264:   Level: beginner

266:    Notes:
267:     Once the error handler is called the calling function is then returned from with the given error code.

269:     There are also versions for 4, 5, 6 and 7 arguments.

271:    Experienced users can set the error handler with PetscPushErrorHandler().

273:    Concepts: error^setting condition

275: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
276: M*/
277: #define SETERRQ5(comm,ierr,s,a1,a2,a3,a4,a5) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5)

279: /*MC
280:    SETERRQ6 - Macro that is called when an error has been detected,

282:    Synopsis:
283:    #include <petscsys.h>
284:    PetscErrorCode SETERRQ6(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)

286:    Collective on MPI_Comm

288:    Input Parameters:
289: +  comm - A communicator, so that the error can be collective
290: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
291: .  message - error message in the printf format
292: .  arg1 - argument (for example an integer, string or double)
293: .  arg2 - argument (for example an integer, string or double)
294: .  arg3 - argument (for example an integer, string or double)
295: .  arg4 - argument (for example an integer, string or double)
296: .  arg5 - argument (for example an integer, string or double)
297: -  arg6 - argument (for example an integer, string or double)

299:   Level: beginner

301:    Notes:
302:     Once the error handler is called the calling function is then returned from with the given error code.

304:     There are also versions for 4, 5, 6 and 7 arguments.

306:    Experienced users can set the error handler with PetscPushErrorHandler().

308:    Concepts: error^setting condition

310: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
311: M*/
312: #define SETERRQ6(comm,ierr,s,a1,a2,a3,a4,a5,a6) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6)

314: /*MC
315:    SETERRQ7 - Macro that is called when an error has been detected,

317:    Synopsis:
318:    #include <petscsys.h>
319:    PetscErrorCode SETERRQ7(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)

321:    Collective on MPI_Comm

323:    Input Parameters:
324: +  comm - A communicator, so that the error can be collective
325: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
326: .  message - error message in the printf format
327: .  arg1 - argument (for example an integer, string or double)
328: .  arg2 - argument (for example an integer, string or double)
329: .  arg3 - argument (for example an integer, string or double)
330: .  arg4 - argument (for example an integer, string or double)
331: .  arg5 - argument (for example an integer, string or double)
332: .  arg6 - argument (for example an integer, string or double)
333: -  arg7 - argument (for example an integer, string or double)

335:   Level: beginner

337:    Notes:
338:     Once the error handler is called the calling function is then returned from with the given error code.

340:     There are also versions for 4, 5, 6 and 7 arguments.

342:    Experienced users can set the error handler with PetscPushErrorHandler().

344:    Concepts: error^setting condition

346: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
347: M*/
348: #define SETERRQ7(comm,ierr,s,a1,a2,a3,a4,a5,a6,a7) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6,a7)

350: /*MC
351:    SETERRQ8 - Macro that is called when an error has been detected,

353:    Synopsis:
354:    #include <petscsys.h>
355:    PetscErrorCode SETERRQ8(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)

357:    Collective on MPI_Comm

359:    Input Parameters:
360: +  comm - A communicator, so that the error can be collective
361: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
362: .  message - error message in the printf format
363: .  arg1 - argument (for example an integer, string or double)
364: .  arg2 - argument (for example an integer, string or double)
365: .  arg3 - argument (for example an integer, string or double)
366: .  arg4 - argument (for example an integer, string or double)
367: .  arg5 - argument (for example an integer, string or double)
368: .  arg6 - argument (for example an integer, string or double)
369: .  arg7 - argument (for example an integer, string or double)
370: -  arg8 - argument (for example an integer, string or double)

372:   Level: beginner

374:    Notes:
375:     Once the error handler is called the calling function is then returned from with the given error code.

377:     There are also versions for 4, 5, 6 and 7 arguments.

379:    Experienced users can set the error handler with PetscPushErrorHandler().

381:    Concepts: error^setting condition

383: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
384: M*/
385: #define SETERRQ8(comm,ierr,s,a1,a2,a3,a4,a5,a6,a7,a8) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6,a7,a8)

387: /*MC
388:    SETERRQ9 - Macro that is called when an error has been detected,

390:    Synopsis:
391:    #include <petscsys.h>
392:    PetscErrorCode SETERRQ9(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)

394:    Collective on MPI_Comm

396:    Input Parameters:
397: +  comm - A communicator, so that the error can be collective
398: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
399: .  message - error message in the printf format
400: .  arg1 - argument (for example an integer, string or double)
401: .  arg2 - argument (for example an integer, string or double)
402: .  arg3 - argument (for example an integer, string or double)
403: .  arg4 - argument (for example an integer, string or double)
404: .  arg5 - argument (for example an integer, string or double)
405: .  arg6 - argument (for example an integer, string or double)
406: .  arg7 - argument (for example an integer, string or double)
407: .  arg8 - argument (for example an integer, string or double)
408: -  arg9 - argument (for example an integer, string or double)

410:   Level: beginner

412:    Notes:
413:     Once the error handler is called the calling function is then returned from with the given error code.

415:     There are also versions for 0 to 9 arguments.

417:    Experienced users can set the error handler with PetscPushErrorHandler().

419:    Concepts: error^setting condition

421: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
422: M*/
423: #define SETERRQ9(comm,ierr,s,a1,a2,a3,a4,a5,a6,a7,a8,a9) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6,a7,a8,a9)

425: /*MC
426:    SETERRABORT - Macro that can be called when an error has been detected,

428:    Synopsis:
429:    #include <petscsys.h>
430:    PetscErrorCode SETERRABORT(MPI_Comm comm,PetscErrorCode ierr,char *message)

432:    Collective on MPI_Comm

434:    Input Parameters:
435: +  comm - A communicator, so that the error can be collective
436: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
437: -  message - error message in the printf format

439:   Level: beginner

441:    Notes:
442:     This function just calls MPI_Abort().

444:    Concepts: error^setting condition

446: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
447: M*/
448: #define SETERRABORT(comm,ierr,s) do {PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s);MPI_Abort(comm,ierr);} while (0)

450: /*MC
451:    CHKERRQ - Checks error code, if non-zero it calls the error handler and then returns

453:    Synopsis:
454:    #include <petscsys.h>
455:    PetscErrorCode CHKERRQ(PetscErrorCode ierr)

457:    Not Collective

459:    Input Parameters:
460: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h

462:   Level: beginner

464:    Notes:
465:     Once the error handler is called the calling function is then returned from with the given error code.

467:     Experienced users can set the error handler with PetscPushErrorHandler().

469:     CHKERRQ(ierr) is fundamentally a macro replacement for
470:          if (ierr) return(PetscError(...,ierr,...));

472:     Although typical usage resembles "void CHKERRQ(PetscErrorCode)" as described above, for certain uses it is
473:     highly inappropriate to use it in this manner as it invokes return(PetscErrorCode). In particular,
474:     it cannot be used in functions which return(void) or any other datatype.  In these types of functions,
475:     you can use CHKERRV() which returns without an error code (bad idea since the error is ignored or
476:          if (ierr) {PetscError(....); return(YourReturnType);}
477:     where you may pass back a NULL to indicate an error. You can also call CHKERRABORT(comm,n) to have
478:     MPI_Abort() returned immediately.

480:    Concepts: error^setting condition

482: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2()
483: M*/
484: #define CHKERRQ(ierr)          do {if (PetscUnlikely(ierr)) return PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_REPEAT," ");} while (0)
485: #define CHKERRV(ierr)          do {if (PetscUnlikely(ierr)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_REPEAT," ");return;}} while(0)
486: #define CHKERRABORT(comm,ierr) do {if (PetscUnlikely(ierr)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_REPEAT," ");MPI_Abort(comm,ierr);}} while (0)
487: #define CHKERRCONTINUE(ierr)   do {if (PetscUnlikely(ierr)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_REPEAT," ");}} while (0)


490: /*MC
491:    CHKERRMPI - Checks error code, if non-zero it calls the error handler and then returns

493:    Synopsis:
494:    #include <petscsys.h>
495:    PetscErrorCode CHKERRMPI(PetscErrorCode ierr)

497:    Not Collective

499:    Input Parameters:
500: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h

502:   Level: developer

504:    Notes:
505:     This macro is FOR USE IN MPI CALLBACK FUNCTIONS ONLY, such as those passed to MPI_Comm_create_keyval(). It always returns the error code PETSC_MPI_ERROR_CODE
506:     which is registered with MPI_Add_error_code() when PETSc is initialized.

508:    Concepts: error^setting condition

510: .seealso: CHKERRQ(), PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2()
511: M*/
512: #define CHKERRMPI(ierr)        do {if (PetscUnlikely(ierr)) return (PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_REPEAT," "),PETSC_MPI_ERROR_CODE);} while (0)

514: #ifdef PETSC_CLANGUAGE_CXX

516: /*MC
517:    CHKERRXX - Checks error code, if non-zero it calls the C++ error handler which throws an exception

519:    Synopsis:
520:    #include <petscsys.h>
521:    void CHKERRXX(PetscErrorCode ierr)

523:    Not Collective

525:    Input Parameters:
526: .  ierr - nonzero error code, see the list of standard error codes in include/petscerror.h

528:   Level: beginner

530:    Notes:
531:     Once the error handler throws a ??? exception.

533:     You can use CHKERRV() which returns without an error code (bad idea since the error is ignored)
534:     or CHKERRABORT(comm,n) to have MPI_Abort() returned immediately.

536:    Concepts: error^setting condition

538: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKERRQ(), CHKMEMQ
539: M*/
540: #define CHKERRXX(ierr)  do {if (PetscUnlikely(ierr)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_IN_CXX,0);}} while(0)

542: #endif

544: #define CHKERRCUDA(err)   do {if (PetscUnlikely(err)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CUDA error %d",err);} while(0)
545: #define CHKERRCUBLAS(err) do {if (PetscUnlikely(err)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CUBLAS error %d",err);} while(0)

547: /*MC
548:    CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected

550:    Synopsis:
551:    #include <petscsys.h>
552:    CHKMEMQ;

554:    Not Collective

556:   Level: beginner

558:    Notes:
559:     We highly recommend using valgrind http://www.mcs.anl.gov/petsc/documentation/faq.html#valgrind for finding memory problems. This is useful
560:     on systems that do not have valgrind, but much much less useful.

562:     Must run with the option -malloc_debug to enable this option

564:     Once the error handler is called the calling function is then returned from with the given error code.

566:     By defaults prints location where memory that is corrupted was allocated.

568:     Use CHKMEMA for functions that return void

570:    Concepts: memory corruption

572: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(),
573:           PetscMallocValidate()
574: M*/
575: #define CHKMEMQ do {PetscErrorCode _7_PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__);CHKERRQ(_7_ierr);} while(0)

577: #define CHKMEMA PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__)

579: /*E
580:   PetscErrorType - passed to the PETSc error handling routines indicating if this is the first or a later call to the error handlers

582:   Level: advanced

584:   PETSC_ERROR_IN_CXX indicates the error was detected in C++ and an exception should be generated

586:   Developer Notes:
587:     This is currently used to decide when to print the detailed information about the run in PetscTraceBackErrorHandler()

589: .seealso: PetscError(), SETERRXX()
590: E*/
591: typedef enum {PETSC_ERROR_INITIAL=0,PETSC_ERROR_REPEAT=1,PETSC_ERROR_IN_CXX = 2} PetscErrorType;

593: #if defined(__clang_analyzer__)
594: __attribute__((analyzer_noreturn))
595: #endif
596: PETSC_EXTERN PetscErrorCode PetscError(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,...);

598: PETSC_EXTERN PetscErrorCode PetscErrorPrintfInitialize(void);
599: PETSC_EXTERN PetscErrorCode PetscErrorMessage(int,const char*[],char **);
600: PETSC_EXTERN PetscErrorCode PetscTraceBackErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
601: PETSC_EXTERN PetscErrorCode PetscIgnoreErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
602: PETSC_EXTERN PetscErrorCode PetscEmacsClientErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
603: PETSC_EXTERN PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
604: PETSC_EXTERN PetscErrorCode PetscAbortErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
605: PETSC_EXTERN PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
606: PETSC_EXTERN PetscErrorCode PetscReturnErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
607: PETSC_EXTERN PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*),void*);
608: PETSC_EXTERN PetscErrorCode PetscPopErrorHandler(void);
609: PETSC_EXTERN PetscErrorCode PetscSignalHandlerDefault(int,void*);
610: PETSC_EXTERN PetscErrorCode PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*);
611: PETSC_EXTERN PetscErrorCode PetscPopSignalHandler(void);
613: PETSC_EXTERN void PetscSignalSegvCheckPointer(void);

615: /*MC
616:     PetscErrorPrintf - Prints error messages.

618:    Synopsis:
619:     #include <petscsys.h>
620:      PetscErrorCode (*PetscErrorPrintf)(const char format[],...);

622:     Not Collective

624:     Input Parameters:
625: .   format - the usual printf() format string

627:    Options Database Keys:
628: +    -error_output_stdout - cause error messages to be printed to stdout instead of the  (default) stderr
629: -    -error_output_none - to turn off all printing of error messages (does not change the way the error is handled.)

631:    Notes:
632:     Use
633: $     PetscErrorPrintf = PetscErrorPrintfNone; to turn off all printing of error messages (does not change the way the
634: $                        error is handled.) and
635: $     PetscErrorPrintf = PetscErrorPrintfDefault; to turn it back on or you can use your own function

637:           Use
638:      PETSC_STDERR = FILE* obtained from a file open etc. to have stderr printed to the file.
639:      PETSC_STDOUT = FILE* obtained from a file open etc. to have stdout printed to the file.

641:           Use
642:       PetscPushErrorHandler() to provide your own error handler that determines what kind of messages to print

644:    Level: developer

646:     Fortran Note:
647:     This routine is not supported in Fortran.

649:     Concepts: error messages^printing
650:     Concepts: printing^error messages

652: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscHelpPrintf(), PetscPrintf(), PetscPushErrorHandler(), PetscVFPrintf(), PetscHelpPrintf()
653: M*/
654: PETSC_EXTERN PetscErrorCode (*PetscErrorPrintf)(const char[],...);

656: typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap;
657: PETSC_EXTERN PetscErrorCode PetscSetFPTrap(PetscFPTrap);
658: PETSC_EXTERN PetscErrorCode PetscFPTrapPush(PetscFPTrap);
659: PETSC_EXTERN PetscErrorCode PetscFPTrapPop(void);

661: /*
662:       Allows the code to build a stack frame as it runs
663: */

665: #define PETSCSTACKSIZE 64

667: typedef struct  {
668:   const char      *function[PETSCSTACKSIZE];
669:   const char      *file[PETSCSTACKSIZE];
670:         int       line[PETSCSTACKSIZE];
671:         PetscBool petscroutine[PETSCSTACKSIZE];
672:         int       currentsize;
673:         int       hotdepth;
674: } PetscStack;

676: PETSC_EXTERN PetscStack *petscstack;

678: PetscErrorCode  PetscStackCopy(PetscStack*,PetscStack*);
679: PetscErrorCode  PetscStackPrint(PetscStack *,FILE*);
680: #if defined(PETSC_SERIALIZE_FUNCTIONS)
681:  #include <petsc/private/petscfptimpl.h>
682: /*
683:    Registers the current function into the global function pointer to function name table

685:    Have to fix this to handle errors but cannot return error since used in PETSC_VIEWER_DRAW_() etc
686: */
687: #define PetscRegister__FUNCT__() do { \
688:   static PetscBool __chked = PETSC_FALSE; \
689:   if (!__chked) {\
690:   void *ptr; PetscDLSym(NULL,PETSC_FUNCTION_NAME,&ptr);\
691:   __chked = PETSC_TRUE;\
692:   }} while (0)
693: #else
694: #define PetscRegister__FUNCT__()
695: #endif

697: #if defined(PETSC_USE_DEBUG)
698: PETSC_STATIC_INLINE PetscBool PetscStackActive(void)
699: {
700:   return(petscstack ? PETSC_TRUE : PETSC_FALSE);
701: }

703: /* Stack handling is based on the following two "NoCheck" macros.  These should only be called directly by other error
704:  * handling macros.  We record the line of the call, which may or may not be the location of the definition.  But is at
705:  * least more useful than "unknown" because it can distinguish multiple calls from the same function.
706:  */

708: #define PetscStackPushNoCheck(funct,petsc_routine,hot)                        \
709:   do {                                                                        \
710:     PetscStackSAWsTakeAccess();                                                \
711:     if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) {         \
712:       petscstack->function[petscstack->currentsize]  = funct;               \
713:       petscstack->file[petscstack->currentsize]      = __FILE__;            \
714:       petscstack->line[petscstack->currentsize]      = __LINE__;            \
715:       petscstack->petscroutine[petscstack->currentsize] = petsc_routine;    \
716:       petscstack->currentsize++;                                             \
717:     }                                                                         \
718:     if (petscstack) {                                                        \
719:       petscstack->hotdepth += (hot || petscstack->hotdepth);                \
720:     }                                                                         \
721:     PetscStackSAWsGrantAccess();                                               \
722:   } while (0)

724: #define PetscStackPopNoCheck                                            \
725:   do {                                                                  \
726:     PetscStackSAWsTakeAccess();                                          \
727:     if (petscstack && petscstack->currentsize > 0) {                  \
728:       petscstack->currentsize--;                                       \
729:       petscstack->function[petscstack->currentsize]  = 0;             \
730:       petscstack->file[petscstack->currentsize]      = 0;             \
731:       petscstack->line[petscstack->currentsize]      = 0;             \
732:       petscstack->petscroutine[petscstack->currentsize] = PETSC_FALSE;\
733:     }                                                                   \
734:     if (petscstack) {                                                  \
735:       petscstack->hotdepth = PetscMax(petscstack->hotdepth-1,0);      \
736:     }                                                                   \
737:     PetscStackSAWsGrantAccess();                                         \
738:   } while (0)

740: /*MC
742:       line of PETSc functions should be return(0);

744:    Synopsis:
745:    #include <petscsys.h>

748:    Not Collective

750:    Usage:
751: .vb
752:      int something;

755: .ve

757:    Notes:

760:      Not available in Fortran

762:    Level: developer


766: .keywords: traceback, error handling
767: M*/
769:     PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_TRUE,PETSC_FALSE); \
770:     PetscRegister__FUNCT__();                                          \
771:   } while (0)

773: /*MC
775:    performance-critical circumstances.  Use of this function allows for lighter profiling by default.

777:    Synopsis:
778:    #include <petscsys.h>

781:    Not Collective

783:    Usage:
784: .vb
785:      int something;

788: .ve

790:    Notes:
791:      Not available in Fortran

793:    Level: developer


797: .keywords: traceback, error handling
798: M*/
800:     PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_TRUE,PETSC_TRUE);  \
801:     PetscRegister__FUNCT__();                                          \
802:   } while (0)

804: /*MC

807:    Synopsis:
808:    #include <petscsys.h>

811:    Not Collective

813:    Usage:
814: .vb
815:      int something;

818: .ve

820:    Notes:
821:       Final line of PETSc functions should be return(0) except for main().

823:       Not available in Fortran

826:       routine instead of as a PETSc library routine.

828:    Level: intermediate


832: .keywords: traceback, error handling
833: M*/
835:   do {                                                                  \
836:     PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_FALSE,PETSC_FALSE); \
837:     PetscRegister__FUNCT__();                                           \
838:   } while (0)


841: #define PetscStackPush(n) \
842:   do {                                                                  \
843:     PetscStackPushNoCheck(n,PETSC_FALSE,PETSC_FALSE);                   \
844:     CHKMEMQ;                                                            \
845:   } while (0)

847: #define PetscStackPop                           \
848:     do {                                        \
849:       CHKMEMQ;                                  \
850:       PetscStackPopNoCheck;                     \
851:     } while (0)

853: /*MC
854:    PetscFunctionReturn - Last executable line of each PETSc function
855:         used for error handling. Replaces return()

857:    Synopsis:
858:    #include <petscsys.h>
859:    void return(0);

861:    Not Collective

863:    Usage:
864: .vb
865:     ....
866:      return(0);
867:    }
868: .ve

870:    Notes:
871:      Not available in Fortran

873:    Level: developer


877: .keywords: traceback, error handling
878: M*/
879: #define PetscFunctionReturn(a) \
880:   do {                                                                \
881:     PetscStackPopNoCheck;                                             \
882:     return(a);} while (0)

884: #define PetscFunctionReturnVoid() \
885:   do {                                                                \
886:     PetscStackPopNoCheck;                                             \
887:     return;} while (0)

889: #else

891: PETSC_STATIC_INLINE PetscBool PetscStackActive(void) {return PETSC_FALSE;}
892: #define PetscStackPushNoCheck(funct,petsc_routine,hot) do {} while (0)
893: #define PetscStackPopNoCheck                           do {} while (0)
897: #define PetscFunctionReturn(a)    return(a)
898: #define PetscFunctionReturnVoid() return
899: #define PetscStackPop             CHKMEMQ
900: #define PetscStackPush(f)         CHKMEMQ

902: #endif

904: /*
905:     PetscStackCall - Calls an external library routine or user function after pushing the name of the routine on the stack.

907:    Input Parameters:
908: +   name - string that gives the name of the function being called
909: -   routine - actual call to the routine, including and 

911:    Note: Often one should use PetscStackCallStandard() instead. This routine is intended for external library routines that DO NOT return error codes

913:    Developer Note: this is so that when a user or external library routine results in a crash or corrupts memory, they get blamed instead of PETSc.



917: */
918: #define PetscStackCall(name,routine) do { PetscStackPush(name);routine;PetscStackPop; } while(0)

920: /*
921:     PetscStackCallStandard - Calls an external library routine after pushing the name of the routine on the stack.

923:    Input Parameters:
924: +   func-  name of the routine
925: -   args - arguments to the routine surrounded by ()

927:    Notes:
928:     This is intended for external package routines that return error codes. Use PetscStackCall() for those that do not.

930:    Developer Note: this is so that when an external packge routine results in a crash or corrupts memory, they get blamed instead of PETSc.

932: */
933: #define PetscStackCallStandard(func,args) do {                                                            \
934:     PetscErrorCode __ierr;                                                                                \
935:     PetscStackPush(#func);                                                                                \
936:     __func args;                                                                                   \
937:     PetscStackPop;                                                                                        \
938:     if (__ierr) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error in %s(): error code %d",#func,(int)__ierr); \
939:   } while (0)

941: PETSC_EXTERN PetscErrorCode PetscStackCreate(void);
942: PETSC_EXTERN PetscErrorCode PetscStackView(FILE*);
943: PETSC_EXTERN PetscErrorCode PetscStackDestroy(void);

945: #endif