picotm-module.h File Reference

Picotm's module interface. More...

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "compiler.h"
#include "picotm-error.h"

Include dependency graph for picotm-module.h:

Typedefs
typedef void(*	picotm_module_lock_function) (void *data, struct picotm_error *error)
typedef void(*	picotm_module_unlock_function) (void *data, struct picotm_error *error)
typedef bool(*	picotm_module_is_valid_function) (void *data, int is_irrevocable, struct picotm_error *error)
typedef void(*	picotm_module_apply_function) (void *data, struct picotm_error *error)
typedef void(*	picotm_module_undo_function) (void *data, struct picotm_error *error)
typedef void(*	picotm_module_apply_event_function) (const struct picotm_event *event, void *data, struct picotm_error *error)
typedef void(*	picotm_module_undo_event_function) (const struct picotm_event *event, void *data, struct picotm_error *error)
typedef void(*	picotm_module_update_cc_function) (void *data, int is_irrevocable, struct picotm_error *error)
typedef void(*	picotm_module_clear_cc_function) (void *data, int is_irrevocable, struct picotm_error *error)
typedef void(*	picotm_module_finish_function) (void *data, struct picotm_error *error)
typedef void(*	picotm_module_uninit_function) (void *data)

Functions
PICOTM_NOTHROW unsigned long	picotm_register_module (picotm_module_lock_function lock, picotm_module_unlock_function unlock, picotm_module_is_valid_function is_valid, picotm_module_apply_function apply, picotm_module_undo_function undo, picotm_module_apply_event_function apply_event, picotm_module_undo_event_function undo_event, picotm_module_update_cc_function update_cc, picotm_module_clear_cc_function clear_cc, picotm_module_finish_function finish, picotm_module_uninit_function uninit, void *cbdata, struct picotm_error *error)
PICOTM_NOTHROW void	picotm_append_event (unsigned long module, unsigned long op, uintptr_t cookie, struct picotm_error *error)
PICOTM_NOTHROW void	picotm_resolve_conflict (struct picotm_tx *conflicting_tx)
PICOTM_NOTHROW void	picotm_recover_from_error_code (enum picotm_error_code error_hint)
PICOTM_NOTHROW void	picotm_recover_from_errno (int errno_hint)
PICOTM_NOTHROW void	picotm_recover_from_error (const struct picotm_error *error)
PICOTM_NOTHROW bool	picotm_is_valid (void)
PICOTM_NOTHROW void	picotm_irrevocable (void)
PICOTM_NOTHROW bool	picotm_is_irrevocable (void)

Detailed Description

Picotm is extensible. The header file picotm-module.h contains the declaration of picotm's module interface. The interface allows for implementing support for additional features, libraries and functionality. All existing modules are written on top of this interface as well.

Typedef Documentation

picotm_module_apply_event_function

typedef void(* picotm_module_apply_event_function) (const struct picotm_event *event, void *data, struct picotm_error *error)

Invoked by picotm during the commit phase to apply an event.

Parameters

	event	An event.
	data	The pointer to module-specific data.
[out]	error	Returns an error from the module.

picotm_module_apply_function

typedef void(* picotm_module_apply_function) (void *data, struct picotm_error *error)

Invoked by picotm during the commit phase to apply changes of a module.

Parameters

	data	The pointer to module-specific data.
[out]	error	Returns an error from the module.

picotm_module_clear_cc_function

typedef void(* picotm_module_clear_cc_function) (void *data, int is_irrevocable, struct picotm_error *error)

Invoked by picotm to clear a module's concurrency control during an abort.

Parameters

	data	The pointer to module-specific data.
	is_irrevocable	True if the transaction is irrevocable, false otherwise.
[out]	error	Returns an error from the module.

picotm_module_finish_function

typedef void(* picotm_module_finish_function) (void *data, struct picotm_error *error)

Invoked by picotm to clean up a module's resources at the end of a transaction.

Parameters

	data	The pointer to module-specific data.
[out]	error	Returns an error from the module.

picotm_module_is_valid_function

typedef bool(* picotm_module_is_valid_function) (void *data, int is_irrevocable, struct picotm_error *error)

Invoked by picotm to validate a module's resources.

Parameters

	data	The pointer to module-specific data.
	is_irrevocable	True if the transaction is irrevocable, false otherwise.
[out]	error	Returns an error from the module.

Returns

True if valid, or flase otherwise.

picotm_module_lock_function

typedef void(* picotm_module_lock_function) (void *data, struct picotm_error *error)

Invoked by picotm to lock a module's resources at the beginning if a commit.

Parameters

	data	The pointer to module-specific data.
[out]	error	Returns an error from the module.

picotm_module_undo_event_function

typedef void(* picotm_module_undo_event_function) (const struct picotm_event *event, void *data, struct picotm_error *error)

Invoked by picotm during the roll-back phase to revert an event.

Parameters

	event	An event.
	data	The pointer to module-specific data.
