Actual source code: petscerror.h

petsc-master 2015-07-31
Report Typos and Errors
  1: /*
  2:     Contains all error handling interfaces for PETSc.
  3: */

  7: /*
  8:    Defines the function where the compiled source is located; used
  9:    in printing error messages. This is defined here in case the user
 10:    does not declare it.
 11: */
 14: #endif

 16: /*
 17:      These are the generic error codes. These error codes are used
 18:      many different places in the PETSc source code. The string versions are
 19:      at src/sys/error/err.c any changes here must also be made there
 20:      These are also define in include/petsc/finclude/petscerror.h any CHANGES here
 21:      must be also made there.

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

 26: #define PETSC_ERR_MEM              55   /* unable to allocate requested memory */
 27: #define PETSC_ERR_SUP              56   /* no support for requested operation */
 28: #define PETSC_ERR_SUP_SYS          57   /* no support for requested operation on this computer system */
 29: #define PETSC_ERR_ORDER            58   /* operation done in wrong order */
 30: #define PETSC_ERR_SIG              59   /* signal received */
 31: #define PETSC_ERR_FP               72   /* floating point exception */
 32: #define PETSC_ERR_COR              74   /* corrupted PETSc object */
 33: #define PETSC_ERR_LIB              76   /* error in library called by PETSc */
 34: #define PETSC_ERR_PLIB             77   /* PETSc library generated inconsistent data */
 35: #define PETSC_ERR_MEMC             78   /* memory corruption */
 36: #define PETSC_ERR_CONV_FAILED      82   /* iterative method (KSP or SNES) failed */
 37: #define PETSC_ERR_USER             83   /* user has not provided needed function */
 38: #define PETSC_ERR_SYS              88   /* error in system call */
 39: #define PETSC_ERR_POINTER          70   /* pointer does not point to valid address */

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

 55: #define PETSC_ERR_FILE_OPEN        65   /* unable to open file */
 56: #define PETSC_ERR_FILE_READ        66   /* unable to read from file */
 57: #define PETSC_ERR_FILE_WRITE       67   /* unable to write to file */
 58: #define PETSC_ERR_FILE_UNEXPECTED  79   /* unexpected data in file */

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

 63: #define PETSC_ERR_INT_OVERFLOW     84

 65: #define PETSC_ERR_FLOP_COUNT       90
 66: #define PETSC_ERR_NOT_CONVERGED    91  /* solver did not converge */
 67: #define PETSC_ERR_MISSING_FACTOR   92  /* MatGetFactor() failed */
 68: #define PETSC_ERR_MAX_VALUE        93  /* this is always the one more than the largest error code */

 70: #define PETSC_ERR_OPT_OVERWRITE    94  /* overwrote options which should not be changed */

 72: #define PetscStringizeArg(a) #a
 73: #define PetscStringize(a) PetscStringizeArg(a)

 75: #if defined(PETSC_USE_ERRORCHECKING)

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

 80:    Synopsis:
 81:    #include <petscsys.h>
 82:    PetscErrorCode SETERRQ(MPI_Comm comm,PetscErrorCode errorcode,char *message)

 84:    Not Collective

 86:    Input Parameters:
 87: +  comm - A communicator, so that the error can be collective
 88: .  errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
 89: -  message - error message

 91:   Level: beginner

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

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

 98:     In Fortran MPI_Abort() is always called

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

102:    Concepts: error^setting condition

104: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3()
105: M*/
106: #define SETERRQ(comm,n,s)              return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_INITIAL,s)

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

111:    Synopsis:
112:    #include <petscsys.h>
113:    PetscErrorCode SETERRQ1(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg)

115:    Not Collective

117:    Input Parameters:
118: +  comm - A communicator, so that the error can be collective
119: .  errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
120: .  message - error message in the printf format
121: -  arg - argument (for example an integer, string or double)

123:   Level: beginner

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

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

130:    Concepts: error^setting condition

132: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3()
133: M*/
134: #define SETERRQ1(comm,n,s,a1)          return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_INITIAL,s,a1)

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

139:    Synopsis:
140:    #include <petscsys.h>
141:    PetscErrorCode SETERRQ2(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2)

143:    Not Collective

145:    Input Parameters:
146: +  comm - A communicator, so that the error can be collective
147: .  errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
148: .  message - error message in the printf format
149: .  arg1 - argument (for example an integer, string or double)
150: -  arg2 - argument (for example an integer, string or double)

152:   Level: beginner

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

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

159:    Concepts: error^setting condition

161: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3()
162: M*/
163: #define SETERRQ2(comm,n,s,a1,a2)       return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_INITIAL,s,a1,a2)

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

