corevm-host 0.1.28

Types that are common across CoreVM service, builder, monitor, tooling
Documentation
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
use alloc::vec::Vec;
use codec::{Decode, Encode, Input, MaxEncodedLen};

// TODO @ivan Proper B-Tree-based implementation would be useful for both CoreVM and PolkaVM.
#[derive(Clone, PartialEq, Eq, Encode, Default)]
pub struct RangeSet {
	ranges: Vec<Range>,
}

impl RangeSet {
	pub const fn new() -> Self {
		Self { ranges: Vec::new() }
	}

	pub fn with_capacity(capacity: usize) -> Self {
		Self { ranges: Vec::with_capacity(capacity) }
	}

	pub fn insert(&mut self, mut new_range: Range) {
		if new_range.is_empty() {
			return;
		}
		if self.ranges.is_empty() {
			self.ranges.push(new_range);
			return;
		}
		let (at, from) =
			match self.ranges.binary_search_by(|range| range.start.cmp(&new_range.start)) {
				Ok(i) => (i, i),
				Err(i) => (i, i.saturating_sub(1)),
			};
		let mut splice_range = at..at;
		for i in from..self.ranges.len() {
			let r = &mut self.ranges[i];
			let contains_start = (r.start..=r.end).contains(&new_range.start);
			let contains_end = (r.start..=r.end).contains(&new_range.end);
			if contains_start && contains_end {
				return;
			}
			if contains_start {
				new_range.start = r.start;
				splice_range = i..i + 1;
				continue;
			}
			if contains_end {
				new_range.end = r.end;
				splice_range.end = i + 1;
				break;
			}
		}
		self.ranges.splice(splice_range, [new_range]);
	}

	pub fn remove(&mut self, range: &Range) {
		if range.is_empty() {
			return;
		}
		let from = match self.ranges.binary_search_by(|r| r.start.cmp(&range.start)) {
			Ok(i) => i,
			Err(i) => i.saturating_sub(1),
		};
		#[allow(clippy::reversed_empty_ranges)]
		let mut drain_range = usize::MAX..0;
		for i in from..self.ranges.len() {
			let r = &mut self.ranges[i];
			let contains_start = (r.start..r.end).contains(&range.start);
			let contains_end = (r.start..=r.end).contains(&range.end);
			if contains_start && contains_end {
				let old_end = r.end;
				r.end = range.start;
				let new_range = Range::new(range.end, old_end);
				if r.is_empty() && new_range.is_empty() {
					drain_range = i..i + 1;
					break;
				}
				if r.is_empty() {
					self.ranges[i] = new_range;
					break;
				}
				if !new_range.is_empty() {
					self.ranges.insert(i + 1, new_range);
				}
				break;
			}
			if range.contains_range(r) {
				if i < drain_range.start {
					drain_range.start = i;
				}
				if i + 1 > drain_range.end {
					drain_range.end = i + 1;
				}
			} else if contains_start {
				r.end = range.start;
				drain_range.start = if r.is_empty() { i } else { i + 1 };
			}
			if contains_end {
				r.start = range.end;
				drain_range.end = if r.is_empty() { i + 1 } else { i };
				break;
			}
		}
		if !drain_range.is_empty() {
			self.ranges.drain(drain_range);
		}
	}

	pub fn overlap(&self, range: &Range) -> bool {
		if range.is_empty() {
			return false;
		}
		for r in &self.ranges {
			if r.start < range.end && range.start < r.end {
				return true;
			}
		}
		false
	}

	pub fn clear(&mut self) {
		self.ranges.clear();
	}

	pub fn enclosing_range(&self) -> Option<Range> {
		if self.ranges.is_empty() {
			return None;
		}
		let start = self.ranges[0].start;
		let end = self.ranges[self.ranges.len() - 1].end;
		Some(Range::new(start, end))
	}

	pub fn count(&self) -> u32 {
		self.ranges.iter().map(|range| range.end - range.start).sum()
	}

	pub fn contains_index(&self, index: u32) -> bool {
		let i = match self.ranges.binary_search_by(|range| range.start.cmp(&index)) {
			Ok(i) => i,
			Err(i) => i.saturating_sub(1),
		};
		self.ranges.get(i).map(|range| range.contains(index)).unwrap_or(false)
	}

	pub fn as_slice(&self) -> &[Range] {
		self.ranges.as_slice()
	}
}

impl AsRef<[Range]> for RangeSet {
	fn as_ref(&self) -> &[Range] {
		&self.ranges[..]
	}
}

