summaryrefslogtreecommitdiffhomepage
path: root/pkg/sentry
diff options
context:
space:
mode:
authorAdin Scannell <ascannell@google.com>2020-02-10 12:06:06 -0800
committergVisor bot <gvisor-bot@google.com>2020-02-10 12:08:32 -0800
commitc9a18b16ade6ec0bc90fc75d0a4ab0621f9d01d6 (patch)
tree9d75a1fc29bd81d24b92955113d6f5936591465e /pkg/sentry
parentbfa0bba72abb69cbc7f4da27d3b4b116c3784495 (diff)
Document MinimumTotalMemoryBytes.
PiperOrigin-RevId: 294273559
Diffstat (limited to 'pkg/sentry')
-rw-r--r--pkg/sentry/usage/memory.go4
1 files changed, 4 insertions, 0 deletions
diff --git a/pkg/sentry/usage/memory.go b/pkg/sentry/usage/memory.go
index 538c645eb..4320ad17f 100644
--- a/pkg/sentry/usage/memory.go
+++ b/pkg/sentry/usage/memory.go
@@ -253,6 +253,10 @@ func (m *MemoryLocked) Copy() (MemoryStats, uint64) {
}
// MinimumTotalMemoryBytes is the minimum reported total system memory.
+//
+// This can be configured through options provided to the Sentry at start.
+// This number is purely synthetic. This is only set before the application
+// starts executing, and must not be modified.
var MinimumTotalMemoryBytes uint64 = 2 << 30 // 2 GB
// TotalMemory returns the "total usable memory" available.