aws-s3-transfer 1.0.0

Transfer Manager for Amazon S3 - a high-performance data plane client for uploading and downloading objects and directories.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

//! Process-level diagnostic settings resolved before runtime construction.

use std::env::VarError;
use std::time::Duration;

/// Process environment variable containing transfer-manager diagnostic settings.
const DIAGNOSTICS_ENV: &str = "AWS_S3_TM_DIAGNOSTICS";

/// Smallest periodic reporting interval accepted by memory diagnostics.
const MIN_MEMORY_SNAPSHOT_INTERVAL: Duration = Duration::from_millis(100);

/// Highest memory detail level understood by this binary.
const MAX_MEMORY_DETAIL_LEVEL: u64 = 1;

/// Highest transfer detail level understood by this binary.
const MAX_TRANSFER_DETAIL_LEVEL: u64 = 2;

/// Immutable diagnostic policy for one transfer-manager runtime domain.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub(crate) struct DiagnosticsConfig {
    memory: MemoryDiagnosticsConfig,
    transfer: TransferDiagnosticsConfig,
}

impl DiagnosticsConfig {
    /// Resolves the process environment without allowing invalid settings to fail construction.
    pub(crate) fn from_env() -> Self {
        Self::from_environment_value(std::env::var(DIAGNOSTICS_ENV))
    }

    /// Resolves one environment lookup result.
    fn from_environment_value(value: Result<String, VarError>) -> Self {
        match value {
            Ok(value) => Self::parse(&value),
            Err(VarError::NotPresent) => Self::default(),
            Err(VarError::NotUnicode(_)) => {
                tracing::warn!(
                    target: crate::telemetry::TARGET_MEMORY,
                    variable = DIAGNOSTICS_ENV,
                    "ignored non-Unicode transfer-manager diagnostics configuration"
                );
                Self::default()
            }
        }
    }

    /// Returns the memory-subsystem policy.
    pub(crate) fn memory(self) -> MemoryDiagnosticsConfig {
        self.memory
    }

    /// Returns the per-transfer policy shared by uploads and downloads.
    pub(crate) fn transfer(self) -> TransferDiagnosticsConfig {
        self.transfer
    }

    /// Constructs an explicit policy for deterministic internal tests.
    #[cfg(test)]
    pub(crate) fn for_test(memory: MemoryDiagnosticsConfig, transfer_detail_level: u64) -> Self {
        Self {
            memory,
            transfer: TransferDiagnosticsConfig {
                detail: TransferDiagnosticDetail::from_level(
                    transfer_detail_level.min(MAX_TRANSFER_DETAIL_LEVEL),
                ),
            },
        }
    }

    /// Parses comma-separated `key=value` settings from one Unicode value.
    fn parse(value: &str) -> Self {
        let mut config = Self::default();
        for entry in value
            .split(',')
            .map(str::trim)
            .filter(|entry| !entry.is_empty())
        {
            let Some((key, value)) = entry.split_once('=') else {
                warn_invalid_entry(entry);
                continue;
            };
            let key = key.trim();
            let value = value.trim();
            match key {
                "memory.snapshot" => match parse_memory_snapshot(value) {
                    Ok(interval) => config.memory.snapshot_interval = interval,
                    Err(()) => warn_invalid_setting(key, value),
                },
                "memory.detail" => match value.parse::<u64>() {
                    Ok(requested) => {
                        let effective = requested.min(MAX_MEMORY_DETAIL_LEVEL);
                        if requested != effective {
                            tracing::warn!(
                                target: crate::telemetry::TARGET_MEMORY,
                                variable = DIAGNOSTICS_ENV,
                                setting = key,
                                requested,
                                effective,
                                "clamped unsupported transfer-manager diagnostic detail level"
                            );
                        }
                        config.memory.detail = MemoryDiagnosticDetail::from_level(effective);
                    }
                    Err(_) => warn_invalid_setting(key, value),
                },
                "transfer.detail" => match value.parse::<u64>() {
                    Ok(requested) => {
                        let effective = requested.min(MAX_TRANSFER_DETAIL_LEVEL);
                        if requested != effective {
                            tracing::warn!(
                                target: crate::telemetry::TARGET_TRANSFER,
                                variable = DIAGNOSTICS_ENV,
                                setting = key,
                                requested,
                                effective,
                                "clamped unsupported transfer-manager diagnostic detail level"
                            );
                        }
                        config.transfer.detail = TransferDiagnosticDetail::from_level(effective);
                    }
                    Err(_) => warn_invalid_transfer_setting(key, value),
                },
                _ => {}
            }
        }
        config
    }
}

