Hints (#22)

hints

Author: leonardoalt

Cargo.lock

@@ -37,6 +37,7 @@ num-integer = { version = "0.1.46", default-features = false }
 serde = { version = "1.0.201", default-features = false, features = ["derive"] }
 serde-big-array = "0.5.1"
 struct-reflection = { git = "https://github.com/gzanitti/struct-reflection-rs.git" }
+rustc-hash = "2.0.0"
 
 rrs-lib = "0.1.0"
 tracing = "0.1.40"

Cargo.toml

@@ -20,6 +20,7 @@ derive_more = { workspace = true, features = ["from"] }
 rand.workspace = true
 eyre.workspace = true
 thiserror.workspace = true
+rustc-hash.workspace = true
 # for div_rem:
 num-bigint.workspace = true
 num-integer.workspace = true

extensions/circuit/Cargo.toml

@@ -38,8 +38,6 @@ pub struct WomirIConfig {
     pub system: SystemConfig,
     #[extension]
     pub base: WomirI,
-    #[extension]
-    pub io: WomirIo,
 }
 
 // Default implementation uses no init file
@@ -63,7 +61,6 @@ impl Default for WomirIConfig {
         Self {
             system,
             base: Default::default(),
-            io: Default::default(),
         }
     }
 }
@@ -76,7 +73,6 @@ impl WomirIConfig {
         Self {
             system,
             base: Default::default(),
-            io: Default::default(),
         }
     }
 
@@ -88,7 +84,6 @@ impl WomirIConfig {
         Self {
             system,
             base: Default::default(),
-            io: Default::default(),
         }
     }
 }
