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 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 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
//
//===----------------------------------------------------------------------===//
// MARK: - Memory layout
/// A 128-bit unsigned integer type.
@available(SwiftStdlib 6.0, *)
@frozen
public struct UInt128: Sendable {
#if _pointerBitWidth(_64) || arch(arm64_32)
// On 64-bit platforms (including arm64_32 and any similar targets with
// 32b pointers but HW-backed 64b integers), the layout is simply that
// of `Builtin.Int128`.
public var _value: Builtin.Int128
@available(SwiftStdlib 6.0, *)
@_transparent
public init(_ _value: Builtin.Int128) {
self._value = _value
}
@available(SwiftStdlib 6.0, *)
@_transparent
public var _low: UInt64 {
UInt64(Builtin.trunc_Int128_Int64(_value))
}
@available(SwiftStdlib 6.0, *)
@_transparent
public var _high: UInt64 {
let shifted: UInt128 = self &>> 64
return UInt64(Builtin.trunc_Int128_Int64(shifted._value))
}
@available(SwiftStdlib 6.0, *)
@_transparent
public init(_low: UInt64, _high: UInt64) {
#if _endian(little)
self = unsafeBitCast((_low, _high), to: Self.self)
#else
self = unsafeBitCast((_high, _low), to: Self.self)
#endif
}
#else
// On 32-bit platforms, we don't want to use Builtin.Int128 for layout
// because it would be 16B aligned, which is excessive for such targets
// (and generally incompatible with C's `_BitInt(128)`). Instead we lay
// out the type as two `UInt64` fields--note that we have to be careful
// about endianness in this case.
#if _endian(little)
public var _low: UInt64
public var _high: UInt64
#else
public var _high: UInt64
public var _low: UInt64
#endif
@available(SwiftStdlib 6.0, *)
@_transparent
public init(_low: UInt64, _high: UInt64) {
self._low = _low
self._high = _high
}
@available(SwiftStdlib 6.0, *)
public var _value: Builtin.Int128 {
@_transparent
get {
unsafeBitCast(self, to: Builtin.Int128.self)
}
@_transparent
set {
self = Self(newValue)
}
}
@available(SwiftStdlib 6.0, *)
@_transparent
public init(_ _value: Builtin.Int128) {
self = unsafeBitCast(_value, to: Self.self)
}
#endif
@available(SwiftStdlib 6.0, *)
@_transparent
public init(bitPattern: Int128) {
self.init(bitPattern._value)
}
}
// MARK: - Constants
@available(SwiftStdlib 6.0, *)
extension UInt128 {
@available(SwiftStdlib 6.0, *)
@_transparent
public static var zero: Self {
Self(Builtin.zeroInitializer())
}
@available(SwiftStdlib 6.0, *)
@_transparent
public static var min: Self {
zero
}
@available(SwiftStdlib 6.0, *)
@_transparent
public static var max: Self {
Self(_low: .max, _high: .max)
}
}
// MARK: - Conversions from other integers
@available(SwiftStdlib 6.0, *)
extension UInt128: ExpressibleByIntegerLiteral,
_ExpressibleByBuiltinIntegerLiteral {
@available(SwiftStdlib 6.0, *)
public typealias IntegerLiteralType = Self
@available(SwiftStdlib 6.0, *)
@_transparent
public init(_builtinIntegerLiteral x: Builtin.IntLiteral) {
self.init(Builtin.s_to_u_checked_trunc_IntLiteral_Int128(x).0)
}
@available(SwiftStdlib 6.0, *)
@inlinable
public init?<T>(exactly source: T) where T: BinaryInteger {
guard let high = UInt64(exactly: source >> 64) else { return nil }
let low = UInt64(truncatingIfNeeded: source)
self.init(_low: low, _high: high)
}
@available(SwiftStdlib 6.0, *)
@inlinable
public init<T>(_ source: T) where T: BinaryInteger {
guard let value = Self(exactly: source) else {
fatalError("value cannot be converted to UInt128 because it is outside the representable range")
}
self = value
}
@available(SwiftStdlib 6.0, *)
@inlinable
public init<T>(clamping source: T) where T: BinaryInteger {
guard let value = Self(exactly: source) else {
self = source < .zero ? .zero : .max
return
}
self = value
}
@available(SwiftStdlib 6.0, *)
@inlinable
public init<T>(truncatingIfNeeded source: T) where T: BinaryInteger {
let high = UInt64(truncatingIfNeeded: source >> 64)
let low = UInt64(truncatingIfNeeded: source)
self.init(_low: low, _high: high)
}
@available(SwiftStdlib 6.0, *)
@_transparent
public init(_truncatingBits source: UInt) {
self.init(_low: UInt64(source), _high: .zero)
}
}
// MARK: - Conversions from Binary floating-point
@available(SwiftStdlib 6.0, *)
extension UInt128 {
@available(SwiftStdlib 6.0, *)
@inlinable
public init?<T>(exactly source: T) where T: BinaryFloatingPoint {
let highAsFloat = (source * 0x1.0p-64).rounded(.towardZero)
guard let high = UInt64(exactly: highAsFloat) else { return nil }
guard let low = UInt64(
exactly: high == 0 ? source : source - 0x1.0p64*highAsFloat
) else { return nil }
self.init(_low: low, _high: high)
}
@available(SwiftStdlib 6.0, *)
@inlinable
public init<T>(_ source: T) where T: BinaryFloatingPoint {
guard let value = Self(exactly: source.rounded(.towardZero)) else {
fatalError("value cannot be converted to UInt128 because it is outside the representable range")
}
self = value
}
}
// MARK: - Non-arithmetic utility conformances
@available(SwiftStdlib 6.0, *)
extension UInt128: Equatable {
@available(SwiftStdlib 6.0, *)
@_transparent
public static func ==(a: Self, b: Self) -> Bool {
Bool(Builtin.cmp_eq_Int128(a._value, b._value))
}
}
@available(SwiftStdlib 6.0, *)
extension UInt128: Comparable {
@available(SwiftStdlib 6.0, *)
@_transparent
public static func <(a: Self, b: Self) -> Bool {
Bool(Builtin.cmp_ult_Int128(a._value, b._value))
}
}
@available(SwiftStdlib 6.0, *)
extension UInt128: Hashable {
@available(SwiftStdlib 6.0, *)
@inlinable
public func hash(into hasher: inout Hasher) {
hasher.combine(_low)
hasher.combine(_high)
}
}
// MARK: - Overflow-reporting arithmetic
@available(SwiftStdlib 6.0, *)
extension UInt128 {
@available(SwiftStdlib 6.0, *)
@_transparent
public func addingReportingOverflow(
_ other: Self
) -> (partialValue: Self, overflow: Bool) {
let (result, overflow) = Builtin.uadd_with_overflow_Int128(
self._value, other._value, Builtin.zeroInitializer()
)
return (Self(result), Bool(overflow))
}
@available(SwiftStdlib 6.0, *)
@_transparent
public func subtractingReportingOverflow(
_ other: Self
) -> (partialValue: Self, overflow: Bool) {
let (result, overflow) = Builtin.usub_with_overflow_Int128(
self._value, other._value, Builtin.zeroInitializer()
)
return (Self(result), Bool(overflow))
}
@available(SwiftStdlib 6.0, *)
@_transparent
public func multipliedReportingOverflow(
by other: Self
) -> (partialValue: Self, overflow: Bool) {
let (result, overflow) = Builtin.umul_with_overflow_Int128(
self._value, other._value, Builtin.zeroInitializer()
)
return (Self(result), Bool(overflow))
}
@available(SwiftStdlib 6.0, *)
@_transparent
public func dividedReportingOverflow(
by other: Self
) -> (partialValue: Self, overflow: Bool) {
_precondition(other != .zero, "Division by zero")
// Unsigned divide never overflows.
return (Self(Builtin.udiv_Int128(self._value, other._value)), false)
}
@available(SwiftStdlib 6.0, *)
@_transparent
public func remainderReportingOverflow(
dividingBy other: Self
) -> (partialValue: Self, overflow: Bool) {
_precondition(other != .zero, "Division by zero in remainder operation")
// Unsigned divide never overflows.
return (Self(Builtin.urem_Int128(self._value, other._value)), false)
}
}
// MARK: - AdditiveArithmetic conformance
@available(SwiftStdlib 6.0, *)
extension UInt128: AdditiveArithmetic {
@available(SwiftStdlib 6.0, *)
@_transparent
public static func +(a: Self, b: Self) -> Self {
let (result, overflow) = a.addingReportingOverflow(b)
// On arm64, this check materializes the carryout in register, then does
// a TBNZ, where we should get a b.cs instead. I filed rdar://115387277
// to track this, but it only costs us one extra instruction, so we'll
// keep it as is for now.
Builtin.condfail_message(
overflow._value,
StaticString("arithmetic overflow").unsafeRawPointer
)
return result
}
@available(SwiftStdlib 6.0, *)
@_transparent
public static func -(a: Self, b: Self) -> Self {
let (result, overflow) = a.subtractingReportingOverflow(b)
Builtin.condfail_message(
overflow._value,
StaticString("arithmetic overflow").unsafeRawPointer
)
return result
}
}
// MARK: - Multiplication and division
@available(SwiftStdlib 6.0, *)
extension UInt128 {
@available(SwiftStdlib 6.0, *)
@_transparent
public static func *(a: Self, b: Self) -> Self {
let (result, overflow) = a.multipliedReportingOverflow(by: b)
Builtin.condfail_message(
overflow._value,
StaticString("arithmetic overflow").unsafeRawPointer
)
return result
}
@available(SwiftStdlib 6.0, *)
@_transparent
public static func *=(a: inout Self, b: Self) {
a = a * b
}
@available(SwiftStdlib 6.0, *)
@_transparent
public static func /(a: Self, b: Self) -> Self {
a.dividedReportingOverflow(by: b).partialValue
}
@available(SwiftStdlib 6.0, *)
@_transparent
public static func /=(a: inout Self, b: Self) {
a = a / b
}
@available(SwiftStdlib 6.0, *)
@_transparent
public static func %(a: Self, b: Self) -> Self {
a.remainderReportingOverflow(dividingBy: b).partialValue
}
@available(SwiftStdlib 6.0, *)
@_transparent
public static func %=(a: inout Self, b: Self) {
a = a % b
}
}
// MARK: - Numeric conformance
@available(SwiftStdlib 6.0, *)
extension UInt128: Numeric {
@available(SwiftStdlib 6.0, *)
public typealias Magnitude = Self
@available(SwiftStdlib 6.0, *)
@_transparent
public var magnitude: Self {
self
}
}
// MARK: - BinaryInteger conformance
@available(SwiftStdlib 6.0, *)
extension UInt128: BinaryInteger {
@available(SwiftStdlib 6.0, *)
@frozen
public struct Words {
@usableFromInline
let _value: UInt128
@available(SwiftStdlib 6.0, *)
@_transparent
public init(_value: UInt128) {
self._value = _value
}
}
@available(SwiftStdlib 6.0, *)
@_transparent
public var words: Words {
Words(_value: self)
}
@available(SwiftStdlib 6.0, *)
@_transparent
public static func &=(a: inout Self, b: Self) {
a._value = Builtin.and_Int128(a._value, b._value)
}
@available(SwiftStdlib 6.0, *)
@_transparent
public static func |=(a: inout Self, b: Self) {
a._value = Builtin.or_Int128(a._value, b._value)
}
@available(SwiftStdlib 6.0, *)
@_transparent
public static func ^=(a: inout Self, b: Self) {
a._value = Builtin.xor_Int128(a._value, b._value)
}
@available(SwiftStdlib 6.0, *)
@_transparent
public static func &>>=(a: inout Self, b: Self) {
let masked = b & 127
a._value = Builtin.lshr_Int128(a._value, masked._value)
}
@available(SwiftStdlib 6.0, *)
@_transparent
public static func &<<=(a: inout Self, b: Self) {
let masked = b & 127
a._value = Builtin.shl_Int128(a._value, masked._value)
}
@available(SwiftStdlib 6.0, *)
@_transparent
public var trailingZeroBitCount: Int {
_low == 0 ? 64 + _high.trailingZeroBitCount : _low.trailingZeroBitCount
}
@available(SwiftStdlib 6.0, *)
@_transparent
public var _lowWord: UInt {
#if _pointerBitWidth(_64)
UInt(Builtin.trunc_Int128_Int64(_value))
#elseif _pointerBitWidth(_32)
UInt(Builtin.trunc_Int128_Int32(_value))
#else
#error("Unsupported platform")
#endif
}
}
@available(SwiftStdlib 6.0, *)
extension UInt128.Words: RandomAccessCollection {
@available(SwiftStdlib 6.0, *)
public typealias Element = UInt
@available(SwiftStdlib 6.0, *)
public typealias Index = Int
@available(SwiftStdlib 6.0, *)
public typealias SubSequence = Slice<Self>
@available(SwiftStdlib 6.0, *)
public typealias Indices = Range<Int>
@available(SwiftStdlib 6.0, *)
@_transparent
public var count: Int {
128 / UInt.bitWidth
}
@available(SwiftStdlib 6.0, *)
@_transparent
public var startIndex: Int {
0
}
@available(SwiftStdlib 6.0, *)
@_transparent
public var endIndex: Int {
count
}
@available(SwiftStdlib 6.0, *)
@_transparent
public var indices: Indices {
startIndex ..< endIndex
}
@available(SwiftStdlib 6.0, *)
@_transparent
public func index(after i: Int) -> Int {
i + 1
}
@available(SwiftStdlib 6.0, *)
@_transparent
public func index(before i: Int) -> Int {
i - 1
}
@available(SwiftStdlib 6.0, *)
public subscript(position: Int) -> UInt {
@inlinable
get {
_precondition(position >= 0 && position < count, "Index out of bounds")
var value = _value
#if _endian(little)
let index = position
#else
let index = count - 1 - position
#endif
return _withUnprotectedUnsafePointer(to: &value) {
$0.withMemoryRebound(to: UInt.self, capacity: count) { $0[index] }
}
}
}
}
// MARK: - FixedWidthInteger conformance
@available(SwiftStdlib 6.0, *)
extension UInt128: FixedWidthInteger, UnsignedInteger {
@available(SwiftStdlib 6.0, *)
@_transparent
public static var bitWidth: Int { 128 }
@available(SwiftStdlib 6.0, *)
@_transparent
public var nonzeroBitCount: Int {
_high.nonzeroBitCount &+ _low.nonzeroBitCount
}
@available(SwiftStdlib 6.0, *)
@_transparent
public var leadingZeroBitCount: Int {
_high == 0 ? 64 + _low.leadingZeroBitCount : _high.leadingZeroBitCount
}
@available(SwiftStdlib 6.0, *)
@_transparent
public var byteSwapped: Self {
return Self(_low: _high.byteSwapped, _high: _low.byteSwapped)
}
}
|