168:    Synopsis:
169:    #include <petscsys.h>
170:    PetscErrorCode SETERRQ3(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)

172:    Not Collective

174:    Input Parameters:
175: +  comm - A communicator, so that the error can be collective
176: .  errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
177: .  message - error message in the printf format
178: .  arg1 - argument (for example an integer, string or double)
179: .  arg2 - argument (for example an integer, string or double)
180: -  arg3 - argument (for example an integer, string or double)

182:   Level: beginner

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

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

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

191:    Concepts: error^setting condition

193: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
194: M*/
195: #define SETERRQ3(comm,n,s,a1,a2,a3)    return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_INITIAL,s,a1,a2,a3)

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

200:    Synopsis:
201:    #include <petscsys.h>
202:    PetscErrorCode SETERRQ4(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)

204:    Not Collective

206:    Input Parameters:
207: +  comm - A communicator, so that the error can be collective
208: .  errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
209: .  message - error message in the printf format
210: .  arg1 - argument (for example an integer, string or double)
211: .  arg2 - argument (for example an integer, string or double)
212: .  arg3 - argument (for example an integer, string or double)
213: -  arg4 - argument (for example an integer, string or double)

215:   Level: beginner

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

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

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

224:    Concepts: error^setting condition

226: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
227: M*/
228: #define SETERRQ4(comm,n,s,a1,a2,a3,a4) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4)

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

233:    Synopsis:
234:    #include <petscsys.h>
235:    PetscErrorCode SETERRQ5(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)

237:    Not Collective

239:    Input Parameters:
240: +  comm - A communicator, so that the error can be collective
241: .  errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
242: .  message - error message in the printf format
243: .  arg1 - argument (for example an integer, string or double)
244: .  arg2 - argument (for example an integer, string or double)
245: .  arg3 - argument (for example an integer, string or double)
246: .  arg4 - argument (for example an integer, string or double)
247: -  arg5 - argument (for example an integer, string or double)

249:   Level: beginner

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

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

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

258:    Concepts: error^setting condition

260: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
261: M*/
262: #define SETERRQ5(comm,n,s,a1,a2,a3,a4,a5)       return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5)

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

267:    Synopsis:
268:    #include <petscsys.h>
269:    PetscErrorCode SETERRQ6(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)

271:    Not Collective

273:    Input Parameters:
274: +  comm - A communicator, so that the error can be collective
275: .  errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
276: .  message - error message in the printf format
277: .  arg1 - argument (for example an integer, string or double)
278: .  arg2 - argument (for example an integer, string or double)
279: .  arg3 - argument (for example an integer, string or double)
280: .  arg4 - argument (for example an integer, string or double)
281: .  arg5 - argument (for example an integer, string or double)
282: -  arg6 - argument (for example an integer, string or double)

284:   Level: beginner

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

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

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

293:    Concepts: error^setting condition

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

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

302:    Synopsis:
303:    #include <petscsys.h>
304:    PetscErrorCode SETERRQ7(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)

306:    Not Collective

308:    Input Parameters:
309: +  comm - A communicator, so that the error can be collective
310: .  errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
311: .  message - error message in the printf format
312: .  arg1 - argument (for example an integer, string or double)
313: .  arg2 - argument (for example an integer, string or double)
314: .  arg3 - argument (for example an integer, string or double)
315: .  arg4 - argument (for example an integer, string or double)
316: .  arg5 - argument (for example an integer, string or double)
317: .  arg6 - argument (for example an integer, string or double)
318: -  arg7 - argument (for example an integer, string or double)

320:   Level: beginner

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

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

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

329:    Concepts: error^setting condition

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

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

338:    Synopsis:
339:    #include <petscsys.h>
340:    PetscErrorCode SETERRQ8(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)

342:    Not Collective

344:    Input Parameters:
345: +  comm - A communicator, so that the error can be collective
346: .  errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
347: .  message - error message in the printf format
348: .  arg1 - argument (for example an integer, string or double)
349: .  arg2 - argument (for example an integer, string or double)
350: .  arg3 - argument (for example an integer, string or double)
351: .  arg4 - argument (for example an integer, string or double)
352: .  arg5 - argument (for example an integer, string or double)
353: .  arg6 - argument (for example an integer, string or double)
354: .  arg7 - argument (for example an integer, string or double)
355: -  arg8 - argument (for example an integer, string or double)

357:   Level: beginner

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

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

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

366:    Concepts: error^setting condition

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

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

375:    Synopsis:
376:    #include <petscsys.h>
377:    PetscErrorCode SETERRABORT(MPI_Comm comm,PetscErrorCode errorcode,char *message)

