Read-Write Mutex

Read-Write Mutex. More...

Collaboration diagram for Read-Write Mutex:

Detailed Description

Read-Write Mutex.

Data Structures
struct	rwmutex_t
	Read-Write Mutex structure. More...

Macros
#define	RWMUTEX_READ_SCOPE(mutex)
	Acquires a rwmutex for reading for the reminder of the current scope.
#define	RWMUTEX_WRITE_SCOPE(mutex)
	Acquires a rwmutex for writing for the reminder of the current scope.
#define	RWMUTEX_CREATE(name)
	Create a rwmutex initializer.

Functions
void	rwmutex_init (rwmutex_t *mtx)
	Initializes a rwmutex.
void	rwmutex_deinit (rwmutex_t *mtx)
	Deinitializes a rwmutex.
void	rwmutex_read_acquire (rwmutex_t *mtx)
	Acquires a rwmutex for reading, blocking until it is available.
uint64_t	rwmutex_read_try_acquire (rwmutex_t *mtx)
	Tries to acquire a rwmutex for reading.
void	rwmutex_read_release (rwmutex_t *mtx)
	Releases a rwmutex from reading.
void	rwmutex_write_acquire (rwmutex_t *mtx)
	Acquires a rwmutex for writing, blocking until it is available.
uint64_t	rwmutex_write_try_acquire (rwmutex_t *mtx)
	Tries to acquire a rwmutex for writing.
void	rwmutex_write_release (rwmutex_t *mtx)
	Releases a rwmutex from writing.
static void	rwmutex_read_cleanup (rwmutex_t **mutex)
static void	rwmutex_write_cleanup (rwmutex_t **mutex)

Macro Definition Documentation

RWMUTEX_READ_SCOPE

#define RWMUTEX_READ_SCOPE

(

mutex

)

Value:

    __attribute__((cleanup(rwmutex_read_cleanup))) rwmutex_t* CONCAT(rm, __COUNTER__) = (mutex); \
    rwmutex_read_acquire((mutex))

Acquires a rwmutex for reading for the reminder of the current scope.

Parameters

mutex

Pointer to the rwmutex to acquire.

Definition at line 21 of file rwmutex.h.

RWMUTEX_WRITE_SCOPE

#define RWMUTEX_WRITE_SCOPE

(

mutex

)

Value:

    __attribute__((cleanup(rwmutex_write_cleanup))) rwmutex_t* CONCAT(wm, __COUNTER__) = (mutex); \
    rwmutex_write_acquire((mutex))

Acquires a rwmutex for writing for the reminder of the current scope.

Parameters

mutex

Pointer to the rwmutex to acquire.

Definition at line 30 of file rwmutex.h.

RWMUTEX_CREATE

#define RWMUTEX_CREATE

(

name

)

Value:

    { \
        .activeReaders = 0, \
        .waitingWriters = 0, \
        .readerQueue = WAIT_QUEUE_CREATE(name.readerQueue), \
        .writerQueue = WAIT_QUEUE_CREATE(name.writerQueue), \
        .hasWriter = false, \
        .lock = LOCK_CREATE(), \
    }

Create a rwmutex initializer.

Parameters

name	The name of the rwmutex variable to initialize.

Returns

A rwmutex_t initializer.

Definition at line 58 of file rwmutex.h.

Function Documentation

rwmutex_init()

void rwmutex_init

(

rwmutex_t *

mtx

)

Initializes a rwmutex.

Parameters

mtx	Pointer to the rwmutex to initialize.

Definition at line 10 of file rwmutex.c.

Here is the call graph for this function:

Here is the caller graph for this function:

rwmutex_deinit()

void rwmutex_deinit

(

rwmutex_t *

mtx

)

Deinitializes a rwmutex.

Parameters

mtx	Pointer to the rwmutex to deinitialize.

Definition at line 20 of file rwmutex.c.

Here is the call graph for this function:

Here is the caller graph for this function:

rwmutex_read_acquire()

void rwmutex_read_acquire

(

rwmutex_t *

mtx

)

Acquires a rwmutex for reading, blocking until it is available.

Parameters

mtx	Pointer to the rwmutex to acquire.

Definition at line 30 of file rwmutex.c.

rwmutex_read_try_acquire()

uint64_t rwmutex_read_try_acquire

(

rwmutex_t *

mtx

)

Tries to acquire a rwmutex for reading.

If the rwmutex is owned by another thread for writing or a writer is waiting, this function will fail with EWOULDBLOCK.

If the function succeeds, rwmutex_read_release() must be called to release the rwmutex.

Parameters

mtx	Pointer to the rwmutex to acquire.

Returns

On success, 0. On error, ERR and errno is set.

Definition at line 47 of file rwmutex.c.

rwmutex_read_release()

void rwmutex_read_release

(

rwmutex_t *

mtx

)

Releases a rwmutex from reading.

Parameters

mtx	Pointer to the rwmutex to release.

Definition at line 67 of file rwmutex.c.

Here is the call graph for this function:

Here is the caller graph for this function:

rwmutex_write_acquire()

void rwmutex_write_acquire

(

rwmutex_t *

mtx

)

Acquires a rwmutex for writing, blocking until it is available.

Parameters

mtx	Pointer to the rwmutex to acquire.

Definition at line 85 of file rwmutex.c.

Here is the caller graph for this function:

rwmutex_write_try_acquire()

uint64_t rwmutex_write_try_acquire

(

rwmutex_t *

mtx

)

Tries to acquire a rwmutex for writing.

If the function succeeds, rwmutex_write_release() must be called to release the rwmutex.

Parameters

mtx	Pointer to the rwmutex to acquire.

Returns

On success, 0. On error, ERR and errno is set.

Definition at line 104 of file rwmutex.c.

rwmutex_write_release()

void rwmutex_write_release

(

rwmutex_t *

mtx

)

Releases a rwmutex from writing.

Parameters

mtx	Pointer to the rwmutex to release.

Definition at line 124 of file rwmutex.c.

Here is the call graph for this function:

Here is the caller graph for this function:

rwmutex_read_cleanup()

static void rwmutex_read_cleanup ( rwmutex_t **  mutex )

inlinestatic

Definition at line 133 of file rwmutex.h.

Here is the call graph for this function:

rwmutex_write_cleanup()

static void rwmutex_write_cleanup ( rwmutex_t **  mutex )

inlinestatic

Definition at line 138 of file rwmutex.h.

Here is the call graph for this function: