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
@@ -3,12 +3,14 @@
3
3
  //!
4
4
  //! Owned as the data of each per-invocation `wasmtime::Store`
5
5
  //! and threaded through every host import —
6
- //! the `__kobako_upcall` dispatcher reads the bound dispatch handler,
6
+ //! the `upcall` dispatcher reads the bound dispatch handler, the `preamble`
7
+ //! import the Invocation's Preamble,
7
8
  //! and the WASI imports read the invocation's `Wasi` context, which the
8
9
  //! Store is created with.
9
10
  //!
10
11
  //! The slot also carries the per-invocation wall-clock deadline and the
11
- //! memory cap `MemoryLimiter`, both read from the wasmtime
12
+ //! `MemoryLimiter` charging the guest's growth to the memory budget its
13
+ //! Cred carries, both read from the wasmtime
12
14
  //! `epoch_deadline_callback` / `ResourceLimiter` callbacks installed in
13
15
  //! `Driver::new_store`.
14
16
 
@@ -16,7 +18,8 @@ use std::sync::Arc;
16
18
  use std::time::{Duration, Instant};
17
19
 
18
20
  use kobako_runtime::dispatch::DispatchHandler;
19
- use kobako_runtime::endpoint::{Calls, MemoryCap, ABANDONED};
21
+ use kobako_runtime::endpoint::{Calls, ABANDONED};
22
+ use kobako_runtime::profile::Profile;
20
23
 
21
24
  use crate::exports::Exports;
22
25
  use crate::limiter::MemoryLimiter;
@@ -39,22 +42,37 @@ pub(crate) struct Invocation {
39
42
  wall_time: Duration,
40
43
  exports: Option<Exports>,
41
44
  hostcall_fuel: usize,
45
+ preamble: Arc<[u8]>,
42
46
  }
43
47
 
