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
use {
    crate::{
        proof::{NonEmpty, Unknown},
        Container, Index, IndexError,
    },
    core::{convert::TryFrom, fmt, hash::Hash, ops},
};

/// Unsigned integers able to be used as a trusted index.
pub unsafe trait Idx: Copy + Ord + Hash
where
    Self: fmt::Debug,
{
    //noinspection RsSelfConvention
    fn as_usize(self) -> usize;
    fn from_usize(i: usize) -> Option<Self>;
    fn zero() -> Self;
    fn add(self, increment: usize) -> Self;
    fn sub(self, decrement: usize) -> Self;
}

#[allow(non_snake_case)]
macro_rules! impl_Idx {
    ($($ty:ty),*$(,)?) => {
        $(unsafe impl Idx for $ty {
            fn as_usize(self) -> usize { self as usize } // we need u32 support, 64 KiB isn't enough
            fn from_usize(i: usize) -> Option<Self> { Self::try_from(i).ok() }
            fn zero() -> Self { 0 }
            fn add(self, increment: usize) -> Self {
                // FUTURE: See if this is always sound in the face of wrapping arithmetic
                Self::from_usize(increment).and_then(|i| self.checked_add(i)).expect("increment")
            }
            fn sub(self, decrement: usize) -> Self {
                self - Self::from_usize(decrement).expect("increment")
            }
        })*
    };
}

impl_Idx! {
    u8,
    u16,
    u32,
    usize,
}

/// Types that can back a trusted container: it can have
/// indices and ranges that are trusted to be in bounds.
///
/// It must have a continuously addressable range.
pub unsafe trait TrustedContainer {
    type Item: ?Sized + TrustedItem<Self>;
    type Slice: ?Sized;

    /// The length of the container in base item units.
    fn unit_len(&self) -> usize;

    unsafe fn get_unchecked(&self, i: usize) -> &Self::Item;
    unsafe fn slice_unchecked(&self, r: ops::Range<usize>) -> &Self::Slice;
}

/// An item within a trusted container.
pub unsafe trait TrustedItem<Array: TrustedContainer<Item = Self> + ?Sized> {
    type Unit;

    /// Vet an index for being on item boundaries.
    ///
    /// The index for the end of the container should pass.
    /// This function does not imply a nonempty proof.
    fn vet<'id, I: Idx>(
        idx: I,
        container: &Container<'id, Array>,
    ) -> Result<Index<'id, I, Unknown>, IndexError>;

    /// Increment an index to the next item, potentially leaving the container.
    fn after<'id, I: Idx>(
        this: Index<'id, I, NonEmpty>,
        container: &Container<'id, Array>,
    ) -> Index<'id, I, Unknown>;

    /// Advance an index to the next item, if a next item exists.
    fn advance<'id, I: Idx>(
        this: Index<'id, I, NonEmpty>,
        container: &Container<'id, Array>,
    ) -> Option<Index<'id, I, NonEmpty>>;
}

unsafe impl<T: TrustedContainer + ?Sized> TrustedContainer for &T {
    type Item = T::Item;
    type Slice = T::Slice;

    fn unit_len(&self) -> usize {
        T::unit_len(self)
    }

    unsafe fn get_unchecked(&self, i: usize) -> &Self::Item {
        T::get_unchecked(self, i)
    }

    unsafe fn slice_unchecked(&self, r: ops::Range<usize>) -> &Self::Slice {
        T::slice_unchecked(self, r)
    }
}

unsafe impl<T> TrustedContainer for [T] {
    type Item = T;
    type Slice = [T];

    fn unit_len(&self) -> usize {
        self.len()
    }

    unsafe fn get_unchecked(&self, i: usize) -> &Self::Item {
        debug_assert!(i < self.len());
        self.get_unchecked(i)
    }

    unsafe fn slice_unchecked(&self, r: ops::Range<usize>) -> &Self::Slice {
        debug_assert!(r.start <= self.len());
        debug_assert!(r.end <= self.len());
        debug_assert!(r.start <= r.end);
        self.get_unchecked(r)
    }
}

unsafe impl<T: TrustedItem<Array> + ?Sized, Array: TrustedContainer<Item = T> + ?Sized>
    TrustedItem<&Array> for T
{
    type Unit = T::Unit;

    fn vet<'id, I: Idx>(
        idx: I,
        container: &Container<'id, &Array>,
    ) -> Result<Index<'id, I, Unknown>, IndexError> {
        T::vet(idx, container.project())
    }

    fn after<'id, I: Idx>(
        this: Index<'id, I, NonEmpty>,
        container: &Container<'id, &Array>,
    ) -> Index<'id, I, Unknown> {
        T::after(this, container.project())
    }

    fn advance<'id, I: Idx>(
        this: Index<'id, I, NonEmpty>,
        container: &Container<'id, &Array>,
    ) -> Option<Index<'id, I, NonEmpty>> {
        T::advance(this, container.project())
    }
}

unsafe impl<T> TrustedItem<[T]> for T {
    type Unit = T;

    fn vet<'id, I: Idx>(
        idx: I,
        container: &Container<'id, [T]>,
    ) -> Result<Index<'id, I, Unknown>, IndexError> {
        if idx.as_usize() <= container.unit_len() {
            Ok(unsafe { Index::new(idx) })
        } else {
            Err(IndexError::OutOfBounds)
        }
    }

    fn after<'id, I: Idx>(
        this: Index<'id, I, NonEmpty>,
        _: &Container<'id, [T]>,
    ) -> Index<'id, I, Unknown> {
        unsafe { Index::new(this.untrusted().add(1)) }
    }

    fn advance<'id, I: Idx>(
        this: Index<'id, I, NonEmpty>,
        container: &Container<'id, [T]>,
    ) -> Option<Index<'id, I, NonEmpty>> {
        container.vet(Self::after(this, container).untrusted()).ok()
    }
}

#[cfg(feature = "std")]
mod std_impls {
    use super::*;
    use std::{boxed::Box, vec::Vec};

    #[cfg_attr(feature = "doc", doc(cfg(feature = "std")))]
    unsafe impl<T: TrustedContainer + ?Sized> TrustedContainer for Box<T> {
        type Item = T::Item;
        type Slice = T::Slice;

        fn unit_len(&self) -> usize {
            T::unit_len(&self)
        }

        unsafe fn get_unchecked(&self, i: usize) -> &Self::Item {
            T::get_unchecked(self, i)
        }

        unsafe fn slice_unchecked(&self, r: ops::Range<usize>) -> &Self::Slice {
            T::slice_unchecked(self, r)
        }
    }

    #[cfg_attr(feature = "doc", doc(cfg(feature = "std")))]
    unsafe impl<T: TrustedItem<Array> + ?Sized, Array: TrustedContainer<Item = T> + ?Sized>
        TrustedItem<Box<Array>> for T
    {
        type Unit = T::Unit;

        fn vet<'id, I: Idx>(
            idx: I,
            container: &Container<'id, Box<Array>>,
        ) -> Result<Index<'id, I, Unknown>, IndexError> {
            T::vet(idx, container.project())
        }

        fn after<'id, I: Idx>(
            this: Index<'id, I, NonEmpty>,
            container: &Container<'id, Box<Array>>,
        ) -> Index<'id, I, Unknown> {
            T::after(this, container.project())
        }

        fn advance<'id, I: Idx>(
            this: Index<'id, I, NonEmpty>,
            container: &Container<'id, Box<Array>>,
        ) -> Option<Index<'id, I, NonEmpty>> {
            T::advance(this, container.project())
        }
    }

    #[cfg_attr(feature = "doc", doc(cfg(feature = "std")))]
    impl<'id, Array: TrustedContainer + ?Sized> Container<'id, Box<Array>> {
        pub fn project(&self) -> &Container<'id, Array> {
            unsafe { &*(&**self.untrusted() as *const Array as *const Container<'id, Array>) }
        }
    }

    #[cfg_attr(feature = "doc", doc(cfg(feature = "std")))]
    unsafe impl<T> TrustedContainer for Vec<T> {
        type Item = T;
        type Slice = [T];

        fn unit_len(&self) -> usize {
            self.len()
        }

        unsafe fn get_unchecked(&self, i: usize) -> &Self::Item {
            <[T]>::get_unchecked(self, i)
        }

        unsafe fn slice_unchecked(&self, r: ops::Range<usize>) -> &Self::Slice {
            <[T]>::slice_unchecked(self, r)
        }
    }

    #[cfg_attr(feature = "doc", doc(cfg(feature = "std")))]
    unsafe impl<T: TrustedItem<[T]>> TrustedItem<Vec<T>> for T {
        type Unit = T::Unit;

        fn vet<'id, I: Idx>(
            idx: I,
            container: &Container<'id, Vec<T>>,
        ) -> Result<Index<'id, I, Unknown>, IndexError> {
            T::vet(idx, container.project())
        }

        fn after<'id, I: Idx>(
            this: Index<'id, I, NonEmpty>,
            container: &Container<'id, Vec<T>>,
        ) -> Index<'id, I, Unknown> {
            T::after(this, container.project())
        }

        fn advance<'id, I: Idx>(
            this: Index<'id, I, NonEmpty>,
            container: &Container<'id, Vec<T>>,
        ) -> Option<Index<'id, I, NonEmpty>> {
            T::advance(this, container.project())
        }
    }

    #[cfg_attr(feature = "doc", doc(cfg(feature = "std")))]
    impl<'id, T> Container<'id, Vec<T>> {
        pub fn project(&self) -> &Container<'id, [T]> {
            unsafe { &*(&**self.untrusted() as *const [T] as *const Container<'id, [T]>) }
        }
    }
}