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
@@ -1,115 +0,0 @@
1
- //! Per-channel stdout / stderr capture sizing and clipping.
2
- //!
3
- //! Two pure helpers shared by the run path: one sizes the per-run pipe, the
4
- //! other clips a captured snapshot back to the configured limit and reports
5
- //! whether the limit was passed. Kept channel-agnostic (a function of `limit`,
6
- //! not of which channel) so a regression that only breaks one channel cannot
7
- //! sneak through the test that pins them.
8
-
9
- /// One byte past the limit, so "wrote exactly the limit" and "passed the
10
- /// limit" stay distinguishable.
11
- pub fn pipe_capacity(limit: Option<usize>) -> usize {
12
- match limit {
13
- Some(limit) => limit.saturating_add(1),
14
- None => usize::MAX,
15
- }
16
- }
17
-
18
- /// Takes the snapshot by value and truncates in place, so the readback
19
- /// costs one copy out of the pipe rather than two.
20
- pub fn clip_capture(mut raw: Vec<u8>, limit: Option<usize>) -> (Vec<u8>, bool) {
21
- match limit {
22
- Some(limit) if raw.len() > limit => {
23
- raw.truncate(limit);
24
- (raw, true)
25
- }
26
- _ => (raw, false),
27
- }
28
- }
29
-
30
- #[cfg(test)]
31
- mod tests {
32
- use super::{clip_capture, pipe_capacity};
33
-
34
- // @behavior S-108
35
- #[test]
36
- fn a_pipe_holds_one_byte_past_its_limit() {
37
- assert_eq!(
38
- (pipe_capacity(Some(5)), pipe_capacity(Some(0))),
39
- (6, 1),
40
- "a limit of 5 and of 0 through pipe_capacity must size the pipe 6 and 1"
41
- );
42
- }
43
-
44
- // @behavior S-109
45
- #[test]
46
- fn a_pipe_without_a_limit_holds_usize_max() {
47
- assert_eq!(
48
- pipe_capacity(None),
49
- usize::MAX,
50
- "no limit through pipe_capacity must size the pipe usize::MAX"
51
- );
52
- }
53
-
54
- // @behavior S-110
55
- #[test]
56
- fn a_pipe_past_usize_max_saturates() {
57
- assert_eq!(
58
- pipe_capacity(Some(usize::MAX)),
59
- usize::MAX,
60
- "a limit of usize::MAX through pipe_capacity must saturate at usize::MAX"
61
- );
62
- }
63
-
64
- // @behavior S-111
65
- #[test]
66
- fn a_capture_under_its_limit_stays_whole() {
67
- assert_eq!(
68
- clip_capture(b"abc".to_vec(), Some(5)),
69
- (b"abc".to_vec(), false),
70
- "3 bytes under a limit of 5 through clip_capture must stay whole and untruncated"
71
- );
72
- }
73
-
74
- // @behavior S-112
75
- #[test]
76
- fn a_capture_at_its_limit_is_not_truncated() {
77
- assert_eq!(
78
- clip_capture(b"abcde".to_vec(), Some(5)),
79
- (b"abcde".to_vec(), false),
80
- "5 bytes at a limit of 5 through clip_capture must stay whole and untruncated"
81
- );
82
- }
83
-
84
- // @behavior S-024
85
- #[test]
86
- fn a_capture_past_its_limit_is_clipped_and_truncated() {
87
- // The pipe holds one byte past the limit, so 6 bytes is the most a
88
- // limit of 5 can capture.
89
- assert_eq!(
90
- clip_capture(b"abcdef".to_vec(), Some(5)),
91
- (b"abcde".to_vec(), true),
92
- "6 bytes past a limit of 5 through clip_capture must clip to 5 and flag truncation"
93
- );
94
- }
95
-
96
- // @behavior S-033
97
- #[test]
98
- fn a_capture_without_a_limit_stays_whole() {
99
- assert_eq!(
100
- clip_capture(b"abcdef".to_vec(), None),
101
- (b"abcdef".to_vec(), false),
102
- "6 bytes with no limit through clip_capture must stay whole and untruncated"
103
- );
104
- }
105
-
106
- // @behavior S-100 S-101
107
- #[test]
108
- fn an_empty_capture_stays_empty() {
109
- assert_eq!(
110
- clip_capture(Vec::new(), Some(5)),
111
- (Vec::new(), false),
112
- "no bytes under a limit of 5 through clip_capture must stay empty and untruncated"
113
- );
114
- }
115
- }
@@ -1,238 +0,0 @@
1
- //! The per-invocation memory cap: only the growth past the linear-memory size
2
- //! captured at invocation entry is charged, so the image's initial allocation
3
- //! is outside the budget.
4
-
5
- /// The budget one invocation's memory grows against.
6
- ///
7
- /// `memory_limit` bounds per-invocation growth (`None` disables it).
8
- /// `baseline` is the linear-memory size captured at invocation entry by
9
- /// `MemoryCap::activate`; only the growth past `baseline` is charged against
10
- /// `memory_limit`, so the mruby image's initial allocation and any high-water
11
- /// mark left by prior invocations on the same Sandbox do not consume the
12
- /// budget. An Engine also asks about the module's declared initial allocation
13
- /// at instantiation time, so the cap stays dormant until `MemoryCap::activate`
14
- /// arms it for one invocation.
15
- #[derive(Debug, Clone, Copy)]
16
- pub struct MemoryCap {
17
- memory_limit: Option<usize>,
18
- baseline: usize,
19
- cap_active: bool,
20
- peak: usize,
21
- }
22
-
23
- impl MemoryCap {
24
- pub fn new(memory_limit: Option<usize>) -> Self {
25
- Self {
26
- memory_limit,
27
- baseline: 0,
28
- cap_active: false,
29
- peak: 0,
30
- }
31
- }
32
-
33
- /// The cap stays dormant until armed, because the module's declared
34
- /// initial memory is allocated during instantiation and must pass.
35
- pub fn activate(&mut self, baseline: usize) {
36
- self.baseline = baseline;
37
- self.cap_active = true;
38
- self.peak = 0;
39
- }
40
-
41
- pub fn deactivate(&mut self) {
42
- self.cap_active = false;
43
- }
44
-
45
- /// A grow the cap rejects never updates the peak, so the reported value
46
- /// never exceeds `memory_limit`.
47
- pub fn peak(&self) -> usize {
48
- self.peak
49
- }
50
-
51
- /// Charge a growth to `desired` bytes, refusing one past `memory_limit`.
52
- pub fn charge(&mut self, desired: usize) -> Result<(), MemoryLimitExceeded> {
53
- if !self.cap_active {
54
- return Ok(());
55
- }
56
- let delta = desired.saturating_sub(self.baseline);
57
- if let Some(limit) = self.memory_limit {
58
- if delta > limit {
59
- return Err(MemoryLimitExceeded::new(desired, limit));
60
- }
61
- }
62
- if delta > self.peak {
63
- self.peak = delta;
64
- }
65
- Ok(())
66
- }
67
- }
68
-
69
- /// A growth past the per-invocation memory cap. An Engine ends the invocation
70
- /// with it, and a Wasm Driver finds it again to classify the failure as a
71
- /// memory-limit `Trap`. Callers use the `Display` impl below — no field is
72
- /// read directly — so the inner state stays private.
73
- #[derive(Debug)]
74
- pub struct MemoryLimitExceeded {
75
- desired: usize,
76
- limit: usize,
77
- }
78
-
79
- impl MemoryLimitExceeded {
80
- pub fn new(desired: usize, limit: usize) -> Self {
81
- Self { desired, limit }
82
- }
83
- }
84
-
85
- impl std::fmt::Display for MemoryLimitExceeded {
86
- fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
87
- write!(
88
- f,
89
- "memory usage exceeded memory_limit: \
90
- requested={} bytes, limit={} bytes",
91
- self.desired, self.limit
92
- )
93
- }
94
- }
95
-
96
- impl std::error::Error for MemoryLimitExceeded {}
97
-
98
- #[cfg(test)]
99
- mod tests {
100
- //! The pure delta arithmetic, so a regression that breaks the baseline
101
- //! accounting (dropping the `baseline` subtraction, or letting `activate`
102
- //! carry stale state across invocations) is caught without an Engine.
103
- use super::MemoryCap;
104
-
105
- fn assert_charged(cap: &mut MemoryCap, desired: usize, what: &str) {
106
- assert!(
107
- cap.charge(desired).is_ok(),
108
- "{what} through MemoryCap::charge must be allowed"
109
- );
110
- }
111
-
112
- fn assert_refused(cap: &mut MemoryCap, desired: usize, what: &str) {
113
- assert!(
114
- cap.charge(desired).is_err(),
115
- "{what} through MemoryCap::charge must be refused"
116
- );
117
- }
118
-
119
- // @behavior S-113
120
- #[test]
121
- fn a_growth_before_the_cap_is_armed_is_not_bounded() {
122
- let mut cap = MemoryCap::new(Some(1 << 20));
123
- assert_charged(&mut cap, 100 << 20, "a 100 MiB growth before activate");
124
- }
125
-
126
- // @behavior S-114
127
- #[test]
128
- fn a_growth_within_the_limit_is_allowed() {
129
- let mut cap = MemoryCap::new(Some(1 << 20));
130
- cap.activate(2 << 20);
131
- assert_charged(
132
- &mut cap,
133
- (2 << 20) + (1 << 19),
134
- "a 512 KiB growth past a 2 MiB baseline under a 1 MiB limit",
135
- );
136
- }
137
-
138
- // @behavior S-121
139
- #[test]
140
- fn a_growth_past_the_limit_is_refused() {
141
- let mut cap = MemoryCap::new(Some(1 << 20));
142
- cap.activate(2 << 20);
143
- assert_refused(
144
- &mut cap,
145
- 4 << 20,
146
- "a 2 MiB growth past a 2 MiB baseline under a 1 MiB limit",
147
- );
148
- }
149
-
150
- // @behavior S-008
151
- #[test]
152
- fn each_activation_charges_from_its_own_baseline() {
153
- let mut cap = MemoryCap::new(Some(1 << 20));
154
- cap.activate(2 << 20);
155
- assert_charged(&mut cap, 3 << 20, "a 1 MiB growth in the first invocation");
156
- cap.activate(3 << 20);
157
- assert_charged(
158
- &mut cap,
159
- 4 << 20,
160
- "a 1 MiB growth in the second invocation, past the first one's residue",
161
- );
162
- }
163
-
164
- // @behavior S-009
165
- #[test]
166
- fn a_cap_without_a_limit_allows_any_growth() {
167
- let mut cap = MemoryCap::new(None);
168
- cap.activate(0);
169
- assert_charged(&mut cap, 100 << 20, "a 100 MiB growth with no limit");
170
- }
171
-
172
- // @behavior S-116
173
- #[test]
174
- fn the_peak_is_zero_before_any_growth() {
175
- let cap = MemoryCap::new(Some(1 << 20));
176
- assert_eq!(
177
- cap.peak(),
178
- 0,
179
- "a new cap through MemoryCap::peak must report 0"
180
- );
181
- }
182
-
183
- // @behavior S-115
184
- #[test]
185
- fn the_peak_is_the_highest_growth_past_the_baseline() {
186
- let mut cap = MemoryCap::new(Some(1 << 20));
187
- cap.activate(2 << 20);
188
- assert_charged(&mut cap, (2 << 20) + (1 << 18), "a 256 KiB growth");
189
- assert_charged(&mut cap, (2 << 20) + (1 << 19), "a 512 KiB growth");
190
- assert_charged(&mut cap, (2 << 20) + (1 << 17), "a 128 KiB growth");
191
- assert_eq!(
192
- cap.peak(),
193
- 1 << 19,
194
- "growths of 256, 512, and 128 KiB through MemoryCap::peak must report 512 KiB"
195
- );
196
- }
197
-
198
- // @behavior S-062
199
- #[test]
200
- fn a_refused_growth_leaves_the_peak_alone() {
201
- let mut cap = MemoryCap::new(Some(1 << 20));
202
- cap.activate(2 << 20);
203
- assert_charged(&mut cap, (2 << 20) + (1 << 19), "a 512 KiB growth");
204
- assert_refused(&mut cap, 4 << 20, "a 2 MiB growth under a 1 MiB limit");
205
- assert_eq!(
206
- cap.peak(),
207
- 1 << 19,
208
- "a refused 2 MiB growth through MemoryCap::peak must leave 512 KiB reported"
209
- );
210
- }
211
-
212
- // @behavior S-117
213
- #[test]
214
- fn each_activation_resets_the_peak() {
215
- let mut cap = MemoryCap::new(Some(1 << 20));
216
- cap.activate(2 << 20);
217
- assert_charged(&mut cap, (2 << 20) + (1 << 19), "a 512 KiB growth");
218
- cap.activate(3 << 20);
219
- assert_eq!(
220
- cap.peak(),
221
- 0,
222
- "a second activate through MemoryCap::peak must report 0"
223
- );
224
- }
225
-
226
- // @behavior S-118
227
- #[test]
228
- fn a_cap_without_a_limit_still_reports_its_peak() {
229
- let mut cap = MemoryCap::new(None);
230
- cap.activate(1 << 20);
231
- assert_charged(&mut cap, 5 << 20, "a 4 MiB growth with no limit");
232
- assert_eq!(
233
- cap.peak(),
234
- 4 << 20,
235
- "a 4 MiB growth with no limit through MemoryCap::peak must report 4 MiB"
236
- );
237
- }
238
- }
@@ -1,21 +0,0 @@
1
- //! Paths beneath a Filesystem's root, components joined by `/` and the
2
- //! empty path being the root: the files a Host App seeds a Tmpfs with.
3
-
4
- /// The last name of `path`, within its parent.
5
- pub(crate) fn name(path: &str) -> &str {
6
- path.rsplit_once('/').map_or(path, |(_, name)| name)
7
- }
8
-
9
- /// Every directory above `path`, outermost first, the root left out.
10
- pub(crate) fn ancestors(path: &str) -> impl Iterator<Item = &str> {
11
- path.match_indices('/').map(move |(end, _)| &path[..end])
12
- }
13
-
14
- /// A path a Host App seeds a Filesystem with, in the form a runtime hands
15
- /// over: no leading `/`, and no empty or `.` component.
16
- pub(crate) fn normalize_seed(path: &str) -> String {
17
- path.split('/')
18
- .filter(|component| !component.is_empty() && *component != ".")
19
- .collect::<Vec<_>>()
20
- .join("/")
21
- }
@@ -1,153 +0,0 @@
1
- //! Why a call on a Filesystem failed, under the POSIX name each failure
2
- //! stands for, as Linux's calls answer an errno.
3
-
4
- use crate::locking::DownError;
5
-
6
- /// Why a Filesystem call failed, for the ABI above to encode as its error code.
7
- #[derive(Clone, Debug, PartialEq, Eq)]
8
- #[non_exhaustive]
9
- pub enum FilesystemError {
10
- NotFound,
11
- AlreadyExists,
12
- NotADirectory,
13
- IsADirectory,
14
- DirectoryNotEmpty,
15
- PermissionDenied,
16
- ReadOnlyFilesystem,
17
- InvalidInput,
18
- Unsupported,
19
- /// A change past what the Filesystem can hold.
20
- StorageFull,
21
- /// A file grown past the largest the Filesystem keeps.
22
- FileTooLarge,
23
- /// A move that cannot happen in one step, as between two devices.
24
- CrossesDevices,
25
- /// A path that is absolute, climbs above the directory it is resolved
26
- /// beneath, or holds a link that does either, as `openat2`'s
27
- /// `RESOLVE_BENEATH` refuses one. Linux names it EXDEV as well, and an ABI
28
- /// may have a code of its own for it.
29
- Escape,
30
- /// A call that would wait on a lock its own thread holds.
31
- Deadlock,
32
- /// A symbolic link where the call asked to follow none.
33
- FilesystemLoop,
34
- /// A call only a privileged caller may make, as apart from one the
35
- /// file's permissions deny.
36
- NotPermitted,
37
- BadDescriptor,
38
- ResourceBusy,
39
- /// Bytes that are no valid character where the call needs one.
40
- IllegalSequence,
41
- Interrupted,
42
- /// A call to make again, as a walk a move landed in answers.
43
- WouldBlock,
44
- TooManyOpenFiles,
45
- /// A name too long for the Filesystem.
46
- InvalidFilename,
47
- OutOfMemory,
48
- NotASocket,
49
- /// A value too large for the type the call answers in.
50
- ValueTooLarge,
51
- NotSeekable,
52
- /// A call the kind of file it reached cannot take, as a device that
53
- /// allocates nothing.
54
- NoSuchDevice,
55
- /// A directory a lookup found standing elsewhere, which could not be moved
56
- /// to the name it was found under.
57
- StaleNetworkFileHandle,
58
- /// Any other failure, with what the Filesystem knows of it.
59
- Other(String),
60
- }
61
-
62
- /// Each failure a Filesystem can name under the POSIX error name it stands for.
63
- /// `ENOTSUP` comes before `EOPNOTSUPP`, a name some hosts give the same error,
64
- /// so `Unsupported` answers to the first.
65
- const POSIX_NAMES: [(&str, FilesystemError); 29] = [
66
- ("EAGAIN", FilesystemError::WouldBlock),
67
- ("ENOENT", FilesystemError::NotFound),
68
- ("EEXIST", FilesystemError::AlreadyExists),
69
- ("ENOTDIR", FilesystemError::NotADirectory),
70
- ("EISDIR", FilesystemError::IsADirectory),
71
- ("ENOTEMPTY", FilesystemError::DirectoryNotEmpty),
72
- ("EACCES", FilesystemError::PermissionDenied),
73
- ("EROFS", FilesystemError::ReadOnlyFilesystem),
74
- ("EINVAL", FilesystemError::InvalidInput),
75
- ("ENOTSUP", FilesystemError::Unsupported),
76
- ("EOPNOTSUPP", FilesystemError::Unsupported),
77
- ("ENOSPC", FilesystemError::StorageFull),
78
- ("EFBIG", FilesystemError::FileTooLarge),
79
- ("EXDEV", FilesystemError::CrossesDevices),
80
- ("EDEADLK", FilesystemError::Deadlock),
81
- ("ELOOP", FilesystemError::FilesystemLoop),
82
- ("EPERM", FilesystemError::NotPermitted),
83
- ("EBADF", FilesystemError::BadDescriptor),
84
- ("EBUSY", FilesystemError::ResourceBusy),
85
- ("EILSEQ", FilesystemError::IllegalSequence),
86
- ("EINTR", FilesystemError::Interrupted),
87
- ("EMFILE", FilesystemError::TooManyOpenFiles),
88
- ("ENAMETOOLONG", FilesystemError::InvalidFilename),
89
- ("ENOMEM", FilesystemError::OutOfMemory),
90
- ("ENOTSOCK", FilesystemError::NotASocket),
91
- ("EOVERFLOW", FilesystemError::ValueTooLarge),
92
- ("ESPIPE", FilesystemError::NotSeekable),
93
- ("ENODEV", FilesystemError::NoSuchDevice),
94
- ("ESTALE", FilesystemError::StaleNetworkFileHandle),
95
- ];
96
-
97
- impl From<DownError> for FilesystemError {
98
- fn from(error: DownError) -> Self {
99
- match error {
100
- DownError::Deadlock => Self::Deadlock,
101
- DownError::Interrupted => Self::Interrupted,
102
- }
103
- }
104
- }
105
-
106
- impl FilesystemError {
107
- /// The POSIX error name this failure stands for, as `ENOENT`. `Other`
108
- /// has none, and `Escape` shares `CrossesDevices`'s.
109
- pub fn posix_name(&self) -> Option<&'static str> {
110
- if *self == Self::Escape {
111
- return Some("EXDEV");
112
- }
113
- POSIX_NAMES
114
- .iter()
115
- .find(|(_, error)| error == self)
116
- .map(|(name, _)| *name)
117
- }
118
-
119
- /// The failure a POSIX error name stands for, if it is one of these.
120
- pub fn from_posix_name(name: &str) -> Option<Self> {
121
- POSIX_NAMES
122
- .iter()
123
- .find(|(known, _)| *known == name)
124
- .map(|(_, error)| error.clone())
125
- }
126
- }
127
-
128
- #[cfg(test)]
129
- mod tests {
130
- use super::*;
131
-
132
- #[test]
133
- fn every_posix_name_answers_back_to_its_failure() {
134
- for (name, error) in &POSIX_NAMES {
135
- assert_eq!(
136
- FilesystemError::from_posix_name(name)
137
- .as_ref()
138
- .and_then(FilesystemError::posix_name)
139
- .and_then(FilesystemError::from_posix_name),
140
- Some(error.clone()),
141
- "{name} through FilesystemError::from_posix_name and posix_name must name {error:?} again"
142
- );
143
- }
144
- assert_eq!(
145
- (
146
- FilesystemError::Unsupported.posix_name(),
147
- FilesystemError::Other("x".into()).posix_name()
148
- ),
149
- (Some("ENOTSUP"), None),
150
- "Unsupported through FilesystemError::posix_name must answer ENOTSUP, and Other none"
151
- );
152
- }
153
- }
@@ -1,171 +0,0 @@
1
- //! The calls a sequence is made of, drawn from a seed so a run repeats and an
2
- //! older commit can be held to the same one.
3
-
4
- /// How many descriptors a sequence holds at once.
5
- pub const SLOTS: usize = 4;
6
-
7
- /// The modified time a call sets, seconds past the Unix epoch.
8
- pub const UTIME_SECONDS: i64 = 1;
9
-
10
- /// One call, made alike through the VFS and through Linux. A path call starts
11
- /// from the root, or from the descriptor `base` names.
12
- #[derive(Clone, Debug)]
13
- pub enum Call {
14
- Open(Open),
15
- Close(usize),
16
- Read(usize, usize),
17
- Write(usize, usize),
18
- Pread(usize, usize, u64),
19
- Pwrite(usize, usize, u64),
20
- Seek(usize, i64, u8),
21
- Truncate(usize, u64),
22
- Fallocate(usize, u64, u64),
23
- Fstat(usize),
24
- Fsync(usize),
25
- Readdir(usize),
26
- Stat {
27
- base: Option<usize>,
28
- path: String,
29
- follow: bool,
30
- },
31
- Utimes {
32
- base: Option<usize>,
33
- path: String,
34
- follow: bool,
35
- },
36
- Mkdir(Option<usize>, String),
37
- Rmdir(Option<usize>, String),
38
- Unlink(Option<usize>, String),
39
- Rename(Option<usize>, String, String),
40
- }
41
-
42
- /// What an open asks for, and the descriptor it lands in.
43
- #[derive(Clone, Debug, Default)]
44
- pub struct Open {
45
- pub base: Option<usize>,
46
- pub path: String,
47
- pub read: bool,
48
- pub write: bool,
49
- pub create: bool,
50
- pub exclusive: bool,
51
- pub truncate: bool,
52
- pub append: bool,
53
- pub directory: bool,
54
- pub nofollow: bool,
55
- pub slot: usize,
56
- }
57
-
58
- impl Call {
59
- /// The call's name, which a difference and a coverage count are kept by.
60
- pub fn kind(&self) -> &'static str {
61
- match self {
62
- Self::Open(_) => "Open",
63
- Self::Close(_) => "Close",
64
- Self::Read(..) => "Read",
65
- Self::Write(..) => "Write",
66
- Self::Pread(..) => "Pread",
67
- Self::Pwrite(..) => "Pwrite",
68
- Self::Seek(..) => "Seek",
69
- Self::Truncate(..) => "Truncate",
70
- Self::Fallocate(..) => "Fallocate",
71
- Self::Utimes { .. } => "Utimes",
72
- Self::Fstat(_) => "Fstat",
73
- Self::Fsync(_) => "Fsync",
74
- Self::Readdir(_) => "Readdir",
75
- Self::Stat { .. } => "Stat",
76
- Self::Mkdir(..) => "Mkdir",
77
- Self::Rmdir(..) => "Rmdir",
78
- Self::Unlink(..) => "Unlink",
79
- Self::Rename(..) => "Rename",
80
- }
81
- }
82
- }
83
-
84
- /// The bytes a write of `len` carries.
85
- pub fn payload(len: usize) -> &'static [u8] {
86
- &b"WXYZ"[..len.min(4)]
87
- }
88
-
89
- /// A small generator, so a seed names the same sequence on every toolchain.
90
- pub struct Rng(u64);
91
-
92
- impl Rng {
93
- pub fn new(seed: u64) -> Self {
94
- let mut rng = Self(seed.wrapping_mul(0x9E37_79B9_7F4A_7C15) | 1);
95
- for _ in 0..4 {
96
- rng.next();
97
- }
98
- rng
99
- }
100
-
101
- fn next(&mut self) -> u64 {
102
- self.0 ^= self.0 << 13;
103
- self.0 ^= self.0 >> 7;
104
- self.0 ^= self.0 << 17;
105
- self.0
106
- }
107
-
108
- pub fn random_below(&mut self, bound: u64) -> u64 {
109
- self.next() % bound
110
- }
111
-
112
- fn random_ratio(&mut self, numerator: u64, denominator: u64) -> bool {
113
- self.random_below(denominator) < numerator
114
- }
115
-
116
- fn choose_path(&mut self, paths: &[String]) -> String {
117
- paths[self.random_below(paths.len() as u64) as usize].clone()
118
- }
119
-
120
- /// The next call of a sequence over `paths`.
121
- pub fn call(&mut self, paths: &[String]) -> Call {
122
- let slot = self.random_below(SLOTS as u64) as usize;
123
- let base = self
124
- .random_ratio(25, 100)
125
- .then(|| self.random_below(SLOTS as u64) as usize);
126
- match self.random_below(100) {
127
- 0..=27 => Call::Open(Open {
128
- base,
129
- path: self.choose_path(paths),
130
- read: self.random_ratio(70, 100),
131
- write: self.random_ratio(45, 100),
132
- create: self.random_ratio(30, 100),
133
- exclusive: self.random_ratio(10, 100),
134
- truncate: self.random_ratio(10, 100),
135
- append: self.random_ratio(12, 100),
136
- directory: self.random_ratio(12, 100),
137
- nofollow: self.random_ratio(15, 100),
138
- slot,
139
- }),
140
- 28..=32 => Call::Close(slot),
141
- 33..=38 => Call::Read(slot, self.random_below(8) as usize),
142
- 39..=45 => Call::Write(slot, self.random_below(4) as usize),
143
- 46..=48 => Call::Pread(slot, self.random_below(8) as usize, self.random_below(10)),
144
- 49..=51 => Call::Pwrite(slot, self.random_below(4) as usize, self.random_below(10)),
145
- 52..=54 => Call::Seek(
146
- slot,
147
- self.random_below(14) as i64 - 4,
148
- self.random_below(3) as u8,
149
- ),
150
- 55..=58 => Call::Truncate(slot, self.random_below(12)),
151
- 59..=62 => Call::Fstat(slot),
152
- 63..=64 => Call::Fsync(slot),
153
- 65..=68 => Call::Readdir(slot),
154
- 69..=73 => Call::Stat {
155
- base,
156
- path: self.choose_path(paths),
157
- follow: self.random_ratio(50, 100),
158
- },
159
- 74..=79 => Call::Mkdir(base, self.choose_path(paths)),
160
- 80..=85 => Call::Rmdir(base, self.choose_path(paths)),
161
- 86..=89 => Call::Unlink(base, self.choose_path(paths)),
162
- 90 => Call::Fallocate(slot, self.random_below(10), self.random_below(5)),
163
- 91 => Call::Utimes {
164
- base,
165
- path: self.choose_path(paths),
166
- follow: self.random_ratio(50, 100),
167
- },
168
- _ => Call::Rename(base, self.choose_path(paths), self.choose_path(paths)),
169
- }
170
- }
171
- }