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
// Copyright 2022 Colin Finck <colin@reactos.org>
// SPDX-License-Identifier: MIT OR Apache-2.0
use core::iter::FusedIterator;
use core::marker::PhantomData;
use core::ptr;
use super::traits::NtSingleList;
use crate::traits::{NtListElement, NtTypedList};
/// A singly linked list header compatible to [`SINGLE_LIST_ENTRY`] of the Windows NT API.
///
/// This variant requires elements to be allocated beforehand on a stable address and be
/// valid as long as the list is used.
/// As the Rust compiler cannot guarantee the validity of them, almost all `NtSingleListHead`
/// functions are `unsafe`.
/// You almost always want to use [`NtBoxingSingleListHead`] over this.
///
/// See the [module-level documentation](crate::single_list) for more details.
///
/// This structure substitutes the `SINGLE_LIST_ENTRY` structure of the Windows NT API for the list header.
///
/// [`NtBoxingSingleListHead`]: crate::single_list::NtBoxingSingleListHead
/// [`SINGLE_LIST_ENTRY`]: https://docs.microsoft.com/en-us/windows/win32/api/ntdef/ns-ntdef-single_list_entry
#[repr(C)]
pub struct NtSingleListHead<E: NtListElement<L>, L: NtTypedList<T = NtSingleList>> {
pub(crate) next: *mut NtSingleListEntry<E, L>,
}
impl<E, L> NtSingleListHead<E, L>
where
E: NtListElement<L>,
L: NtTypedList<T = NtSingleList>,
{
/// Creates a new singly linked list.
pub fn new() -> Self {
Self {
next: ptr::null_mut(),
}
}
/// Removes all elements from the list.
///
/// This operation computes in *O*(*1*) time, because it only resets the forward link of the header.
pub fn clear(&mut self) {
self.next = ptr::null_mut();
}
/// Returns the [`NtSingleListEntry`] for the given element.
pub(crate) fn entry(element: &mut E) -> *mut NtSingleListEntry<E, L> {
let element_ptr = element as *mut E;
// This is the canonical implementation of `byte_add`
let entry = unsafe { element_ptr.cast::<u8>().add(E::offset()).cast::<E>() };
entry.cast()
}
/// Provides a reference to the first element, or `None` if the list is empty.
///
/// This operation computes in *O*(*1*) time.
pub unsafe fn front(&self) -> Option<&E> {
(!self.is_empty()).then(|| NtSingleListEntry::containing_record(self.next))
}
/// Provides a mutable reference to the first element, or `None` if the list is empty.
///
/// This operation computes in *O*(*1*) time.
pub unsafe fn front_mut(&mut self) -> Option<&mut E> {
(!self.is_empty()).then(|| NtSingleListEntry::containing_record_mut(self.next))
}
/// Returns `true` if the list is empty.
///
/// This operation computes in *O*(*1*) time.
pub fn is_empty(&self) -> bool {
self.next.is_null()
}
/// Returns an iterator yielding references to each element of the list.
pub unsafe fn iter(&self) -> Iter<E, L> {
Iter {
current: self.next,
phantom: PhantomData,
}
}
/// Returns an iterator yielding mutable references to each element of the list.
pub unsafe fn iter_mut(&mut self) -> IterMut<E, L> {
IterMut {
current: self.next,
phantom: PhantomData,
}
}
/// Counts all elements and returns the length of the list.
///
/// This operation computes in *O*(*n*) time.
pub unsafe fn len(&self) -> usize {
self.iter().count()
}
/// Removes the first element from the list and returns it, or `None` if the list is empty.
///
/// This function substitutes [`PopEntryList`] of the Windows NT API.
///
/// This operation computes in *O*(*1*) time.
///
/// [`PopEntryList`]: https://docs.microsoft.com/en-us/windows-hardware/drivers/ddi/wdm/nf-wdm-popentrylist
pub unsafe fn pop_front(&mut self) -> Option<&mut E> {
(!self.is_empty()).then(|| {
let entry = self.next;
self.next = (*entry).next;
NtSingleListEntry::containing_record_mut(entry)
})
}
/// Appends an element to the front of the list.
///
/// This function substitutes [`PushEntryList`] of the Windows NT API.
///
/// This operation computes in *O*(*1*) time.
///
/// [`PushEntryList`]: https://docs.microsoft.com/en-us/windows-hardware/drivers/ddi/wdm/nf-wdm-pushentrylist
pub unsafe fn push_front(&mut self, element: &mut E) {
let entry = Self::entry(element);
(*entry).next = self.next;
self.next = entry;
}
/// Retains only the elements specified by the predicate, passing a mutable reference to it.
///
/// In other words, remove all elements `e` for which `f(&mut e)` returns `false`.
/// This method operates in place, visiting each element exactly once in the original order,
/// and preserves the order of the retained elements.
///
/// This operation computes in *O*(*n*) time.
pub unsafe fn retain<F>(&mut self, mut f: F)
where
F: FnMut(&mut E) -> bool,
{
let mut previous = (self as *mut Self).cast();
let mut current = self.next;
while !current.is_null() {
let element = NtSingleListEntry::containing_record_mut(current);
if f(element) {
previous = current;
} else {
(*previous).next = (*current).next;
}
current = (*current).next;
}
}
}
impl<E, L> Default for NtSingleListHead<E, L>
where
E: NtListElement<L>,
L: NtTypedList<T = NtSingleList>,
{
fn default() -> Self {
Self::new()
}
}
/// Iterator over the elements of a singly linked list.
///
/// This iterator is returned from the [`NtSingleListHead::iter`] and
/// [`NtBoxingSingleListHead::iter`] functions.
///
/// [`NtBoxingSingleListHead::iter`]: crate::single_list::NtBoxingSingleListHead::iter
pub struct Iter<'a, E: NtListElement<L>, L: NtTypedList<T = NtSingleList>> {
current: *const NtSingleListEntry<E, L>,
phantom: PhantomData<&'a NtSingleListHead<E, L>>,
}
impl<'a, E, L> Iterator for Iter<'a, E, L>
where
E: NtListElement<L>,
L: NtTypedList<T = NtSingleList>,
{
type Item = &'a E;
fn next(&mut self) -> Option<&'a E> {
if self.current.is_null() {
None
} else {
unsafe {
let element_ptr = self.current;
self.current = (*self.current).next;
Some(NtSingleListEntry::<E, L>::containing_record(element_ptr))
}
}
}
}
impl<'a, E, L> FusedIterator for Iter<'a, E, L>
where
E: NtListElement<L>,
L: NtTypedList<T = NtSingleList>,
{
}
/// Mutable iterator over the elements of a singly linked list.
///
/// This iterator is returned from the [`NtSingleListHead::iter_mut`] and
/// [`NtBoxingSingleListHead::iter_mut`] functions.
///
/// [`NtBoxingSingleListHead::iter_mut`]: crate::single_list::NtBoxingSingleListHead::iter_mut
pub struct IterMut<'a, E: NtListElement<L>, L: NtTypedList<T = NtSingleList>> {
current: *mut NtSingleListEntry<E, L>,
phantom: PhantomData<&'a mut NtSingleListHead<E, L>>,
}
impl<'a, E, L> Iterator for IterMut<'a, E, L>
where
E: NtListElement<L>,
L: NtTypedList<T = NtSingleList>,
{
type Item = &'a mut E;
fn next(&mut self) -> Option<&'a mut E> {
if self.current.is_null() {
None
} else {
unsafe {
let element_ptr = self.current;
self.current = (*self.current).next;
Some(NtSingleListEntry::containing_record_mut(element_ptr))
}
}
}
}
impl<'a, E, L> FusedIterator for IterMut<'a, E, L>
where
E: NtListElement<L>,
L: NtTypedList<T = NtSingleList>,
{
}
/// This structure substitutes the `SINGLE_LIST_ENTRY` structure of the Windows NT API for actual list entries.
#[derive(Debug)]
#[repr(C)]
pub struct NtSingleListEntry<E: NtListElement<L>, L: NtTypedList<T = NtSingleList>> {
pub(crate) next: *mut NtSingleListEntry<E, L>,
}
impl<E, L> NtSingleListEntry<E, L>
where
E: NtListElement<L>,
L: NtTypedList<T = NtSingleList>,
{
/// Allows the creation of an `NtSingleListEntry`, but leaves all fields uninitialized.
///
/// Its fields are only initialized when an entry is pushed to a list.
pub fn new() -> Self {
Self {
next: ptr::null_mut(),
}
}
pub(crate) unsafe fn containing_record<'a>(ptr: *const Self) -> &'a E {
// This is the canonical implementation of `byte_sub`
let element_ptr = unsafe { ptr.cast::<u8>().sub(E::offset()).cast::<Self>() };
unsafe { &*element_ptr.cast() }
}
pub(crate) unsafe fn containing_record_mut<'a>(ptr: *mut Self) -> &'a mut E {
// This is the canonical implementation of `byte_sub`
let element_ptr = unsafe { ptr.cast::<u8>().sub(E::offset()).cast::<Self>() };
unsafe { &mut *element_ptr.cast() }
}
}
impl<E, L> Default for NtSingleListEntry<E, L>
where
E: NtListElement<L>,
L: NtTypedList<T = NtSingleList>,
{
fn default() -> Self {
Self::new()
}
}