Replace unmaintained generational-arena with slotmap

Fixes #5628
FuelLabs · Feb 19, 2024 · 1eb3d0d · 1eb3d0d
1 parent 65c1927
commit 1eb3d0d
Show file tree

Hide file tree

Showing 14 changed files with 44 additions and 47 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/sway-ir/Cargo.toml b/sway-ir/Cargo.toml
@@ -12,13 +12,13 @@ repository.workspace = true
 anyhow = "1.0"
 downcast-rs = "1.2.0"
 filecheck = "0.5"
-generational-arena = "0.2"
 indexmap = { version = "2.0.0", features = ["rayon"] }
 itertools = "0.10.3"
 once_cell = "1.18.0"
 peg = "0.7"
 prettydiff = "0.6.4"
 rustc-hash = "1.1.0"
+slotmap = "1.0.7"
 sway-ir-macros = { version = "0.50.0", path = "sway-ir-macros" }
 sway-types = { version = "0.50.0", path = "../sway-types" }
 sway-utils = { version = "0.50.0", path = "../sway-utils" }

diff --git a/sway-ir/src/block.rs b/sway-ir/src/block.rs
@@ -22,10 +22,10 @@ use crate::{
     Type,
 };
 
-/// A wrapper around an [ECS](https://github.com/fitzgen/generational-arena) handle into the
+/// A wrapper around an [ECS](https://github.com/orlp/slotmap) handle into the
 /// [`Context`].
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Hash, DebugWithContext)]
-pub struct Block(pub generational_arena::Index);
+pub struct Block(pub slotmap::DefaultKey);
 
 #[doc(hidden)]
 pub struct BlockContent {
@@ -570,7 +570,7 @@ impl Block {
 
 /// An iterator over each block in a [`Function`].
 pub struct BlockIterator {
-    blocks: Vec<generational_arena::Index>,
+    blocks: Vec<slotmap::DefaultKey>,
     next: usize,
 }
 

diff --git a/sway-ir/src/context.rs b/sway-ir/src/context.rs
@@ -1,13 +1,13 @@
 //! The main handle to an IR instance.
 //!
 //! [`Context`] contains several
-//! [generational_arena](https://github.com/fitzgen/generational-arena) collections to maintain the
+//! [slotmap](https://github.com/orlp/slotmap) collections to maintain the
 //! IR ECS.
 //!
 //! It is passed around as a mutable reference to many of the Sway-IR APIs.
 
-use generational_arena::Arena;
 use rustc_hash::FxHashMap;
+use slotmap::{DefaultKey, SlotMap};
 use sway_types::SourceEngine;
 
 use crate::{
@@ -23,14 +23,14 @@ use crate::{
 pub struct Context<'eng> {
     pub source_engine: &'eng SourceEngine,
 
-    pub(crate) modules: Arena<ModuleContent>,
-    pub(crate) functions: Arena<FunctionContent>,
-    pub(crate) blocks: Arena<BlockContent>,
-    pub(crate) values: Arena<ValueContent>,
-    pub(crate) local_vars: Arena<LocalVarContent>,
-    pub(crate) types: Arena<TypeContent>,
+    pub(crate) modules: SlotMap<DefaultKey, ModuleContent>,
+    pub(crate) functions: SlotMap<DefaultKey, FunctionContent>,
+    pub(crate) blocks: SlotMap<DefaultKey, BlockContent>,
+    pub(crate) values: SlotMap<DefaultKey, ValueContent>,
+    pub(crate) local_vars: SlotMap<DefaultKey, LocalVarContent>,
+    pub(crate) types: SlotMap<DefaultKey, TypeContent>,
     pub(crate) type_map: FxHashMap<TypeContent, Type>,
-    pub(crate) metadata: Arena<Metadatum>,
+    pub(crate) metadata: SlotMap<DefaultKey, Metadatum>,
 
     pub program_kind: Kind,
 

diff --git a/sway-ir/src/function.rs b/sway-ir/src/function.rs
@@ -24,10 +24,10 @@ use crate::{
     BlockArgument, BranchToWithArgs,
 };
 
-/// A wrapper around an [ECS](https://github.com/fitzgen/generational-arena) handle into the
+/// A wrapper around an [ECS](https://github.com/orlp/slotmap) handle into the
 /// [`Context`].
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
-pub struct Function(pub generational_arena::Index);
+pub struct Function(pub slotmap::DefaultKey);
 
 #[doc(hidden)]
 pub struct FunctionContent {
@@ -541,7 +541,7 @@ impl Function {
 
 /// An iterator over each [`Function`] in a [`Module`].
 pub struct FunctionIterator {
-    functions: Vec<generational_arena::Index>,
+    functions: Vec<slotmap::DefaultKey>,
     next: usize,
 }
 

diff --git a/sway-ir/src/instruction.rs b/sway-ir/src/instruction.rs
@@ -671,7 +671,7 @@ impl InstOp {
 
 /// Iterate over all [`Instruction`]s in a specific [`Block`].
 pub struct InstructionIterator {
-    instructions: Vec<generational_arena::Index>,
+    instructions: Vec<slotmap::DefaultKey>,
     next: usize,
     next_back: isize,
 }

diff --git a/sway-ir/src/irtype.rs b/sway-ir/src/irtype.rs
@@ -12,7 +12,7 @@
 use crate::{context::Context, pretty::DebugWithContext, Constant, ConstantValue, Value};
 
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Hash, DebugWithContext)]
-pub struct Type(pub generational_arena::Index);
+pub struct Type(pub slotmap::DefaultKey);
 
 #[derive(Debug, Clone, DebugWithContext, Hash, PartialEq, Eq)]
 pub enum TypeContent {

diff --git a/sway-ir/src/lib.rs b/sway-ir/src/lib.rs
@@ -23,7 +23,7 @@
 //!
 //! Most of the public data types used in this library are in fact wrappers around a handle into
 //! the context.  The context uses the
-//! [generational_arena](https://github.com/fitzgen/generational-arena) crate to maintain an entity
+//! [slotmap](https://github.com/orlp/slotmap) crate to maintain an entity
 //! component system, or ECS.
 //!
 //! The nature of SSA is that it represents a graph of modules, functions, basic blocks and

diff --git a/sway-ir/src/local_var.rs b/sway-ir/src/local_var.rs
@@ -7,10 +7,10 @@ use crate::{
     pretty::DebugWithContext,
 };
 
-/// A wrapper around an [ECS](https://github.com/fitzgen/generational-arena) handle into the
+/// A wrapper around an [ECS](https://github.com/orlp/slotmap) handle into the
 /// [`Context`].
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Hash, DebugWithContext)]
-pub struct LocalVar(#[in_context(local_vars)] pub generational_arena::Index);
+pub struct LocalVar(#[in_context(local_vars)] pub slotmap::DefaultKey);
 
 #[doc(hidden)]
 #[derive(Clone, DebugWithContext)]

diff --git a/sway-ir/src/metadata.rs b/sway-ir/src/metadata.rs
@@ -11,7 +11,7 @@ use sway_types::SourceId;
 use crate::context::Context;
 
 #[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd, Hash)]
-pub struct MetadataIndex(pub generational_arena::Index);
+pub struct MetadataIndex(pub slotmap::DefaultKey);
 
 #[derive(Clone, Debug, Eq, PartialEq, Hash)]
 pub enum Metadatum {

diff --git a/sway-ir/src/module.rs b/sway-ir/src/module.rs
@@ -10,10 +10,10 @@ use crate::{
     value::Value,
 };
 
-/// A wrapper around an [ECS](https://github.com/fitzgen/generational-arena) handle into the
+/// A wrapper around an [ECS](https://github.com/orlp/slotmap) handle into the
 /// [`Context`].
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
-pub struct Module(pub generational_arena::Index);
+pub struct Module(pub slotmap::DefaultKey);
 
 #[doc(hidden)]
 pub struct ModuleContent {
@@ -113,7 +113,7 @@ impl Module {
 
 /// An iterator over [`Module`]s within a [`Context`].
 pub struct ModuleIterator {
-    modules: Vec<generational_arena::Index>,
+    modules: Vec<slotmap::DefaultKey>,
     next: usize,
 }
 

diff --git a/sway-ir/src/pass_manager.rs b/sway-ir/src/pass_manager.rs
@@ -22,15 +22,15 @@ pub type AnalysisResult = Box<dyn AnalysisResultT>;
 
 /// Program scope over which a pass executes.
 pub trait PassScope {
-    fn get_arena_idx(&self) -> generational_arena::Index;
+    fn get_arena_idx(&self) -> slotmap::DefaultKey;
 }
 impl PassScope for Module {
-    fn get_arena_idx(&self) -> generational_arena::Index {
+    fn get_arena_idx(&self) -> slotmap::DefaultKey {
         self.0
     }
 }
 impl PassScope for Function {
-    fn get_arena_idx(&self) -> generational_arena::Index {
+    fn get_arena_idx(&self) -> slotmap::DefaultKey {
         self.0
     }
 }
@@ -77,7 +77,7 @@ impl Pass {
 #[derive(Default)]
 pub struct AnalysisResults {
     // Hash from (AnalysisResultT, (PassScope, Scope Identity)) to an actual result.
-    results: FxHashMap<(TypeId, (TypeId, generational_arena::Index)), AnalysisResult>,
+    results: FxHashMap<(TypeId, (TypeId, slotmap::DefaultKey)), AnalysisResult>,
     name_typeid_map: FxHashMap<&'static str, TypeId>,
 }
 

diff --git a/sway-ir/src/value.rs b/sway-ir/src/value.rs
@@ -19,10 +19,10 @@ use crate::{
     Block, Instruction,
 };
 
-/// A wrapper around an [ECS](https://github.com/fitzgen/generational-arena) handle into the
+/// A wrapper around an [ECS](https://github.com/orlp/slotmap) handle into the
 /// [`Context`].
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Hash, DebugWithContext)]
-pub struct Value(#[in_context(values)] pub generational_arena::Index);
+pub struct Value(#[in_context(values)] pub slotmap::DefaultKey);
 
 #[doc(hidden)]
 #[derive(Debug, Clone, DebugWithContext)]

diff --git a/sway-ir/src/verify.rs b/sway-ir/src/verify.rs
@@ -63,11 +63,8 @@ impl<'eng> Context<'eng> {
         if function.get_module(self) != cur_module {
             return Err(IrError::InconsistentParent(
                 function.get_name(self).into(),
-                format!("Module_Index_{:?}", cur_module.0.into_raw_parts()),
-                format!(
-                    "Module_Index_{:?}",
-                    function.get_module(self).0.into_raw_parts()
-                ),
+                format!("Module_Index_{:?}", cur_module.0),
+                format!("Module_Index_{:?}", function.get_module(self).0),
             ));
         }
         let entry_block = function.get_entry_block(self);
@@ -193,7 +190,7 @@ impl<'a, 'eng> InstructionVerifier<'a, 'eng> {
             if let ValueDatum::Instruction(instruction) = &value_content.value {
                 if instruction.parent != self.cur_block {
                     return Err(IrError::InconsistentParent(
-                        format!("Instr_{:?}", ins.0.into_raw_parts()),
+                        format!("Instr_{:?}", ins.0),
                         self.cur_block.get_label(self.context),
                         instruction.parent.get_label(self.context),
                     ));