aboutsummaryrefslogtreecommitdiff
path: root/sys/sys/seqc.h
blob: 00e4cc3cc85047ec6322bb19dec4032c72276001 (plain) (blame)
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
/*-
 * Copyright (c) 2014 Mateusz Guzik <mjg@FreeBSD.org>
 *
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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$
 */

#ifndef _SYS_SEQC_H_
#define _SYS_SEQC_H_

#ifdef _KERNEL
#include <sys/systm.h>
#endif
#include <sys/types.h>

/*
 * seqc_t may be included in structs visible to userspace
 */
typedef uint32_t seqc_t;

#ifdef _KERNEL

/* A hack to get MPASS macro */
#include <sys/lock.h>

#include <machine/cpu.h>

static __inline bool
seqc_in_modify(seqc_t seqcp)
{

	return (seqcp & 1);
}

static __inline void
seqc_write_begin(seqc_t *seqcp)
{

	critical_enter();
	MPASS(!seqc_in_modify(*seqcp));
	*seqcp += 1;
	atomic_thread_fence_rel();
}

static __inline void
seqc_write_end(seqc_t *seqcp)
{

	atomic_store_rel_int(seqcp, *seqcp + 1);
	MPASS(!seqc_in_modify(*seqcp));
	critical_exit();
}

static __inline seqc_t
seqc_read(const seqc_t *seqcp)
{
	seqc_t ret;

	for (;;) {
		ret = atomic_load_acq_int(__DECONST(seqc_t *, seqcp));
		if (__predict_false(seqc_in_modify(ret))) {
			cpu_spinwait();
			continue;
		}
		break;
	}

	return (ret);
}

static __inline bool
seqc_consistent_nomb(const seqc_t *seqcp, seqc_t oldseqc)
{

	return (*seqcp == oldseqc);
}

static __inline bool
seqc_consistent(const seqc_t *seqcp, seqc_t oldseqc)
{

	atomic_thread_fence_acq();
	return (seqc_consistent_nomb(seqcp, oldseqc));
}

#endif	/* _KERNEL */
#endif	/* _SYS_SEQC_H_ */