Skip to content

Commit

Permalink
Backport of client: do not disable memory swappiness if kernel does n…
Browse files Browse the repository at this point in the history
…ot support it into release/1.3.x (#17670)

This pull request was automerged via backport-assistant
  • Loading branch information
hc-github-team-nomad-core committed Jun 22, 2023
1 parent 06e2f9e commit 88ba64d
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .changelog/17625.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
client: Fixed a bug where Nomad incorrectly wrote to memory swappiness cgroup on old kernels
```
24 changes: 24 additions & 0 deletions client/lib/cgutil/cgutil_linux.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"path/filepath"

"github.com/hashicorp/go-hclog"
"github.com/hashicorp/nomad/helper/pointer"
"github.com/hashicorp/nomad/helper/uuid"
"github.com/opencontainers/runc/libcontainer/cgroups"
lcc "github.com/opencontainers/runc/libcontainer/configs"
Expand Down Expand Up @@ -145,3 +146,26 @@ func CopyCpuset(source, destination string) error {

return nil
}

// MaybeDisableMemorySwappiness will disable memory swappiness, if that controller
// is available. Always the case for cgroups v2, but is not always the case on
// very old kernels with cgroups v1.
func MaybeDisableMemorySwappiness() *uint64 {
bypass := (*uint64)(nil)
zero := pointer.Of[uint64](0)

// cgroups v2 always set zero
if UseV2 {
return zero
}

// cgroups v1 detect if swappiness is supported by attempting to write to
// the nomad parent cgroup swappiness interface
e := &editor{fromRoot: "memory/nomad"}
err := e.write("memory.swappiness", "0")
if err != nil {
return bypass
}

return zero
}
9 changes: 9 additions & 0 deletions client/lib/cgutil/cgutil_linux_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,12 @@ func TestUtil_CopyCpuset(t *testing.T) {
require.Equal(t, "0-1", strings.TrimSpace(value))
})
}

func TestUtil_MaybeDisableMemorySwappiness(t *testing.T) {
ci.Parallel(t)

// will return 0 on any reasonable kernel (both cgroups v1 and v2)
value := MaybeDisableMemorySwappiness()
must.NotNil(t, value)
must.Eq(t, 0, *value)
}
5 changes: 2 additions & 3 deletions drivers/shared/executor/executor_linux.go
Original file line number Diff line number Diff line change
Expand Up @@ -703,9 +703,8 @@ func configureCgroups(cfg *lconfigs.Config, command *ExecCommand) error {
cfg.Cgroups.Resources.Memory = memHard * 1024 * 1024
cfg.Cgroups.Resources.MemoryReservation = memSoft * 1024 * 1024

// Disable swap to avoid issues on the machine
var memSwappiness uint64
cfg.Cgroups.Resources.MemorySwappiness = &memSwappiness
// Disable swap if possible, to avoid issues on the machine
cfg.Cgroups.Resources.MemorySwappiness = cgutil.MaybeDisableMemorySwappiness()
}

cpuShares := res.Cpu.CpuShares
Expand Down

0 comments on commit 88ba64d

Please sign in to comment.