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