summaryrefslogtreecommitdiffstats
path: root/src/go/plugin/go.d/modules/smartctl/scan.go
blob: 58af0b0cad4d15579986d1f337923d3c2a157559 (plain)
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
// SPDX-License-Identifier: GPL-3.0-or-later

package smartctl

import (
	"errors"
	"fmt"
	"strings"

	"github.com/tidwall/gjson"
)

type scanDevice struct {
	name     string
	infoName string
	typ      string
	extra    bool // added via config "extra_devices"
}

func (s *scanDevice) key() string {
	return fmt.Sprintf("%s|%s", s.name, s.typ)
}

func (s *scanDevice) shortName() string {
	return strings.TrimPrefix(s.name, "/dev/")
}

func (s *Smartctl) scanDevices() (map[string]*scanDevice, error) {
	powerModeNever := s.NoCheckPowerMode == "never"

	var resp *gjson.Result
	var err error

	// Issue on Discord: https://discord.com/channels/847502280503590932/1261747175361347644/1261747175361347644
	// "sat" devices being identified as "scsi" with --scan, and then later
	// code attempts to validate the type by calling `smartctl` with the "scsi" type.
	// This validation can trigger unintended "Enabling discard_zeroes_data" messages in system logs (dmesg).
	// To address this specific issue we use `smartctl --scan-open` as a workaround.
	// This method reliably identifies device types.
	if powerModeNever {
		resp, err = s.exec.scanOpen()
	} else {
		resp, err = s.exec.scan()
	}
	if err != nil {
		return nil, fmt.Errorf("failed to scan devices: %v", err)
	}

	devices := make(map[string]*scanDevice)

	for _, d := range resp.Get("devices").Array() {
		dev := &scanDevice{
			name:     d.Get("name").String(),
			infoName: d.Get("info_name").String(),
			typ:      d.Get("type").String(), // guessed type when using '--scan' instead of '--scan-open'
		}

		if dev.name == "" || dev.typ == "" {
			s.Warningf("device info missing required fields (name: '%s', type: '%s'), skipping", dev.name, dev.typ)
			continue
		}

		if !s.deviceSr.MatchString(dev.infoName) {
			s.Debugf("device %s does not match selector, skipping it", dev.infoName)
			continue
		}

		if !powerModeNever {
			if dev.typ == "scsi" {
				// `smartctl --scan` attempts to guess the device type based on the path, but this can be unreliable.
				// Accurate device type information is crucial because we use the `--device` option to gather data.
				// Using the wrong type can lead to issues.
				// For example, using 'scsi' for 'sat' devices prevents `smartctl` from issuing the necessary ATA commands.
				d := scanDevice{name: dev.name, typ: "sat"}
				if _, ok := s.scannedDevices[d.key()]; ok {
					dev.typ = "sat"
				} else {
					resp, _ := s.exec.deviceInfo(dev.name, dev.typ, s.NoCheckPowerMode)
					if resp != nil && isExitStatusHasBit(resp, 2) {
						s.Debugf("changing device '%s' type 'scsi' -> 'sat'", dev.name)
						dev.typ = "sat"
					}
				}
			}
		}

		s.Debugf("smartctl scan found device '%s' type '%s' info_name '%s'", dev.name, dev.typ, dev.infoName)

		devices[dev.key()] = dev
	}

	s.Debugf("smartctl scan found %d devices", len(devices))

	for _, v := range s.ExtraDevices {
		if v.Name == "" || v.Type == "" {
			continue
		}
		dev := &scanDevice{name: v.Name, typ: v.Type, extra: true}
		if _, ok := devices[dev.key()]; !ok {
			devices[dev.key()] = dev
		}
	}

	if len(devices) == 0 {
		return nil, errors.New("no devices found during scan")
	}

	return devices, nil
}