Moves SBPFVersion, FunctionRegistry, BuiltinFunction and BuiltinProgr…

…am into a new file (#526)
solana-labs · Sep 28, 2023 · 03d64e6 · 03d64e6
1 parent 42c5e90
commit 03d64e6
Show file tree

Hide file tree

Showing 26 changed files with 406 additions and 355 deletions.
diff --git a/benches/elf_loader.rs b/benches/elf_loader.rs
@@ -11,9 +11,10 @@ extern crate test;
 extern crate test_utils;
 
 use solana_rbpf::{
-    elf::{Executable, FunctionRegistry},
+    elf::Executable,
+    program::{BuiltinFunction, BuiltinProgram, FunctionRegistry},
     syscalls,
-    vm::{BuiltinFunction, BuiltinProgram, Config, TestContextObject},
+    vm::{Config, TestContextObject},
 };
 use std::{fs::File, io::Read, sync::Arc};
 use test::Bencher;

diff --git a/benches/jit_compile.rs b/benches/jit_compile.rs
@@ -10,9 +10,7 @@ extern crate solana_rbpf;
 extern crate test;
 
 use solana_rbpf::{
-    elf::Executable,
-    verifier::RequisiteVerifier,
-    vm::{BuiltinProgram, TestContextObject},
+    elf::Executable, program::BuiltinProgram, verifier::RequisiteVerifier, vm::TestContextObject,
 };
 use std::{fs::File, io::Read, sync::Arc};
 use test::Bencher;

diff --git a/benches/memory_mapping.rs b/benches/memory_mapping.rs
@@ -12,10 +12,10 @@ extern crate test;
 
 use rand::{rngs::SmallRng, Rng, SeedableRng};
 use solana_rbpf::{
-    elf::SBPFVersion,
     memory_region::{
         AccessType, AlignedMemoryMapping, MemoryRegion, MemoryState, UnalignedMemoryMapping,
     },
+    program::SBPFVersion,
     vm::Config,
 };
 use test::Bencher;

diff --git a/benches/vm_execution.rs b/benches/vm_execution.rs
@@ -11,10 +11,11 @@ extern crate test;
 
 use solana_rbpf::{
     ebpf,
-    elf::{Executable, FunctionRegistry},
+    elf::Executable,
     memory_region::MemoryRegion,
+    program::{BuiltinProgram, FunctionRegistry},
     verifier::RequisiteVerifier,
-    vm::{BuiltinProgram, Config, TestContextObject},
+    vm::{Config, TestContextObject},
 };
 use std::{fs::File, io::Read, sync::Arc};
 use test::Bencher;

diff --git a/cli/src/main.rs b/cli/src/main.rs
@@ -3,11 +3,12 @@ use solana_rbpf::{
     aligned_memory::AlignedMemory,
     assembler::assemble,
     ebpf,
-    elf::{Executable, FunctionRegistry},
+    elf::Executable,
     memory_region::{MemoryMapping, MemoryRegion},
+    program::{BuiltinProgram, FunctionRegistry},
     static_analysis::Analysis,
     verifier::RequisiteVerifier,
-    vm::{BuiltinProgram, Config, DynamicAnalysis, EbpfVm, TestContextObject},
+    vm::{Config, DynamicAnalysis, EbpfVm, TestContextObject},
 };
 use std::{fs::File, io::Read, path::Path, sync::Arc};
 

diff --git a/examples/disassemble.rs b/examples/disassemble.rs
@@ -6,9 +6,10 @@
 
 extern crate solana_rbpf;
 use solana_rbpf::{
-    elf::{Executable, FunctionRegistry, SBPFVersion},
+    elf::Executable,
+    program::{BuiltinProgram, FunctionRegistry, SBPFVersion},
     static_analysis::Analysis,
-    vm::{BuiltinProgram, TestContextObject},
+    vm::TestContextObject,
 };
 use std::sync::Arc;
 

diff --git a/examples/to_json.rs b/examples/to_json.rs
@@ -12,9 +12,10 @@ use std::path::PathBuf;
 
 extern crate solana_rbpf;
 use solana_rbpf::{
-    elf::{Executable, FunctionRegistry, SBPFVersion},
+    elf::Executable,
+    program::{BuiltinProgram, FunctionRegistry, SBPFVersion},
     static_analysis::Analysis,
-    vm::{BuiltinProgram, TestContextObject},
+    vm::TestContextObject,
 };
 use std::sync::Arc;
 // Turn a program into a JSON string.

diff --git a/fuzz/fuzz_targets/dumb.rs b/fuzz/fuzz_targets/dumb.rs
@@ -6,10 +6,11 @@ use libfuzzer_sys::fuzz_target;
 
 use solana_rbpf::{
     ebpf,
-    elf::{Executable, FunctionRegistry, SBPFVersion},
+    elf::Executable,
     memory_region::MemoryRegion,
+    program::{BuiltinProgram, FunctionRegistry, SBPFVersion},
     verifier::{RequisiteVerifier, Verifier},
-    vm::{BuiltinProgram, TestContextObject},
+    vm::TestContextObject,
 };
 use test_utils::create_vm;
 
@@ -35,7 +36,10 @@ fuzz_target!(|data: DumbFuzzData| {
     let mut mem = data.mem;
     let executable = Executable::<TestContextObject>::from_text_bytes(
         &prog,
-        std::sync::Arc::new(BuiltinProgram::new_loader(config, FunctionRegistry::default())),
+        std::sync::Arc::new(BuiltinProgram::new_loader(
+            config,
+            FunctionRegistry::default(),
+        )),
         SBPFVersion::V2,
         function_registry,
     )

diff --git a/fuzz/fuzz_targets/smart.rs b/fuzz/fuzz_targets/smart.rs
@@ -7,11 +7,12 @@ use libfuzzer_sys::fuzz_target;
 use grammar_aware::*;
 use solana_rbpf::{
     ebpf,
-    elf::{Executable, FunctionRegistry, SBPFVersion},
+    elf::Executable,
     insn_builder::{Arch, IntoBytes},
     memory_region::MemoryRegion,
+    program::{BuiltinProgram, FunctionRegistry, SBPFVersion},
     verifier::{RequisiteVerifier, Verifier},
-    vm::{BuiltinProgram, TestContextObject},
+    vm::TestContextObject,
 };
 use test_utils::create_vm;
 
@@ -32,14 +33,24 @@ fuzz_target!(|data: FuzzData| {
     let prog = make_program(&data.prog, data.arch);
     let config = data.template.into();
     let function_registry = FunctionRegistry::default();
-    if RequisiteVerifier::verify(prog.into_bytes(), &config, &SBPFVersion::V2, &function_registry).is_err() {
+    if RequisiteVerifier::verify(
+        prog.into_bytes(),
+        &config,
+        &SBPFVersion::V2,
+        &function_registry,
+    )
+    .is_err()
+    {
         // verify please
         return;
     }
     let mut mem = data.mem;
     let executable = Executable::<TestContextObject>::from_text_bytes(
         prog.into_bytes(),
-        std::sync::Arc::new(BuiltinProgram::new_loader(config, FunctionRegistry::default())),
+        std::sync::Arc::new(BuiltinProgram::new_loader(
+            config,
+            FunctionRegistry::default(),
+        )),
         SBPFVersion::V2,
         function_registry,
     )

diff --git a/fuzz/fuzz_targets/smart_jit_diff.rs b/fuzz/fuzz_targets/smart_jit_diff.rs
@@ -5,11 +5,12 @@ use libfuzzer_sys::fuzz_target;
 use grammar_aware::*;
 use solana_rbpf::{
     ebpf,
-    elf::{Executable, FunctionRegistry, SBPFVersion},
+    elf::Executable,
     insn_builder::{Arch, Instruction, IntoBytes},
     memory_region::MemoryRegion,
+    program::{BuiltinProgram, FunctionRegistry, SBPFVersion},
     verifier::{RequisiteVerifier, Verifier},
-    vm::{BuiltinProgram, TestContextObject},
+    vm::TestContextObject,
 };
 use test_utils::create_vm;
 
@@ -39,15 +40,25 @@ fuzz_target!(|data: FuzzData| {
         .push();
     let config = data.template.into();
     let function_registry = FunctionRegistry::default();
-    if RequisiteVerifier::verify(prog.into_bytes(), &config, &SBPFVersion::V2, &function_registry).is_err() {
+    if RequisiteVerifier::verify(
+        prog.into_bytes(),
+        &config,
+        &SBPFVersion::V2,
+        &function_registry,
+    )
+    .is_err()
+    {
         // verify please
         return;
     }
     let mut interp_mem = data.mem.clone();
     let mut jit_mem = data.mem;
     let mut executable = Executable::<TestContextObject>::from_text_bytes(
         prog.into_bytes(),
-        std::sync::Arc::new(BuiltinProgram::new_loader(config, FunctionRegistry::default())),
+        std::sync::Arc::new(BuiltinProgram::new_loader(
+            config,
+            FunctionRegistry::default(),
+        )),
         SBPFVersion::V2,
         function_registry,
     )

diff --git a/fuzz/fuzz_targets/smarter_jit_diff.rs b/fuzz/fuzz_targets/smarter_jit_diff.rs
@@ -5,14 +5,13 @@ use libfuzzer_sys::fuzz_target;
 use semantic_aware::*;
 use solana_rbpf::{
     ebpf,
-    elf::{Executable, FunctionRegistry, SBPFVersion},
+    elf::Executable,
     insn_builder::IntoBytes,
     memory_region::MemoryRegion,
+    program::{BuiltinProgram, FunctionRegistry, SBPFVersion},
     static_analysis::Analysis,
     verifier::{RequisiteVerifier, Verifier},
-    vm::{
-        BuiltinProgram, ContextObject, TestContextObject,
-    },
+    vm::{ContextObject, TestContextObject},
 };
 use test_utils::create_vm;
 
@@ -38,15 +37,25 @@ fuzz_target!(|data: FuzzData| {
     let prog = make_program(&data.prog);
     let config = data.template.into();
     let function_registry = FunctionRegistry::default();
-    if RequisiteVerifier::verify(prog.into_bytes(), &config, &SBPFVersion::V2, &function_registry).is_err() {
+    if RequisiteVerifier::verify(
+        prog.into_bytes(),
+        &config,
+        &SBPFVersion::V2,
+        &function_registry,
+    )
+    .is_err()
+    {
         // verify please
         return;
     }
     let mut interp_mem = data.mem.clone();
     let mut jit_mem = data.mem;
     let mut executable = Executable::<TestContextObject>::from_text_bytes(
         prog.into_bytes(),
-        std::sync::Arc::new(BuiltinProgram::new_loader(config, FunctionRegistry::default())),
+        std::sync::Arc::new(BuiltinProgram::new_loader(
+            config,
+            FunctionRegistry::default(),
+        )),
         SBPFVersion::V2,
         function_registry,
     )
@@ -82,8 +91,9 @@ fuzz_target!(|data: FuzzData| {
         let jit_res_str = format!("{:?}", jit_res);
         if interp_res_str != jit_res_str {
             // spot check: there's a meaningless bug where ExceededMaxInstructions is different due to jump calculations
-            if interp_res_str.contains("ExceededMaxInstructions") &&
-                jit_res_str.contains("ExceededMaxInstructions") {
+            if interp_res_str.contains("ExceededMaxInstructions")
+                && jit_res_str.contains("ExceededMaxInstructions")
+            {
                 return;
             }
             eprintln!("{:#?}", &data.prog);

diff --git a/fuzz/fuzz_targets/verify_semantic_aware.rs b/fuzz/fuzz_targets/verify_semantic_aware.rs
@@ -4,8 +4,8 @@ use libfuzzer_sys::fuzz_target;
 
 use semantic_aware::*;
 use solana_rbpf::{
-    elf::{FunctionRegistry, SBPFVersion},
     insn_builder::IntoBytes,
+    program::{FunctionRegistry, SBPFVersion},
     verifier::{RequisiteVerifier, Verifier},
 };
 
@@ -24,5 +24,11 @@ fuzz_target!(|data: FuzzData| {
     let prog = make_program(&data.prog);
     let config = data.template.into();
     let function_registry = FunctionRegistry::default();
-    RequisiteVerifier::verify(prog.into_bytes(), &config, &SBPFVersion::V2, &function_registry).unwrap();
+    RequisiteVerifier::verify(
+        prog.into_bytes(),
+        &config,
+        &SBPFVersion::V2,
+        &function_registry,
+    )
+    .unwrap();
 });
diff --git a/src/assembler.rs b/src/assembler.rs
@@ -18,8 +18,9 @@ use crate::{
         Statement,
     },
     ebpf::{self, Insn},
-    elf::{Executable, FunctionRegistry, SBPFVersion},
-    vm::{BuiltinProgram, ContextObject},
+    elf::Executable,
+    program::{BuiltinProgram, FunctionRegistry, SBPFVersion},
+    vm::ContextObject,
 };
 use std::{collections::HashMap, sync::Arc};
 
@@ -258,7 +259,7 @@ fn insn(opc: u8, dst: i64, src: i64, off: i64, imm: i64) -> Result<Insn, String>
 /// # Examples
 ///
 /// ```
-/// use solana_rbpf::{assembler::assemble, vm::{Config, TestContextObject, BuiltinProgram}};
+/// use solana_rbpf::{assembler::assemble, program::BuiltinProgram, vm::{Config, TestContextObject}};
 /// let executable = assemble::<TestContextObject>(
 ///    "add64 r1, 0x605
 ///     mov64 r2, 0x32

diff --git a/src/disassembler.rs b/src/disassembler.rs
@@ -10,9 +10,9 @@
 
 use crate::{
     ebpf,
-    elf::{FunctionRegistry, SBPFVersion},
+    program::{BuiltinProgram, FunctionRegistry, SBPFVersion},
     static_analysis::CfgNode,
-    vm::{BuiltinProgram, ContextObject},
+    vm::ContextObject,
 };
 use std::collections::BTreeMap;