Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[move] Move out tag cache (safe speculation) #15676

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+531 −44
Open

[move] Move out tag cache (safe speculation) #15676

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a8644c
[move] Move out tag cache (safe speculation)
georgemitenkov Jan 5, 2025
7eec28c
cleanup
georgemitenkov Jan 5, 2025
a4b33f5
address Rati's comments
georgemitenkov Jan 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 65 additions & 40 deletions third_party/move/move-vm/runtime/src/loader/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ use crate::{
storage::{
loader::LoaderV2, module_storage::FunctionValueExtensionAdapter,
struct_name_index_map::StructNameIndexMap, ty_cache::StructInfoCache,
ty_tag_cache::TypeTagBuilder,
},
};
pub use function::{Function, LoadedFunction};
Expand Down Expand Up @@ -1671,15 +1672,42 @@ pub const VALUE_DEPTH_MAX: u64 = 128;
/// fields for struct types.
const MAX_TYPE_TO_LAYOUT_NODES: u64 = 256;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hm, random thought but shouldn't such constants be defined in some more centralized place.. there should be something already, maybe @runtian-zhou ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we should put them in VM config or even gas schedule. I will moving this code around for lazy loading and V2 loader layout cache, so we can do it then.


struct PseudoGasContext {
pub(crate) struct PseudoGasContext {
// Parameters for metering type tag construction:
// - maximum allowed cost,
// - base cost for any type to tag conversion,
// - cost for size of a struct tag.
max_cost: u64,
cost: u64,
pub(crate) cost: u64,
cost_base: u64,
cost_per_byte: u64,
}

impl PseudoGasContext {
fn charge(&mut self, amount: u64) -> PartialVMResult<()> {
pub(crate) fn new(vm_config: &VMConfig) -> Self {
Self {
max_cost: vm_config.type_max_cost,
cost: 0,
cost_base: vm_config.type_base_cost,
cost_per_byte: vm_config.type_byte_cost,
}
}

pub(crate) fn current_cost(&mut self) -> u64 {
self.cost
}

pub(crate) fn charge_base(&mut self) -> PartialVMResult<()> {
self.charge(self.cost_base)
}

pub(crate) fn charge_struct_tag(&mut self, struct_tag: &StructTag) -> PartialVMResult<()> {
let size =
(struct_tag.address.len() + struct_tag.module.len() + struct_tag.name.len()) as u64;
self.charge(size * self.cost_per_byte)
}

pub(crate) fn charge(&mut self, amount: u64) -> PartialVMResult<()> {
self.cost += amount;
if self.cost > self.max_cost {
Err(
Expand All @@ -1694,38 +1722,34 @@ impl PseudoGasContext {
}
}

impl Loader {
impl LoaderV1 {
fn struct_name_to_type_tag(
&self,
struct_name_idx: StructNameIndex,
ty_args: &[Type],
gas_context: &mut PseudoGasContext,
module_storage: &dyn ModuleStorage,
) -> PartialVMResult<StructTag> {
let ty_cache = self.ty_cache(module_storage);
if let Some((struct_tag, gas)) = ty_cache.get_struct_tag(&struct_name_idx, ty_args) {
if let Some((struct_tag, gas)) = self.type_cache.get_struct_tag(&struct_name_idx, ty_args) {
gas_context.charge(gas)?;
return Ok(struct_tag.clone());
}

let cur_cost = gas_context.cost;
let cur_cost = gas_context.current_cost();

let type_args = ty_args
.iter()
.map(|ty| self.type_to_type_tag_impl(ty, gas_context, module_storage))
.map(|ty| self.type_to_type_tag_impl(ty, gas_context))
.collect::<PartialVMResult<Vec<_>>>()?;
let struct_tag = self
.name_cache
.idx_to_struct_tag(struct_name_idx, type_args)?;

let struct_name_index_map = self.struct_name_index_map(module_storage);
let struct_tag = struct_name_index_map.idx_to_struct_tag(struct_name_idx, type_args)?;

let size =
(struct_tag.address.len() + struct_tag.module.len() + struct_tag.name.len()) as u64;
gas_context.charge(size * gas_context.cost_per_byte)?;
ty_cache.store_struct_tag(
gas_context.charge_struct_tag(&struct_tag)?;
self.type_cache.store_struct_tag(
struct_name_idx,
ty_args.to_vec(),
struct_tag.clone(),
gas_context.cost - cur_cost,
gas_context.current_cost() - cur_cost,
);
Ok(struct_tag)
}
Expand All @@ -1734,9 +1758,8 @@ impl Loader {
&self,
ty: &Type,
gas_context: &mut PseudoGasContext,
module_storage: &dyn ModuleStorage,
) -> PartialVMResult<TypeTag> {
gas_context.charge(gas_context.cost_base)?;
gas_context.charge_base()?;
Ok(match ty {
Type::Bool => TypeTag::Bool,
Type::U8 => TypeTag::U8,
Expand All @@ -1748,17 +1771,16 @@ impl Loader {
Type::Address => TypeTag::Address,
Type::Signer => TypeTag::Signer,
Type::Vector(ty) => {
let el_ty_tag = self.type_to_type_tag_impl(ty, gas_context, module_storage)?;
let el_ty_tag = self.type_to_type_tag_impl(ty, gas_context)?;
TypeTag::Vector(Box::new(el_ty_tag))
},
Type::Struct { idx, .. } => TypeTag::Struct(Box::new(self.struct_name_to_type_tag(
*idx,
&[],
gas_context,
module_storage,
)?)),
Type::StructInstantiation { idx, ty_args, .. } => TypeTag::Struct(Box::new(
self.struct_name_to_type_tag(*idx, ty_args, gas_context, module_storage)?,
self.struct_name_to_type_tag(*idx, ty_args, gas_context)?,
)),
Type::Reference(_) | Type::MutableReference(_) | Type::TyParam(_) => {
return Err(
Expand All @@ -1768,7 +1790,9 @@ impl Loader {
},
})
}
}

impl Loader {
fn struct_name_to_type_layout(
&self,
struct_name_idx: StructNameIndex,
Expand Down Expand Up @@ -2057,18 +2081,16 @@ impl Loader {
}

let count_before = *count;
let mut gas_context = PseudoGasContext {
cost: 0,
max_cost: self.vm_config().type_max_cost,
cost_base: self.vm_config().type_base_cost,
cost_per_byte: self.vm_config().type_byte_cost,
let struct_tag = match self {
Loader::V1(loader) => {
let mut gas_context = PseudoGasContext::new(loader.vm_config());
loader.struct_name_to_type_tag(struct_name_idx, ty_args, &mut gas_context)?
},
Loader::V2(_) => {
let ty_tag_builder = TypeTagBuilder::new(module_storage.runtime_environment());
ty_tag_builder.struct_name_idx_to_struct_tag(&struct_name_idx, ty_args)?
},
};
let struct_tag = self.struct_name_to_type_tag(
struct_name_idx,
ty_args,
&mut gas_context,
module_storage,
)?;
let fields = struct_type.fields(None)?;

let field_layouts = fields
Expand Down Expand Up @@ -2263,13 +2285,16 @@ impl Loader {
ty: &Type,
module_storage: &dyn ModuleStorage,
) -> PartialVMResult<TypeTag> {
let mut gas_context = PseudoGasContext {
cost: 0,
max_cost: self.vm_config().type_max_cost,
cost_base: self.vm_config().type_base_cost,
cost_per_byte: self.vm_config().type_byte_cost,
};
self.type_to_type_tag_impl(ty, &mut gas_context, module_storage)
match self {
Loader::V1(loader) => {
let mut gas_context = PseudoGasContext::new(self.vm_config());
loader.type_to_type_tag_impl(ty, &mut gas_context)
},
Loader::V2(_) => {
let ty_tag_builder = TypeTagBuilder::new(module_storage.runtime_environment());
ty_tag_builder.ty_to_ty_tag(ty)
},
}
}

pub(crate) fn type_to_type_layout_with_identifier_mappings(
Expand Down
21 changes: 17 additions & 4 deletions third_party/move/move-vm/runtime/src/storage/environment.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use crate::{
native_functions::{NativeFunction, NativeFunctions},
storage::{
struct_name_index_map::StructNameIndexMap, ty_cache::StructInfoCache,
verified_module_cache::VERIFIED_MODULES_V2,
ty_tag_cache::TypeTagCache, verified_module_cache::VERIFIED_MODULES_V2,
},
Module, Script,
};
Expand Down Expand Up @@ -52,6 +52,10 @@ pub struct RuntimeEnvironment {
/// We wrap the index map into an [Arc] so that on republishing these clones are cheap.
struct_name_index_map: Arc<StructNameIndexMap>,

/// Caches struct tags for instantiated types. This cache can be used concurrently and
/// speculatively because type tag information does not change with module publishes.
ty_tag_cache: Arc<TypeTagCache>,

/// Type cache for struct layouts, tags and depths, shared across multiple threads.
///
/// SAFETY:
Expand Down Expand Up @@ -100,6 +104,7 @@ impl RuntimeEnvironment {
vm_config,
natives,
struct_name_index_map: Arc::new(StructNameIndexMap::empty()),
ty_tag_cache: Arc::new(TypeTagCache::empty()),
ty_cache: StructInfoCache::empty(),
}
}
Expand Down Expand Up @@ -261,6 +266,12 @@ impl RuntimeEnvironment {
&self.struct_name_index_map
}

/// Returns the type tag cache used by this environment to store already constructed struct
/// tags.
pub(crate) fn ty_tag_cache(&self) -> &TypeTagCache {
&self.ty_tag_cache
}

/// Returns the type cache owned by this runtime environment which stores information about
/// struct layouts, tags and depth formulae.
pub(crate) fn ty_cache(&self) -> &StructInfoCache {
Expand All @@ -276,6 +287,7 @@ impl RuntimeEnvironment {
/// Flushes the struct information (type) cache. Flushing this cache does not invalidate struct
/// name index map or module cache.
pub fn flush_struct_info_cache(&self) {
self.ty_tag_cache.flush();
self.ty_cache.flush();
}

Expand Down Expand Up @@ -307,14 +319,15 @@ impl RuntimeEnvironment {
}

impl Clone for RuntimeEnvironment {
/// Returns the cloned environment. Struct re-indexing map and type caches are cloned and no
/// longer shared with the original environment.
/// Returns the cloned environment.
fn clone(&self) -> Self {
Self {
vm_config: self.vm_config.clone(),
natives: self.natives.clone(),
struct_name_index_map: self.struct_name_index_map.clone(),
ty_cache: self.ty_cache.clone(),
// Cloning arcs below.
struct_name_index_map: self.struct_name_index_map.clone(),
ty_tag_cache: self.ty_tag_cache.clone(),
}
}
}
Expand Down
1 change: 1 addition & 0 deletions third_party/move/move-vm/runtime/src/storage/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
pub(crate) mod loader;
pub(crate) mod struct_name_index_map;
pub(crate) mod ty_cache;
pub(crate) mod ty_tag_cache;
mod verified_module_cache;

pub mod code_storage;
Expand Down
Loading
Loading