impl core::fmt::Debug for RangeSet {
	fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
		f.debug_list().entries(self.ranges.iter()).finish()
	}
}

impl FromIterator<Range> for RangeSet {
	fn from_iter<I: IntoIterator<Item = Range>>(items: I) -> Self {
		let iter = items.into_iter();
		let (min_size, max_size) = iter.size_hint();
		let mut set = RangeSet::with_capacity(max_size.unwrap_or(min_size));
		set.extend(iter);
		set
	}
}

impl Extend<Range> for RangeSet {
	fn extend<I: IntoIterator<Item = Range>>(&mut self, iter: I) {
		for range in iter.into_iter() {
			self.insert(range);
		}
	}
}

impl Decode for RangeSet {
	fn decode<I: Input>(input: &mut I) -> Result<Self, codec::Error> {
		let ranges = Vec::<Range>::decode(input)?;
		if !validate_ranges(&ranges) {
			return Err("RangeSet: out-of-order/overlapping/empty ranges".into());
		}
		Ok(Self { ranges })
	}
}

fn validate_ranges(ranges: &[Range]) -> bool {
	if ranges.iter().any(|r| r.is_empty()) {
		return false;
	}
	for window in ranges.windows(2) {
		let a = &window[0];
		let b = &window[1];
		if b.start <= a.start || b.start <= a.end {
			return false;
		}
	}
	true
}

#[derive(Clone, PartialEq, Eq, Encode, Decode, MaxEncodedLen)]
pub struct Range {
	/// The start of the range (inclusive).
	#[codec(compact)]
	pub start: u32,
	/// The end of the range (exclusive).
	#[codec(compact)]
	pub end: u32,
}

impl Range {
	pub const fn new(start: u32, end: u32) -> Self {
		Self { start, end }
	}

	pub const fn is_empty(&self) -> bool {
		self.start >= self.end
	}

	/// Returns `true` if `self` is fully contains `other`.
	///
	/// If `other` range is empty, returns `false`.
	pub fn contains_range(&self, other: &Range) -> bool {
		!other.is_empty() &&
			(self.start..self.end).contains(&other.start) &&
			(self.start..=self.end).contains(&other.end)
	}

	pub const fn contains(&self, i: u32) -> bool {
		self.start <= i && i < self.end
	}
}

impl core::fmt::Display for Range {
	fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
		if self.start.saturating_add(1) == self.end {
			write!(f, "{}", self.start)
		} else {
			write!(f, "{}..{}", self.start, self.end)
		}
	}
}

impl core::fmt::Debug for Range {
	fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
		core::fmt::Display::fmt(self, f)
	}
}

#[cfg(test)]
mod tests {
	use super::*;
	use rand::{seq::SliceRandom, Rng};

	#[test]
	fn insert_works() {
		let mut ranges = RangeSet::new();
		assert_eq!(0, ranges.as_ref().len());
		ranges.insert(Range::new(0, 0));
		assert_eq!(0, ranges.as_ref().len());
		ranges.insert(Range::new(0, 1));
		assert_eq!(1, ranges.as_ref().len());
		ranges.insert(Range::new(0, 1));
		assert_eq!(1, ranges.as_ref().len());
		ranges.insert(Range::new(2, 3));
		assert_eq!([Range::new(0, 1), Range::new(2, 3)].as_slice(), ranges.as_ref());
		ranges.insert(Range::new(1, 2));
		assert_eq!([Range::new(0, 3)].as_slice(), ranges.as_ref());
		ranges.insert(Range::new(3, 10));
		assert_eq!([Range::new(0, 10)].as_slice(), ranges.as_ref());
	}