379:    Not Collective

381:    Input Parameters:
382: +  comm - A communicator, so that the error can be collective
383: .  errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
384: -  message - error message in the printf format

386:   Level: beginner

388:    Notes:
389:     This function just calls MPI_Abort().

391:    Concepts: error^setting condition

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

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

400:    Synopsis:
401:    #include <petscsys.h>
402:    PetscErrorCode CHKERRQ(PetscErrorCode errorcode)

404:    Not Collective

406:    Input Parameters:
407: .  errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h

409:   Level: beginner

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

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

416:     CHKERRQ(n) is fundamentally a macro replacement for
417:          if (n) return(PetscError(...,n,...));

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

427:     In Fortran MPI_Abort() is always called

429:    Concepts: error^setting condition

431: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2()
432: M*/
433: #define CHKERRQ(n)             do {if (PetscUnlikely(n)) return PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_REPEAT," ");} while (0)

435: #define CHKERRV(n)             do {if (PetscUnlikely(n)) {n = PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_REPEAT," ");return;}} while(0)
436: #define CHKERRABORT(comm,n)    do {if (PetscUnlikely(n)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_REPEAT," ");MPI_Abort(comm,n);}} while (0)
437: #define CHKERRCONTINUE(n)      do {if (PetscUnlikely(n)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_REPEAT," ");}} while (0)

439: #ifdef PETSC_CLANGUAGE_CXX

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

444:    Synopsis:
445:    #include <petscsys.h>
446:    void CHKERRXX(PetscErrorCode errorcode)

448:    Not Collective

450:    Input Parameters:
451: .  errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h

453:   Level: beginner

455:    Notes:
456:     Once the error handler throws a ??? exception.

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

461:    Concepts: error^setting condition

463: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKERRQ(), CHKMEMQ
464: M*/
465: #define CHKERRXX(n)            do {if (PetscUnlikely(n)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_IN_CXX,0);}} while(0)

467: #endif

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

472:    Synopsis:
473:    #include <petscsys.h>
474:    CHKMEMQ;

476:    Not Collective

478:   Level: beginner

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

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

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

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

490:     Use CHKMEMA for functions that return void

492:    Concepts: memory corruption

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

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

501: #else /* PETSC_USE_ERRORCHECKING */

503: /*
504:     These are defined to be empty for when error checking is turned off, with ./configure --with-errorchecking=0
505: */

507: #define SETERRQ(c,n,s)
508: #define SETERRQ1(c,n,s,a1)
509: #define SETERRQ2(c,n,s,a1,a2)
510: #define SETERRQ3(c,n,s,a1,a2,a3)
511: #define SETERRQ4(c,n,s,a1,a2,a3,a4)
512: #define SETERRQ5(c,n,s,a1,a2,a3,a4,a5)
513: #define SETERRQ6(c,n,s,a1,a2,a3,a4,a5,a6)
514: #define SETERRQ7(c,n,s,a1,a2,a3,a4,a5,a6,a7)
515: #define SETERRQ8(c,n,s,a1,a2,a3,a4,a5,a6,a7,a8)
516: #define SETERRABORT(comm,n,s)

518: #define CHKERRQ(n)     ;
519: #define CHKERRABORT(comm,n) ;
520: #define CHKERRCONTINUE(n) ;
521: #define CHKMEMQ        ;

523: #ifdef PETSC_CLANGUAGE_CXX
524: #define CHKERRXX(n) ;
525: #endif

527: #endif /* PETSC_USE_ERRORCHECKING */

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

532:   Level: advanced

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

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

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

542: #if defined(__clang_analyzer__)
543: __attribute__((analyzer_noreturn))
544: #endif
545: PETSC_EXTERN PetscErrorCode PetscError(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,...);

547: PETSC_EXTERN PetscErrorCode PetscErrorPrintfInitialize(void);
548: PETSC_EXTERN PetscErrorCode PetscErrorMessage(int,const char*[],char **);
549: PETSC_EXTERN PetscErrorCode PetscTraceBackErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
550: PETSC_EXTERN PetscErrorCode PetscIgnoreErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
551: PETSC_EXTERN PetscErrorCode PetscEmacsClientErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
552: PETSC_EXTERN PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
553: PETSC_EXTERN PetscErrorCode PetscAbortErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
554: PETSC_EXTERN PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
555: PETSC_EXTERN PetscErrorCode PetscReturnErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
556: PETSC_EXTERN PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*),void*);
557: PETSC_EXTERN PetscErrorCode PetscPopErrorHandler(void);
558: PETSC_EXTERN PetscErrorCode PetscSignalHandlerDefault(int,void*);
559: PETSC_EXTERN PetscErrorCode PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*);
560: PETSC_EXTERN PetscErrorCode PetscPopSignalHandler(void);

