Add support for smartpqi/arcconf RAID adapters on Linux

The smartpqi driver for Adaptec/Microsemi RAID controllers uses a cli
tool called `arcconf`.  Add support modeled after the existing
MegaRAID/storcli structures and implement the RAID Controller interface
introduced to abstract the specific RAID adapter for the linux system.

- Did not implement the Caching mechansim, repeated invocations do not
have any significant impact on system, 5 minute timeout seems quite long
to wait for RAID device changes which happen immediately after issuing
arcconf commands.

- Refactored how linux package looks up disks to see if they belong to
a RAID adapter to prevent import loops.

- Added tests for arcconf for the interface commands parsing output
collected from systems with smartpqi driver and card

- Added smartpqi to the demo program

Signed-off-by: Ryan Harper <ryaharpe@cisco.com>

demo/main.go

@@ -48,6 +48,7 @@ func main() {
 		Commands: []*cli.Command{
 			&diskCommands,
 			&megaraidCommands,
+			&smartpqiCommands,
 			&lvmCommands,
 			&miscCommands,
 		},

demo/smartpqi.go

@@ -0,0 +1,117 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"strconv"
+
+	"github.com/urfave/cli/v2"
+	"machinerun.io/disko/smartpqi"
+)
+
+//nolint:gochecknoglobals
+var smartpqiCommands = cli.Command{
+	Name:  "smartpqi",
+	Usage: "smartpqi / arcconf commands",
+	Subcommands: []*cli.Command{
+		{
+			Name:   "dump",
+			Usage:  "Dump information about smartpqi",
+			Action: smartpqiDump,
+		},
+		{
+			Name:   "disk-summary",
+			Usage:  "Show information about virtual devices on system",
+			Action: smartpqiDiskSummary,
+		},
+		{
+			Name:   "list-controllers",
+			Usage:  "Show the discovered controller IDs",
+			Action: smartpqiListControllers,
+		},
+	},
+}
+
+func smartpqiListControllers(c *cli.Context) error {
+	arc := smartpqi.ArcConf()
+	ctrls, err := arc.List()
+	if err != nil {
+		return fmt.Errorf("failed to list controllers: %s", err)
+	}
+
+	fmt.Printf("Found %d controllers.", len(ctrls))
+	for _, cID := range ctrls {
+		fmt.Printf("Controller ID: %d\n", cID)
+	}
+	return nil
+}
+
+func smartpqiDiskSummary(c *cli.Context) error {
+	var err error
+	var ctrlNum = 1
+	var ctrlArg = c.Args().First()
+
+	if ctrlArg != "" {
+		ctrlNum, err = strconv.Atoi(ctrlArg)
+		if err != nil {
+			return fmt.Errorf("could not convert to integer: %s", err)
+		}
+	}
+
+	arc := smartpqi.ArcConf()
+	ctrl, err := arc.Query(ctrlNum)
+
+	if err != nil {
+		return err
+	}
+
+	data := [][]string{{"Path", "Name", "DiskType", "RAID"}}
+
+	for _, ld := range ctrl.LogicalDrives {
+		stype := "HDD"
+
+		if ld.IsSSD() {
+			stype = "SSD"
+		}
+
+		name := ld.Name
+		if ld.Name == "" {
+			name = fmt.Sprintf("logicalid-%d", ld.ID)
+		}
+
+		data = append(data, []string{ld.DiskName, name, stype, ld.RAIDLevel})
+	}
+
+	printTextTable(data)
+
+	return nil
+}
+
+func smartpqiDump(c *cli.Context) error {
+	var err error
+	var ctrlNum = 1
+	var ctrlArg = c.Args().First()
+
+	if ctrlArg != "" {
+		ctrlNum, err = strconv.Atoi(ctrlArg)
+		if err != nil {
+			return fmt.Errorf("could not convert to integer: %s", err)
+		}
+	}
+
+	arc := smartpqi.ArcConf()
+	ctrl, err := arc.Query(ctrlNum)
+
+	if err != nil {
+		return err
+	}
+
+	jbytes, err := json.MarshalIndent(&ctrl, "", "  ")
+	if err != nil {
+		return err
+	}
+
+	fmt.Printf("%s\n", string(jbytes))
+
+	return nil
+}

go.mod

@@ -12,5 +12,4 @@ require (
 	github.com/stretchr/testify v1.8.2
 	github.com/urfave/cli/v2 v2.25.3
 	golang.org/x/sys v0.8.0
-	machinerun.io/disko v0.0.13 // indirect
 )

go.sum

@@ -634,8 +634,6 @@ honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWh
 honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg=
 honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k=
 honnef.co/go/tools v0.0.1-2020.1.4/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k=
-machinerun.io/disko v0.0.13 h1:1kkOorxGvLprdTSksh7fOsNK0WZ0Lq+4/ZQgPeuXnsY=
-machinerun.io/disko v0.0.13/go.mod h1:qorFih3sB8bmNcHWHyjXujgYfaugOjHj+s2GdK33+lk=
 rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8=
 rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
 rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=

linux/raidcontroller.go

@@ -6,6 +6,7 @@ type RAIDControllerType string
 
 const (
 	MegaRAIDControllerType RAIDControllerType = "megaraid"
+	SmartPqiControllerType RAIDControllerType = "smartpqi"
 )
 
 type RAIDController interface {

linux/system.go

@@ -13,6 +13,7 @@ import (
 	"golang.org/x/sys/unix"
 	"machinerun.io/disko"
 	"machinerun.io/disko/megaraid"
+	"machinerun.io/disko/smartpqi"
 )
 
 type linuxSystem struct {
@@ -24,6 +25,7 @@ func System() disko.System {
 	return &linuxSystem{
 		raidctrls: []RAIDController{
 			megaraid.CachingStorCli(),
+			smartpqi.ArcConf(),
 		},
 	}
 }

megaraid/linux.go

@@ -1,3 +1,3 @@
 package megaraid
 
-const sysDriverMegaRaidSAS = "/sys/bus/pci/drivers/megaraid_sas"
+const SysfsPCIDriversPath = "/sys/bus/pci/drivers/megaraid_sas"