1af0996ceSBarry Smith #include <petsc/private/petscimpl.h> 205035670SJunchao Zhang 328559dc8SJed Brown static PetscInt petsc_checkpointer_intensity = 1; 428559dc8SJed Brown 528559dc8SJed Brown /*@ 628559dc8SJed Brown PetscCheckPointerSetIntensity - An intense pointer check registers a signal handler and attempts to dereference to 728559dc8SJed Brown confirm whether the address is valid. An intensity of 0 never uses signal handlers, 1 uses them when not in a "hot" 828559dc8SJed Brown function, and intensity of 2 always uses a signal handler. 928559dc8SJed Brown 1028559dc8SJed Brown Not Collective 1128559dc8SJed Brown 124165533cSJose E. Roman Input Parameter: 1328559dc8SJed Brown . intensity - how much to check pointers for validity 1428559dc8SJed Brown 15811af0c4SBarry Smith Options Database Key: 165789d1f5SJed Brown . -check_pointer_intensity - intensity (0, 1, or 2) 17c2f74817SBarry Smith 1828559dc8SJed Brown Level: advanced 1928559dc8SJed Brown 20db781477SPatrick Sanan .seealso: `PetscCheckPointer()`, `PetscFunctionBeginHot()` 2128559dc8SJed Brown @*/ 229371c9d4SSatish Balay PetscErrorCode PetscCheckPointerSetIntensity(PetscInt intensity) { 2328559dc8SJed Brown PetscFunctionBegin; 24*0e6b6b59SJacob Faibussowitsch PetscCheck((intensity >= 0) && (intensity <= 2), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Intensity %" PetscInt_FMT " not in [0,2]", intensity); 25*0e6b6b59SJacob Faibussowitsch petsc_checkpointer_intensity = intensity; 2628559dc8SJed Brown PetscFunctionReturn(0); 2728559dc8SJed Brown } 2828559dc8SJed Brown 29d96cc911SJed Brown /* ---------------------------------------------------------------------------------------*/ 30718fc407SJed Brown 31*0e6b6b59SJacob Faibussowitsch #if PetscDefined(HAVE_SETJMP_H) 32d96cc911SJed Brown #include <setjmp.h> 33f8a67e6dSJed Brown static jmp_buf PetscSegvJumpBuf; 34f8a67e6dSJed Brown static PetscBool PetscSegvJumpBuf_set; 35f8a67e6dSJed Brown 36f8a67e6dSJed Brown /*@C 37*0e6b6b59SJacob Faibussowitsch PetscSignalSegvCheckPointerOrMpi - To be called from a signal handler for SIGSEGV. 38f8a67e6dSJed Brown 39f8a67e6dSJed Brown Not Collective 40f8a67e6dSJed Brown 41*0e6b6b59SJacob Faibussowitsch Notes: 42*0e6b6b59SJacob Faibussowitsch If the signal was received while executing PetscCheckPointer(), this function longjmps back 43*0e6b6b59SJacob Faibussowitsch there, otherwise returns with no effect. This function is called automatically by 44*0e6b6b59SJacob Faibussowitsch PetscSignalHandlerDefault(). 45*0e6b6b59SJacob Faibussowitsch 46f8a67e6dSJed Brown Level: developer 47f8a67e6dSJed Brown 48db781477SPatrick Sanan .seealso: `PetscPushSignalHandler()` 49f8a67e6dSJed Brown @*/ 509371c9d4SSatish Balay void PetscSignalSegvCheckPointerOrMpi(void) { 51f8a67e6dSJed Brown if (PetscSegvJumpBuf_set) longjmp(PetscSegvJumpBuf, 1); 52f8a67e6dSJed Brown } 53d076d156SJed Brown 54d96cc911SJed Brown /*@C 55811af0c4SBarry Smith PetscCheckPointer - Returns `PETSC_TRUE` if a pointer points to accessible data 56d96cc911SJed Brown 57d96cc911SJed Brown Not Collective 58d96cc911SJed Brown 59d96cc911SJed Brown Input Parameters: 60d96cc911SJed Brown + ptr - the pointer 61d96cc911SJed Brown - dtype - the type of data the pointer is suppose to point to 62d96cc911SJed Brown 63d96cc911SJed Brown Level: developer 64d96cc911SJed Brown 65811af0c4SBarry Smith Note: 66811af0c4SBarry Smith This is a non-standard PETSc function in that it returns the result as the return code and does not return an error code 67811af0c4SBarry Smith 68db781477SPatrick Sanan .seealso: `PetscCheckPointerSetIntensity()` 69d96cc911SJed Brown @*/ 709371c9d4SSatish Balay PetscBool PetscCheckPointer(const void *ptr, PetscDataType dtype) { 71d96cc911SJed Brown if (PETSC_RUNNING_ON_VALGRIND) return PETSC_TRUE; 72d96cc911SJed Brown if (!ptr) return PETSC_FALSE; 7328559dc8SJed Brown if (petsc_checkpointer_intensity < 1) return PETSC_TRUE; 74d96cc911SJed Brown 7527104ee2SJacob Faibussowitsch #if PetscDefined(USE_DEBUG) 76a2f94806SJed Brown /* Skip the verbose check if we are inside a hot function. */ 7727104ee2SJacob Faibussowitsch if (petscstack.hotdepth > 0 && petsc_checkpointer_intensity < 2) return PETSC_TRUE; 7827104ee2SJacob Faibussowitsch #endif 79a2f94806SJed Brown 80718fc407SJed Brown PetscSegvJumpBuf_set = PETSC_TRUE; 81d96cc911SJed Brown 82d96cc911SJed Brown if (setjmp(PetscSegvJumpBuf)) { 83d96cc911SJed Brown /* A segv was triggered in the code below hence we return with an error code */ 84718fc407SJed Brown PetscSegvJumpBuf_set = PETSC_FALSE; 85d96cc911SJed Brown return PETSC_FALSE; 86d96cc911SJed Brown } else { 87d96cc911SJed Brown switch (dtype) { 88d96cc911SJed Brown case PETSC_INT: { 89d96cc911SJed Brown PETSC_UNUSED PetscInt x = (PetscInt) * (volatile PetscInt *)ptr; 90d96cc911SJed Brown break; 91d96cc911SJed Brown } 92d96cc911SJed Brown #if defined(PETSC_USE_COMPLEX) 93d96cc911SJed Brown case PETSC_SCALAR: { /* C++ is seriously dysfunctional with volatile std::complex. */ 9496d2aba5SSatish Balay #if defined(PETSC_USE_CXXCOMPLEX) 95d96cc911SJed Brown PetscReal xreal = ((volatile PetscReal *)ptr)[0], ximag = ((volatile PetscReal *)ptr)[1]; 96d96cc911SJed Brown PETSC_UNUSED volatile PetscScalar x = xreal + PETSC_i * ximag; 9796d2aba5SSatish Balay #else 9896d2aba5SSatish Balay PETSC_UNUSED PetscScalar x = *(volatile PetscScalar *)ptr; 9996d2aba5SSatish Balay #endif 100d96cc911SJed Brown break; 101d96cc911SJed Brown } 102d96cc911SJed Brown #endif 103d96cc911SJed Brown case PETSC_REAL: { 104d96cc911SJed Brown PETSC_UNUSED PetscReal x = *(volatile PetscReal *)ptr; 105d96cc911SJed Brown break; 106d96cc911SJed Brown } 107d96cc911SJed Brown case PETSC_BOOL: { 108d96cc911SJed Brown PETSC_UNUSED PetscBool x = *(volatile PetscBool *)ptr; 109d96cc911SJed Brown break; 110d96cc911SJed Brown } 111d96cc911SJed Brown case PETSC_ENUM: { 112d96cc911SJed Brown PETSC_UNUSED PetscEnum x = *(volatile PetscEnum *)ptr; 113d96cc911SJed Brown break; 114d96cc911SJed Brown } 115d96cc911SJed Brown case PETSC_CHAR: { 116f4e06bcbSJed Brown PETSC_UNUSED char x = *(volatile char *)ptr; 117d96cc911SJed Brown break; 118d96cc911SJed Brown } 119d96cc911SJed Brown case PETSC_OBJECT: { 120d96cc911SJed Brown PETSC_UNUSED volatile PetscClassId classid = ((PetscObject)ptr)->classid; 121d96cc911SJed Brown break; 122d96cc911SJed Brown } 123d96cc911SJed Brown default:; 124d96cc911SJed Brown } 125d96cc911SJed Brown } 126718fc407SJed Brown PetscSegvJumpBuf_set = PETSC_FALSE; 127d96cc911SJed Brown return PETSC_TRUE; 128d96cc911SJed Brown } 12905035670SJunchao Zhang #endif 130