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*5789d1f5SJed Brown Options Database Keys: 17*5789d1f5SJed Brown . -check_pointer_intensity - intensity (0, 1, or 2) 18*5789d1f5SJed Brown 1928559dc8SJed Brown Level: advanced 2028559dc8SJed Brown 21*5789d1f5SJed Brown .seealso: PetscCheckPointer(), PetscFunctionBeginHot() 2228559dc8SJed Brown @*/ 2328559dc8SJed Brown PetscErrorCode PetscCheckPointerSetIntensity(PetscInt intensity) 2428559dc8SJed Brown { 2528559dc8SJed Brown 2628559dc8SJed Brown PetscFunctionBegin; 2728559dc8SJed Brown switch (intensity) { 2828559dc8SJed Brown case 0: 2928559dc8SJed Brown case 1: 3028559dc8SJed Brown case 2: 3128559dc8SJed Brown petsc_checkpointer_intensity = intensity; 3228559dc8SJed Brown break; 3328559dc8SJed Brown default: SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Intensity %D not in 0,1,2",intensity); 3428559dc8SJed Brown } 3528559dc8SJed Brown PetscFunctionReturn(0); 3628559dc8SJed Brown } 3728559dc8SJed Brown 38d96cc911SJed Brown /* ---------------------------------------------------------------------------------------*/ 39d96cc911SJed Brown #if defined(PETSC_HAVE_SETJMP_H) && defined(PETSC_HAVE_SIGINFO_T) 40d96cc911SJed Brown #include <signal.h> 41d96cc911SJed Brown #include <setjmp.h> 42d076d156SJed Brown PETSC_INTERN jmp_buf PetscSegvJumpBuf; 43d076d156SJed Brown PETSC_INTERN void PetscSegv_sigaction(int, siginfo_t*, void *); 44d076d156SJed Brown 45d96cc911SJed Brown /*@C 46d96cc911SJed Brown PetscCheckPointer - Returns PETSC_TRUE if a pointer points to accessible data 47d96cc911SJed Brown 48d96cc911SJed Brown Not Collective 49d96cc911SJed Brown 50d96cc911SJed Brown Input Parameters: 51d96cc911SJed Brown + ptr - the pointer 52d96cc911SJed Brown - dtype - the type of data the pointer is suppose to point to 53d96cc911SJed Brown 54d96cc911SJed Brown Level: developer 55d96cc911SJed Brown 56*5789d1f5SJed Brown .seealso: PetscCheckPointerSetIntensity() 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. */ 86d96cc911SJed Brown PetscReal xreal = ((volatile PetscReal*)ptr)[0],ximag = ((volatile PetscReal*)ptr)[1]; 87d96cc911SJed Brown PETSC_UNUSED volatile PetscScalar x = xreal + PETSC_i*ximag; 88d96cc911SJed Brown break; 89d96cc911SJed Brown } 90d96cc911SJed Brown #endif 91d96cc911SJed Brown case PETSC_REAL:{ 92d96cc911SJed Brown PETSC_UNUSED PetscReal x = *(volatile PetscReal*)ptr; 93d96cc911SJed Brown break; 94d96cc911SJed Brown } 95d96cc911SJed Brown case PETSC_BOOL:{ 96d96cc911SJed Brown PETSC_UNUSED PetscBool x = *(volatile PetscBool*)ptr; 97d96cc911SJed Brown break; 98d96cc911SJed Brown } 99d96cc911SJed Brown case PETSC_ENUM:{ 100d96cc911SJed Brown PETSC_UNUSED PetscEnum x = *(volatile PetscEnum*)ptr; 101d96cc911SJed Brown break; 102d96cc911SJed Brown } 103d96cc911SJed Brown case PETSC_CHAR:{ 104f4e06bcbSJed Brown PETSC_UNUSED char x = *(volatile char*)ptr; 105d96cc911SJed Brown break; 106d96cc911SJed Brown } 107d96cc911SJed Brown case PETSC_OBJECT:{ 108d96cc911SJed Brown PETSC_UNUSED volatile PetscClassId classid = ((PetscObject)ptr)->classid; 109d96cc911SJed Brown break; 110d96cc911SJed Brown } 111d96cc911SJed Brown default:; 112d96cc911SJed Brown } 113d96cc911SJed Brown } 114d96cc911SJed Brown sigaction(SIGSEGV, &oldsa, NULL); /* reset old signal hanlder */ 115d96cc911SJed Brown return PETSC_TRUE; 116d96cc911SJed Brown } 117d96cc911SJed Brown #else 118d96cc911SJed Brown PetscBool PetscCheckPointer(const void *ptr,PETSC_UNUSED PetscDataType dtype) 119d96cc911SJed Brown { 120d96cc911SJed Brown if (!ptr) return PETSC_FALSE; 121d96cc911SJed Brown return PETSC_TRUE; 122d96cc911SJed Brown } 123d96cc911SJed Brown #endif 124