xref: /petsc/src/sys/error/checkptr.c (revision f4e06bcbf1709361a01ab69117bafba7a5705209)
1d96cc911SJed Brown #include <petsc-private/petscimpl.h>
2d96cc911SJed Brown 
328559dc8SJed Brown static PetscInt petsc_checkpointer_intensity = 1;
428559dc8SJed Brown 
528559dc8SJed Brown #undef __FUNCT__
628559dc8SJed Brown #define __FUNCT__ "PetscCheckPointerSetIntensity"
728559dc8SJed Brown /*@
828559dc8SJed Brown    PetscCheckPointerSetIntensity - An intense pointer check registers a signal handler and attempts to dereference to
928559dc8SJed Brown    confirm whether the address is valid.  An intensity of 0 never uses signal handlers, 1 uses them when not in a "hot"
1028559dc8SJed Brown    function, and intensity of 2 always uses a signal handler.
1128559dc8SJed Brown 
1228559dc8SJed Brown    Not Collective
1328559dc8SJed Brown 
1428559dc8SJed Brown    Input Arguments:
1528559dc8SJed Brown .  intensity - how much to check pointers for validity
1628559dc8SJed Brown 
1728559dc8SJed Brown    Level: advanced
1828559dc8SJed Brown 
1928559dc8SJed Brown .seealso: PetscCheckPointer(), PetscFunctionBeginHot
2028559dc8SJed Brown @*/
2128559dc8SJed Brown PetscErrorCode PetscCheckPointerSetIntensity(PetscInt intensity)
2228559dc8SJed Brown {
2328559dc8SJed Brown 
2428559dc8SJed Brown   PetscFunctionBegin;
2528559dc8SJed Brown   switch (intensity) {
2628559dc8SJed Brown   case 0:
2728559dc8SJed Brown   case 1:
2828559dc8SJed Brown   case 2:
2928559dc8SJed Brown     petsc_checkpointer_intensity = intensity;
3028559dc8SJed Brown     break;
3128559dc8SJed Brown   default: SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Intensity %D not in 0,1,2",intensity);
3228559dc8SJed Brown   }
3328559dc8SJed Brown   PetscFunctionReturn(0);
3428559dc8SJed Brown }
3528559dc8SJed Brown 
36d96cc911SJed Brown /* ---------------------------------------------------------------------------------------*/
37d96cc911SJed Brown #if defined(PETSC_HAVE_SETJMP_H) && defined(PETSC_HAVE_SIGINFO_T)
38d96cc911SJed Brown #include <signal.h>
39d96cc911SJed Brown #include <setjmp.h>
40d076d156SJed Brown PETSC_INTERN jmp_buf PetscSegvJumpBuf;
41d076d156SJed Brown PETSC_INTERN void PetscSegv_sigaction(int, siginfo_t*, void *);
42d076d156SJed Brown 
43d96cc911SJed Brown /*@C
44d96cc911SJed Brown      PetscCheckPointer - Returns PETSC_TRUE if a pointer points to accessible data
45d96cc911SJed Brown 
46d96cc911SJed Brown    Not Collective
47d96cc911SJed Brown 
48d96cc911SJed Brown    Input Parameters:
49d96cc911SJed Brown +     ptr - the pointer
50d96cc911SJed Brown -     dtype - the type of data the pointer is suppose to point to
51d96cc911SJed Brown 
52d96cc911SJed Brown    Level: developer
53d96cc911SJed Brown 
54d96cc911SJed Brown @*/
55d96cc911SJed Brown PetscBool PetscCheckPointer(const void *ptr,PetscDataType dtype)
56d96cc911SJed Brown {
57d96cc911SJed Brown   struct sigaction sa,oldsa;
58a2f94806SJed Brown   PetscStack *stackp;
59d96cc911SJed Brown 
60d96cc911SJed Brown   if (PETSC_RUNNING_ON_VALGRIND) return PETSC_TRUE;
61d96cc911SJed Brown   if (!ptr) return PETSC_FALSE;
6228559dc8SJed Brown   if (petsc_checkpointer_intensity < 1) return PETSC_TRUE;
63d96cc911SJed Brown 
64a2f94806SJed Brown   /* Skip the verbose check if we are inside a hot function. */
65a2f94806SJed Brown   stackp = (PetscStack*)PetscThreadLocalGetValue(petscstack);
6628559dc8SJed Brown   if (stackp && stackp->hotdepth > 0 && petsc_checkpointer_intensity < 2) return PETSC_TRUE;
67a2f94806SJed Brown 
68d96cc911SJed Brown   sigemptyset(&sa.sa_mask);
69d96cc911SJed Brown   sa.sa_sigaction = PetscSegv_sigaction;
70d96cc911SJed Brown   sa.sa_flags   = SA_SIGINFO;
71d96cc911SJed Brown   sigaction(SIGSEGV, &sa, &oldsa);
72d96cc911SJed Brown 
73d96cc911SJed Brown   if (setjmp(PetscSegvJumpBuf)) {
74d96cc911SJed Brown     /* A segv was triggered in the code below hence we return with an error code */
75d96cc911SJed Brown     sigaction(SIGSEGV, &oldsa, NULL);/* reset old signal hanlder */
76d96cc911SJed Brown     return PETSC_FALSE;
77d96cc911SJed Brown   } else {
78d96cc911SJed Brown     switch (dtype) {
79d96cc911SJed Brown     case PETSC_INT:{
80d96cc911SJed Brown       PETSC_UNUSED PetscInt x = (PetscInt)*(volatile PetscInt*)ptr;
81d96cc911SJed Brown       break;
82d96cc911SJed Brown     }
83d96cc911SJed Brown #if defined(PETSC_USE_COMPLEX)
84d96cc911SJed Brown     case PETSC_SCALAR:{         /* C++ is seriously dysfunctional with volatile std::complex. */
85d96cc911SJed Brown       PetscReal xreal = ((volatile PetscReal*)ptr)[0],ximag = ((volatile PetscReal*)ptr)[1];
86d96cc911SJed Brown       PETSC_UNUSED volatile PetscScalar x = xreal + PETSC_i*ximag;
87d96cc911SJed Brown       break;
88d96cc911SJed Brown     }
89d96cc911SJed Brown #endif
90d96cc911SJed Brown     case PETSC_REAL:{
91d96cc911SJed Brown       PETSC_UNUSED PetscReal x = *(volatile PetscReal*)ptr;
92d96cc911SJed Brown       break;
93d96cc911SJed Brown     }
94d96cc911SJed Brown     case PETSC_BOOL:{
95d96cc911SJed Brown       PETSC_UNUSED PetscBool x = *(volatile PetscBool*)ptr;
96d96cc911SJed Brown       break;
97d96cc911SJed Brown     }
98d96cc911SJed Brown     case PETSC_ENUM:{
99d96cc911SJed Brown       PETSC_UNUSED PetscEnum x = *(volatile PetscEnum*)ptr;
100d96cc911SJed Brown       break;
101d96cc911SJed Brown     }
102d96cc911SJed Brown     case PETSC_CHAR:{
103*f4e06bcbSJed Brown       PETSC_UNUSED char x = *(volatile char*)ptr;
104d96cc911SJed Brown       break;
105d96cc911SJed Brown     }
106d96cc911SJed Brown     case PETSC_OBJECT:{
107d96cc911SJed Brown       PETSC_UNUSED volatile PetscClassId classid = ((PetscObject)ptr)->classid;
108d96cc911SJed Brown       break;
109d96cc911SJed Brown     }
110d96cc911SJed Brown     default:;
111d96cc911SJed Brown     }
112d96cc911SJed Brown   }
113d96cc911SJed Brown   sigaction(SIGSEGV, &oldsa, NULL); /* reset old signal hanlder */
114d96cc911SJed Brown   return PETSC_TRUE;
115d96cc911SJed Brown }
116d96cc911SJed Brown #else
117d96cc911SJed Brown PetscBool PetscCheckPointer(const void *ptr,PETSC_UNUSED PetscDataType dtype)
118d96cc911SJed Brown {
119d96cc911SJed Brown   if (!ptr) return PETSC_FALSE;
120d96cc911SJed Brown   return PETSC_TRUE;
121d96cc911SJed Brown }
122d96cc911SJed Brown #endif
123