summaryrefslogtreecommitdiff
path: root/kern/mutex/mutex_adaptive_i.h
blob: b123251fcf2789a80e67bf183b2c60973544bcb0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*
 * Copyright (c) 2017 Agustina Arzille.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef KERN_MUTEX_ADAPTIVE_I_H
#define KERN_MUTEX_ADAPTIVE_I_H

#ifndef KERN_MUTEX_H
#error "don't include <kern/mutex/mutex_adaptive_i.h> directly," \
       " use <kern/mutex.h> instead"
#endif

#include <assert.h>
#include <errno.h>
#include <stdint.h>

#include <kern/atomic.h>
#include <kern/init.h>
#include <kern/macros.h>
#include <kern/mutex_types.h>
#include <kern/thread.h>

/*
 * Mutex flags.
 *
 * The "contended" flag indicates that threads are waiting for the mutex
 * to be unlocked, potentially spinning on the owner. It forces threads
 * trying to lock the mutex as well as the owner to take the slow path.
 */
#define MUTEX_ADAPTIVE_CONTENDED 0x1

static inline void
mutex_adaptive_init(struct mutex *mutex)
{
    mutex->owner = 0;
}

#define mutex_adaptive_assert_locked(mutex) assert((mutex)->owner != 0)

static inline int
mutex_adaptive_lock_fast(struct mutex *mutex)
{
    uintptr_t owner;

    owner = atomic_cas(&mutex->owner, 0,
                       (uintptr_t)thread_self(), ATOMIC_ACQUIRE);

    if (unlikely(owner != 0)) {
        return EBUSY;
    }

    return 0;
}

static inline int
mutex_adaptive_unlock_fast(struct mutex *mutex)
{
    uintptr_t owner;

    owner = atomic_cas(&mutex->owner, (uintptr_t)thread_self(),
                       0, ATOMIC_RELEASE);

    if (unlikely(owner & MUTEX_ADAPTIVE_CONTENDED)) {
        return EBUSY;
    }

    return 0;
}

void mutex_adaptive_lock_slow(struct mutex *mutex);
int mutex_adaptive_timedlock_slow(struct mutex *mutex, uint64_t ticks);
void mutex_adaptive_unlock_slow(struct mutex *mutex);

/*
 * Interface exported to the public mutex header.
 */

#define mutex_impl_init             mutex_adaptive_init
#define mutex_impl_assert_locked    mutex_adaptive_assert_locked

static inline int
mutex_impl_trylock(struct mutex *mutex)
{
    return mutex_adaptive_lock_fast(mutex);
}

static inline void
mutex_impl_lock(struct mutex *mutex)
{
    int error;

    error = mutex_adaptive_lock_fast(mutex);

    if (unlikely(error)) {
        mutex_adaptive_lock_slow(mutex);
    }
}

static inline int
mutex_impl_timedlock(struct mutex *mutex, uint64_t ticks)
{
    int error;

    error = mutex_adaptive_lock_fast(mutex);

    if (unlikely(error)) {
        error = mutex_adaptive_timedlock_slow(mutex, ticks);
    }

    return error;
}

static inline void
mutex_impl_unlock(struct mutex *mutex)
{
    int error;

    error = mutex_adaptive_unlock_fast(mutex);

    if (unlikely(error)) {
        mutex_adaptive_unlock_slow(mutex);
    }
}

/*
 * Mutex init operations. See kern/mutex.h.
 */

#define mutex_impl_bootstrap mutex_adaptive_bootstrap
INIT_OP_DECLARE(mutex_adaptive_bootstrap);

#define mutex_impl_setup mutex_adaptive_setup
INIT_OP_DECLARE(mutex_adaptive_setup);

#endif /* KERN_MUTEX_ADAPTIVE_I_H */