|
3 | 3 | The one place layer-type -> launcher wiring lives; everything else (the |
4 | 4 | registry, the outer harness) works in terms of :class:`Layer`/:class:`Launcher` |
5 | 5 | only. |
| 6 | +
|
| 7 | +**Merging same-mechanism layers (iter-2 fix for the triple-stack composition |
| 8 | +blocker).** A naive one-launcher-per-layer mapping is wrong whenever a |
| 9 | +scenario declares two layers that are really the *same enforcement context* |
| 10 | +imposing two different axes -- e.g. the triple-stack scenarios' separate |
| 11 | +``DOCKER_MEMORY``/``DOCKER_CPU_QUOTA`` layers are one container, not two |
| 12 | +nested ``docker run`` invocations, and their separate |
| 13 | +``NESTED_CGROUP_MEMORY``/``NESTED_CGROUP_CPU`` layers are one nested cgroup, |
| 14 | +not two independently-created cgroups at the same path. :func:`build_launchers` |
| 15 | +(and :func:`build_launcher_groups`, which also reports which original layers |
| 16 | +each merged launcher covers) group a scenario's layers by *launcher family* |
| 17 | +first, merge every layer of a multi-axis family (currently docker and the |
| 18 | +nested-cgroup layer) onto one launcher instance, and leave every other layer |
| 19 | +type exactly one-to-one with its own launcher -- preserving outside-in order |
| 20 | +by each family's first occurrence in ``scenario.layers``. |
6 | 21 | """ |
7 | 22 |
|
8 | 23 | from __future__ import annotations |
9 | 24 |
|
| 25 | +from typing import Sequence |
| 26 | + |
10 | 27 | from tests.e2e.launchers.base import Launcher |
11 | 28 | from tests.e2e.launchers.cgroup import CgroupLauncher |
12 | 29 | from tests.e2e.launchers.docker import DockerLauncher |
|
24 | 41 | _MEMORY_KWARG = "memory_bytes" |
25 | 42 | _CPU_KWARG = "cpu_millicores" |
26 | 43 |
|
| 44 | +# Layer types that merge onto one launcher instance per scenario when a |
| 45 | +# scenario declares more than one of them -- the "same enforcement context, |
| 46 | +# two axes" case. Every LayerType not listed here is its own singleton family: |
| 47 | +# exactly one launcher per layer, as before. |
| 48 | +_DOCKER_TYPES = frozenset({LayerType.DOCKER_MEMORY, LayerType.DOCKER_CPU_QUOTA, LayerType.DOCKER_CPUSET}) |
| 49 | +_NESTED_CGROUP_TYPES = frozenset({LayerType.NESTED_CGROUP_MEMORY, LayerType.NESTED_CGROUP_CPU}) |
| 50 | + |
| 51 | +_FAMILY_DOCKER = "docker" |
| 52 | +_FAMILY_NESTED_CGROUP = "nested_cgroup" |
| 53 | + |
| 54 | + |
| 55 | +def _layer_family(layer: Layer) -> str: |
| 56 | + if layer.type in _DOCKER_TYPES: |
| 57 | + return _FAMILY_DOCKER |
| 58 | + if layer.type in _NESTED_CGROUP_TYPES: |
| 59 | + return _FAMILY_NESTED_CGROUP |
| 60 | + return layer.type.value # singleton family: this layer type never merges |
| 61 | + |
27 | 62 |
|
28 | 63 | def build_launcher(layer: Layer) -> Launcher: |
29 | 64 | hints = dict(layer.launcher_hints) |
@@ -76,6 +111,100 @@ def build_launcher(layer: Layer) -> Launcher: |
76 | 111 | raise ValueError(f"no launcher factory registered for layer type {layer.type}") # pragma: no cover |
77 | 112 |
|
78 | 113 |
|
| 114 | +def _merge_hints(layers: Sequence[Layer]) -> dict[str, object]: |
| 115 | + """Union launcher_hints across a merged group, raising on a genuine |
| 116 | + conflict (two layers of the same family disagreeing on the same hint) -- |
| 117 | + every triple-stack docker layer declares matching privileged/cgroupns_private |
| 118 | + hints, so a conflict here would mean a bad registry entry, not something |
| 119 | + to silently resolve one way or the other.""" |
| 120 | + merged: dict[str, object] = {} |
| 121 | + for layer in layers: |
| 122 | + for key, value in layer.launcher_hints.items(): |
| 123 | + if key in merged and merged[key] != value: |
| 124 | + raise ValueError( |
| 125 | + f"conflicting launcher_hint {key!r} ({merged[key]!r} vs {value!r}) " |
| 126 | + f"across layers merged into one launcher: {[l.type for l in layers]}" |
| 127 | + ) |
| 128 | + merged[key] = value |
| 129 | + return merged |
| 130 | + |
| 131 | + |
| 132 | +def _merge_docker_layers(layers: Sequence[Layer]) -> DockerLauncher: |
| 133 | + """One DockerLauncher for every DOCKER_* layer in ``layers`` -- one |
| 134 | + ``docker run`` imposing every axis declared (``--memory``/``--memory-swap`` |
| 135 | + together with ``--cpus`` or ``--cpuset-cpus``), never a second, nested |
| 136 | + ``docker run`` for the CPU axis.""" |
| 137 | + kwargs: dict[str, object] = _merge_hints(layers) |
| 138 | + for layer in layers: |
| 139 | + if layer.type is LayerType.DOCKER_MEMORY: |
| 140 | + kwargs[_MEMORY_KWARG] = layer.imposed |
| 141 | + elif layer.type is LayerType.DOCKER_CPU_QUOTA: |
| 142 | + kwargs[_CPU_KWARG] = layer.imposed |
| 143 | + elif layer.type is LayerType.DOCKER_CPUSET: |
| 144 | + kwargs["cpuset_millicores"] = layer.imposed |
| 145 | + return DockerLauncher(**kwargs) |
| 146 | + |
| 147 | + |
| 148 | +def _merge_nested_cgroup_layers(layers: Sequence[Layer]) -> NestedCgroupLauncher: |
| 149 | + """One NestedCgroupLauncher for every NESTED_CGROUP_* layer in ``layers`` |
| 150 | + -- one script that mkdir's the nested cgroup once, probes it once, and |
| 151 | + writes both ``memory.max``/``memory.swap.max`` and ``cpu.max`` to it, |
| 152 | + never two independent scripts racing to create/write the same path.""" |
| 153 | + kwargs: dict[str, object] = {} |
| 154 | + probe_key: str | None = None |
| 155 | + for layer in layers: |
| 156 | + if layer.probe_key: |
| 157 | + if probe_key is not None and probe_key != layer.probe_key: |
| 158 | + raise ValueError( |
| 159 | + f"conflicting probe_key across merged nested-cgroup layers: {probe_key!r} vs {layer.probe_key!r}" |
| 160 | + ) |
| 161 | + probe_key = layer.probe_key |
| 162 | + if layer.type is LayerType.NESTED_CGROUP_MEMORY: |
| 163 | + kwargs[_MEMORY_KWARG] = layer.imposed |
| 164 | + elif layer.type is LayerType.NESTED_CGROUP_CPU: |
| 165 | + kwargs[_CPU_KWARG] = layer.imposed |
| 166 | + if probe_key: |
| 167 | + kwargs["probe_key"] = probe_key |
| 168 | + return NestedCgroupLauncher(**kwargs) |
| 169 | + |
| 170 | + |
| 171 | +def build_launcher_groups(scenario: Scenario) -> list[tuple[Launcher, tuple[Layer, ...]]]: |
| 172 | + """Group ``scenario.layers`` by enforcement-context family, merge each |
| 173 | + multi-axis family (docker, nested-cgroup) onto one launcher instance, and |
| 174 | + return ``(launcher, layers_it_covers)`` pairs outermost-first -- ordered by |
| 175 | + each family's *first* occurrence in ``scenario.layers``, so genuinely |
| 176 | + nested contexts (container -> nested cgroup -> rlimit -> payload) still |
| 177 | + compose outside-in via :func:`~tests.e2e.launchers.base.compose_argv`. |
| 178 | +
|
| 179 | + Every layer type outside the two merging families is its own singleton |
| 180 | + group: one launcher per layer, exactly as before this fix. |
| 181 | + """ |
| 182 | + groups: dict[str, list[Layer]] = {} |
| 183 | + order: list[str] = [] |
| 184 | + for layer in scenario.layers: |
| 185 | + family = _layer_family(layer) |
| 186 | + if family not in groups: |
| 187 | + groups[family] = [] |
| 188 | + order.append(family) |
| 189 | + groups[family].append(layer) |
| 190 | + |
| 191 | + result: list[tuple[Launcher, tuple[Layer, ...]]] = [] |
| 192 | + for family in order: |
| 193 | + group = tuple(groups[family]) |
| 194 | + if family == _FAMILY_DOCKER: |
| 195 | + result.append((_merge_docker_layers(group), group)) |
| 196 | + elif family == _FAMILY_NESTED_CGROUP: |
| 197 | + result.append((_merge_nested_cgroup_layers(group), group)) |
| 198 | + else: |
| 199 | + assert len(group) == 1, f"unexpected multiple layers grouped under singleton family {family!r}: {group}" |
| 200 | + result.append((build_launcher(group[0]), group)) |
| 201 | + return result |
| 202 | + |
| 203 | + |
79 | 204 | def build_launchers(scenario: Scenario) -> list[Launcher]: |
80 | | - """One launcher per layer, outermost-first, matching scenario.layers order.""" |
81 | | - return [build_launcher(layer) for layer in scenario.layers] |
| 205 | + """One launcher per *enforcement context* (same-mechanism, multi-axis |
| 206 | + layers merged -- see module docstring), outermost-first. Use |
| 207 | + :func:`build_launcher_groups` when the caller also needs to know which |
| 208 | + original layers a given launcher covers (e.g. to fold probe results back |
| 209 | + per layer).""" |
| 210 | + return [launcher for launcher, _layers in build_launcher_groups(scenario)] |
0 commit comments