config: add mmap read env alias (#4021)

This commit is contained in:
Zhengchao An
2026-06-28 23:24:24 +08:00
committed by GitHub
parent b37c8c6435
commit 8284e6a75c
5 changed files with 61 additions and 17 deletions
+35
View File
@@ -15,6 +15,7 @@
use crate::disk::{self, DiskAPI as _, DiskStore, FileReader, error::DiskError};
use crate::erasure::coding::{BitrotReader, BitrotWriterWrapper, CustomWriter};
use bytes::Bytes;
use rustfs_config::{DEFAULT_OBJECT_MMAP_READ_ENABLE, ENV_OBJECT_MMAP_READ_ENABLE, ENV_OBJECT_ZERO_COPY_ENABLE};
use rustfs_utils::HashAlgorithm;
use std::future::Future;
use std::io::{self, Cursor};
@@ -28,6 +29,14 @@ use tracing::debug;
type BoxedObjectReader = Box<dyn AsyncRead + Send + Sync + Unpin>;
type OpenObjectReaderFuture = Pin<Box<dyn Future<Output = disk::error::Result<Option<BoxedObjectReader>>> + Send>>;
pub(crate) fn object_mmap_read_enabled() -> bool {
rustfs_utils::get_env_bool_with_aliases(
ENV_OBJECT_MMAP_READ_ENABLE,
&[ENV_OBJECT_ZERO_COPY_ENABLE],
DEFAULT_OBJECT_MMAP_READ_ENABLE,
)
}
#[derive(Clone)]
struct BitrotReaderSource {
inline_data: Option<Bytes>,
@@ -295,6 +304,32 @@ pub async fn create_bitrot_writer(
mod tests {
use super::*;
#[test]
fn object_mmap_read_enabled_accepts_legacy_zero_copy_alias() {
temp_env::with_vars(
[
(ENV_OBJECT_MMAP_READ_ENABLE, None::<&str>),
(ENV_OBJECT_ZERO_COPY_ENABLE, Some("false")),
],
|| {
assert!(!object_mmap_read_enabled());
},
);
}
#[test]
fn object_mmap_read_enabled_prefers_canonical_env() {
temp_env::with_vars(
[
(ENV_OBJECT_MMAP_READ_ENABLE, Some("true")),
(ENV_OBJECT_ZERO_COPY_ENABLE, Some("false")),
],
|| {
assert!(object_mmap_read_enabled());
},
);
}
#[tokio::test]
async fn test_create_bitrot_reader_with_inline_data() {
let test_data = b"hello world test data";