Struct mmtk::vm::object_model::specs::VMLocalPinningBitSpec

pub struct VMLocalPinningBitSpec(MetadataSpec);

1-bit local metadata for spaces that support pinning.

Tuple Fields

0: MetadataSpec

Implementations

impl VMLocalPinningBitSpec

pub fn pin_object<VM: VMBinding>(&self, object: ObjectReference) -> bool

Pin an object by setting the pinning bit to 1. Return true if the object is pinned in this operation.

pub fn unpin_object<VM: VMBinding>(&self, object: ObjectReference) -> bool

Unpin an object by clearing the pinning bit to 0. Return true if the object is unpinned in this operation.

pub fn is_object_pinned<VM: VMBinding>(&self, object: ObjectReference) -> bool

Check if an object is pinned.

impl VMLocalPinningBitSpec

pub const LOG_NUM_BITS: usize = 0usize

The number of bits (in log2) that are needed for the spec.

pub const IS_GLOBAL: bool = false

Whether this spec is global or local. For side metadata, the binding needs to make sure global specs are laid out after another global spec, and local specs are laid out after another local spec. Otherwise, there will be an assertion failure.

pub const fn in_header(bit_offset: isize) -> Self

Declare that the VM uses in-header metadata for this metadata type. For the specification of the bit_offset argument, please refer to the document of [crate::util::metadata::header_metadata::HeaderMetadataSpec.bit_offset]. The binding needs to make sure that the bits used for a spec in the header do not conflict with the bits of another spec (unless it is specified that some bits may be reused).

pub const fn side_first() -> Self

Declare that the VM uses side metadata for this metadata type, and the side metadata is the first of its kind (global or local). The first global or local side metadata should be declared with side_first(), and the rest side metadata should be declared with side_after() after a defined side metadata of the same kind (global or local). Logically, all the declarations create two list of side metadata, one for global, and one for local.

pub const fn side_after(spec: &MetadataSpec) -> Self

Declare that the VM uses side metadata for this metadata type, and the side metadata should be laid out after the given side metadata spec. The first global or local side metadata should be declared with side_first(), and the rest side metadata should be declared with side_after() after a defined side metadata of the same kind (global or local). Logically, all the declarations create two list of side metadata, one for global, and one for local.

pub const fn as_spec(&self) -> &MetadataSpec

Return the inner [crate::util::metadata::MetadataSpec] for the metadata type.

pub const fn num_bits(&self) -> usize

Return the number of bits for the metadata type.

Methods from Deref<Target = MetadataSpec>

pub fn is_on_side(&self) -> bool

Is this metadata stored in the side table?

pub fn is_in_header(&self) -> bool

Is this metadata stored in the object header?

pub fn extract_side_spec(&self) -> &SideMetadataSpec

Extract SideMetadataSpec from a MetadataSpec. Panics if this is not side metadata.

pub unsafe fn load<VM: VMBinding, T: MetadataValue>( &self, object: ObjectReference, mask: Option<T> ) -> T

A function to non-atomically load the specified metadata’s content. Returns the metadata value.

Arguments:

• object: is a reference to the target object.
• mask: is an optional mask value for the metadata. This value is used in cases like the forwarding pointer metadata, where some of the bits are reused by other metadata such as the forwarding bits.

Safety

This is a non-atomic load, thus not thread-safe.

pub fn load_atomic<VM: VMBinding, T: MetadataValue>( &self, object: ObjectReference, mask: Option<T>, ordering: Ordering ) -> T

A function to atomically load the specified metadata’s content. Returns the metadata value.

Arguments:

• object: is a reference to the target object.
• mask: is an optional mask value for the metadata. This value is used in cases like the forwarding pointer metadata, where some of the bits are reused by other metadata such as the forwarding bits.
• atomic_ordering: is the ordering for the load operation.

pub unsafe fn store<VM: VMBinding, T: MetadataValue>( &self, object: ObjectReference, val: T, mask: Option<T> )

A function to non-atomically store a value to the specified metadata.

Arguments:

