rispc

API Documentation

Intel SPMD Compiler Documentation

Using rispc

First, you'll want to both add a build script for your crate (build.rs) and also add rispc to your build-dependencies, and rispsrt to your dependencies:

# Cargo.toml
[package]

# ...

build = "build.rs"

[build-dependencies]
rispc = "0.1"

[dependencies]
rispcrt = "0.1"

Next up, you'll want to write a build script like so:

// build.rs

extern crate rispc;

fn main() {
  rispc::compile_library("libmandelbrot.a", &[ "src/mandelbrot.ispc" ]);
}

And that's it! Running cargo build should take care of the rest and your Rust application will now have the ispc file mandelbrot.ispc compiled into it. You can call the functions in Rust the same way as you do C functions.

Example

See the ispc-demo folder for an example application that uses an ISPC binding.

License

The MIT License (MIT)
Copyright (c) 2016 Clark Gaebel <cg.wowus.cg@gmail.com>

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.

lib.rs:

The task system for rispc-built code.

If your ispc code uses tasks, you will need this library as a dependency.

Currently, pthreads are used. In the future, I would like this library to support custom, pluggable task systems. Pull requests welcome.

For more documentation, see the rispc crate.