/// Immutable diagnostic policy consumed by the memory subsystem.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub(crate) struct MemoryDiagnosticsConfig {
    snapshot_interval: Option<Duration>,
    detail: MemoryDiagnosticDetail,
}

impl MemoryDiagnosticsConfig {
    /// Constructs an explicit policy for deterministic internal tests.
    #[cfg(any(test, s3_tm_fuzz))]
    pub(crate) fn for_test(snapshot_interval: Option<Duration>, detail_level: u64) -> Self {
        Self {
            snapshot_interval,
            detail: MemoryDiagnosticDetail::from_level(detail_level.min(MAX_MEMORY_DETAIL_LEVEL)),
        }
    }

    /// Returns the periodic memory snapshot interval.
    pub(crate) fn snapshot_interval(self) -> Option<Duration> {
        self.snapshot_interval
    }

    /// Returns the effective documented detail level.
    pub(crate) fn detail_level(self) -> u8 {
        self.detail as u8
    }

    /// Returns whether successful optimistic acquisitions record scan work.
    pub(crate) fn enable_detailed_counters(self) -> bool {
        self.detail >= MemoryDiagnosticDetail::AllocatorScans
    }
}

/// Cumulative memory-diagnostic detail enabled for one pool.
#[derive(Clone, Copy, Debug, Default, Eq, Ord, PartialEq, PartialOrd)]
#[repr(u8)]
enum MemoryDiagnosticDetail {
    /// Stable gauges and counters that update only on pressure or lifecycle events.
    #[default]
    Baseline = 0,
    /// Per-acquisition optimistic attempts and bitmap words inspected.
    AllocatorScans = 1,
}

impl MemoryDiagnosticDetail {
    /// Converts one requested level, saturating at the highest supported detail.
    fn from_level(level: u64) -> Self {
        match level {
            0 => Self::Baseline,
            _ => Self::AllocatorScans,
        }
    }
}

/// Immutable diagnostic policy consumed by transfer state machines.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub(crate) struct TransferDiagnosticsConfig {
    detail: TransferDiagnosticDetail,
}

impl TransferDiagnosticsConfig {
    /// Returns the effective documented detail level.
    #[cfg(test)]
    pub(crate) fn detail_level(self) -> u8 {
        self.detail as u8
    }

    /// Returns whether per-transfer summaries and aggregate timings are collected.
    pub(crate) fn enable_summaries(self) -> bool {
        self.detail >= TransferDiagnosticDetail::Summary
    }

    /// Returns whether individual transfer state-machine events are reported.
    pub(crate) fn events_enabled(self) -> bool {
        self.detail >= TransferDiagnosticDetail::Transitions
    }
}

/// Cumulative transfer-diagnostic detail enabled for one client.
#[derive(Clone, Copy, Debug, Default, Eq, Ord, PartialEq, PartialOrd)]
#[repr(u8)]
enum TransferDiagnosticDetail {
    /// No optional transfer-state collection. Ordinary terminal tracing still
    /// reports always-on lifecycle metrics when its target is enabled.
    #[default]
    Disabled = 0,
    /// Aggregate timings and counters reported once per transfer.
    Summary = 1,
    /// Summary collection plus individual state-machine event records.
    Transitions = 2,
}

impl TransferDiagnosticDetail {
    /// Converts one requested level, saturating at the highest supported detail.
    fn from_level(level: u64) -> Self {
        match level {
            0 => Self::Disabled,
            1 => Self::Summary,
            _ => Self::Transitions,
        }
    }
}

