start-command 0.25.2

Gamification of coding, execute any command with ability to auto-report issues on GitHub
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

//! Docker resource limits that must survive a resume (issue #176).
//!
//! `docker commit` captures a container's filesystem and image config, but not
//! its HostConfig. A snapshot-based resume (`$ --resume <id> -- <cmd>`) used to
//! start the replacement container without the memory, CPU and PIDs limits the
//! original one had — limits a supervisor typically applied with
//! `docker update`, so they were never part of the stored launch options.
//!
//! This module reads the limits back out of `docker inspect` and translates the
//! non-default ones into `docker run` flags. The flags are kept in the
//! `--flag=value` form, so the same list is stored in the execution record,
//! shown in `[Isolation]` status lines, and spliced into `docker run` as is.

use serde_json::Value;

use crate::docker_cleanup::docker_command;
use crate::execution_control::CommandRunner;

/// Docker's default `/dev/shm` size; only a different size is re-applied.
pub const DEFAULT_SHM_SIZE: i64 = 64 * 1024 * 1024;

const KIB: i64 = 1024;
const MIB: i64 = KIB * 1024;
const GIB: i64 = MIB * 1024;

/// Format a byte count with the largest binary unit `docker run` accepts that
/// represents it exactly (`268435456` → `256m`).
pub fn format_docker_bytes(bytes: i64) -> String {
    for (unit, size) in [("g", GIB), ("m", MIB), ("k", KIB)] {
        if bytes >= size && bytes % size == 0 {
            return format!("{}{}", bytes / size, unit);
        }
    }
    bytes.to_string()
}

/// Format `NanoCpus` as the decimal `--cpus` value (`500000000` → `0.5`).
pub fn format_docker_cpus(nano_cpus: i64) -> String {
    let text = format!("{:.9}", nano_cpus as f64 / 1e9);
    let text = text.trim_end_matches('0').trim_end_matches('.');
    text.to_string()
}

fn number(value: Option<&Value>) -> Option<i64> {
    match value? {
        Value::Number(n) => n.as_i64().or_else(|| n.as_f64().map(|f| f as i64)),
        Value::String(s) => s.trim().parse().ok(),
        _ => None,
    }
}

fn positive(value: Option<&Value>) -> Option<i64> {
    number(value).filter(|n| *n > 0)
}

fn non_empty(value: Option<&Value>) -> Option<String> {
    value
        .and_then(Value::as_str)
        .map(str::trim)
        .filter(|s| !s.is_empty())
        .map(str::to_string)
}

fn scalar_text(value: Option<&Value>) -> String {
    match value {
        Some(Value::String(s)) => s.clone(),
        Some(Value::Number(n)) => n.to_string(),
        Some(Value::Bool(b)) => b.to_string(),
        _ => String::new(),
    }
}

/// Translate an inspected `HostConfig` into `docker run` flags.
///
/// Only limits that differ from Docker's defaults are emitted, and only in
/// combinations `docker run` accepts: `--memory-swap` needs `--memory`, and
/// `--cpus` cannot be combined with `--cpu-quota`/`--cpu-period`.
pub fn parse_docker_resource_limits(host_config: &Value) -> Vec<String> {
    let Some(h) = host_config.as_object() else {
        return Vec::new();
    };
    let mut limits = Vec::new();

    if let Some(memory) = positive(h.get("Memory")) {
        limits.push(format!("--memory={}", format_docker_bytes(memory)));
        match number(h.get("MemorySwap")) {
            Some(-1) => limits.push("--memory-swap=-1".to_string()),
            Some(swap) if swap > 0 => {
                limits.push(format!("--memory-swap={}", format_docker_bytes(swap)))
            }
            _ => {}
        }
    }
    if let Some(reservation) = positive(h.get("MemoryReservation")) {
        limits.push(format!(
            "--memory-reservation={}",
            format_docker_bytes(reservation)
        ));
    }

    if let Some(nano_cpus) = positive(h.get("NanoCpus")) {
        limits.push(format!("--cpus={}", format_docker_cpus(nano_cpus)));
    } else {
        if let Some(quota) = positive(h.get("CpuQuota")) {
            limits.push(format!("--cpu-quota={}", quota));
        }
        if let Some(period) = positive(h.get("CpuPeriod")) {
            limits.push(format!("--cpu-period={}", period));
        }
    }
    if let Some(shares) = positive(h.get("CpuShares")) {
        limits.push(format!("--cpu-shares={}", shares));
    }
    if let Some(cpus) = non_empty(h.get("CpusetCpus")) {
        limits.push(format!("--cpuset-cpus={}", cpus));
    }
    if let Some(mems) = non_empty(h.get("CpusetMems")) {
        limits.push(format!("--cpuset-mems={}", mems));
    }

    if let Some(pids) = positive(h.get("PidsLimit")) {
        limits.push(format!("--pids-limit={}", pids));
    }

    if let Some(shm) = positive(h.get("ShmSize")) {
        if shm != DEFAULT_SHM_SIZE {
            limits.push(format!("--shm-size={}", format_docker_bytes(shm)));
        }
    }

    if let Some(storage) = h.get("StorageOpt").and_then(Value::as_object) {
        let mut keys: Vec<&String> = storage.keys().collect();
        keys.sort();
        for key in keys {
            let value = scalar_text(storage.get(key));
            if !value.trim().is_empty() {
                limits.push(format!("--storage-opt={}={}", key, value.trim()));
            }
        }
    }

    if let Some(ulimits) = h.get("Ulimits").and_then(Value::as_array) {
        for ulimit in ulimits {
            if let Some(name) = non_empty(ulimit.get("Name")) {
                limits.push(format!(
                    "--ulimit={}={}:{}",
                    name,
                    scalar_text(ulimit.get("Soft")),
                    scalar_text(ulimit.get("Hard"))
                ));
            }
        }
    }

    limits
}

