1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
//
// Copyright 2014-2023 Cristian Maglie. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
//
package enumerator
// #cgo LDFLAGS: -framework CoreFoundation -framework IOKit
// #include <IOKit/IOKitLib.h>
// #include <CoreFoundation/CoreFoundation.h>
// #include <stdlib.h>
import "C"
import (
"errors"
"fmt"
"time"
"unsafe"
)
func nativeGetDetailedPortsList() ([]*PortDetails, error) {
var ports []*PortDetails
services, err := getAllServices("IOSerialBSDClient")
if err != nil {
return nil, &PortEnumerationError{causedBy: err}
}
for _, service := range services {
defer service.Release()
port, err := extractPortInfo(io_registry_entry_t(service))
if err != nil {
return nil, &PortEnumerationError{causedBy: err}
}
ports = append(ports, port)
}
return ports, nil
}
func extractPortInfo(service io_registry_entry_t) (*PortDetails, error) {
port := &PortDetails{}
// If called too early the port may still not be ready or fully enumerated
// so we retry 5 times before returning error.
for retries := 5; retries > 0; retries-- {
name, err := service.GetStringProperty("IOCalloutDevice")
if err == nil {
port.Name = name
break
}
if retries == 0 {
return nil, fmt.Errorf("error extracting port info from device: %w", err)
}
time.Sleep(50 * time.Millisecond)
}
port.IsUSB = false
validUSBDeviceClass := map[string]bool{
"IOUSBDevice": true,
"IOUSBHostDevice": true,
}
usbDevice := service
var searchErr error
for !validUSBDeviceClass[usbDevice.GetClass()] {
if usbDevice, searchErr = usbDevice.GetParent("IOService"); searchErr != nil {
break
}
}
if searchErr == nil {
// It's an IOUSBDevice
vid, _ := usbDevice.GetIntProperty("idVendor", C.kCFNumberSInt16Type)
pid, _ := usbDevice.GetIntProperty("idProduct", C.kCFNumberSInt16Type)
serialNumber, _ := usbDevice.GetStringProperty("USB Serial Number")
//product, _ := usbDevice.GetStringProperty("USB Product Name")
//manufacturer, _ := usbDevice.GetStringProperty("USB Vendor Name")
//fmt.Println(product + " - " + manufacturer)
port.IsUSB = true
port.VID = fmt.Sprintf("%04X", vid)
port.PID = fmt.Sprintf("%04X", pid)
port.SerialNumber = serialNumber
}
return port, nil
}
func getAllServices(serviceType string) ([]io_object_t, error) {
i, err := getMatchingServices(serviceMatching(serviceType))
if err != nil {
return nil, err
}
defer i.Release()
var services []io_object_t
tries := 0
for tries < 5 {
// Extract all elements from iterator
if service, ok := i.Next(); ok {
services = append(services, service)
continue
}
// If the list of services is empty or the iterator is still valid return the result
if len(services) == 0 || i.IsValid() {
return services, nil
}
// Otherwise empty the result and retry
for _, s := range services {
s.Release()
}
services = []io_object_t{}
i.Reset()
tries++
}
// Give up if the iteration continues to fail...
return nil, fmt.Errorf("IOServiceGetMatchingServices failed, data changed while iterating")
}
// serviceMatching create a matching dictionary that specifies an IOService class match.
func serviceMatching(serviceType string) C.CFMutableDictionaryRef {
t := C.CString(serviceType)
defer C.free(unsafe.Pointer(t))
return C.IOServiceMatching(t)
}
// getMatchingServices look up registered IOService objects that match a matching dictionary.
func getMatchingServices(matcher C.CFMutableDictionaryRef) (io_iterator_t, error) {
var i C.io_iterator_t
err := C.IOServiceGetMatchingServices(C.kIOMasterPortDefault, C.CFDictionaryRef(matcher), &i)
if err != C.KERN_SUCCESS {
return 0, fmt.Errorf("IOServiceGetMatchingServices failed (code %d)", err)
}
return io_iterator_t(i), nil
}
// CFStringRef
type cfStringRef C.CFStringRef
func cfStringCreateWithString(s string) cfStringRef {
c := C.CString(s)
defer C.free(unsafe.Pointer(c))
return cfStringRef(C.CFStringCreateWithCString(
C.kCFAllocatorDefault, c, C.kCFStringEncodingMacRoman))
}
func (ref cfStringRef) Release() {
C.CFRelease(C.CFTypeRef(ref))
}
// CFTypeRef
type cfTypeRef C.CFTypeRef
func (ref cfTypeRef) Release() {
C.CFRelease(C.CFTypeRef(ref))
}
// io_registry_entry_t
type io_registry_entry_t C.io_registry_entry_t
func (me *io_registry_entry_t) GetParent(plane string) (io_registry_entry_t, error) {
cPlane := C.CString(plane)
defer C.free(unsafe.Pointer(cPlane))
var parent C.io_registry_entry_t
err := C.IORegistryEntryGetParentEntry(C.io_registry_entry_t(*me), cPlane, &parent)
if err != 0 {
return 0, errors.New("No parent device available")
}
return io_registry_entry_t(parent), nil
}
func (me *io_registry_entry_t) CreateCFProperty(key string) (cfTypeRef, error) {
k := cfStringCreateWithString(key)
defer k.Release()
property := C.IORegistryEntryCreateCFProperty(C.io_registry_entry_t(*me), C.CFStringRef(k), C.kCFAllocatorDefault, 0)
if property == 0 {
return 0, errors.New("Property not found: " + key)
}
return cfTypeRef(property), nil
}
func (me *io_registry_entry_t) GetStringProperty(key string) (string, error) {
property, err := me.CreateCFProperty(key)
if err != nil {
return "", err
}
defer property.Release()
if ptr := C.CFStringGetCStringPtr(C.CFStringRef(property), 0); ptr != nil {
return C.GoString(ptr), nil
}
// in certain circumstances CFStringGetCStringPtr may return NULL
// and we must retrieve the string by copy
buff := make([]C.char, 1024)
if C.CFStringGetCString(C.CFStringRef(property), &buff[0], 1024, 0) != C.true {
return "", fmt.Errorf("Property '%s' can't be converted", key)
}
return C.GoString(&buff[0]), nil
}
func (me *io_registry_entry_t) GetIntProperty(key string, intType C.CFNumberType) (int, error) {
property, err := me.CreateCFProperty(key)
if err != nil {
return 0, err
}
defer property.Release()
var res int
if C.CFNumberGetValue((C.CFNumberRef)(property), intType, unsafe.Pointer(&res)) != C.true {
return res, fmt.Errorf("Property '%s' can't be converted or has been truncated", key)
}
return res, nil
}
func (me *io_registry_entry_t) Release() {
C.IOObjectRelease(C.io_object_t(*me))
}
func (me *io_registry_entry_t) GetClass() string {
class := make([]C.char, 1024)
C.IOObjectGetClass(C.io_object_t(*me), &class[0])
return C.GoString(&class[0])
}
// io_iterator_t
type io_iterator_t C.io_iterator_t
// IsValid checks if an iterator is still valid.
// Some iterators will be made invalid if changes are made to the
// structure they are iterating over. This function checks the iterator
// is still valid and should be called when Next returns zero.
// An invalid iterator can be Reset and the iteration restarted.
func (me *io_iterator_t) IsValid() bool {
return C.IOIteratorIsValid(C.io_iterator_t(*me)) == C.true
}
func (me *io_iterator_t) Reset() {
C.IOIteratorReset(C.io_iterator_t(*me))
}
func (me *io_iterator_t) Next() (io_object_t, bool) {
res := C.IOIteratorNext(C.io_iterator_t(*me))
return io_object_t(res), res != 0
}
func (me *io_iterator_t) Release() {
C.IOObjectRelease(C.io_object_t(*me))
}
// io_object_t
type io_object_t C.io_object_t
func (me *io_object_t) Release() {
C.IOObjectRelease(C.io_object_t(*me))
}
func (me *io_object_t) GetClass() string {
class := make([]C.char, 1024)
C.IOObjectGetClass(C.io_object_t(*me), &class[0])
return C.GoString(&class[0])
}
|