summaryrefslogtreecommitdiffstats
path: root/lib/libthr/thread/thr_spinlock.c
blob: 60e95224cbce6db65060b69d684ddfe49831af8e (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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/*
 * Copyright (c) 2004 Michael Telahun Makonnen <mtm@FreeBSD.Org>
 * Copyright (c) 1997 John Birrell <jb@cimlogic.com.au>.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by John Birrell.
 * 4. Neither the name of the author nor the names of any co-contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD$
 *
 */

#include <sys/types.h>
#include <machine/atomic.h>

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <sched.h>
#include <pthread.h>
#include <unistd.h>

#include <libc_private.h>

#include "thr_private.h"

#define THR_SPIN_MAGIC		0xdadadada
#define THR_SPIN_UNOWNED	(void *)0
#define MAGIC_TEST_RETURN_ON_FAIL(l)					   \
	do {								   \
		if ((l) == NULL || (l)->s_magic != THR_SPIN_MAGIC)	   \
			return (EINVAL);				   \
	} while(0)

__weak_reference(_pthread_spin_destroy, pthread_spin_destroy);
__weak_reference(_pthread_spin_init, pthread_spin_init);
__weak_reference(_pthread_spin_lock, pthread_spin_lock);
__weak_reference(_pthread_spin_trylock, pthread_spin_trylock);
__weak_reference(_pthread_spin_unlock, pthread_spin_unlock);

int
_pthread_spin_destroy(pthread_spinlock_t *lock)
{
	MAGIC_TEST_RETURN_ON_FAIL((*lock));
	if ((*lock)->s_owner == THR_SPIN_UNOWNED) {
		(*lock)->s_magic = 0;
		free((*lock));
		*lock = NULL;
		return (0);
	}
	return (EBUSY);
}

int
_pthread_spin_init(pthread_spinlock_t *lock, int pshared)
{
	struct pthread_spinlock *s;

	if (*lock != NULL) {
		if ((*lock)->s_magic == THR_SPIN_MAGIC)
			return (EBUSY);
	}
	s = (struct pthread_spinlock *)malloc(sizeof(struct pthread_spinlock));
	if (s == NULL)
		return (ENOMEM);
	s->s_magic = THR_SPIN_MAGIC;
	s->s_owner = THR_SPIN_UNOWNED;
	*lock = s;
	return (0);
}

/*
 * If the caller sets nonblocking to 1, this function will return
 * immediately without acquiring the lock it is owned by another thread.
 * If set to 0, it will keep spinning until it acquires the lock.
 */
int
_pthread_spin_lock(pthread_spinlock_t *lock)
{
	MAGIC_TEST_RETURN_ON_FAIL(*lock);
	if ((*lock)->s_owner == curthread)
		return (EDEADLK);
        while (atomic_cmpset_acq_ptr(&(*lock)->s_owner, THR_SPIN_UNOWNED,
            (void *)curthread) != 1)
		;	/* SPIN */
	return (0);
}

int
_pthread_spin_trylock(pthread_spinlock_t *lock)
{
	MAGIC_TEST_RETURN_ON_FAIL(*lock);
	if (atomic_cmpset_acq_ptr(&(*lock)->s_owner, THR_SPIN_UNOWNED,
	    (void *)curthread) == 1)
		return (0);
	return (EBUSY);
}

int
_pthread_spin_unlock(pthread_spinlock_t *lock)
{
	MAGIC_TEST_RETURN_ON_FAIL(*lock);
	if (atomic_cmpset_rel_ptr(&(*lock)->s_owner, (void *)curthread,
	    THR_SPIN_UNOWNED) == 1)
		return (0);
	return (EPERM);
}

void
_spinunlock(spinlock_t *lck)
{
	if (umtx_unlock((struct umtx *)lck, curthread->thr_id))
		abort();
}

/*
 * Lock a location for the running thread. Yield to allow other
 * threads to run if this thread is blocked because the lock is
 * not available. Note that this function does not sleep. It
 * assumes that the lock will be available very soon.
 */
void
_spinlock(spinlock_t *lck)
{
	if (umtx_lock((struct umtx *)lck, curthread->thr_id))
		abort();
}

int
_spintrylock(spinlock_t *lck)
{
	int error;

	error = umtx_lock((struct umtx *)lck, curthread->thr_id);
	if (error != 0 && error != EBUSY)
		abort();
	return (error);
}

/*
 * Lock a location for the running thread. Yield to allow other
 * threads to run if this thread is blocked because the lock is
 * not available. Note that this function does not sleep. It
 * assumes that the lock will be available very soon.
 *
 * This function checks if the running thread has already locked the
 * location, warns if this occurs and creates a thread dump before
 * returning.
 */
void
_spinlock_debug(spinlock_t *lck, char *fname, int lineno)
{
	if (umtx_lock((struct umtx *)lck, curthread->thr_id))
		abort();
}
OpenPOWER on IntegriCloud