// Copyright 2024 RustFS Team // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. use crate::MI_B; // Tokio runtime ENV keys pub const ENV_WORKER_THREADS: &str = "RUSTFS_RUNTIME_WORKER_THREADS"; pub const ENV_MAX_BLOCKING_THREADS: &str = "RUSTFS_RUNTIME_MAX_BLOCKING_THREADS"; pub const ENV_THREAD_PRINT_ENABLED: &str = "RUSTFS_RUNTIME_THREAD_PRINT_ENABLED"; pub const ENV_THREAD_STACK_SIZE: &str = "RUSTFS_RUNTIME_THREAD_STACK_SIZE"; pub const ENV_THREAD_KEEP_ALIVE: &str = "RUSTFS_RUNTIME_THREAD_KEEP_ALIVE"; pub const ENV_GLOBAL_QUEUE_INTERVAL: &str = "RUSTFS_RUNTIME_GLOBAL_QUEUE_INTERVAL"; pub const ENV_THREAD_NAME: &str = "RUSTFS_RUNTIME_THREAD_NAME"; pub const ENV_MAX_IO_EVENTS_PER_TICK: &str = "RUSTFS_RUNTIME_MAX_IO_EVENTS_PER_TICK"; pub const ENV_RNG_SEED: &str = "RUSTFS_RUNTIME_RNG_SEED"; /// Event polling interval pub const ENV_EVENT_INTERVAL: &str = "RUSTFS_RUNTIME_EVENT_INTERVAL"; // Dial9 Tokio Telemetry Configuration pub const ENV_RUNTIME_DIAL9_ENABLED: &str = "RUSTFS_RUNTIME_DIAL9_ENABLED"; pub const ENV_RUNTIME_DIAL9_OUTPUT_DIR: &str = "RUSTFS_RUNTIME_DIAL9_OUTPUT_DIR"; pub const ENV_RUNTIME_DIAL9_FILE_PREFIX: &str = "RUSTFS_RUNTIME_DIAL9_FILE_PREFIX"; pub const ENV_RUNTIME_DIAL9_MAX_FILE_SIZE: &str = "RUSTFS_RUNTIME_DIAL9_MAX_FILE_SIZE"; pub const ENV_RUNTIME_DIAL9_ROTATION_COUNT: &str = "RUSTFS_RUNTIME_DIAL9_ROTATION_COUNT"; /// Accepted but not honoured: dial9's S3 uploader depends on a vulnerable /// rustls-webpki. Setting this logs a warning. See rustfs/backlog#1157. pub const ENV_RUNTIME_DIAL9_S3_BUCKET: &str = "RUSTFS_RUNTIME_DIAL9_S3_BUCKET"; /// Accepted but not honoured; see [`ENV_RUNTIME_DIAL9_S3_BUCKET`]. pub const ENV_RUNTIME_DIAL9_S3_PREFIX: &str = "RUSTFS_RUNTIME_DIAL9_S3_PREFIX"; // Note: there are deliberately no task-dump knobs. dial9 only captures task // dumps for futures spawned through `dial9_tokio_telemetry::spawn`, and RustFS // spawns with `tokio::spawn` throughout, so the switch could never do anything. // Measured: 0 dumps via tokio::spawn vs 14709 via dial9::spawn on an identical // workload. See rustfs/backlog#1157 (D9-16). // Default values for Tokio runtime pub const DEFAULT_WORKER_THREADS: usize = 16; pub const DEFAULT_MAX_BLOCKING_THREADS: usize = 1024; pub const DEFAULT_THREAD_PRINT_ENABLED: bool = false; pub const DEFAULT_THREAD_STACK_SIZE: usize = MI_B; // 1 MiB pub const DEFAULT_THREAD_KEEP_ALIVE: u64 = 60; // seconds pub const DEFAULT_GLOBAL_QUEUE_INTERVAL: u32 = 31; pub const DEFAULT_THREAD_NAME: &str = "rustfs-worker"; pub const DEFAULT_MAX_IO_EVENTS_PER_TICK: usize = 1024; /// Event polling default (Tokio default 61) pub const DEFAULT_EVENT_INTERVAL: u32 = 61; pub const DEFAULT_RNG_SEED: Option = None; // None means random // Dial9 Tokio Telemetry Default values pub const DEFAULT_RUNTIME_DIAL9_ENABLED: bool = false; // Disabled by default pub const DEFAULT_RUNTIME_DIAL9_OUTPUT_DIR: &str = "/var/log/rustfs/telemetry"; pub const DEFAULT_RUNTIME_DIAL9_FILE_PREFIX: &str = "rustfs-tokio"; pub const DEFAULT_RUNTIME_DIAL9_MAX_FILE_SIZE: u64 = 100 * 1024 * 1024; // 100MB pub const DEFAULT_RUNTIME_DIAL9_ROTATION_COUNT: usize = 10; // Note: S3 bucket/prefix have no default; absence means upload is disabled (modeled as Option) /// Maximum transition workers used as a local fallback when runtime env is unset. pub const DEFAULT_TRANSITION_WORKERS_CAP: i64 = 16; /// Absolute upper bound for transition workers accepted from runtime env. pub const DEFAULT_TRANSITION_WORKERS_ABSOLUTE_MAX: i64 = 32; /// Default capacity for the transition queue. pub const DEFAULT_TRANSITION_QUEUE_CAPACITY: usize = 1000; /// Default send timeout for transition queue enqueue attempts, in milliseconds. pub const DEFAULT_TRANSITION_QUEUE_SEND_TIMEOUT_MS: usize = 100; /// Test-only fault injection env var that forces the immediate transition enqueue timeout path. pub const ENV_TEST_FORCE_IMMEDIATE_TRANSITION_ENQUEUE_TIMEOUT: &str = "RUSTFS_TEST_FORCE_IMMEDIATE_TRANSITION_ENQUEUE_TIMEOUT"; /// Test-only fault injection env var that forces a number of IAM bootstrap failures. pub const ENV_TEST_IAM_FAIL_INIT_ATTEMPTS: &str = "RUSTFS_TEST_IAM_FAIL_INIT_ATTEMPTS"; /// Test-only env var that overrides the deferred IAM retry interval in debug builds. pub const ENV_TEST_IAM_RETRY_INTERVAL_MS: &str = "RUSTFS_TEST_IAM_RETRY_INTERVAL_MS"; /// Runtime env var controlling the transition worker count. pub const ENV_TRANSITION_WORKERS: &str = "RUSTFS_MAX_TRANSITION_WORKERS"; /// Runtime env var controlling the absolute maximum transition workers. pub const ENV_TRANSITION_WORKERS_ABSOLUTE_MAX: &str = "RUSTFS_ABSOLUTE_MAX_WORKERS"; /// Runtime env var controlling the transition queue capacity. pub const ENV_TRANSITION_QUEUE_CAPACITY: &str = "RUSTFS_TRANSITION_QUEUE_CAPACITY"; /// Runtime env var controlling the transition queue send timeout in milliseconds. pub const ENV_TRANSITION_QUEUE_SEND_TIMEOUT_MS: &str = "RUSTFS_TRANSITION_QUEUE_SEND_TIMEOUT_MS"; // Allocator reclaim configuration pub const ENV_ALLOCATOR_RECLAIM_ENABLED: &str = "RUSTFS_ALLOCATOR_RECLAIM_ENABLED"; pub const ENV_ALLOCATOR_RECLAIM_INTERVAL_SECS: &str = "RUSTFS_ALLOCATOR_RECLAIM_INTERVAL_SECS"; pub const ENV_ALLOCATOR_RECLAIM_FORCE: &str = "RUSTFS_ALLOCATOR_RECLAIM_FORCE"; pub const ENV_ALLOCATOR_RECLAIM_IDLE_INTERVALS: &str = "RUSTFS_ALLOCATOR_RECLAIM_IDLE_INTERVALS"; pub const DEFAULT_ALLOCATOR_RECLAIM_ENABLED: bool = false; pub const DEFAULT_ALLOCATOR_RECLAIM_INTERVAL_SECS: u64 = 30; pub const DEFAULT_ALLOCATOR_RECLAIM_FORCE: bool = true; pub const DEFAULT_ALLOCATOR_RECLAIM_IDLE_INTERVALS: u64 = 3; // File page-cache reclaim configuration pub const ENV_OBJECT_FILE_CACHE_RECLAIM_WRITE_ENABLE: &str = "RUSTFS_OBJECT_FILE_CACHE_RECLAIM_WRITE_ENABLE"; pub const ENV_OBJECT_FILE_CACHE_RECLAIM_READ_ENABLE: &str = "RUSTFS_OBJECT_FILE_CACHE_RECLAIM_READ_ENABLE"; pub const ENV_OBJECT_FILE_CACHE_RECLAIM_THRESHOLD: &str = "RUSTFS_OBJECT_FILE_CACHE_RECLAIM_THRESHOLD"; pub const DEFAULT_OBJECT_FILE_CACHE_RECLAIM_WRITE_ENABLE: bool = false; pub const DEFAULT_OBJECT_FILE_CACHE_RECLAIM_READ_ENABLE: bool = true; pub const DEFAULT_OBJECT_FILE_CACHE_RECLAIM_THRESHOLD: usize = 4 * 1024 * 1024; /// Threshold for small object seek support in bytes. /// /// When an object response is smaller than this size, rustfs may provide /// in-memory seek support. Runtime GET logic also enforces a hard safety cap /// (`64 MiB`) to prevent large-download memory spikes even if this threshold /// is configured higher. /// /// Default is set to 10 MiB. pub const ENV_OBJECT_SEEK_SUPPORT_THRESHOLD: &str = "RUSTFS_OBJECT_SEEK_SUPPORT_THRESHOLD"; pub const DEFAULT_OBJECT_SEEK_SUPPORT_THRESHOLD: usize = 10 * 1024 * 1024; // Object data cache configuration /// Enables the in-memory object body cache, which serves whole-object GET /// responses without an erasure read. /// /// # Timing side channel /// /// A cache hit skips the erasure read, bitrot verification and decode, so it is /// reliably faster than a miss. Any principal authorized to read an object can /// therefore infer, by timing a single GET, whether *someone* read that object /// within the entry's lifetime (see `RUSTFS_OBJECT_DATA_CACHE_TTL_SECS` and /// `..._TIME_TO_IDLE_SECS`). /// /// This never crosses an authorization boundary — the probe requires read /// access to the exact bucket and object, checked before the cache is consulted /// — but it does disclose co-tenants' recent access patterns on objects the /// observer may already read. Leave the cache disabled where access-pattern /// confidentiality matters, such as a bucket shared read-only between competing /// tenants. Timing noise is not a viable mitigation: it would cost exactly the /// latency the cache exists to save. pub const ENV_OBJECT_DATA_CACHE_ENABLE: &str = "RUSTFS_OBJECT_DATA_CACHE_ENABLE"; pub const ENV_OBJECT_DATA_CACHE_MODE: &str = "RUSTFS_OBJECT_DATA_CACHE_MODE"; pub const ENV_OBJECT_DATA_CACHE_MAX_BYTES: &str = "RUSTFS_OBJECT_DATA_CACHE_MAX_BYTES"; pub const ENV_OBJECT_DATA_CACHE_MAX_MEMORY_PERCENT: &str = "RUSTFS_OBJECT_DATA_CACHE_MAX_MEMORY_PERCENT"; pub const ENV_OBJECT_DATA_CACHE_MAX_ENTRY_BYTES: &str = "RUSTFS_OBJECT_DATA_CACHE_MAX_ENTRY_BYTES"; pub const ENV_OBJECT_DATA_CACHE_TTL_SECS: &str = "RUSTFS_OBJECT_DATA_CACHE_TTL_SECS"; pub const ENV_OBJECT_DATA_CACHE_TIME_TO_IDLE_SECS: &str = "RUSTFS_OBJECT_DATA_CACHE_TIME_TO_IDLE_SECS"; pub const ENV_OBJECT_DATA_CACHE_MIN_FREE_MEMORY_PERCENT: &str = "RUSTFS_OBJECT_DATA_CACHE_MIN_FREE_MEMORY_PERCENT"; pub const ENV_OBJECT_DATA_CACHE_FILL_CONCURRENCY_PER_CPU: &str = "RUSTFS_OBJECT_DATA_CACHE_FILL_CONCURRENCY_PER_CPU"; pub const ENV_OBJECT_DATA_CACHE_FILL_CONCURRENCY_MAX: &str = "RUSTFS_OBJECT_DATA_CACHE_FILL_CONCURRENCY_MAX"; pub const ENV_OBJECT_DATA_CACHE_IDENTITY_KEYS_MAX: &str = "RUSTFS_OBJECT_DATA_CACHE_IDENTITY_KEYS_MAX";