1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2023-2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import struct SystemPackage.FilePath
package protocol Query: Sendable {
associatedtype Key: CacheKey
var cacheKey: Key { get }
func run(engine: QueryEngine) async throws -> FilePath
}
package protocol CachingQuery: Query, CacheKey where Self.Key == Self {}
extension CachingQuery {
package var cacheKey: Key { self }
}
// SwiftPM has to be built with Swift 5.8 on CI and also needs to support CMake for bootstrapping on Windows.
// This means we can't implement persistable hashing with macros (unavailable in Swift 5.8 and additional effort to
// set up with CMake when Swift 5.9 is available for all CI jobs) and have to stick to `Encodable` for now.
final class HashEncoder<Hash: HashFunction>: Encoder {
enum Error: Swift.Error {
case noCacheKeyConformance(Encodable.Type)
}
var codingPath: [any CodingKey]
var userInfo: [CodingUserInfoKey: Any]
func container<Key>(keyedBy type: Key.Type) -> KeyedEncodingContainer<Key> where Key: CodingKey {
.init(KeyedContainer(encoder: self))
}
func unkeyedContainer() -> any UnkeyedEncodingContainer {
self
}
func singleValueContainer() -> any SingleValueEncodingContainer {
self
}
init() {
self.hashFunction = Hash()
self.codingPath = []
self.userInfo = [:]
}
fileprivate var hashFunction = Hash()
func finalize() -> Hash.Digest {
self.hashFunction.finalize()
}
}
extension HashEncoder: SingleValueEncodingContainer {
func encodeNil() throws {
// FIXME: this doesn't encode the name of the underlying optional type,
// but `Encoder` protocol is limited and can't provide this for us.
var str = "nil"
str.withUTF8 {
self.hashFunction.update(data: $0)
}
}
func encode(_ value: Bool) throws {
value.hash(with: &self.hashFunction)
}
func encode(_ value: String) throws {
value.hash(with: &self.hashFunction)
}
func encode(_ value: Double) throws {
value.hash(with: &self.hashFunction)
}
func encode(_ value: Float) throws {
value.hash(with: &self.hashFunction)
}
func encode(_ value: Int) throws {
value.hash(with: &self.hashFunction)
}
func encode(_ value: Int8) throws {
value.hash(with: &self.hashFunction)
}
func encode(_ value: Int16) throws {
value.hash(with: &self.hashFunction)
}
func encode(_ value: Int32) throws {
value.hash(with: &self.hashFunction)
}
func encode(_ value: Int64) throws {
value.hash(with: &self.hashFunction)
}
func encode(_ value: UInt) throws {
value.hash(with: &self.hashFunction)
}
func encode(_ value: UInt8) throws {
value.hash(with: &self.hashFunction)
}
func encode(_ value: UInt16) throws {
value.hash(with: &self.hashFunction)
}
func encode(_ value: UInt32) throws {
value.hash(with: &self.hashFunction)
}
func encode(_ value: UInt64) throws {
value.hash(with: &self.hashFunction)
}
func encode<T>(_ value: T) throws where T: Encodable {
if let leaf = value as? LeafCacheKey {
leaf.hash(with: &self.hashFunction)
return
}
guard value is CacheKey else {
throw Error.noCacheKeyConformance(T.self)
}
try String(describing: T.self).encode(to: self)
try value.encode(to: self)
}
}
extension HashEncoder: UnkeyedEncodingContainer {
var count: Int {
0
}
func nestedContainer<NestedKey>(keyedBy keyType: NestedKey.Type) -> KeyedEncodingContainer<NestedKey>
where NestedKey: CodingKey {
KeyedEncodingContainer(KeyedContainer(encoder: self))
}
func nestedUnkeyedContainer() -> any UnkeyedEncodingContainer {
self
}
func superEncoder() -> any Encoder {
fatalError()
}
}
extension HashEncoder {
struct KeyedContainer<K: CodingKey>: KeyedEncodingContainerProtocol {
var encoder: HashEncoder
var codingPath: [any CodingKey] { self.encoder.codingPath }
mutating func encodeNil(forKey key: K) throws {
// FIXME: this doesn't encode the name of the underlying optional type,
// but `Encoder` protocol is limited and can't provide this for us.
var str = "nil"
str.withUTF8 {
self.encoder.hashFunction.update(data: $0)
}
}
mutating func encode(_ value: Bool, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode(_ value: String, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode(_ value: Double, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode(_ value: Float, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode(_ value: Int, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode(_ value: Int8, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode(_ value: Int16, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode(_ value: Int32, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode(_ value: Int64, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode(_ value: UInt, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode(_ value: UInt8, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode(_ value: UInt16, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode(_ value: UInt32, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode(_ value: UInt64, forKey key: K) throws {
key.stringValue.hash(with: &self.encoder.hashFunction)
value.hash(with: &self.encoder.hashFunction)
}
mutating func encode<T>(_ value: T, forKey key: K) throws where T: Encodable {
if let leaf = value as? LeafCacheKey {
leaf.hash(with: &self.encoder.hashFunction)
return
}
guard value is CacheKey else {
throw Error.noCacheKeyConformance(T.self)
}
try String(reflecting: T.self).encode(to: self.encoder)
key.stringValue.hash(with: &self.encoder.hashFunction)
try value.encode(to: self.encoder)
}
mutating func nestedContainer<NestedKey>(
keyedBy keyType: NestedKey.Type,
forKey key: K
) -> KeyedEncodingContainer<NestedKey> where NestedKey: CodingKey {
key.stringValue.hash(with: &self.encoder.hashFunction)
return self.encoder.nestedContainer(keyedBy: keyType)
}
mutating func nestedUnkeyedContainer(forKey key: K) -> any UnkeyedEncodingContainer {
key.stringValue.hash(with: &self.encoder.hashFunction)
return self.encoder
}
mutating func superEncoder() -> any Encoder {
fatalError()
}
mutating func superEncoder(forKey key: K) -> any Encoder {
fatalError()
}
typealias Key = K
}
}
|