@@ -115,10 +110,6 @@ impl WomirImConfig {
 #[derive(Clone, Copy, Debug, Default, Serialize, Deserialize)]
 pub struct WomirI;
 
-/// Extension similar to RISC-V for handling IO (not to be confused with I base extension)
-#[derive(Clone, Copy, Debug, Default, Serialize, Deserialize)]
-pub struct WomirIo;
-
 /// Extension similar to RISC-V 32-bit Multiplication Extension (RV32M)
 #[derive(Clone, Copy, Debug, Serialize, Deserialize)]
 pub struct WomirM {
@@ -149,6 +140,7 @@ pub enum WomirIExecutor<F: PrimeField32> {
     CopyIntoFrame(CopyIntoFrameChipWom<F>),
     Const32(ConstsChipWom<F>),
     LessThan(LessThanChipWom<F>),
+    HintStore(HintStoreChip<F>),
     // Shift(Rv32ShiftChip<F>),
     // LoadStore(Rv32LoadStoreChip<F>),
     // LoadSignExtend(Rv32LoadSignExtendChip<F>),
@@ -166,12 +158,6 @@ pub enum WomirMExecutor<F: PrimeField32> {
     DivRem(Rv32DivRemChip<F>),
 }
 
-/// RISC-V 32-bit Io Instruction Executors
-#[derive(ChipUsageGetter, Chip, InstructionExecutor, From, AnyEnum)]
-pub enum WomirIoExecutor<F: PrimeField32> {
-    HintStore(Rv32HintStoreChip<F>),
-}
-
 #[derive(From, ChipUsageGetter, Chip, AnyEnum)]
 pub enum WomirIPeriphery<F: PrimeField32> {
     BitwiseOperationLookup(SharedBitwiseOperationLookupChip<8>),
@@ -188,13 +174,6 @@ pub enum WomirMPeriphery<F: PrimeField32> {
     Phantom(PhantomChip<F>),
 }
 
-#[derive(From, ChipUsageGetter, Chip, AnyEnum)]
-pub enum WomirIoPeriphery<F: PrimeField32> {
-    BitwiseOperationLookup(SharedBitwiseOperationLookupChip<8>),
-    // We put this only to get the <F> generic to work
-    Phantom(PhantomChip<F>),
-}
-
 // ============ VmExtension Implementations ============
 
 impl<F: PrimeField32> VmExtension<F> for WomirI {
@@ -308,7 +287,25 @@ impl<F: PrimeField32> VmExtension<F> for WomirI {
             shared_fp.clone(),
         );
         inventory.add_executor(lt_chip, LessThanOpcode::iter().map(|x| x.global_opcode()))?;
-        //
+
+        let mut hintstore_chip = HintStoreChip::new(
+            execution_bus,
+            frame_bus,
+            program_bus,
+            bitwise_lu_chip.clone(),
+            memory_bridge,
+            offline_memory.clone(),
+            shared_fp.clone(),
+            builder.system_config().memory_config.pointer_max_bits,
+            HintStoreOpcode::CLASS_OFFSET,
+        );
+        hintstore_chip.set_streams(builder.streams().clone());
+
+        inventory.add_executor(
+            hintstore_chip,
+            HintStoreOpcode::iter().map(|x| x.global_opcode()),
+        )?;
+
         // let shift_chip = Rv32ShiftChip::new(
         //     Rv32WomBaseAluAdapterChip::new(
         //         execution_bus,
@@ -507,54 +504,6 @@ impl<F: PrimeField32> VmExtension<F> for WomirM {
     }
 }
 
-impl<F: PrimeField32> VmExtension<F> for WomirIo {
-    type Executor = WomirIoExecutor<F>;
-    type Periphery = WomirIoPeriphery<F>;
-
-    fn build(
-        &self,
-        builder: &mut VmInventoryBuilder<F>,
-    ) -> Result<VmInventory<Self::Executor, Self::Periphery>, VmInventoryError> {
-        let mut inventory = VmInventory::new();
-        let SystemPort {
-            execution_bus,
-            program_bus,
-            memory_bridge,
-        } = builder.system_port();
-        let offline_memory = builder.system_base().offline_memory();
-
-        let bitwise_lu_chip = if let Some(&chip) = builder
-            .find_chip::<SharedBitwiseOperationLookupChip<8>>()
-            .first()
-        {
-            chip.clone()
-        } else {
-            let bitwise_lu_bus = BitwiseOperationLookupBus::new(builder.new_bus_idx());
-            let chip = SharedBitwiseOperationLookupChip::new(bitwise_lu_bus);
-            inventory.add_periphery_chip(chip.clone());
-            chip
-        };
-
-        let mut hintstore_chip = Rv32HintStoreChip::new(
-            execution_bus,
-            program_bus,
-            bitwise_lu_chip.clone(),
-            memory_bridge,
-            offline_memory.clone(),
-            builder.system_config().memory_config.pointer_max_bits,
-            HintStoreOpcode::CLASS_OFFSET,
-        );
-        hintstore_chip.set_streams(builder.streams().clone());
-
-        inventory.add_executor(
-            hintstore_chip,
-            HintStoreOpcode::iter().map(|x| x.global_opcode()),
-        )?;
-
-        Ok(inventory)
-    }
-}
-
 /// Phantom sub-executors
 mod phantom {
     use eyre::bail;
@@ -590,22 +539,23 @@ mod phantom {
             _: F,
             _: u16,
         ) -> eyre::Result<()> {
-            let mut hint = match streams.input_stream.pop_front() {
+            let hint = match streams.input_stream.pop_front() {
                 Some(hint) => hint,
                 None => {
                     bail!("EndOfInputStream");
                 }
             };
             streams.hint_stream.clear();
-            streams.hint_stream.extend(
-                (hint.len() as u32)
-                    .to_le_bytes()
-                    .iter()
-                    .map(|b| F::from_canonical_u8(*b)),
-            );
-            // Extend by 0 for 4 byte alignment
-            let capacity = hint.len().div_ceil(4) * 4;
-            hint.resize(capacity, F::ZERO);
+            // TODO add this back when we support generic read over serialized data.
+            // streams.hint_stream.extend(
+            //     (hint.len() as u32)
+            //         .to_le_bytes()
+            //         .iter()
+            //         .map(|b| F::from_canonical_u8(*b)),
+            // );
+            // // Extend by 0 for 4 byte alignment
+            // let capacity = hint.len().div_ceil(4) * 4;
+            // hint.resize(capacity, F::ZERO);
             streams.hint_stream.extend(hint);
             Ok(())
         }