/usr/lib/petscdir/3.7.7/x86_64-linux-gnu-real-debug/include/petscerror.h is in libpetsc3.7.7-dbg 3.7.7+dfsg1-2build5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 | /*
Contains all error handling interfaces for PETSc.
*/
#if !defined(__PETSCERROR_H)
#define __PETSCERROR_H
/*
Defines the function where the compiled source is located; used
in printing error messages. This is defined here in case the user
does not declare it.
*/
#if !defined(__FUNCT__)
#define __FUNCT__ "User provided function"
#endif
/*
These are the generic error codes. These error codes are used
many different places in the PETSc source code. The string versions are
at src/sys/error/err.c any changes here must also be made there
These are also define in include/petsc/finclude/petscerror.h any CHANGES here
must be also made there.
*/
#define PETSC_ERR_MIN_VALUE 54 /* should always be one less then the smallest value */
#define PETSC_ERR_MEM 55 /* unable to allocate requested memory */
#define PETSC_ERR_SUP 56 /* no support for requested operation */
#define PETSC_ERR_SUP_SYS 57 /* no support for requested operation on this computer system */
#define PETSC_ERR_ORDER 58 /* operation done in wrong order */
#define PETSC_ERR_SIG 59 /* signal received */
#define PETSC_ERR_FP 72 /* floating point exception */
#define PETSC_ERR_COR 74 /* corrupted PETSc object */
#define PETSC_ERR_LIB 76 /* error in library called by PETSc */
#define PETSC_ERR_PLIB 77 /* PETSc library generated inconsistent data */
#define PETSC_ERR_MEMC 78 /* memory corruption */
#define PETSC_ERR_CONV_FAILED 82 /* iterative method (KSP or SNES) failed */
#define PETSC_ERR_USER 83 /* user has not provided needed function */
#define PETSC_ERR_SYS 88 /* error in system call */
#define PETSC_ERR_POINTER 70 /* pointer does not point to valid address */
#define PETSC_ERR_ARG_SIZ 60 /* nonconforming object sizes used in operation */
#define PETSC_ERR_ARG_IDN 61 /* two arguments not allowed to be the same */
#define PETSC_ERR_ARG_WRONG 62 /* wrong argument (but object probably ok) */
#define PETSC_ERR_ARG_CORRUPT 64 /* null or corrupted PETSc object as argument */
#define PETSC_ERR_ARG_OUTOFRANGE 63 /* input argument, out of range */
#define PETSC_ERR_ARG_BADPTR 68 /* invalid pointer argument */
#define PETSC_ERR_ARG_NOTSAMETYPE 69 /* two args must be same object type */
#define PETSC_ERR_ARG_NOTSAMECOMM 80 /* two args must be same communicators */
#define PETSC_ERR_ARG_WRONGSTATE 73 /* object in argument is in wrong state, e.g. unassembled mat */
#define PETSC_ERR_ARG_TYPENOTSET 89 /* the type of the object has not yet been set */
#define PETSC_ERR_ARG_INCOMP 75 /* two arguments are incompatible */
#define PETSC_ERR_ARG_NULL 85 /* argument is null that should not be */
#define PETSC_ERR_ARG_UNKNOWN_TYPE 86 /* type name doesn't match any registered type */
#define PETSC_ERR_FILE_OPEN 65 /* unable to open file */
#define PETSC_ERR_FILE_READ 66 /* unable to read from file */
#define PETSC_ERR_FILE_WRITE 67 /* unable to write to file */
#define PETSC_ERR_FILE_UNEXPECTED 79 /* unexpected data in file */
#define PETSC_ERR_MAT_LU_ZRPVT 71 /* detected a zero pivot during LU factorization */
#define PETSC_ERR_MAT_CH_ZRPVT 81 /* detected a zero pivot during Cholesky factorization */
#define PETSC_ERR_INT_OVERFLOW 84
#define PETSC_ERR_FLOP_COUNT 90
#define PETSC_ERR_NOT_CONVERGED 91 /* solver did not converge */
#define PETSC_ERR_MISSING_FACTOR 92 /* MatGetFactor() failed */
#define PETSC_ERR_OPT_OVERWRITE 93 /* attempted to over wrote options which should not be changed */
#define PETSC_ERR_MAX_VALUE 94 /* this is always the one more than the largest error code */
#define PetscStringizeArg(a) #a
#define PetscStringize(a) PetscStringizeArg(a)
#if defined(PETSC_USE_ERRORCHECKING)
/*MC
SETERRQ - Macro to be called when an error has been detected,
Synopsis:
#include <petscsys.h>
PetscErrorCode SETERRQ(MPI_Comm comm,PetscErrorCode errorcode,char *message)
Not Collective
Input Parameters:
+ comm - A communicator, so that the error can be collective
. errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
- message - error message
Level: beginner
Notes:
Once the error handler is called the calling function is then returned from with the given error code.
See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments
In Fortran MPI_Abort() is always called
Experienced users can set the error handler with PetscPushErrorHandler().
Concepts: error^setting condition
.seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3()
M*/
#define SETERRQ(comm,n,s) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_INITIAL,s)
/*MC
SETERRQ1 - Macro that is called when an error has been detected,
Synopsis:
#include <petscsys.h>
PetscErrorCode SETERRQ1(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg)
Not Collective
Input Parameters:
+ comm - A communicator, so that the error can be collective
. errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
. message - error message in the printf format
- arg - argument (for example an integer, string or double)
Level: beginner
Notes:
Once the error handler is called the calling function is then returned from with the given error code.
Experienced users can set the error handler with PetscPushErrorHandler().
Concepts: error^setting condition
.seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3()
M*/
#define SETERRQ1(comm,n,s,a1) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_INITIAL,s,a1)
/*MC
SETERRQ2 - Macro that is called when an error has been detected,
Synopsis:
#include <petscsys.h>
PetscErrorCode SETERRQ2(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2)
Not Collective
Input Parameters:
+ comm - A communicator, so that the error can be collective
. errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
. message - error message in the printf format
. arg1 - argument (for example an integer, string or double)
- arg2 - argument (for example an integer, string or double)
Level: beginner
Notes:
Once the error handler is called the calling function is then returned from with the given error code.
Experienced users can set the error handler with PetscPushErrorHandler().
Concepts: error^setting condition
.seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3()
M*/
#define SETERRQ2(comm,n,s,a1,a2) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_INITIAL,s,a1,a2)
/*MC
SETERRQ3 - Macro that is called when an error has been detected,
Synopsis:
#include <petscsys.h>
PetscErrorCode SETERRQ3(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)
Not Collective
Input Parameters:
+ comm - A communicator, so that the error can be collective
. errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
. message - error message in the printf format
. arg1 - argument (for example an integer, string or double)
. arg2 - argument (for example an integer, string or double)
- arg3 - argument (for example an integer, string or double)
Level: beginner
Notes:
Once the error handler is called the calling function is then returned from with the given error code.
There are also versions for 4, 5, 6 and 7 arguments.
Experienced users can set the error handler with PetscPushErrorHandler().
Concepts: error^setting condition
.seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
M*/
#define SETERRQ3(comm,n,s,a1,a2,a3) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_INITIAL,s,a1,a2,a3)
/*MC
SETERRQ4 - Macro that is called when an error has been detected,
Synopsis:
#include <petscsys.h>
PetscErrorCode SETERRQ4(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)
Not Collective
Input Parameters:
+ comm - A communicator, so that the error can be collective
. errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
. message - error message in the printf format
. arg1 - argument (for example an integer, string or double)
. arg2 - argument (for example an integer, string or double)
. arg3 - argument (for example an integer, string or double)
- arg4 - argument (for example an integer, string or double)
Level: beginner
Notes:
Once the error handler is called the calling function is then returned from with the given error code.
There are also versions for 4, 5, 6 and 7 arguments.
Experienced users can set the error handler with PetscPushErrorHandler().
Concepts: error^setting condition
.seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
M*/
#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)
/*MC
SETERRQ5 - Macro that is called when an error has been detected,
Synopsis:
#include <petscsys.h>
PetscErrorCode SETERRQ5(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)
Not Collective
Input Parameters:
+ comm - A communicator, so that the error can be collective
. errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
. message - error message in the printf format
. arg1 - argument (for example an integer, string or double)
. arg2 - argument (for example an integer, string or double)
. arg3 - argument (for example an integer, string or double)
. arg4 - argument (for example an integer, string or double)
- arg5 - argument (for example an integer, string or double)
Level: beginner
Notes:
Once the error handler is called the calling function is then returned from with the given error code.
There are also versions for 4, 5, 6 and 7 arguments.
Experienced users can set the error handler with PetscPushErrorHandler().
Concepts: error^setting condition
.seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
M*/
#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)
/*MC
SETERRQ6 - Macro that is called when an error has been detected,
Synopsis:
#include <petscsys.h>
PetscErrorCode SETERRQ6(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)
Not Collective
Input Parameters:
+ comm - A communicator, so that the error can be collective
. errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
. message - error message in the printf format
. arg1 - argument (for example an integer, string or double)
. arg2 - argument (for example an integer, string or double)
. arg3 - argument (for example an integer, string or double)
. arg4 - argument (for example an integer, string or double)
. arg5 - argument (for example an integer, string or double)
- arg6 - argument (for example an integer, string or double)
Level: beginner
Notes:
Once the error handler is called the calling function is then returned from with the given error code.
There are also versions for 4, 5, 6 and 7 arguments.
Experienced users can set the error handler with PetscPushErrorHandler().
Concepts: error^setting condition
.seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
M*/
#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)
/*MC
SETERRQ7 - Macro that is called when an error has been detected,
Synopsis:
#include <petscsys.h>
PetscErrorCode SETERRQ7(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)
Not Collective
Input Parameters:
+ comm - A communicator, so that the error can be collective
. errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
. message - error message in the printf format
. arg1 - argument (for example an integer, string or double)
. arg2 - argument (for example an integer, string or double)
. arg3 - argument (for example an integer, string or double)
. arg4 - argument (for example an integer, string or double)
. arg5 - argument (for example an integer, string or double)
. arg6 - argument (for example an integer, string or double)
- arg7 - argument (for example an integer, string or double)
Level: beginner
Notes:
Once the error handler is called the calling function is then returned from with the given error code.
There are also versions for 4, 5, 6 and 7 arguments.
Experienced users can set the error handler with PetscPushErrorHandler().
Concepts: error^setting condition
.seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
M*/
#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)
/*MC
SETERRQ8 - Macro that is called when an error has been detected,
Synopsis:
#include <petscsys.h>
PetscErrorCode SETERRQ8(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)
Not Collective
Input Parameters:
+ comm - A communicator, so that the error can be collective
. errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
. message - error message in the printf format
. arg1 - argument (for example an integer, string or double)
. arg2 - argument (for example an integer, string or double)
. arg3 - argument (for example an integer, string or double)
. arg4 - argument (for example an integer, string or double)
. arg5 - argument (for example an integer, string or double)
. arg6 - argument (for example an integer, string or double)
. arg7 - argument (for example an integer, string or double)
- arg8 - argument (for example an integer, string or double)
Level: beginner
Notes:
Once the error handler is called the calling function is then returned from with the given error code.
There are also versions for 4, 5, 6 and 7 arguments.
Experienced users can set the error handler with PetscPushErrorHandler().
Concepts: error^setting condition
.seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
M*/
#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)
/*MC
SETERRABORT - Macro that can be called when an error has been detected,
Synopsis:
#include <petscsys.h>
PetscErrorCode SETERRABORT(MPI_Comm comm,PetscErrorCode errorcode,char *message)
Not Collective
Input Parameters:
+ comm - A communicator, so that the error can be collective
. errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
- message - error message in the printf format
Level: beginner
Notes:
This function just calls MPI_Abort().
Concepts: error^setting condition
.seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
M*/
#define SETERRABORT(comm,n,s) do {PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_INITIAL,s);MPI_Abort(comm,n);} while (0)
/*MC
CHKERRQ - Checks error code, if non-zero it calls the error handler and then returns
Synopsis:
#include <petscsys.h>
PetscErrorCode CHKERRQ(PetscErrorCode errorcode)
Not Collective
Input Parameters:
. errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
Level: beginner
Notes:
Once the error handler is called the calling function is then returned from with the given error code.
Experienced users can set the error handler with PetscPushErrorHandler().
CHKERRQ(n) is fundamentally a macro replacement for
if (n) return(PetscError(...,n,...));
Although typical usage resembles "void CHKERRQ(PetscErrorCode)" as described above, for certain uses it is
highly inappropriate to use it in this manner as it invokes return(PetscErrorCode). In particular,
it cannot be used in functions which return(void) or any other datatype. In these types of functions,
you can use CHKERRV() which returns without an error code (bad idea since the error is ignored or
if (n) {PetscError(....); return(YourReturnType);}
where you may pass back a NULL to indicate an error. You can also call CHKERRABORT(comm,n) to have
MPI_Abort() returned immediately.
In Fortran MPI_Abort() is always called
Concepts: error^setting condition
.seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2()
M*/
#define CHKERRQ(n) do {if (PetscUnlikely(n)) return PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_REPEAT," ");} while (0)
#define CHKERRV(n) do {if (PetscUnlikely(n)) {n = PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_REPEAT," ");return;}} while(0)
#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)
#define CHKERRCONTINUE(n) do {if (PetscUnlikely(n)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_REPEAT," ");}} while (0)
#ifdef PETSC_CLANGUAGE_CXX
/*MC
CHKERRXX - Checks error code, if non-zero it calls the C++ error handler which throws an exception
Synopsis:
#include <petscsys.h>
void CHKERRXX(PetscErrorCode errorcode)
Not Collective
Input Parameters:
. errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
Level: beginner
Notes:
Once the error handler throws a ??? exception.
You can use CHKERRV() which returns without an error code (bad idea since the error is ignored)
or CHKERRABORT(comm,n) to have MPI_Abort() returned immediately.
Concepts: error^setting condition
.seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKERRQ(), CHKMEMQ
M*/
#define CHKERRXX(n) do {if (PetscUnlikely(n)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,n,PETSC_ERROR_IN_CXX,0);}} while(0)
#endif
#define CHKERRCUDA(err) do {if (PetscUnlikely(((int)err) != (int)CUDA_SUCCESS)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CUDA error %d",err);} while(0)
#define CHKERRCUBLAS(err) do {if (PetscUnlikely(((int)err) != (int)CUBLAS_STATUS_SUCCESS)) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_LIB, "CUBLAS error %d",err);} while(0)
/*MC
CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected
Synopsis:
#include <petscsys.h>
CHKMEMQ;
Not Collective
Level: beginner
Notes:
We highly recommend using valgrind http://www.mcs.anl.gov/petsc/documentation/faq.html#valgrind for finding memory problems. This is useful
on systems that do not have valgrind, but much much less useful.
Must run with the option -malloc_debug to enable this option
Once the error handler is called the calling function is then returned from with the given error code.
By defaults prints location where memory that is corrupted was allocated.
Use CHKMEMA for functions that return void
Concepts: memory corruption
.seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(),
PetscMallocValidate()
M*/
#define CHKMEMQ do {PetscErrorCode _7_ierr = PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__);CHKERRQ(_7_ierr);} while(0)
#define CHKMEMA PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__)
#else /* PETSC_USE_ERRORCHECKING */
/*
These are defined to be empty for when error checking is turned off, with ./configure --with-errorchecking=0
*/
#define SETERRQ(c,n,s)
#define SETERRQ1(c,n,s,a1)
#define SETERRQ2(c,n,s,a1,a2)
#define SETERRQ3(c,n,s,a1,a2,a3)
#define SETERRQ4(c,n,s,a1,a2,a3,a4)
#define SETERRQ5(c,n,s,a1,a2,a3,a4,a5)
#define SETERRQ6(c,n,s,a1,a2,a3,a4,a5,a6)
#define SETERRQ7(c,n,s,a1,a2,a3,a4,a5,a6,a7)
#define SETERRQ8(c,n,s,a1,a2,a3,a4,a5,a6,a7,a8)
#define SETERRABORT(comm,n,s)
#define CHKERRQ(n) ;
#define CHKERRV(n) ;
#define CHKERRABORT(comm,n) ;
#define CHKERRCONTINUE(n) ;
#define CHKMEMQ ;
#define CHKERRCUDA(err) ;
#define CHKERRCUBLAS(err) ;
#ifdef PETSC_CLANGUAGE_CXX
#define CHKERRXX(n) ;
#endif
#endif /* PETSC_USE_ERRORCHECKING */
/*E
PetscErrorType - passed to the PETSc error handling routines indicating if this is the first or a later call to the error handlers
Level: advanced
PETSC_ERROR_IN_CXX indicates the error was detected in C++ and an exception should be generated
Developer Notes: This is currently used to decide when to print the detailed information about the run in PetscTraceBackErrorHandler()
.seealso: PetscError(), SETERRXX()
E*/
typedef enum {PETSC_ERROR_INITIAL=0,PETSC_ERROR_REPEAT=1,PETSC_ERROR_IN_CXX = 2} PetscErrorType;
#if defined(__clang_analyzer__)
__attribute__((analyzer_noreturn))
#endif
PETSC_EXTERN PetscErrorCode PetscError(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,...);
PETSC_EXTERN PetscErrorCode PetscErrorPrintfInitialize(void);
PETSC_EXTERN PetscErrorCode PetscErrorMessage(int,const char*[],char **);
PETSC_EXTERN PetscErrorCode PetscTraceBackErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
PETSC_EXTERN PetscErrorCode PetscIgnoreErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
PETSC_EXTERN PetscErrorCode PetscEmacsClientErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
PETSC_EXTERN PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
PETSC_EXTERN PetscErrorCode PetscAbortErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
PETSC_EXTERN PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
PETSC_EXTERN PetscErrorCode PetscReturnErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
PETSC_EXTERN PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*),void*);
PETSC_EXTERN PetscErrorCode PetscPopErrorHandler(void);
PETSC_EXTERN PetscErrorCode PetscSignalHandlerDefault(int,void*);
PETSC_EXTERN PetscErrorCode PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*);
PETSC_EXTERN PetscErrorCode PetscPopSignalHandler(void);
PETSC_EXTERN PetscErrorCode PetscCheckPointerSetIntensity(PetscInt);
/*MC
PetscErrorPrintf - Prints error messages.
Synopsis:
#include <petscsys.h>
PetscErrorCode (*PetscErrorPrintf)(const char format[],...);
Not Collective
Input Parameters:
. format - the usual printf() format string
Options Database Keys:
+ -error_output_stdout - cause error messages to be printed to stdout instead of the (default) stderr
- -error_output_none - to turn off all printing of error messages (does not change the way the error is handled.)
Notes: Use
$ PetscErrorPrintf = PetscErrorPrintfNone; to turn off all printing of error messages (does not change the way the
$ error is handled.) and
$ PetscErrorPrintf = PetscErrorPrintfDefault; to turn it back on or you can use your own function
Use
PETSC_STDERR = FILE* obtained from a file open etc. to have stderr printed to the file.
PETSC_STDOUT = FILE* obtained from a file open etc. to have stdout printed to the file.
Use
PetscPushErrorHandler() to provide your own error handler that determines what kind of messages to print
Level: developer
Fortran Note:
This routine is not supported in Fortran.
Concepts: error messages^printing
Concepts: printing^error messages
.seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscHelpPrintf(), PetscPrintf(), PetscErrorHandlerPush(), PetscVFPrintf(), PetscHelpPrintf()
M*/
PETSC_EXTERN PetscErrorCode (*PetscErrorPrintf)(const char[],...);
typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap;
PETSC_EXTERN PetscErrorCode PetscSetFPTrap(PetscFPTrap);
PETSC_EXTERN PetscErrorCode PetscFPTrapPush(PetscFPTrap);
PETSC_EXTERN PetscErrorCode PetscFPTrapPop(void);
/*
Allows the code to build a stack frame as it runs
*/
#define PETSCSTACKSIZE 64
typedef struct {
const char *function[PETSCSTACKSIZE];
const char *file[PETSCSTACKSIZE];
int line[PETSCSTACKSIZE];
PetscBool petscroutine[PETSCSTACKSIZE];
int currentsize;
int hotdepth;
} PetscStack;
PETSC_EXTERN PetscStack *petscstack;
PetscErrorCode PetscStackCopy(PetscStack*,PetscStack*);
PetscErrorCode PetscStackPrint(PetscStack *,FILE*);
#if defined(PETSC_USE_DEBUG)
PETSC_STATIC_INLINE PetscBool PetscStackActive(void)
{
return(petscstack ? PETSC_TRUE : PETSC_FALSE);
}
/* Stack handling is based on the following two "NoCheck" macros. These should only be called directly by other error
* handling macros. We record the line of the call, which may or may not be the location of the definition. But is at
* least more useful than "unknown" because it can distinguish multiple calls from the same function.
*/
#define PetscStackPushNoCheck(funct,petsc_routine,hot) \
do { \
PetscStackSAWsTakeAccess(); \
if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \
petscstack->function[petscstack->currentsize] = funct; \
petscstack->file[petscstack->currentsize] = __FILE__; \
petscstack->line[petscstack->currentsize] = __LINE__; \
petscstack->petscroutine[petscstack->currentsize] = petsc_routine; \
petscstack->currentsize++; \
} \
if (petscstack) { \
petscstack->hotdepth += (hot || petscstack->hotdepth); \
} \
PetscStackSAWsGrantAccess(); \
} while (0)
#define PetscStackPopNoCheck \
do { \
PetscStackSAWsTakeAccess(); \
if (petscstack && petscstack->currentsize > 0) { \
petscstack->currentsize--; \
petscstack->function[petscstack->currentsize] = 0; \
petscstack->file[petscstack->currentsize] = 0; \
petscstack->line[petscstack->currentsize] = 0; \
petscstack->petscroutine[petscstack->currentsize] = PETSC_FALSE;\
} \
if (petscstack) { \
petscstack->hotdepth = PetscMax(petscstack->hotdepth-1,0); \
} \
PetscStackSAWsGrantAccess(); \
} while (0)
/*MC
PetscFunctionBegin - First executable line of each PETSc function, used for error handling. Final
line of PETSc functions should be PetscFunctionReturn(0);
Synopsis:
#include <petscsys.h>
void PetscFunctionBegin;
Not Collective
Usage:
.vb
int something;
PetscFunctionBegin;
.ve
Notes:
Use PetscFunctionBeginUser for application codes.
Not available in Fortran
Level: developer
.seealso: PetscFunctionReturn(), PetscFunctionBeginHot(), PetscFunctionBeginUser()
.keywords: traceback, error handling
M*/
#define PetscFunctionBegin do { \
PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_TRUE,PETSC_FALSE); \
PetscCheck__FUNCT__(); \
PetscRegister__FUNCT__(); \
} while (0)
/*MC
PetscFunctionBeginHot - Substitute for PetscFunctionBegin to be used in functions that are called in
performance-critical circumstances. Use of this function allows for lighter profiling by default.
Synopsis:
#include <petscsys.h>
void PetscFunctionBeginHot;
Not Collective
Usage:
.vb
int something;
PetscFunctionBeginHot;
.ve
Notes:
Not available in Fortran
Level: developer
.seealso: PetscFunctionBegin, PetscFunctionReturn()
.keywords: traceback, error handling
M*/
#define PetscFunctionBeginHot do { \
PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_TRUE,PETSC_TRUE); \
PetscCheck__FUNCT__(); \
PetscRegister__FUNCT__(); \
} while (0)
/*MC
PetscFunctionBeginUser - First executable line of user provided PETSc routine
Synopsis:
#include <petscsys.h>
void PetscFunctionBeginUser;
Not Collective
Usage:
.vb
int something;
PetscFunctionBegin;
.ve
Notes:
Final line of PETSc functions should be PetscFunctionReturn(0) except for main().
Not available in Fortran
Level: intermediate
.seealso: PetscFunctionReturn(), PetscFunctionBegin, PetscFunctionBeginHot
.keywords: traceback, error handling
M*/
#define PetscFunctionBeginUser \
do { \
PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_FALSE,PETSC_FALSE); \
PetscCheck__FUNCT__(); \
PetscRegister__FUNCT__(); \
} while (0)
#if defined(PETSC_SERIALIZE_FUNCTIONS)
#include <petsc/private/petscfptimpl.h>
/*
Registers the current function into the global function pointer to function name table
Have to fix this to handle errors but cannot return error since used in PETSC_VIEWER_DRAW_() etc
*/
#define PetscRegister__FUNCT__() do { \
static PetscBool __chked = PETSC_FALSE; \
if (!__chked) {\
void *ptr; PetscDLSym(NULL,__FUNCT__,&ptr);\
__chked = PETSC_TRUE;\
}} while (0)
#else
#define PetscRegister__FUNCT__()
#endif
#define PetscCheck__FUNCT__() do { PetscBool _sc1,_sc2; \
PetscStrcmpNoError(PETSC_FUNCTION_NAME,__FUNCT__,&_sc1);\
PetscStrcmpNoError(__FUNCT__,"User provided function",&_sc2);\
if (!_sc1 && !_sc2) { \
printf("%s:%d: __FUNCT__=\"%s\" does not agree with %s=\"%s\"\n",__FILE__,__LINE__,__FUNCT__,PetscStringize(PETSC_FUNCTION_NAME),PETSC_FUNCTION_NAME); \
} \
} while (0)
#define PetscStackPush(n) \
do { \
PetscStackPushNoCheck(n,PETSC_FALSE,PETSC_FALSE); \
CHKMEMQ; \
} while (0)
#define PetscStackPop \
do { \
CHKMEMQ; \
PetscStackPopNoCheck; \
} while (0)
/*MC
PetscFunctionReturn - Last executable line of each PETSc function
used for error handling. Replaces return()
Synopsis:
#include <petscsys.h>
void PetscFunctionReturn(0);
Not Collective
Usage:
.vb
....
PetscFunctionReturn(0);
}
.ve
Notes:
Not available in Fortran
Level: developer
.seealso: PetscFunctionBegin()
.keywords: traceback, error handling
M*/
#define PetscFunctionReturn(a) \
do { \
PetscStackPopNoCheck; \
return(a);} while (0)
#define PetscFunctionReturnVoid() \
do { \
PetscStackPopNoCheck; \
return;} while (0)
#else
PETSC_STATIC_INLINE PetscBool PetscStackActive(void) {return PETSC_FALSE;}
#define PetscStackPushNoCheck(funct,petsc_routine,hot) do {} while (0)
#define PetscStackPopNoCheck do {} while (0)
#define PetscFunctionBegin
#define PetscFunctionBeginUser
#define PetscFunctionBeginHot
#define PetscFunctionReturn(a) return(a)
#define PetscFunctionReturnVoid() return
#define PetscStackPop CHKMEMQ
#define PetscStackPush(f) CHKMEMQ
#endif
/*
PetscStackCall - Calls an external library routine or user function after pushing the name of the routine on the stack.
Input Parameters:
+ name - string that gives the name of the function being called
- routine - actual call to the routine, including ierr = and CHKERRQ(ierr);
Note: Often one should use PetscStackCallStandard() instead. This routine is intended for external library routines that DO NOT return error codes
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.
*/
#define PetscStackCall(name,routine) do { PetscStackPush(name);routine;PetscStackPop; } while(0)
/*
PetscStackCallStandard - Calls an external library routine after pushing the name of the routine on the stack.
Input Parameters:
+ func- name of the routine
- args - arguments to the routine surrounded by ()
Notes: This is intended for external package routines that return error codes. Use PetscStackCall() for those that do not.
Developer Note: this is so that when an external packge routine results in a crash or corrupts memory, they get blamed instead of PETSc.
*/
#define PetscStackCallStandard(func,args) do { \
PetscStackPush(#func);ierr = func args;PetscStackPop; if (ierr) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error in %s()",#func); \
} while (0)
PETSC_EXTERN PetscErrorCode PetscStackCreate(void);
PETSC_EXTERN PetscErrorCode PetscStackView(FILE*);
PETSC_EXTERN PetscErrorCode PetscStackDestroy(void);
#endif
|