kvark / copyless

[deprecated] Avoid memcpy calls when working with standard containers
Apache License 2.0
276 stars 12 forks source link

copyless

Build Status Crates.io

NOTE: crate is marked as DEPRECATED because of https://github.com/kvark/copyless/issues/22

Rust abstractions can be zero cost in theory, but often reveal quite a few unnecessary memcpy calls in practice. This library provides a number of trait extensions for standard containers that expose API that is more friendly to LLVM optimization passes and doesn't end up with as many copies.

It aims to accelerate WebRender and gfx-rs.

Background

The memcpy instructions showed in profiles of WebRender running in Gecko. @jrmuizel built a tool called memcpy-find that analyzes LLVM IR and spews out the call stacks that end up producing memcpy instructions. We figured out a way to convince the compiler to eliminate the copies. This library attempts to make these ways available to Rust ecosystem, at least until the compiler gets smart enough ;)

Here is a small example

use copyless::BoxHelper;

enum Foo {
    Small(i8),
    Big([f32; 100]),
}

#[inline(never)]
fn foo() -> Box<Foo> {
    Box::new(Foo::Small(4)) // this has 1 memcopy
    //Box::alloc().init(Foo::Small(4)) // this has 0 memcopies
}

fn main() {
    let z = foo();
    println!("{:?}", &*z as *const _);
}

Playground permalink.