563: /*MC
564:     PetscErrorPrintf - Prints error messages.

566:    Synopsis:
567:     #include <petscsys.h>
568:      PetscErrorCode (*PetscErrorPrintf)(const char format[],...);

570:     Not Collective

572:     Input Parameters:
573: .   format - the usual printf() format string

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

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

584:           Use
585:      PETSC_STDERR = FILE* obtained from a file open etc. to have stderr printed to the file.
586:      PETSC_STDOUT = FILE* obtained from a file open etc. to have stdout printed to the file.

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

591:    Level: developer

593:     Fortran Note:
594:     This routine is not supported in Fortran.

596:     Concepts: error messages^printing
597:     Concepts: printing^error messages

599: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscHelpPrintf(), PetscPrintf(), PetscErrorHandlerPush(), PetscVFPrintf(), PetscHelpPrintf()
600: M*/
601: PETSC_EXTERN PetscErrorCode (*PetscErrorPrintf)(const char[],...);

603: typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap;
604: PETSC_EXTERN PetscErrorCode PetscSetFPTrap(PetscFPTrap);
605: PETSC_EXTERN PetscErrorCode PetscFPTrapPush(PetscFPTrap);
606: PETSC_EXTERN PetscErrorCode PetscFPTrapPop(void);

608: /*
609:       Allows the code to build a stack frame as it runs
610: */

612: #define PETSCSTACKSIZE 64

614: typedef struct  {
615:   const char      *function[PETSCSTACKSIZE];
616:   const char      *file[PETSCSTACKSIZE];
617:         int       line[PETSCSTACKSIZE];
618:         PetscBool petscroutine[PETSCSTACKSIZE];
619:         int       currentsize;
620:         int       hotdepth;
621: } PetscStack;

623: PETSC_EXTERN PetscStack *petscstack;

625: PetscErrorCode  PetscStackCopy(PetscStack*,PetscStack*);
626: PetscErrorCode  PetscStackPrint(PetscStack *,FILE*);
627: #if defined(PETSC_USE_DEBUG)
628: PETSC_STATIC_INLINE PetscBool PetscStackActive(void)
629: {
630:   return(petscstack ? PETSC_TRUE : PETSC_FALSE);
631: }

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

638: #define PetscStackPushNoCheck(funct,petsc_routine,hot)                        \
639:   do {                                                                        \
640:     PetscStackSAWsTakeAccess();                                                \
641:     if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) {         \
642:       petscstack->function[petscstack->currentsize]  = funct;               \
643:       petscstack->file[petscstack->currentsize]      = __FILE__;            \
644:       petscstack->line[petscstack->currentsize]      = __LINE__;            \
645:       petscstack->petscroutine[petscstack->currentsize] = petsc_routine;    \
646:       petscstack->currentsize++;                                             \
647:     }                                                                         \
648:     if (petscstack) {                                                        \
649:       petscstack->hotdepth += (hot || petscstack->hotdepth);                \
650:     }                                                                         \
651:     PetscStackSAWsGrantAccess();                                               \
652:   } while (0)

654: #define PetscStackPopNoCheck                                            \
655:   do {                                                                  \
656:     PetscStackSAWsTakeAccess();                                          \
657:     if (petscstack && petscstack->currentsize > 0) {                  \
658:       petscstack->currentsize--;                                       \
659:       petscstack->function[petscstack->currentsize]  = 0;             \
660:       petscstack->file[petscstack->currentsize]      = 0;             \
661:       petscstack->line[petscstack->currentsize]      = 0;             \
662:       petscstack->petscroutine[petscstack->currentsize] = PETSC_FALSE;\
663:     }                                                                   \
664:     if (petscstack) {                                                  \
665:       petscstack->hotdepth = PetscMax(petscstack->hotdepth-1,0);      \
666:     }                                                                   \
667:     PetscStackSAWsGrantAccess();                                         \
668:   } while (0)

670: /*MC
672:       line of PETSc functions should be return(0);

674:    Synopsis:
675:    #include <petscsys.h>

678:    Not Collective

680:    Usage:
681: .vb
682:      int something;

685: .ve

687:    Notes:

690:      Not available in Fortran

692:    Level: developer


696: .keywords: traceback, error handling
697: M*/
699:     PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_TRUE,PETSC_FALSE); \
701:     PetscRegister__FUNCT__();                                          \
702:   } while (0)

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

