xref: /petsc/src/sys/error/checkptr.c (revision af0996ce37bc06907c37d8d91773840993d61e62)
1 #include <petsc/private/petscimpl.h>
2 #include <petscvalgrind.h>
3 
4 static PetscInt petsc_checkpointer_intensity = 1;
5 
6 #undef __FUNCT__
7 #define __FUNCT__ "PetscCheckPointerSetIntensity"
8 /*@
9    PetscCheckPointerSetIntensity - An intense pointer check registers a signal handler and attempts to dereference to
10    confirm whether the address is valid.  An intensity of 0 never uses signal handlers, 1 uses them when not in a "hot"
11    function, and intensity of 2 always uses a signal handler.
12 
13    Not Collective
14 
15    Input Arguments:
16 .  intensity - how much to check pointers for validity
17 
18    Level: advanced
19 
20 .seealso: PetscCheckPointer(), PetscFunctionBeginHot
21 @*/
22 PetscErrorCode PetscCheckPointerSetIntensity(PetscInt intensity)
23 {
24 
25   PetscFunctionBegin;
26   switch (intensity) {
27   case 0:
28   case 1:
29   case 2:
30     petsc_checkpointer_intensity = intensity;
31     break;
32   default: SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Intensity %D not in 0,1,2",intensity);
33   }
34   PetscFunctionReturn(0);
35 }
36 
37 /* ---------------------------------------------------------------------------------------*/
38 #if defined(PETSC_HAVE_SETJMP_H) && defined(PETSC_HAVE_SIGINFO_T)
39 #include <signal.h>
40 #include <setjmp.h>
41 PETSC_INTERN jmp_buf PetscSegvJumpBuf;
42 PETSC_INTERN void PetscSegv_sigaction(int, siginfo_t*, void *);
43 
44 /*@C
45      PetscCheckPointer - Returns PETSC_TRUE if a pointer points to accessible data
46 
47    Not Collective
48 
49    Input Parameters:
50 +     ptr - the pointer
51 -     dtype - the type of data the pointer is suppose to point to
52 
53    Level: developer
54 
55 @*/
56 PetscBool PetscCheckPointer(const void *ptr,PetscDataType dtype)
57 {
58   struct sigaction sa,oldsa;
59   PetscStack *stackp;
60 
61   if (PETSC_RUNNING_ON_VALGRIND) return PETSC_TRUE;
62   if (!ptr) return PETSC_FALSE;
63   if (petsc_checkpointer_intensity < 1) return PETSC_TRUE;
64 
65   /* Skip the verbose check if we are inside a hot function. */
66   stackp = (PetscStack*)PetscThreadLocalGetValue(petscstack);
67   if (stackp && stackp->hotdepth > 0 && petsc_checkpointer_intensity < 2) return PETSC_TRUE;
68 
69   sigemptyset(&sa.sa_mask);
70   sa.sa_sigaction = PetscSegv_sigaction;
71   sa.sa_flags   = SA_SIGINFO;
72   sigaction(SIGSEGV, &sa, &oldsa);
73 
74   if (setjmp(PetscSegvJumpBuf)) {
75     /* A segv was triggered in the code below hence we return with an error code */
76     sigaction(SIGSEGV, &oldsa, NULL);/* reset old signal hanlder */
77     return PETSC_FALSE;
78   } else {
79     switch (dtype) {
80     case PETSC_INT:{
81       PETSC_UNUSED PetscInt x = (PetscInt)*(volatile PetscInt*)ptr;
82       break;
83     }
84 #if defined(PETSC_USE_COMPLEX)
85     case PETSC_SCALAR:{         /* C++ is seriously dysfunctional with volatile std::complex. */
86       PetscReal xreal = ((volatile PetscReal*)ptr)[0],ximag = ((volatile PetscReal*)ptr)[1];
87       PETSC_UNUSED volatile PetscScalar x = xreal + PETSC_i*ximag;
88       break;
89     }
90 #endif
91     case PETSC_REAL:{
92       PETSC_UNUSED PetscReal x = *(volatile PetscReal*)ptr;
93       break;
94     }
95     case PETSC_BOOL:{
96       PETSC_UNUSED PetscBool x = *(volatile PetscBool*)ptr;
97       break;
98     }
99     case PETSC_ENUM:{
100       PETSC_UNUSED PetscEnum x = *(volatile PetscEnum*)ptr;
101       break;
102     }
103     case PETSC_CHAR:{
104       PETSC_UNUSED char x = *(volatile char*)ptr;
105       break;
106     }
107     case PETSC_OBJECT:{
108       PETSC_UNUSED volatile PetscClassId classid = ((PetscObject)ptr)->classid;
109       break;
110     }
111     default:;
112     }
113   }
114   sigaction(SIGSEGV, &oldsa, NULL); /* reset old signal hanlder */
115   return PETSC_TRUE;
116 }
117 #else
118 PetscBool PetscCheckPointer(const void *ptr,PETSC_UNUSED PetscDataType dtype)
119 {
120   if (!ptr) return PETSC_FALSE;
121   return PETSC_TRUE;
122 }
123 #endif
124