Remove debug feature from fuel-vm and use debugger by default. (#554

)

* Remove `debug` feature from `fuel-vm` and use debugger by default.

* Updated CHANGELOG.md

* Use a new `Rust`

* Make clippy happy

* Use rust 1.71

* Update CHANGELOG.md

Co-authored-by: Brandon Vrooman <brandon.vrooman@fuel.sh>

---------

Co-authored-by: Brandon Vrooman <brandon.vrooman@fuel.sh>

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 #### Breaking
 
+- [#554](https://github.com/FuelLabs/fuel-vm/pull/554): Removed `debug` feature from the `fuel-vm`. The debugger is always available and becomes active after calling any `set_*` method.
 - [#537](https://github.com/FuelLabs/fuel-vm/pull/537): Use dependent cost for `k256`, `s256`, `mcpi`, `scwq`, `swwq` opcodes.
     These opcodes charged inadequately low costs in comparison to the amount of work.
     This change should make all transactions that used these opcodes much more expensive than before.

fuel-vm/Cargo.toml

@@ -55,7 +55,6 @@ tokio-rayon = "2.1.0"
 [features]
 default = []
 arbitrary = ["fuel-asm/arbitrary"]
-debug = []
 optimized = []
 profile-gas = ["profile-any"]
 profile-coverage = ["profile-any"]

fuel-vm/src/error.rs

@@ -41,7 +41,6 @@ pub enum InterpreterError {
     #[error("Unrecoverable error: {0}")]
     Io(#[from] io::Error),
 
-    #[cfg(feature = "debug")]
     #[error("Execution error")]
     /// The debug state is not initialized; debug routines can't be called.
     DebugStateNotInitialized,
@@ -118,7 +117,6 @@ impl PartialEq for InterpreterError {
             (Self::NoTransactionInitialized, Self::NoTransactionInitialized) => true,
             (Self::Io(s), Self::Io(o)) => s.kind() == o.kind(),
 
-            #[cfg(feature = "debug")]
             (Self::DebugStateNotInitialized, Self::DebugStateNotInitialized) => true,
 
             _ => false,

fuel-vm/src/interpreter.rs

@@ -68,7 +68,6 @@ mod metadata;
 mod post_execution;
 mod receipts;
 
-#[cfg(feature = "debug")]
 mod debug;
 
 use crate::profiler::Profiler;

fuel-vm/src/interpreter/executors.rs

@@ -2,5 +2,4 @@ mod instruction;
 mod main;
 mod predicate;
 
-#[cfg(feature = "debug")]
 mod debug;

fuel-vm/src/interpreter/executors/instruction.rs

@@ -58,8 +58,7 @@ where
         &mut self,
         raw: R,
     ) -> Result<ExecuteState, InterpreterError> {
-        #[cfg(feature = "debug")]
-        {
+        if self.debugger.is_active() {
             let debug = self.eval_debugger_state();
             if !debug.should_continue() {
                 return Ok(debug.into())

fuel-vm/src/interpreter/executors/main.rs

@@ -569,7 +569,6 @@ where
 
             self.append_receipt(receipt);
 
-            #[cfg(feature = "debug")]
             if program.is_debug() {
                 self.debugger_set_last_state(program);
             }
@@ -620,7 +619,6 @@ where
 
                     ExecuteState::Proceed => (),
 
-                    #[cfg(feature = "debug")]
                     ExecuteState::DebugEvent(d) => return Ok(ProgramState::RunProgram(d)),
                 }
             }

fuel-vm/src/interpreter/executors/predicate.rs

@@ -54,7 +54,6 @@ where
 
                 ExecuteState::Proceed => (),
 
-                #[cfg(feature = "debug")]
                 ExecuteState::DebugEvent(d) => {
                     return Ok(ProgramState::VerifyPredicate(d))
                 }

fuel-vm/src/lib.rs

@@ -148,7 +148,6 @@ pub mod prelude {
         transactor::Transactor,
     };
 
-    #[cfg(feature = "debug")]
     pub use crate::state::{
         Breakpoint,
         DebugEval,

fuel-vm/src/state.rs

@@ -6,25 +6,17 @@ use fuel_types::{
     Word,
 };
 
-#[cfg(feature = "debug")]
 mod debug;
 
-#[cfg(feature = "debug")]
 mod debugger;
 
-#[cfg(feature = "debug")]
 pub use debug::{
     Breakpoint,
     DebugEval,
 };
 
-#[cfg(feature = "debug")]
 pub use debugger::Debugger;
 
-#[cfg(not(feature = "debug"))]
-/// Fallback functionless implementation if `debug` feature isn't enabled.
-pub type Debugger = ();
-
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 /// Resulting state of an instruction set execution.
 pub enum ExecuteState {
@@ -37,23 +29,14 @@ pub enum ExecuteState {
     /// The set execution resulted in a `RVRT` instruction.
     Revert(Word),
 
-    #[cfg(feature = "debug")]
     /// A debug event was reached.
     DebugEvent(DebugEval),
 }
 
 impl ExecuteState {
     /// Return true if the VM execution should continue.
     pub const fn should_continue(&self) -> bool {
-        #[cfg(not(feature = "debug"))]
-        {
-            matches!(self, Self::Proceed)
-        }
-
-        #[cfg(feature = "debug")]
-        {
-            matches!(self, Self::Proceed | Self::DebugEvent(DebugEval::Continue))
-        }
+        matches!(self, Self::Proceed | Self::DebugEvent(DebugEval::Continue))
     }
 }
 
@@ -63,7 +46,6 @@ impl Default for ExecuteState {
     }
 }
 
-#[cfg(feature = "debug")]
 impl From<DebugEval> for ExecuteState {
     fn from(d: DebugEval) -> Self {
         Self::DebugEvent(d)
@@ -81,17 +63,14 @@ pub enum ProgramState {
     /// The transaction execution resulted in a `RVRT` instruction.
     Revert(Word),
 
-    #[cfg(feature = "debug")]
     /// A debug event was reached for the transaction. The VM is suspended.
     RunProgram(DebugEval),
 
-    #[cfg(feature = "debug")]
     /// A debug event was reached for a predicate verification. The VM is
     /// suspended.
     VerifyPredicate(DebugEval),
 }
 
-#[cfg(feature = "debug")]
 impl PartialEq<Breakpoint> for ProgramState {
     fn eq(&self, other: &Breakpoint) -> bool {
         match self.debug_ref() {
@@ -101,7 +80,6 @@ impl PartialEq<Breakpoint> for ProgramState {
     }
 }
 
-#[cfg(feature = "debug")]
 impl ProgramState {
     /// Debug event representation.
     ///

fuel-vm/src/state/debugger.rs

@@ -14,31 +14,37 @@ use std::collections::{
     HashSet,
 };
 
-#[derive(Debug, Default, Clone)]
 /// Debugger implementation for the VM.
-///
-/// Required features:
-/// - `debug`
+#[derive(Debug, Default, Clone)]
 pub struct Debugger {
+    /// Debugger is active and used.
+    is_active: bool,
     /// Single-stepping mode triggers a breakpoint after each instruction
     single_stepping: bool,
     breakpoints: HashMap<ContractId, HashSet<Word>>,
     last_state: Option<ProgramState>,
 }
 
 impl Debugger {
+    /// Returns `true` if the `Debugger` is active and used.
+    pub const fn is_active(&self) -> bool {
+        self.is_active
+    }
+
     /// Get single-stepping mode
     pub const fn single_stepping(&self) -> bool {
         self.single_stepping
     }
 
     /// Set single-stepping mode
     pub fn set_single_stepping(&mut self, single_stepping: bool) {
+        self.is_active = true;
         self.single_stepping = single_stepping;
     }
 
     /// Set a new breakpoint in the provided location.
     pub fn set_breakpoint(&mut self, breakpoint: Breakpoint) {
+        self.is_active = true;
         let contract = *breakpoint.contract();
         let pc = breakpoint.pc();
 
@@ -57,6 +63,7 @@ impl Debugger {
 
     /// Remove a breakpoint, if existent.
     pub fn remove_breakpoint(&mut self, breakpoint: &Breakpoint) {
+        self.is_active = true;
         self.breakpoints
             .get_mut(breakpoint.contract())
             .map(|set| set.remove(&breakpoint.pc()));
@@ -90,6 +97,7 @@ impl Debugger {
 
     /// Overwrite the last known state of the VM.
     pub fn set_last_state(&mut self, state: ProgramState) {
+        self.is_active = true;
         self.last_state.replace(state);
     }