44
48
  impl Invocation {
45
- pub(crate) fn new(memory_limit: Option<usize>, wasi: Wasi) -> Self {
49
+ /// The guest's growth is charged to the budget `wasi`'s Cred charges what
50
+ /// the host holds for it to, so both count against one `memory_limit`.
51
+ pub(crate) fn new(wasi: Wasi) -> Self {
52
+ let limiter = MemoryLimiter::new(wasi.cred().memory_budget().clone());
46
53
  Self {
47
54
  wasi,
48
55
  calls: Calls::default(),
49
56
  deadline: None,
50
- limiter: MemoryLimiter(MemoryCap::new(memory_limit)),
57
+ limiter,
51
58
  wall_entry: None,
52
59
  wall_time: Duration::ZERO,
53
60
  exports: None,
54
61
  hostcall_fuel: 0,
62
+ preamble: Arc::from([]),
55
63
  }
56
64
  }
57
65
 
66
+ /// The Preamble bytes the `preamble` import hands the guest; empty until
67
+ /// an entry sets them.
68
+ pub(crate) fn preamble(&self) -> Arc<[u8]> {
69
+ Arc::clone(&self.preamble)
70
+ }
71
+
72
+ pub(crate) fn set_preamble(&mut self, preamble: Vec<u8>) {
73
+ self.preamble = Arc::from(preamble);
74
+ }
75
+
58
76
  /// How much of the guest's memory the call under way may have the host
59
77
  /// copy or walk, as wasmtime hands each host call.
60
78
  pub(crate) fn hostcall_fuel(&self) -> usize {
@@ -107,6 +125,10 @@ impl Invocation {
107
125
  self.deadline
108
126
  }
109
127
 
128
+ pub(crate) fn profile(&self) -> Profile {
129
+ self.wasi.profile()
130
+ }
131
+
110
132
  pub(crate) fn limiter_mut(&mut self) -> &mut MemoryLimiter {
111
133
  &mut self.limiter
112
134
  }
@@ -114,18 +136,19 @@ impl Invocation {
114
136
  /// Only the `memory.grow` delta past `baseline` is charged, so the
115
137
  /// image's initial allocation and the high-water mark of earlier
116
138
  /// invocations do not consume the budget.
117
- pub(crate) fn arm_memory_cap(&mut self, baseline: usize) {
118
- self.limiter.0.activate(baseline);
139
+ pub(crate) fn arm_memory_budget(&mut self, baseline: usize) {
140
+ self.limiter.budget().arm(baseline);
119
141
  }
120
142
 
121
143
  /// Disarmed once the export returns, so post-run host bookkeeping such
122
144
  /// as reading the answer back is not charged to the script.
123
- pub(crate) fn disarm_memory_cap(&mut self) {
124
- self.limiter.0.deactivate();
145
+ pub(crate) fn disarm_memory_budget(&mut self) {
146
+ self.limiter.budget().disarm();
125
147
  }
126
148
 
127
- /// Stamped right before the guest export call, so the bracket matches
128
- /// the `timeout` accounting and excludes post-run host bookkeeping.
149
+ /// Stamped as the Store opens, so instantiating the guest and writing its
150
+ /// request count as the `timeout` counts them, and post-run host
151
+ /// bookkeeping stays out.
129
152
  pub(crate) fn start_wall_clock(&mut self) {
130
153
  self.wall_entry = Some(Instant::now());
131
154
  }
@@ -141,6 +164,45 @@ impl Invocation {
141
164
  }
142
165
 
143
166
  pub(crate) fn memory_peak(&self) -> usize {
144
- self.limiter.0.peak()
167
+ self.limiter.budget().peak()
168
+ }
169
+ }
170
+
171
+ #[cfg(test)]
172
+ impl Invocation {
173
+ /// An invocation under `config` whose one network entry holds
174
+ /// `endpoints`.
175
+ pub(crate) fn with_network(
176
+ config: &crate::config::Config,
177
+ endpoints: impl IntoIterator<Item = kobako_runtime::network::Endpoint>,
178
+ ) -> Self {
179
+ use kobako_runtime::grant::Grant;
180
+ use kobako_runtime::network::{Builder, Network};
181
+
182
+ let mut entry = Builder::default();
183
+ for endpoint in endpoints {
184
+ entry.endpoint(endpoint);
185
+ }
186
+ let grant = Grant::Network(Network::new("local", Arc::new(entry)).unwrap());
187
+ let wasi = Wasi::for_invocation(config, &[grant]).expect("WASI context must build");
188
+ Self::new(wasi)
189
+ }
190
+
191
+ /// A hermetic invocation whose one network entry holds `endpoints`, or
192
+ /// with no network for `None`, under the hermetic config `adjust` moves.
193
+ pub(crate) fn hermetic(
194
+ endpoints: Option<Vec<kobako_runtime::network::Endpoint>>,
195
+ adjust: impl FnOnce(&mut crate::config::Config),
196
+ ) -> Self {
197
+ let mut config =
198
+ crate::config::Config::for_profile(kobako_runtime::profile::Profile::Hermetic);
199
+ adjust(&mut config);
200
+ match endpoints {
201
+ Some(endpoints) => Self::with_network(&config, endpoints),
202
+ None => {
203
+ let wasi = Wasi::for_invocation(&config, &[]).expect("WASI context must build");
204
+ Self::new(wasi)
205
+ }
206
+ }
145
207
  }
146
208
  }
@@ -5,8 +5,8 @@
5
5
  //! every invocation instantiates a fresh instance from a pre-linked
6
6
  //! template and discards the whole Store afterwards — the
7
7
  //! per-invocation instance discipline. Everything engine-bound
8
- //! lives behind the contract surface, so a frontend shell (the Ruby
9
- //! ext's `Kobako::Runtime`) sees no wasmtime type.
8
+ //! lives behind the contract surface, so a frontend sees no wasmtime
9
+ //! type.
10
10
  //!
11
11
  //! Each module holds one responsibility and opens with its own doc.
12
12
 
@@ -14,15 +14,17 @@ mod abi;
14
14
  mod ambient;
15
15
  mod cache;
16
16
  mod config;
17
- mod descriptors;
18
17
  mod driver;
19
18
  mod exports;
20
19
  mod guest;
20
+ #[cfg(test)]
21
+ mod guest_binary;
21
22
  mod imports;
22
23
  mod instance_pre;
23
24
  mod invocation;
24
25
  mod limiter;
25
26
  mod preview1;
27
+ mod preview2;
26
28
  mod trap;
27
29
  mod wasi;
28
30
 
@@ -1,11 +1,32 @@
1
- //! Hands wasmtime's growth hook to the runtime's per-invocation memory cap.
1
+ //! Hands wasmtime's growth hook to the runtime's per-invocation memory budget.
2
2
 
3
- use kobako_runtime::endpoint::MemoryCap;
3
+ use std::sync::Arc;
4
+
5
+ use kobako_runtime::memcg::{GrowthCharge, MemoryBudget};
4
6
  use wasmtime::ResourceLimiter;
5
7
 
6
8
  /// wasmtime asks this as `memory.grow` runs; an `Err` becomes the trap
7
- /// surfaced to the host as a guest invocation failure.
8
- pub(crate) struct MemoryLimiter(pub(crate) MemoryCap);
9
+ /// surfaced to the host as a guest invocation failure. A growth it allowed
10
+ /// may still fail, past the memory's maximum or for want of host memory, and
11
+ /// its charge is then given back.
12
+ pub(crate) struct MemoryLimiter {
13
+ budget: Arc<MemoryBudget>,
14
+ pending: Option<GrowthCharge>,
15
+ }
16
+
17
+ impl MemoryLimiter {
18
+ pub(crate) fn new(budget: Arc<MemoryBudget>) -> Self {
19
+ Self {
20
+ budget,
21
+ pending: None,
22
+ }
23
+ }
24
+
25
+ /// The budget it charges.
26
+ pub(crate) fn budget(&self) -> &MemoryBudget {
27
+ &self.budget
28
+ }
29
+ }
9
30
 
10
31
  impl ResourceLimiter for MemoryLimiter {
11
32
  fn memory_growing(
@@ -14,10 +35,21 @@ impl ResourceLimiter for MemoryLimiter {
14
35
  desired: usize,
15
36
  _maximum: Option<usize>,
16
37
  ) -> wasmtime::Result<bool> {
17
- self.0.charge(desired).map_err(wasmtime::Error::new)?;
38
+ let charge = self
39
+ .budget
40
+ .charge_growth(desired)
41
+ .map_err(wasmtime::Error::new)?;
42
+ self.pending = Some(charge);
18
43
  Ok(true)
19
44
  }
20
45
 
46
+ fn memory_grow_failed(&mut self, _error: wasmtime::Error) -> wasmtime::Result<()> {
47
+ if let Some(charge) = self.pending.take() {
48
+ self.budget.cancel_growth(charge);
49
+ }
50
+ Ok(())
51
+ }
52
+
21
53
  fn table_growing(
22
54
  &mut self,
23
55
  _current: usize,
@@ -27,3 +59,36 @@ impl ResourceLimiter for MemoryLimiter {
27
59
  Ok(true)
28
60
  }
29
61
  }
62
+
63
+ #[cfg(test)]
64
+ mod tests {
65
+ use kobako_runtime::memcg::MemoryCharge;
66
+ use wasmtime::{Engine, Memory, MemoryType, Store};
67
+
68
+ use super::*;
69
+
70
+ const PAGE: usize = 64 * 1024;
71
+
72
+ // wasmtime asks the limiter before it checks the memory's own maximum, so
73
+ // only a growth it fails after the budget allowed it shows the charge
74
+ // given back.
75
+ // @behavior S-211
76
+ #[test]
77
+ fn a_growth_the_engine_fails_to_make_costs_the_budget_nothing() {
78
+ let budget = MemoryBudget::new(Some(3 * PAGE));
79
+ budget.arm(PAGE);
80
+ let mut store = Store::new(&Engine::default(), MemoryLimiter::new(budget.clone()));
81
+ store.limiter(|limiter| limiter);
82
+ let memory = Memory::new(&mut store, MemoryType::new(1, Some(2)))
83
+ .expect("a memory of one page within its maximum must be made");
84
+ let failed = memory.grow(&mut store, 2).is_err();
85
+ let peak = budget.peak();
86
+ let held = MemoryCharge::new(&budget, 2 * PAGE).is_ok();
87
+ assert_eq!(
88
+ (failed, peak, held),
89
+ (true, 2 * PAGE, true),
90
+ "a growth past a memory's maximum that the budget allowed must fail, give the \
91
+ budget back for the host to hold, and stay in the peak reported"
92
+ );
93
+ }
94
+ }
@@ -0,0 +1,309 @@
1
+ //! The guest's descriptor table: what each preview1 file descriptor
2
+ //! stands for within one invocation.
3
+ //!
4
+ //! kobako answers every preview1 call that reads this table, so the guest
5
+ //! sees one table and no call falls through to a second one that
6
+ //! disagrees. Numbering follows Linux's `alloc_fd`: the lowest number the
7
+ //! table does not hold is taken. Each number stands over a handle in
8
+ //! preview2's resource table, which holds the file and counts it, as
9
+ //! wasmtime-wasi's preview1 numbers apart from the `ResourceTable` it shares
10
+ //! with preview2. The standard streams stand over preview2 streams, as
11
+ //! `wasi:cli` hands them out, each over its end of a pipe and lent to its
12
+ //! descriptor, so the guest drops none while the descriptor stands.
13
+
14
+ use std::collections::BTreeMap;
15
+ use std::ops::{Deref, DerefMut};
16
+ use std::sync::{Arc, MutexGuard};
17
+
18
+ use kobako_runtime::cred::Cred;
19
+ use kobako_runtime::mount::Mount;
20
+ use kobako_runtime::vfs::File;
21
+ use kobako_runtime::Errno;
22
+
23
+ pub(crate) use crate::preview2::bindings::wasi_filesystem_types_0_2_12::Descriptor as FileHandle;
24
+ use crate::preview2::bindings::wasi_io_streams_0_2_12::{
25
+ InputStream as InputHandle, OutputStream as OutputHandle,
26
+ };
27
+ use crate::preview2::io::{InputStream, OutputStream, Stream};
28
+ use crate::preview2::table::Handle;
29
+ use crate::preview2::Table;
30
+
31
+ /// The preview2 resource one descriptor stands over, by its handle.
32
+ #[derive(Clone, Copy)]
33
+ pub(crate) enum Resource {
34
+ File(FileHandle),
35
+ /// stdin, read as `wasi:cli`'s `get-stdin` hands it.
36
+ Input(InputHandle),
37
+ /// stdout or stderr, written as `wasi:cli`'s `get-stdout` hands it.
38
+ Output(OutputHandle),
39
+ }
40
+
41
+ impl Resource {
42
+ /// The stream a standard stream's descriptor stands over, if it is one.
43
+ fn stream(self, table: &Table) -> Option<&Stream> {
44
+ match self {
45
+ Resource::File(_) => None,
46
+ Resource::Input(handle) => table.get(handle).ok().map(|input| &input.stream),
47
+ Resource::Output(handle) => table.get(handle).ok().map(|output| &output.stream),
48
+ }
49
+ }
50
+ }
51
+
52
+ /// What one descriptor stands for, as Linux's fd table holds a `struct file`.
53
+ pub(crate) struct Descriptor {
54
+ pub(crate) resource: Resource,
55
+ /// The guest path a preopen names; an outermost Mount's root has one.
56
+ pub(crate) preopen_path: Option<String>,
57
+ }
58
+
59
+ impl Descriptor {
60
+ /// The descriptor of the file under `file`, naming no preopen.
61
+ pub(crate) fn for_file(file: FileHandle) -> Self {
62
+ Self {
63
+ resource: Resource::File(file),
64
+ preopen_path: None,
65
+ }
66
+ }
67
+
68
+ fn for_stream(resource: Resource) -> Self {
69
+ Self {
70
+ resource,
71
+ preopen_path: None,
72
+ }
73
+ }
74
+ }
75
+
76
+ pub(crate) struct Descriptors {
77
+ used: BTreeMap<u32, Descriptor>,
78
+ /// No number below this is free, as Linux's `next_fd` hints `alloc_fd`.
79
+ next_fd: u32,
80
+ }
81
+
82
+ impl Descriptors {
83
+ /// The table every invocation starts from: stdin, then the two
84
+ /// Channels, then one preopen per Mount among `mounts`, from descriptor
85
+ /// 3. Each counts against the open files in `table`, as a process's
86
+ /// `RLIMIT_NOFILE` counts every one it holds. Each opens, as `opener`, the
87
+ /// Cred the Driver prepared, the topmost mount stacked on its root for
88
+ /// `guest`, as Linux's `topmost_overmount` answers.
89
+ pub(crate) fn new(
90
+ stdin: File,
91
+ stdout: File,
92
+ stderr: File,
93
+ mounts: &[&Mount],
94
+ table: &mut Table,
95
+ (opener, guest): (&Arc<Cred>, &Arc<Cred>),
96
+ ) -> Result<Self, Errno> {
97
+ let mut used = BTreeMap::new();
98
+ let input = InputStream::new(Stream::from(stdin));
99
+ let input = lend_inherited(table, input)?;
100
+ used.insert(0, Descriptor::for_stream(Resource::Input(input)));
101
+ for (fd, file) in [(1, stdout), (2, stderr)] {
102
+ let output = lend_inherited(table, OutputStream::new(Stream::from(file)))?;
103
+ used.insert(fd, Descriptor::for_stream(Resource::Output(output)));
104
+ }
105
+ for (fd, mount) in (3..).zip(mounts) {
106
+ let root = File::root(&guest.topmost_overmount(mount.mnt()), opener)?;
107
+ used.insert(
108
+ fd,
109
+ Descriptor {
110
+ resource: Resource::File(install_inherited(table, root)?),
111
+ preopen_path: Some(mount.at().to_string()),
112
+ },
113
+ );
114
+ }
115
+ Ok(Self {
116
+ next_fd: used.len() as u32,
117
+ used,
118
+ })
119
+ }
120
+
121
+ pub(crate) fn get(&self, fd: u32) -> Option<&Descriptor> {
122
+ self.used.get(&fd)
123
+ }
124
+
125
+ /// Take `fd` out of the table, freeing its number for reuse.
126
+ pub(crate) fn remove(&mut self, fd: u32) -> Option<Descriptor> {
127
+ let descriptor = self.used.remove(&fd)?;
128
+ self.next_fd = self.next_fd.min(fd);
129
+ Some(descriptor)
130
+ }
131
+
132
+ /// Place `descriptor` at `fd`, a number the caller has just freed or
133
+ /// `lowest_unused` found, as Linux's `fd_install` does.
134
+ pub(crate) fn place(&mut self, fd: u32, descriptor: Descriptor) {
135
+ self.used.insert(fd, descriptor);
136
+ if fd == self.next_fd {
137
+ self.next_fd = self.lowest_unused().unwrap_or(u32::MAX);
138
+ }
139
+ }
140
+
141
+ /// The number the next descriptor takes, the lowest one the table does
142
+ /// not hold, as Linux's `get_unused_fd_flags` finds it.
143
+ pub(crate) fn lowest_unused(&self) -> Option<u32> {
144
+ (self.next_fd..=u32::MAX).find(|fd| !self.used.contains_key(fd))
145
+ }
146
+
147
+ /// The file `fd` stands for, one that stands only for its path included:
148
+ /// the one `table` holds, or the pipe's end a standard stream stands
149
+ /// over, which answers each call as Linux's pipe does.
150
+ pub(crate) fn file<'a>(&self, fd: u32, table: &'a Table) -> Option<FileRef<'a>> {
151
+ let resource = self.get(fd)?.resource;
152
+ Some(match resource {
153
+ Resource::File(handle) => FileRef::Table(table.get(handle).ok()?),
154
+ stream => FileRef::Stream(stream.stream(table)?.lock()),
155
+ })
156
+ }
157
+
158
+ /// The file `fd` stands for, to change.
159
+ pub(crate) fn file_mut<'a>(&self, fd: u32, table: &'a mut Table) -> Option<FileRefMut<'a>> {
160
+ let resource = self.get(fd)?.resource;
161
+ Some(match resource {
162
+ Resource::File(handle) => FileRefMut::Table(table.get_mut(handle).ok()?),
163
+ stream => FileRefMut::Stream(stream.stream(table)?.lock()),
164
+ })
165
+ }
166
+
167
+ /// Take `fd` out of the table, and what it stood over out of `table`:
168
+ /// the file to close, or none for a standard stream, whose lend ends
169
+ /// while preview2's handle keeps the stream.
170
+ pub(crate) fn take(&mut self, fd: u32, table: &mut Table) -> Option<Option<File>> {
171
+ Some(match self.remove(fd)?.resource {
172
+ Resource::File(handle) => table.delete(handle).ok(),
173
+ Resource::Input(handle) => {
174
+ table.end_lend(handle);
175
+ None
176
+ }
177
+ Resource::Output(handle) => {
178
+ table.end_lend(handle);
179
+ None
180
+ }
181
+ })
182
+ }
183
+
184
+ /// Open `file` under the lowest free descriptor; `None` when the
185
+ /// Invocation holds as many files as it may.
186
+ #[cfg(test)]
187
+ pub(crate) fn push_file(&mut self, file: File, table: &mut Table) -> Option<u32> {
188
+ let room = table.reserve_file::<FileHandle>().ok()?;
189
+ let fd = self.lowest_unused()?;
190
+ let handle = table.install(room, file);
191
+ self.place(fd, Descriptor::for_file(handle));
192
+ Some(fd)
193
+ }
194
+ }
195
+
196
+ /// The handle `resource`, opened before the guest runs, takes in `table`;
197
+ /// refused past the open file limit.
198
+ fn install_inherited<H: Handle>(table: &mut Table, resource: H::Host) -> Result<H, Errno> {
199
+ let room = table.reserve_inherited_file()?;
200
+ Ok(table.install(room, resource))
201
+ }
202
+
203
+ /// The handle a standard stream takes in `table`, lent to the descriptor
204
+ /// standing over it.
205
+ fn lend_inherited<H: Handle>(table: &mut Table, stream: H::Host) -> Result<H, Errno> {
206
+ let handle = install_inherited(table, stream)?;
207
+ table.lend(handle);
208
+ Ok(handle)
209
+ }
210
+
211
+ /// A file a descriptor stands for, as `Descriptors::file` finds it.
212
+ pub(crate) enum FileRef<'a> {
213
+ Table(&'a File),
214
+ /// The pipe's end behind a standard stream, which its stream shares.
215
+ Stream(MutexGuard<'a, File>),
216
+ }
217
+
218
+ impl Deref for FileRef<'_> {
219
+ type Target = File;
220
+
221
+ fn deref(&self) -> &File {
222
+ match self {
223
+ FileRef::Table(file) => file,
224
+ FileRef::Stream(file) => file,
225
+ }
226
+ }
227
+ }
228
+
229
+ /// A file a descriptor stands for, to change, as `Descriptors::file_mut`
230
+ /// finds it.
231
+ pub(crate) enum FileRefMut<'a> {
232
+ Table(&'a mut File),
233
+ Stream(MutexGuard<'a, File>),
234
+ }
235
+
236
+ impl Deref for FileRefMut<'_> {
237
+ type Target = File;
238
+
239
+ fn deref(&self) -> &File {
240
+ match self {
241
+ FileRefMut::Table(file) => file,
242
+ FileRefMut::Stream(file) => file,
243
+ }
244
+ }
245
+ }
246
+
247
+ impl DerefMut for FileRefMut<'_> {
248
+ fn deref_mut(&mut self) -> &mut File {
249
+ match self {
250
+ FileRefMut::Table(file) => file,
251
+ FileRefMut::Stream(file) => file,
252
+ }
253
+ }
254
+ }
255
+
256
+ #[cfg(test)]
257
+ mod tests {
258
+ use super::*;
259
+ use kobako_runtime::filesystem::{create_pipe_files, PipeInodeInfo};
260
+ use kobako_runtime::memcg::MemoryBudget;
261
+ use kobako_runtime::security::prepare_creds;
262
+ use kobako_runtime::vfs::OpenFiles;
263
+
264
+ fn pipe_end() -> File {
265
+ create_pipe_files(&PipeInodeInfo::new(1), &prepare_creds(&[], None)).1
266
+ }
267
+
268
+ // @behavior RT-189
269
+ #[test]
270
+ fn a_new_descriptor_takes_the_lowest_closed_number() {
271
+ let mut table = Table::new(OpenFiles::new(None), MemoryBudget::new(None));
272
+ let mut descriptors = Descriptors::new(
273
+ pipe_end(),
274
+ pipe_end(),
275
+ pipe_end(),
276
+ &[],
277
+ &mut table,
278
+ (&prepare_creds(&[], None), &prepare_creds(&[], None)),
279
+ )
280
+ .unwrap_or_else(|_| panic!("a table holding no Mount must make"));
281
+ let mut open = |descriptors: &mut Descriptors| {
282
+ let fd = descriptors
283
+ .lowest_unused()
284
+ .expect("a table with no limit numbers every descriptor");
285
+ let file =
286
+ install_inherited(&mut table, pipe_end()).expect("a table with no limit takes it");
287
+ descriptors.place(fd, Descriptor::for_file(file));
288
+ fd
289
+ };
290
+ let numbers = [
291
+ open(&mut descriptors),
292
+ open(&mut descriptors),
293
+ open(&mut descriptors),
294
+ ];
295
+ assert_eq!(numbers, [3, 4, 5], "descriptors must number from 3");
296
+ descriptors.remove(3);
297
+ descriptors.remove(4);
298
+ assert_eq!(
299
+ (
300
+ open(&mut descriptors),
301
+ open(&mut descriptors),
302
+ open(&mut descriptors),
303
+ ),
304
+ (3, 4, 6),
305
+ "path_open's descriptors must take the lowest closed number first, as Linux's alloc_fd \
306
+ does, and then the one past the highest"
307
+ );
308
+ }
309
+ }
@@ -20,7 +20,7 @@
20
20
  use std::fs;
21
21
  use std::path::{Path, PathBuf};
22
22
  use std::sync::atomic::{AtomicUsize, Ordering};
23
- use std::sync::{Arc, OnceLock};
23
+ use std::sync::OnceLock;
24
24
 
25
25
  use kobako_runtime::filesystem::Bind;
26
26
  use kobako_runtime::filesystem::Filesystem;
@@ -375,28 +375,18 @@ fn through_wasmtime_wasi(call: Call, path: &str) -> Observation {
375
375
  /// `host` behind a kobako `Bind` Mount at `AT`.
376
376
  fn kobako_preopen(host: &HostDir) -> (Store<Invocation>, Linker<Invocation>) {
377
377
  let engine = load_engine().expect("shared engine must be constructible");
378
- let config = Config {
379
- timeout: None,
380
- setup_timeout: None,
381
- memory_limit: None,
382
- stdout_limit: None,
383
- stderr_limit: None,
384
- open_file_limit: None,
385
- profile: Profile::Hermetic,
386
- security: Vec::new(),
387
- };
378
+ let config = Config::for_profile(Profile::Hermetic);
388
379
  let directory = Bind::new(&host.0).expect("the host directory must open");
389
380
  let grant = Grant::Mount(
390
381
  Mount::new(
391
382
  AT,
392
- Filesystem::new(Arc::new(directory)).expect("the instance must stand"),
383
+ Filesystem::new(directory).expect("the instance must stand"),
393
384
  Access::ReadWrite,
394
385
  )
395
386
  .expect("AT is a guest path"),
396
387
  );
397
- let wasi =
398
- Wasi::for_invocation(&config, Vec::new(), &[grant]).expect("WASI context must build");
399
- let mut store = Store::new(engine, Invocation::new(None, wasi));
388
+ let wasi = Wasi::for_invocation(&config, &[grant]).expect("WASI context must build");
389
+ let mut store = Store::new(engine, Invocation::new(wasi));
400
390
  store.set_epoch_deadline(NO_TIMEOUT_EPOCH_DELTA);
401
391
  let linker = imports::linker().expect("host imports must link");
402
392
  (store, linker)