library/alloc/src/collections/btree/node.rs

   1 // This is an attempt at an implementation following the ideal
   2 //
   3 // ```
   4 // struct BTreeMap<K, V> {
   5 //     height: usize,
   6 //     root: Option<Box<Node<K, V, height>>>
   7 // }
   8 //
   9 // struct Node<K, V, height: usize> {
  10 //     keys: [K; 2 * B - 1],
  11 //     vals: [V; 2 * B - 1],
  12 //     edges: if height > 0 {
  13 //         [Box<Node<K, V, height - 1>>; 2 * B]
  14 //     } else { () },
  15 //     parent: *const Node<K, V, height + 1>,
  16 //     parent_idx: u16,
  17 //     len: u16,
  18 // }
  19 // ```
  20 //
  21 // Since Rust doesn't actually have dependent types and polymorphic recursion,
  22 // we make do with lots of unsafety.
  23
  24 // A major goal of this module is to avoid complexity by treating the tree as a generic (if
  25 // weirdly shaped) container and avoiding dealing with most of the B-Tree invariants. As such,
  26 // this module doesn't care whether the entries are sorted, which nodes can be underfull, or
  27 // even what underfull means. However, we do rely on a few invariants:
  28 //
  29 // - Trees must have uniform depth/height. This means that every path down to a leaf from a
  30 //   given node has exactly the same length.
  31 // - A node of length `n` has `n` keys, `n` values, and (in an internal node) `n + 1` edges.
  32 //   This implies that even an empty internal node has at least one edge.
  33
  34 use core::cmp::Ordering;
  35 use core::marker::PhantomData;
  36 use core::mem::{self, MaybeUninit};
  37 use core::ptr::{self, NonNull, Unique};
  38 use core::slice;
  39
  40 use crate::alloc::{AllocRef, Global, Layout};
  41 use crate::boxed::Box;
  42
  43 const B: usize = 6;
  44 pub const MIN_LEN: usize = B - 1;
  45 pub const CAPACITY: usize = 2 * B - 1;
  46
  47 /// The underlying representation of leaf nodes.
  48 #[repr(C)]
  49 struct LeafNode<K, V> {
  50     /// We use `*const` as opposed to `*mut` so as to be covariant in `K` and `V`.
  51     /// This either points to an actual node or is null.
  52     parent: *const InternalNode<K, V>,
  53
  54     /// This node's index into the parent node's `edges` array.
  55     /// `*node.parent.edges[node.parent_idx]` should be the same thing as `node`.
  56     /// This is only guaranteed to be initialized when `parent` is non-null.
  57     parent_idx: MaybeUninit<u16>,
  58
  59     /// The number of keys and values this node stores.
  60     ///
  61     /// This next to `parent_idx` to encourage the compiler to join `len` and
  62     /// `parent_idx` into the same 32-bit word, reducing space overhead.
  63     len: u16,
  64
  65     /// The arrays storing the actual data of the node. Only the first `len` elements of each
  66     /// array are initialized and valid.
  67     keys: [MaybeUninit<K>; CAPACITY],
  68     vals: [MaybeUninit<V>; CAPACITY],
  69 }
  70
  71 impl<K, V> LeafNode<K, V> {
  72     /// Creates a new `LeafNode`. Unsafe because all nodes should really be hidden behind
  73     /// `BoxedNode`, preventing accidental dropping of uninitialized keys and values.
  74     unsafe fn new() -> Self {
  75         LeafNode {
  76             // As a general policy, we leave fields uninitialized if they can be, as this should
  77             // be both slightly faster and easier to track in Valgrind.
  78             keys: [MaybeUninit::UNINIT; CAPACITY],
  79             vals: [MaybeUninit::UNINIT; CAPACITY],
  80             parent: ptr::null(),
  81             parent_idx: MaybeUninit::uninit(),
  82             len: 0,
  83         }
  84     }
  85 }
  86
  87 /// The underlying representation of internal nodes. As with `LeafNode`s, these should be hidden
  88 /// behind `BoxedNode`s to prevent dropping uninitialized keys and values. Any pointer to an
  89 /// `InternalNode` can be directly casted to a pointer to the underlying `LeafNode` portion of the
  90 /// node, allowing code to act on leaf and internal nodes generically without having to even check
  91 /// which of the two a pointer is pointing at. This property is enabled by the use of `repr(C)`.
  92 #[repr(C)]
  93 struct InternalNode<K, V> {
  94     data: LeafNode<K, V>,
  95
  96     /// The pointers to the children of this node. `len + 1` of these are considered
  97     /// initialized and valid. Although during the process of `into_iter` or `drop`,
  98     /// some pointers are dangling while others still need to be traversed.
  99     edges: [MaybeUninit<BoxedNode<K, V>>; 2 * B],
 100 }
 101
 102 impl<K, V> InternalNode<K, V> {
 103     /// Creates a new `InternalNode`.
 104     ///
 105     /// This is unsafe for two reasons. First, it returns an `InternalNode` by value, risking
 106     /// dropping of uninitialized fields. Second, an invariant of internal nodes is that `len + 1`
 107     /// edges are initialized and valid, meaning that even when the node is empty (having a
 108     /// `len` of 0), there must be one initialized and valid edge. This function does not set up
 109     /// such an edge.
 110     unsafe fn new() -> Self {
 111         InternalNode { data: unsafe { LeafNode::new() }, edges: [MaybeUninit::UNINIT; 2 * B] }
 112     }
 113 }
 114
 115 /// A managed, non-null pointer to a node. This is either an owned pointer to
 116 /// `LeafNode<K, V>` or an owned pointer to `InternalNode<K, V>`.
 117 ///
 118 /// However, `BoxedNode` contains no information as to which of the two types
 119 /// of nodes it actually contains, and, partially due to this lack of information,
 120 /// has no destructor.
 121 struct BoxedNode<K, V> {
 122     ptr: Unique<LeafNode<K, V>>,
 123 }
 124
 125 impl<K, V> BoxedNode<K, V> {
 126     fn from_leaf(node: Box<LeafNode<K, V>>) -> Self {
 127         BoxedNode { ptr: Box::into_unique(node) }
 128     }
 129
 130     fn from_internal(node: Box<InternalNode<K, V>>) -> Self {
 131         BoxedNode { ptr: Box::into_unique(node).cast() }
 132     }
 133
 134     unsafe fn from_ptr(ptr: NonNull<LeafNode<K, V>>) -> Self {
 135         BoxedNode { ptr: unsafe { Unique::new_unchecked(ptr.as_ptr()) } }
 136     }
 137
 138     fn as_ptr(&self) -> NonNull<LeafNode<K, V>> {
 139         NonNull::from(self.ptr)
 140     }
 141 }
 142
 143 /// An owned tree.
 144 ///
 145 /// Note that this does not have a destructor, and must be cleaned up manually.
 146 pub struct Root<K, V> {
 147     node: BoxedNode<K, V>,
 148     /// The number of levels below the root node.
 149     height: usize,
 150 }
 151
 152 unsafe impl<K: Sync, V: Sync> Sync for Root<K, V> {}
 153 unsafe impl<K: Send, V: Send> Send for Root<K, V> {}
 154
 155 impl<K, V> Root<K, V> {
 156     /// Returns the number of levels below the root.
 157     pub fn height(&self) -> usize {
 158         self.height
 159     }
 160
 161     /// Returns a new owned tree, with its own root node that is initially empty.
 162     pub fn new_leaf() -> Self {
 163         Root { node: BoxedNode::from_leaf(Box::new(unsafe { LeafNode::new() })), height: 0 }
 164     }
 165
 166     pub fn as_ref(&self) -> NodeRef<marker::Immut<'_>, K, V, marker::LeafOrInternal> {
 167         NodeRef {
 168             height: self.height,
 169             node: self.node.as_ptr(),
 170             root: ptr::null(),
 171             _marker: PhantomData,
 172         }
 173     }
 174
 175     pub fn as_mut(&mut self) -> NodeRef<marker::Mut<'_>, K, V, marker::LeafOrInternal> {
 176         NodeRef {
 177             height: self.height,
 178             node: self.node.as_ptr(),
 179             root: self as *mut _,
 180             _marker: PhantomData,
 181         }
 182     }
 183
 184     pub fn into_ref(self) -> NodeRef<marker::Owned, K, V, marker::LeafOrInternal> {
 185         NodeRef {
 186             height: self.height,
 187             node: self.node.as_ptr(),
 188             root: ptr::null(),
 189             _marker: PhantomData,
 190         }
 191     }
 192
 193     /// Adds a new internal node with a single edge, pointing to the previous root, and make that
 194     /// new node the root. This increases the height by 1 and is the opposite of `pop_level`.
 195     pub fn push_level(&mut self) -> NodeRef<marker::Mut<'_>, K, V, marker::Internal> {
 196         let mut new_node = Box::new(unsafe { InternalNode::new() });
 197         new_node.edges[0].write(unsafe { BoxedNode::from_ptr(self.node.as_ptr()) });
 198
 199         self.node = BoxedNode::from_internal(new_node);
 200         self.height += 1;
 201
 202         let mut ret = NodeRef {
 203             height: self.height,
 204             node: self.node.as_ptr(),
 205             root: self as *mut _,
 206             _marker: PhantomData,
 207         };
 208
 209         unsafe {
 210             ret.reborrow_mut().first_edge().correct_parent_link();
 211         }
 212
 213         ret
 214     }
 215
 216     /// Removes the root node, using its first child as the new root. This cannot be called when
 217     /// the tree consists only of a leaf node. As it is intended only to be called when the root
 218     /// has only one edge, no cleanup is done on any of the other children of the root.
 219     /// This decreases the height by 1 and is the opposite of `push_level`.
 220     pub fn pop_level(&mut self) {
 221         assert!(self.height > 0);
 222
 223         let top = self.node.ptr;
 224
 225         self.node = unsafe {
 226             BoxedNode::from_ptr(
 227                 self.as_mut().cast_unchecked::<marker::Internal>().first_edge().descend().node,
 228             )
 229         };
 230         self.height -= 1;
 231         unsafe {
 232             (*self.as_mut().as_leaf_mut()).parent = ptr::null();
 233         }
 234
 235         unsafe {
 236             Global.dealloc(NonNull::from(top).cast(), Layout::new::<InternalNode<K, V>>());
 237         }
 238     }
 239 }
 240
 241 // N.B. `NodeRef` is always covariant in `K` and `V`, even when the `BorrowType`
 242 // is `Mut`. This is technically wrong, but cannot result in any unsafety due to
 243 // internal use of `NodeRef` because we stay completely generic over `K` and `V`.
 244 // However, whenever a public type wraps `NodeRef`, make sure that it has the
 245 // correct variance.
 246 /// A reference to a node.
 247 ///
 248 /// This type has a number of parameters that controls how it acts:
 249 /// - `BorrowType`: This can be `Immut<'a>` or `Mut<'a>` for some `'a` or `Owned`.
 250 ///    When this is `Immut<'a>`, the `NodeRef` acts roughly like `&'a Node`,
 251 ///    when this is `Mut<'a>`, the `NodeRef` acts roughly like `&'a mut Node`,
 252 ///    and when this is `Owned`, the `NodeRef` acts roughly like `Box<Node>`.
 253 /// - `K` and `V`: These control what types of things are stored in the nodes.
 254 /// - `Type`: This can be `Leaf`, `Internal`, or `LeafOrInternal`. When this is
 255 ///   `Leaf`, the `NodeRef` points to a leaf node, when this is `Internal` the
 256 ///   `NodeRef` points to an internal node, and when this is `LeafOrInternal` the
 257 ///   `NodeRef` could be pointing to either type of node.
 258 pub struct NodeRef<BorrowType, K, V, Type> {
 259     /// The number of levels below the node.
 260     height: usize,
 261     node: NonNull<LeafNode<K, V>>,
 262     // `root` is null unless the borrow type is `Mut`
 263     root: *const Root<K, V>,
 264     _marker: PhantomData<(BorrowType, Type)>,
 265 }
 266
 267 impl<'a, K: 'a, V: 'a, Type> Copy for NodeRef<marker::Immut<'a>, K, V, Type> {}
 268 impl<'a, K: 'a, V: 'a, Type> Clone for NodeRef<marker::Immut<'a>, K, V, Type> {
 269     fn clone(&self) -> Self {
 270         *self
 271     }
 272 }
 273
 274 unsafe impl<BorrowType, K: Sync, V: Sync, Type> Sync for NodeRef<BorrowType, K, V, Type> {}
 275
 276 unsafe impl<'a, K: Sync + 'a, V: Sync + 'a, Type> Send for NodeRef<marker::Immut<'a>, K, V, Type> {}
 277 unsafe impl<'a, K: Send + 'a, V: Send + 'a, Type> Send for NodeRef<marker::Mut<'a>, K, V, Type> {}
 278 unsafe impl<K: Send, V: Send, Type> Send for NodeRef<marker::Owned, K, V, Type> {}
 279
 280 impl<BorrowType, K, V> NodeRef<BorrowType, K, V, marker::Internal> {
 281     fn as_internal(&self) -> &InternalNode<K, V> {
 282         unsafe { &*(self.node.as_ptr() as *mut InternalNode<K, V>) }
 283     }
 284 }
 285
 286 impl<'a, K, V> NodeRef<marker::Mut<'a>, K, V, marker::Internal> {
 287     fn as_internal_mut(&mut self) -> &mut InternalNode<K, V> {
 288         unsafe { &mut *(self.node.as_ptr() as *mut InternalNode<K, V>) }
 289     }
 290 }
 291
 292 impl<BorrowType, K, V, Type> NodeRef<BorrowType, K, V, Type> {
 293     /// Finds the length of the node. This is the number of keys or values. In an
 294     /// internal node, the number of edges is `len() + 1`.
 295     /// For any node, the number of possible edge handles is also `len() + 1`.
 296     /// Note that, despite being safe, calling this function can have the side effect
 297     /// of invalidating mutable references that unsafe code has created.
 298     pub fn len(&self) -> usize {
 299         self.as_leaf().len as usize
 300     }
 301
 302     /// Returns the height of this node in the whole tree. Zero height denotes the
 303     /// leaf level.
 304     pub fn height(&self) -> usize {
 305         self.height
 306     }
 307
 308     /// Removes any static information about whether this node is a `Leaf` or an
 309     /// `Internal` node.
 310     pub fn forget_type(self) -> NodeRef<BorrowType, K, V, marker::LeafOrInternal> {
 311         NodeRef { height: self.height, node: self.node, root: self.root, _marker: PhantomData }
 312     }
 313
 314     /// Temporarily takes out another, immutable reference to the same node.
 315     fn reborrow(&self) -> NodeRef<marker::Immut<'_>, K, V, Type> {
 316         NodeRef { height: self.height, node: self.node, root: self.root, _marker: PhantomData }
 317     }
 318
 319     /// Exposes the leaf "portion" of any leaf or internal node.
 320     /// If the node is a leaf, this function simply opens up its data.
 321     /// If the node is an internal node, so not a leaf, it does have all the data a leaf has
 322     /// (header, keys and values), and this function exposes that.
 323     fn as_leaf(&self) -> &LeafNode<K, V> {
 324         // The node must be valid for at least the LeafNode portion.
 325         // This is not a reference in the NodeRef type because we don't know if
 326         // it should be unique or shared.
 327         unsafe { self.node.as_ref() }
 328     }
 329
 330     /// Borrows a view into the keys stored in the node.
 331     pub fn keys(&self) -> &[K] {
 332         self.reborrow().into_key_slice()
 333     }
 334
 335     /// Borrows a view into the values stored in the node.
 336     fn vals(&self) -> &[V] {
 337         self.reborrow().into_val_slice()
 338     }
 339
 340     /// Finds the parent of the current node. Returns `Ok(handle)` if the current
 341     /// node actually has a parent, where `handle` points to the edge of the parent
 342     /// that points to the current node. Returns `Err(self)` if the current node has
 343     /// no parent, giving back the original `NodeRef`.
 344     ///
 345     /// `edge.descend().ascend().unwrap()` and `node.ascend().unwrap().descend()` should
 346     /// both, upon success, do nothing.
 347     pub fn ascend(
 348         self,
 349     ) -> Result<Handle<NodeRef<BorrowType, K, V, marker::Internal>, marker::Edge>, Self> {
 350         let parent_as_leaf = self.as_leaf().parent as *const LeafNode<K, V>;
 351         if let Some(non_zero) = NonNull::new(parent_as_leaf as *mut _) {
 352             Ok(Handle {
 353                 node: NodeRef {
 354                     height: self.height + 1,
 355                     node: non_zero,
 356                     root: self.root,
 357                     _marker: PhantomData,
 358                 },
 359                 idx: unsafe { usize::from(*self.as_leaf().parent_idx.as_ptr()) },
 360                 _marker: PhantomData,
 361             })
 362         } else {
 363             Err(self)
 364         }
 365     }
 366
 367     pub fn first_edge(self) -> Handle<Self, marker::Edge> {
 368         unsafe { Handle::new_edge(self, 0) }
 369     }
 370
 371     pub fn last_edge(self) -> Handle<Self, marker::Edge> {
 372         let len = self.len();
 373         unsafe { Handle::new_edge(self, len) }
 374     }
 375
 376     /// Note that `self` must be nonempty.
 377     pub fn first_kv(self) -> Handle<Self, marker::KV> {
 378         let len = self.len();
 379         assert!(len > 0);
 380         unsafe { Handle::new_kv(self, 0) }
 381     }
 382
 383     /// Note that `self` must be nonempty.
 384     pub fn last_kv(self) -> Handle<Self, marker::KV> {
 385         let len = self.len();
 386         assert!(len > 0);
 387         unsafe { Handle::new_kv(self, len - 1) }
 388     }
 389 }
 390
 391 impl<K, V> NodeRef<marker::Owned, K, V, marker::LeafOrInternal> {
 392     /// Similar to `ascend`, gets a reference to a node's parent node, but also
 393     /// deallocate the current node in the process. This is unsafe because the
 394     /// current node will still be accessible despite being deallocated.
 395     pub unsafe fn deallocate_and_ascend(
 396         self,
 397     ) -> Option<Handle<NodeRef<marker::Owned, K, V, marker::Internal>, marker::Edge>> {
 398         let height = self.height;
 399         let node = self.node;
 400         let ret = self.ascend().ok();
 401         unsafe {
 402             Global.dealloc(
 403                 node.cast(),
 404                 if height > 0 {
 405                     Layout::new::<InternalNode<K, V>>()
 406                 } else {
 407                     Layout::new::<LeafNode<K, V>>()
 408                 },
 409             );
 410         }
 411         ret
 412     }
 413 }
 414
 415 impl<'a, K, V, Type> NodeRef<marker::Mut<'a>, K, V, Type> {
 416     /// Unsafely asserts to the compiler some static information about whether this
 417     /// node is a `Leaf` or an `Internal`.
 418     unsafe fn cast_unchecked<NewType>(&mut self) -> NodeRef<marker::Mut<'_>, K, V, NewType> {
 419         NodeRef { height: self.height, node: self.node, root: self.root, _marker: PhantomData }
 420     }
 421
 422     /// Temporarily takes out another, mutable reference to the same node. Beware, as
 423     /// this method is very dangerous, doubly so since it may not immediately appear
 424     /// dangerous.
 425     ///
 426     /// Because mutable pointers can roam anywhere around the tree and can even (through
 427     /// `into_root_mut`) mess with the root of the tree, the result of `reborrow_mut`
 428     /// can easily be used to make the original mutable pointer dangling, or, in the case
 429     /// of a reborrowed handle, out of bounds.
 430     // FIXME(@gereeter) consider adding yet another type parameter to `NodeRef` that restricts
 431     // the use of `ascend` and `into_root_mut` on reborrowed pointers, preventing this unsafety.
 432     unsafe fn reborrow_mut(&mut self) -> NodeRef<marker::Mut<'_>, K, V, Type> {
 433         NodeRef { height: self.height, node: self.node, root: self.root, _marker: PhantomData }
 434     }
 435
 436     /// Exposes the leaf "portion" of any leaf or internal node for writing.
 437     /// If the node is a leaf, this function simply opens up its data.
 438     /// If the node is an internal node, so not a leaf, it does have all the data a leaf has
 439     /// (header, keys and values), and this function exposes that.
 440     ///
 441     /// Returns a raw ptr to avoid asserting exclusive access to the entire node.
 442     fn as_leaf_mut(&mut self) -> *mut LeafNode<K, V> {
 443         self.node.as_ptr()
 444     }
 445
 446     fn keys_mut(&mut self) -> &mut [K] {
 447         // SAFETY: the caller will not be able to call further methods on self
 448         // until the key slice reference is dropped, as we have unique access
 449         // for the lifetime of the borrow.
 450         unsafe { self.reborrow_mut().into_key_slice_mut() }
 451     }
 452
 453     fn vals_mut(&mut self) -> &mut [V] {
 454         // SAFETY: the caller will not be able to call further methods on self
 455         // until the value slice reference is dropped, as we have unique access
 456         // for the lifetime of the borrow.
 457         unsafe { self.reborrow_mut().into_val_slice_mut() }
 458     }
 459 }
 460
 461 impl<'a, K: 'a, V: 'a, Type> NodeRef<marker::Immut<'a>, K, V, Type> {
 462     fn into_key_slice(self) -> &'a [K] {
 463         unsafe { slice::from_raw_parts(MaybeUninit::first_ptr(&self.as_leaf().keys), self.len()) }
 464     }
 465
 466     fn into_val_slice(self) -> &'a [V] {
 467         unsafe { slice::from_raw_parts(MaybeUninit::first_ptr(&self.as_leaf().vals), self.len()) }
 468     }
 469 }
 470
 471 impl<'a, K: 'a, V: 'a, Type> NodeRef<marker::Mut<'a>, K, V, Type> {
 472     /// Gets a mutable reference to the root itself. This is useful primarily when the
 473     /// height of the tree needs to be adjusted. Never call this on a reborrowed pointer.
 474     pub fn into_root_mut(self) -> &'a mut Root<K, V> {
 475         unsafe { &mut *(self.root as *mut Root<K, V>) }
 476     }
 477
 478     fn into_key_slice_mut(mut self) -> &'a mut [K] {
 479         // SAFETY: The keys of a node must always be initialized up to length.
 480         unsafe {
 481             slice::from_raw_parts_mut(
 482                 MaybeUninit::first_ptr_mut(&mut (*self.as_leaf_mut()).keys),
 483                 self.len(),
 484             )
 485         }
 486     }
 487
 488     fn into_val_slice_mut(mut self) -> &'a mut [V] {
 489         // SAFETY: The values of a node must always be initialized up to length.
 490         unsafe {
 491             slice::from_raw_parts_mut(
 492                 MaybeUninit::first_ptr_mut(&mut (*self.as_leaf_mut()).vals),
 493                 self.len(),
 494             )
 495         }
 496     }
 497
 498     fn into_slices_mut(mut self) -> (&'a mut [K], &'a mut [V]) {
 499         // We cannot use the getters here, because calling the second one
 500         // invalidates the reference returned by the first.
 501         // More precisely, it is the call to `len` that is the culprit,
 502         // because that creates a shared reference to the header, which *can*
 503         // overlap with the keys (and even the values, for ZST keys).
 504         let len = self.len();
 505         let leaf = self.as_leaf_mut();
 506         // SAFETY: The keys and values of a node must always be initialized up to length.
 507         let keys = unsafe {
 508             slice::from_raw_parts_mut(MaybeUninit::first_ptr_mut(&mut (*leaf).keys), len)
 509         };
 510         let vals = unsafe {
 511             slice::from_raw_parts_mut(MaybeUninit::first_ptr_mut(&mut (*leaf).vals), len)
 512         };
 513         (keys, vals)
 514     }
 515 }
 516
 517 impl<'a, K, V> NodeRef<marker::Mut<'a>, K, V, marker::Leaf> {
 518     /// Adds a key/value pair to the end of the node.
 519     pub fn push(&mut self, key: K, val: V) {
 520         assert!(self.len() < CAPACITY);
 521
 522         let idx = self.len();
 523
 524         unsafe {
 525             ptr::write(self.keys_mut().get_unchecked_mut(idx), key);
 526             ptr::write(self.vals_mut().get_unchecked_mut(idx), val);
 527
 528             (*self.as_leaf_mut()).len += 1;
 529         }
 530     }
 531
 532     /// Adds a key/value pair to the beginning of the node.
 533     pub fn push_front(&mut self, key: K, val: V) {
 534         assert!(self.len() < CAPACITY);
 535
 536         unsafe {
 537             slice_insert(self.keys_mut(), 0, key);
 538             slice_insert(self.vals_mut(), 0, val);
 539
 540             (*self.as_leaf_mut()).len += 1;
 541         }
 542     }
 543 }
 544
 545 impl<'a, K, V> NodeRef<marker::Mut<'a>, K, V, marker::Internal> {
 546     /// Adds a key/value pair and an edge to go to the right of that pair to
 547     /// the end of the node.
 548     pub fn push(&mut self, key: K, val: V, edge: Root<K, V>) {
 549         assert!(edge.height == self.height - 1);
 550         assert!(self.len() < CAPACITY);
 551
 552         let idx = self.len();
 553
 554         unsafe {
 555             ptr::write(self.keys_mut().get_unchecked_mut(idx), key);
 556             ptr::write(self.vals_mut().get_unchecked_mut(idx), val);
 557             self.as_internal_mut().edges.get_unchecked_mut(idx + 1).write(edge.node);
 558
 559             (*self.as_leaf_mut()).len += 1;
 560
 561             Handle::new_edge(self.reborrow_mut(), idx + 1).correct_parent_link();
 562         }
 563     }
 564
 565     // Unsafe because 'first' and 'after_last' must be in range
 566     unsafe fn correct_childrens_parent_links(&mut self, first: usize, after_last: usize) {
 567         debug_assert!(first <= self.len());
 568         debug_assert!(after_last <= self.len() + 1);
 569         for i in first..after_last {
 570             unsafe { Handle::new_edge(self.reborrow_mut(), i) }.correct_parent_link();
 571         }
 572     }
 573
 574     fn correct_all_childrens_parent_links(&mut self) {
 575         let len = self.len();
 576         unsafe { self.correct_childrens_parent_links(0, len + 1) };
 577     }
 578
 579     /// Adds a key/value pair and an edge to go to the left of that pair to
 580     /// the beginning of the node.
 581     pub fn push_front(&mut self, key: K, val: V, edge: Root<K, V>) {
 582         assert!(edge.height == self.height - 1);
 583         assert!(self.len() < CAPACITY);
 584
 585         unsafe {
 586             slice_insert(self.keys_mut(), 0, key);
 587             slice_insert(self.vals_mut(), 0, val);
 588             slice_insert(
 589                 slice::from_raw_parts_mut(
 590                     MaybeUninit::first_ptr_mut(&mut self.as_internal_mut().edges),
 591                     self.len() + 1,
 592                 ),
 593                 0,
 594                 edge.node,
 595             );
 596
 597             (*self.as_leaf_mut()).len += 1;
 598
 599             self.correct_all_childrens_parent_links();
 600         }
 601     }
 602 }
 603
 604 impl<'a, K, V> NodeRef<marker::Mut<'a>, K, V, marker::LeafOrInternal> {
 605     /// Removes a key/value pair from the end of this node and returns the pair.
 606     /// If this is an internal node, also removes the edge that was to the right
 607     /// of that pair and returns the orphaned node that this edge owned with its
 608     /// parent erased.
 609     pub fn pop(&mut self) -> (K, V, Option<Root<K, V>>) {
 610         assert!(self.len() > 0);
 611
 612         let idx = self.len() - 1;
 613
 614         unsafe {
 615             let key = ptr::read(self.keys().get_unchecked(idx));
 616             let val = ptr::read(self.vals().get_unchecked(idx));
 617             let edge = match self.reborrow_mut().force() {
 618                 ForceResult::Leaf(_) => None,
 619                 ForceResult::Internal(internal) => {
 620                     let edge =
 621                         ptr::read(internal.as_internal().edges.get_unchecked(idx + 1).as_ptr());
 622                     let mut new_root = Root { node: edge, height: internal.height - 1 };
 623                     (*new_root.as_mut().as_leaf_mut()).parent = ptr::null();
 624                     Some(new_root)
 625                 }
 626             };
 627
 628             (*self.as_leaf_mut()).len -= 1;
 629             (key, val, edge)
 630         }
 631     }
 632
 633     /// Removes a key/value pair from the beginning of this node. If this is an internal node,
 634     /// also removes the edge that was to the left of that pair.
 635     pub fn pop_front(&mut self) -> (K, V, Option<Root<K, V>>) {
 636         assert!(self.len() > 0);
 637
 638         let old_len = self.len();
 639
 640         unsafe {
 641             let key = slice_remove(self.keys_mut(), 0);
 642             let val = slice_remove(self.vals_mut(), 0);
 643             let edge = match self.reborrow_mut().force() {
 644                 ForceResult::Leaf(_) => None,
 645                 ForceResult::Internal(mut internal) => {
 646                     let edge = slice_remove(
 647                         slice::from_raw_parts_mut(
 648                             MaybeUninit::first_ptr_mut(&mut internal.as_internal_mut().edges),
 649                             old_len + 1,
 650                         ),
 651                         0,
 652                     );
 653
 654                     let mut new_root = Root { node: edge, height: internal.height - 1 };
 655                     (*new_root.as_mut().as_leaf_mut()).parent = ptr::null();
 656
 657                     for i in 0..old_len {
 658                         Handle::new_edge(internal.reborrow_mut(), i).correct_parent_link();
 659                     }
 660
 661                     Some(new_root)
 662                 }
 663             };
 664
 665             (*self.as_leaf_mut()).len -= 1;
 666
 667             (key, val, edge)
 668         }
 669     }
 670
 671     fn into_kv_pointers_mut(mut self) -> (*mut K, *mut V) {
 672         (self.keys_mut().as_mut_ptr(), self.vals_mut().as_mut_ptr())
 673     }
 674 }
 675
 676 impl<BorrowType, K, V> NodeRef<BorrowType, K, V, marker::LeafOrInternal> {
 677     /// Checks whether a node is an `Internal` node or a `Leaf` node.
 678     pub fn force(
 679         self,
 680     ) -> ForceResult<
 681         NodeRef<BorrowType, K, V, marker::Leaf>,
 682         NodeRef<BorrowType, K, V, marker::Internal>,
 683     > {
 684         if self.height == 0 {
 685             ForceResult::Leaf(NodeRef {
 686                 height: self.height,
 687                 node: self.node,
 688                 root: self.root,
 689                 _marker: PhantomData,
 690             })
 691         } else {
 692             ForceResult::Internal(NodeRef {
 693                 height: self.height,
 694                 node: self.node,
 695                 root: self.root,
 696                 _marker: PhantomData,
 697             })
 698         }
 699     }
 700 }
 701
 702 /// A reference to a specific key/value pair or edge within a node. The `Node` parameter
 703 /// must be a `NodeRef`, while the `Type` can either be `KV` (signifying a handle on a key/value
 704 /// pair) or `Edge` (signifying a handle on an edge).
 705 ///
 706 /// Note that even `Leaf` nodes can have `Edge` handles. Instead of representing a pointer to
 707 /// a child node, these represent the spaces where child pointers would go between the key/value
 708 /// pairs. For example, in a node with length 2, there would be 3 possible edge locations - one
 709 /// to the left of the node, one between the two pairs, and one at the right of the node.
 710 pub struct Handle<Node, Type> {
 711     node: Node,
 712     idx: usize,
 713     _marker: PhantomData<Type>,
 714 }
 715
 716 impl<Node: Copy, Type> Copy for Handle<Node, Type> {}
 717 // We don't need the full generality of `#[derive(Clone)]`, as the only time `Node` will be
 718 // `Clone`able is when it is an immutable reference and therefore `Copy`.
 719 impl<Node: Copy, Type> Clone for Handle<Node, Type> {
 720     fn clone(&self) -> Self {
 721         *self
 722     }
 723 }
 724
 725 impl<Node, Type> Handle<Node, Type> {
 726     /// Retrieves the node that contains the edge of key/value pair this handle points to.
 727     pub fn into_node(self) -> Node {
 728         self.node
 729     }
 730
 731     /// Returns the position of this handle in the node.
 732     pub fn idx(&self) -> usize {
 733         self.idx
 734     }
 735 }
 736
 737 impl<BorrowType, K, V, NodeType> Handle<NodeRef<BorrowType, K, V, NodeType>, marker::KV> {
 738     /// Creates a new handle to a key/value pair in `node`.
 739     /// Unsafe because the caller must ensure that `idx < node.len()`.
 740     pub unsafe fn new_kv(node: NodeRef<BorrowType, K, V, NodeType>, idx: usize) -> Self {
 741         debug_assert!(idx < node.len());
 742
 743         Handle { node, idx, _marker: PhantomData }
 744     }
 745
 746     pub fn left_edge(self) -> Handle<NodeRef<BorrowType, K, V, NodeType>, marker::Edge> {
 747         unsafe { Handle::new_edge(self.node, self.idx) }
 748     }
 749
 750     pub fn right_edge(self) -> Handle<NodeRef<BorrowType, K, V, NodeType>, marker::Edge> {
 751         unsafe { Handle::new_edge(self.node, self.idx + 1) }
 752     }
 753 }
 754
 755 impl<BorrowType, K, V, NodeType, HandleType> PartialEq
 756     for Handle<NodeRef<BorrowType, K, V, NodeType>, HandleType>
 757 {
 758     fn eq(&self, other: &Self) -> bool {
 759         self.node.node == other.node.node && self.idx == other.idx
 760     }
 761 }
 762
 763 impl<BorrowType, K, V, NodeType, HandleType> PartialOrd
 764     for Handle<NodeRef<BorrowType, K, V, NodeType>, HandleType>
 765 {
 766     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
 767         if self.node.node == other.node.node { Some(self.idx.cmp(&other.idx)) } else { None }
 768     }
 769 }
 770
 771 impl<BorrowType, K, V, NodeType, HandleType>
 772     Handle<NodeRef<BorrowType, K, V, NodeType>, HandleType>
 773 {
 774     /// Temporarily takes out another, immutable handle on the same location.
 775     pub fn reborrow(&self) -> Handle<NodeRef<marker::Immut<'_>, K, V, NodeType>, HandleType> {
 776         // We can't use Handle::new_kv or Handle::new_edge because we don't know our type
 777         Handle { node: self.node.reborrow(), idx: self.idx, _marker: PhantomData }
 778     }
 779 }
 780
 781 impl<'a, K, V, NodeType, HandleType> Handle<NodeRef<marker::Mut<'a>, K, V, NodeType>, HandleType> {
 782     /// Temporarily takes out another, mutable handle on the same location. Beware, as
 783     /// this method is very dangerous, doubly so since it may not immediately appear
 784     /// dangerous.
 785     ///
 786     /// Because mutable pointers can roam anywhere around the tree and can even (through
 787     /// `into_root_mut`) mess with the root of the tree, the result of `reborrow_mut`
 788     /// can easily be used to make the original mutable pointer dangling, or, in the case
 789     /// of a reborrowed handle, out of bounds.
 790     // FIXME(@gereeter) consider adding yet another type parameter to `NodeRef` that restricts
 791     // the use of `ascend` and `into_root_mut` on reborrowed pointers, preventing this unsafety.
 792     pub unsafe fn reborrow_mut(
 793         &mut self,
 794     ) -> Handle<NodeRef<marker::Mut<'_>, K, V, NodeType>, HandleType> {
 795         // We can't use Handle::new_kv or Handle::new_edge because we don't know our type
 796         Handle { node: unsafe { self.node.reborrow_mut() }, idx: self.idx, _marker: PhantomData }
 797     }
 798 }
 799
 800 impl<BorrowType, K, V, NodeType> Handle<NodeRef<BorrowType, K, V, NodeType>, marker::Edge> {
 801     /// Creates a new handle to an edge in `node`.
 802     /// Unsafe because the caller must ensure that `idx <= node.len()`.
 803     pub unsafe fn new_edge(node: NodeRef<BorrowType, K, V, NodeType>, idx: usize) -> Self {
 804         debug_assert!(idx <= node.len());
 805
 806         Handle { node, idx, _marker: PhantomData }
 807     }
 808
 809     pub fn left_kv(self) -> Result<Handle<NodeRef<BorrowType, K, V, NodeType>, marker::KV>, Self> {
 810         if self.idx > 0 {
 811             Ok(unsafe { Handle::new_kv(self.node, self.idx - 1) })
 812         } else {
 813             Err(self)
 814         }
 815     }
 816
 817     pub fn right_kv(self) -> Result<Handle<NodeRef<BorrowType, K, V, NodeType>, marker::KV>, Self> {
 818         if self.idx < self.node.len() {
 819             Ok(unsafe { Handle::new_kv(self.node, self.idx) })
 820         } else {
 821             Err(self)
 822         }
 823     }
 824 }
 825
 826 impl<'a, K, V> Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge> {
 827     /// Inserts a new key/value pair between the key/value pairs to the right and left of
 828     /// this edge. This method assumes that there is enough space in the node for the new
 829     /// pair to fit.
 830     ///
 831     /// The returned pointer points to the inserted value.
 832     fn insert_fit(&mut self, key: K, val: V) -> *mut V {
 833         // Necessary for correctness, but in a private module
 834         debug_assert!(self.node.len() < CAPACITY);
 835
 836         unsafe {
 837             slice_insert(self.node.keys_mut(), self.idx, key);
 838             slice_insert(self.node.vals_mut(), self.idx, val);
 839
 840             (*self.node.as_leaf_mut()).len += 1;
 841
 842             self.node.vals_mut().get_unchecked_mut(self.idx)
 843         }
 844     }
 845
 846     /// Inserts a new key/value pair between the key/value pairs to the right and left of
 847     /// this edge. This method splits the node if there isn't enough room.
 848     ///
 849     /// The returned pointer points to the inserted value.
 850     pub fn insert(mut self, key: K, val: V) -> (InsertResult<'a, K, V, marker::Leaf>, *mut V) {
 851         if self.node.len() < CAPACITY {
 852             let ptr = self.insert_fit(key, val);
 853             let kv = unsafe { Handle::new_kv(self.node, self.idx) };
 854             (InsertResult::Fit(kv), ptr)
 855         } else {
 856             let middle = unsafe { Handle::new_kv(self.node, B) };
 857             let (mut left, k, v, mut right) = middle.split();
 858             let ptr = if self.idx <= B {
 859                 unsafe { Handle::new_edge(left.reborrow_mut(), self.idx).insert_fit(key, val) }
 860             } else {
 861                 unsafe {
 862                     Handle::new_edge(
 863                         right.as_mut().cast_unchecked::<marker::Leaf>(),
 864                         self.idx - (B + 1),
 865                     )
 866                     .insert_fit(key, val)
 867                 }
 868             };
 869             (InsertResult::Split(left, k, v, right), ptr)
 870         }
 871     }
 872 }
 873
 874 impl<'a, K, V> Handle<NodeRef<marker::Mut<'a>, K, V, marker::Internal>, marker::Edge> {
 875     /// Fixes the parent pointer and index in the child node below this edge. This is useful
 876     /// when the ordering of edges has been changed, such as in the various `insert` methods.
 877     fn correct_parent_link(mut self) {
 878         let idx = self.idx as u16;
 879         let ptr = self.node.as_internal_mut() as *mut _;
 880         let mut child = self.descend();
 881         unsafe {
 882             (*child.as_leaf_mut()).parent = ptr;
 883             (*child.as_leaf_mut()).parent_idx.write(idx);
 884         }
 885     }
 886
 887     /// Unsafely asserts to the compiler some static information about whether the underlying
 888     /// node of this handle is a `Leaf` or an `Internal`.
 889     unsafe fn cast_unchecked<NewType>(
 890         &mut self,
 891     ) -> Handle<NodeRef<marker::Mut<'_>, K, V, NewType>, marker::Edge> {
 892         unsafe { Handle::new_edge(self.node.cast_unchecked(), self.idx) }
 893     }
 894
 895     /// Inserts a new key/value pair and an edge that will go to the right of that new pair
 896     /// between this edge and the key/value pair to the right of this edge. This method assumes
 897     /// that there is enough space in the node for the new pair to fit.
 898     fn insert_fit(&mut self, key: K, val: V, edge: Root<K, V>) {
 899         // Necessary for correctness, but in an internal module
 900         debug_assert!(self.node.len() < CAPACITY);
 901         debug_assert!(edge.height == self.node.height - 1);
 902
 903         unsafe {
 904             // This cast is a lie, but it allows us to reuse the key/value insertion logic.
 905             self.cast_unchecked::<marker::Leaf>().insert_fit(key, val);
 906
 907             slice_insert(
 908                 slice::from_raw_parts_mut(
 909                     MaybeUninit::first_ptr_mut(&mut self.node.as_internal_mut().edges),
 910                     self.node.len(),
 911                 ),
 912                 self.idx + 1,
 913                 edge.node,
 914             );
 915
 916             for i in (self.idx + 1)..(self.node.len() + 1) {
 917                 Handle::new_edge(self.node.reborrow_mut(), i).correct_parent_link();
 918             }
 919         }
 920     }
 921
 922     /// Inserts a new key/value pair and an edge that will go to the right of that new pair
 923     /// between this edge and the key/value pair to the right of this edge. This method splits
 924     /// the node if there isn't enough room.
 925     pub fn insert(
 926         mut self,
 927         key: K,
 928         val: V,
 929         edge: Root<K, V>,
 930     ) -> InsertResult<'a, K, V, marker::Internal> {
 931         assert!(edge.height == self.node.height - 1);
 932
 933         if self.node.len() < CAPACITY {
 934             self.insert_fit(key, val, edge);
 935             let kv = unsafe { Handle::new_kv(self.node, self.idx) };
 936             InsertResult::Fit(kv)
 937         } else {
 938             let middle = unsafe { Handle::new_kv(self.node, B) };
 939             let (mut left, k, v, mut right) = middle.split();
 940             if self.idx <= B {
 941                 unsafe {
 942                     Handle::new_edge(left.reborrow_mut(), self.idx).insert_fit(key, val, edge);
 943                 }
 944             } else {
 945                 unsafe {
 946                     Handle::new_edge(
 947                         right.as_mut().cast_unchecked::<marker::Internal>(),
 948                         self.idx - (B + 1),
 949                     )
 950                     .insert_fit(key, val, edge);
 951                 }
 952             }
 953             InsertResult::Split(left, k, v, right)
 954         }
 955     }
 956 }
 957
 958 impl<BorrowType, K, V> Handle<NodeRef<BorrowType, K, V, marker::Internal>, marker::Edge> {
 959     /// Finds the node pointed to by this edge.
 960     ///
 961     /// `edge.descend().ascend().unwrap()` and `node.ascend().unwrap().descend()` should
 962     /// both, upon success, do nothing.
 963     pub fn descend(self) -> NodeRef<BorrowType, K, V, marker::LeafOrInternal> {
 964         NodeRef {
 965             height: self.node.height - 1,
 966             node: unsafe {
 967                 (&*self.node.as_internal().edges.get_unchecked(self.idx).as_ptr()).as_ptr()
 968             },
 969             root: self.node.root,
 970             _marker: PhantomData,
 971         }
 972     }
 973 }
 974
 975 impl<'a, K: 'a, V: 'a, NodeType> Handle<NodeRef<marker::Immut<'a>, K, V, NodeType>, marker::KV> {
 976     pub fn into_kv(self) -> (&'a K, &'a V) {
 977         let keys = self.node.into_key_slice();
 978         let vals = self.node.into_val_slice();
 979         unsafe { (keys.get_unchecked(self.idx), vals.get_unchecked(self.idx)) }
 980     }
 981 }
 982
 983 impl<'a, K: 'a, V: 'a, NodeType> Handle<NodeRef<marker::Mut<'a>, K, V, NodeType>, marker::KV> {
 984     pub fn into_kv_mut(self) -> (&'a mut K, &'a mut V) {
 985         unsafe {
 986             let (keys, vals) = self.node.into_slices_mut();
 987             (keys.get_unchecked_mut(self.idx), vals.get_unchecked_mut(self.idx))
 988         }
 989     }
 990 }
 991
 992 impl<'a, K, V, NodeType> Handle<NodeRef<marker::Mut<'a>, K, V, NodeType>, marker::KV> {
 993     pub fn kv_mut(&mut self) -> (&mut K, &mut V) {
 994         unsafe {
 995             let (keys, vals) = self.node.reborrow_mut().into_slices_mut();
 996             (keys.get_unchecked_mut(self.idx), vals.get_unchecked_mut(self.idx))
 997         }
 998     }
 999 }
