kobako 0.30.0 → 0.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (266) hide show
  1. checksums.yaml +4 -4
  2. data/.release-please-manifest.json +1 -1
  3. data/CHANGELOG.md +335 -0
  4. data/Cargo.lock +469 -11
  5. data/README.md +43 -3
  6. data/ROADMAP.md +1 -1
  7. data/crates/kobako-runtime/CHANGELOG.md +219 -0
  8. data/crates/kobako-runtime/Cargo.toml +51 -3
  9. data/crates/kobako-runtime/README.md +7 -4
  10. data/crates/kobako-runtime/src/cred.rs +124 -0
  11. data/crates/kobako-runtime/src/dispatch.rs +4 -5
  12. data/crates/kobako-runtime/src/endpoint/buffer.rs +153 -44
  13. data/crates/kobako-runtime/src/endpoint/dispatch.rs +80 -41
  14. data/crates/kobako-runtime/src/endpoint/invoke.rs +23 -36
  15. data/crates/kobako-runtime/src/endpoint.rs +137 -36
  16. data/crates/kobako-runtime/src/errno.rs +391 -0
  17. data/crates/kobako-runtime/src/error.rs +31 -10
  18. data/crates/kobako-runtime/src/filesystem/anon_inodes.rs +52 -0
  19. data/crates/kobako-runtime/src/filesystem/bind/lookup.rs +52 -14
  20. data/crates/kobako-runtime/src/filesystem/bind/walk.rs +19 -20
  21. data/crates/kobako-runtime/src/filesystem/bind.rs +437 -245
  22. data/crates/kobako-runtime/src/filesystem/overlay/file.rs +6 -6
  23. data/crates/kobako-runtime/src/filesystem/overlay/path.rs +43 -65
  24. data/crates/kobako-runtime/src/filesystem/overlay/stack/copy_up.rs +9 -16
  25. data/crates/kobako-runtime/src/filesystem/overlay/stack/dir.rs +47 -72
  26. data/crates/kobako-runtime/src/filesystem/overlay/stack/namei.rs +12 -12
  27. data/crates/kobako-runtime/src/filesystem/overlay/stack/readdir.rs +4 -7
  28. data/crates/kobako-runtime/src/filesystem/overlay/stack.rs +121 -37
  29. data/crates/kobako-runtime/src/filesystem/overlay.rs +302 -343
  30. data/crates/kobako-runtime/src/filesystem/pipe.rs +12 -9
  31. data/crates/kobako-runtime/src/filesystem/rdir.rs +15 -32
  32. data/crates/kobako-runtime/src/filesystem/tmpfs/seed.rs +32 -0
  33. data/crates/kobako-runtime/src/filesystem/tmpfs/tmpfile.rs +3 -3
  34. data/crates/kobako-runtime/src/filesystem/tmpfs/whiteout.rs +57 -35
  35. data/crates/kobako-runtime/src/filesystem/tmpfs/xattr.rs +2 -2
  36. data/crates/kobako-runtime/src/filesystem/tmpfs.rs +172 -160
  37. data/crates/kobako-runtime/src/filesystem/wrap.rs +36 -52
  38. data/crates/kobako-runtime/src/filesystem.rs +6 -3
  39. data/crates/kobako-runtime/src/fork.rs +96 -0
  40. data/crates/kobako-runtime/src/grant.rs +3 -0
  41. data/crates/kobako-runtime/src/hashtable.rs +4 -2
  42. data/crates/kobako-runtime/src/lib.rs +18 -7
  43. data/crates/kobako-runtime/src/limits.rs +195 -0
  44. data/crates/kobako-runtime/src/locking.rs +10 -0
  45. data/crates/kobako-runtime/src/memcg.rs +383 -0
  46. data/crates/kobako-runtime/src/mount.rs +67 -9
  47. data/crates/kobako-runtime/src/net/backends.rs +43 -0
  48. data/crates/kobako-runtime/src/net/connections.rs +179 -0
  49. data/crates/kobako-runtime/src/net/credential.rs +125 -0
  50. data/crates/kobako-runtime/src/net/egress.rs +160 -0
  51. data/crates/kobako-runtime/src/net/family.rs +181 -0
  52. data/crates/kobako-runtime/src/net/http.rs +2733 -0
  53. data/crates/kobako-runtime/src/net/lookup.rs +285 -0
  54. data/crates/kobako-runtime/src/net/mock.rs +251 -0
  55. data/crates/kobako-runtime/src/net/namespace.rs +1366 -0
  56. data/crates/kobako-runtime/src/net/reactor.rs +531 -0
  57. data/crates/kobako-runtime/src/net/resolv/darwin.rs +275 -0
  58. data/crates/kobako-runtime/src/net/resolv/stub/tests.rs +469 -0
  59. data/crates/kobako-runtime/src/net/resolv/stub.rs +536 -0
  60. data/crates/kobako-runtime/src/net/resolv/windows.rs +248 -0
  61. data/crates/kobako-runtime/src/net/resolv.rs +227 -0
  62. data/crates/kobako-runtime/src/net/socket.rs +870 -0
  63. data/crates/kobako-runtime/src/net/tcp.rs +1588 -0
  64. data/crates/kobako-runtime/src/net/tls.rs +58 -0
  65. data/crates/kobako-runtime/src/net/transport.rs +279 -0
  66. data/crates/kobako-runtime/src/net/udp.rs +1003 -0
  67. data/crates/kobako-runtime/src/net.rs +42 -0
  68. data/crates/kobako-runtime/src/network/builder.rs +177 -0
  69. data/crates/kobako-runtime/src/network/ruleset.rs +777 -0
  70. data/crates/kobako-runtime/src/network.rs +551 -0
  71. data/crates/kobako-runtime/src/policy.rs +16 -0
  72. data/crates/kobako-runtime/src/profile.rs +29 -144
  73. data/crates/kobako-runtime/src/runtime.rs +3 -5
  74. data/crates/kobako-runtime/src/sched.rs +130 -29
  75. data/crates/kobako-runtime/src/security/entry_policy.rs +22 -0
  76. data/crates/kobako-runtime/src/{vfs/cred.rs → security/hooks.rs} +52 -144
  77. data/crates/kobako-runtime/src/security/mount_policy.rs +158 -0
  78. data/crates/kobako-runtime/src/security.rs +101 -196
  79. data/crates/kobako-runtime/src/snapshot.rs +121 -2
  80. data/crates/kobako-runtime/src/vfs/attr.rs +5 -5
  81. data/crates/kobako-runtime/src/vfs/dentry.rs +143 -89
  82. data/crates/kobako-runtime/src/vfs/file.rs +199 -203
  83. data/crates/kobako-runtime/src/vfs/inode.rs +41 -45
  84. data/crates/kobako-runtime/src/vfs/kern_path.rs +38 -42
  85. data/crates/kobako-runtime/src/vfs/mount.rs +10 -9
  86. data/crates/kobako-runtime/src/vfs/namei.rs +829 -700
  87. data/crates/kobako-runtime/src/vfs/namespace.rs +162 -0
  88. data/crates/kobako-runtime/src/vfs/open_files.rs +69 -0
  89. data/crates/kobako-runtime/src/vfs/openat2.rs +3 -3
  90. data/crates/kobako-runtime/src/vfs/path.rs +6 -6
  91. data/crates/kobako-runtime/src/vfs/readdir.rs +6 -6
  92. data/crates/kobako-runtime/src/vfs/stat.rs +159 -23
  93. data/crates/kobako-runtime/src/vfs/super_block.rs +18 -14
  94. data/crates/kobako-runtime/src/vfs/utimes.rs +37 -27
  95. data/crates/kobako-runtime/src/vfs.rs +9 -6
  96. data/crates/kobako-runtime/src/wait.rs +356 -0
  97. data/crates/kobako-transport/CHANGELOG.md +31 -0
  98. data/crates/kobako-transport/Cargo.toml +1 -1
  99. data/crates/kobako-transport/README.md +3 -4
  100. data/crates/kobako-transport/src/abi.rs +78 -72
  101. data/crates/kobako-transport/src/envelope/bytes.rs +17 -6
  102. data/crates/kobako-transport/src/envelope/call.rs +32 -4
  103. data/crates/kobako-transport/src/envelope/error_record.rs +21 -0
  104. data/crates/kobako-transport/src/envelope/name.rs +99 -0
  105. data/crates/kobako-transport/src/envelope/outcome.rs +9 -9
  106. data/crates/kobako-transport/src/envelope/preamble.rs +24 -21
  107. data/crates/kobako-transport/src/envelope/reply.rs +27 -27
  108. data/crates/kobako-transport/src/envelope/unsupported.rs +10 -10
  109. data/crates/kobako-transport/src/envelope.rs +13 -8
  110. data/crates/kobako-wasmtime/CHANGELOG.md +161 -0
  111. data/crates/kobako-wasmtime/Cargo.toml +26 -7
  112. data/crates/kobako-wasmtime/README.md +3 -2
  113. data/crates/kobako-wasmtime/build/preview2.rs +1339 -0
  114. data/crates/kobako-wasmtime/build.rs +16 -0
  115. data/crates/kobako-wasmtime/src/abi.rs +17 -37
  116. data/crates/kobako-wasmtime/src/ambient.rs +33 -18
  117. data/crates/kobako-wasmtime/src/cache.rs +23 -15
  118. data/crates/kobako-wasmtime/src/config.rs +52 -68
  119. data/crates/kobako-wasmtime/src/driver.rs +48 -63
  120. data/crates/kobako-wasmtime/src/exports.rs +143 -17
  121. data/crates/kobako-wasmtime/src/guest.rs +12 -6
  122. data/crates/kobako-wasmtime/src/guest_binary.rs +14 -0
  123. data/crates/kobako-wasmtime/src/imports.rs +42 -18
  124. data/crates/kobako-wasmtime/src/instance_pre.rs +4 -4
  125. data/crates/kobako-wasmtime/src/invocation.rs +74 -12
  126. data/crates/kobako-wasmtime/src/lib.rs +5 -3
  127. data/crates/kobako-wasmtime/src/limiter.rs +70 -5
  128. data/crates/kobako-wasmtime/src/preview1/descriptors.rs +309 -0
  129. data/crates/kobako-wasmtime/src/preview1/differential/mount.rs +5 -15
  130. data/crates/kobako-wasmtime/src/preview1/differential.rs +27 -31
  131. data/crates/kobako-wasmtime/src/preview1/errno.rs +55 -66
  132. data/crates/kobako-wasmtime/src/preview1/fd.rs +327 -296
  133. data/crates/kobako-wasmtime/src/preview1/memory.rs +21 -12
  134. data/crates/kobako-wasmtime/src/preview1/mount_view/wrap.rs +34 -53
  135. data/crates/kobako-wasmtime/src/preview1/mount_view.rs +231 -217
  136. data/crates/kobako-wasmtime/src/preview1/path.rs +56 -121
  137. data/crates/kobako-wasmtime/src/preview1/poll.rs +244 -120
  138. data/crates/kobako-wasmtime/src/preview1/sock.rs +10 -8
  139. data/crates/kobako-wasmtime/src/preview1/testsuite.rs +5 -15
  140. data/crates/kobako-wasmtime/src/preview1.rs +46 -42
  141. data/crates/kobako-wasmtime/src/preview2/abi.rs +227 -0
  142. data/crates/kobako-wasmtime/src/preview2/error.rs +118 -0
  143. data/crates/kobako-wasmtime/src/preview2/filesystem.rs +122 -0
  144. data/crates/kobako-wasmtime/src/preview2/host.rs +3959 -0
  145. data/crates/kobako-wasmtime/src/preview2/http.rs +1503 -0
  146. data/crates/kobako-wasmtime/src/preview2/io.rs +315 -0
  147. data/crates/kobako-wasmtime/src/preview2/sockets.rs +379 -0
  148. data/crates/kobako-wasmtime/src/preview2/table.rs +305 -0
  149. data/crates/kobako-wasmtime/src/preview2.rs +57 -0
  150. data/crates/kobako-wasmtime/src/trap.rs +24 -9
  151. data/crates/kobako-wasmtime/src/wasi.rs +210 -81
  152. data/crates/kobako-wasmtime/wit/deps/cli.wit +233 -0
  153. data/crates/kobako-wasmtime/wit/deps/clocks.wit +162 -0
  154. data/crates/kobako-wasmtime/wit/deps/filesystem.wit +589 -0
  155. data/crates/kobako-wasmtime/wit/deps/http.wit +733 -0
  156. data/crates/kobako-wasmtime/wit/deps/io.wit +299 -0
  157. data/crates/kobako-wasmtime/wit/deps/random.wit +92 -0
  158. data/crates/kobako-wasmtime/wit/deps/sockets.wit +949 -0
  159. data/data/kobako.wasm +0 -0
  160. data/ext/kobako/Cargo.toml +1 -1
  161. data/ext/kobako/src/{runtime/errors.rs → errors.rs} +34 -26
  162. data/ext/kobako/src/{runtime/escape.rs → escape.rs} +42 -11
  163. data/ext/kobako/src/{runtime/filesystem → filesystem}/grants.rs +30 -26
  164. data/ext/kobako/src/{runtime/filesystem → filesystem}/ruby.rs +149 -168
  165. data/ext/kobako/src/{runtime/filesystem.rs → filesystem.rs} +24 -15
  166. data/ext/kobako/src/gvl.rs +306 -0
  167. data/ext/kobako/src/lib.rs +64 -3
  168. data/ext/kobako/src/network/mock.rs +187 -0
  169. data/ext/kobako/src/network.rs +591 -0
  170. data/ext/kobako/src/runtime/bridge.rs +30 -29
  171. data/ext/kobako/src/runtime/snapshot.rs +4 -4
  172. data/ext/kobako/src/runtime.rs +221 -143
  173. data/ext/kobako/src/wire.rs +42 -0
  174. data/lib/kobako/catalog/extensions.rb +14 -2
  175. data/lib/kobako/catalog/flags.rb +3 -5
  176. data/lib/kobako/catalog/grants.rb +5 -4
  177. data/lib/kobako/catalog/handles.rb +5 -27
  178. data/lib/kobako/catalog/mount.rb +11 -3
  179. data/lib/kobako/catalog/network.rb +35 -0
  180. data/lib/kobako/catalog/replacements.rb +28 -0
  181. data/lib/kobako/catalog/services.rb +5 -19
  182. data/lib/kobako/catalog/snippets.rb +3 -18
  183. data/lib/kobako/catalog.rb +3 -0
  184. data/lib/kobako/codec/{utils.rb → boundary.rb} +4 -2
  185. data/lib/kobako/codec/decoder.rb +4 -4
  186. data/lib/kobako/codec/ext_types.rb +3 -3
  187. data/lib/kobako/codec/handle_walk.rb +3 -43
  188. data/lib/kobako/codec/value_budget.rb +132 -40
  189. data/lib/kobako/codec.rb +1 -1
  190. data/lib/kobako/context.rb +24 -11
  191. data/lib/kobako/errors.rb +15 -12
  192. data/lib/kobako/extension.rb +3 -2
  193. data/lib/kobako/filesystem.rb +9 -2
  194. data/lib/kobako/handle.rb +2 -2
  195. data/lib/kobako/names.rb +28 -0
  196. data/lib/kobako/network.rb +210 -0
  197. data/lib/kobako/outcome.rb +7 -7
  198. data/lib/kobako/pool.rb +45 -23
  199. data/lib/kobako/runtime.rb +3 -2
  200. data/lib/kobako/sandbox.rb +92 -35
  201. data/lib/kobako/sandbox_options.rb +41 -106
  202. data/lib/kobako/transport/argument_wrap.rb +64 -0
  203. data/lib/kobako/transport/block_failure.rb +1 -1
  204. data/lib/kobako/transport/dispatcher.rb +6 -6
  205. data/lib/kobako/transport/exposure.rb +26 -15
  206. data/lib/kobako/transport/reflection.rb +21 -4
  207. data/lib/kobako/transport/run.rb +8 -23
  208. data/lib/kobako/transport/yielder.rb +2 -9
  209. data/lib/kobako/transport.rb +1 -0
  210. data/lib/kobako/version.rb +1 -1
  211. data/lib/kobako.rb +6 -2
  212. data/release-please-config.json +15 -0
  213. data/sig/core/thread.rbs +6 -0
  214. data/sig/kobako/catalog/extensions.rbs +2 -0
  215. data/sig/kobako/catalog/grants.rbs +7 -4
  216. data/sig/kobako/catalog/handles.rbs +0 -2
  217. data/sig/kobako/catalog/mount.rbs +3 -1
  218. data/sig/kobako/catalog/network.rbs +20 -0
  219. data/sig/kobako/catalog/replacements.rbs +14 -0
  220. data/sig/kobako/catalog/services.rbs +0 -4
  221. data/sig/kobako/catalog/snippets.rbs +0 -2
  222. data/sig/kobako/codec/{utils.rbs → boundary.rbs} +2 -2
  223. data/sig/kobako/codec/handle_walk.rbs +0 -6
  224. data/sig/kobako/codec/value_budget.rbs +47 -4
  225. data/sig/kobako/context.rbs +3 -1
  226. data/sig/kobako/errors.rbs +4 -4
  227. data/sig/kobako/filesystem.rbs +21 -3
  228. data/sig/kobako/network.rbs +115 -0
  229. data/sig/kobako/outcome.rbs +1 -1
  230. data/sig/kobako/pool.rbs +7 -3
  231. data/sig/kobako/runtime.rbs +32 -3
  232. data/sig/kobako/sandbox.rbs +19 -2
  233. data/sig/kobako/sandbox_options.rbs +29 -38
  234. data/sig/kobako/transport/argument_wrap.rbs +15 -0
  235. data/sig/kobako/transport/error.rbs +1 -1
  236. data/sig/kobako/transport/exposure.rbs +2 -4
  237. data/sig/kobako/transport/reflection.rbs +10 -0
  238. data/sig/kobako/transport/run.rbs +0 -2
  239. data/sig/kobako/transport/yielder.rbs +0 -3
  240. data/sig/kobako/transport.rbs +1 -1
  241. data/sig/kobako.rbs +13 -0
  242. metadata +84 -35
  243. data/crates/kobako-runtime/src/endpoint/capture.rs +0 -115
  244. data/crates/kobako-runtime/src/endpoint/memory_cap.rs +0 -238
  245. data/crates/kobako-runtime/src/filesystem/path.rs +0 -21
  246. data/crates/kobako-runtime/src/vfs/errno.rs +0 -153
  247. data/crates/kobako-runtime/tests/linux_baseline/calls.rs +0 -171
  248. data/crates/kobako-runtime/tests/linux_baseline/concurrent.rs +0 -276
  249. data/crates/kobako-runtime/tests/linux_baseline/kobako.rs +0 -323
  250. data/crates/kobako-runtime/tests/linux_baseline/linux-baseline-expected.txt +0 -16
  251. data/crates/kobako-runtime/tests/linux_baseline/linux.rs +0 -449
  252. data/crates/kobako-runtime/tests/linux_baseline/main.rs +0 -611
  253. data/crates/kobako-runtime/tests/linux_baseline/permissions.rs +0 -236
  254. data/crates/kobako-wasmtime/src/descriptors.rs +0 -200
  255. data/crates/kobako-wasmtime/tests/integration/compile_posture.rs +0 -43
  256. data/crates/kobako-wasmtime/tests/integration/guest_file.rs +0 -1085
  257. data/crates/kobako-wasmtime/tests/integration/main.rs +0 -29
  258. data/crates/kobako-wasmtime/tests/integration/preamble_flags.rs +0 -70
  259. data/crates/kobako-wasmtime/tests/integration/snippet_compile.rs +0 -95
  260. data/crates/kobako-wasmtime/tests/integration/support/mod.rs +0 -30
  261. data/crates/kobako-wasmtime/tests/integration/unanswered_call.rs +0 -86
  262. data/crates/kobako-wasmtime/tests/integration/unsupported_call.rs +0 -51
  263. data/ext/kobako/src/runtime/gvl.rs +0 -147
  264. data/lib/kobako/constant_name.rb +0 -8
  265. data/sig/kobako/constant_name.rbs +0 -3
  266. /data/ext/kobako/src/{runtime/pinned_value.rs → pinned_value.rs} +0 -0
