Skip to content

Commit ab66f2d

Browse files
shiroushirou
authored
Merge pull request #1764 from shirou/refactor/net_merge_base_functions
Refactor[net]: merge base functions to net.go
2 parents 9d7cedb + 69c2c10 commit ab66f2d

12 files changed

+182
-413
lines changed

‎Makefile

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ build_test: ## test only buildable
2727
GOOS=freebsd GOARCH=arm64 go test ./... | $(BUILD_FAIL_PATTERN)
2828
CGO_ENABLED=0 GOOS=darwin go test ./... | $(BUILD_FAIL_PATTERN)
2929
GOOS=windows go test ./... | $(BUILD_FAIL_PATTERN)
30-
# Operating systems supported for building only (not implemented error if used)
30+
# The following operating systems are tested only for successful builds.
31+
# Value testing is not performed.
3132
GOOS=solaris go test ./... | $(BUILD_FAIL_PATTERN)
3233
GOOS=dragonfly go test ./... | $(BUILD_FAIL_PATTERN)
3334
GOOS=netbsd go test ./... | $(BUILD_FAIL_PATTERN)
34-
# cross build to OpenBSD not worked since process has "C"
35-
# GOOS=openbsd go test ./... | $(BUILD_FAIL_PATTERN)
35+
GOOS=openbsd go test ./... | $(BUILD_FAIL_PATTERN)
3636
GOOS=plan9 go test ./... | $(BUILD_FAIL_PATTERN)
3737

3838
ifeq ($(shell uname -s), Darwin)

‎net/net.go

+82
Original file line numberDiff line numberDiff line change
@@ -272,3 +272,85 @@ func getIOCountersAll(n []IOCountersStat) ([]IOCountersStat, error) {
272272

273273
return []IOCountersStat{r}, nil
274274
}
275+
276+
// NetIOCounters returns network I/O statistics for every network
277+
// interface installed on the system. If pernic argument is false,
278+
// return only sum of all information (which name is 'all'). If true,
279+
// every network interface installed on the system is returned
280+
// separately.
281+
func IOCounters(pernic bool) ([]IOCountersStat, error) {
282+
return IOCountersWithContext(context.Background(), pernic)
283+
}
284+
285+
func IOCountersByFile(pernic bool, filename string) ([]IOCountersStat, error) {
286+
return IOCountersByFileWithContext(context.Background(), pernic, filename)
287+
}
288+
289+
// ProtoCounters returns network statistics for the entire system
290+
// If protocols is empty then all protocols are returned, otherwise
291+
// just the protocols in the list are returned.
292+
// Available protocols:
293+
// [ip,icmp,icmpmsg,tcp,udp,udplite]
294+
// Not Implemented for FreeBSD, Windows, OpenBSD, Darwin
295+
func ProtoCounters(protocols []string) ([]ProtoCountersStat, error) {
296+
return ProtoCountersWithContext(context.Background(), protocols)
297+
}
298+
299+
// NetFilterCounters returns iptables conntrack statistics
300+
// the currently in use conntrack count and the max.
301+
// If the file does not exist or is invalid it will return nil.
302+
func FilterCounters() ([]FilterStat, error) {
303+
return FilterCountersWithContext(context.Background())
304+
}
305+
306+
// ConntrackStats returns more detailed info about the conntrack table
307+
func ConntrackStats(percpu bool) ([]ConntrackStat, error) {
308+
return ConntrackStatsWithContext(context.Background(), percpu)
309+
}
310+
311+
// Return a list of network connections opened.
312+
func Connections(kind string) ([]ConnectionStat, error) {
313+
return ConnectionsWithContext(context.Background(), kind)
314+
}
315+
316+
// Return a list of network connections opened returning at most `max`
317+
// connections for each running process.
318+
func ConnectionsMax(kind string, maxConn int) ([]ConnectionStat, error) {
319+
return ConnectionsMaxWithContext(context.Background(), kind, maxConn)
320+
}
321+
322+
// Return a list of network connections opened, omitting `Uids`.
323+
// WithoutUids functions are reliant on implementation details. They may be altered to be an alias for Connections or be
324+
// removed from the API in the future.
325+
func ConnectionsWithoutUids(kind string) ([]ConnectionStat, error) {
326+
return ConnectionsWithoutUidsWithContext(context.Background(), kind)
327+
}
328+
329+
// Return a list of network connections opened by a process.
330+
func ConnectionsPid(kind string, pid int32) ([]ConnectionStat, error) {
331+
return ConnectionsPidWithContext(context.Background(), kind, pid)
332+
}
333+
334+
// Return a list of network connections opened, omitting `Uids`.
335+
// WithoutUids functions are reliant on implementation details. They may be altered to be an alias for Connections or be
336+
// removed from the API in the future.
337+
func ConnectionsPidWithoutUids(kind string, pid int32) ([]ConnectionStat, error) {
338+
return ConnectionsPidWithoutUidsWithContext(context.Background(), kind, pid)
339+
}
340+
341+
func ConnectionsPidMaxWithoutUids(kind string, pid int32, maxConn int) ([]ConnectionStat, error) {
342+
return ConnectionsPidMaxWithoutUidsWithContext(context.Background(), kind, pid, maxConn)
343+
}
344+
345+
// Return up to `max` network connections opened by a process.
346+
func ConnectionsPidMax(kind string, pid int32, maxConn int) ([]ConnectionStat, error) {
347+
return ConnectionsPidMaxWithContext(context.Background(), kind, pid, maxConn)
348+
}
349+
350+
// Pids retunres all pids.
351+
// Note: this is a copy of process_linux.Pids()
352+
// FIXME: Import process occures import cycle.
353+
// move to common made other platform breaking. Need consider.
354+
func Pids() ([]int32, error) {
355+
return PidsWithContext(context.Background())
356+
}