1000
1001 impl<'a, K, V> Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::KV> {
1002     /// Splits the underlying node into three parts:
1003     ///
1004     /// - The node is truncated to only contain the key/value pairs to the right of
1005     ///   this handle.
1006     /// - The key and value pointed to by this handle and extracted.
1007     /// - All the key/value pairs to the right of this handle are put into a newly
1008     ///   allocated node.
1009     pub fn split(mut self) -> (NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, K, V, Root<K, V>) {
1010         unsafe {
1011             let mut new_node = Box::new(LeafNode::new());
1012
1013             let k = ptr::read(self.node.keys().get_unchecked(self.idx));
1014             let v = ptr::read(self.node.vals().get_unchecked(self.idx));
1015
1016             let new_len = self.node.len() - self.idx - 1;
1017
1018             ptr::copy_nonoverlapping(
1019                 self.node.keys().as_ptr().add(self.idx + 1),
1020                 new_node.keys.as_mut_ptr() as *mut K,
1021                 new_len,
1022             );
1023             ptr::copy_nonoverlapping(
1024                 self.node.vals().as_ptr().add(self.idx + 1),
1025                 new_node.vals.as_mut_ptr() as *mut V,
1026                 new_len,
1027             );
1028
1029             (*self.node.as_leaf_mut()).len = self.idx as u16;
1030             new_node.len = new_len as u16;
1031
1032             (self.node, k, v, Root { node: BoxedNode::from_leaf(new_node), height: 0 })
1033         }
1034     }
1035
1036     /// Removes the key/value pair pointed to by this handle and returns it, along with the edge
1037     /// between the now adjacent key/value pairs (if any) to the left and right of this handle.
1038     pub fn remove(
1039         mut self,
1040     ) -> (Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge>, K, V) {
1041         unsafe {
1042             let k = slice_remove(self.node.keys_mut(), self.idx);
1043             let v = slice_remove(self.node.vals_mut(), self.idx);
1044             (*self.node.as_leaf_mut()).len -= 1;
1045             (self.left_edge(), k, v)
1046         }
1047     }
1048 }
1049
1050 impl<'a, K, V> Handle<NodeRef<marker::Mut<'a>, K, V, marker::Internal>, marker::KV> {
1051     /// Splits the underlying node into three parts:
1052     ///
1053     /// - The node is truncated to only contain the edges and key/value pairs to the
1054     ///   right of this handle.
1055     /// - The key and value pointed to by this handle and extracted.
1056     /// - All the edges and key/value pairs to the right of this handle are put into
1057     ///   a newly allocated node.
1058     pub fn split(mut self) -> (NodeRef<marker::Mut<'a>, K, V, marker::Internal>, K, V, Root<K, V>) {
1059         unsafe {
1060             let mut new_node = Box::new(InternalNode::new());
1061
1062             let k = ptr::read(self.node.keys().get_unchecked(self.idx));
1063             let v = ptr::read(self.node.vals().get_unchecked(self.idx));
1064
1065             let height = self.node.height;
1066             let new_len = self.node.len() - self.idx - 1;
1067
1068             ptr::copy_nonoverlapping(
1069                 self.node.keys().as_ptr().add(self.idx + 1),
1070                 new_node.data.keys.as_mut_ptr() as *mut K,
1071                 new_len,
1072             );
1073             ptr::copy_nonoverlapping(
1074                 self.node.vals().as_ptr().add(self.idx + 1),
1075                 new_node.data.vals.as_mut_ptr() as *mut V,
1076                 new_len,
1077             );
1078             ptr::copy_nonoverlapping(
1079                 self.node.as_internal().edges.as_ptr().add(self.idx + 1),
1080                 new_node.edges.as_mut_ptr(),
1081                 new_len + 1,
1082             );
1083
1084             (*self.node.as_leaf_mut()).len = self.idx as u16;
1085             new_node.data.len = new_len as u16;
1086
1087             let mut new_root = Root { node: BoxedNode::from_internal(new_node), height };
1088
1089             for i in 0..(new_len + 1) {
1090                 Handle::new_edge(new_root.as_mut().cast_unchecked(), i).correct_parent_link();
1091             }
1092
1093             (self.node, k, v, new_root)
1094         }
1095     }
1096
1097     /// Returns `true` if it is valid to call `.merge()`, i.e., whether there is enough room in
1098     /// a node to hold the combination of the nodes to the left and right of this handle along
1099     /// with the key/value pair at this handle.
1100     pub fn can_merge(&self) -> bool {
1101         (self.reborrow().left_edge().descend().len()
1102             + self.reborrow().right_edge().descend().len()
1103             + 1)
1104             <= CAPACITY
1105     }
1106
1107     /// Combines the node immediately to the left of this handle, the key/value pair pointed
1108     /// to by this handle, and the node immediately to the right of this handle into one new
1109     /// child of the underlying node, returning an edge referencing that new child.
1110     ///
1111     /// Assumes that this edge `.can_merge()`.
1112     pub fn merge(
1113         mut self,
1114     ) -> Handle<NodeRef<marker::Mut<'a>, K, V, marker::Internal>, marker::Edge> {
1115         let self1 = unsafe { ptr::read(&self) };
1116         let self2 = unsafe { ptr::read(&self) };
1117         let mut left_node = self1.left_edge().descend();
1118         let left_len = left_node.len();
1119         let mut right_node = self2.right_edge().descend();
1120         let right_len = right_node.len();
1121
1122         // necessary for correctness, but in a private module
1123         assert!(left_len + right_len < CAPACITY);
1124
1125         unsafe {
1126             ptr::write(
1127                 left_node.keys_mut().get_unchecked_mut(left_len),
1128                 slice_remove(self.node.keys_mut(), self.idx),
1129             );
1130             ptr::copy_nonoverlapping(
1131                 right_node.keys().as_ptr(),
1132                 left_node.keys_mut().as_mut_ptr().add(left_len + 1),
1133                 right_len,
1134             );
1135             ptr::write(
1136                 left_node.vals_mut().get_unchecked_mut(left_len),
1137                 slice_remove(self.node.vals_mut(), self.idx),
1138             );
1139             ptr::copy_nonoverlapping(
1140                 right_node.vals().as_ptr(),
1141                 left_node.vals_mut().as_mut_ptr().add(left_len + 1),
1142                 right_len,
1143             );
1144
1145             slice_remove(&mut self.node.as_internal_mut().edges, self.idx + 1);
1146             for i in self.idx + 1..self.node.len() {
1147                 Handle::new_edge(self.node.reborrow_mut(), i).correct_parent_link();
1148             }
1149             (*self.node.as_leaf_mut()).len -= 1;
1150
1151             (*left_node.as_leaf_mut()).len += right_len as u16 + 1;
1152
1153             let layout = if self.node.height > 1 {
1154                 ptr::copy_nonoverlapping(
1155                     right_node.cast_unchecked().as_internal().edges.as_ptr(),
1156                     left_node
1157                         .cast_unchecked()
1158                         .as_internal_mut()
1159                         .edges
1160                         .as_mut_ptr()
1161                         .add(left_len + 1),
1162                     right_len + 1,
1163                 );
1164
1165                 for i in left_len + 1..left_len + right_len + 2 {
1166                     Handle::new_edge(left_node.cast_unchecked().reborrow_mut(), i)
1167                         .correct_parent_link();
1168                 }
1169
1170                 Layout::new::<InternalNode<K, V>>()
1171             } else {
1172                 Layout::new::<LeafNode<K, V>>()
1173             };
1174             Global.dealloc(right_node.node.cast(), layout);
1175
1176             Handle::new_edge(self.node, self.idx)
1177         }
1178     }
1179
1180     /// This removes a key/value pair from the left child and places it in the key/value storage
1181     /// pointed to by this handle while pushing the old key/value pair of this handle into the right
1182     /// child.
1183     pub fn steal_left(&mut self) {
1184         unsafe {
1185             let (k, v, edge) = self.reborrow_mut().left_edge().descend().pop();
1186
1187             let k = mem::replace(self.reborrow_mut().into_kv_mut().0, k);
1188             let v = mem::replace(self.reborrow_mut().into_kv_mut().1, v);
1189
1190             match self.reborrow_mut().right_edge().descend().force() {
1191                 ForceResult::Leaf(mut leaf) => leaf.push_front(k, v),
1192                 ForceResult::Internal(mut internal) => internal.push_front(k, v, edge.unwrap()),
1193             }
1194         }
1195     }
1196
1197     /// This removes a key/value pair from the right child and places it in the key/value storage
1198     /// pointed to by this handle while pushing the old key/value pair of this handle into the left
1199     /// child.
1200     pub fn steal_right(&mut self) {
1201         unsafe {
1202             let (k, v, edge) = self.reborrow_mut().right_edge().descend().pop_front();
1203
1204             let k = mem::replace(self.reborrow_mut().into_kv_mut().0, k);
1205             let v = mem::replace(self.reborrow_mut().into_kv_mut().1, v);
1206
1207             match self.reborrow_mut().left_edge().descend().force() {
1208                 ForceResult::Leaf(mut leaf) => leaf.push(k, v),
1209                 ForceResult::Internal(mut internal) => internal.push(k, v, edge.unwrap()),
1210             }
1211         }
1212     }
1213
1214     /// This does stealing similar to `steal_left` but steals multiple elements at once.
1215     pub fn bulk_steal_left(&mut self, count: usize) {
1216         unsafe {
1217             let mut left_node = ptr::read(self).left_edge().descend();
1218             let left_len = left_node.len();
1219             let mut right_node = ptr::read(self).right_edge().descend();
1220             let right_len = right_node.len();
1221
1222             // Make sure that we may steal safely.
1223             assert!(right_len + count <= CAPACITY);
1224             assert!(left_len >= count);
1225
1226             let new_left_len = left_len - count;
1227
1228             // Move data.
1229             {
1230                 let left_kv = left_node.reborrow_mut().into_kv_pointers_mut();
1231                 let right_kv = right_node.reborrow_mut().into_kv_pointers_mut();
1232                 let parent_kv = {
1233                     let kv = self.reborrow_mut().into_kv_mut();
1234                     (kv.0 as *mut K, kv.1 as *mut V)
1235                 };
1236
1237                 // Make room for stolen elements in the right child.
1238                 ptr::copy(right_kv.0, right_kv.0.add(count), right_len);
1239                 ptr::copy(right_kv.1, right_kv.1.add(count), right_len);
1240
1241                 // Move elements from the left child to the right one.
1242                 move_kv(left_kv, new_left_len + 1, right_kv, 0, count - 1);
1243
1244                 // Move parent's key/value pair to the right child.
1245                 move_kv(parent_kv, 0, right_kv, count - 1, 1);
1246
1247                 // Move the left-most stolen pair to the parent.
1248                 move_kv(left_kv, new_left_len, parent_kv, 0, 1);
1249             }
1250
1251             (*left_node.reborrow_mut().as_leaf_mut()).len -= count as u16;
1252             (*right_node.reborrow_mut().as_leaf_mut()).len += count as u16;
1253
1254             match (left_node.force(), right_node.force()) {
1255                 (ForceResult::Internal(left), ForceResult::Internal(mut right)) => {
1256                     // Make room for stolen edges.
1257                     let right_edges = right.reborrow_mut().as_internal_mut().edges.as_mut_ptr();
1258                     ptr::copy(right_edges, right_edges.add(count), right_len + 1);
1259                     right.correct_childrens_parent_links(count, count + right_len + 1);
1260
1261                     move_edges(left, new_left_len + 1, right, 0, count);
1262                 }
1263                 (ForceResult::Leaf(_), ForceResult::Leaf(_)) => {}
1264                 _ => {
1265                     unreachable!();
1266                 }
1267             }
1268         }
1269     }
1270
1271     /// The symmetric clone of `bulk_steal_left`.
1272     pub fn bulk_steal_right(&mut self, count: usize) {
1273         unsafe {
1274             let mut left_node = ptr::read(self).left_edge().descend();
1275             let left_len = left_node.len();
1276             let mut right_node = ptr::read(self).right_edge().descend();
1277             let right_len = right_node.len();
1278
1279             // Make sure that we may steal safely.
1280             assert!(left_len + count <= CAPACITY);
1281             assert!(right_len >= count);
1282
1283             let new_right_len = right_len - count;
1284
1285             // Move data.
1286             {
1287                 let left_kv = left_node.reborrow_mut().into_kv_pointers_mut();
1288                 let right_kv = right_node.reborrow_mut().into_kv_pointers_mut();
1289                 let parent_kv = {
1290                     let kv = self.reborrow_mut().into_kv_mut();
1291                     (kv.0 as *mut K, kv.1 as *mut V)
1292                 };
1293
1294                 // Move parent's key/value pair to the left child.
1295                 move_kv(parent_kv, 0, left_kv, left_len, 1);
1296
1297                 // Move elements from the right child to the left one.
1298                 move_kv(right_kv, 0, left_kv, left_len + 1, count - 1);
1299
1300                 // Move the right-most stolen pair to the parent.
1301                 move_kv(right_kv, count - 1, parent_kv, 0, 1);
1302
1303                 // Fix right indexing
1304                 ptr::copy(right_kv.0.add(count), right_kv.0, new_right_len);
1305                 ptr::copy(right_kv.1.add(count), right_kv.1, new_right_len);
1306             }
1307
1308             (*left_node.reborrow_mut().as_leaf_mut()).len += count as u16;
1309             (*right_node.reborrow_mut().as_leaf_mut()).len -= count as u16;
1310
1311             match (left_node.force(), right_node.force()) {
1312                 (ForceResult::Internal(left), ForceResult::Internal(mut right)) => {
1313                     move_edges(right.reborrow_mut(), 0, left, left_len + 1, count);
1314
1315                     // Fix right indexing.
1316                     let right_edges = right.reborrow_mut().as_internal_mut().edges.as_mut_ptr();
1317                     ptr::copy(right_edges.add(count), right_edges, new_right_len + 1);
1318                     right.correct_childrens_parent_links(0, new_right_len + 1);
1319                 }
1320                 (ForceResult::Leaf(_), ForceResult::Leaf(_)) => {}
1321                 _ => {
1322                     unreachable!();
1323                 }
1324             }
1325         }
1326     }
1327 }
1328
1329 unsafe fn move_kv<K, V>(
1330     source: (*mut K, *mut V),
1331     source_offset: usize,
1332     dest: (*mut K, *mut V),
1333     dest_offset: usize,
1334     count: usize,
1335 ) {
1336     unsafe {
1337         ptr::copy_nonoverlapping(source.0.add(source_offset), dest.0.add(dest_offset), count);
1338         ptr::copy_nonoverlapping(source.1.add(source_offset), dest.1.add(dest_offset), count);
1339     }
1340 }
1341
1342 // Source and destination must have the same height.
1343 unsafe fn move_edges<K, V>(
1344     mut source: NodeRef<marker::Mut<'_>, K, V, marker::Internal>,
1345     source_offset: usize,
1346     mut dest: NodeRef<marker::Mut<'_>, K, V, marker::Internal>,
1347     dest_offset: usize,
1348     count: usize,
1349 ) {
1350     let source_ptr = source.as_internal_mut().edges.as_mut_ptr();
1351     let dest_ptr = dest.as_internal_mut().edges.as_mut_ptr();
1352     unsafe {
1353         ptr::copy_nonoverlapping(source_ptr.add(source_offset), dest_ptr.add(dest_offset), count);
1354         dest.correct_childrens_parent_links(dest_offset, dest_offset + count);
1355     }
1356 }
1357
1358 impl<BorrowType, K, V> Handle<NodeRef<BorrowType, K, V, marker::Leaf>, marker::Edge> {
1359     pub fn forget_node_type(
1360         self,
1361     ) -> Handle<NodeRef<BorrowType, K, V, marker::LeafOrInternal>, marker::Edge> {
1362         unsafe { Handle::new_edge(self.node.forget_type(), self.idx) }
1363     }
1364 }
1365
1366 impl<BorrowType, K, V> Handle<NodeRef<BorrowType, K, V, marker::Internal>, marker::Edge> {
1367     pub fn forget_node_type(
1368         self,
1369     ) -> Handle<NodeRef<BorrowType, K, V, marker::LeafOrInternal>, marker::Edge> {
1370         unsafe { Handle::new_edge(self.node.forget_type(), self.idx) }
1371     }
1372 }
1373
1374 impl<BorrowType, K, V> Handle<NodeRef<BorrowType, K, V, marker::Leaf>, marker::KV> {
1375     pub fn forget_node_type(
1376         self,
1377     ) -> Handle<NodeRef<BorrowType, K, V, marker::LeafOrInternal>, marker::KV> {
1378         unsafe { Handle::new_kv(self.node.forget_type(), self.idx) }
1379     }
1380 }
1381
1382 impl<BorrowType, K, V, HandleType>
1383     Handle<NodeRef<BorrowType, K, V, marker::LeafOrInternal>, HandleType>
1384 {
1385     /// Checks whether the underlying node is an `Internal` node or a `Leaf` node.
1386     pub fn force(
1387         self,
1388     ) -> ForceResult<
1389         Handle<NodeRef<BorrowType, K, V, marker::Leaf>, HandleType>,
1390         Handle<NodeRef<BorrowType, K, V, marker::Internal>, HandleType>,
1391     > {
1392         match self.node.force() {
1393             ForceResult::Leaf(node) => {
1394                 ForceResult::Leaf(Handle { node, idx: self.idx, _marker: PhantomData })
1395             }
1396             ForceResult::Internal(node) => {
1397                 ForceResult::Internal(Handle { node, idx: self.idx, _marker: PhantomData })
1398             }
1399         }
1400     }
1401 }
1402
1403 impl<'a, K, V> Handle<NodeRef<marker::Mut<'a>, K, V, marker::LeafOrInternal>, marker::Edge> {
1404     /// Move the suffix after `self` from one node to another one. `right` must be empty.
1405     /// The first edge of `right` remains unchanged.
1406     pub fn move_suffix(
1407         &mut self,
1408         right: &mut NodeRef<marker::Mut<'a>, K, V, marker::LeafOrInternal>,
1409     ) {
1410         unsafe {
1411             let left_new_len = self.idx;
1412             let mut left_node = self.reborrow_mut().into_node();
1413
1414             let right_new_len = left_node.len() - left_new_len;
1415             let mut right_node = right.reborrow_mut();
1416
1417             assert!(right_node.len() == 0);
1418             assert!(left_node.height == right_node.height);
1419
1420             if right_new_len > 0 {
1421                 let left_kv = left_node.reborrow_mut().into_kv_pointers_mut();
1422                 let right_kv = right_node.reborrow_mut().into_kv_pointers_mut();
1423
1424                 move_kv(left_kv, left_new_len, right_kv, 0, right_new_len);
1425
1426                 (*left_node.reborrow_mut().as_leaf_mut()).len = left_new_len as u16;
1427                 (*right_node.reborrow_mut().as_leaf_mut()).len = right_new_len as u16;
1428
1429                 match (left_node.force(), right_node.force()) {
1430                     (ForceResult::Internal(left), ForceResult::Internal(right)) => {
1431                         move_edges(left, left_new_len + 1, right, 1, right_new_len);
1432                     }
1433                     (ForceResult::Leaf(_), ForceResult::Leaf(_)) => {}
1434                     _ => {
1435                         unreachable!();
1436                     }
1437                 }
1438             }
1439         }
1440     }
1441 }
1442
1443 pub enum ForceResult<Leaf, Internal> {
1444     Leaf(Leaf),
1445     Internal(Internal),
1446 }
1447
1448 pub enum InsertResult<'a, K, V, Type> {
1449     Fit(Handle<NodeRef<marker::Mut<'a>, K, V, Type>, marker::KV>),
1450     Split(NodeRef<marker::Mut<'a>, K, V, Type>, K, V, Root<K, V>),
1451 }
1452
1453 pub mod marker {
1454     use core::marker::PhantomData;
1455
1456     pub enum Leaf {}
1457     pub enum Internal {}
1458     pub enum LeafOrInternal {}
1459
1460     pub enum Owned {}
1461     pub struct Immut<'a>(PhantomData<&'a ()>);
1462     pub struct Mut<'a>(PhantomData<&'a mut ()>);
1463
1464     pub enum KV {}
1465     pub enum Edge {}
1466 }
1467
1468 unsafe fn slice_insert<T>(slice: &mut [T], idx: usize, val: T) {
1469     unsafe {
1470         ptr::copy(slice.as_ptr().add(idx), slice.as_mut_ptr().add(idx + 1), slice.len() - idx);
1471         ptr::write(slice.get_unchecked_mut(idx), val);
1472     }
1473 }
1474
1475 unsafe fn slice_remove<T>(slice: &mut [T], idx: usize) -> T {
1476     unsafe {
1477         let ret = ptr::read(slice.get_unchecked(idx));
1478         ptr::copy(slice.as_ptr().add(idx + 1), slice.as_mut_ptr().add(idx), slice.len() - idx - 1);
1479         ret
1480     }
1481 }