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.

Sign up for GitHub

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

Jump to bottom

Make max_bytes_per_stream optional in config #474

Merged
merged 1 commit into from
Dec 12, 2023
Merged

Make max_bytes_per_stream optional in config #474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions deployment-examples/docker-compose/local-storage-cas.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,7 @@
"bytestream": {
"cas_stores": {
"main": "CAS_MAIN_STORE",
},
// According to https://github.com/grpc/grpc.github.io/issues/371 16KiB - 64KiB is optimal.
"max_bytes_per_stream": 64000, // 64kb.
}
}
}
}, {
Expand Down Expand Up @@ -91,9 +89,7 @@
"bytestream": {
"cas_stores": {
"main": "CAS_MAIN_STORE",
},
// According to https://github.com/grpc/grpc.github.io/issues/371 16KiB - 64KiB is optimal.
"max_bytes_per_stream": 64000, // 64kb.
}
}
}
}]
Expand Down
4 changes: 1 addition & 3 deletions deployment-examples/terraform/AWS/scripts/cas.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,7 @@
"bytestream": {
"cas_stores": {
"main": "CAS_S3_STORE",
},
// According to https://github.com/grpc/grpc.github.io/issues/371 16KiB - 64KiB is optimal.
"max_bytes_per_stream": 64000, // 64kb.
}
}
}
}]
Expand Down
4 changes: 1 addition & 3 deletions deployment-examples/terraform/GCP/module/scripts/browser_proxy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,7 @@
"bytestream": {
"cas_stores": {
"main": "CAS_STORE"
},
// According to https://github.com/grpc/grpc.github.io/issues/371 16KiB - 64KiB is optimal.
"max_bytes_per_stream": 64000 // 64kb.
}
}
}
}]
Expand Down
8 changes: 2 additions & 6 deletions deployment-examples/terraform/GCP/module/scripts/cas.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,7 @@
"bytestream": {
"cas_stores": {
"main": "CAS_STORE"
},
// According to https://github.com/grpc/grpc.github.io/issues/371 16KiB - 64KiB is optimal.
"max_bytes_per_stream": 64000 // 64kb.
}
}
}
}, {
Expand Down Expand Up @@ -139,9 +137,7 @@
"bytestream": {
"cas_stores": {
"main": "CAS_STORE"
},
// According to https://github.com/grpc/grpc.github.io/issues/371 16KiB - 64KiB is optimal.
"max_bytes_per_stream": 64000 // 64kb.
}
}
}
}]
Expand Down
5 changes: 1 addition & 4 deletions nativelink-config/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,7 @@ A very basic configuration that is a pure in-memory store is:
"bytestream": {
"cas_stores": {
"main": "CAS_MAIN_STORE",
},
// According to https://github.com/grpc/grpc.github.io/issues/371
// 16KiB - 64KiB is optimal.
"max_bytes_per_stream": 64000, // 64kb.
}
}
}
}]
Expand Down
4 changes: 1 addition & 3 deletions nativelink-config/examples/basic_cas.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,7 @@
"bytestream": {
"cas_stores": {
"main": "WORKER_FAST_SLOW_STORE",
},
// According to https://github.com/grpc/grpc.github.io/issues/371 16KiB - 64KiB is optimal.
"max_bytes_per_stream": 64000, // 64kb.
}
}
}
}, {
Expand Down
4 changes: 1 addition & 3 deletions nativelink-config/examples/filesystem_cas.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,9 +142,7 @@
"bytestream": {
"cas_stores": {
"main": "CAS_MAIN_STORE",
},
// According to https://github.com/grpc/grpc.github.io/issues/371 16KiB - 64KiB is optimal.
"max_bytes_per_stream": 64000, // 64kb.
}
}
}
}, {
Expand Down
4 changes: 1 addition & 3 deletions nativelink-config/examples/s3_backend_with_local_fast_cas.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,7 @@
"bytestream": {
"cas_stores": {
"main": "CAS_MAIN_STORE",
},
// According to https://github.com/grpc/grpc.github.io/issues/371 16KiB - 64KiB is optimal.
"max_bytes_per_stream": 64000, // 64kb.
}
}
}
}]
Expand Down
6 changes: 5 additions & 1 deletion nativelink-config/src/cas_server.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,11 @@ pub struct ByteStreamConfig {
pub cas_stores: HashMap<InstanceName, StoreRefName>,

/// Max number of bytes to send on each grpc stream chunk.
#[serde(deserialize_with = "convert_numeric_with_shellexpand")]
/// According to <https://github.com/grpc/grpc.github.io/issues/371>
/// 16KiB - 64KiB is optimal.
///
/// Defaults: 64KiB
#[serde(default, deserialize_with = "convert_numeric_with_shellexpand")]
pub max_bytes_per_stream: usize,

/// In the event a client disconnects while uploading a blob, we will hold
Expand Down
10 changes: 9 additions & 1 deletion nativelink-service/src/bytestream_server.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ use tracing::{enabled, error, info, Level};
/// If this value changes update the documentation in the config definition.
const DEFAULT_PERSIST_STREAM_ON_DISCONNECT_TIMEOUT: Duration = Duration::from_secs(60);

/// If this value changes update the documentation in the config definition.
const DEFAULT_MAX_BYTES_PER_STREAM: usize = 64 * 1024;

type ReadStream = Pin<Box<dyn Stream<Item = Result<ReadResponse, Status>> + Send + 'static>>;
type StoreUpdateFuture = Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'static>>;

Expand Down Expand Up @@ -170,9 +173,14 @@ impl ByteStreamServer {
.ok_or_else(|| make_input_err!("'cas_store': '{}' does not exist", store_name))?;
stores.insert(instance_name.to_string(), store);
}
let max_bytes_per_stream = if config.max_bytes_per_stream == 0 {
DEFAULT_MAX_BYTES_PER_STREAM
} else {
config.max_bytes_per_stream
};
Ok(ByteStreamServer {
stores,
max_bytes_per_stream: config.max_bytes_per_stream,
max_bytes_per_stream,
active_uploads: Arc::new(Mutex::new(HashMap::new())),
sleep_fn,
})
Expand Down
Loading