Debug helpers for BNX2X
[akaros.git] / user / parlib / spinlock.c
1 /* Copyright (c) 2013 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * Kevin Klues <klueska@cs.berkeley.edu>
4  *
5  * Spinlocks and Spin-PDR locks (preemption detection/recovery)
6  *
7  * This file is part of Parlib.
8  * 
9  * Parlib is free software: you can redistribute it and/or modify
10  * it under the terms of the Lesser GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  * 
14  * Parlib is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * Lesser GNU General Public License for more details.
18  * 
19  * See COPYING.LESSER for details on the GNU Lesser General Public License.
20  * See COPYING for details on the GNU General Public License. */
21
22 #include <stdlib.h>
23 #include <errno.h>
24 #include <assert.h>
25
26 #include <spinlock.h>
27 #include <vcore.h>
28 #include <uthread.h>
29
30 void spinlock_init(spinlock_t *lock)
31 {
32         lock->lock = 0;
33 }
34
35 int spinlock_trylock(spinlock_t *lock) 
36 {
37         if (lock->lock)
38                 return EBUSY;
39         return __sync_lock_test_and_set(&lock->lock, EBUSY);
40 }
41
42 void spinlock_lock(spinlock_t *lock) 
43 {
44         while (spinlock_trylock(lock))
45                 cpu_relax();
46 }
47
48 void spinlock_unlock(spinlock_t *lock) 
49 {
50         __sync_lock_release(&lock->lock, 0);
51 }
52
53 /* Two different versions, with and without CAS.  Default is with CAS. */
54 #ifndef CONFIG_SPINPDR_NO_CAS /* CAS version */
55
56 /* Spin-PRD locks (preemption detection/recovery).  Idea is to CAS and put the
57  * lockholder's vcoreid in the lock, and all spinners ensure that vcore runs. */
58 void spin_pdr_init(struct spin_pdr_lock *pdr_lock)
59 {
60         pdr_lock->lock = SPINPDR_UNLOCKED;
61 }
62
63 /* Internal version of the locking func, doesn't care if notifs are disabled */
64 void __spin_pdr_lock(struct spin_pdr_lock *pdr_lock)
65 {
66         uint32_t vcoreid = vcore_id();
67         uint32_t lock_val;
68         do {
69                 while ((lock_val = pdr_lock->lock) != SPINPDR_UNLOCKED) {
70                         ensure_vcore_runs(lock_val);
71                         cmb();
72                 }
73         } while (!atomic_cas_u32(&pdr_lock->lock, lock_val, vcoreid));
74         cmb();  /* just need a cmb, the CAS handles the CPU wmb/wrmb() */
75 }
76
77 void __spin_pdr_unlock(struct spin_pdr_lock *pdr_lock)
78 {
79         /* could make an arch-dependent 'release barrier' out of these */
80         wmb();  /* Need to prevent the compiler from reordering older stores. */
81         rwmb(); /* And no old reads passing either.   x86 makes both mbs a cmb() */
82         pdr_lock->lock = SPINPDR_UNLOCKED;
83 }
84
85 #else /* NON-CAS version */
86
87 /* Using regular spinlocks, with SPINPDR_VCOREID_UNKNOWN (-1) meaning 'no
88  * lockholder advertised yet'.  There are two spots where the lockholder still
89  * holds the lock but hasn't advertised its vcoreid, and in those cases we
90  * ensure all vcores aren't preempted (linear scan). */
91 void spin_pdr_init(struct spin_pdr_lock *pdr_lock)
92 {
93         spinlock_init(&pdr_lock->spinlock);
94         pdr_lock->lockholder = SPINPDR_VCOREID_UNKNOWN;
95 }
96
97 void __spin_pdr_lock(struct spin_pdr_lock *pdr_lock)
98 {
99         uint32_t vcoreid = vcore_id();
100         uint32_t ensure_tgt;
101         while (spinlock_trylock(&pdr_lock->spinlock)) {
102                 ensure_tgt = pdr_lock->lockholder;
103                 /* ensure will make sure *every* vcore runs if you pass it your self. */
104                 if (ensure_tgt == SPINPDR_VCOREID_UNKNOWN)
105                         ensure_tgt = vcoreid;
106                 ensure_vcore_runs(ensure_tgt);
107                 cpu_relax();
108         }
109         pdr_lock->lockholder = vcoreid;
110 }
111
112 void __spin_pdr_unlock(struct spin_pdr_lock *pdr_lock)
113 {
114         pdr_lock->lockholder = SPINPDR_VCOREID_UNKNOWN;
115         spinlock_unlock(&pdr_lock->spinlock);
116 }
117
118 #endif /* CONFIG_SPINPDR_NO_CAS */
119
120 void spin_pdr_lock(struct spin_pdr_lock *pdr_lock)
121 {
122         /* Disable notifs, if we're an _M uthread */
123         uth_disable_notifs();
124         __spin_pdr_lock(pdr_lock);
125 }
126
127 void spin_pdr_unlock(struct spin_pdr_lock *pdr_lock)
128 {
129         __spin_pdr_unlock(pdr_lock);
130         /* Enable notifs, if we're an _M uthread */
131         uth_enable_notifs();
132 }