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

Log when MAP_POPULATE gets disabled #28526

Merged
merged 14 commits into from
Oct 2, 2024
Merged

Conversation

digivava
Copy link
Collaborator

@digivava digivava commented Sep 26, 2024

Description

This PR adds a log line during the log store and FSM setup process that warns when Linux's MAP_POPULATE flag for mmap has been disabled. (That flag populates page tables ahead of time before we try to open a database file, which helps limit page faults and thus speeds up the process.)

Without this log message, the Vault process appears to hang for a long period of time while it tries to open up a large database. This log line will help warn users so they don't just think Vault is being broken and unresponsive.

Note that the unix.MAP_POPULATE flag is only available on Linux, so Go won't compile if I reference it in files that don't end in _linux.go, hence the slight gymnastics.

I've also added some comments to help noobs to these concepts like myself understand how this flag is used.

TODO only if you're a HashiCorp employee

  • [N/A] Backport Labels: If this PR is in the ENT repo and needs to be backported, backport
    to N, N-1, and N-2, using the backport/ent/x.x.x+ent labels. If this PR is in the CE repo, you should only backport to N, using the backport/x.x.x label, not the enterprise labels.
    • [N/A] If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • [N/A] RFC: If this change has an associated RFC, please link it in the description.
  • [N/A] ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

@digivava digivava added this to the 1.19.0-rc milestone Sep 26, 2024
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Sep 26, 2024
Copy link

github-actions bot commented Sep 26, 2024

CI Results:
All Go tests succeeded! ✅

Copy link

github-actions bot commented Sep 26, 2024

Build Results:
All builds succeeded! ✅

@@ -447,6 +451,7 @@ func NewRaftBackend(conf map[string]string, logger log.Logger) (physical.Backend
}
}

// Create the log store.
Copy link
Collaborator Author

@digivava digivava Sep 26, 2024

Choose a reason for hiding this comment

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

I added this to match the comment up above where we explain that we're creating the FSM. Helps people like me who are new to the concept that Vault has two different databases that need to be created.

@digivava digivava marked this pull request as draft September 27, 2024 22:23
@digivava digivava modified the milestones: 1.19.0-rc, 1.18.1 Sep 30, 2024
Copy link
Contributor

@raskchanky raskchanky left a comment

Choose a reason for hiding this comment

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

Looks good! Just a few small comments about one of the tests.

physical/raft/bolt_64bit_test.go Outdated Show resolved Hide resolved
physical/raft/bolt_64bit_test.go Outdated Show resolved Hide resolved
Copy link
Contributor

@raskchanky raskchanky left a comment

Choose a reason for hiding this comment

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

@digivava digivava modified the milestones: 1.19.0-rc, 1.18.1 Oct 2, 2024
@digivava digivava merged commit 53bb78c into main Oct 2, 2024
100 checks passed
@digivava digivava deleted the VAULT-23020/log_when_mmap_disabled branch October 2, 2024 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/ent/1.16.x+ent Changes are backported to 1.16.x+ent backport/1.17.x backport/1.18.x hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants