Skip to content

Commit

Permalink
sync: don't use volatile in Mutex
Browse files Browse the repository at this point in the history
Volatile loads/stors are only useful for communication with interrupts
or for memory-mapped I/O. They do not provide any sort of safety for
sync.Mutex, while making it *appear* as if it is more safe.

  * `sync.Mutex` cannot be used safely inside interrupts, because any
    blocking calls (including `Lock`) will cause a runtime panic.
  * For multithreading, `volatile` is also the wrong choice. Atomic
    operations should be used instead, and the current code would not
    work for multithreaded programs anyway.
  • Loading branch information
aykevl committed Oct 28, 2024
1 parent 9151326 commit 76d5b3d
Showing 1 changed file with 6 additions and 23 deletions.
29 changes: 6 additions & 23 deletions src/sync/mutex.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,37 @@ package sync
import (
"internal/task"
_ "unsafe"

"runtime/volatile"
)

type Mutex struct {
state uint8 // Set to non-zero if locked.
locked bool
blocked task.Stack
}

//go:linkname scheduleTask runtime.runqueuePushBack
func scheduleTask(*task.Task)

func (m *Mutex) Lock() {
if m.islocked() {
if m.locked {
// Push self onto stack of blocked tasks, and wait to be resumed.
m.blocked.Push(task.Current())
task.Pause()
return
}

m.setlock(true)
m.locked = true
}

func (m *Mutex) Unlock() {
if !m.islocked() {
if !m.locked {
panic("sync: unlock of unlocked Mutex")
}

// Wake up a blocked task, if applicable.
if t := m.blocked.Pop(); t != nil {
scheduleTask(t)
} else {
m.setlock(false)
m.locked = false
}
}

Expand All @@ -45,28 +43,13 @@ func (m *Mutex) Unlock() {
// and use of TryLock is often a sign of a deeper problem
// in a particular use of mutexes.
func (m *Mutex) TryLock() bool {
if m.islocked() {
if m.locked {
return false
}
m.Lock()
return true
}

func (m *Mutex) islocked() bool {
return volatile.LoadUint8(&m.state) != 0
}

func (m *Mutex) setlock(b bool) {
volatile.StoreUint8(&m.state, boolToU8(b))
}

func boolToU8(b bool) uint8 {
if b {
return 1
}
return 0
}

type RWMutex struct {
// waitingWriters are all of the tasks waiting for write locks.
waitingWriters task.Stack
Expand Down

0 comments on commit 76d5b3d

Please sign in to comment.