pmem2_badblock_context_new - Man Page

allocate and free a context for pmem2_badblock_next() and pmem2_badblock_clear() operations

Synopsis

#include <libpmem2.h>

struct pmem2_source;
struct pmem2_badblock_context;

int pmem2_badblock_context_new(
        struct pmem2_badblock_context **bbctx,
        const struct pmem2_source *src);

void pmem2_badblock_context_delete(
        struct pmem2_badblock_context **bbctx);

Description

The pmem2_badblock_context_new() function instantiates a new (opaque) bad block context structure, pmem2_badblock_context, which is used to read and clear bad blocks (by pmem2_badblock_next() and pmem2_badblock_clear()). The function returns the bad block context through the pointer in *bbctx.

New bad block context structure is initialized with values read from the source given as the first argument (src).

A bad block is an uncorrectable media error - a part of a storage media that is either inaccessible or unwritable due to permanent physical damage. In case of memory-mapped I/O, if a process tries to access (read or write) the corrupted block, it will be terminated by the SIGBUS signal.

The pmem2_badblock_context_delete() function frees *bbctx returned by pmem2_badblock_context_new() and sets *bbctx to NULL. If *bbctx is NULL, no operation is performed.

It is not supported on Windows.

Return Value

The pmem2_badblock_context_new() function returns 0 on success or a negative error code on failure.

The pmem2_badblock_context_new() sets *bbctx to NULL on failure.

The pmem2_badblock_context_delete() does not return any value.

Errors

The pmem2_badblock_context_new() can fail with the following errors:

See Also

pmem2_badblock_next(3), pmem2_badblock_clear(3), libpmem2(7) and <http://pmem.io>

Referenced By

libpmem2(7), pmem2_badblock_clear(3), pmem2_badblock_next(3).

The man page pmem2_badblock_context_delete(3) is an alias of pmem2_badblock_context_new(3).

2020-10-28 PMDK - pmem2 API version 1.0 PMDK Programmer's Manual