[out]	error	Returns an error from the module.

picotm_module_undo_function

typedef void(* picotm_module_undo_function) (void *data, struct picotm_error *error)

Invoked by picotm during the roll-back phase to revert changes of a module.

Parameters

	data	The pointer to module-specific data.
[out]	error	Returns an error from the module.

picotm_module_uninit_function

typedef void(* picotm_module_uninit_function) (void *data)

Invoked by picotm to clean up a module's resources when the thread exists.

Parameters

data	The pointer to module-specific data.

picotm_module_unlock_function

typedef void(* picotm_module_unlock_function) (void *data, struct picotm_error *error)

Invoked by picotm to unlock a module's resources. This is the inverse of picotm_module_lock_function.

Parameters

	data	The pointer to module-specific data.
[out]	error	Returns an error from the module.

picotm_module_update_cc_function

typedef void(* picotm_module_update_cc_function) (void *data, int is_irrevocable, struct picotm_error *error)

Invoked by picotm to update a module's concurrency control during a commit.

Parameters

	data	The pointer to module-specific data.
	is_irrevocable	True if the transaction is irrevocable, false otherwise.
[out]	error	Returns an error from the module.

Function Documentation

picotm_append_event()

PICOTM_NOTHROW void picotm_append_event	(	unsigned long	module,
		unsigned long	op,
		uintptr_t	cookie,
		struct picotm_error *	error
	)

Appends an event to the transaction's event log.

Parameters

	module	The module number
	op	A module-specific operation.
	cookie	A module-specific cookie.
[out]	error	Returns an error.

picotm_irrevocable()

PICOTM_NOTHROW void picotm_irrevocable

(

void

)

Makes the current transaction irrevocable.

picotm_is_irrevocable()

PICOTM_NOTHROW bool picotm_is_irrevocable

(

void

)

Returns the transaction irrevocability status.

Returns

True if the transaction is irrevocable, false otherwise.

picotm_is_valid()

PICOTM_NOTHROW bool picotm_is_valid

(

void

)

Validates the transaction state.

Returns

True if the transaction state is valid, false otherwise.

picotm_recover_from_errno()

PICOTM_NOTHROW void picotm_recover_from_errno

(

int

errno_hint

)

Instructs the transaction management system to recover from an error. The errno code is given as a hint.

Parameters

errno_hint

The errno code of the detected error, or 0 if unknown.

Attention

This function will not return if picotm aborts the transaction. If the function returns, the caller shall restart the operation that triggered the conflict.

picotm_recover_from_error()

PICOTM_NOTHROW void picotm_recover_from_error

(

const struct picotm_error *

error

)

Instructs the transaction management system to recover from an error. The error is supplied as an argument.

Parameters

error

The detected error.

Attention

This function will not return if picotm aborts the transaction. If the function returns, the caller shall restart the operation that triggered the conflict.

picotm_recover_from_error_code()

PICOTM_NOTHROW void picotm_recover_from_error_code

(

enum picotm_error_code

error_hint

)

Instructs the transaction management system to recover from an error. The error code is given as a hint.

Parameters

error_hint

The error code of the detected error, or PICOTM_GENERAL_ERROR if unknown.

Attention

This function will not return if picotm aborts the transaction. If the function returns, the caller shall restart the operation that triggered the conflict.

picotm_register_module()

PICOTM_NOTHROW unsigned long picotm_register_module	(	picotm_module_lock_function	lock,
		picotm_module_unlock_function	unlock,
		picotm_module_is_valid_function	is_valid,
		picotm_module_apply_function	apply,
		picotm_module_undo_function	undo,
		picotm_module_apply_event_function	apply_event,
		picotm_module_undo_event_function	undo_event,
		picotm_module_update_cc_function	update_cc,
		picotm_module_clear_cc_function	clear_cc,
		picotm_module_finish_function	finish,
		picotm_module_uninit_function	uninit,
		void *	cbdata,
		struct picotm_error *	error
	)

Registers a new module with the transaction management system.

Parameters

	lock	The lock call-back function.
	unlock	The unlock call-back function.
	is_valid	The is-valid call-back function.
	apply	The apply call-back function.
	undo	The undo call-back function.
	apply_event	The apply-event call-back function.
	undo_event	The undo-event call-back function.
	update_cc	The update-CC call-back function.
	clear_cc	The clear-CC call-back function.
	finish	The finish call-back function.
	uninit	The uninit call-back function.
	cbdata	A pointer to module-specific data.
[out]	error	Returns an error.

Returns

A module number on success.

picotm_resolve_conflict()

PICOTM_NOTHROW void picotm_resolve_conflict

(

struct picotm_tx *

conflicting_tx

)

Instructs the transaction management system to resolve a conflict with another transaction.

Parameters

conflicting_tx

The conflicting transaction, or NULL if unknown.

Attention

This function will not return if picotm aborts the transaction. If the function returns, the caller shall restart the operation that triggered the conflict.