/// Read a container's resource limits with `docker inspect`.
///
/// Returns `None` when the container could not be read.
pub fn read_docker_resource_limits<R: CommandRunner + ?Sized>(
    container_name: &str,
    runner: &R,
) -> Option<Vec<String>> {
    let docker = docker_command().to_string_lossy().to_string();
    let args: Vec<String> = [
        "inspect",
        "--format",
        "{{json .HostConfig}}",
        container_name,
    ]
    .iter()
    .map(|s| s.to_string())
    .collect();
    let result = runner.run(&docker, &args);
    if !result.success {
        return None;
    }
    let host_config: Value = serde_json::from_str(result.stdout.trim()).ok()?;
    Some(parse_docker_resource_limits(&host_config))
}

/// Normalize a stored `resourceLimits` value (array or whitespace-separated
/// string) to a list of flags.
pub fn normalize_resource_limits(value: Option<&Value>) -> Vec<String> {
    match value {
        Some(Value::Array(items)) => items
            .iter()
            .map(|item| match item {
                Value::String(s) => s.clone(),
                other => other.to_string(),
            })
            .filter(|flag| flag.starts_with("--"))
            .collect(),
        Some(Value::String(text)) => text
            .split_whitespace()
            .filter(|flag| flag.starts_with("--"))
            .map(str::to_string)
            .collect(),
        _ => Vec::new(),
    }
}

/// `[Isolation]` status line for resource limits, or `None` when there are none.
pub fn build_resource_limits_status_line(limits: &[String]) -> Option<String> {
    if limits.is_empty() {
        None
    } else {
        Some(format!("[Isolation] Resource limits: {}", limits.join(" ")))
    }
}

/// An existing quota/period cannot be changed to Docker NanoCPUs in place.
pub fn cpu_count(limits: &[String]) -> Option<f64> {
    let get = |prefix: &str| {
        limits.iter().find_map(|s| {
            s.strip_prefix(prefix)
                .and_then(|n| n.parse::<f64>().ok())
                .filter(|n| *n > 0.0)
        })
    };
    get("--cpus=")
        .or_else(|| get("--cpu-quota=").map(|q| q / get("--cpu-period=").unwrap_or(100000.0)))
}
pub fn cpu_update_args(limits: &[String], cpus: f64) -> Vec<String> {
    if !limits.iter().any(|s| s.starts_with("--cpus="))
        && limits
            .iter()
            .any(|s| s.starts_with("--cpu-quota=") || s.starts_with("--cpu-period="))
    {
        vec![
            "--cpu-period=100000".into(),
            format!("--cpu-quota={}", (cpus * 100000.0).ceil() as i64),
        ]
    } else {
        vec!["--cpus".into(), cpus.to_string()]
    }
}
pub fn with_cpu_limit(mut limits: Vec<String>, cpus: f64) -> Vec<String> {
    let args = cpu_update_args(&limits, cpus);
    limits.retain(|s| {
        !["--cpus=", "--cpu-quota=", "--cpu-period="]
            .iter()
            .any(|p| s.starts_with(p))
    });
    if args[0] == "--cpus" {
        limits.push(format!("--cpus={}", cpus));
    } else {
        limits.extend(args);
    }
    limits
}