| 1 | /*
|
|---|
| 2 | * Copyright (c) 2009 Jakub Jermar
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup libc
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file
|
|---|
| 33 | */
|
|---|
| 34 |
|
|---|
| 35 | #ifndef LIBC_FIBRIL_SYNCH_H_
|
|---|
| 36 | #define LIBC_FIBRIL_SYNCH_H_
|
|---|
| 37 |
|
|---|
| 38 | #include <fibril.h>
|
|---|
| 39 | #include <adt/list.h>
|
|---|
| 40 | #include <libarch/tls.h>
|
|---|
| 41 | #include <sys/time.h>
|
|---|
| 42 | #include <stdbool.h>
|
|---|
| 43 |
|
|---|
| 44 | typedef struct {
|
|---|
| 45 | fibril_owner_info_t oi; /**< Keep this the first thing. */
|
|---|
| 46 | int counter;
|
|---|
| 47 | list_t waiters;
|
|---|
| 48 | } fibril_mutex_t;
|
|---|
| 49 |
|
|---|
| 50 | #define FIBRIL_MUTEX_INITIALIZER(name) \
|
|---|
| 51 | { \
|
|---|
| 52 | .oi = { \
|
|---|
| 53 | .owned_by = NULL \
|
|---|
| 54 | }, \
|
|---|
| 55 | .counter = 1, \
|
|---|
| 56 | .waiters = { \
|
|---|
| 57 | .head = { \
|
|---|
| 58 | .prev = &(name).waiters.head, \
|
|---|
| 59 | .next = &(name).waiters.head, \
|
|---|
| 60 | } \
|
|---|
| 61 | } \
|
|---|
| 62 | }
|
|---|
| 63 |
|
|---|
| 64 | #define FIBRIL_MUTEX_INITIALIZE(name) \
|
|---|
| 65 | fibril_mutex_t name = FIBRIL_MUTEX_INITIALIZER(name)
|
|---|
| 66 |
|
|---|
| 67 | typedef struct {
|
|---|
| 68 | fibril_owner_info_t oi; /**< Keep this the first thing. */
|
|---|
| 69 | unsigned writers;
|
|---|
| 70 | unsigned readers;
|
|---|
| 71 | list_t waiters;
|
|---|
| 72 | } fibril_rwlock_t;
|
|---|
| 73 |
|
|---|
| 74 | #define FIBRIL_RWLOCK_INITIALIZER(name) \
|
|---|
| 75 | { \
|
|---|
| 76 | .oi = { \
|
|---|
| 77 | .owned_by = NULL \
|
|---|
| 78 | }, \
|
|---|
| 79 | .readers = 0, \
|
|---|
| 80 | .writers = 0, \
|
|---|
| 81 | .waiters = { \
|
|---|
| 82 | .head = { \
|
|---|
| 83 | .prev = &(name).waiters.head, \
|
|---|
| 84 | .next = &(name).waiters.head, \
|
|---|
| 85 | } \
|
|---|
| 86 | } \
|
|---|
| 87 | }
|
|---|
| 88 |
|
|---|
| 89 | #define FIBRIL_RWLOCK_INITIALIZE(name) \
|
|---|
| 90 | fibril_rwlock_t name = FIBRIL_RWLOCK_INITIALIZER(name)
|
|---|
| 91 |
|
|---|
| 92 | typedef struct {
|
|---|
| 93 | list_t waiters;
|
|---|
| 94 | } fibril_condvar_t;
|
|---|
| 95 |
|
|---|
| 96 | #define FIBRIL_CONDVAR_INITIALIZER(name) \
|
|---|
| 97 | { \
|
|---|
| 98 | .waiters = { \
|
|---|
| 99 | .head = { \
|
|---|
| 100 | .next = &(name).waiters.head, \
|
|---|
| 101 | .prev = &(name).waiters.head, \
|
|---|
| 102 | } \
|
|---|
| 103 | } \
|
|---|
| 104 | }
|
|---|
| 105 |
|
|---|
| 106 | #define FIBRIL_CONDVAR_INITIALIZE(name) \
|
|---|
| 107 | fibril_condvar_t name = FIBRIL_CONDVAR_INITIALIZER(name)
|
|---|
| 108 |
|
|---|
| 109 | typedef void (*fibril_timer_fun_t)(void *);
|
|---|
| 110 |
|
|---|
| 111 | typedef enum {
|
|---|
| 112 | /** Timer has not been set or has been cleared */
|
|---|
| 113 | fts_not_set,
|
|---|
| 114 | /** Timer was set but did not fire yet */
|
|---|
| 115 | fts_active,
|
|---|
| 116 | /** Timer has fired and has not been cleared since */
|
|---|
| 117 | fts_fired,
|
|---|
| 118 | /** Timer fibril is requested to terminate */
|
|---|
| 119 | fts_cleanup,
|
|---|
| 120 | /** Timer fibril acknowledged termination */
|
|---|
| 121 | fts_clean
|
|---|
| 122 | } fibril_timer_state_t;
|
|---|
| 123 |
|
|---|
| 124 | /** Fibril timer.
|
|---|
| 125 | *
|
|---|
| 126 | * When a timer is set it executes a callback function (in a separate
|
|---|
| 127 | * fibril) after a specified time interval. The timer can be cleared
|
|---|
| 128 | * (canceled) before that. From the return value of fibril_timer_clear()
|
|---|
| 129 | * one can tell whether the timer fired or not.
|
|---|
| 130 | */
|
|---|
| 131 | typedef struct {
|
|---|
| 132 | fibril_mutex_t lock;
|
|---|
| 133 | fibril_mutex_t *lockp;
|
|---|
| 134 | fibril_condvar_t cv;
|
|---|
| 135 | fid_t fibril;
|
|---|
| 136 | fibril_timer_state_t state;
|
|---|
| 137 | /** FID of fibril executing handler or 0 if handler is not running */
|
|---|
| 138 | fid_t handler_fid;
|
|---|
| 139 |
|
|---|
| 140 | suseconds_t delay;
|
|---|
| 141 | fibril_timer_fun_t fun;
|
|---|
| 142 | void *arg;
|
|---|
| 143 | } fibril_timer_t;
|
|---|
| 144 |
|
|---|
| 145 | extern void fibril_mutex_initialize(fibril_mutex_t *);
|
|---|
| 146 | extern void fibril_mutex_lock(fibril_mutex_t *);
|
|---|
| 147 | extern bool fibril_mutex_trylock(fibril_mutex_t *);
|
|---|
| 148 | extern void fibril_mutex_unlock(fibril_mutex_t *);
|
|---|
| 149 | extern bool fibril_mutex_is_locked(fibril_mutex_t *);
|
|---|
| 150 |
|
|---|
| 151 | extern void fibril_rwlock_initialize(fibril_rwlock_t *);
|
|---|
| 152 | extern void fibril_rwlock_read_lock(fibril_rwlock_t *);
|
|---|
| 153 | extern void fibril_rwlock_write_lock(fibril_rwlock_t *);
|
|---|
| 154 | extern void fibril_rwlock_read_unlock(fibril_rwlock_t *);
|
|---|
| 155 | extern void fibril_rwlock_write_unlock(fibril_rwlock_t *);
|
|---|
| 156 | extern bool fibril_rwlock_is_read_locked(fibril_rwlock_t *);
|
|---|
| 157 | extern bool fibril_rwlock_is_write_locked(fibril_rwlock_t *);
|
|---|
| 158 | extern bool fibril_rwlock_is_locked(fibril_rwlock_t *);
|
|---|
| 159 |
|
|---|
| 160 | extern void fibril_condvar_initialize(fibril_condvar_t *);
|
|---|
| 161 | extern int fibril_condvar_wait_timeout(fibril_condvar_t *, fibril_mutex_t *,
|
|---|
| 162 | suseconds_t);
|
|---|
| 163 | extern void fibril_condvar_wait(fibril_condvar_t *, fibril_mutex_t *);
|
|---|
| 164 | extern void fibril_condvar_signal(fibril_condvar_t *);
|
|---|
| 165 | extern void fibril_condvar_broadcast(fibril_condvar_t *);
|
|---|
| 166 |
|
|---|
| 167 | extern fibril_timer_t *fibril_timer_create(fibril_mutex_t *);
|
|---|
| 168 | extern void fibril_timer_destroy(fibril_timer_t *);
|
|---|
| 169 | extern void fibril_timer_set(fibril_timer_t *, suseconds_t, fibril_timer_fun_t,
|
|---|
| 170 | void *);
|
|---|
| 171 | extern void fibril_timer_set_locked(fibril_timer_t *, suseconds_t,
|
|---|
| 172 | fibril_timer_fun_t, void *);
|
|---|
| 173 | extern fibril_timer_state_t fibril_timer_clear(fibril_timer_t *);
|
|---|
| 174 | extern fibril_timer_state_t fibril_timer_clear_locked(fibril_timer_t *);
|
|---|
| 175 |
|
|---|
| 176 | #endif
|
|---|
| 177 |
|
|---|
| 178 | /** @}
|
|---|
| 179 | */
|
|---|