@@ -0,0 +1,383 @@
1
+ //! The memory one Invocation may take, as Linux's memory cgroup counts a
2
+ //! task's pages and the memory the kernel holds for it, socket buffers among
3
+ //! them, in one `memory.current` against `memory.max`.
4
+
5
+ use std::sync::{Arc, Mutex, PoisonError};
6
+
7
+ use crate::Errno;
8
+
9
+ /// What one Invocation has taken against its `memory_limit`: the guest's
10
+ /// memory grown past where the run began, and what the host holds on its
11
+ /// behalf between calls. `None` bounds neither, while both are still counted
12
+ /// so the peak is reported either way.
13
+ pub struct MemoryBudget {
14
+ limit: Option<usize>,
15
+ charged: Mutex<Charged>,
16
+ }
17
+
18
+ #[derive(Default)]
19
+ struct Charged {
20
+ /// Whether the guest's growth is charged; it is not before the run
21
+ /// begins, as the image's own allocation must pass.
22
+ armed: bool,
23
+ baseline: usize,
24
+ grown: usize,
25
+ held: usize,
26
+ peak: usize,
27
+ }
28
+
29
+ impl Charged {
30
+ fn total(&self) -> usize {
31
+ self.grown.saturating_add(self.held)
32
+ }
33
+ }
34
+
35
+ impl MemoryBudget {
36
+ pub fn new(limit: Option<usize>) -> Arc<Self> {
37
+ Arc::new(Self {
38
+ limit,
39
+ charged: Mutex::default(),
40
+ })
41
+ }
42
+
43
+ /// Charge the guest's memory past `baseline` from now on, as the run
44
+ /// begins, so the image's allocation and what earlier runs left behind
45
+ /// take none of it.
46
+ pub fn arm(&self, baseline: usize) {
47
+ let mut charged = self.charged();
48
+ charged.armed = true;
49
+ charged.baseline = baseline;
50
+ charged.grown = 0;
51
+ charged.peak = charged.held;
52
+ }
53
+
54
+ /// Stop charging the guest's growth once the run returns, so reading its
55
+ /// answer back costs the script nothing.
56
+ pub fn disarm(&self) {
57
+ self.charged().armed = false;
58
+ }
59
+
60
+ /// The most the run held at once. A charge the budget refused never
61
+ /// raises it, so it never passes `memory_limit`.
62
+ pub fn peak(&self) -> usize {
63
+ self.charged().peak
64
+ }
65
+
66
+ /// Charge the guest's memory growing to `desired` bytes, refused where it
67
+ /// and what the host holds would pass the limit. What it answers gives the
68
+ /// charge back should the growth then fail.
69
+ pub fn charge_growth(&self, desired: usize) -> Result<GrowthCharge, MemoryLimitExceeded> {
70
+ let mut charged = self.charged();
71
+ let before = GrowthCharge {
72
+ grown: charged.grown,
73
+ };
74
+ if !charged.armed {
75
+ return Ok(before);
76
+ }
77
+ let grown = desired.saturating_sub(charged.baseline);
78
+ let total = grown.saturating_add(charged.held);
79
+ if let Some(limit) = self.limit.filter(|&limit| total > limit) {
80
+ return Err(MemoryLimitExceeded::new(desired, limit));
81
+ }
82
+ charged.grown = grown;
83
+ charged.peak = charged.peak.max(total);
84
+ Ok(before)
85
+ }
86
+
87
+ /// Give back `charge`, a growth the Engine failed to make once the budget
88
+ /// allowed it, so what the run holds counts no memory it never had, as
89
+ /// `page_counter_cancel` gives a charge back. The peak keeps it, as the
90
+ /// watermark the charge raised stays.
91
+ pub fn cancel_growth(&self, charge: GrowthCharge) {
92
+ self.charged().grown = charge.grown;
93
+ }
94
+
95
+ /// Charge `bytes` the host holds for the guest, refused as ENOMEM where
96
+ /// they would pass the limit, as `try_charge_memcg` refuses a charge past
97
+ /// `memory.max`.
98
+ pub(crate) fn try_charge(&self, bytes: usize) -> Result<(), Errno> {
99
+ let mut charged = self.charged();
100
+ let total = charged
101
+ .total()
102
+ .checked_add(bytes)
103
+ .filter(|&total| self.limit.is_none_or(|limit| total <= limit))
104
+ .ok_or(Errno::OutOfMemory)?;
105
+ charged.held += bytes;
106
+ charged.peak = charged.peak.max(total);
107
+ Ok(())
108
+ }
109
+
110
+ /// `bytes` charged earlier are held no more, as `memcg_uncharge` gives
111
+ /// them back.
112
+ fn uncharge(&self, bytes: usize) {
113
+ let mut charged = self.charged();
114
+ charged.held = charged.held.saturating_sub(bytes);
115
+ }
116
+
117
+ fn charged(&self) -> std::sync::MutexGuard<'_, Charged> {
118
+ self.charged.lock().unwrap_or_else(PoisonError::into_inner)
119
+ }
120
+ }
121
+
122
+ /// What the guest's growth stood at before one charge, which a growth the
123
+ /// Engine fails to make gives back through `MemoryBudget::cancel_growth`.
124
+ #[must_use]
125
+ pub struct GrowthCharge {
126
+ grown: usize,
127
+ }
128
+
129
+ /// Memory the host holds for a guest, charged to its budget as it is taken
130
+ /// and given back as it is let go, as `obj_cgroup_charge` and
131
+ /// `obj_cgroup_uncharge` count what the kernel holds for a cgroup by the byte:
132
+ /// a socket's queues, a listing, or a part of a request the guest builds.
133
+ pub struct MemoryCharge {
134
+ budget: Arc<MemoryBudget>,
135
+ bytes: usize,
136
+ }
137
+
138
+ impl MemoryCharge {
139
+ /// Charge `bytes` to `budget`, refused past its limit as `ENOMEM`.
140
+ pub fn new(budget: &Arc<MemoryBudget>, bytes: usize) -> Result<Self, Errno> {
141
+ budget.try_charge(bytes)?;
142
+ Ok(Self {
143
+ budget: budget.clone(),
144
+ bytes,
145
+ })
146
+ }
147
+
148
+ /// A charge to `budget` that holds nothing yet.
149
+ pub fn empty(budget: &Arc<MemoryBudget>) -> Self {
150
+ Self {
151
+ budget: budget.clone(),
152
+ bytes: 0,
153
+ }
154
+ }
155
+
156
+ /// The bytes it holds.
157
+ pub fn bytes(&self) -> usize {
158
+ self.bytes
159
+ }
160
+
161
+ /// Hold `bytes` in place of what it held, charging only the growth and
162
+ /// giving back the rest; refused past the limit as `ENOMEM`, keeping what
163
+ /// it held.
164
+ pub fn resize(&mut self, bytes: usize) -> Result<(), Errno> {
165
+ match bytes.checked_sub(self.bytes) {
166
+ Some(growth) => self.budget.try_charge(growth)?,
167
+ None => self.budget.uncharge(self.bytes - bytes),
168
+ }
169
+ self.bytes = bytes;
170
+ Ok(())
171
+ }
172
+ }
173
+
174
+ impl Drop for MemoryCharge {
175
+ fn drop(&mut self) {
176
+ self.budget.uncharge(self.bytes);
177
+ }
178
+ }
179
+
180
+ /// A growth past the per-invocation memory budget. An Engine ends the
181
+ /// invocation with it, and a Wasm Driver finds it again to classify the
182
+ /// failure as a memory-limit `Trap`. Callers use the `Display` impl below — no
183
+ /// field is read directly — so the inner state stays private.
184
+ #[derive(Debug)]
185
+ pub struct MemoryLimitExceeded {
186
+ desired: usize,
187
+ limit: usize,
188
+ }
189
+
190
+ impl MemoryLimitExceeded {
191
+ pub fn new(desired: usize, limit: usize) -> Self {
192
+ Self { desired, limit }
193
+ }
194
+ }
195
+
196
+ impl std::fmt::Display for MemoryLimitExceeded {
197
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
198
+ write!(
199
+ f,
200
+ "memory usage exceeded memory_limit: \
201
+ requested={} bytes, limit={} bytes",
202
+ self.desired, self.limit
203
+ )
204
+ }
205
+ }
206
+
207
+ impl std::error::Error for MemoryLimitExceeded {}
208
+
209
+ #[cfg(test)]
210
+ mod tests {
211
+ //! The arithmetic of one budget, so a regression that breaks the baseline
212
+ //! (dropping its subtraction, or letting `arm` carry stale state across
213
+ //! invocations) or counts the guest and the host apart is caught without
214
+ //! an Engine.
215
+ use super::MemoryBudget;
216
+ use crate::Errno;
217
+
218
+ fn assert_charged(budget: &MemoryBudget, desired: usize, what: &str) {
219
+ assert!(
220
+ budget.charge_growth(desired).is_ok(),
221
+ "{what} through MemoryBudget::charge_growth must be allowed"
222
+ );
223
+ }
224
+
225
+ fn assert_refused(budget: &MemoryBudget, desired: usize, what: &str) {
226
+ assert!(
227
+ budget.charge_growth(desired).is_err(),
228
+ "{what} through MemoryBudget::charge_growth must be refused"
229
+ );
230
+ }
231
+
232
+ // @behavior S-113
233
+ #[test]
234
+ fn a_growth_before_the_budget_is_armed_is_not_bounded() {
235
+ let budget = MemoryBudget::new(Some(1 << 20));
236
+ assert_charged(&budget, 100 << 20, "a 100 MiB growth before arm");
237
+ }
238
+
239
+ // @behavior S-114
240
+ #[test]
241
+ fn a_growth_within_the_limit_is_allowed() {
242
+ let budget = MemoryBudget::new(Some(1 << 20));
243
+ budget.arm(2 << 20);
244
+ assert_charged(
245
+ &budget,
246
+ (2 << 20) + (1 << 19),
247
+ "a 512 KiB growth past a 2 MiB baseline under a 1 MiB limit",
248
+ );
249
+ }
250
+
251
+ // @behavior S-121
252
+ #[test]
253
+ fn a_growth_past_the_limit_is_refused() {
254
+ let budget = MemoryBudget::new(Some(1 << 20));
255
+ budget.arm(2 << 20);
256
+ assert_refused(
257
+ &budget,
258
+ 4 << 20,
259
+ "a 2 MiB growth past a 2 MiB baseline under a 1 MiB limit",
260
+ );
261
+ }
262
+
263
+ // @behavior S-209
264
+ #[test]
265
+ fn a_growth_past_what_the_host_left_of_the_limit_is_refused() {
266
+ let budget = MemoryBudget::new(Some(1 << 20));
267
+ budget.arm(2 << 20);
268
+ budget
269
+ .try_charge(3 << 18)
270
+ .expect("768 KiB of socket buffers under a 1 MiB limit must be charged");
271
+ assert_refused(
272
+ &budget,
273
+ (2 << 20) + (1 << 19),
274
+ "a 512 KiB growth beside 768 KiB the host holds under a 1 MiB limit",
275
+ );
276
+ }
277
+
278
+ // @behavior S-209
279
+ #[test]
280
+ fn a_host_charge_past_what_the_guest_left_of_the_limit_is_refused() {
281
+ let budget = MemoryBudget::new(Some(1 << 20));
282
+ budget.arm(2 << 20);
283
+ assert_charged(&budget, (2 << 20) + (3 << 18), "a 768 KiB growth");
284
+ assert_eq!(
285
+ budget.try_charge(1 << 19),
286
+ Err(Errno::OutOfMemory),
287
+ "512 KiB of host buffers beside a 768 KiB growth under a 1 MiB limit must answer ENOMEM"
288
+ );
289
+ }
290
+
291
+ // @behavior S-008
292
+ #[test]
293
+ fn each_arming_charges_from_its_own_baseline() {
294
+ let budget = MemoryBudget::new(Some(1 << 20));
295
+ budget.arm(2 << 20);
296
+ assert_charged(&budget, 3 << 20, "a 1 MiB growth in the first invocation");
297
+ budget.arm(3 << 20);
298
+ assert_charged(
299
+ &budget,
300
+ 4 << 20,
301
+ "a 1 MiB growth in the second invocation, past the first one's residue",
302
+ );
303
+ }
304
+
305
+ // @behavior S-009
306
+ #[test]
307
+ fn a_budget_without_a_limit_allows_any_growth() {
308
+ let budget = MemoryBudget::new(None);
309
+ budget.arm(0);
310
+ assert_charged(&budget, 100 << 20, "a 100 MiB growth with no limit");
311
+ }
312
+
313
+ // @behavior S-116
314
+ #[test]
315
+ fn the_peak_is_zero_before_any_growth() {
316
+ let budget = MemoryBudget::new(Some(1 << 20));
317
+ assert_eq!(
318
+ budget.peak(),
319
+ 0,
320
+ "a new budget through MemoryBudget::peak must report 0"
321
+ );
322
+ }
323
+
324
+ // @behavior S-115
325
+ #[test]
326
+ fn the_peak_is_the_most_held_at_once() {
327
+ let budget = MemoryBudget::new(Some(1 << 20));
328
+ budget.arm(2 << 20);
329
+ assert_charged(&budget, (2 << 20) + (1 << 18), "a 256 KiB growth");
330
+ assert_charged(&budget, (2 << 20) + (1 << 19), "a 512 KiB growth");
331
+ budget
332
+ .try_charge(1 << 17)
333
+ .expect("128 KiB of host buffers must be charged");
334
+ budget.uncharge(1 << 17);
335
+ assert_eq!(
336
+ budget.peak(),
337
+ (1 << 19) + (1 << 17),
338
+ "a 512 KiB growth beside 128 KiB the host held for a while through \
339
+ MemoryBudget::peak must report 640 KiB"
340
+ );
341
+ }
342
+
343
+ // @behavior S-062
344
+ #[test]
345
+ fn a_refused_growth_leaves_the_peak_alone() {
346
+ let budget = MemoryBudget::new(Some(1 << 20));
347
+ budget.arm(2 << 20);
348
+ assert_charged(&budget, (2 << 20) + (1 << 19), "a 512 KiB growth");
349
+ assert_refused(&budget, 4 << 20, "a 2 MiB growth under a 1 MiB limit");
350
+ assert_eq!(
351
+ budget.peak(),
352
+ 1 << 19,
353
+ "a refused 2 MiB growth through MemoryBudget::peak must leave 512 KiB reported"
354
+ );
355
+ }
356
+
357
+ // @behavior S-117
358
+ #[test]
359
+ fn each_arming_resets_the_peak() {
360
+ let budget = MemoryBudget::new(Some(1 << 20));
361
+ budget.arm(2 << 20);
362
+ assert_charged(&budget, (2 << 20) + (1 << 19), "a 512 KiB growth");
363
+ budget.arm(3 << 20);
364
+ assert_eq!(
365
+ budget.peak(),
366
+ 0,
367
+ "a second arm through MemoryBudget::peak must report 0"
368
+ );
369
+ }
370
+
371
+ // @behavior S-118
372
+ #[test]
373
+ fn a_budget_without_a_limit_still_reports_its_peak() {
374
+ let budget = MemoryBudget::new(None);
375
+ budget.arm(1 << 20);
376
+ assert_charged(&budget, 5 << 20, "a 4 MiB growth with no limit");
377
+ assert_eq!(
378
+ budget.peak(),
379
+ 4 << 20,
380
+ "a 4 MiB growth with no limit through MemoryBudget::peak must report 4 MiB"
381
+ );
382
+ }
383
+ }
@@ -7,7 +7,9 @@ use std::fmt;
7
7
  use std::sync::Arc;
