File: _UnmanagedHashNode.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (109 lines) | stat: -rw-r--r-- 3,091 bytes parent folder | download
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Collections open source project
//
// Copyright (c) 2022 - 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
//
//===----------------------------------------------------------------------===//

#if !COLLECTIONS_SINGLE_MODULE
import InternalCollectionsUtilities
#endif

/// An unsafe, unowned, type-erased reference to a hash tree node; essentially
/// just a lightweight wrapper around `Unmanaged<_RawHashStorage>`.
///
/// Because such a reference may outlive the underlying object, use sites must
/// be extraordinarily careful to never dereference an invalid
/// `_UnmanagedHashNode`. Doing so results in undefined behavior.
@usableFromInline
@frozen
internal struct _UnmanagedHashNode {
  @usableFromInline
  internal var ref: Unmanaged<_RawHashStorage>

  @inlinable @inline(__always)
  internal init(_ storage: _RawHashStorage) {
    self.ref = .passUnretained(storage)
  }
}

extension _UnmanagedHashNode: Equatable {
  /// Indicates whether two unmanaged node references are equal.
  ///
  /// This function is safe to call even if one or both of its arguments are
  /// invalid -- however, it may incorrectly return true in this case.
  /// (This can happen when a destroyed node's memory region is later reused for
  /// a newly created node.)
  @inlinable
  internal static func ==(left: Self, right: Self) -> Bool {
    left.ref.toOpaque() == right.ref.toOpaque()
  }
}

extension _UnmanagedHashNode: CustomStringConvertible {
  @usableFromInline
  internal var description: String {
    _addressString(for: ref.toOpaque())
  }
}

extension _UnmanagedHashNode {
  @inlinable @inline(__always)
  internal func withRaw<R>(_ body: (_RawHashStorage) -> R) -> R {
    ref._withUnsafeGuaranteedRef(body)
  }

  @inline(__always)
  internal func read<R>(_ body: (_RawHashNode.UnsafeHandle) -> R) -> R {
    ref._withUnsafeGuaranteedRef { storage in
      storage.withUnsafeMutablePointers { header, elements in
        body(_RawHashNode.UnsafeHandle(header, UnsafeRawPointer(elements)))
      }
    }
  }

  @inlinable
  internal var hasItems: Bool {
    withRaw { $0.header.hasItems }
  }

  @inlinable
  internal var hasChildren: Bool {
    withRaw { $0.header.hasChildren }
  }

  @inlinable
  internal var itemCount: Int {
    withRaw { $0.header.itemCount }
  }

  @inlinable
  internal var childCount: Int {
    withRaw { $0.header.childCount }
  }

  @inlinable
  internal var itemsEndSlot: _HashSlot {
    withRaw { _HashSlot($0.header.itemCount) }
  }

  @inlinable
  internal var childrenEndSlot: _HashSlot {
    withRaw { _HashSlot($0.header.childCount) }
  }

  @inlinable
  internal func unmanagedChild(at slot: _HashSlot) -> Self {
    withRaw { raw in
      assert(slot.value < raw.header.childCount)
      return raw.withUnsafeMutablePointerToElements { p in
        Self(p[slot.value].storage)
      }
    }
  }
}