708:    Synopsis:
709:    #include <petscsys.h>

712:    Not Collective

714:    Usage:
715: .vb
716:      int something;

719: .ve

721:    Notes:
722:      Not available in Fortran

724:    Level: developer


728: .keywords: traceback, error handling
729: M*/
731:     PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_TRUE,PETSC_TRUE);  \
733:     PetscRegister__FUNCT__();                                          \
734:   } while (0)

736: /*MC

739:    Synopsis:
740:    #include <petscsys.h>

743:    Not Collective

745:    Usage:
746: .vb
747:      int something;

750: .ve

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

755:       Not available in Fortran

757:    Level: intermediate


761: .keywords: traceback, error handling
762: M*/
764:   do {                                                                  \
765:     PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_FALSE,PETSC_FALSE); \
767:     PetscRegister__FUNCT__();                                           \
768:   } while (0)


771: #if defined(PETSC_SERIALIZE_FUNCTIONS)
772: #include <petsc/private/petscfptimpl.h>
773: /*
774:    Registers the current function into the global function pointer to function name table

776:    Have to fix this to handle errors but cannot return error since used in PETSC_VIEWER_DRAW_() etc
777: */
778: #define PetscRegister__FUNCT__() do { \
779:   static PetscBool __chked = PETSC_FALSE; \
780:   if (!__chked) {\
781:   void *ptr; PetscDLSym(NULL,__FUNCT__,&ptr);\
782:   __chked = PETSC_TRUE;\
783:   }} while (0)
784: #else
785: #define PetscRegister__FUNCT__()
786: #endif

789:     PetscStrcmpNoError(PETSC_FUNCTION_NAME,__FUNCT__,&_sc1);\
790:     PetscStrcmpNoError(__FUNCT__,"User provided function",&_sc2);\
791:     if (!_sc1 && !_sc2) { \
792:       printf("%s:%d: __FUNCT__=\"%s\" does not agree with %s=\"%s\"\n",__FILE__,__LINE__,__FUNCT__,PetscStringize(PETSC_FUNCTION_NAME),PETSC_FUNCTION_NAME); \
793:     }                                                                   \
794:   } while (0)

796: #define PetscStackPush(n) \
797:   do {                                                                  \
798:     PetscStackPushNoCheck(n,PETSC_FALSE,PETSC_FALSE);                   \
799:     CHKMEMQ;                                                            \
800:   } while (0)

802: #define PetscStackPop                           \
803:     do {                                        \
804:       CHKMEMQ;                                  \
805:       PetscStackPopNoCheck;                     \
806:     } while (0)

808: /*MC
809:    PetscFunctionReturn - Last executable line of each PETSc function
810:         used for error handling. Replaces return()

812:    Synopsis:
813:    #include <petscsys.h>
814:    void return(0);

816:    Not Collective

818:    Usage:
819: .vb
820:     ....
821:      return(0);
822:    }
823: .ve

825:    Notes:
826:      Not available in Fortran

828:    Level: developer


832: .keywords: traceback, error handling
833: M*/
834: #define PetscFunctionReturn(a) \
835:   do {                                                                \
836:     PetscStackPopNoCheck;                                             \
837:     return(a);} while (0)

839: #define PetscFunctionReturnVoid() \
840:   do {                                                                \
841:     PetscStackPopNoCheck;                                             \
842:     return;} while (0)

844: #else

846: PETSC_STATIC_INLINE PetscBool PetscStackActive(void) {return PETSC_FALSE;}
847: #define PetscStackPushNoCheck(funct,petsc_routine,hot) do {} while (0)
848: #define PetscStackPopNoCheck                           do {} while (0)
852: #define PetscFunctionReturn(a)    return(a)
853: #define PetscFunctionReturnVoid() return
854: #define PetscStackPop             CHKMEMQ
855: #define PetscStackPush(f)         CHKMEMQ

857: #endif

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

862:    Input Parameters:
863: +   name - string that gives the name of the function being called
864: -   routine - actual call to the routine, including and 

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

868:    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.



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

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

878:    Input Parameters:
879: +   func-  name of the routine
880: -   args - arguments to the routine surrounded by ()

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

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

886: */
887: #define PetscStackCallStandard(func,args) do {                        \
888:     PetscStackPush(#func);func args;PetscStackPop; if (ierr) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error in %s()",#func); \
889:   } while (0)

891: PETSC_EXTERN PetscErrorCode PetscStackCreate(void);
892: PETSC_EXTERN PetscErrorCode PetscStackView(FILE*);
893: PETSC_EXTERN PetscErrorCode PetscStackDestroy(void);

895: #endif