8
8
 
9
9
  use crate::filesystem::Filesystem;
10
+ use crate::policy::Policy;
10
11
  use crate::vfs::VfsMount;
12
+ use crate::Errno;
11
13
 
12
14
  /// What a Mount allows a guest beneath it, and what a Policy is asked to allow
13
15
  /// for one path.
@@ -17,12 +19,15 @@ pub enum Access {
17
19
  ReadWrite,
18
20
  }
19
21
 
20
- /// The Host App's decision for one path a guest opens or changes, made after
21
- /// a Mount's access allows it, so it can only refuse more.
22
- pub trait Policy: Send + Sync {
23
- /// Whether the guest may reach `path`, the absolute guest path, with
24
- /// `access`.
25
- fn allows(&self, path: &str, access: Access) -> bool;
22
+ /// One path a guest opens or changes beneath a Mount, as its Policy is asked
23
+ /// about it.
24
+ #[derive(Clone, Copy, Debug, PartialEq, Eq)]
25
+ #[non_exhaustive]
26
+ pub struct MountRequest<'a> {
27
+ /// The absolute guest path.
28
+ pub path: &'a str,
29
+ /// The access the guest asks for there.
30
+ pub access: Access,
26
31
  }
27
32
 
28
33
  /// A Filesystem instance at an absolute guest path. Its path bounds what a
