Bump to v0.9.0 (#2)

* Updates the README * Bump to v0.9.0 * Renames the crate.
anza-xyz · Dec 13, 2024 · 75d5bc8 · 75d5bc8
1 parent 2205eba
commit 75d5bc8
Show file tree

Hide file tree

Showing 40 changed files with 101 additions and 107 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -1,4 +1,4 @@
-name: rbpf
+name: sbpf
 
 on:
   push:

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,9 +1,9 @@
 [package]
-name = "solana_rbpf"
-version = "0.8.2"
+name = "solana-sbpf"
+version = "0.9.0"
 description = "Virtual machine and JIT compiler for eBPF programs"
 authors = ["Solana Maintainers <[email protected]>"]
-repository = "https://github.com/solana-labs/rbpf"
+repository = "https://github.com/anza-xyz/sbpf"
 homepage = "https://solana.com/"
 keywords = ["BPF", "eBPF", "interpreter", "JIT", "filtering"]
 license = "Apache-2.0"

diff --git a/README.md b/README.md
@@ -1,15 +1,13 @@
-# solana_rbpf
+# solana-sbpf
 
-![](misc/rbpf_256.png)
+SBPF virtual machine
 
-Rust (user-space) virtual machine for eBPF
-
-[![Build Status](https://github.com/solana-labs/rbpf/actions/workflows/main.yml/badge.svg)](https://github.com/solana-labs/rbpf/actions/workflows/main.yml)
-[![Crates.io](https://img.shields.io/crates/v/solana_rbpf.svg)](https://crates.io/crates/solana_rbpf)
+[![Build Status](https://github.com/anza-xyz/sbpf/actions/workflows/main.yml/badge.svg)](https://github.com/anza-xyz/sbpf/actions/workflows/main.yml)
+[![Crates.io](https://img.shields.io/crates/v/solana-sbpf.svg)](https://crates.io/crates/solana-sbpf)
 
 ## Description
 
-This is a fork of [RBPF](https://github.com/qmonnet/rbpf) by Quentin Monnet.
+This is a fork of [RBPF](https://github.com/solana-labs/rbpf) which in turn is a fork of [RBPF](https://github.com/qmonnet/rbpf) by Quentin Monnet.
 
 This crate contains a virtual machine for eBPF program execution. BPF, as in
 _Berkeley Packet Filter_, is an assembly-like language initially developed for
@@ -26,48 +24,48 @@ although the JIT-compiler does not work with Windows at this time.
 
 ## Link to the crate
 
-This crate is available from [crates.io](https://crates.io/crates/solana_rbpf),
+This crate is available from [crates.io](https://crates.io/crates/solana-sbpf),
 so it should work out of the box by adding it as a dependency in your
 `Cargo.toml` file:
 
 ```toml
 [dependencies]
-solana_rbpf = "0.8.2"
+solana-sbpf = "0.9.0"
 ```
 
 You can also use the development version from this GitHub repository. This
 should be as simple as putting this inside your `Cargo.toml`:
 
 ```toml
 [dependencies]
-solana_rbpf = { git = "https://github.com/solana-labs/rbpf", branch = "main" }
+solana-sbpf = { git = "https://github.com/anza-xyz/sbpf", branch = "main" }
 ```
 
 Of course, if you prefer, you can clone it locally, possibly hack the crate,
 and then indicate the path of your local version in `Cargo.toml`:
 
 ```toml
 [dependencies]
-solana_rbpf = { path = "path/to/solana_rbpf" }
+solana-sbpf = { path = "path/to/sbpf" }
 ```
 
 Then indicate in your source code that you want to use the crate:
 
 ```rust,ignore
-extern crate solana_rbpf;
+extern crate solana_sbpf;
 ```
 
 ## API
 
 The API is pretty well documented inside the source code. You should also be
 able to access [an online version of the documentation from
-here](https://docs.rs/solana_rbpf/), automatically generated from the
-[crates.io](https://crates.io/crates/solana_rbpf)
+here](https://docs.rs/solana-sbpf/), automatically generated from the
+[crates.io](https://crates.io/crates/solana-sbpf)
 version (may not be up-to-date with master branch).
 [Examples](examples), [unit tests](tests) and [performance benchmarks](benches)
 should also prove helpful.
 
-Here are the steps to follow to run an eBPF program with rbpf:
+Here are the steps to follow to run an SBPF:
 
 1. Create the config and a loader built-in program, add some functions.
 2. Create an executable, either from the bytecode or an ELF.
@@ -81,7 +79,7 @@ Here are the steps to follow to run an eBPF program with rbpf:
 ## Developer
 
 ### Dependencies
-- rustc version 1.72 or higher
+- rustc version 1.83 or higher
 
 ### Build and test instructions
 - To build run `cargo build`
@@ -90,7 +88,7 @@ Here are the steps to follow to run an eBPF program with rbpf:
 ## License
 
 Following the effort of the Rust language project itself in order to ease
-integration with other projects, the rbpf crate is distributed under the terms
+integration with other projects, the sbpf crate is distributed under the terms
 of both the MIT license and the Apache License (Version 2.0).
 
 See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
diff --git a/benches/elf_loader.rs b/benches/elf_loader.rs
@@ -6,11 +6,11 @@
 
 #![feature(test)]
 
-extern crate solana_rbpf;
+extern crate solana_sbpf;
 extern crate test;
 extern crate test_utils;
 
-use solana_rbpf::{
+use solana_sbpf::{
     elf::Executable,
     program::{BuiltinFunction, BuiltinProgram, FunctionRegistry},
     syscalls,

diff --git a/benches/jit_compile.rs b/benches/jit_compile.rs
@@ -6,10 +6,10 @@
 
 #![feature(test)]
 
-extern crate solana_rbpf;
+extern crate solana_sbpf;
 extern crate test;
 
-use solana_rbpf::{
+use solana_sbpf::{
     elf::Executable, program::BuiltinProgram, verifier::RequisiteVerifier, vm::TestContextObject,
 };
 use std::{fs::File, io::Read, sync::Arc};

diff --git a/benches/memory_mapping.rs b/benches/memory_mapping.rs
@@ -7,11 +7,11 @@
 #![feature(test)]
 
 extern crate rand;
-extern crate solana_rbpf;
+extern crate solana_sbpf;
 extern crate test;
 
 use rand::{rngs::SmallRng, Rng, SeedableRng};
-use solana_rbpf::{
+use solana_sbpf::{
     memory_region::{
         AccessType, AlignedMemoryMapping, MemoryRegion, MemoryState, UnalignedMemoryMapping,
     },

diff --git a/benches/vm_execution.rs b/benches/vm_execution.rs
@@ -6,17 +6,17 @@
 
 #![feature(test)]
 
-extern crate solana_rbpf;
+extern crate solana_sbpf;
 extern crate test;
 
 #[cfg(all(feature = "jit", not(target_os = "windows"), target_arch = "x86_64"))]
-use solana_rbpf::{
+use solana_sbpf::{
     ebpf,
     memory_region::MemoryRegion,
     program::{FunctionRegistry, SBPFVersion},
     vm::Config,
 };
-use solana_rbpf::{
+use solana_sbpf::{
     elf::Executable, program::BuiltinProgram, verifier::RequisiteVerifier, vm::TestContextObject,
 };
 use std::{fs::File, io::Read, sync::Arc};
@@ -83,7 +83,7 @@ fn bench_jit_vs_interpreter(
     instruction_meter: u64,
     mem: &mut [u8],
 ) {
-    let mut executable = solana_rbpf::assembler::assemble::<TestContextObject>(
+    let mut executable = solana_sbpf::assembler::assemble::<TestContextObject>(
         assembly,
         Arc::new(BuiltinProgram::new_loader(
             config,

diff --git a/cli/Cargo.lock b/cli/Cargo.lock
diff --git a/cli/Cargo.toml b/cli/Cargo.toml
@@ -1,14 +1,14 @@
 [package]
-name = "rbpf_cli"
-version = "0.8.2"
+name = "sbpf_cli"
+version = "0.9.0"
 description = "CLI to test and analyze eBPF programs"
 authors = ["Solana Maintainers <[email protected]>"]
-repository = "https://github.com/solana-labs/rbpf"
+repository = "https://github.com/anza-xyz/sbpf"
 homepage = "https://solana.com/"
 keywords = ["BPF", "eBPF", "interpreter", "JIT"]
 edition = "2018"
 
 [dependencies]
-solana_rbpf = { path = "../", features = ["debugger"] }
+solana-sbpf = { path = "../", features = ["debugger"] }
 test_utils = { path = "../test_utils/" }
 clap = "3.0.0-beta.2"
diff --git a/cli/src/main.rs b/cli/src/main.rs
@@ -1,5 +1,5 @@
 use clap::{crate_version, App, Arg};
-use solana_rbpf::{
+use solana_sbpf::{
     aligned_memory::AlignedMemory,
     assembler::assemble,
     ebpf,

diff --git a/examples/disassemble.rs b/examples/disassemble.rs
@@ -4,8 +4,8 @@
 // the MIT license <http://opensource.org/licenses/MIT>, at your option. This file may not be
 // copied, modified, or distributed except according to those terms.
 
-extern crate solana_rbpf;
-use solana_rbpf::{
+extern crate solana_sbpf;
+use solana_sbpf::{
     elf::Executable,
     program::{BuiltinProgram, FunctionRegistry, SBPFVersion},
     static_analysis::Analysis,

diff --git a/examples/to_json.rs b/examples/to_json.rs
@@ -10,8 +10,8 @@ extern crate json;
 extern crate elf;
 use std::path::PathBuf;
 
-extern crate solana_rbpf;
-use solana_rbpf::{
+extern crate solana_sbpf;
+use solana_sbpf::{
     elf::Executable,
     program::{BuiltinProgram, FunctionRegistry, SBPFVersion},
     static_analysis::Analysis,

diff --git a/fuzz/Cargo.lock b/fuzz/Cargo.lock
diff --git a/fuzz/Cargo.toml b/fuzz/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
-name = "solana_rbpf-fuzz"
-version = "0.8.2"
+name = "solana-sbpf-fuzz"
+version = "0.9.0"
 authors = ["Automatically generated"]
 publish = false
 edition = "2018"
@@ -15,7 +15,7 @@ num-traits = "0.2"
 rayon = "1.5"
 test_utils = { path = "../test_utils/" }
 
-[dependencies.solana_rbpf]
+[dependencies.solana-sbpf]
 path = ".."
 features = ["fuzzer-not-safe-for-production"]
 

diff --git a/fuzz/fuzz_targets/common.rs b/fuzz/fuzz_targets/common.rs
@@ -2,7 +2,7 @@ use std::mem::size_of;
 
 use arbitrary::{Arbitrary, Unstructured};
 
-use solana_rbpf::vm::Config;
+use solana_sbpf::vm::Config;
 
 #[derive(Debug)]
 pub struct ConfigTemplate {

diff --git a/fuzz/fuzz_targets/dumb.rs b/fuzz/fuzz_targets/dumb.rs
@@ -4,7 +4,7 @@ use std::hint::black_box;
 
 use libfuzzer_sys::fuzz_target;
 
-use solana_rbpf::{
+use solana_sbpf::{
     ebpf,
     elf::Executable,
     memory_region::MemoryRegion,

diff --git a/fuzz/fuzz_targets/grammar_aware.rs b/fuzz/fuzz_targets/grammar_aware.rs
@@ -1,6 +1,6 @@
 #![allow(dead_code)]
 
-use solana_rbpf::insn_builder::{Arch, BpfCode, Cond, Endian, Instruction, MemSize, Source};
+use solana_sbpf::insn_builder::{Arch, BpfCode, Cond, Endian, Instruction, MemSize, Source};
 
 #[derive(arbitrary::Arbitrary, Debug, Eq, PartialEq)]
 pub enum FuzzedOp {

diff --git a/fuzz/fuzz_targets/semantic_aware.rs b/fuzz/fuzz_targets/semantic_aware.rs
@@ -3,7 +3,7 @@
 
 use std::num::NonZeroI32;
 
-use solana_rbpf::insn_builder::{Arch, BpfCode, Cond, Endian, Instruction, MemSize, Move, Source};
+use solana_sbpf::insn_builder::{Arch, BpfCode, Cond, Endian, Instruction, MemSize, Move, Source};
 
 #[derive(arbitrary::Arbitrary, Debug, Eq, PartialEq, Copy, Clone)]
 pub struct Register(u8);