Skip to content

Commit 252dcbf

Browse files
shiroushirou
authored
Merge pull request #1768 from uubulb/darwin
refactor(darwin): optimize string allocation
2 parents bcd0c0a + 1f39525 commit 252dcbf

7 files changed

+98
-33
lines changed

‎cpu/cpu_darwin_arm64.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ func getFrequency() (float64, error) {
5555
break
5656
}
5757

58-
buf := make([]byte, 512)
59-
ioRegistryEntryGetName(service, &buf[0])
58+
buf := common.NewCStr(512)
59+
ioRegistryEntryGetName(service, buf)
6060

61-
if common.GoString(&buf[0]) == "pmgr" {
61+
if buf.GoString() == "pmgr" {
6262
pCoreRef := ioRegistryEntryCreateCFProperty(service, uintptr(pCorekey), common.KCFAllocatorDefault, common.KNilOptions)
6363
length := cfDataGetLength(uintptr(pCoreRef))
6464
data := cfDataGetBytePtr(uintptr(pCoreRef))

‎disk/disk_darwin.go

+9-7
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ package disk
55

66
import (
77
"context"
8+
"errors"
89
"fmt"
910
"unsafe"
1011

@@ -234,17 +235,17 @@ func (i *ioCounters) getDriveStat(d uint32) (*IOCountersStat, error) {
234235
key := i.cfStr(kIOBSDNameKey)
235236
defer i.cfRelease(uintptr(key))
236237
name := i.cfDictionaryGetValue(uintptr(props), uintptr(key))
237-
length := cfStringGetLength(uintptr(name)) + 1
238-
buf := make([]byte, length-1)
239-
cfStringGetCString(uintptr(name), &buf[0], length, common.KCFStringEncodingUTF8)
238+
239+
buf := common.NewCStr(cfStringGetLength(uintptr(name)))
240+
cfStringGetCString(uintptr(name), buf, buf.Length(), common.KCFStringEncodingUTF8)
240241

241242
stat, err := i.fillStat(parent)
242243
if err != nil {
243244
return nil, err
244245
}
245246

246247
if stat != nil {
247-
stat.Name = string(buf)
248+
stat.Name = buf.GoString()
248249
return stat, nil
249250
}
250251
return nil, nil
@@ -263,9 +264,10 @@ func (i *ioCounters) fillStat(d uint32) (*IOCountersStat, error) {
263264

264265
key := i.cfStr(kIOBlockStorageDriverStatisticsKey)
265266
defer i.cfRelease(uintptr(key))
267+
266268
v := i.cfDictionaryGetValue(uintptr(props), uintptr(key))
267269
if v == nil {
268-
return nil, fmt.Errorf("CFDictionaryGetValue failed")
270+
return nil, errors.New("CFDictionaryGetValue failed")
269271
}
270272

271273
var stat IOCountersStat
@@ -280,10 +282,10 @@ func (i *ioCounters) fillStat(d uint32) (*IOCountersStat, error) {
280282

281283
for key, off := range statstab {
282284
s := i.cfStr(key)
283-
defer i.cfRelease(uintptr(s))
284285
if num := i.cfDictionaryGetValue(uintptr(v), uintptr(s)); num != nil {
285-
i.cfNumberGetValue(uintptr(num), common.KCFNumberSInt64Type, uintptr(unsafe.Pointer(uintptr(unsafe.Pointer(&stat))+off)))
286+
i.cfNumberGetValue(uintptr(num), common.KCFNumberSInt64Type, uintptr(unsafe.Add(unsafe.Pointer(&stat), off)))
286287
}
288+
i.cfRelease(uintptr(s))
287289
}
288290

289291
return &stat, nil

‎internal/common/common_darwin.go

+40-2
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ type (
125125
IOServiceOpenFunc func(service, owningTask, connType uint32, connect *uint32) int
126126
IOServiceCloseFunc func(connect uint32) int
127127
IOIteratorNextFunc func(iterator uint32) uint32
128-
IORegistryEntryGetNameFunc func(entry uint32, name *byte) int
128+
IORegistryEntryGetNameFunc func(entry uint32, name CStr) int
129129
IORegistryEntryGetParentEntryFunc func(entry uint32, plane string, parent *uint32) int
130130
IORegistryEntryCreateCFPropertyFunc func(entry uint32, key, allocator uintptr, options uint32) unsafe.Pointer
131131
IORegistryEntryCreateCFPropertiesFunc func(entry uint32, properties unsafe.Pointer, allocator uintptr, options uint32) int
@@ -191,7 +191,7 @@ type (
191191
CFArrayGetValueAtIndexFunc func(theArray uintptr, index int32) unsafe.Pointer
192192
CFStringCreateMutableFunc func(alloc uintptr, maxLength int32) unsafe.Pointer
193193
CFStringGetLengthFunc func(theString uintptr) int32
194-
CFStringGetCStringFunc func(theString uintptr, buffer *byte, bufferSize int32, encoding uint32)
194+
CFStringGetCStringFunc func(theString uintptr, buffer CStr, bufferSize int32, encoding uint32)
195195
CFStringCreateWithCStringFunc func(alloc uintptr, cStr string, encoding uint32) unsafe.Pointer
196196
CFDataGetLengthFunc func(theData uintptr) int32
197197
CFDataGetBytePtrFunc func(theData uintptr) unsafe.Pointer
@@ -348,6 +348,44 @@ func (s *SMC) Close() error {
348348
return nil
349349
}
350350

351+
type CStr []byte
352+
353+
func NewCStr(length int32) CStr {
354+
return make(CStr, length)
355+
}
356+
357+
func (s CStr) Length() int32 {
358+
// Include null terminator to make CFStringGetCString properly functions
359+
return int32(len(s)) + 1
360+
}
361+
362+
func (s CStr) Ptr() *byte {
363+
if len(s) < 1 {
364+
return nil
365+
}
366+
367+
return &s[0]
368+
}
369+
370+
func (c CStr) Addr() uintptr {
371+
return uintptr(unsafe.Pointer(c.Ptr()))
372+
}
373+
374+
func (s CStr) GoString() string {
375+
if s == nil {
376+
return ""
377+
}
378+
379+
var length int
380+
for _, char := range s {
381+
if char == '\x00' {
382+
break
383+
}
384+
length++
385+
}
386+
return string(s[:length])
387+
}
388+
351389
// https://github.com/ebitengine/purego/blob/main/internal/strings/strings.go#L26
352390
func GoString(cStr *byte) string {
353391
if cStr == nil {

‎process/process_darwin.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -310,14 +310,14 @@ func (p *Process) ExeWithContext(ctx context.Context) (string, error) {
310310
}
311311
defer lib.Close()
312312

313-
buf := make([]byte, common.PROC_PIDPATHINFO_MAXSIZE)
314-
ret := procPidPath(p.Pid, uintptr(unsafe.Pointer(&buf[0])), common.PROC_PIDPATHINFO_MAXSIZE)
313+
buf := common.NewCStr(common.PROC_PIDPATHINFO_MAXSIZE)
314+
ret := procPidPath(p.Pid, buf.Addr(), common.PROC_PIDPATHINFO_MAXSIZE)
315315

316316
if ret <= 0 {
317317
return "", fmt.Errorf("unknown error: proc_pidpath returned %d", ret)
318318
}
319319

320-
return common.GoString(&buf[0]), nil
320+
return buf.GoString(), nil
321321
}
322322

323323
// sys/proc_info.h
@@ -339,6 +339,7 @@ func (p *Process) CwdWithContext(ctx context.Context) (string, error) {
339339
}
340340
defer lib.Close()
341341

342+
// Lock OS thread to ensure the errno does not change
342343
runtime.LockOSThread()
343344
defer runtime.UnlockOSThread()
344345

@@ -366,6 +367,8 @@ func procArgs(pid int32) ([]byte, int, error) {
366367
if err != nil {
367368
return nil, 0, err
368369
}
370+
371+
// The first 4 bytes indicate the number of arguments.
369372
nargs := procargs[:4]
370373
return procargs, int(binary.LittleEndian.Uint32(nargs)), nil
371374
}
@@ -434,8 +437,7 @@ func (p *Process) NumThreadsWithContext(ctx context.Context) (int32, error) {
434437
defer lib.Close()
435438

436439
var ti ProcTaskInfo
437-
const tiSize = int32(unsafe.Sizeof(ti))
438-
procPidInfo(p.Pid, common.PROC_PIDTASKINFO, 0, uintptr(unsafe.Pointer(&ti)), tiSize)
440+
procPidInfo(p.Pid, common.PROC_PIDTASKINFO, 0, uintptr(unsafe.Pointer(&ti)), int32(unsafe.Sizeof(ti)))
439441

440442
return int32(ti.Threadnum), nil
441443
}
@@ -448,8 +450,7 @@ func (p *Process) TimesWithContext(ctx context.Context) (*cpu.TimesStat, error)
448450
defer lib.Close()
449451

450452
var ti ProcTaskInfo
451-
const tiSize = int32(unsafe.Sizeof(ti))
452-
procPidInfo(p.Pid, common.PROC_PIDTASKINFO, 0, uintptr(unsafe.Pointer(&ti)), tiSize)
453+
procPidInfo(p.Pid, common.PROC_PIDTASKINFO, 0, uintptr(unsafe.Pointer(&ti)), int32(unsafe.Sizeof(ti)))
453454

454455
timescaleToNanoSeconds := getTimeScaleToNanoSeconds()
455456
ret := &cpu.TimesStat{
@@ -468,8 +469,7 @@ func (p *Process) MemoryInfoWithContext(ctx context.Context) (*MemoryInfoStat, e
468469
defer lib.Close()
469470

470471
var ti ProcTaskInfo
471-
const tiSize = int32(unsafe.Sizeof(ti))
472-
procPidInfo(p.Pid, common.PROC_PIDTASKINFO, 0, uintptr(unsafe.Pointer(&ti)), tiSize)
472+
procPidInfo(p.Pid, common.PROC_PIDTASKINFO, 0, uintptr(unsafe.Pointer(&ti)), int32(unsafe.Sizeof(ti)))
473473

474474
ret := &MemoryInfoStat{
475475
RSS: uint64(ti.Resident_size),

‎sensors/sensors_darwin.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ func TemperaturesWithContext(ctx context.Context) ([]TemperatureStat, error) {
2424
}
2525
defer smc.Close()
2626

27-
var temperatures []TemperatureStat
27+
temperatures := make([]TemperatureStat, 0, len(temperatureKeys))
2828
for _, key := range temperatureKeys {
2929
temperatures = append(temperatures, TemperatureStat{
3030
SensorKey: key,

‎sensors/sensors_darwin_arm64.go

+11-11
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,6 @@ func (ta *temperatureArm) getProductNames(system unsafe.Pointer) []string {
9494
cfStringGetLength := common.GetFunc[common.CFStringGetLengthFunc](ta.cf, common.CFStringGetLengthSym)
9595
cfStringGetCString := common.GetFunc[common.CFStringGetCStringFunc](ta.cf, common.CFStringGetCStringSym)
9696

97-
var names []string
98-
9997
ta.ioHIDEventSystemClientSetMatching(uintptr(system), uintptr(ta.sensors))
10098
matchingsrvs := ta.ioHIDEventSystemClientCopyServices(uintptr(system))
10199

@@ -110,18 +108,19 @@ func (ta *temperatureArm) getProductNames(system unsafe.Pointer) []string {
110108
str := ta.cfStr("Product")
111109
defer ta.cfRelease(uintptr(str))
112110

111+
names := make([]string, 0, count)
113112
for i = 0; i < count; i++ {
114113
sc := ta.cfArrayGetValueAtIndex(uintptr(matchingsrvs), i)
115114
name := ioHIDServiceClientCopyProperty(uintptr(sc), uintptr(str))
116115

117116
if name != nil {
118-
length := cfStringGetLength(uintptr(name)) + 1 // include null terminator
119-
buf := make([]byte, length) // allocate buffer with full length
120-
cfStringGetCString(uintptr(name), &buf[0], length, common.KCFStringEncodingUTF8)
117+
buf := common.NewCStr(cfStringGetLength(uintptr(name)))
118+
cfStringGetCString(uintptr(name), buf, buf.Length(), common.KCFStringEncodingUTF8)
121119

122-
names = append(names, string(buf[:length-1])) // remove null terminator
120+
names = append(names, buf.GoString())
123121
ta.cfRelease(uintptr(name))
124122
} else {
123+
// make sure the number of names and values are consistent
125124
names = append(names, "noname")
126125
}
127126
}
@@ -166,11 +165,17 @@ func (ta *temperatureArm) matching(page, usage int) {
166165
cfDictionaryCreate := common.GetFunc[common.CFDictionaryCreateFunc](ta.cf, common.CFDictionaryCreateSym)
167166

168167
pageNum := cfNumberCreate(common.KCFAllocatorDefault, common.KCFNumberIntType, uintptr(unsafe.Pointer(&page)))
168+
defer ta.cfRelease(uintptr(pageNum))
169+
169170
usageNum := cfNumberCreate(common.KCFAllocatorDefault, common.KCFNumberIntType, uintptr(unsafe.Pointer(&usage)))
171+
defer ta.cfRelease(uintptr(usageNum))
170172

171173
k1 := ta.cfStr("PrimaryUsagePage")
172174
k2 := ta.cfStr("PrimaryUsage")
173175

176+
defer ta.cfRelease(uintptr(k1))
177+
defer ta.cfRelease(uintptr(k2))
178+
174179
keys := []unsafe.Pointer{k1, k2}
175180
values := []unsafe.Pointer{pageNum, usageNum}
176181

@@ -180,11 +185,6 @@ func (ta *temperatureArm) matching(page, usage int) {
180185
ta.sensors = cfDictionaryCreate(common.KCFAllocatorDefault, &keys[0], &values[0], 2,
181186
kCFTypeDictionaryKeyCallBacks,
182187
kCFTypeDictionaryValueCallBacks)
183-
184-
ta.cfRelease(uintptr(pageNum))
185-
ta.cfRelease(uintptr(usageNum))
186-
ta.cfRelease(uintptr(k1))
187-
ta.cfRelease(uintptr(k2))
188188
}
189189

190190
func (ta *temperatureArm) cfStr(str string) unsafe.Pointer {

‎sensors/sensors_test.go

+25
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@
33
package sensors
44

55
import (
6+
"errors"
67
"fmt"
8+
"os"
79
"testing"
10+
11+
"github.com/shirou/gopsutil/v4/internal/common"
812
)
913

1014
func TestTemperatureStat_String(t *testing.T) {
@@ -19,3 +23,24 @@ func TestTemperatureStat_String(t *testing.T) {
1923
t.Errorf("TemperatureStat string is invalid, %v", fmt.Sprintf("%v", v))
2024
}
2125
}
26+
27+
func skipIfNotImplementedErr(t *testing.T, err error) {
28+
if errors.Is(err, common.ErrNotImplementedError) {
29+
t.Skip("not implemented")
30+
}
31+
}
32+
33+
func TestTemperatures(t *testing.T) {
34+
if os.Getenv("CI") != "" {
35+
t.Skip("Skip CI")
36+
}
37+
v, err := SensorsTemperatures()
38+
skipIfNotImplementedErr(t, err)
39+
if err != nil {
40+
t.Errorf("error %v", err)
41+
}
42+
if len(v) == 0 {
43+
t.Errorf("Could not get temperature %v", v)
44+
}
45+
t.Log(v)
46+
}

0 commit comments

Comments
 (0)