@@ -30,7 +35,7 @@ pub trait Policy: Send + Sync {
30
35
  #[derive(Clone)]
31
36
  pub struct Mount {
32
37
  at: String,
33
- policy: Option<Arc<dyn Policy>>,
38
+ policy: Option<Arc<dyn for<'a> Policy<MountRequest<'a>>>>,
34
39
  mnt: Arc<VfsMount>,
35
40
  }
36
41
 
@@ -81,7 +86,7 @@ impl Mount {
81
86
 
82
87
  /// This Mount with `policy` also judging each open and each change its
83
88
  /// access allows; it can only refuse more, as an LSM can.
84
- pub fn with_policy(self, policy: Arc<dyn Policy>) -> Self {
89
+ pub fn with_policy(self, policy: Arc<dyn for<'a> Policy<MountRequest<'a>>>) -> Self {
85
90
  Self {
86
91
  policy: Some(policy),
87
92
  ..self
@@ -94,7 +99,7 @@ impl Mount {
94
99
  }
95
100
 
96
101
  /// The Policy deciding beneath this Mount, once one was given.
97
- pub(crate) fn policy(&self) -> Option<&Arc<dyn Policy>> {
102
+ pub(crate) fn policy(&self) -> Option<&Arc<dyn for<'a> Policy<MountRequest<'a>>>> {
98
103
  self.policy.as_ref()
99
104
  }
100
105
 
@@ -103,3 +108,56 @@ impl Mount {
103
108
  &self.at
104
109
  }
105
110
  }
111
+
112
+ /// A Mount Linux's `mount` refuses to place, as its walk fails or lands on no
113
+ /// directory: its guest path, and the errno Linux refuses it with.
114
+ #[derive(Debug)]
115
+ pub struct UnplacedMountError {
116
+ pub at: String,
117
+ pub errno: Errno,
118
+ }
119
+
120
+ impl fmt::Display for UnplacedMountError {
121
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
122
+ match self.errno.posix_name() {
123
+ Some(name) => write!(f, "the Mount at {:?} stands nowhere: {name}", self.at),
124
+ None => write!(
125
+ f,
126
+ "the Mount at {:?} stands nowhere: {:?}",
127
+ self.at, self.errno
128
+ ),
129
+ }
130
+ }
131
+ }
132
+
133
+ impl std::error::Error for UnplacedMountError {}
134
+
135
+ /// The Mounts among `mounts` no other one's path holds, the roots every guest
136
+ /// path starts from. One beneath another is reached only by a walk into it, so
137
+ /// each spelling of its path meets what Linux's mount namespace holds there.
138
+ pub fn outermost_of<'a>(mounts: &[&'a Mount]) -> Vec<&'a Mount> {
139
+ mounts
140
+ .iter()
141
+ .copied()
142
+ .filter(|mount| {
143
+ outermost_holder_of(&mount.at, mounts.iter().map(|other| (other.at(), ()))).is_none()
144
+ })
145
+ .collect()
146
+ }
147
+
148
+ /// The outermost of `holders`, each a guest path with what stands there,
149
+ /// holding the guest path `at` strictly beneath it; none where none holds it.
150
+ pub(crate) fn outermost_holder_of<'a, T>(
151
+ at: &str,
152
+ holders: impl IntoIterator<Item = (&'a str, T)>,
153
+ ) -> Option<(&'a str, T)> {
154
+ holders
155
+ .into_iter()
156
+ .filter(|(above, _)| {
157
+ *above != at
158
+ && at
159
+ .strip_prefix(above)
160
+ .is_some_and(|rest| *above == "/" || rest.starts_with('/'))
161
+ })
162
+ .min_by_key(|(above, _)| above.len())
163
+ }
@@ -0,0 +1,43 @@
1
+ //! The backends a network namespace reaches the host through, which a Host
2
+ //! App may replace, as gVisor picks one network stack for each sandbox.
3
+
4
+ use std::sync::Arc;
5
+
6
+ use super::family::{HostInet, ProtocolFamily};
7
+ use super::lookup::Resolver;
8
+
9
+ /// The Protocol Family that dials and the Resolver that answers names, one
10
+ /// pair for every entry of an Invocation's network. Both stand beneath the
11
+ /// socket layer's rules, so each is handed only what those rules admitted:
12
+ /// a family dials a real address the filter let through, and every address
13
+ /// a resolver answers is judged again at connect. The L7 proxy's sender is
14
+ /// not among them, since the rules hold only while it dials through the
15
+ /// connector kobako hands it.
16
+ #[derive(Clone)]
17
+ pub struct Backends {
18
+ family: Arc<dyn ProtocolFamily>,
19
+ resolver: Arc<dyn Resolver>,
20
+ }
21
+
22
+ impl Backends {
23
+ /// Dial through `family` and look names up through `resolver`.
24
+ pub fn new(family: Arc<dyn ProtocolFamily>, resolver: Arc<dyn Resolver>) -> Self {
25
+ Self { family, resolver }
26
+ }
27
+
28
+ pub(crate) fn family(&self) -> &Arc<dyn ProtocolFamily> {
29
+ &self.family
30
+ }
31
+
32
+ pub(crate) fn resolver(&self) -> &Arc<dyn Resolver> {
33
+ &self.resolver
34
+ }
35
+ }
36
+
37
+ impl Default for Backends {
38
+ /// The host's own sockets and resolver.
39
+ fn default() -> Self {
40
+ let host = Arc::new(HostInet);
41
+ Self::new(host.clone(), host)
42
+ }
43
+ }