/// Parses `off` or one positive integer millisecond duration.
fn parse_memory_snapshot(value: &str) -> Result<Option<Duration>, ()> {
    if value == "off" {
        return Ok(None);
    }
    let millis = value
        .strip_suffix("ms")
        .ok_or(())?
        .parse::<u64>()
        .map_err(|_| ())?;
    if millis == 0 {
        return Err(());
    }
    let requested = Duration::from_millis(millis);
    if requested < MIN_MEMORY_SNAPSHOT_INTERVAL {
        tracing::warn!(
            target: crate::telemetry::TARGET_MEMORY,
            variable = DIAGNOSTICS_ENV,
            setting = "memory.snapshot",
            requested_ms = millis,
            effective_ms = MIN_MEMORY_SNAPSHOT_INTERVAL.as_millis(),
            "raised transfer-manager diagnostic interval to its minimum"
        );
    }
    Ok(Some(requested.max(MIN_MEMORY_SNAPSHOT_INTERVAL)))
}

/// Reports one malformed comma-separated entry.
fn warn_invalid_entry(entry: &str) {
    tracing::warn!(
        target: crate::telemetry::TARGET_MEMORY,
        variable = DIAGNOSTICS_ENV,
        entry,
        "ignored malformed transfer-manager diagnostic setting"
    );
}

/// Reports one recognized setting with an unsupported value.
fn warn_invalid_setting(setting: &str, value: &str) {
    tracing::warn!(
        target: crate::telemetry::TARGET_MEMORY,
        variable = DIAGNOSTICS_ENV,
        setting,
        value,
        "ignored invalid transfer-manager diagnostic setting"
    );
}