‎net/net_aix.go

+10-41
Original file line numberDiff line numberDiff line change
@@ -14,39 +14,23 @@ import (
1414
"github.com/shirou/gopsutil/v4/internal/common"
1515
)
1616

17-
func IOCounters(pernic bool) ([]IOCountersStat, error) {
18-
return IOCountersWithContext(context.Background(), pernic)
19-
}
20-
21-
// IOCountersByFile exists just for compatibility with Linux.
22-
func IOCountersByFile(pernic bool, filename string) ([]IOCountersStat, error) {
23-
return IOCountersByFileWithContext(context.Background(), pernic, filename)
17+
// Deprecated: use process.PidsWithContext instead
18+
func PidsWithContext(ctx context.Context) ([]int32, error) {
19+
return nil, common.ErrNotImplementedError
2420
}
2521

2622
func IOCountersByFileWithContext(ctx context.Context, pernic bool, filename string) ([]IOCountersStat, error) {
2723
return IOCounters(pernic)
2824
}
2925

30-
func FilterCounters() ([]FilterStat, error) {
31-
return FilterCountersWithContext(context.Background())
32-
}
33-
3426
func FilterCountersWithContext(ctx context.Context) ([]FilterStat, error) {
3527
return nil, common.ErrNotImplementedError
3628
}
3729

38-
func ConntrackStats(percpu bool) ([]ConntrackStat, error) {
39-
return ConntrackStatsWithContext(context.Background(), percpu)
40-
}
41-
4230
func ConntrackStatsWithContext(ctx context.Context, percpu bool) ([]ConntrackStat, error) {
4331
return nil, common.ErrNotImplementedError
4432
}
4533

46-
func ProtoCounters(protocols []string) ([]ProtoCountersStat, error) {
47-
return ProtoCountersWithContext(context.Background(), protocols)
48-
}
49-
5034
func ProtoCountersWithContext(ctx context.Context, protocols []string) ([]ProtoCountersStat, error) {
5135
return nil, common.ErrNotImplementedError
5236
}
@@ -250,10 +234,6 @@ func parseNetstatA(output string, kind string) ([]ConnectionStat, error) {
250234
return ret, nil
251235
}
252236

253-
func Connections(kind string) ([]ConnectionStat, error) {
254-
return ConnectionsWithContext(context.Background(), kind)
255-
}
256-
257237
func ConnectionsWithContext(ctx context.Context, kind string) ([]ConnectionStat, error) {
258238
args := []string{"-na"}
259239
switch strings.ToLower(kind) {
@@ -286,19 +266,8 @@ func ConnectionsWithContext(ctx context.Context, kind string) ([]ConnectionStat,
286266
return ret, nil
287267
}
288268

289-
func ConnectionsMax(kind string, maxConn int) ([]ConnectionStat, error) {
290-
return ConnectionsMaxWithContext(context.Background(), kind, maxConn)
291-
}
292-
293269
func ConnectionsMaxWithContext(ctx context.Context, kind string, maxConn int) ([]ConnectionStat, error) {
294-
return []ConnectionStat{}, common.ErrNotImplementedError
295-
}
296-
297-
// Return a list of network connections opened, omitting `Uids`.
298-
// WithoutUids functions are reliant on implementation details. They may be altered to be an alias for Connections or be
299-
// removed from the API in the future.
300-
func ConnectionsWithoutUids(kind string) ([]ConnectionStat, error) {
301-
return ConnectionsWithoutUidsWithContext(context.Background(), kind)
270+
return ConnectionsPidMaxWithContext(ctx, kind, 0, maxConn)
302271
}
303272

304273
func ConnectionsWithoutUidsWithContext(ctx context.Context, kind string) ([]ConnectionStat, error) {
@@ -309,22 +278,22 @@ func ConnectionsMaxWithoutUidsWithContext(ctx context.Context, kind string, maxC
309278
return ConnectionsPidMaxWithoutUidsWithContext(ctx, kind, 0, maxConn)
310279
}
311280

312-
func ConnectionsPidWithoutUids(kind string, pid int32) ([]ConnectionStat, error) {
313-
return ConnectionsPidWithoutUidsWithContext(context.Background(), kind, pid)
281+
func ConnectionsPidWithContext(ctx context.Context, kind string, pid int32) ([]ConnectionStat, error) {
282+
return ConnectionsPidMaxWithContext(ctx, kind, pid, 0)
314283
}
315284

316285
func ConnectionsPidWithoutUidsWithContext(ctx context.Context, kind string, pid int32) ([]ConnectionStat, error) {
317286
return ConnectionsPidMaxWithoutUidsWithContext(ctx, kind, pid, 0)
318287
}
319288

320-
func ConnectionsPidMaxWithoutUids(kind string, pid int32, maxConn int) ([]ConnectionStat, error) {
321-
return ConnectionsPidMaxWithoutUidsWithContext(context.Background(), kind, pid, maxConn)
289+
func ConnectionsPidMaxWithContext(ctx context.Context, kind string, pid int32, maxConn int) ([]ConnectionStat, error) {
290+
return connectionsPidMaxWithoutUidsWithContext(ctx, kind, pid, maxConn, false)
322291
}
323292

324293
func ConnectionsPidMaxWithoutUidsWithContext(ctx context.Context, kind string, pid int32, maxConn int) ([]ConnectionStat, error) {
325-
return connectionsPidMaxWithoutUidsWithContext(ctx, kind, pid, maxConn)
294+
return connectionsPidMaxWithoutUidsWithContext(ctx, kind, pid, maxConn, true)
326295
}
327296

328-
func connectionsPidMaxWithoutUidsWithContext(ctx context.Context, kind string, pid int32, maxConn int) ([]ConnectionStat, error) {
297+
func connectionsPidMaxWithoutUidsWithContext(ctx context.Context, kind string, pid int32, maxConn int, skipUids bool) ([]ConnectionStat, error) {
329298
return []ConnectionStat{}, common.ErrNotImplementedError
330299
}

‎net/net_darwin.go

+5-25
Original file line numberDiff line numberDiff line change
@@ -162,15 +162,16 @@ func (mapi mapInterfaceNameUsage) notTruncated() []string {
162162
return output
163163
}
164164

165+
// Deprecated: use process.PidsWithContext instead
166+
func PidsWithContext(ctx context.Context) ([]int32, error) {
167+
return nil, common.ErrNotImplementedError
168+
}
169+
165170
// example of `netstat -ibdnW` output on yosemite
166171
// Name Mtu Network Address Ipkts Ierrs Ibytes Opkts Oerrs Obytes Coll Drop
167172
// lo0 16384 <Link#1> 869107 0 169411755 869107 0 169411755 0 0
168173
// lo0 16384 ::1/128 ::1 869107 - 169411755 869107 - 169411755 - -
169174
// lo0 16384 127 127.0.0.1 869107 - 169411755 869107 - 169411755 - -
170-
func IOCounters(pernic bool) ([]IOCountersStat, error) {
171-
return IOCountersWithContext(context.Background(), pernic)
172-
}
173-
174175
func IOCountersWithContext(ctx context.Context, pernic bool) ([]IOCountersStat, error) {
175176
var (
176177
ret []IOCountersStat
@@ -253,39 +254,18 @@ func IOCountersWithContext(ctx context.Context, pernic bool) ([]IOCountersStat,
253254
return ret, nil
254255
}
255256

256-
// IOCountersByFile exists just for compatibility with Linux.
257-
func IOCountersByFile(pernic bool, filename string) ([]IOCountersStat, error) {
258-
return IOCountersByFileWithContext(context.Background(), pernic, filename)
259-
}
260-
261257
func IOCountersByFileWithContext(ctx context.Context, pernic bool, filename string) ([]IOCountersStat, error) {
262258
return IOCountersWithContext(ctx, pernic)
263259
}
264260

265-
func FilterCounters() ([]FilterStat, error) {
266-
return FilterCountersWithContext(context.Background())
267-
}
268-
269261
func FilterCountersWithContext(ctx context.Context) ([]FilterStat, error) {
270262
return nil, common.ErrNotImplementedError
271263
}
272264

273-
func ConntrackStats(percpu bool) ([]ConntrackStat, error) {
274-
return ConntrackStatsWithContext(context.Background(), percpu)
275-
}
276-
277265
func ConntrackStatsWithContext(ctx context.Context, percpu bool) ([]ConntrackStat, error) {
278266
return nil, common.ErrNotImplementedError
279267
}
280268

281-
// ProtoCounters returns network statistics for the entire system
282-
// If protocols is empty then all protocols are returned, otherwise
283-
// just the protocols in the list are returned.
284-
// Not Implemented for Darwin
285-
func ProtoCounters(protocols []string) ([]ProtoCountersStat, error) {
286-
return ProtoCountersWithContext(context.Background(), protocols)
287-
}
288-
289269
func ProtoCountersWithContext(ctx context.Context, protocols []string) ([]ProtoCountersStat, error) {
290270
return nil, common.ErrNotImplementedError
291271
}

‎net/net_fallback.go

+16-38
Original file line numberDiff line numberDiff line change
@@ -9,59 +9,37 @@ import (
99
"github.com/shirou/gopsutil/v4/internal/common"
1010
)
1111

12-
func IOCounters(pernic bool) ([]IOCountersStat, error) {
13-
return IOCountersWithContext(context.Background(), pernic)
14-
}
15-
1612
func IOCountersWithContext(ctx context.Context, pernic bool) ([]IOCountersStat, error) {
1713
return []IOCountersStat{}, common.ErrNotImplementedError
1814
}
1915

20-
func FilterCounters() ([]FilterStat, error) {
21-
return FilterCountersWithContext(context.Background())
16+
func IOCountersByFileWithContext(ctx context.Context, pernic bool, filename string) ([]IOCountersStat, error) {
17+
return IOCountersWithContext(ctx, pernic)
2218
}
2319

2420
func FilterCountersWithContext(ctx context.Context) ([]FilterStat, error) {
25-
return []FilterStat{}, common.ErrNotImplementedError
26-
}
27-
28-
func ConntrackStats(percpu bool) ([]ConntrackStat, error) {
29-
return ConntrackStatsWithContext(context.Background(), percpu)
21+
return nil, common.ErrNotImplementedError
3022
}
3123

3224
func ConntrackStatsWithContext(ctx context.Context, percpu bool) ([]ConntrackStat, error) {
3325
return nil, common.ErrNotImplementedError
3426
}
3527

36-
func ProtoCounters(protocols []string) ([]ProtoCountersStat, error) {
37-
return ProtoCountersWithContext(context.Background(), protocols)
38-
}
39-
4028
func ProtoCountersWithContext(ctx context.Context, protocols []string) ([]ProtoCountersStat, error) {
41-
return []ProtoCountersStat{}, common.ErrNotImplementedError
29+
return nil, common.ErrNotImplementedError
4230
}
4331

44-
func Connections(kind string) ([]ConnectionStat, error) {
45-
return ConnectionsWithContext(context.Background(), kind)
32+
// Deprecated: use process.PidsWithContext instead
33+
func PidsWithContext(ctx context.Context) ([]int32, error) {
34+
return nil, common.ErrNotImplementedError
4635
}
4736

4837
func ConnectionsWithContext(ctx context.Context, kind string) ([]ConnectionStat, error) {
4938
return []ConnectionStat{}, common.ErrNotImplementedError
5039
}
5140

52-
func ConnectionsMax(kind string, maxConn int) ([]ConnectionStat, error) {
53-
return ConnectionsMaxWithContext(context.Background(), kind, maxConn)
54-
}
55-
5641
func ConnectionsMaxWithContext(ctx context.Context, kind string, maxConn int) ([]ConnectionStat, error) {
57-
return []ConnectionStat{}, common.ErrNotImplementedError
58-
}
59-
60-
// Return a list of network connections opened, omitting `Uids`.
61-
// WithoutUids functions are reliant on implementation details. They may be altered to be an alias for Connections or be
62-
// removed from the API in the future.
63-
func ConnectionsWithoutUids(kind string) ([]ConnectionStat, error) {
64-
return ConnectionsWithoutUidsWithContext(context.Background(), kind)
42+
return ConnectionsPidMaxWithContext(ctx, kind, 0, maxConn)
6543
}
6644

6745
func ConnectionsWithoutUidsWithContext(ctx context.Context, kind string) ([]ConnectionStat, error) {
@@ -72,22 +50,22 @@ func ConnectionsMaxWithoutUidsWithContext(ctx context.Context, kind string, maxC
7250
return ConnectionsPidMaxWithoutUidsWithContext(ctx, kind, 0, maxConn)
7351
}
7452

75-
func ConnectionsPidWithoutUids(kind string, pid int32) ([]ConnectionStat, error) {
76-
return ConnectionsPidWithoutUidsWithContext(context.Background(), kind, pid)
77-
}
78-
7953
func ConnectionsPidWithoutUidsWithContext(ctx context.Context, kind string, pid int32) ([]ConnectionStat, error) {
8054
return ConnectionsPidMaxWithoutUidsWithContext(ctx, kind, pid, 0)
8155
}
8256

83-
func ConnectionsPidMaxWithoutUids(kind string, pid int32, maxConn int) ([]ConnectionStat, error) {
84-
return ConnectionsPidMaxWithoutUidsWithContext(context.Background(), kind, pid, maxConn)
57+
func ConnectionsPidWithContext(ctx context.Context, kind string, pid int32) ([]ConnectionStat, error) {
58+
return ConnectionsPidMaxWithContext(ctx, kind, pid, 0)
59+
}
60+
61+
func ConnectionsPidMaxWithContext(ctx context.Context, kind string, pid int32, maxConn int) ([]ConnectionStat, error) {
62+
return connectionsPidMaxWithoutUidsWithContext(ctx, kind, pid, maxConn, false)
8563
}
8664

8765
func ConnectionsPidMaxWithoutUidsWithContext(ctx context.Context, kind string, pid int32, maxConn int) ([]ConnectionStat, error) {
88-
return connectionsPidMaxWithoutUidsWithContext(ctx, kind, pid, maxConn)
66+
return connectionsPidMaxWithoutUidsWithContext(ctx, kind, pid, maxConn, true)
8967
}
9068

91-
func connectionsPidMaxWithoutUidsWithContext(ctx context.Context, kind string, pid int32, maxConn int) ([]ConnectionStat, error) {
69+
func connectionsPidMaxWithoutUidsWithContext(_ context.Context, _ string, _ int32, _ int, _ bool) ([]ConnectionStat, error) {
9270
return []ConnectionStat{}, common.ErrNotImplementedError
9371
}

0 commit comments

Comments
 (0)