• object: is a reference to the target object.
• val: is the new metadata value to be stored.
• mask: is an optional mask value for the metadata. This value is used in cases like the forwarding pointer metadata, where some of the bits are reused by other metadata such as the forwarding bits.

Safety

This is a non-atomic store, thus not thread-safe.

pub fn store_atomic<VM: VMBinding, T: MetadataValue>( &self, object: ObjectReference, val: T, mask: Option<T>, ordering: Ordering )

A function to atomically store a value to the specified metadata.

Arguments:

• object: is a reference to the target object.
• val: is the new metadata value to be stored.
• mask: is an optional mask value for the metadata. This value is used in cases like the forwarding pointer metadata, where some of the bits are reused by other metadata such as the forwarding bits.
• ordering: is the ordering for the store operation.

pub fn compare_exchange_metadata<VM: VMBinding, T: MetadataValue>( &self, object: ObjectReference, old_val: T, new_val: T, mask: Option<T>, success_order: Ordering, failure_order: Ordering ) -> Result<T, T>

A function to atomically compare-and-exchange the specified metadata’s content. Returns true if the operation is successful, and false otherwise.

Arguments:

• object: is a reference to the target object.
• old_val: is the expected current value of the metadata.
• new_val: is the new metadata value to be stored if the compare-and-exchange operation is successful.
• mask: is an optional mask value for the metadata. This value is used in cases like the forwarding pointer metadata, where some of the bits are reused by other metadata such as the forwarding bits.
• success_order: is the atomic ordering used if the operation is successful.
• failure_order: is the atomic ordering used if the operation fails.

pub fn fetch_add_metadata<VM: VMBinding, T: MetadataValue>( &self, object: ObjectReference, val: T, order: Ordering ) -> T

A function to atomically perform an add operation on the specified metadata’s content. Returns the old metadata value.

Arguments:

• object: is a reference to the target object.
• val: is the value to be added to the current value of the metadata.
• order: is the atomic ordering of the fetch-and-add operation.

pub fn fetch_sub_metadata<VM: VMBinding, T: MetadataValue>( &self, object: ObjectReference, val: T, order: Ordering ) -> T

A function to atomically perform a subtract operation on the specified metadata’s content. Returns the old metadata value.

Arguments:

• object: is a reference to the target object.
• val: is the value to be subtracted from the current value of the metadata.
• order: is the atomic ordering of the fetch-and-add operation.

pub fn fetch_and_metadata<VM: VMBinding, T: MetadataValue>( &self, object: ObjectReference, val: T, order: Ordering ) -> T

A function to atomically perform a bit-and operation on the specified metadata’s content. Returns the old metadata value.

Arguments:

• object: is a reference to the target object.
• val: is the value to bit-and with the current value of the metadata.
• order: is the atomic ordering of the fetch-and-add operation.

pub fn fetch_or_metadata<VM: VMBinding, T: MetadataValue>( &self, object: ObjectReference, val: T, order: Ordering ) -> T

A function to atomically perform a bit-or operation on the specified metadata’s content. Returns the old metadata value.

Arguments:

• object: is a reference to the target object.
• val: is the value to bit-or with the current value of the metadata.
• order: is the atomic ordering of the fetch-and-add operation.

pub fn fetch_update_metadata<VM: VMBinding, T: MetadataValue, F: FnMut(T) -> Option<T> + Copy>( &self, object: ObjectReference, set_order: Ordering, fetch_order: Ordering, f: F ) -> Result<T, T>

A function to atomically perform an update operation on the specified metadata’s content. The semantics are the same as Rust’s fetch_update on atomic types. Returns a Result of Ok(previous_value) if the function returned Some(_), else Err(previous_value).

Arguments:

• object: is a reference to the target object.
• val: is the value to bit-or with the current value of the metadata.
• order: is the atomic ordering of the fetch-and-add operation.
• f: the update function. The function may be called multiple times.

Trait Implementations

impl Deref for VMLocalPinningBitSpec

type Target = MetadataSpec

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.