/// Reports one invalid transfer diagnostic setting.
fn warn_invalid_transfer_setting(setting: &str, value: &str) {
    tracing::warn!(
        target: crate::telemetry::TARGET_TRANSFER,
        variable = DIAGNOSTICS_ENV,
        setting,
        value,
        "ignored invalid transfer-manager diagnostic setting"
    );
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn empty_and_unknown_settings_keep_defaults() {
        assert_eq!(DiagnosticsConfig::parse(""), DiagnosticsConfig::default());
        assert_eq!(
            DiagnosticsConfig::parse("scheduler.snapshot=1000ms"),
            DiagnosticsConfig::default()
        );
    }

    #[test]
    fn environment_resolution_uses_the_same_parser_and_defaults() {
        assert_eq!(
            DiagnosticsConfig::from_environment_value(Err(VarError::NotPresent)),
            DiagnosticsConfig::default()
        );
        assert_eq!(
            DiagnosticsConfig::from_environment_value(Ok(
                "memory.snapshot=250ms,memory.detail=1,transfer.detail=2".to_owned()
            ))
            .memory(),
            MemoryDiagnosticsConfig::for_test(Some(Duration::from_millis(250)), 1)
        );
        assert_eq!(
            DiagnosticsConfig::from_environment_value(Ok(
                "memory.snapshot=250ms,memory.detail=1,transfer.detail=2".to_owned()
            ))
            .transfer()
            .detail_level(),
            2
        );
        assert_eq!(
            DiagnosticsConfig::from_environment_value(Err(VarError::NotUnicode(
                std::ffi::OsString::from("invalid")
            ))),
            DiagnosticsConfig::default()
        );
    }

    #[test]
    fn memory_snapshot_accepts_off_and_integer_milliseconds() {
        assert_eq!(
            DiagnosticsConfig::parse("memory.snapshot=250ms")
                .memory()
                .snapshot_interval(),
            Some(Duration::from_millis(250))
        );
        assert_eq!(
            DiagnosticsConfig::parse("memory.snapshot=1ms")
                .memory()
                .snapshot_interval(),
            Some(MIN_MEMORY_SNAPSHOT_INTERVAL)
        );
        assert_eq!(
            DiagnosticsConfig::parse("memory.snapshot=250ms,memory.snapshot=off")
                .memory()
                .snapshot_interval(),
            None
        );
    }

    #[test]
    fn invalid_snapshot_values_do_not_replace_valid_settings() {
        let config = DiagnosticsConfig::parse(
            "memory.snapshot=250ms,memory.snapshot=250,memory.snapshot=0ms",
        );
        assert_eq!(
            config.memory().snapshot_interval(),
            Some(Duration::from_millis(250))
        );
    }

    #[test]
    fn snapshot_parser_rejects_missing_suffix_invalid_units_and_overflow() {
        assert_eq!(parse_memory_snapshot("250"), Err(()));
        assert_eq!(parse_memory_snapshot("1s"), Err(()));
        assert_eq!(parse_memory_snapshot("18446744073709551616ms"), Err(()));
    }

    #[test]
    fn memory_detail_levels_are_cumulative_and_clamped() {
        assert_eq!(
            DiagnosticsConfig::parse("memory.detail=0")
                .memory()
                .detail_level(),
            0
        );
        assert_eq!(
            DiagnosticsConfig::parse("memory.detail=1")
                .memory()
                .detail_level(),
            1
        );
        assert_eq!(
            DiagnosticsConfig::parse("memory.detail=2")
                .memory()
                .detail_level(),
            1
        );
    }

    #[test]
    fn transfer_detail_levels_are_cumulative_and_clamped() {
        let disabled = DiagnosticsConfig::parse("transfer.detail=0").transfer();
        assert_eq!(disabled.detail_level(), 0);
        assert!(!disabled.enable_summaries());
        assert!(!disabled.events_enabled());

        let summary = DiagnosticsConfig::parse("transfer.detail=1").transfer();
        assert_eq!(summary.detail_level(), 1);
        assert!(summary.enable_summaries());
        assert!(!summary.events_enabled());

        let events = DiagnosticsConfig::parse("transfer.detail=2").transfer();
        assert_eq!(events.detail_level(), 2);
        assert!(events.enable_summaries());
        assert!(events.events_enabled());

        assert_eq!(
            DiagnosticsConfig::parse("transfer.detail=3")
                .transfer()
                .detail_level(),
            2
        );
    }

    #[test]
    fn detail_conversion_saturates_at_the_highest_supported_level() {
        assert_eq!(
            MemoryDiagnosticDetail::from_level(u64::MAX),
            MemoryDiagnosticDetail::AllocatorScans
        );
        assert_eq!(
            TransferDiagnosticDetail::from_level(u64::MAX),
            TransferDiagnosticDetail::Transitions
        );
    }

    #[test]
    fn snapshot_and_detail_controls_are_independent() {
        let snapshot = DiagnosticsConfig::parse("memory.snapshot=250ms").memory();
        assert_eq!(
            snapshot.snapshot_interval(),
            Some(Duration::from_millis(250))
        );
        assert_eq!(snapshot.detail_level(), 0);

        let detailed = DiagnosticsConfig::parse("memory.detail=1").memory();
        assert_eq!(detailed.snapshot_interval(), None);
        assert_eq!(detailed.detail_level(), 1);
    }

    #[test]
    fn settings_are_trimmed_and_last_valid_assignment_wins() {
        let config = DiagnosticsConfig::parse(
            " memory.detail = 1 , memory.snapshot = 500ms , transfer.detail = 2 , \
              memory.detail = 0 , transfer.detail = 1 ",
        );
        assert_eq!(config.memory().detail_level(), 0);
        assert_eq!(config.transfer().detail_level(), 1);
        assert_eq!(
            config.memory().snapshot_interval(),
            Some(Duration::from_millis(500))
        );
    }

    #[test]
    fn malformed_entries_do_not_change_other_settings() {
        let config = DiagnosticsConfig::parse(
            "bad-entry,memory.detail=1,memory.snapshot=broken,transfer.detail=1,\
             transfer.detail=bad",
        );
        assert_eq!(config.memory().detail_level(), 1);
        assert_eq!(config.memory().snapshot_interval(), None);
        assert_eq!(config.transfer().detail_level(), 1);
    }
}