Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nixos/boot: add boot.tmp.useZram option #320917

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

luochen1990
Copy link
Contributor

@luochen1990 luochen1990 commented Jun 19, 2024

Description of changes

This PR provides an alternative option for the boot.tmp.useTmpfs setting, allowing a zram device to be used directly as /tmp.
In certain scenarios, this choice can be more effective than using zram as swap and waiting for tmpfs to trigger swap due to memory pressure. After all, the conditions for triggering swap are unrelated to the compression ratio of the content. In situations where it can be presupposed that the contents of the /tmp directory will have a higher compression ratio, the option provided by this PR will be an excellent solution.

Things done

Provide an option named boot.tmp.useZram, and related options named boot.tmp.zramSettings.*

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 24.11 Release Notes (or backporting 23.11 and 24.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` labels Jun 19, 2024
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Jun 19, 2024
@luochen1990 luochen1990 marked this pull request as ready for review June 19, 2024 03:53
@luochen1990 luochen1990 requested a review from dasJ as a code owner June 19, 2024 03:53
nixos/modules/system/boot/zram-as-tmp.nix Outdated Show resolved Hide resolved
example = "lzo-rle";
description = ''
The compression algorithm to use for the zram device,
or leave unspecified to keep the kernel default.
Copy link
Member

@FliegendeWurst FliegendeWurst Dec 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default is actually specified by us (not the kernel) as zstd.

@FliegendeWurst FliegendeWurst changed the title add option boot.tmp.useZram nixos/boot: add boot.tmp.useZram option Dec 31, 2024
};

zramSettings = {
zram-size = mkOption {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
zram-size = mkOption {
zram-size = lib.mkOption {

'';
};

compression-algorithm = mkOption {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
compression-algorithm = mkOption {
compression-algorithm = lib.mkOption {

'';
};

fs-type = mkOption {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
fs-type = mkOption {
fs-type = lib.mkOption {

'';
};

options = mkOption {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
options = mkOption {
options = lib.mkOption {


zramSettings = {
zram-size = mkOption {
type = types.str;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
type = types.str;
type = lib.types.str;

Same for other types

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants