picotm  0.2.0
Data Structures | Enumerations | Functions

Contains struct picotm_error and helper functions. More...

#include <stdbool.h>
#include <stddef.h>
#include "compiler.h"
Include dependency graph for picotm-error.h:
This graph shows which files directly or indirectly include this file:

Data Structures

struct  picotm_error
 

Enumerations

enum  picotm_error_code { PICOTM_GENERAL_ERROR, PICOTM_OUT_OF_MEMORY, PICOTM_INVALID_FENV }
 
enum  picotm_error_status { PICOTM_CONFLICTING, PICOTM_REVOCABLE, PICOTM_ERROR_CODE, PICOTM_ERRNO }
 

Functions

PICOTM_NOTHROW void picotm_error_clear (struct picotm_error *error)
 
PICOTM_NOTHROW void picotm_error_set_conflicting (struct picotm_error *error, void *conflicting_tx)
 
PICOTM_NOTHROW void picotm_error_set_revocable (struct picotm_error *error)
 
PICOTM_NOTHROW void picotm_error_set_error_code (struct picotm_error *error, enum picotm_error_code error_hint)
 
PICOTM_NOTHROW void picotm_error_set_errno (struct picotm_error *error, int errno_hint)
 
PICOTM_NOTHROW bool picotm_error_is_set (const struct picotm_error *error)
 
PICOTM_NOTHROW bool picotm_error_is_conflicting (const struct picotm_error *error)
 
PICOTM_NOTHROW bool picotm_error_is_revocable (const struct picotm_error *error)
 
PICOTM_NOTHROW bool picotm_error_is_error (const struct picotm_error *error)
 
PICOTM_NOTHROW void picotm_error_mark_as_non_recoverable (struct picotm_error *error)
 
PICOTM_NOTHROW void picotm_error_set_description (struct picotm_error *error, const char *description)
 
PICOTM_NOTHROW const char * picotm_error_get_description (const struct picotm_error *error)
 

Enumeration Type Documentation

◆ picotm_error_code

Signals detected errors to picotm.

If a component detects an error, it should prefer setting the system- specific error code that was returned by the failed call. This is more specific than the generic one's below. In some portable code, such as the tm module, using the generic codes might be preferable.

Enumerator
PICOTM_GENERAL_ERROR 

The exact error is unknown.

PICOTM_OUT_OF_MEMORY 

Out-of-Memory error.

PICOTM_INVALID_FENV 

Invalid floating-point environment.

◆ picotm_error_status

Signals error status to picotm.

Enumerator
PICOTM_CONFLICTING 

Conflict among transactions detected.

PICOTM_REVOCABLE 

Transaction requires irrevocability to continue.

PICOTM_ERROR_CODE 

Error detected. Encoded as enum picotm_error_code.

PICOTM_ERRNO 

Error detected. Encoded as errno code.

Function Documentation

◆ picotm_error_clear()

PICOTM_NOTHROW void picotm_error_clear ( struct picotm_error error)
inline

Clears an error structure.

Parameters
errorThe error to clear.

◆ picotm_error_get_description()

PICOTM_NOTHROW const char* picotm_error_get_description ( const struct picotm_error error)
inline

Returns an error's description.

Parameters
errorThe error.
Returns
The error description if set, or NULL otherwise.

◆ picotm_error_is_conflicting()

PICOTM_NOTHROW bool picotm_error_is_conflicting ( const struct picotm_error error)
inline

Tests if an error has been set to CONFLICTING status.

Parameters
errorThe error to set.
Returns
True if an error has been set to CONFLICTING, or false otherwise.

◆ picotm_error_is_error()

PICOTM_NOTHROW bool picotm_error_is_error ( const struct picotm_error error)
inline

Tests if an error has been set to an error status.

Parameters
errorThe error to set.
Returns
True if an error has been set to an error status, or false otherwise.

◆ picotm_error_is_revocable()

PICOTM_NOTHROW bool picotm_error_is_revocable ( const struct picotm_error error)
inline

Tests if an error has been set to REVOCABLE status.

Parameters
errorThe error to set.
Returns
True if an error has been set to REVOCABLE, or false otherwise.

◆ picotm_error_is_set()

PICOTM_NOTHROW bool picotm_error_is_set ( const struct picotm_error error)
inline

Tests if an error has been set.

Parameters
errorThe error to set.
Returns
True if an error has been set, or false otherwise.

◆ picotm_error_mark_as_non_recoverable()

PICOTM_NOTHROW void picotm_error_mark_as_non_recoverable ( struct picotm_error error)
inline

Marks an error as non-recoverable.

By default, errors are expected to recoverable. For irrevocable transactions or after applying events from the transaction log, errors cannot easily be recovered, because the program state is undefined in these situations. An errors that happens under such conditions is marked as being non-recoverable.

Normally, modules should not care baout this flag. The commit logic within picotm will set this flag if appropriate.

Parameters
errorThe error to mark as non-recoverable.

◆ picotm_error_set_conflicting()

PICOTM_NOTHROW void picotm_error_set_conflicting ( struct picotm_error error,
void *  conflicting_tx 
)
inline

Sets an error of type PICOTM_CONFLICTING.

Parameters
errorThe error to set.
conflicting_txThe conflicting transaction if known, or NULL otherwise.

◆ picotm_error_set_description()

PICOTM_NOTHROW void picotm_error_set_description ( struct picotm_error error,
const char *  description 
)
inline

Sets an error's description.

Parameters
errorThe error.
descriptionA descriptive string.

◆ picotm_error_set_errno()

PICOTM_NOTHROW void picotm_error_set_errno ( struct picotm_error error,
int  errno_hint 
)
inline

Sets an error of type PICOTM_ERRNO.

Parameters
errorThe error to set.
errno_hintThe errno code if known, or 0 otherwise.

◆ picotm_error_set_error_code()

PICOTM_NOTHROW void picotm_error_set_error_code ( struct picotm_error error,
enum picotm_error_code  error_hint 
)
inline

Sets an error of type PICOTM_ERROR_CODE.

Parameters
errorThe error to set.
error_hintThe picotm error code if known, or PICOTM_GENERAL_ERROR otherwise.

◆ picotm_error_set_revocable()

PICOTM_NOTHROW void picotm_error_set_revocable ( struct picotm_error error)
inline

Sets an error of type PICOTM_REVOCABLE.

Parameters
errorThe error to set.