1use anyhow::{Result, ensure};
2use serde::{Deserialize, Serialize};
3
4#[derive(Clone, Debug, Deserialize, Serialize)]
5#[serde(rename_all = "camelCase", deny_unknown_fields)]
6pub struct Source {
7 pub uri: String,
8 #[serde(default, skip_serializing_if = "Option::is_none")]
9 pub etag: Option<String>,
10 #[serde(default, skip_serializing_if = "Option::is_none")]
11 pub size_bytes: Option<u64>,
12 #[serde(default, skip_serializing_if = "Option::is_none")]
13 pub rows: Option<usize>,
14}
15#[derive(Clone, Debug, Deserialize, Serialize, Default)]
17#[serde(rename_all = "camelCase", deny_unknown_fields)]
18pub struct Storage {
19 #[serde(default, skip_serializing_if = "Option::is_none")]
20 pub base_url: Option<String>,
21 #[serde(default, skip_serializing_if = "Option::is_none")]
22 pub region: Option<String>,
23 #[serde(default, skip_serializing_if = "Option::is_none")]
24 pub access_key_id: Option<String>,
25 #[serde(default, skip_serializing_if = "Option::is_none")]
26 pub secret_access_key: Option<String>,
27 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
28 pub virtual_hosted_style_request: bool,
29}
30impl Storage {
31 pub fn without_credentials(&self) -> Self {
32 Self {
33 access_key_id: None,
34 secret_access_key: None,
35 ..self.clone()
36 }
37 }
38}
39#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
40#[serde(deny_unknown_fields)]
41pub struct Field {
42 pub name: String,
43 pub from: String,
44 pub dtype: String,
45 #[serde(default, skip_serializing_if = "Option::is_none")]
46 pub length: Option<usize>,
47 #[serde(default, skip_serializing_if = "Option::is_none")]
48 pub shape: Option<Vec<usize>>,
49 #[serde(default, skip_serializing_if = "Option::is_none")]
50 pub pad: Option<serde_json::Value>,
51}
52impl Field {
53 pub fn dimensions(&self) -> Vec<usize> {
54 self.shape
55 .clone()
56 .unwrap_or_else(|| self.length.into_iter().collect())
57 }
58 pub fn width(&self) -> usize {
59 self.dimensions().iter().product()
60 }
61}
62#[derive(Clone, Debug, Deserialize, Serialize)]
65#[serde(rename_all = "camelCase", deny_unknown_fields)]
66pub struct Group {
67 #[serde(default, skip_serializing_if = "Option::is_none")]
68 pub encoding: Option<String>,
69 #[serde(default, skip_serializing_if = "Option::is_none")]
70 pub fields: Option<Vec<Field>>,
71 #[serde(default, skip_serializing_if = "Vec::is_empty")]
72 pub files: Vec<Source>,
73 #[serde(default, skip_serializing_if = "Option::is_none")]
74 pub manifest_uri: Option<String>,
75 #[serde(default, skip_serializing_if = "Option::is_none")]
76 pub split: Option<String>,
77 #[serde(default, skip_serializing_if = "Vec::is_empty")]
78 pub curriculum_stages: Vec<String>,
79 #[serde(default, skip_serializing_if = "Option::is_none")]
80 pub weight: Option<f64>,
81}
82#[derive(Clone, Debug, Deserialize, Serialize)]
83#[serde(rename_all = "camelCase", deny_unknown_fields)]
84pub struct Shuffle {
85 pub buffer_rows: usize,
86}
87#[derive(Clone, Debug, Deserialize, Serialize)]
88#[serde(rename_all = "camelCase", deny_unknown_fields)]
89pub struct Stage {
90 #[serde(default, skip_serializing_if = "Option::is_none")]
91 pub encoding: Option<String>,
92 pub sources: Vec<Group>,
93 pub batch_size: usize,
94 #[serde(default, skip_serializing_if = "Option::is_none")]
95 pub shuffle: Option<Shuffle>,
96 pub infinite: bool,
97 #[serde(default)]
98 pub drop_last: bool,
99}
100#[derive(Clone, Debug, Deserialize, Serialize)]
101#[serde(rename_all = "camelCase", deny_unknown_fields)]
102pub struct Config {
103 #[serde(default)]
104 pub storage: Storage,
105 pub stages: Vec<Stage>,
106 pub fields: Vec<Field>,
107 pub seed: u64,
108 pub rank: u64,
109 pub world_size: u64,
110 pub threads: usize,
111 pub prefetch_batches: usize,
112 #[serde(default = "lookahead")]
113 pub lookahead: usize,
114 #[serde(default, skip_serializing_if = "Option::is_none")]
115 pub memory_limit_bytes: Option<u64>,
116 #[serde(default = "record_limit")]
117 pub max_record_bytes: usize,
118 #[serde(default = "row_group_limit")]
119 pub max_row_group_bytes: usize,
120 #[serde(default = "row_limit")]
121 pub max_shard_rows: usize,
122}
123fn lookahead() -> usize {
124 2
125}
126fn record_limit() -> usize {
127 4 * 1024 * 1024
128}
129fn row_group_limit() -> usize {
130 64 * 1024 * 1024
131}
132fn row_limit() -> usize {
133 65536
134}
135impl Config {
136 pub fn memory_limit(&self) -> Result<u64> {
137 if let Some(limit) = self.memory_limit_bytes {
138 return Ok(limit);
139 }
140 let pages = unsafe { libc::sysconf(libc::_SC_PHYS_PAGES) };
141 let page_size = unsafe { libc::sysconf(libc::_SC_PAGESIZE) };
142 ensure!(
143 pages > 0 && page_size > 0,
144 "cannot read host physical memory"
145 );
146 Ok(((pages as u128 * page_size as u128) / 2).try_into()?)
147 }
148 pub fn memory_bound(&self) -> Result<u64> {
149 let groups: Vec<_> = self.stages.iter().flat_map(|s| &s.sources).collect();
150 let row: u128 = self
151 .fields
152 .iter()
153 .map(|f| f.width() as u128 * if f.dtype == "i64" { 8 } else { 4 })
154 .sum();
155 let metadata = std::iter::once(&self.fields)
156 .chain(groups.iter().filter_map(|g| g.fields.as_ref()))
157 .map(|fields| {
158 fields
159 .iter()
160 .map(|f| (4096 + f.name.len() + f.from.len()) as u128)
161 .sum::<u128>()
162 })
163 .max()
164 .unwrap_or(0);
165 let rows = groups
166 .iter()
167 .flat_map(|g| &g.files)
168 .map(|f| f.rows.unwrap_or(self.max_shard_rows))
169 .max()
170 .unwrap_or(0) as u128;
171 let batch_rows = self.stages.iter().map(|s| s.batch_size).max().unwrap_or(0) as u128;
172 let batch = (row + 128) * batch_rows + metadata;
173 let shuffle = self
174 .stages
175 .iter()
176 .filter_map(|s| s.shuffle.as_ref())
177 .map(|s| s.buffer_rows)
178 .max()
179 .unwrap_or(0) as u128;
180 let sources = self
181 .stages
182 .iter()
183 .map(|s| s.sources.len())
184 .max()
185 .unwrap_or(0) as u128;
186 let parquet = self.stages.iter().any(|s| {
187 s.sources.iter().any(|g| {
188 g.encoding
189 .as_ref()
190 .or(s.encoding.as_ref())
191 .is_some_and(|e| e == "parquet")
192 })
193 });
194 let shard = row * rows;
195 let workspace = (64 * self.max_record_bytes as u128).max(if parquet {
198 8 * self.max_row_group_bytes as u128
199 } else {
200 0
201 }) + 16 * row * rows.min(128)
202 + 2 * shard
203 + metadata * rows.div_ceil(128)
204 + 32 * 1024 * 1024;
205 let buffered = (shuffle + batch_rows + 1) * (row + 1024);
206 let snapshots = 64 * (shuffle + sources);
207 let bound = (self.threads as u128)
208 .checked_mul(self.lookahead as u128)
209 .and_then(|n| n.checked_mul(shard + metadata))
210 .and_then(|n| {
211 (self.threads as u128)
212 .checked_mul(workspace)
213 .and_then(|w| n.checked_add(w))
214 })
215 .and_then(|n| n.checked_add(buffered))
216 .and_then(|n| {
217 (self.prefetch_batches as u128 + 3)
218 .checked_mul(batch * 3 + snapshots)
219 .and_then(|q| n.checked_add(q))
220 })
221 .ok_or_else(|| anyhow::anyhow!("memory bound exceeds supported range"))?;
222 Ok(bound.try_into()?)
223 }
224
225 pub fn validate(&self) -> Result<u64> {
228 ensure!(!self.stages.is_empty(), "no stages");
229 ensure!(
230 !self.fields.is_empty(),
231 "fields must be a nonempty allowlist"
232 );
233 ensure!(
234 self.lookahead > 0
235 && self.max_record_bytes > 0
236 && self.max_shard_rows > 0
237 && self.max_row_group_bytes > 0,
238 "invalid memory limits"
239 );
240 ensure!(
241 self.world_size > 0 && self.rank < self.world_size,
242 "invalid rank layout"
243 );
244 ensure!(self.threads > 0, "threads must be positive");
245 for (stage_index, stage) in self.stages.iter().enumerate() {
246 ensure!(
247 stage.sources.len() <= self.threads.saturating_mul(self.lookahead),
248 "threads * lookahead must hold one current shard per source"
249 );
250 ensure!(
251 stage.batch_size > 0 && !stage.sources.is_empty(),
252 "empty stage"
253 );
254 ensure!(
255 stage.shuffle.as_ref().is_none_or(|s| s.buffer_rows > 0),
256 "empty shuffle buffer"
257 );
258 let mut sum = 0.0;
259 for (source_index, group) in stage.sources.iter().enumerate() {
260 ensure!(
261 group.manifest_uri.is_none() && group.split.is_none(),
262 "stage {stage_index} source {source_index}: manifest source is not resolved"
263 );
264 ensure!(
265 matches!(
266 group
267 .encoding
268 .as_ref()
269 .or(stage.encoding.as_ref())
270 .map(String::as_str),
271 Some("msgpack.zstf" | "jsonl.gz" | "parquet")
272 ),
273 "stage {stage_index} source {source_index}: unknown encoding"
274 );
275 let w = group.weight.unwrap_or(1.0);
276 ensure!(
277 w.is_finite() && w >= 0.0 && !group.files.is_empty(),
278 "stage {stage_index} source {source_index}: invalid source group"
279 );
280 ensure!(
281 group
282 .files
283 .iter()
284 .all(|f| f.rows.is_none_or(|n| n <= self.max_shard_rows)),
285 "manifest rows exceed maxShardRows"
286 );
287 sum += w;
288 }
289 ensure!(sum.is_finite() && sum > 0.0, "invalid total weight");
290 }
291 for fields in std::iter::once(&self.fields).chain(
292 self.stages
293 .iter()
294 .flat_map(|s| &s.sources)
295 .filter_map(|g| g.fields.as_ref()),
296 ) {
297 let mut names = std::collections::HashSet::new();
298 for field in fields {
299 ensure!(names.insert(&field.name), "duplicate projected name");
300 ensure!(
301 matches!(field.dtype.as_str(), "i32" | "i64" | "f32" | "bool"),
302 "unknown dtype"
303 );
304 ensure!(
305 field.length.is_none_or(|n| n > 0 && n <= i32::MAX as usize),
306 "invalid field length"
307 );
308 ensure!(
309 field.shape.is_none() || field.length.is_none(),
310 "use length or shape, not both"
311 );
312 if let Some(shape) = &field.shape {
313 ensure!(
314 !shape.is_empty() && shape.iter().all(|&n| n > 0),
315 "invalid field shape"
316 );
317 ensure!(
318 shape
319 .iter()
320 .try_fold(1usize, |a, &b| a.checked_mul(b))
321 .is_some_and(|n| n <= i32::MAX as usize),
322 "field shape is too large"
323 );
324 }
325 }
326 }
327 for (stage_index, stage) in self.stages.iter().enumerate() {
328 for (source_index, source) in stage.sources.iter().enumerate() {
329 let fields = source.fields.as_ref().unwrap_or(&self.fields);
330 ensure!(
331 fields.len() == self.fields.len(),
332 "stage {stage_index} source {source_index} {}: field count differs",
333 source.files[0].uri
334 );
335 for (a, b) in fields.iter().zip(&self.fields) {
336 ensure!(
337 a.name == b.name && a.dtype == b.dtype && a.dimensions() == b.dimensions(),
338 "stage {stage_index} source {source_index} {}: incompatible field {}",
339 source.files[0].uri,
340 b.name
341 );
342 }
343 }
344 }
345 let bound = self.memory_bound()?;
346 let limit = self.memory_limit()?;
347 ensure!(
348 bound <= limit,
349 "memory bound {bound} bytes exceeds memoryLimitBytes {limit}"
350 );
351 Ok(bound)
352 }
353}