Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Trylock #3983

Merged
merged 1 commit into from
Jan 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 35 additions & 5 deletions src/sync/mutex.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,68 @@ package sync
import (
"internal/task"
_ "unsafe"

"runtime/volatile"
)

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

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

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

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

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

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

// TryLock tries to lock m and reports whether it succeeded.
//
// Note that while correct uses of TryLock do exist, they are rare,
// 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() {
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 {
Expand Down
36 changes: 36 additions & 0 deletions src/sync/mutex_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,42 @@ import (
"testing"
)

func HammerMutex(m *sync.Mutex, loops int, cdone chan bool) {
for i := 0; i < loops; i++ {
if i%3 == 0 {
if m.TryLock() {
m.Unlock()
}
continue
}
m.Lock()
m.Unlock()
}
cdone <- true
}

func TestMutex(t *testing.T) {
m := new(sync.Mutex)

m.Lock()
if m.TryLock() {
t.Fatalf("TryLock succeeded with mutex locked")
}
m.Unlock()
if !m.TryLock() {
t.Fatalf("TryLock failed with mutex unlocked")
}
m.Unlock()

c := make(chan bool)
for i := 0; i < 10; i++ {
go HammerMutex(m, 1000, c)
}
for i := 0; i < 10; i++ {
<-c
}
}

// TestMutexUncontended tests locking and unlocking a Mutex that is not shared with any other goroutines.
func TestMutexUncontended(t *testing.T) {
var mu sync.Mutex
Expand Down
Loading