	#[test]
	fn remove_works() {
		let mut ranges = RangeSet::new();
		assert_eq!(0, ranges.as_ref().len());
		// Remove exact.
		ranges.insert(Range::new(0, 1));
		assert_eq!(1, ranges.as_ref().len());
		ranges.remove(&Range::new(0, 1));
		assert_eq!(0, ranges.as_ref().len());
		// Remove in the middle.
		ranges.insert(Range::new(0, 4));
		ranges.remove(&Range::new(1, 3));
		assert_eq!([Range::new(0, 1), Range::new(3, 4)].as_slice(), ranges.as_ref());
		// Remove at the start.
		ranges.clear();
		ranges.insert(Range::new(0, 4));
		ranges.remove(&Range::new(0, 1));
		assert_eq!([Range::new(1, 4)].as_slice(), ranges.as_ref());
		// Remove at the end.
		ranges.clear();
		ranges.insert(Range::new(0, 4));
		ranges.remove(&Range::new(3, 4));
		assert_eq!([Range::new(0, 3)].as_slice(), ranges.as_ref());
		// Remove enclosing range.
		ranges.clear();
		ranges.insert(Range::new(1, 4));
		ranges.remove(&Range::new(0, 5));
		assert_eq!(([] as [Range; 0]).as_slice(), ranges.as_ref());
		// Remove overlaping-at-the-start range.
		ranges.clear();
		ranges.insert(Range::new(1, 4));
		ranges.remove(&Range::new(0, 2));
		assert_eq!([Range::new(2, 4)].as_slice(), ranges.as_ref());
		// Remove overlaping-at-the-end range.
		ranges.clear();
		ranges.insert(Range::new(1, 4));
		ranges.remove(&Range::new(3, 5));
		assert_eq!([Range::new(1, 3)].as_slice(), ranges.as_ref());
	}

	#[test]
	fn insert_remove_random() {
		let mut rng = rand::rng();
		for _ in 0..1000 {
			let mut ranges = Vec::new();
			let mut offset = 0;
			for _ in 0..10 {
				let start = offset;
				let end = rng.random_range(start..=start + 20);
				offset = end;
				ranges.push(Range::new(start, end));
			}
			// Insert all ranges in random order.
			ranges.shuffle(&mut rng);
			let mut set = RangeSet::new();
			for range in ranges.iter() {
				set.insert(range.clone());
			}
			assert_eq!(1, set.as_ref().len());
			assert_eq!(&[Range::new(0, offset)], set.as_ref());
			// Remove all ranges in random order.
			ranges.shuffle(&mut rng);
			for range in ranges.iter() {
				set.remove(range);
			}
			assert_eq!(0, set.as_ref().len());
		}
	}

	#[test]
	fn remove_reverts_insert() {
		let mut rng = rand::rng();
		for _ in 0..1000 {
			let mut ranges = RangeSet::new();
			{
				let mut offset = 0;
				for _ in 0..10 {
					let start = rng.random_range(offset..=20);
					let end = rng.random_range(start..=20);
					offset = end;
					ranges.insert(Range::new(start, end));
				}
			}
			let range = {
				let start = rng.random_range(0..=20);
				Range::new(start, rng.random_range(start..=20))
			};
			if ranges.overlap(&range) {
				// `remove` reverts `insert` only if there is no overlap
				continue;
			}
			let expected = ranges.clone();
			ranges.insert(range.clone());
			let middle = ranges.clone();
			ranges.remove(&range);
			assert_eq!(expected, ranges,
                "ranges = {expected:?}, insert/remove {range:?}, after insert = {middle:?}, after remove = {ranges:?}");
			assert_eq!(expected.encoded_size(), ranges.encoded_size());
		}
	}

	#[test]
	fn insert_reverts_remove() {
		let mut rng = rand::rng();
		for _ in 0..1000 {
			let mut ranges = RangeSet::new();
			{
				let mut offset = 0;
				for _ in 0..10 {
					let start = rng.random_range(offset..=20);
					let end = rng.random_range(start..=20);
					offset = end;
					ranges.insert(Range::new(start, end));
				}
			}
			let range = {
				let start = rng.random_range(0..=20);
				Range::new(start, rng.random_range(start..=20))
			};
			if !ranges.as_ref().iter().any(|r| r.contains_range(&range)) {
				// `insert` reverts `remove` only if the new range is fully contained in one of the
				// existing ranges
				continue;
			}
			let expected = ranges.clone();
			ranges.remove(&range);
			let middle = ranges.clone();
			ranges.insert(range.clone());
			assert_eq!(expected, ranges,
                "ranges = {expected:?}, remove/insert {range:?}, after remove = {middle:?}, after insert = {ranges:?}");
		}
	}

	#[test]
	fn validate_works() {
		assert!(!validate_ranges(&[Range::new(0, 0)]));
		assert!(!validate_ranges(&[Range::new(0, 1), Range::new(0, 2)]));
		assert!(!validate_ranges(&[Range::new(0, 2), Range::new(1, 3)]));
		assert!(!validate_ranges(&[Range::new(0, 1), Range::new(1, 2)]));
		assert!(!validate_ranges(&[Range::new(2, 3), Range::new(0, 1)]));
		assert!(validate_ranges(&[Range::new(0, 1), Range::new(2, 3)]));
	}
}