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 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
// Copyright (c) 2013-2015 Sandstorm Development Group, Inc. and contributors
// Licensed under the MIT License:
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//! Untyped root container for a Cap'n Proto value.
//!
//! ## Notes about type specialization
//! This module provides [TypedReader] and [TypedBuilder] structs which are strongly-typed variants
//! of [Reader] and [Builder].
//!
//! Code autogenerated by capnpc will have an individual module for each of structures and each of
//! modules will have `Owned` struct which implements [Owned] trait.
//!
//! Example from a real auto-generated file:
//!
//! ```ignore
//! pub mod simple_struct {
//! #[derive(Copy, Clone)]
//! pub struct Owned(());
//! impl <'a> ::capnp::traits::Owned<'a> for Owned { type Reader = Reader<'a>; type Builder = Builder<'a>; }
//! ....
//! }
//! ```
//!
//! [TypedReader] and [TypedBuilder] accept generic type parameter `T`. This parameter must be
//! a corresponding `Owned` type which was auto-generated inside the corresponding module.
//!
//! For example, for auto-generated module `crate::test_data::simple_struct` you'd supply
//! `crate::test_data::simple_struct::Owned` type into [TypedReader]/[TypedBuilder]
//!
//! ```ignore
//! include!(concat!(env!("OUT_DIR"), "/simple_struct_capnp.rs"));
//!
//! use capnp::message::{self, TypedBuilder, TypedReader};
//!
//! fn main() {
//! let mut builder = TypedBuilder::<simple_struct::Owned>::new_default();
//! let mut builder_root = builder.init_root();
//! builder_root.set_x(10);
//! builder_root.set_y(20);
//!
//! let mut buffer = vec![];
//! capnp::serialize_packed::write_message(&mut buffer, builder.borrow_inner()).unwrap();
//!
//! let reader = capnp::serialize_packed::read_message(buffer.as_slice(), ReaderOptions::new()).unwrap();
//! let typed_reader = TypedReader::<_, simple_struct::Owned>::new(reader);
//!
//! let reader_root = typed_reader.get().unwrap();
//! assert_eq!(reader_root.get_x(), 10);
//! assert_eq!(reader_root.get_x(), 20);
//! }
//!
//! ```
use crate::any_pointer;
use crate::private::arena::{BuilderArena, BuilderArenaImpl};
use crate::private::arena::{ReaderArena, ReaderArenaImpl};
use crate::private::layout;
use crate::private::units::BYTES_PER_WORD;
use crate::traits::{FromPointerBuilder, SetterInput};
use crate::traits::{FromPointerReader, Owned};
use crate::OutputSegments;
use crate::Result;
/// Options controlling how data is read.
#[derive(Clone, Copy, Debug)]
pub struct ReaderOptions {
/// Limits how many total (8-byte) words of data are allowed to be traversed. Traversal is counted
/// when a new struct or list builder is obtained, e.g. from a get() accessor. This means that
/// calling the getter for the same sub-struct multiple times will cause it to be double-counted.
/// Once the traversal limit is reached, an error will be reported.
///
/// This limit exists for security reasons. It is possible for an attacker to construct a message
/// in which multiple pointers point at the same location. This is technically invalid, but hard
/// to detect. Using such a message, an attacker could cause a message which is small on the wire
/// to appear much larger when actually traversed, possibly exhausting server resources leading to
/// denial-of-service.
///
/// It makes sense to set a traversal limit that is much larger than the underlying message.
/// Together with sensible coding practices (e.g. trying to avoid calling sub-object getters
/// multiple times, which is expensive anyway), this should provide adequate protection without
/// inconvenience.
///
/// A traversal limit of `None` means that no limit is enforced.
pub traversal_limit_in_words: Option<usize>,
/// Limits how deeply nested a message structure can be, e.g. structs containing other structs or
/// lists of structs.
///
/// Like the traversal limit, this limit exists for security reasons. Since it is common to use
/// recursive code to traverse recursive data structures, an attacker could easily cause a stack
/// overflow by sending a very-depply-nested (or even cyclic) message, without the message even
/// being very large. The default limit of 64 is probably low enough to prevent any chance of
/// stack overflow, yet high enough that it is never a problem in practice.
pub nesting_limit: i32,
}
pub const DEFAULT_READER_OPTIONS: ReaderOptions = ReaderOptions {
traversal_limit_in_words: Some(8 * 1024 * 1024),
nesting_limit: 64,
};
impl Default for ReaderOptions {
fn default() -> Self {
DEFAULT_READER_OPTIONS
}
}
impl ReaderOptions {
pub fn new() -> Self {
DEFAULT_READER_OPTIONS
}
pub fn nesting_limit(&mut self, value: i32) -> &mut Self {
self.nesting_limit = value;
self
}
pub fn traversal_limit_in_words(&mut self, value: Option<usize>) -> &mut Self {
self.traversal_limit_in_words = value;
self
}
}
/// An object that manages the buffers underlying a Cap'n Proto message reader.
pub trait ReaderSegments {
/// Gets the segment with index `idx`. Returns `None` if `idx` is out of range.
///
/// The segment must be 8-byte aligned or the "unaligned" feature must
/// be enabled in the capnp crate. (Otherwise reading the segment will return an error.)
///
/// The returned slice is required to point to memory that remains valid until the ReaderSegments
/// object is dropped. In safe Rust, it should not be possible to violate this requirement.
fn get_segment(&self, idx: u32) -> Option<&[u8]>;
/// Gets the number of segments.
fn len(&self) -> usize {
for i in 0.. {
if self.get_segment(i as u32).is_none() {
return i;
}
}
unreachable!()
}
fn is_empty(&self) -> bool {
self.len() == 0
}
}
impl<S> ReaderSegments for &S
where
S: ReaderSegments,
{
fn get_segment(&self, idx: u32) -> Option<&[u8]> {
(**self).get_segment(idx)
}
fn len(&self) -> usize {
(**self).len()
}
}
/// An array of segments.
pub struct SegmentArray<'a> {
segments: &'a [&'a [u8]],
}
impl<'a> SegmentArray<'a> {
pub fn new(segments: &'a [&'a [u8]]) -> SegmentArray<'a> {
SegmentArray { segments }
}
}
impl<'b> ReaderSegments for SegmentArray<'b> {
fn get_segment(&self, id: u32) -> Option<&[u8]> {
self.segments.get(id as usize).copied()
}
fn len(&self) -> usize {
self.segments.len()
}
}
impl<'b> ReaderSegments for [&'b [u8]] {
fn get_segment(&self, id: u32) -> Option<&[u8]> {
self.get(id as usize).copied()
}
fn len(&self) -> usize {
self.len()
}
}
/// A container used to read a message.
pub struct Reader<S>
where
S: ReaderSegments,
{
arena: ReaderArenaImpl<S>,
}
impl<S> Reader<S>
where
S: ReaderSegments,
{
pub fn new(segments: S, options: ReaderOptions) -> Self {
Self {
arena: ReaderArenaImpl::new(segments, options),
}
}
fn get_root_internal(&self) -> Result<any_pointer::Reader<'_>> {
let (segment_start, _seg_len) = self.arena.get_segment(0)?;
let pointer_reader = layout::PointerReader::get_root(
&self.arena,
0,
segment_start,
self.arena.nesting_limit(),
)?;
Ok(any_pointer::Reader::new(pointer_reader))
}
/// Gets the root of the message, interpreting it as the given type.
pub fn get_root<'a, T: FromPointerReader<'a>>(&'a self) -> Result<T> {
self.get_root_internal()?.get_as()
}
pub fn into_segments(self) -> S {
self.arena.into_segments()
}
/// Checks whether the message is [canonical](https://capnproto.org/encoding.html#canonicalization).
pub fn is_canonical(&self) -> Result<bool> {
let (segment_start, seg_len) = self.arena.get_segment(0)?;
if self.arena.get_segment(1).is_ok() {
// TODO(cleanup, apibump): should there be a nicer way to ask the arena how many
// segments there are?
// There is more than one segment, so the message cannot be canonical.
return Ok(false);
}
let pointer_reader = layout::PointerReader::get_root(
&self.arena,
0,
segment_start,
self.arena.nesting_limit(),
)?;
let read_head = ::core::cell::Cell::new(unsafe { segment_start.add(BYTES_PER_WORD) });
let root_is_canonical = pointer_reader.is_canonical(&read_head)?;
let all_words_consumed = (read_head.get() as usize - segment_start as usize)
/ BYTES_PER_WORD
== seg_len as usize;
Ok(root_is_canonical && all_words_consumed)
}
/// Gets the [canonical](https://capnproto.org/encoding.html#canonicalization) form
/// of this message. Works by copying the message twice. For a canonicalization
/// method that only requires one copy, see `message::Builder::set_root_canonical()`.
#[cfg(feature = "alloc")]
pub fn canonicalize(&self) -> Result<alloc::vec::Vec<crate::Word>> {
let root = self.get_root_internal()?;
let size = root.target_size()?.word_count + 1;
let mut message = Builder::new(HeapAllocator::new().first_segment_words(size as u32));
message.set_root_canonical(root)?;
let output_segments = message.get_segments_for_output();
assert_eq!(1, output_segments.len());
let output = output_segments[0];
assert!((output.len() / BYTES_PER_WORD) as u64 <= size);
let mut result = crate::Word::allocate_zeroed_vec(output.len() / BYTES_PER_WORD);
crate::Word::words_to_bytes_mut(&mut result[..]).copy_from_slice(output);
Ok(result)
}
pub fn into_typed<T: Owned>(self) -> TypedReader<S, T> {
TypedReader::new(self)
}
}
/// A message reader whose value is known to be of type `T`.
/// Please see [module documentation](self) for more info about reader type specialization.
pub struct TypedReader<S, T>
where
S: ReaderSegments,
T: Owned,
{
marker: ::core::marker::PhantomData<T>,
message: Reader<S>,
}
impl<S, T> TypedReader<S, T>
where
S: ReaderSegments,
T: Owned,
{
pub fn new(message: Reader<S>) -> Self {
Self {
marker: ::core::marker::PhantomData,
message,
}
}
pub fn get(&self) -> Result<T::Reader<'_>> {
self.message.get_root()
}
pub fn into_inner(self) -> Reader<S> {
self.message
}
}
impl<S, T> From<Reader<S>> for TypedReader<S, T>
where
S: ReaderSegments,
T: Owned,
{
fn from(message: Reader<S>) -> Self {
Self::new(message)
}
}
impl<A, T> From<Builder<A>> for TypedReader<Builder<A>, T>
where
A: Allocator,
T: Owned,
{
fn from(message: Builder<A>) -> Self {
let reader = message.into_reader();
reader.into_typed()
}
}
impl<A, T> From<TypedBuilder<T, A>> for TypedReader<Builder<A>, T>
where
A: Allocator,
T: Owned,
{
fn from(builder: TypedBuilder<T, A>) -> Self {
builder.into_reader()
}
}
/// An object that allocates memory for a Cap'n Proto message as it is being built.
/// Users of capnproto-rust who wish to provide memory in non-standard ways should
/// implement this trait. Objects implementing this trait are intended to be wrapped
/// by `capnp::private::BuilderArena`, which handles calling the methods at the appropriate
/// times, including calling `deallocate_segment()` on drop.
///
/// # Safety
/// Implementions must ensure all of the following:
/// 1. The memory returned by `allocate_segment` is initialized to all zeroes.
/// 2. The memory returned by `allocate_segment` is valid until `deallocate_segment()`
/// is called on it.
/// 3. The allocated memory does not overlap with other allocated memory.
/// 4. The allocated memory is 8-byte aligned (or the "unaligned" feature is enabled
/// for the capnp crate).
pub unsafe trait Allocator {
/// Allocates zeroed memory for a new segment, returning a pointer to the start of the segment
/// and a u32 indicating the length of the segment in words. The allocated segment must be
/// at least `minimum_size` words long (`minimum_size * 8` bytes long). Allocator implementations
/// commonly allocate much more than the minimum, to reduce the total number of segments needed.
/// A reasonable strategy is to allocate the maximum of `minimum_size` and twice the size of the
/// previous segment.
fn allocate_segment(&mut self, minimum_size: u32) -> (*mut u8, u32);
/// Indicates that a segment, previously allocated via allocate_segment(), is no longer in use.
/// `word_size` is the length of the segment in words, as returned from `allocate_segment()`.
/// `words_used` is always less than or equal to `word_size`, and indicates how many
/// words (contiguous from the start of the segment) were possibly written with non-zero values.
///
/// # Safety
/// Callers must only call this method on a pointer that has previously been been returned
/// from `allocate_segment()`, and only once on each such segment. `word_size` must
/// equal the word size returned from `allocate_segment()`, and `words_used` must be at
/// most `word_size`.
unsafe fn deallocate_segment(&mut self, ptr: *mut u8, word_size: u32, words_used: u32);
}
/// A container used to build a message.
pub struct Builder<A>
where
A: Allocator,
{
arena: BuilderArenaImpl<A>,
}
unsafe impl<A> Send for Builder<A> where A: Send + Allocator {}
fn _assert_kinds() {
fn _assert_send<T: Send>() {}
fn _assert_reader<S: ReaderSegments + Send>() {
_assert_send::<Reader<S>>();
}
fn _assert_builder<A: Allocator + Send>() {
_assert_send::<Builder<A>>();
}
}
impl<A> Builder<A>
where
A: Allocator,
{
pub fn new(allocator: A) -> Self {
Self {
arena: BuilderArenaImpl::new(allocator),
}
}
fn get_root_internal(&mut self) -> any_pointer::Builder<'_> {
if self.arena.is_empty() {
self.arena
.allocate_segment(1)
.expect("allocate root pointer");
self.arena.allocate(0, 1).expect("allocate root pointer");
}
let (seg_start, _seg_len) = self.arena.get_segment_mut(0);
let location: *mut u8 = seg_start;
let Self { arena } = self;
any_pointer::Builder::new(layout::PointerBuilder::get_root(arena, 0, location))
}
/// Initializes the root as a value of the given type.
pub fn init_root<'a, T: FromPointerBuilder<'a>>(&'a mut self) -> T {
let root = self.get_root_internal();
root.init_as()
}
/// Initializes the root as a value of the given list type, with the given length.
pub fn initn_root<'a, T: FromPointerBuilder<'a>>(&'a mut self, length: u32) -> T {
let root = self.get_root_internal();
root.initn_as(length)
}
/// Gets the root, interpreting it as the given type.
pub fn get_root<'a, T: FromPointerBuilder<'a>>(&'a mut self) -> Result<T> {
let root = self.get_root_internal();
root.get_as()
}
pub fn get_root_as_reader<'a, T: FromPointerReader<'a>>(&'a self) -> Result<T> {
if self.arena.is_empty() {
any_pointer::Reader::new(layout::PointerReader::new_default()).get_as()
} else {
let (segment_start, _segment_len) = self.arena.get_segment(0)?;
let pointer_reader = layout::PointerReader::get_root(
self.arena.as_reader(),
0,
segment_start,
0x7fffffff,
)?;
let root = any_pointer::Reader::new(pointer_reader);
root.get_as()
}
}
/// Sets the root to a deep copy of the given value.
pub fn set_root<T: Owned>(&mut self, value: impl SetterInput<T>) -> Result<()> {
let mut root = self.get_root_internal();
root.set_as(value)
}
/// Sets the root to a canonicalized version of `value`. If this was the first action taken
/// on this `Builder`, then a subsequent call to `get_segments_for_output()` should return
/// a single segment, containing the full canonicalized message.
pub fn set_root_canonical<T: Owned>(&mut self, value: impl SetterInput<T>) -> Result<()> {
if self.arena.is_empty() {
self.arena
.allocate_segment(1)
.expect("allocate root pointer");
self.arena.allocate(0, 1).expect("allocate root pointer");
}
let (seg_start, _seg_len) = self.arena.get_segment_mut(0);
let pointer = layout::PointerBuilder::get_root(&mut self.arena, 0, seg_start);
SetterInput::set_pointer_builder(pointer, value, true)?;
assert_eq!(self.get_segments_for_output().len(), 1);
Ok(())
}
pub fn get_segments_for_output(&self) -> OutputSegments {
self.arena.get_segments_for_output()
}
pub fn into_reader(self) -> Reader<Self> {
Reader::new(
self,
ReaderOptions {
traversal_limit_in_words: None,
nesting_limit: i32::max_value(),
},
)
}
pub fn into_typed<T: Owned>(self) -> TypedBuilder<T, A> {
TypedBuilder::new(self)
}
/// Retrieves the underlying `Allocator`, deallocating all currently-allocated
/// segments.
pub fn into_allocator(self) -> A {
self.arena.into_allocator()
}
}
impl<A> ReaderSegments for Builder<A>
where
A: Allocator,
{
fn get_segment(&self, id: u32) -> Option<&[u8]> {
self.get_segments_for_output().get(id as usize).copied()
}
fn len(&self) -> usize {
self.get_segments_for_output().len()
}
}
/// Stongly typed variant of the [Builder]
///
/// Generic type parameters:
/// - `T` - type of the capnp message which this builder is specialized on. Please see
/// [module documentation](self) for more info about builder type specialization.
/// - `A` - type of allocator
#[cfg(feature = "alloc")]
pub struct TypedBuilder<T, A = HeapAllocator>
where
T: Owned,
A: Allocator,
{
marker: ::core::marker::PhantomData<T>,
message: Builder<A>,
}
// Defined separately because the A=HeapAllocator default type
// argument is not allowed in no-alloc mode.
// TODO(apibump): remove the A=HeapAllocator thing above?
#[cfg(not(feature = "alloc"))]
pub struct TypedBuilder<T, A>
where
T: Owned,
A: Allocator,
{
marker: ::core::marker::PhantomData<T>,
message: Builder<A>,
}
#[cfg(feature = "alloc")]
impl<T> TypedBuilder<T, HeapAllocator>
where
T: Owned,
{
pub fn new_default() -> Self {
Default::default()
}
}
#[cfg(feature = "alloc")]
impl<T> Default for TypedBuilder<T, HeapAllocator>
where
T: Owned,
{
fn default() -> Self {
Self::new(Builder::default())
}
}
impl<T, A> TypedBuilder<T, A>
where
T: Owned,
A: Allocator,
{
pub fn new(message: Builder<A>) -> Self {
Self {
marker: ::core::marker::PhantomData,
message,
}
}
pub fn init_root(&mut self) -> T::Builder<'_> {
self.message.init_root()
}
pub fn initn_root(&mut self, length: u32) -> T::Builder<'_> {
self.message.initn_root(length)
}
pub fn get_root(&mut self) -> Result<T::Builder<'_>> {
self.message.get_root()
}
pub fn get_root_as_reader(&self) -> Result<T::Reader<'_>> {
self.message.get_root_as_reader()
}
pub fn set_root(&mut self, value: T::Reader<'_>) -> Result<()> {
self.message.set_root(value)
}
pub fn into_inner(self) -> Builder<A> {
self.message
}
pub fn borrow_inner(&self) -> &Builder<A> {
&self.message
}
pub fn borrow_inner_mut(&mut self) -> &mut Builder<A> {
&mut self.message
}
pub fn into_reader(self) -> TypedReader<Builder<A>, T> {
TypedReader::new(self.message.into_reader())
}
}
impl<T, A> From<Builder<A>> for TypedBuilder<T, A>
where
T: Owned,
A: Allocator,
{
fn from(builder: Builder<A>) -> Self {
Self::new(builder)
}
}
/// Standard segment allocator. Allocates each segment via `alloc::alloc::alloc_zeroed()`.
#[derive(Debug)]
#[cfg(feature = "alloc")]
pub struct HeapAllocator {
// Minimum number of words in the next allocation.
next_size: u32,
// How to update next_size after an allocation.
allocation_strategy: AllocationStrategy,
// Maximum number of words to allocate.
max_segment_words: u32,
}
#[derive(Clone, Copy, Debug)]
pub enum AllocationStrategy {
/// Allocates the same number of words for each segment, to the extent possible.
/// This strategy is primarily useful for testing cross-segment pointers.
FixedSize,
/// Increases segment size by a multiplicative factor for each subsequent segment.
GrowHeuristically,
}
pub const SUGGESTED_FIRST_SEGMENT_WORDS: u32 = 1024;
pub const SUGGESTED_ALLOCATION_STRATEGY: AllocationStrategy = AllocationStrategy::GrowHeuristically;
#[cfg(feature = "alloc")]
impl Default for HeapAllocator {
fn default() -> Self {
Self {
next_size: SUGGESTED_FIRST_SEGMENT_WORDS,
allocation_strategy: SUGGESTED_ALLOCATION_STRATEGY,
max_segment_words: 1 << 29,
}
}
}
#[cfg(feature = "alloc")]
impl HeapAllocator {
pub fn new() -> Self {
Self::default()
}
/// Sets the size of the initial segment in words, where 1 word = 8 bytes.
pub fn first_segment_words(mut self, value: u32) -> Self {
assert!(value <= self.max_segment_words);
self.next_size = value;
self
}
/// Sets the allocation strategy for segments after the first one.
pub fn allocation_strategy(mut self, value: AllocationStrategy) -> Self {
self.allocation_strategy = value;
self
}
/// Sets the maximum number of words allowed in a single allocation.
pub fn max_segment_words(mut self, value: u32) -> Self {
assert!(self.next_size <= value);
self.max_segment_words = value;
self
}
}
#[cfg(feature = "alloc")]
unsafe impl Allocator for HeapAllocator {
fn allocate_segment(&mut self, minimum_size: u32) -> (*mut u8, u32) {
let size = core::cmp::max(minimum_size, self.next_size);
let layout =
alloc::alloc::Layout::from_size_align(size as usize * BYTES_PER_WORD, 8).unwrap();
let ptr = unsafe { alloc::alloc::alloc_zeroed(layout) };
if ptr.is_null() {
alloc::alloc::handle_alloc_error(layout);
}
match self.allocation_strategy {
AllocationStrategy::GrowHeuristically => {
if size < self.max_segment_words - self.next_size {
self.next_size += size;
} else {
self.next_size = self.max_segment_words;
}
}
AllocationStrategy::FixedSize => {}
}
(ptr, size)
}
unsafe fn deallocate_segment(&mut self, ptr: *mut u8, word_size: u32, _words_used: u32) {
unsafe {
alloc::alloc::dealloc(
ptr,
alloc::alloc::Layout::from_size_align(word_size as usize * BYTES_PER_WORD, 8)
.unwrap(),
);
}
self.next_size = SUGGESTED_FIRST_SEGMENT_WORDS;
}
}
#[cfg(feature = "alloc")]
#[test]
fn test_allocate_max() {
let allocation_size = 1 << 24;
let mut allocator = HeapAllocator::new()
.max_segment_words((1 << 25) - 1)
.first_segment_words(allocation_size);
let (a1, s1) = allocator.allocate_segment(allocation_size);
let (a2, s2) = allocator.allocate_segment(allocation_size);
let (a3, s3) = allocator.allocate_segment(allocation_size);
assert_eq!(s1, allocation_size);
// Allocation size tops out at max_segment_words.
assert_eq!(s2, allocator.max_segment_words);
assert_eq!(s3, allocator.max_segment_words);
unsafe {
allocator.deallocate_segment(a1, s1, 0);
allocator.deallocate_segment(a2, s2, 0);
allocator.deallocate_segment(a3, s3, 0);
}
}
#[cfg(feature = "alloc")]
impl Builder<HeapAllocator> {
/// Constructs a new `message::Builder<HeapAllocator>` whose first segment has length
/// `SUGGESTED_FIRST_SEGMENT_WORDS`.
pub fn new_default() -> Self {
Default::default()
}
}
#[cfg(feature = "alloc")]
impl Default for Builder<HeapAllocator> {
/// Constructs a new `message::Builder<HeapAllocator>` whose first segment has length
/// `SUGGESTED_FIRST_SEGMENT_WORDS`.
fn default() -> Self {
Self::new(HeapAllocator::new())
}
}
/// An Allocator whose first segment is a backed by a user-provided buffer.
///
/// Recall that an `Allocator` implementation must ensure that allocated segments are
/// initially *zeroed*. `ScratchSpaceHeapAllocator` ensures that is the case by zeroing
/// the entire buffer upon initial construction, and then zeroing any *potentially used*
/// part of the buffer upon `deallocate_segment()`.
///
/// You can reuse a `ScratchSpaceHeapAllocator` by calling `message::Builder::into_allocator()`,
/// or by initially passing it to `message::Builder::new()` as a `&mut ScratchSpaceHeapAllocator`.
/// Such reuse can save significant amounts of zeroing.
#[cfg(feature = "alloc")]
pub struct ScratchSpaceHeapAllocator<'a> {
scratch_space: &'a mut [u8],
scratch_space_allocated: bool,
allocator: HeapAllocator,
}
#[cfg(feature = "alloc")]
impl<'a> ScratchSpaceHeapAllocator<'a> {
/// Writes zeroes into the entire buffer and constructs a new allocator from it.
///
/// If the buffer is large, this operation could be relatively expensive. If you want to reuse
/// the same scratch space in a later message, you should reuse the entire
/// `ScratchSpaceHeapAllocator`, to avoid paying this full cost again.
pub fn new(scratch_space: &'a mut [u8]) -> ScratchSpaceHeapAllocator<'a> {
#[cfg(not(feature = "unaligned"))]
{
if scratch_space.as_ptr() as usize % BYTES_PER_WORD != 0 {
panic!(
"Scratch space must be 8-byte aligned, or you must enable the \"unaligned\" \
feature in the capnp crate"
);
}
}
// We need to ensure that the buffer is zeroed.
for b in &mut scratch_space[..] {
*b = 0;
}
ScratchSpaceHeapAllocator {
scratch_space,
scratch_space_allocated: false,
allocator: HeapAllocator::new(),
}
}
/// Sets the size of the second segment in words, where 1 word = 8 bytes.
/// (The first segment is the scratch space passed to `ScratchSpaceHeapAllocator::new()`.
pub fn second_segment_words(self, value: u32) -> ScratchSpaceHeapAllocator<'a> {
ScratchSpaceHeapAllocator {
allocator: self.allocator.first_segment_words(value),
..self
}
}
/// Sets the allocation strategy for segments after the second one.
pub fn allocation_strategy(self, value: AllocationStrategy) -> ScratchSpaceHeapAllocator<'a> {
ScratchSpaceHeapAllocator {
allocator: self.allocator.allocation_strategy(value),
..self
}
}
}
#[cfg(feature = "alloc")]
unsafe impl<'a> Allocator for ScratchSpaceHeapAllocator<'a> {
fn allocate_segment(&mut self, minimum_size: u32) -> (*mut u8, u32) {
if (minimum_size as usize) < (self.scratch_space.len() / BYTES_PER_WORD)
&& !self.scratch_space_allocated
{
self.scratch_space_allocated = true;
(
self.scratch_space.as_mut_ptr(),
(self.scratch_space.len() / BYTES_PER_WORD) as u32,
)
} else {
self.allocator.allocate_segment(minimum_size)
}
}
unsafe fn deallocate_segment(&mut self, ptr: *mut u8, word_size: u32, words_used: u32) {
let seg_ptr = self.scratch_space.as_mut_ptr();
if ptr == seg_ptr {
// Rezero the slice to allow reuse of the allocator. We only need to write
// words that we know might contain nonzero values.
unsafe {
core::ptr::write_bytes(
seg_ptr, // miri isn't happy if we use ptr instead
0u8,
(words_used as usize) * BYTES_PER_WORD,
);
}
self.scratch_space_allocated = false;
} else {
self.allocator
.deallocate_segment(ptr, word_size, words_used);
}
}
}
/// An Allocator whose first and only segment is a backed by a user-provided buffer.
/// If the segment fills up, subsequent allocations trigger panics.
///
/// The main purpose of this struct is to be used in situations where heap allocation
/// is not available.
///
/// Recall that an `Allocator` implementation must ensure that allocated segments are
/// initially *zeroed*. `SingleSegmentAllocator` ensures that is the case by zeroing
/// the entire buffer upon initial construction, and then zeroing any *potentially used*
/// part of the buffer upon `deallocate_segment()`.
///
/// You can reuse a `SingleSegmentAllocator` by calling `message::Builder::into_allocator()`,
/// or by initially passing it to `message::Builder::new()` as a `&mut SingleSegmentAllocator`.
/// Such reuse can save significant amounts of zeroing.
pub struct SingleSegmentAllocator<'a> {
segment: &'a mut [u8],
segment_allocated: bool,
}
impl<'a> SingleSegmentAllocator<'a> {
/// Writes zeroes into the entire buffer and constructs a new allocator from it.
///
/// If the buffer is large, this operation could be relatively expensive. If you want to reuse
/// the same scratch space in a later message, you should reuse the entire
/// `SingleSegmentAllocator`, to avoid paying this full cost again.
pub fn new(segment: &'a mut [u8]) -> SingleSegmentAllocator<'a> {
#[cfg(not(feature = "unaligned"))]
{
if segment.as_ptr() as usize % BYTES_PER_WORD != 0 {
panic!(
"Segment must be 8-byte aligned, or you must enable the \"unaligned\" \
feature in the capnp crate"
);
}
}
// We need to ensure that the buffer is zeroed.
for b in &mut segment[..] {
*b = 0;
}
SingleSegmentAllocator {
segment,
segment_allocated: false,
}
}
}
unsafe impl<'a> Allocator for SingleSegmentAllocator<'a> {
fn allocate_segment(&mut self, minimum_size: u32) -> (*mut u8, u32) {
let available_word_count = self.segment.len() / BYTES_PER_WORD;
if (minimum_size as usize) > available_word_count {
panic!(
"Allocation too large: asked for {minimum_size} words, \
but only {available_word_count} are available."
)
} else if self.segment_allocated {
panic!("Tried to allocated two segments in a SingleSegmentAllocator.")
} else {
self.segment_allocated = true;
(
self.segment.as_mut_ptr(),
(self.segment.len() / BYTES_PER_WORD) as u32,
)
}
}
unsafe fn deallocate_segment(&mut self, ptr: *mut u8, _word_size: u32, words_used: u32) {
let seg_ptr = self.segment.as_mut_ptr();
if ptr == seg_ptr {
// Rezero the slice to allow reuse of the allocator. We only need to write
// words that we know might contain nonzero values.
unsafe {
core::ptr::write_bytes(
seg_ptr, // miri isn't happy if we use ptr instead
0u8,
(words_used as usize) * BYTES_PER_WORD,
);
}
self.segment_allocated = false;
}
}
}
unsafe impl<'a, A> Allocator for &'a mut A
where
A: Allocator,
{
fn allocate_segment(&mut self, minimum_size: u32) -> (*mut u8, u32) {
(*self).allocate_segment(minimum_size)
}
unsafe fn deallocate_segment(&mut self, ptr: *mut u8, word_size: u32, words_used: u32) {
(*self).deallocate_segment(ptr, word_size, words_used)
}
}