PetscIsRegionPoisoned#

Query whether a particular memory region is poisoned

Synopsis#

static inline PetscErrorCode PetscIsRegionPoisoned(const void *ptr, size_t size, PetscBool3 *poisoned)

Input Parameters#

ptr - The pointer to the start of the region
size - The size (in bytes) of the region to query

Output Parameter#

poisoned - Whether the region is known to be poisoned

Notes#

Sets poisoned to PETSC_BOOL3_TRUE if at least 1 byte in the range [ptr, ptr + size) is poisoned. Therefore a region must be entirely unpoisoned for poisoned to be PETSC_BOOL3_FALSE.

If ptr is NULL or size is 0 then poisoned is set to PETSC_BOOL3_FALSE.

If it is not possible to query the poisoned status of a region, then poisoned is set to PETSC_BOOL3_UNKNOWN.

Level#

developer

Location#

include/petsc/private/mempoison.h

Edit on GitLab

Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages