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
use soroban_env_common::{xdr::ScHostFnErrorCode, Compare};

use super::MeteredClone;
use crate::{
    budget::{AsBudget, Budget, CostType},
    xdr::ScHostObjErrorCode,
    Host, HostError,
};
use std::{cmp::Ordering, ops::Range};

#[derive(Clone)]
pub struct MeteredVector<A>
where
    A: MeteredClone,
{
    vec: Vec<A>,
}

impl<A> MeteredVector<A>
where
    A: MeteredClone,
{
    fn charge_new(size: usize, budget: &Budget) -> Result<(), HostError> {
        budget.charge(CostType::VecNew, size as u64)
    }

    fn charge_access(&self, count: usize, budget: &Budget) -> Result<(), HostError> {
        budget.charge(CostType::VecEntry, count as u64)
    }

    fn charge_scan(&self, budget: &Budget) -> Result<(), HostError> {
        budget.charge(CostType::VecEntry, self.len() as u64)
    }

    fn charge_binsearch(&self, budget: &Budget) -> Result<(), HostError> {
        let mag = 64 - (self.len() as u64).leading_zeros();
        budget.charge(CostType::VecEntry, 1 + mag as u64)
    }
}

impl<A> MeteredVector<A>
where
    A: MeteredClone,
{
    pub fn new(budget: &Budget) -> Result<Self, HostError> {
        Self::charge_new(0, budget)?;
        Self::from_vec(Vec::new())
    }

    pub fn from_array<const N: usize>(buf: [A; N], budget: &Budget) -> Result<Self, HostError> {
        Self::charge_new(N, budget)?;
        Self::from_vec(buf.into())
    }

    pub fn from_vec(vec: Vec<A>) -> Result<Self, HostError> {
        // No charge here: vector already allocated, charge happened in caller.
        Ok(Self { vec })
    }

    // This doesn't take ExactSizeIterator since that is not implemented for Chain
    // (see https://github.com/rust-lang/rust/issues/34433) but it only works
    // with iterators that report an exact size_hint, and it constructs a new
    // Vec from that iterator with a single allocation-and-copy.
    pub fn from_exact_iter<I: Iterator<Item = A>>(
        iter: I,
        budget: &Budget,
    ) -> Result<Self, HostError> {
        if let (_, Some(sz)) = iter.size_hint() {
            Self::charge_new(sz, budget)?;
            // It's possible we temporarily go over-budget here before charging, but
            // only by the cost of temporarily allocating twice the size of our largest
            // possible object. In exchange we get to batch all charges associated with
            // the clone into one (when A::IS_SHALLOW==true).
            let vec: Vec<A> = iter.collect();
            A::charge_for_clones(vec.as_slice(), budget)?;
            Ok(Self { vec })
        } else {
            // TODO use a better error code for "unbounded input iterators"
            Err(ScHostFnErrorCode::UnknownError.into())
        }
    }

    pub fn set(&self, index: usize, value: A, budget: &Budget) -> Result<Self, HostError> {
        let mut new = self.metered_clone(budget)?;
        new.charge_access(1, budget)?;
        let cell: Result<&mut A, HostError> = new
            .vec
            .get_mut(index)
            .ok_or_else(|| ScHostObjErrorCode::VecIndexOutOfBound.into());
        *(cell?) = value;
        Ok(new)
    }

    pub fn get(&self, index: usize, budget: &Budget) -> Result<&A, HostError> {
        self.charge_access(1, budget)?;
        self.vec
            .get(index)
            .ok_or_else(|| ScHostObjErrorCode::VecIndexOutOfBound.into())
    }

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

    pub fn push_front(&self, value: A, budget: &Budget) -> Result<Self, HostError> {
        let iter = [value].into_iter().chain(self.vec.iter().cloned());
        Self::from_exact_iter(iter, budget)
    }

    pub fn pop_front(&self, budget: &Budget) -> Result<Self, HostError> {
        if self.vec.len() == 0 {
            Err(ScHostObjErrorCode::VecIndexOutOfBound.into())
        } else {
            let iter = self.vec.iter().skip(1).cloned();
            Self::from_exact_iter(iter, budget)
        }
    }

    pub fn push_back(&self, value: A, budget: &Budget) -> Result<Self, HostError> {
        let iter = self.vec.iter().cloned().chain([value].into_iter());
        Self::from_exact_iter(iter, budget)
    }

    fn err_overflow() -> HostError {
        // TODO: need a better overflow code.
        ScHostFnErrorCode::UnknownError.into()
    }

    fn add_or_overflow(x: usize, y: usize) -> Result<usize, HostError> {
        x.checked_add(y).ok_or_else(|| Self::err_overflow())
    }

    fn sub_or_overflow(x: usize, y: usize) -> Result<usize, HostError> {
        x.checked_sub(y).ok_or_else(|| Self::err_overflow())
    }

    pub fn pop_back(&self, budget: &Budget) -> Result<Self, HostError> {
        if self.vec.len() == 0 {
            Err(ScHostObjErrorCode::VecIndexOutOfBound.into())
        } else {
            let count = Self::sub_or_overflow(self.vec.len(), 1)?;
            let iter = self.vec.iter().take(count).cloned();
            Self::from_exact_iter(iter, budget)
        }
    }

    pub fn remove(&self, idx: usize, budget: &Budget) -> Result<Self, HostError> {
        if idx >= self.vec.len() || idx == usize::MAX - 1 {
            Err(ScHostObjErrorCode::VecIndexOutOfBound.into())
        } else {
            // [0, 1, 2]
            // del 1 => take(1) + skip(2)
            let skip = Self::add_or_overflow(idx, 1)?;
            let init = self.vec.iter().take(idx).cloned();
            let fini = self.vec.iter().skip(skip).cloned();
            Self::from_exact_iter(init.chain(fini), budget)
        }
    }

    pub fn front(&self, budget: &Budget) -> Result<&A, HostError> {
        self.charge_access(1, budget)?;
        self.vec
            .first()
            .ok_or_else(|| ScHostObjErrorCode::VecIndexOutOfBound.into())
    }

    pub fn back(&self, budget: &Budget) -> Result<&A, HostError> {
        self.charge_access(1, budget)?;
        self.vec
            .last()
            .ok_or_else(|| ScHostObjErrorCode::VecIndexOutOfBound.into())
    }

    pub fn insert(&self, index: usize, value: A, budget: &Budget) -> Result<Self, HostError> {
        let len = self.vec.len();
        if index > len {
            Err(ScHostObjErrorCode::VecIndexOutOfBound.into())
        } else if index == len {
            self.push_back(value, budget)
        } else if index == 0 {
            self.push_front(value, budget)
        } else {
            let init = self.vec.iter().take(index).cloned();
            let fini = self.vec.iter().skip(index).cloned();
            let iter = init.chain([value].into_iter()).chain(fini);
            Self::from_exact_iter(iter, budget)
        }
    }

    pub fn append(&self, other: &Self, budget: &Budget) -> Result<Self, HostError> {
        let iter = self.vec.iter().cloned().chain(other.vec.iter().cloned());
        Self::from_exact_iter(iter, budget)
    }

    pub fn slice(&self, range: Range<usize>, budget: &Budget) -> Result<Self, HostError> {
        match self.vec.get(range) {
            Some(slice) => Self::from_exact_iter(slice.iter().cloned(), budget),
            None => Err(ScHostObjErrorCode::VecIndexOutOfBound.into()),
        }
    }

    pub fn first_index_of<F>(&self, f: F, budget: &Budget) -> Result<Option<usize>, HostError>
    where
        F: Fn(&A) -> Result<Ordering, HostError>,
    {
        self.charge_scan(budget)?;
        let mut i = 0;
        let mut iter = self.vec.iter();
        // this is similar logic to `iter.position(f)` but is fallible
        while let Some(val) = iter.next() {
            if f(val)? == Ordering::Equal {
                return Ok(Some(i));
            }
            i += 1;
        }
        Ok(None)
    }

    pub fn last_index_of<F>(&self, f: F, budget: &Budget) -> Result<Option<usize>, HostError>
    where
        F: Fn(&A) -> Result<Ordering, HostError>,
    {
        self.charge_scan(budget)?;
        let mut i = self.vec.len();
        let mut iter = self.vec.iter();
        // this is similar logic to `iter.rposition(f)` but is fallible
        while let Some(val) = iter.next_back() {
            i -= 1;
            if f(val)? == Ordering::Equal {
                return Ok(Some(i));
            }
        }
        Ok(None)
    }

    pub fn binary_search_by<F>(
        &self,
        mut cmp: F,
        budget: &Budget,
    ) -> Result<Result<usize, usize>, HostError>
    where
        F: FnMut(&A) -> Result<Ordering, HostError>,
    {
        self.charge_binsearch(budget)?;
        let mut err: Option<HostError> = None;
        let res = self.vec.binary_search_by(|probe| {
            // We've already hit an error, return Ordering::Equal
            // to terminate search asap.
            if err.is_some() {
                return Ordering::Equal;
            }
            match cmp(probe) {
                Ok(ord) => ord,
                Err(he) => {
                    err = Some(he);
                    Ordering::Equal
                }
            }
        });
        match err {
            Some(he) => Err(he),
            None => Ok(res),
        }
    }

    pub fn iter(&self) -> std::slice::Iter<'_, A> {
        self.vec.iter()
    }

    pub fn iter_mut(&mut self) -> std::slice::IterMut<'_, A> {
        self.vec.iter_mut()
    }
}

impl<A> MeteredClone for MeteredVector<A>
where
    A: MeteredClone,
{
    fn charge_for_clone(&self, budget: &Budget) -> Result<(), HostError> {
        Self::charge_new(self.len(), budget)
    }
}

impl<Elt: MeteredClone> Compare<MeteredVector<Elt>> for Budget
where
    Budget: Compare<Elt, Error = HostError>,
{
    type Error = HostError;

    fn compare(
        &self,
        a: &MeteredVector<Elt>,
        b: &MeteredVector<Elt>,
    ) -> Result<Ordering, Self::Error> {
        self.as_budget()
            .charge(CostType::VecEntry, a.vec.len().min(b.vec.len()) as u64)?;
        <Self as Compare<Vec<Elt>>>::compare(self, &a.vec, &b.vec)
    }
}

impl<Elt: MeteredClone> Compare<MeteredVector<Elt>> for Host
where
    Host: Compare<Elt, Error = HostError>,
{
    type Error = HostError;

    fn compare(
        &self,
        a: &MeteredVector<Elt>,
        b: &MeteredVector<Elt>,
    ) -> Result<Ordering, Self::Error> {
        self.as_budget()
            .charge(CostType::VecEntry, a.vec.len().min(b.vec.len()) as u64)?;
        <Self as Compare<Vec<Elt>>>::compare(self, &a.vec, &b.vec)
    }
}