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