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

Fix VirtualizationWithContext() race in linux #951

Merged
merged 1 commit into from
Oct 11, 2020
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
26 changes: 19 additions & 7 deletions host/host_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package host
import (
"fmt"
"os"
"sync"
"testing"

"github.com/shirou/gopsutil/internal/common"
Expand Down Expand Up @@ -144,13 +145,24 @@ func TestTemperatureStat_String(t *testing.T) {
}

func TestVirtualization(t *testing.T) {
system, role, err := Virtualization()
skipIfNotImplementedErr(t, err)
if err != nil {
t.Errorf("Virtualization() failed, %v", err)
}

t.Logf("Virtualization(): %s, %s", system, role)
wg := sync.WaitGroup{}
testCount := 10
wg.Add(testCount)
for i := 0; i < testCount; i++ {
go func(j int) {
system, role, err := Virtualization()
wg.Done()
skipIfNotImplementedErr(t, err)
if err != nil {
t.Errorf("Virtualization() failed, %v", err)
}

if j == 9 {
t.Logf("Virtualization(): %s, %s", system, role)
}
}(i)
}
wg.Wait()
}

func TestKernelVersion(t *testing.T) {
Expand Down
52 changes: 41 additions & 11 deletions internal/common/common_linux.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"path/filepath"
"strconv"
"strings"
"sync"
"time"
)

Expand Down Expand Up @@ -110,16 +111,49 @@ func Virtualization() (string, string, error) {
return VirtualizationWithContext(context.Background())
}

var virtualizationCache map[string]string
type virtCache struct {
cache map[string]string
lock sync.Mutex
ok bool
}

func (v *virtCache) setValue(system, role string) {
v.lock.Lock()
defer v.lock.Unlock()
v.cache["system"] = system
v.cache["role"] = role
v.ok = true
}

func (v *virtCache) getValue() (string, string, bool) {
v.lock.Lock()
defer v.lock.Unlock()
return v.cache["system"], v.cache["role"], v.ok
}

var (
once sync.Once
virtualization *virtCache
)

func virtualizationCache() *virtCache {
once.Do(func() {
virtualization = &virtCache{
cache: make(map[string]string),
lock: sync.Mutex{},
ok: false,
}
})

return virtualization
}

func VirtualizationWithContext(ctx context.Context) (string, string, error) {
// if cached already, return from cache
if virtualizationCache != nil {
return virtualizationCache["system"], virtualizationCache["role"], nil
system, role, ok := virtualizationCache().getValue()
if ok {
return system, role, nil
}

var system string
var role string

filename := HostProc("xen")
if PathExists(filename) {
Expand Down Expand Up @@ -240,11 +274,7 @@ func VirtualizationWithContext(ctx context.Context) (string, string, error) {
}

// before returning for the first time, cache the system and role
virtualizationCache = map[string]string{
"system": system,
"role": role,
}

virtualizationCache().setValue(system, role)
return system, role, nil
}

Expand Down