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,248 @@
1
+ //! Windows answers a lookup through `GetAddrInfoExW` with a completion
2
+ //! routine, the asynchronous form its own `getaddrinfo` stands on, and
3
+ //! `GetAddrInfoExCancel` cancels it. The routine runs on a system thread even
4
+ //! after a cancel, so it holds its own reference to what it writes.
5
+
6
+ use std::cell::{Cell, UnsafeCell};
7
+ use std::future::Future;
8
+ use std::io;
9
+ use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
10
+ use std::pin::Pin;
11
+ use std::ptr::{null, null_mut};
12
+ use std::sync::atomic::{AtomicU8, Ordering};
13
+ use std::sync::{Arc, Mutex, OnceLock, PoisonError};
14
+ use std::task::{Context, Poll, Waker};
15
+
16
+ use windows_sys::Win32::Foundation::HANDLE;
17
+ use windows_sys::Win32::Networking::WinSock::{
18
+ FreeAddrInfoExW, GetAddrInfoExCancel, GetAddrInfoExW, WSAStartup, ADDRINFOEXW, AF_INET,
19
+ AF_INET6, AF_UNSPEC, IPPROTO_TCP, NS_ALL, SOCKADDR_IN, SOCKADDR_IN6, SOCK_STREAM, WSADATA,
20
+ WSAEINVAL, WSAHOST_NOT_FOUND, WSANO_DATA, WSANO_RECOVERY, WSA_IO_PENDING,
21
+ };
22
+ use windows_sys::Win32::System::IO::OVERLAPPED;
23
+
24
+ use crate::net::lookup::{LookupError, Resolving};
25
+
26
+ /// `name`'s addresses; Winsock that cannot start is `Again`.
27
+ pub(super) fn resolve(name: &str) -> Resolving {
28
+ match Query::start(name) {
29
+ Ok(query) => Box::pin(query),
30
+ Err(_) => Box::pin(std::future::ready(Err(LookupError::Again))),
31
+ }
32
+ }
33
+
34
+ /// The kind of `error`, a Winsock code, as Windows' `getaddrinfo` pairs
35
+ /// `WSAHOST_NOT_FOUND` with `EAI_NONAME`, `WSANO_RECOVERY` with `EAI_FAIL`,
36
+ /// and `WSATRY_AGAIN` with `EAI_AGAIN`. A name no query can carry is
37
+ /// `NoName`; any other failure leaves a lookup asking again may answer.
38
+ fn to_lookup_error(error: i32) -> LookupError {
39
+ match error {
40
+ WSAHOST_NOT_FOUND | WSANO_DATA | WSAEINVAL => LookupError::NoName,
41
+ WSANO_RECOVERY => LookupError::Fail,
42
+ _ => LookupError::Again,
43
+ }
44
+ }
45
+
46
+ /// What the call and its completion routine share, as Microsoft's example
47
+ /// calls its `QUERY_CONTEXT`. `overlapped` comes first, so the routine finds
48
+ /// the whole from the pointer it is handed; Windows writes it, `result`, and
49
+ /// `handle` through that pointer, so each sits in an `UnsafeCell`.
50
+ #[repr(C)]
51
+ struct QueryContext {
52
+ overlapped: UnsafeCell<OVERLAPPED>,
53
+ result: UnsafeCell<*mut ADDRINFOEXW>,
54
+ handle: UnsafeCell<HANDLE>,
55
+ /// Whether the query is pending, being cancelled, or done. A cancel and
56
+ /// the routine's end exclude each other, so no cancel follows a routine
57
+ /// that marked the query done; one racing Windows' own completion,
58
+ /// before the routine marks it, answers `WSA_INVALID_HANDLE` as
59
+ /// `GetAddrInfoExCancel` documents.
60
+ phase: AtomicU8,
61
+ state: Mutex<State>,
62
+ }
63
+
64
+ // Windows writes the cells before the routine runs, and the routine alone
65
+ // reads them after; everything else is atomic or behind the mutex.
66
+ unsafe impl Send for QueryContext {}
67
+ unsafe impl Sync for QueryContext {}
68
+
69
+ const PENDING: u8 = 0;
70
+ const CANCELLING: u8 = 1;
71
+ const DONE: u8 = 2;
72
+
73
+ thread_local! {
74
+ /// Whether this thread is inside `GetAddrInfoExCancel`, which may run the
75
+ /// routine on it before returning.
76
+ static IN_CANCEL: Cell<bool> = const { Cell::new(false) };
77
+ }
78
+
79
+ #[derive(Default)]
80
+ struct State {
81
+ answer: Option<Result<Vec<IpAddr>, LookupError>>,
82
+ waker: Option<Waker>,
83
+ }
84
+
85
+ impl QueryContext {
86
+ fn new() -> Self {
87
+ Self {
88
+ overlapped: UnsafeCell::new(unsafe { std::mem::zeroed() }),
89
+ result: UnsafeCell::new(null_mut()),
90
+ handle: UnsafeCell::new(null_mut()),
91
+ phase: AtomicU8::new(PENDING),
92
+ state: Mutex::default(),
93
+ }
94
+ }
95
+
96
+ /// Mark the query done, waiting out a cancel another thread is making,
97
+ /// so the handle stays valid for as long as that cancel names it.
98
+ fn end(&self) {
99
+ loop {
100
+ match self
101
+ .phase
102
+ .compare_exchange(PENDING, DONE, Ordering::AcqRel, Ordering::Acquire)
103
+ {
104
+ Ok(_) | Err(DONE) => return,
105
+ Err(_) if IN_CANCEL.get() => return,
106
+ Err(_) => std::thread::yield_now(),
107
+ }
108
+ }
109
+ }
110
+
111
+ /// Cancel the query unless it already ended.
112
+ fn cancel(&self) {
113
+ let claimed = self
114
+ .phase
115
+ .compare_exchange(PENDING, CANCELLING, Ordering::AcqRel, Ordering::Acquire)
116
+ .is_ok();
117
+ if claimed {
118
+ IN_CANCEL.set(true);
119
+ unsafe { GetAddrInfoExCancel(self.handle.get()) };
120
+ IN_CANCEL.set(false);
121
+ self.phase.store(DONE, Ordering::Release);
122
+ }
123
+ }
124
+
125
+ fn state(&self) -> std::sync::MutexGuard<'_, State> {
126
+ self.state.lock().unwrap_or_else(PoisonError::into_inner)
127
+ }
128
+
129
+ /// Take the query's outcome, `error` being its Winsock code, and wake
130
+ /// whoever waits for it.
131
+ fn finish(&self, error: u32) {
132
+ self.end();
133
+ let result = unsafe { std::mem::replace(&mut *self.result.get(), null_mut()) };
134
+ let answer = match error {
135
+ 0 => Ok(unsafe { addresses_of(result) }),
136
+ code => Err(to_lookup_error(code as i32)),
137
+ };
138
+ if !result.is_null() {
139
+ unsafe { FreeAddrInfoExW(result) };
140
+ }
141
+ let mut state = self.state();
142
+ state.answer = Some(answer);
143
+ if let Some(waker) = state.waker.take() {
144
+ waker.wake();
145
+ }
146
+ }
147
+ }
148
+
149
+ /// Each address in `result`, in the order Windows sorted them.
150
+ unsafe fn addresses_of(mut result: *const ADDRINFOEXW) -> Vec<IpAddr> {
151
+ let mut addresses = Vec::new();
152
+ while let Some(info) = result.as_ref() {
153
+ let ip = match i32::from(info.ai_family as u16) {
154
+ family if family == i32::from(AF_INET) => {
155
+ let addr = &*info.ai_addr.cast::<SOCKADDR_IN>();
156
+ Some(IpAddr::from(Ipv4Addr::from(u32::from_be(
157
+ addr.sin_addr.S_un.S_addr,
158
+ ))))
159
+ }
160
+ family if family == i32::from(AF_INET6) => {
161
+ let addr = &*info.ai_addr.cast::<SOCKADDR_IN6>();
162
+ Some(IpAddr::from(Ipv6Addr::from(addr.sin6_addr.u.Byte)))
163
+ }
164
+ _ => None,
165
+ };
166
+ addresses.extend(ip);
167
+ result = info.ai_next;
168
+ }
169
+ addresses
170
+ }
171
+
172
+ unsafe extern "system" fn on_complete(error: u32, _bytes: u32, overlapped: *const OVERLAPPED) {
173
+ let context = Arc::from_raw(overlapped.cast::<QueryContext>());
174
+ context.finish(error);
175
+ }
176
+
177
+ /// Start Winsock once for the process, as a call before any socket needs.
178
+ fn start_winsock() -> io::Result<()> {
179
+ static STARTED: OnceLock<i32> = OnceLock::new();
180
+ let code = *STARTED.get_or_init(|| {
181
+ let mut data: WSADATA = unsafe { std::mem::zeroed() };
182
+ unsafe { WSAStartup(0x202, &mut data) }
183
+ });
184
+ match code {
185
+ 0 => Ok(()),
186
+ code => Err(io::Error::from_raw_os_error(code)),
187
+ }
188
+ }
189
+
190
+ /// One query, cancelled as it drops unanswered.
191
+ struct Query {
192
+ context: Arc<QueryContext>,
193
+ }
194
+
195
+ impl Query {
196
+ fn start(name: &str) -> io::Result<Self> {
197
+ start_winsock()?;
198
+ let wide: Vec<u16> = name.encode_utf16().chain(std::iter::once(0)).collect();
199
+ let mut hints: ADDRINFOEXW = unsafe { std::mem::zeroed() };
200
+ hints.ai_family = i32::from(AF_UNSPEC);
201
+ hints.ai_socktype = SOCK_STREAM;
202
+ hints.ai_protocol = IPPROTO_TCP;
203
+ let context = Arc::new(QueryContext::new());
204
+ // The routine's own reference, which it takes back as it runs.
205
+ let routine = Arc::into_raw(context.clone());
206
+ let error = unsafe {
207
+ GetAddrInfoExW(
208
+ wide.as_ptr(),
209
+ null(),
210
+ NS_ALL,
211
+ null(),
212
+ &hints,
213
+ context.result.get(),
214
+ null(),
215
+ routine.cast::<OVERLAPPED>(),
216
+ Some(on_complete),
217
+ context.handle.get(),
218
+ )
219
+ };
220
+ if error != WSA_IO_PENDING {
221
+ // Answered at once, so the routine never runs.
222
+ drop(unsafe { Arc::from_raw(routine) });
223
+ context.finish(error as u32);
224
+ }
225
+ Ok(Self { context })
226
+ }
227
+ }
228
+
229
+ impl Future for Query {
230
+ type Output = Result<Vec<IpAddr>, LookupError>;
231
+
232
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
233
+ let mut state = self.context.state();
234
+ match state.answer.take() {
235
+ Some(answer) => Poll::Ready(answer),
236
+ None => {
237
+ state.waker = Some(cx.waker().clone());
238
+ Poll::Pending
239
+ }
240
+ }
241
+ }
242
+ }
243
+
244
+ impl Drop for Query {
245
+ fn drop(&mut self) {
246
+ self.context.cancel();
247
+ }
248
+ }
@@ -0,0 +1,227 @@
1
+ //! The host's own resolver, asked so a lookup can be cancelled: each platform
2
+ //! answers through the query its system hands out to be waited on and
3
+ //! dropped, so no lookup holds a thread that outlives it, as glibc's
4
+ //! `getaddrinfo` would.
5
+
6
+ #[cfg(target_os = "macos")]
7
+ mod darwin;
8
+ #[cfg(all(unix, not(target_os = "macos")))]
9
+ mod stub;
10
+ #[cfg(windows)]
11
+ mod windows;
12
+
13
+ use std::io;
14
+ #[cfg(unix)]
15
+ use std::net::Ipv6Addr;
16
+ use std::net::{IpAddr, SocketAddr};
17
+ #[cfg(unix)]
18
+ use std::sync::{Mutex, PoisonError};
19
+ #[cfg(unix)]
20
+ use std::task::{Context, Poll, Waker};
21
+
22
+ use super::lookup::Resolving;
23
+ #[cfg(unix)]
24
+ use super::reactor::Ready;
25
+
26
+ /// The host's addresses for `name`, a fully qualified name with its root.
27
+ /// Windows sorts its own answer; on a Unix host they are sorted here, as
28
+ /// glibc's `getaddrinfo` sorts what its backends answer.
29
+ pub(super) fn resolve(name: &str) -> Resolving {
30
+ #[cfg(windows)]
31
+ return windows::resolve(name);
32
+ #[cfg(unix)]
33
+ {
34
+ #[cfg(target_os = "macos")]
35
+ let resolving = darwin::resolve(name);
36
+ #[cfg(not(target_os = "macos"))]
37
+ let resolving = stub::resolve(name);
38
+ let local = local_addresses().unwrap_or_default();
39
+ Box::pin(async move {
40
+ let mut found = resolving.await?;
41
+ sort_destinations(&mut found, &local);
42
+ Ok(found)
43
+ })
44
+ }
45
+ }
46
+
47
+ /// The host's own addresses, as glibc's `__check_pf` reads them for
48
+ /// `getaddrinfo` to sort by.
49
+ pub(super) fn local_addresses() -> io::Result<Vec<IpAddr>> {
50
+ if_addrs::get_if_addrs().map(|interfaces| interfaces.into_iter().map(|i| i.ip()).collect())
51
+ }
52
+
53
+ /// The unspecified address of `peer`'s family at an ephemeral port, where a
54
+ /// datagram socket bound to reach `peer` sits.
55
+ pub(super) fn any_address_of(peer: SocketAddr) -> SocketAddr {
56
+ match peer {
57
+ SocketAddr::V4(_) => (std::net::Ipv4Addr::UNSPECIFIED, 0).into(),
58
+ SocketAddr::V6(_) => (std::net::Ipv6Addr::UNSPECIFIED, 0).into(),
59
+ }
60
+ }
61
+
62
+ /// `found` in the order glibc's `getaddrinfo` ranks destinations by its
63
+ /// first rules, stable otherwise: one no address of the host's `local` can
64
+ /// reach comes last (Rule 1), then IPv6 before IPv4, as glibc's default
65
+ /// precedence table, after RFC 3484, ranks every IPv6 prefix above IPv4
66
+ /// (Rule 6).
67
+ #[cfg(unix)]
68
+ fn sort_destinations(found: &mut [IpAddr], local: &[IpAddr]) {
69
+ found.sort_by_key(|dest| (!is_reachable(dest, local), dest.is_ipv4()));
70
+ }
71
+
72
+ /// Whether the host holds an address `dest` can be reached from: an IPv4
73
+ /// one for IPv4, `::1` for `::1`, and a global IPv6 one for any other IPv6.
74
+ #[cfg(unix)]
75
+ fn is_reachable(dest: &IpAddr, local: &[IpAddr]) -> bool {
76
+ match dest {
77
+ IpAddr::V4(_) => local.iter().any(IpAddr::is_ipv4),
78
+ IpAddr::V6(dest) if dest.is_loopback() => local.contains(&IpAddr::V6(Ipv6Addr::LOCALHOST)),
79
+ IpAddr::V6(_) => local.iter().any(|ip| match ip {
80
+ IpAddr::V6(ip) => !ip.is_loopback() && !ip.is_unicast_link_local(),
81
+ IpAddr::V4(_) => false,
82
+ }),
83
+ }
84
+ }
85
+
86
+ /// Wakes the task waiting on a resolver's socket, keeping a change that came
87
+ /// while no task waited, so a task that reads after it learns of it.
88
+ #[cfg(unix)]
89
+ #[derive(Default)]
90
+ struct ReadyWaker(Mutex<(bool, Option<Waker>)>);
91
+
92
+ #[cfg(unix)]
93
+ impl ReadyWaker {
94
+ /// Ready once the socket changed since the last ready answer; otherwise
95
+ /// the task waits for the next change.
96
+ fn poll_changed(&self, cx: &mut Context<'_>) -> Poll<()> {
97
+ let mut state = self.0.lock().unwrap_or_else(PoisonError::into_inner);
98
+ if std::mem::take(&mut state.0) {
99
+ return Poll::Ready(());
100
+ }
101
+ state.1 = Some(cx.waker().clone());
102
+ Poll::Pending
103
+ }
104
+ }
105
+
106
+ #[cfg(unix)]
107
+ impl Ready for ReadyWaker {
108
+ fn on_event(&self) {
109
+ let mut state = self.0.lock().unwrap_or_else(PoisonError::into_inner);
110
+ state.0 = true;
111
+ if let Some(waker) = state.1.take() {
112
+ waker.wake();
113
+ }
114
+ }
115
+ }
116
+
117
+ #[cfg(test)]
118
+ mod tests {
119
+ use std::future::Future;
120
+ use std::net::IpAddr;
121
+ use std::sync::Arc;
122
+ use std::task::{Context, Poll, Wake};
123
+ use std::thread::{self, Thread};
124
+ use std::time::{Duration, Instant};
125
+
126
+ use super::resolve;
127
+ use crate::net::lookup::LookupError;
128
+
129
+ /// Wakes the thread that polls.
130
+ struct Unparks(Thread);
131
+
132
+ impl Wake for Unparks {
133
+ fn wake(self: Arc<Self>) {
134
+ self.0.unpark();
135
+ }
136
+ }
137
+
138
+ /// What `future` ends with, or `None` once ten seconds pass first.
139
+ pub(super) fn wait_for<F: Future>(future: F) -> Option<F::Output> {
140
+ let mut future = std::pin::pin!(future);
141
+ let waker = Arc::new(Unparks(thread::current())).into();
142
+ let mut cx = Context::from_waker(&waker);
143
+ let deadline = Instant::now() + Duration::from_secs(10);
144
+ loop {
145
+ if let Poll::Ready(output) = future.as_mut().poll(&mut cx) {
146
+ return Some(output);
147
+ }
148
+ let left = deadline.checked_duration_since(Instant::now())?;
149
+ thread::park_timeout(left.min(Duration::from_millis(50)));
150
+ }
151
+ }
152
+
153
+ /// `name`'s answer, or `None` once ten seconds pass unanswered.
154
+ fn answer_of(name: &str) -> Option<Result<Vec<IpAddr>, LookupError>> {
155
+ wait_for(resolve(name))
156
+ }
157
+
158
+ #[cfg(unix)]
159
+ #[test]
160
+ fn an_unreachable_destination_sorts_after_a_reachable_one() {
161
+ let v4_only: Vec<IpAddr> = vec!["127.0.0.1".parse().unwrap(), "10.0.0.2".parse().unwrap()];
162
+ let dual: Vec<IpAddr> = vec![
163
+ "127.0.0.1".parse().unwrap(),
164
+ "::1".parse().unwrap(),
165
+ "2001:db8::2".parse().unwrap(),
166
+ ];
167
+ let sorted = |local: &[IpAddr]| {
168
+ let mut found: Vec<IpAddr> =
169
+ vec!["192.0.2.1".parse().unwrap(), "2001:db8::1".parse().unwrap()];
170
+ super::sort_destinations(&mut found, local);
171
+ found
172
+ };
173
+ assert_eq!(
174
+ (sorted(&v4_only), sorted(&dual)),
175
+ (
176
+ vec!["192.0.2.1".parse().unwrap(), "2001:db8::1".parse().unwrap()],
177
+ vec!["2001:db8::1".parse().unwrap(), "192.0.2.1".parse().unwrap()]
178
+ ),
179
+ "a host with no global IPv6 address must sort IPv4 first, as RFC 6724's Rule 1 \
180
+ puts an unusable destination last, and one with it must sort IPv6 first"
181
+ );
182
+ }
183
+
184
+ #[test]
185
+ fn localhost_resolves_to_a_loopback_address() {
186
+ let answer = answer_of("localhost.").map(|found| found.ok());
187
+ let is_loopback_only =
188
+ |found: &Vec<IpAddr>| !found.is_empty() && found.iter().all(IpAddr::is_loopback);
189
+ assert!(
190
+ matches!(&answer, Some(Some(found)) if is_loopback_only(found)),
191
+ "the host's resolver must answer localhost with loopback addresses only, got {answer:?}"
192
+ );
193
+ }
194
+
195
+ #[test]
196
+ fn a_name_under_invalid_answers_no_address() {
197
+ let answer = answer_of("kobako.invalid.");
198
+ assert!(
199
+ matches!(&answer, Some(Ok(found)) if found.is_empty())
200
+ || matches!(answer, Some(Err(_))),
201
+ "the host's resolver must answer a name under .invalid with no address, and answer \
202
+ at all, got {answer:?}"
203
+ );
204
+ }
205
+
206
+ // @behavior NW-228
207
+ #[cfg(unix)]
208
+ #[test]
209
+ fn a_name_no_query_can_carry_answers_no_name() {
210
+ let long_label = format!("{}.test.", "a".repeat(64));
211
+ assert_eq!(
212
+ answer_of(&long_label),
213
+ Some(Err(LookupError::NoName)),
214
+ "the host's resolver must answer a name with a label past 63 bytes, which no query \
215
+ can carry, name-unresolvable"
216
+ );
217
+ }
218
+
219
+ #[test]
220
+ fn a_query_dropped_before_its_answer_is_cancelled_cleanly() {
221
+ drop(resolve("kobako-dropped.invalid."));
222
+ assert!(
223
+ answer_of("localhost.").is_some(),
224
+ "the host's resolver must keep answering after a query was dropped unanswered"
225
+ );
226
+ }
227
+ }