-
Notifications
You must be signed in to change notification settings - Fork 549
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: support hardware watchdog timers
Only enabled when activated by config, disabled on shutdown/reboot Fixes #8284 Signed-off-by: Dmitry Sharshakov <dmitry.sharshakov@siderolabs.com> Signed-off-by: Dmitry Sharshakov <d3dx12.xx@gmail.com> Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
- Loading branch information
Showing
28 changed files
with
1,156 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
155 changes: 155 additions & 0 deletions
155
internal/app/machined/pkg/controllers/runtime/watchdog_timer.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| // This Source Code Form is subject to the terms of the Mozilla Public | ||
| // License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| // file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
|
|
||
| package runtime | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "syscall" | ||
| "time" | ||
| "unsafe" | ||
|
|
||
| "github.com/cosi-project/runtime/pkg/controller" | ||
| "github.com/cosi-project/runtime/pkg/safe" | ||
| "github.com/cosi-project/runtime/pkg/state" | ||
| "github.com/siderolabs/gen/optional" | ||
| "go.uber.org/zap" | ||
| "golang.org/x/sys/unix" | ||
|
|
||
| "github.com/siderolabs/talos/pkg/machinery/resources/runtime" | ||
| ) | ||
|
|
||
| // WatchdogTimerController watches v1alpha1.Config, creates/updates/deletes kernel module specs. | ||
| type WatchdogTimerController struct{} | ||
|
|
||
| // Name implements controller.Controller interface. | ||
| func (ctrl *WatchdogTimerController) Name() string { | ||
| return "runtime.WatchdogTimerController" | ||
| } | ||
|
|
||
| // Inputs implements controller.Controller interface. | ||
| func (ctrl *WatchdogTimerController) Inputs() []controller.Input { | ||
| return []controller.Input{ | ||
| { | ||
| Namespace: runtime.NamespaceName, | ||
| Type: runtime.WatchdogTimerConfigType, | ||
| ID: optional.Some(runtime.WatchdogTimerConfigID), | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // Outputs implements controller.Controller interface. | ||
| func (ctrl *WatchdogTimerController) Outputs() []controller.Output { | ||
| return nil | ||
| } | ||
|
|
||
| // Run implements controller.Controller interface. | ||
| // | ||
| //nolint:gocyclo | ||
| func (ctrl *WatchdogTimerController) Run(ctx context.Context, r controller.Runtime, logger *zap.Logger) error { | ||
| var ( | ||
| ticker *time.Ticker | ||
| tickerC <-chan time.Time | ||
| ) | ||
|
|
||
| tickerStop := func() { | ||
| if ticker == nil { | ||
| return | ||
| } | ||
|
|
||
| ticker.Stop() | ||
|
|
||
| ticker = nil | ||
| tickerC = nil | ||
| } | ||
|
|
||
| defer tickerStop() | ||
|
|
||
| var wd *os.File | ||
|
|
||
| wdClose := func() { | ||
| if wd == nil { | ||
| return | ||
| } | ||
|
|
||
| logger.Info("closing hardware watchdog", zap.String("path", wd.Name())) | ||
|
|
||
| // Magic close: make sure old watchdog won't trip after we close it | ||
| if _, err := wd.WriteString("V"); err != nil { | ||
| logger.Error("failed to send magic close to watchdog", zap.String("path", wd.Name())) | ||
| } | ||
|
|
||
| if err := wd.Close(); err != nil { | ||
| logger.Error("failed to close watchdog", zap.String("path", wd.Name())) | ||
| } | ||
|
|
||
| wd = nil | ||
| } | ||
|
|
||
| defer wdClose() | ||
|
|
||
| for { | ||
| select { | ||
| case <-ctx.Done(): | ||
| return nil | ||
| case <-tickerC: | ||
| if _, _, err := syscall.Syscall(syscall.SYS_IOCTL, wd.Fd(), unix.WDIOC_KEEPALIVE, 0); err != 0 { | ||
| return fmt.Errorf("failed to feed watchdog: %w", err) | ||
| } | ||
|
|
||
| continue | ||
| case <-r.EventCh(): | ||
| } | ||
|
|
||
| cfg, err := safe.ReaderGetByID[*runtime.WatchdogTimerConfig](ctx, r, runtime.WatchdogTimerConfigID) | ||
| if err != nil { | ||
| if !state.IsNotFoundError(err) { | ||
| return fmt.Errorf("error getting watchdog config: %w", err) | ||
| } | ||
| } | ||
|
|
||
| if cfg == nil { | ||
| tickerStop() | ||
| wdClose() | ||
| } else { | ||
| // close the watchdog if requested to use new one | ||
| if wd != nil && wd.Name() != cfg.TypedSpec().Device { | ||
| wdClose() | ||
| } | ||
|
|
||
| if wd == nil { | ||
| wd, err = os.OpenFile(cfg.TypedSpec().Device, syscall.O_RDWR, 0o600) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to open watchdog device: %s", err) | ||
| } | ||
|
|
||
| logger.Info("opened hardware watchdog", zap.String("path", cfg.TypedSpec().Device)) | ||
| } | ||
|
|
||
| timeout := int(cfg.TypedSpec().Timeout.Seconds()) | ||
|
|
||
| if _, _, err := syscall.Syscall(syscall.SYS_IOCTL, wd.Fd(), uintptr(unix.WDIOC_SETTIMEOUT), uintptr(unsafe.Pointer(&timeout))); err != 0 { | ||
| return fmt.Errorf("failed to set watchdog timeout: %w", err) | ||
| } | ||
|
|
||
| tickerStop() | ||
|
|
||
| // 3 pings per timeout should suffice in any case | ||
| feedInterval := cfg.TypedSpec().Timeout / 3 | ||
|
|
||
| ticker = time.NewTicker(feedInterval) | ||
| tickerC = ticker.C | ||
|
|
||
| if _, _, err := syscall.Syscall(syscall.SYS_IOCTL, wd.Fd(), uintptr(unix.WDIOC_KEEPALIVE), 0); err != 0 { | ||
| return fmt.Errorf("failed to feed watchdog: %w", err) | ||
| } | ||
|
|
||
| logger.Info("set hardware watchdog timeout", zap.Duration("timeout", cfg.TypedSpec().Timeout), zap.Duration("feed_interval", feedInterval)) | ||
| } | ||
|
|
||
| r.ResetRestartBackoff() | ||
| } | ||
| } |
84 changes: 84 additions & 0 deletions
84
internal/app/machined/pkg/controllers/runtime/watchdog_timer_config.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| // This Source Code Form is subject to the terms of the Mozilla Public | ||
| // License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| // file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
|
|
||
| package runtime | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/cosi-project/runtime/pkg/controller" | ||
| "github.com/cosi-project/runtime/pkg/safe" | ||
| "github.com/cosi-project/runtime/pkg/state" | ||
| "github.com/siderolabs/gen/optional" | ||
| "go.uber.org/zap" | ||
|
|
||
| "github.com/siderolabs/talos/pkg/machinery/resources/config" | ||
| "github.com/siderolabs/talos/pkg/machinery/resources/runtime" | ||
| ) | ||
|
|
||
| // WatchdogTimerConfigController generates configuration for watchdog timers. | ||
| type WatchdogTimerConfigController struct{} | ||
|
|
||
| // Name implements controller.Controller interface. | ||
| func (ctrl *WatchdogTimerConfigController) Name() string { | ||
| return "runtime.WatchdogTimerConfigController" | ||
| } | ||
|
|
||
| // Inputs implements controller.Controller interface. | ||
| func (ctrl *WatchdogTimerConfigController) Inputs() []controller.Input { | ||
| return []controller.Input{ | ||
| { | ||
| Namespace: config.NamespaceName, | ||
| Type: config.MachineConfigType, | ||
| ID: optional.Some(config.V1Alpha1ID), | ||
| Kind: controller.InputWeak, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // Outputs implements controller.Controller interface. | ||
| func (ctrl *WatchdogTimerConfigController) Outputs() []controller.Output { | ||
| return []controller.Output{ | ||
| { | ||
| Type: runtime.WatchdogTimerConfigType, | ||
| Kind: controller.OutputExclusive, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // Run implements controller.Controller interface. | ||
| func (ctrl *WatchdogTimerConfigController) Run(ctx context.Context, r controller.Runtime, logger *zap.Logger) (err error) { | ||
| for { | ||
| select { | ||
| case <-ctx.Done(): | ||
| return nil | ||
| case <-r.EventCh(): | ||
| } | ||
|
|
||
| cfg, err := safe.ReaderGetByID[*config.MachineConfig](ctx, r, config.V1Alpha1ID) | ||
| if err != nil && !state.IsNotFoundError(err) { | ||
| return fmt.Errorf("error getting machine config: %w", err) | ||
| } | ||
|
|
||
| r.StartTrackingOutputs() | ||
|
|
||
| if cfg != nil { | ||
| if watchdogConfig := cfg.Config().Runtime().WatchdogTimer(); watchdogConfig != nil { | ||
| if err = safe.WriterModify(ctx, r, runtime.NewWatchdogTimerConfig(), func(cfg *runtime.WatchdogTimerConfig) error { | ||
| cfg.TypedSpec().Device = watchdogConfig.Device() | ||
| cfg.TypedSpec().Timeout = watchdogConfig.Timeout() | ||
|
|
||
| return nil | ||
| }); err != nil { | ||
| return fmt.Errorf("error updating kmsg log config: %w", err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if err = safe.CleanupOutputs[*runtime.WatchdogTimerConfig](ctx, r); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| } |
60 changes: 60 additions & 0 deletions
60
internal/app/machined/pkg/controllers/runtime/watchdog_timer_config_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| // This Source Code Form is subject to the terms of the Mozilla Public | ||
| // License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| // file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
|
|
||
| package runtime_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/cosi-project/runtime/pkg/resource" | ||
| "github.com/cosi-project/runtime/pkg/resource/rtestutils" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/suite" | ||
|
|
||
| "github.com/siderolabs/talos/internal/app/machined/pkg/controllers/ctest" | ||
| runtimectrls "github.com/siderolabs/talos/internal/app/machined/pkg/controllers/runtime" | ||
| "github.com/siderolabs/talos/pkg/machinery/config/container" | ||
| runtimecfg "github.com/siderolabs/talos/pkg/machinery/config/types/runtime" | ||
| "github.com/siderolabs/talos/pkg/machinery/resources/config" | ||
| "github.com/siderolabs/talos/pkg/machinery/resources/runtime" | ||
| ) | ||
|
|
||
| type WatchdogTimerConfigSuite struct { | ||
| ctest.DefaultSuite | ||
| } | ||
|
|
||
| func TestWatchdogTimerConfigSuite(t *testing.T) { | ||
| suite.Run(t, new(WatchdogTimerConfigSuite)) | ||
| } | ||
|
|
||
| func (suite *WatchdogTimerConfigSuite) TestWatchdogTimerConfigNone() { | ||
| suite.Require().NoError(suite.Runtime().RegisterController(&runtimectrls.WatchdogTimerConfigController{})) | ||
|
|
||
| rtestutils.AssertNoResource[*runtime.WatchdogTimerConfig](suite.Ctx(), suite.T(), suite.State(), runtime.WatchdogTimerConfigID) | ||
| } | ||
|
|
||
| func (suite *WatchdogTimerConfigSuite) TestWatchdogTimerConfigMachineConfig() { | ||
| suite.Require().NoError(suite.Runtime().RegisterController(&runtimectrls.WatchdogTimerConfigController{})) | ||
|
|
||
| watchdogTimerConfig := &runtimecfg.WatchdogTimerV1Alpha1{ | ||
| WatchdogDevice: "/dev/watchdog0", | ||
| } | ||
|
|
||
| cfg, err := container.New(watchdogTimerConfig) | ||
| suite.Require().NoError(err) | ||
|
|
||
| suite.Require().NoError(suite.State().Create(suite.Ctx(), config.NewMachineConfig(cfg))) | ||
|
|
||
| rtestutils.AssertResources[*runtime.WatchdogTimerConfig](suite.Ctx(), suite.T(), suite.State(), []resource.ID{runtime.WatchdogTimerConfigID}, | ||
| func(cfg *runtime.WatchdogTimerConfig, asrt *assert.Assertions) { | ||
| asrt.Equal( | ||
| "/dev/watchdog0", | ||
| cfg.TypedSpec().Device, | ||
| ) | ||
| asrt.Equal( | ||
| runtimecfg.DefaultWatchdogTimeout, | ||
| cfg.TypedSpec().Timeout, | ||
| ) | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.