Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,10 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
smallvec = "*"
smallvec = "1.13.1"

[features]
default = []
std = []
# Optimize memory layout for slab allocators, reducing memory usage
slab-friendly = []
111 changes: 111 additions & 0 deletions benches/xarray_bench.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
#![feature(test)]

extern crate test;

use std::sync::Arc;

use test::{black_box, Bencher};
use xarray::XArray;

const DENSE_LEN: u64 = 100_000;
const SPARSE_LEN: u64 = 200_000;
const RANDOM_QUERIES: usize = 50_000;
const COW_WRITE_COUNT: u64 = 20_000;

fn build_dense(len: u64) -> XArray<Arc<u64>> {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..len {
xa.store(i, Arc::new(i));
}
xa
}

fn random_indices(len: u64, count: usize) -> Vec<u64> {
let mut seed = 0x1234_5678_9abc_def0_u64;
let mut out = Vec::with_capacity(count);
for _ in 0..count {
seed ^= seed << 7;
seed ^= seed >> 9;
seed ^= seed << 8;
out.push(seed % len);
}
out
}

#[bench]
fn bench_store_dense(b: &mut Bencher) {
b.iter(|| {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..DENSE_LEN {
xa.store(i, Arc::new(i));
}
black_box(xa);
});
}

#[bench]
fn bench_cursor_load_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cursor = xa.cursor(0);
let mut sum = 0_u64;
for _ in 0..DENSE_LEN {
if let Some(v) = cursor.load() {
sum = sum.wrapping_add(*v.as_ref());
}
cursor.next();
}
black_box(sum);
});
}

#[bench]
fn bench_load_random_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);
let indices = random_indices(DENSE_LEN, RANDOM_QUERIES);

b.iter(|| {
let mut sum = 0_u64;
for &idx in &indices {
if let Some(v) = xa.load(idx) {
sum = sum.wrapping_add(*v.as_ref());
}
}
black_box(sum);
});
}

#[bench]
fn bench_range_sparse_even(b: &mut Bencher) {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..SPARSE_LEN {
if i % 2 == 0 {
xa.store(i, Arc::new(i));
}
}

b.iter(|| {
let mut sum = 0_u64;
let mut cnt = 0_u64;
for (index, item) in xa.range(0..SPARSE_LEN) {
sum = sum.wrapping_add(index).wrapping_add(*item.as_ref());
cnt += 1;
}
black_box((sum, cnt));
});
}

#[bench]
fn bench_cow_clone_then_overwrite(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cloned = xa.clone();
for i in 0..COW_WRITE_COUNT {
let idx = (i * 7) % DENSE_LEN;
cloned.store(idx, Arc::new(i));
}
black_box(cloned.load(0));
});
}
25 changes: 19 additions & 6 deletions src/entry.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ use alloc::boxed::Box;
use alloc::sync::Arc;
use core::marker::PhantomData;
use core::mem::ManuallyDrop;
use core::ops::{Deref, Not};
use core::ops::Deref;

use crate::node::{TryClone, XNode};

Expand DownExpand Up@@ -67,7 +67,10 @@ impl<'a, T> Deref for ArcRef<'a, T> {

// SAFETY: `Arc<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Arc<T> {
type Ref<'a> = ArcRef<'a, T> where Self: 'a;
type Ref<'a>
= ArcRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -118,7 +121,10 @@ impl<'a, T> Deref for BoxRef<'a, T> {

// SAFETY: `Box<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Box<T> {
type Ref<'a> = BoxRef<'a, T> where Self: 'a;
type Ref<'a>
= BoxRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -214,9 +220,16 @@ impl<I: ItemEntry> XEntry<I> {
}

fn ty(&self) -> Option<EntryType> {
self.is_null()
.not()
.then(|| (self.raw.addr() & Self::TYPE_MASK).try_into().unwrap())
if self.is_null() {
return None;
}

let raw = self.raw.addr();
let tag = raw & Self::TYPE_MASK;
match tag.try_into() {
Ok(ty) => Some(ty),
Err(()) => panic!("xarray: invalid XEntry tag={tag:#x}, raw={raw:#x}"),
}
}

pub fn is_null(&self) -> bool {
Expand Down
23 changes: 22 additions & 1 deletion src/node.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
use core::cmp::Ordering;
#[cfg(feature = "slab-friendly")]
use core::convert::TryInto;
use core::ops::{Deref, DerefMut};

use crate::entry::{ItemEntry, XEntry};
Expand DownExpand Up@@ -103,7 +105,10 @@ where
offset_in_parent: u8,
/// The slots storing `XEntry`s, which point to user-given items for leaf nodes and other
/// `XNode`s for interior nodes.
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry<I>; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]>,
/// The marks representing whether each slot is marked or not.
///
/// Users can set mark or unset mark on user-given items, and a leaf node or an interior node
Expand All@@ -112,6 +117,16 @@ where
}

impl<I: ItemEntry> XNode<I> {
#[cfg(feature = "slab-friendly")]
fn empty_slots() -> alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]> {
let mut slots = alloc::vec::Vec::with_capacity(SLOT_SIZE);
slots.resize_with(SLOT_SIZE, || XEntry::EMPTY);
match slots.into_boxed_slice().try_into() {
Ok(slots) => slots,
Err(_) => panic!("xarray: invalid slab-friendly slot length"),
}
}

pub fn new_root(height: Height) -> Self {
Self::new(height, 0)
}
Expand All@@ -120,7 +135,10 @@ impl<I: ItemEntry> XNode<I> {
Self {
height,
offset_in_parent: offset,
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry::EMPTY; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: Self::empty_slots(),
marks: [Mark::EMPTY; NUM_MARKS],
}
}
Expand All@@ -147,7 +165,10 @@ impl<I: ItemEntry> XNode<I> {
}

pub fn entries_mut(&mut self) -> &mut [XEntry<I>] {
&mut self.slots
#[cfg(not(feature = "slab-friendly"))]
return &mut self.slots;
#[cfg(feature = "slab-friendly")]
return self.slots.as_mut();
}

pub fn is_marked(&self, offset: u8, mark: usize) -> bool {
Expand Down
48 changes: 48 additions & 0 deletions src/test.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,54 @@ fn test_store_overwrite() {
assert_eq!(*v.as_ref(), 40);
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_store_overwrite_remove() {
#[derive(Debug, Clone, PartialEq, Eq)]
struct Token(u32);

let mut xa: XArray<Arc<Token>> = XArray::new();
let shared = Arc::new(Token(7));

for i in 1..n!(256) {
xa.store(i as u64, shared.clone());
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).as_deref(), Some(&shared));
}

for i in 1..n!(256) {
xa.store(i as u64, Arc::new(Token((i % 251) as u32)));
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).unwrap().0, (i % 251) as u32);
}

for i in 1..n!(256) {
assert!(xa.remove(i as u64).is_some());
assert!(xa.load(i as u64).is_none());
}
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_cow_overwrite() {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 1..n!(128) {
xa.store(i as u64, Arc::new(i));
}

let mut cloned = xa.clone();
for i in 1..n!(128) {
cloned.store(i as u64, Arc::new(i * 3));
}

for i in 1..n!(128) {
assert_eq!(*xa.load(i as u64).unwrap().as_ref(), i);
assert_eq!(*cloned.load(i as u64).unwrap().as_ref(), i * 3);
}
}

#[test]
fn test_remove() {
let mut xarray_arc: XArray<Arc<i32>> = XArray::new();
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat: optimize XNode memory layout and refactor XEntry type resolution by fslongjin · Pull Request #14 · asterinas/xarray · GitHub
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,10 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
smallvec = "*"
smallvec = "1.13.1"

[features]
default = []
std = []
# Optimize memory layout for slab allocators, reducing memory usage
slab-friendly = []
111 changes: 111 additions & 0 deletions benches/xarray_bench.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
#![feature(test)]

extern crate test;

use std::sync::Arc;

use test::{black_box, Bencher};
use xarray::XArray;

const DENSE_LEN: u64 = 100_000;
const SPARSE_LEN: u64 = 200_000;
const RANDOM_QUERIES: usize = 50_000;
const COW_WRITE_COUNT: u64 = 20_000;

fn build_dense(len: u64) -> XArray<Arc<u64>> {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..len {
xa.store(i, Arc::new(i));
}
xa
}

fn random_indices(len: u64, count: usize) -> Vec<u64> {
let mut seed = 0x1234_5678_9abc_def0_u64;
let mut out = Vec::with_capacity(count);
for _ in 0..count {
seed ^= seed << 7;
seed ^= seed >> 9;
seed ^= seed << 8;
out.push(seed % len);
}
out
}

#[bench]
fn bench_store_dense(b: &mut Bencher) {
b.iter(|| {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..DENSE_LEN {
xa.store(i, Arc::new(i));
}
black_box(xa);
});
}

#[bench]
fn bench_cursor_load_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cursor = xa.cursor(0);
let mut sum = 0_u64;
for _ in 0..DENSE_LEN {
if let Some(v) = cursor.load() {
sum = sum.wrapping_add(*v.as_ref());
}
cursor.next();
}
black_box(sum);
});
}

#[bench]
fn bench_load_random_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);
let indices = random_indices(DENSE_LEN, RANDOM_QUERIES);

b.iter(|| {
let mut sum = 0_u64;
for &idx in &indices {
if let Some(v) = xa.load(idx) {
sum = sum.wrapping_add(*v.as_ref());
}
}
black_box(sum);
});
}

#[bench]
fn bench_range_sparse_even(b: &mut Bencher) {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..SPARSE_LEN {
if i % 2 == 0 {
xa.store(i, Arc::new(i));
}
}

b.iter(|| {
let mut sum = 0_u64;
let mut cnt = 0_u64;
for (index, item) in xa.range(0..SPARSE_LEN) {
sum = sum.wrapping_add(index).wrapping_add(*item.as_ref());
cnt += 1;
}
black_box((sum, cnt));
});
}

#[bench]
fn bench_cow_clone_then_overwrite(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cloned = xa.clone();
for i in 0..COW_WRITE_COUNT {
let idx = (i * 7) % DENSE_LEN;
cloned.store(idx, Arc::new(i));
}
black_box(cloned.load(0));
});
}
25 changes: 19 additions & 6 deletions src/entry.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ use alloc::boxed::Box;
use alloc::sync::Arc;
use core::marker::PhantomData;
use core::mem::ManuallyDrop;
use core::ops::{Deref, Not};
use core::ops::Deref;

use crate::node::{TryClone, XNode};

Expand DownExpand Up@@ -67,7 +67,10 @@ impl<'a, T> Deref for ArcRef<'a, T> {

// SAFETY: `Arc<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Arc<T> {
type Ref<'a> = ArcRef<'a, T> where Self: 'a;
type Ref<'a>
= ArcRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -118,7 +121,10 @@ impl<'a, T> Deref for BoxRef<'a, T> {

// SAFETY: `Box<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Box<T> {
type Ref<'a> = BoxRef<'a, T> where Self: 'a;
type Ref<'a>
= BoxRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -214,9 +220,16 @@ impl<I: ItemEntry> XEntry<I> {
}

fn ty(&self) -> Option<EntryType> {
self.is_null()
.not()
.then(|| (self.raw.addr() & Self::TYPE_MASK).try_into().unwrap())
if self.is_null() {
return None;
}

let raw = self.raw.addr();
let tag = raw & Self::TYPE_MASK;
match tag.try_into() {
Ok(ty) => Some(ty),
Err(()) => panic!("xarray: invalid XEntry tag={tag:#x}, raw={raw:#x}"),
}
}

pub fn is_null(&self) -> bool {
Expand Down
23 changes: 22 additions & 1 deletion src/node.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
use core::cmp::Ordering;
#[cfg(feature = "slab-friendly")]
use core::convert::TryInto;
use core::ops::{Deref, DerefMut};

use crate::entry::{ItemEntry, XEntry};
Expand DownExpand Up@@ -103,7 +105,10 @@ where
offset_in_parent: u8,
/// The slots storing `XEntry`s, which point to user-given items for leaf nodes and other
/// `XNode`s for interior nodes.
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry<I>; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]>,
/// The marks representing whether each slot is marked or not.
///
/// Users can set mark or unset mark on user-given items, and a leaf node or an interior node
Expand All@@ -112,6 +117,16 @@ where
}

impl<I: ItemEntry> XNode<I> {
#[cfg(feature = "slab-friendly")]
fn empty_slots() -> alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]> {
let mut slots = alloc::vec::Vec::with_capacity(SLOT_SIZE);
slots.resize_with(SLOT_SIZE, || XEntry::EMPTY);
match slots.into_boxed_slice().try_into() {
Ok(slots) => slots,
Err(_) => panic!("xarray: invalid slab-friendly slot length"),
}
}

pub fn new_root(height: Height) -> Self {
Self::new(height, 0)
}
Expand All@@ -120,7 +135,10 @@ impl<I: ItemEntry> XNode<I> {
Self {
height,
offset_in_parent: offset,
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry::EMPTY; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: Self::empty_slots(),
marks: [Mark::EMPTY; NUM_MARKS],
}
}
Expand All@@ -147,7 +165,10 @@ impl<I: ItemEntry> XNode<I> {
}

pub fn entries_mut(&mut self) -> &mut [XEntry<I>] {
&mut self.slots
#[cfg(not(feature = "slab-friendly"))]
return &mut self.slots;
#[cfg(feature = "slab-friendly")]
return self.slots.as_mut();
}

pub fn is_marked(&self, offset: u8, mark: usize) -> bool {
Expand Down
48 changes: 48 additions & 0 deletions src/test.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,54 @@ fn test_store_overwrite() {
assert_eq!(*v.as_ref(), 40);
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_store_overwrite_remove() {
#[derive(Debug, Clone, PartialEq, Eq)]
struct Token(u32);

let mut xa: XArray<Arc<Token>> = XArray::new();
let shared = Arc::new(Token(7));

for i in 1..n!(256) {
xa.store(i as u64, shared.clone());
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).as_deref(), Some(&shared));
}

for i in 1..n!(256) {
xa.store(i as u64, Arc::new(Token((i % 251) as u32)));
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).unwrap().0, (i % 251) as u32);
}

for i in 1..n!(256) {
assert!(xa.remove(i as u64).is_some());
assert!(xa.load(i as u64).is_none());
}
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_cow_overwrite() {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 1..n!(128) {
xa.store(i as u64, Arc::new(i));
}

let mut cloned = xa.clone();
for i in 1..n!(128) {
cloned.store(i as u64, Arc::new(i * 3));
}

for i in 1..n!(128) {
assert_eq!(*xa.load(i as u64).unwrap().as_ref(), i);
assert_eq!(*cloned.load(i as u64).unwrap().as_ref(), i * 3);
}
}

#[test]
fn test_remove() {
let mut xarray_arc: XArray<Arc<i32>> = XArray::new();
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat: optimize XNode memory layout and refactor XEntry type resolution by fslongjin · Pull Request #14 · asterinas/xarray · GitHub
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,10 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
smallvec = "*"
smallvec = "1.13.1"

[features]
default = []
std = []
# Optimize memory layout for slab allocators, reducing memory usage
slab-friendly = []
111 changes: 111 additions & 0 deletions benches/xarray_bench.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
#![feature(test)]

extern crate test;

use std::sync::Arc;

use test::{black_box, Bencher};
use xarray::XArray;

const DENSE_LEN: u64 = 100_000;
const SPARSE_LEN: u64 = 200_000;
const RANDOM_QUERIES: usize = 50_000;
const COW_WRITE_COUNT: u64 = 20_000;

fn build_dense(len: u64) -> XArray<Arc<u64>> {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..len {
xa.store(i, Arc::new(i));
}
xa
}

fn random_indices(len: u64, count: usize) -> Vec<u64> {
let mut seed = 0x1234_5678_9abc_def0_u64;
let mut out = Vec::with_capacity(count);
for _ in 0..count {
seed ^= seed << 7;
seed ^= seed >> 9;
seed ^= seed << 8;
out.push(seed % len);
}
out
}

#[bench]
fn bench_store_dense(b: &mut Bencher) {
b.iter(|| {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..DENSE_LEN {
xa.store(i, Arc::new(i));
}
black_box(xa);
});
}

#[bench]
fn bench_cursor_load_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cursor = xa.cursor(0);
let mut sum = 0_u64;
for _ in 0..DENSE_LEN {
if let Some(v) = cursor.load() {
sum = sum.wrapping_add(*v.as_ref());
}
cursor.next();
}
black_box(sum);
});
}

#[bench]
fn bench_load_random_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);
let indices = random_indices(DENSE_LEN, RANDOM_QUERIES);

b.iter(|| {
let mut sum = 0_u64;
for &idx in &indices {
if let Some(v) = xa.load(idx) {
sum = sum.wrapping_add(*v.as_ref());
}
}
black_box(sum);
});
}

#[bench]
fn bench_range_sparse_even(b: &mut Bencher) {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..SPARSE_LEN {
if i % 2 == 0 {
xa.store(i, Arc::new(i));
}
}

b.iter(|| {
let mut sum = 0_u64;
let mut cnt = 0_u64;
for (index, item) in xa.range(0..SPARSE_LEN) {
sum = sum.wrapping_add(index).wrapping_add(*item.as_ref());
cnt += 1;
}
black_box((sum, cnt));
});
}

#[bench]
fn bench_cow_clone_then_overwrite(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cloned = xa.clone();
for i in 0..COW_WRITE_COUNT {
let idx = (i * 7) % DENSE_LEN;
cloned.store(idx, Arc::new(i));
}
black_box(cloned.load(0));
});
}
25 changes: 19 additions & 6 deletions src/entry.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ use alloc::boxed::Box;
use alloc::sync::Arc;
use core::marker::PhantomData;
use core::mem::ManuallyDrop;
use core::ops::{Deref, Not};
use core::ops::Deref;

use crate::node::{TryClone, XNode};

Expand DownExpand Up@@ -67,7 +67,10 @@ impl<'a, T> Deref for ArcRef<'a, T> {

// SAFETY: `Arc<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Arc<T> {
type Ref<'a> = ArcRef<'a, T> where Self: 'a;
type Ref<'a>
= ArcRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -118,7 +121,10 @@ impl<'a, T> Deref for BoxRef<'a, T> {

// SAFETY: `Box<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Box<T> {
type Ref<'a> = BoxRef<'a, T> where Self: 'a;
type Ref<'a>
= BoxRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -214,9 +220,16 @@ impl<I: ItemEntry> XEntry<I> {
}

fn ty(&self) -> Option<EntryType> {
self.is_null()
.not()
.then(|| (self.raw.addr() & Self::TYPE_MASK).try_into().unwrap())
if self.is_null() {
return None;
}

let raw = self.raw.addr();
let tag = raw & Self::TYPE_MASK;
match tag.try_into() {
Ok(ty) => Some(ty),
Err(()) => panic!("xarray: invalid XEntry tag={tag:#x}, raw={raw:#x}"),
}
}

pub fn is_null(&self) -> bool {
Expand Down
23 changes: 22 additions & 1 deletion src/node.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
use core::cmp::Ordering;
#[cfg(feature = "slab-friendly")]
use core::convert::TryInto;
use core::ops::{Deref, DerefMut};

use crate::entry::{ItemEntry, XEntry};
Expand DownExpand Up@@ -103,7 +105,10 @@ where
offset_in_parent: u8,
/// The slots storing `XEntry`s, which point to user-given items for leaf nodes and other
/// `XNode`s for interior nodes.
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry<I>; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]>,
/// The marks representing whether each slot is marked or not.
///
/// Users can set mark or unset mark on user-given items, and a leaf node or an interior node
Expand All@@ -112,6 +117,16 @@ where
}

impl<I: ItemEntry> XNode<I> {
#[cfg(feature = "slab-friendly")]
fn empty_slots() -> alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]> {
let mut slots = alloc::vec::Vec::with_capacity(SLOT_SIZE);
slots.resize_with(SLOT_SIZE, || XEntry::EMPTY);
match slots.into_boxed_slice().try_into() {
Ok(slots) => slots,
Err(_) => panic!("xarray: invalid slab-friendly slot length"),
}
}

pub fn new_root(height: Height) -> Self {
Self::new(height, 0)
}
Expand All@@ -120,7 +135,10 @@ impl<I: ItemEntry> XNode<I> {
Self {
height,
offset_in_parent: offset,
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry::EMPTY; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: Self::empty_slots(),
marks: [Mark::EMPTY; NUM_MARKS],
}
}
Expand All@@ -147,7 +165,10 @@ impl<I: ItemEntry> XNode<I> {
}

pub fn entries_mut(&mut self) -> &mut [XEntry<I>] {
&mut self.slots
#[cfg(not(feature = "slab-friendly"))]
return &mut self.slots;
#[cfg(feature = "slab-friendly")]
return self.slots.as_mut();
}

pub fn is_marked(&self, offset: u8, mark: usize) -> bool {
Expand Down
48 changes: 48 additions & 0 deletions src/test.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,54 @@ fn test_store_overwrite() {
assert_eq!(*v.as_ref(), 40);
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_store_overwrite_remove() {
#[derive(Debug, Clone, PartialEq, Eq)]
struct Token(u32);

let mut xa: XArray<Arc<Token>> = XArray::new();
let shared = Arc::new(Token(7));

for i in 1..n!(256) {
xa.store(i as u64, shared.clone());
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).as_deref(), Some(&shared));
}

for i in 1..n!(256) {
xa.store(i as u64, Arc::new(Token((i % 251) as u32)));
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).unwrap().0, (i % 251) as u32);
}

for i in 1..n!(256) {
assert!(xa.remove(i as u64).is_some());
assert!(xa.load(i as u64).is_none());
}
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_cow_overwrite() {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 1..n!(128) {
xa.store(i as u64, Arc::new(i));
}

let mut cloned = xa.clone();
for i in 1..n!(128) {
cloned.store(i as u64, Arc::new(i * 3));
}

for i in 1..n!(128) {
assert_eq!(*xa.load(i as u64).unwrap().as_ref(), i);
assert_eq!(*cloned.load(i as u64).unwrap().as_ref(), i * 3);
}
}

#[test]
fn test_remove() {
let mut xarray_arc: XArray<Arc<i32>> = XArray::new();
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat: optimize XNode memory layout and refactor XEntry type resolution by fslongjin · Pull Request #14 · asterinas/xarray · GitHub
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,10 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
smallvec = "*"
smallvec = "1.13.1"

[features]
default = []
std = []
# Optimize memory layout for slab allocators, reducing memory usage
slab-friendly = []
111 changes: 111 additions & 0 deletions benches/xarray_bench.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
#![feature(test)]

extern crate test;

use std::sync::Arc;

use test::{black_box, Bencher};
use xarray::XArray;

const DENSE_LEN: u64 = 100_000;
const SPARSE_LEN: u64 = 200_000;
const RANDOM_QUERIES: usize = 50_000;
const COW_WRITE_COUNT: u64 = 20_000;

fn build_dense(len: u64) -> XArray<Arc<u64>> {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..len {
xa.store(i, Arc::new(i));
}
xa
}

fn random_indices(len: u64, count: usize) -> Vec<u64> {
let mut seed = 0x1234_5678_9abc_def0_u64;
let mut out = Vec::with_capacity(count);
for _ in 0..count {
seed ^= seed << 7;
seed ^= seed >> 9;
seed ^= seed << 8;
out.push(seed % len);
}
out
}

#[bench]
fn bench_store_dense(b: &mut Bencher) {
b.iter(|| {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..DENSE_LEN {
xa.store(i, Arc::new(i));
}
black_box(xa);
});
}

#[bench]
fn bench_cursor_load_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cursor = xa.cursor(0);
let mut sum = 0_u64;
for _ in 0..DENSE_LEN {
if let Some(v) = cursor.load() {
sum = sum.wrapping_add(*v.as_ref());
}
cursor.next();
}
black_box(sum);
});
}

#[bench]
fn bench_load_random_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);
let indices = random_indices(DENSE_LEN, RANDOM_QUERIES);

b.iter(|| {
let mut sum = 0_u64;
for &idx in &indices {
if let Some(v) = xa.load(idx) {
sum = sum.wrapping_add(*v.as_ref());
}
}
black_box(sum);
});
}

#[bench]
fn bench_range_sparse_even(b: &mut Bencher) {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..SPARSE_LEN {
if i % 2 == 0 {
xa.store(i, Arc::new(i));
}
}

b.iter(|| {
let mut sum = 0_u64;
let mut cnt = 0_u64;
for (index, item) in xa.range(0..SPARSE_LEN) {
sum = sum.wrapping_add(index).wrapping_add(*item.as_ref());
cnt += 1;
}
black_box((sum, cnt));
});
}

#[bench]
fn bench_cow_clone_then_overwrite(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cloned = xa.clone();
for i in 0..COW_WRITE_COUNT {
let idx = (i * 7) % DENSE_LEN;
cloned.store(idx, Arc::new(i));
}
black_box(cloned.load(0));
});
}
25 changes: 19 additions & 6 deletions src/entry.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ use alloc::boxed::Box;
use alloc::sync::Arc;
use core::marker::PhantomData;
use core::mem::ManuallyDrop;
use core::ops::{Deref, Not};
use core::ops::Deref;

use crate::node::{TryClone, XNode};

Expand DownExpand Up@@ -67,7 +67,10 @@ impl<'a, T> Deref for ArcRef<'a, T> {

// SAFETY: `Arc<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Arc<T> {
type Ref<'a> = ArcRef<'a, T> where Self: 'a;
type Ref<'a>
= ArcRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -118,7 +121,10 @@ impl<'a, T> Deref for BoxRef<'a, T> {

// SAFETY: `Box<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Box<T> {
type Ref<'a> = BoxRef<'a, T> where Self: 'a;
type Ref<'a>
= BoxRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -214,9 +220,16 @@ impl<I: ItemEntry> XEntry<I> {
}

fn ty(&self) -> Option<EntryType> {
self.is_null()
.not()
.then(|| (self.raw.addr() & Self::TYPE_MASK).try_into().unwrap())
if self.is_null() {
return None;
}

let raw = self.raw.addr();
let tag = raw & Self::TYPE_MASK;
match tag.try_into() {
Ok(ty) => Some(ty),
Err(()) => panic!("xarray: invalid XEntry tag={tag:#x}, raw={raw:#x}"),
}
}

pub fn is_null(&self) -> bool {
Expand Down
23 changes: 22 additions & 1 deletion src/node.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
use core::cmp::Ordering;
#[cfg(feature = "slab-friendly")]
use core::convert::TryInto;
use core::ops::{Deref, DerefMut};

use crate::entry::{ItemEntry, XEntry};
Expand DownExpand Up@@ -103,7 +105,10 @@ where
offset_in_parent: u8,
/// The slots storing `XEntry`s, which point to user-given items for leaf nodes and other
/// `XNode`s for interior nodes.
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry<I>; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]>,
/// The marks representing whether each slot is marked or not.
///
/// Users can set mark or unset mark on user-given items, and a leaf node or an interior node
Expand All@@ -112,6 +117,16 @@ where
}

impl<I: ItemEntry> XNode<I> {
#[cfg(feature = "slab-friendly")]
fn empty_slots() -> alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]> {
let mut slots = alloc::vec::Vec::with_capacity(SLOT_SIZE);
slots.resize_with(SLOT_SIZE, || XEntry::EMPTY);
match slots.into_boxed_slice().try_into() {
Ok(slots) => slots,
Err(_) => panic!("xarray: invalid slab-friendly slot length"),
}
}

pub fn new_root(height: Height) -> Self {
Self::new(height, 0)
}
Expand All@@ -120,7 +135,10 @@ impl<I: ItemEntry> XNode<I> {
Self {
height,
offset_in_parent: offset,
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry::EMPTY; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: Self::empty_slots(),
marks: [Mark::EMPTY; NUM_MARKS],
}
}
Expand All@@ -147,7 +165,10 @@ impl<I: ItemEntry> XNode<I> {
}

pub fn entries_mut(&mut self) -> &mut [XEntry<I>] {
&mut self.slots
#[cfg(not(feature = "slab-friendly"))]
return &mut self.slots;
#[cfg(feature = "slab-friendly")]
return self.slots.as_mut();
}

pub fn is_marked(&self, offset: u8, mark: usize) -> bool {
Expand Down
48 changes: 48 additions & 0 deletions src/test.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,54 @@ fn test_store_overwrite() {
assert_eq!(*v.as_ref(), 40);
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_store_overwrite_remove() {
#[derive(Debug, Clone, PartialEq, Eq)]
struct Token(u32);

let mut xa: XArray<Arc<Token>> = XArray::new();
let shared = Arc::new(Token(7));

for i in 1..n!(256) {
xa.store(i as u64, shared.clone());
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).as_deref(), Some(&shared));
}

for i in 1..n!(256) {
xa.store(i as u64, Arc::new(Token((i % 251) as u32)));
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).unwrap().0, (i % 251) as u32);
}

for i in 1..n!(256) {
assert!(xa.remove(i as u64).is_some());
assert!(xa.load(i as u64).is_none());
}
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_cow_overwrite() {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 1..n!(128) {
xa.store(i as u64, Arc::new(i));
}

let mut cloned = xa.clone();
for i in 1..n!(128) {
cloned.store(i as u64, Arc::new(i * 3));
}

for i in 1..n!(128) {
assert_eq!(*xa.load(i as u64).unwrap().as_ref(), i);
assert_eq!(*cloned.load(i as u64).unwrap().as_ref(), i * 3);
}
}

#[test]
fn test_remove() {
let mut xarray_arc: XArray<Arc<i32>> = XArray::new();
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' feat: optimize XNode memory layout and refactor XEntry type resolution by fslongjin · Pull Request #14 · asterinas/xarray · GitHub
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,10 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
smallvec = "*"
smallvec = "1.13.1"

[features]
default = []
std = []
# Optimize memory layout for slab allocators, reducing memory usage
slab-friendly = []
111 changes: 111 additions & 0 deletions benches/xarray_bench.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
#![feature(test)]

extern crate test;

use std::sync::Arc;

use test::{black_box, Bencher};
use xarray::XArray;

const DENSE_LEN: u64 = 100_000;
const SPARSE_LEN: u64 = 200_000;
const RANDOM_QUERIES: usize = 50_000;
const COW_WRITE_COUNT: u64 = 20_000;

fn build_dense(len: u64) -> XArray<Arc<u64>> {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..len {
xa.store(i, Arc::new(i));
}
xa
}

fn random_indices(len: u64, count: usize) -> Vec<u64> {
let mut seed = 0x1234_5678_9abc_def0_u64;
let mut out = Vec::with_capacity(count);
for _ in 0..count {
seed ^= seed << 7;
seed ^= seed >> 9;
seed ^= seed << 8;
out.push(seed % len);
}
out
}

#[bench]
fn bench_store_dense(b: &mut Bencher) {
b.iter(|| {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..DENSE_LEN {
xa.store(i, Arc::new(i));
}
black_box(xa);
});
}

#[bench]
fn bench_cursor_load_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cursor = xa.cursor(0);
let mut sum = 0_u64;
for _ in 0..DENSE_LEN {
if let Some(v) = cursor.load() {
sum = sum.wrapping_add(*v.as_ref());
}
cursor.next();
}
black_box(sum);
});
}

#[bench]
fn bench_load_random_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);
let indices = random_indices(DENSE_LEN, RANDOM_QUERIES);

b.iter(|| {
let mut sum = 0_u64;
for &idx in &indices {
if let Some(v) = xa.load(idx) {
sum = sum.wrapping_add(*v.as_ref());
}
}
black_box(sum);
});
}

#[bench]
fn bench_range_sparse_even(b: &mut Bencher) {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..SPARSE_LEN {
if i % 2 == 0 {
xa.store(i, Arc::new(i));
}
}

b.iter(|| {
let mut sum = 0_u64;
let mut cnt = 0_u64;
for (index, item) in xa.range(0..SPARSE_LEN) {
sum = sum.wrapping_add(index).wrapping_add(*item.as_ref());
cnt += 1;
}
black_box((sum, cnt));
});
}

#[bench]
fn bench_cow_clone_then_overwrite(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cloned = xa.clone();
for i in 0..COW_WRITE_COUNT {
let idx = (i * 7) % DENSE_LEN;
cloned.store(idx, Arc::new(i));
}
black_box(cloned.load(0));
});
}
25 changes: 19 additions & 6 deletions src/entry.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ use alloc::boxed::Box;
use alloc::sync::Arc;
use core::marker::PhantomData;
use core::mem::ManuallyDrop;
use core::ops::{Deref, Not};
use core::ops::Deref;

use crate::node::{TryClone, XNode};

Expand DownExpand Up@@ -67,7 +67,10 @@ impl<'a, T> Deref for ArcRef<'a, T> {

// SAFETY: `Arc<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Arc<T> {
type Ref<'a> = ArcRef<'a, T> where Self: 'a;
type Ref<'a>
= ArcRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -118,7 +121,10 @@ impl<'a, T> Deref for BoxRef<'a, T> {

// SAFETY: `Box<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Box<T> {
type Ref<'a> = BoxRef<'a, T> where Self: 'a;
type Ref<'a>
= BoxRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -214,9 +220,16 @@ impl<I: ItemEntry> XEntry<I> {
}

fn ty(&self) -> Option<EntryType> {
self.is_null()
.not()
.then(|| (self.raw.addr() & Self::TYPE_MASK).try_into().unwrap())
if self.is_null() {
return None;
}

let raw = self.raw.addr();
let tag = raw & Self::TYPE_MASK;
match tag.try_into() {
Ok(ty) => Some(ty),
Err(()) => panic!("xarray: invalid XEntry tag={tag:#x}, raw={raw:#x}"),
}
}

pub fn is_null(&self) -> bool {
Expand Down
23 changes: 22 additions & 1 deletion src/node.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
use core::cmp::Ordering;
#[cfg(feature = "slab-friendly")]
use core::convert::TryInto;
use core::ops::{Deref, DerefMut};

use crate::entry::{ItemEntry, XEntry};
Expand DownExpand Up@@ -103,7 +105,10 @@ where
offset_in_parent: u8,
/// The slots storing `XEntry`s, which point to user-given items for leaf nodes and other
/// `XNode`s for interior nodes.
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry<I>; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]>,
/// The marks representing whether each slot is marked or not.
///
/// Users can set mark or unset mark on user-given items, and a leaf node or an interior node
Expand All@@ -112,6 +117,16 @@ where
}

impl<I: ItemEntry> XNode<I> {
#[cfg(feature = "slab-friendly")]
fn empty_slots() -> alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]> {
let mut slots = alloc::vec::Vec::with_capacity(SLOT_SIZE);
slots.resize_with(SLOT_SIZE, || XEntry::EMPTY);
match slots.into_boxed_slice().try_into() {
Ok(slots) => slots,
Err(_) => panic!("xarray: invalid slab-friendly slot length"),
}
}

pub fn new_root(height: Height) -> Self {
Self::new(height, 0)
}
Expand All@@ -120,7 +135,10 @@ impl<I: ItemEntry> XNode<I> {
Self {
height,
offset_in_parent: offset,
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry::EMPTY; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: Self::empty_slots(),
marks: [Mark::EMPTY; NUM_MARKS],
}
}
Expand All@@ -147,7 +165,10 @@ impl<I: ItemEntry> XNode<I> {
}

pub fn entries_mut(&mut self) -> &mut [XEntry<I>] {
&mut self.slots
#[cfg(not(feature = "slab-friendly"))]
return &mut self.slots;
#[cfg(feature = "slab-friendly")]
return self.slots.as_mut();
}

pub fn is_marked(&self, offset: u8, mark: usize) -> bool {
Expand Down
48 changes: 48 additions & 0 deletions src/test.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,54 @@ fn test_store_overwrite() {
assert_eq!(*v.as_ref(), 40);
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_store_overwrite_remove() {
#[derive(Debug, Clone, PartialEq, Eq)]
struct Token(u32);

let mut xa: XArray<Arc<Token>> = XArray::new();
let shared = Arc::new(Token(7));

for i in 1..n!(256) {
xa.store(i as u64, shared.clone());
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).as_deref(), Some(&shared));
}

for i in 1..n!(256) {
xa.store(i as u64, Arc::new(Token((i % 251) as u32)));
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).unwrap().0, (i % 251) as u32);
}

for i in 1..n!(256) {
assert!(xa.remove(i as u64).is_some());
assert!(xa.load(i as u64).is_none());
}
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_cow_overwrite() {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 1..n!(128) {
xa.store(i as u64, Arc::new(i));
}

let mut cloned = xa.clone();
for i in 1..n!(128) {
cloned.store(i as u64, Arc::new(i * 3));
}

for i in 1..n!(128) {
assert_eq!(*xa.load(i as u64).unwrap().as_ref(), i);
assert_eq!(*cloned.load(i as u64).unwrap().as_ref(), i * 3);
}
}

#[test]
fn test_remove() {
let mut xarray_arc: XArray<Arc<i32>> = XArray::new();
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat: optimize XNode memory layout and refactor XEntry type resolution by fslongjin · Pull Request #14 · asterinas/xarray · GitHub
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,10 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
smallvec = "*"
smallvec = "1.13.1"

[features]
default = []
std = []
# Optimize memory layout for slab allocators, reducing memory usage
slab-friendly = []
111 changes: 111 additions & 0 deletions benches/xarray_bench.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
#![feature(test)]

extern crate test;

use std::sync::Arc;

use test::{black_box, Bencher};
use xarray::XArray;

const DENSE_LEN: u64 = 100_000;
const SPARSE_LEN: u64 = 200_000;
const RANDOM_QUERIES: usize = 50_000;
const COW_WRITE_COUNT: u64 = 20_000;

fn build_dense(len: u64) -> XArray<Arc<u64>> {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..len {
xa.store(i, Arc::new(i));
}
xa
}

fn random_indices(len: u64, count: usize) -> Vec<u64> {
let mut seed = 0x1234_5678_9abc_def0_u64;
let mut out = Vec::with_capacity(count);
for _ in 0..count {
seed ^= seed << 7;
seed ^= seed >> 9;
seed ^= seed << 8;
out.push(seed % len);
}
out
}

#[bench]
fn bench_store_dense(b: &mut Bencher) {
b.iter(|| {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..DENSE_LEN {
xa.store(i, Arc::new(i));
}
black_box(xa);
});
}

#[bench]
fn bench_cursor_load_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cursor = xa.cursor(0);
let mut sum = 0_u64;
for _ in 0..DENSE_LEN {
if let Some(v) = cursor.load() {
sum = sum.wrapping_add(*v.as_ref());
}
cursor.next();
}
black_box(sum);
});
}

#[bench]
fn bench_load_random_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);
let indices = random_indices(DENSE_LEN, RANDOM_QUERIES);

b.iter(|| {
let mut sum = 0_u64;
for &idx in &indices {
if let Some(v) = xa.load(idx) {
sum = sum.wrapping_add(*v.as_ref());
}
}
black_box(sum);
});
}

#[bench]
fn bench_range_sparse_even(b: &mut Bencher) {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..SPARSE_LEN {
if i % 2 == 0 {
xa.store(i, Arc::new(i));
}
}

b.iter(|| {
let mut sum = 0_u64;
let mut cnt = 0_u64;
for (index, item) in xa.range(0..SPARSE_LEN) {
sum = sum.wrapping_add(index).wrapping_add(*item.as_ref());
cnt += 1;
}
black_box((sum, cnt));
});
}

#[bench]
fn bench_cow_clone_then_overwrite(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cloned = xa.clone();
for i in 0..COW_WRITE_COUNT {
let idx = (i * 7) % DENSE_LEN;
cloned.store(idx, Arc::new(i));
}
black_box(cloned.load(0));
});
}
25 changes: 19 additions & 6 deletions src/entry.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ use alloc::boxed::Box;
use alloc::sync::Arc;
use core::marker::PhantomData;
use core::mem::ManuallyDrop;
use core::ops::{Deref, Not};
use core::ops::Deref;

use crate::node::{TryClone, XNode};

Expand DownExpand Up@@ -67,7 +67,10 @@ impl<'a, T> Deref for ArcRef<'a, T> {

// SAFETY: `Arc<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Arc<T> {
type Ref<'a> = ArcRef<'a, T> where Self: 'a;
type Ref<'a>
= ArcRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -118,7 +121,10 @@ impl<'a, T> Deref for BoxRef<'a, T> {

// SAFETY: `Box<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Box<T> {
type Ref<'a> = BoxRef<'a, T> where Self: 'a;
type Ref<'a>
= BoxRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -214,9 +220,16 @@ impl<I: ItemEntry> XEntry<I> {
}

fn ty(&self) -> Option<EntryType> {
self.is_null()
.not()
.then(|| (self.raw.addr() & Self::TYPE_MASK).try_into().unwrap())
if self.is_null() {
return None;
}

let raw = self.raw.addr();
let tag = raw & Self::TYPE_MASK;
match tag.try_into() {
Ok(ty) => Some(ty),
Err(()) => panic!("xarray: invalid XEntry tag={tag:#x}, raw={raw:#x}"),
}
}

pub fn is_null(&self) -> bool {
Expand Down
23 changes: 22 additions & 1 deletion src/node.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
use core::cmp::Ordering;
#[cfg(feature = "slab-friendly")]
use core::convert::TryInto;
use core::ops::{Deref, DerefMut};

use crate::entry::{ItemEntry, XEntry};
Expand DownExpand Up@@ -103,7 +105,10 @@ where
offset_in_parent: u8,
/// The slots storing `XEntry`s, which point to user-given items for leaf nodes and other
/// `XNode`s for interior nodes.
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry<I>; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]>,
/// The marks representing whether each slot is marked or not.
///
/// Users can set mark or unset mark on user-given items, and a leaf node or an interior node
Expand All@@ -112,6 +117,16 @@ where
}

impl<I: ItemEntry> XNode<I> {
#[cfg(feature = "slab-friendly")]
fn empty_slots() -> alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]> {
let mut slots = alloc::vec::Vec::with_capacity(SLOT_SIZE);
slots.resize_with(SLOT_SIZE, || XEntry::EMPTY);
match slots.into_boxed_slice().try_into() {
Ok(slots) => slots,
Err(_) => panic!("xarray: invalid slab-friendly slot length"),
}
}

pub fn new_root(height: Height) -> Self {
Self::new(height, 0)
}
Expand All@@ -120,7 +135,10 @@ impl<I: ItemEntry> XNode<I> {
Self {
height,
offset_in_parent: offset,
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry::EMPTY; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: Self::empty_slots(),
marks: [Mark::EMPTY; NUM_MARKS],
}
}
Expand All@@ -147,7 +165,10 @@ impl<I: ItemEntry> XNode<I> {
}

pub fn entries_mut(&mut self) -> &mut [XEntry<I>] {
&mut self.slots
#[cfg(not(feature = "slab-friendly"))]
return &mut self.slots;
#[cfg(feature = "slab-friendly")]
return self.slots.as_mut();
}

pub fn is_marked(&self, offset: u8, mark: usize) -> bool {
Expand Down
48 changes: 48 additions & 0 deletions src/test.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,54 @@ fn test_store_overwrite() {
assert_eq!(*v.as_ref(), 40);
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_store_overwrite_remove() {
#[derive(Debug, Clone, PartialEq, Eq)]
struct Token(u32);

let mut xa: XArray<Arc<Token>> = XArray::new();
let shared = Arc::new(Token(7));

for i in 1..n!(256) {
xa.store(i as u64, shared.clone());
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).as_deref(), Some(&shared));
}

for i in 1..n!(256) {
xa.store(i as u64, Arc::new(Token((i % 251) as u32)));
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).unwrap().0, (i % 251) as u32);
}

for i in 1..n!(256) {
assert!(xa.remove(i as u64).is_some());
assert!(xa.load(i as u64).is_none());
}
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_cow_overwrite() {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 1..n!(128) {
xa.store(i as u64, Arc::new(i));
}

let mut cloned = xa.clone();
for i in 1..n!(128) {
cloned.store(i as u64, Arc::new(i * 3));
}

for i in 1..n!(128) {
assert_eq!(*xa.load(i as u64).unwrap().as_ref(), i);
assert_eq!(*cloned.load(i as u64).unwrap().as_ref(), i * 3);
}
}

#[test]
fn test_remove() {
let mut xarray_arc: XArray<Arc<i32>> = XArray::new();
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat: optimize XNode memory layout and refactor XEntry type resolution by fslongjin · Pull Request #14 · asterinas/xarray · GitHub
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,10 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
smallvec = "*"
smallvec = "1.13.1"

[features]
default = []
std = []
# Optimize memory layout for slab allocators, reducing memory usage
slab-friendly = []
111 changes: 111 additions & 0 deletions benches/xarray_bench.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
#![feature(test)]

extern crate test;

use std::sync::Arc;

use test::{black_box, Bencher};
use xarray::XArray;

const DENSE_LEN: u64 = 100_000;
const SPARSE_LEN: u64 = 200_000;
const RANDOM_QUERIES: usize = 50_000;
const COW_WRITE_COUNT: u64 = 20_000;

fn build_dense(len: u64) -> XArray<Arc<u64>> {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..len {
xa.store(i, Arc::new(i));
}
xa
}

fn random_indices(len: u64, count: usize) -> Vec<u64> {
let mut seed = 0x1234_5678_9abc_def0_u64;
let mut out = Vec::with_capacity(count);
for _ in 0..count {
seed ^= seed << 7;
seed ^= seed >> 9;
seed ^= seed << 8;
out.push(seed % len);
}
out
}

#[bench]
fn bench_store_dense(b: &mut Bencher) {
b.iter(|| {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..DENSE_LEN {
xa.store(i, Arc::new(i));
}
black_box(xa);
});
}

#[bench]
fn bench_cursor_load_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cursor = xa.cursor(0);
let mut sum = 0_u64;
for _ in 0..DENSE_LEN {
if let Some(v) = cursor.load() {
sum = sum.wrapping_add(*v.as_ref());
}
cursor.next();
}
black_box(sum);
});
}

#[bench]
fn bench_load_random_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);
let indices = random_indices(DENSE_LEN, RANDOM_QUERIES);

b.iter(|| {
let mut sum = 0_u64;
for &idx in &indices {
if let Some(v) = xa.load(idx) {
sum = sum.wrapping_add(*v.as_ref());
}
}
black_box(sum);
});
}

#[bench]
fn bench_range_sparse_even(b: &mut Bencher) {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..SPARSE_LEN {
if i % 2 == 0 {
xa.store(i, Arc::new(i));
}
}

b.iter(|| {
let mut sum = 0_u64;
let mut cnt = 0_u64;
for (index, item) in xa.range(0..SPARSE_LEN) {
sum = sum.wrapping_add(index).wrapping_add(*item.as_ref());
cnt += 1;
}
black_box((sum, cnt));
});
}

#[bench]
fn bench_cow_clone_then_overwrite(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cloned = xa.clone();
for i in 0..COW_WRITE_COUNT {
let idx = (i * 7) % DENSE_LEN;
cloned.store(idx, Arc::new(i));
}
black_box(cloned.load(0));
});
}
25 changes: 19 additions & 6 deletions src/entry.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ use alloc::boxed::Box;
use alloc::sync::Arc;
use core::marker::PhantomData;
use core::mem::ManuallyDrop;
use core::ops::{Deref, Not};
use core::ops::Deref;

use crate::node::{TryClone, XNode};

Expand DownExpand Up@@ -67,7 +67,10 @@ impl<'a, T> Deref for ArcRef<'a, T> {

// SAFETY: `Arc<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Arc<T> {
type Ref<'a> = ArcRef<'a, T> where Self: 'a;
type Ref<'a>
= ArcRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -118,7 +121,10 @@ impl<'a, T> Deref for BoxRef<'a, T> {

// SAFETY: `Box<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Box<T> {
type Ref<'a> = BoxRef<'a, T> where Self: 'a;
type Ref<'a>
= BoxRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -214,9 +220,16 @@ impl<I: ItemEntry> XEntry<I> {
}

fn ty(&self) -> Option<EntryType> {
self.is_null()
.not()
.then(|| (self.raw.addr() & Self::TYPE_MASK).try_into().unwrap())
if self.is_null() {
return None;
}

let raw = self.raw.addr();
let tag = raw & Self::TYPE_MASK;
match tag.try_into() {
Ok(ty) => Some(ty),
Err(()) => panic!("xarray: invalid XEntry tag={tag:#x}, raw={raw:#x}"),
}
}

pub fn is_null(&self) -> bool {
Expand Down
23 changes: 22 additions & 1 deletion src/node.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
use core::cmp::Ordering;
#[cfg(feature = "slab-friendly")]
use core::convert::TryInto;
use core::ops::{Deref, DerefMut};

use crate::entry::{ItemEntry, XEntry};
Expand DownExpand Up@@ -103,7 +105,10 @@ where
offset_in_parent: u8,
/// The slots storing `XEntry`s, which point to user-given items for leaf nodes and other
/// `XNode`s for interior nodes.
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry<I>; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]>,
/// The marks representing whether each slot is marked or not.
///
/// Users can set mark or unset mark on user-given items, and a leaf node or an interior node
Expand All@@ -112,6 +117,16 @@ where
}

impl<I: ItemEntry> XNode<I> {
#[cfg(feature = "slab-friendly")]
fn empty_slots() -> alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]> {
let mut slots = alloc::vec::Vec::with_capacity(SLOT_SIZE);
slots.resize_with(SLOT_SIZE, || XEntry::EMPTY);
match slots.into_boxed_slice().try_into() {
Ok(slots) => slots,
Err(_) => panic!("xarray: invalid slab-friendly slot length"),
}
}

pub fn new_root(height: Height) -> Self {
Self::new(height, 0)
}
Expand All@@ -120,7 +135,10 @@ impl<I: ItemEntry> XNode<I> {
Self {
height,
offset_in_parent: offset,
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry::EMPTY; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: Self::empty_slots(),
marks: [Mark::EMPTY; NUM_MARKS],
}
}
Expand All@@ -147,7 +165,10 @@ impl<I: ItemEntry> XNode<I> {
}

pub fn entries_mut(&mut self) -> &mut [XEntry<I>] {
&mut self.slots
#[cfg(not(feature = "slab-friendly"))]
return &mut self.slots;
#[cfg(feature = "slab-friendly")]
return self.slots.as_mut();
}

pub fn is_marked(&self, offset: u8, mark: usize) -> bool {
Expand Down
48 changes: 48 additions & 0 deletions src/test.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,54 @@ fn test_store_overwrite() {
assert_eq!(*v.as_ref(), 40);
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_store_overwrite_remove() {
#[derive(Debug, Clone, PartialEq, Eq)]
struct Token(u32);

let mut xa: XArray<Arc<Token>> = XArray::new();
let shared = Arc::new(Token(7));

for i in 1..n!(256) {
xa.store(i as u64, shared.clone());
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).as_deref(), Some(&shared));
}

for i in 1..n!(256) {
xa.store(i as u64, Arc::new(Token((i % 251) as u32)));
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).unwrap().0, (i % 251) as u32);
}

for i in 1..n!(256) {
assert!(xa.remove(i as u64).is_some());
assert!(xa.load(i as u64).is_none());
}
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_cow_overwrite() {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 1..n!(128) {
xa.store(i as u64, Arc::new(i));
}

let mut cloned = xa.clone();
for i in 1..n!(128) {
cloned.store(i as u64, Arc::new(i * 3));
}

for i in 1..n!(128) {
assert_eq!(*xa.load(i as u64).unwrap().as_ref(), i);
assert_eq!(*cloned.load(i as u64).unwrap().as_ref(), i * 3);
}
}

#[test]
fn test_remove() {
let mut xarray_arc: XArray<Arc<i32>> = XArray::new();
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); feat: optimize XNode memory layout and refactor XEntry type resolution by fslongjin · Pull Request #14 · asterinas/xarray · GitHub
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,10 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
smallvec = "*"
smallvec = "1.13.1"

[features]
default = []
std = []
# Optimize memory layout for slab allocators, reducing memory usage
slab-friendly = []
111 changes: 111 additions & 0 deletions benches/xarray_bench.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
#![feature(test)]

extern crate test;

use std::sync::Arc;

use test::{black_box, Bencher};
use xarray::XArray;

const DENSE_LEN: u64 = 100_000;
const SPARSE_LEN: u64 = 200_000;
const RANDOM_QUERIES: usize = 50_000;
const COW_WRITE_COUNT: u64 = 20_000;

fn build_dense(len: u64) -> XArray<Arc<u64>> {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..len {
xa.store(i, Arc::new(i));
}
xa
}

fn random_indices(len: u64, count: usize) -> Vec<u64> {
let mut seed = 0x1234_5678_9abc_def0_u64;
let mut out = Vec::with_capacity(count);
for _ in 0..count {
seed ^= seed << 7;
seed ^= seed >> 9;
seed ^= seed << 8;
out.push(seed % len);
}
out
}

#[bench]
fn bench_store_dense(b: &mut Bencher) {
b.iter(|| {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..DENSE_LEN {
xa.store(i, Arc::new(i));
}
black_box(xa);
});
}

#[bench]
fn bench_cursor_load_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cursor = xa.cursor(0);
let mut sum = 0_u64;
for _ in 0..DENSE_LEN {
if let Some(v) = cursor.load() {
sum = sum.wrapping_add(*v.as_ref());
}
cursor.next();
}
black_box(sum);
});
}

#[bench]
fn bench_load_random_dense(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);
let indices = random_indices(DENSE_LEN, RANDOM_QUERIES);

b.iter(|| {
let mut sum = 0_u64;
for &idx in &indices {
if let Some(v) = xa.load(idx) {
sum = sum.wrapping_add(*v.as_ref());
}
}
black_box(sum);
});
}

#[bench]
fn bench_range_sparse_even(b: &mut Bencher) {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 0..SPARSE_LEN {
if i % 2 == 0 {
xa.store(i, Arc::new(i));
}
}

b.iter(|| {
let mut sum = 0_u64;
let mut cnt = 0_u64;
for (index, item) in xa.range(0..SPARSE_LEN) {
sum = sum.wrapping_add(index).wrapping_add(*item.as_ref());
cnt += 1;
}
black_box((sum, cnt));
});
}

#[bench]
fn bench_cow_clone_then_overwrite(b: &mut Bencher) {
let xa = build_dense(DENSE_LEN);

b.iter(|| {
let mut cloned = xa.clone();
for i in 0..COW_WRITE_COUNT {
let idx = (i * 7) % DENSE_LEN;
cloned.store(idx, Arc::new(i));
}
black_box(cloned.load(0));
});
}
25 changes: 19 additions & 6 deletions src/entry.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ use alloc::boxed::Box;
use alloc::sync::Arc;
use core::marker::PhantomData;
use core::mem::ManuallyDrop;
use core::ops::{Deref, Not};
use core::ops::Deref;

use crate::node::{TryClone, XNode};

Expand DownExpand Up@@ -67,7 +67,10 @@ impl<'a, T> Deref for ArcRef<'a, T> {

// SAFETY: `Arc<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Arc<T> {
type Ref<'a> = ArcRef<'a, T> where Self: 'a;
type Ref<'a>
= ArcRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -118,7 +121,10 @@ impl<'a, T> Deref for BoxRef<'a, T> {

// SAFETY: `Box<T>` meets the safety requirements of `ItemEntry`.
unsafe impl<T> ItemEntry for Box<T> {
type Ref<'a> = BoxRef<'a, T> where Self: 'a;
type Ref<'a>
= BoxRef<'a, T>
where
Self: 'a;

fn into_raw(self) -> *const () {
// A contant expression, so compilers should be smart enough to optimize it away.
Expand DownExpand Up@@ -214,9 +220,16 @@ impl<I: ItemEntry> XEntry<I> {
}

fn ty(&self) -> Option<EntryType> {
self.is_null()
.not()
.then(|| (self.raw.addr() & Self::TYPE_MASK).try_into().unwrap())
if self.is_null() {
return None;
}

let raw = self.raw.addr();
let tag = raw & Self::TYPE_MASK;
match tag.try_into() {
Ok(ty) => Some(ty),
Err(()) => panic!("xarray: invalid XEntry tag={tag:#x}, raw={raw:#x}"),
}
}

pub fn is_null(&self) -> bool {
Expand Down
23 changes: 22 additions & 1 deletion src/node.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
use core::cmp::Ordering;
#[cfg(feature = "slab-friendly")]
use core::convert::TryInto;
use core::ops::{Deref, DerefMut};

use crate::entry::{ItemEntry, XEntry};
Expand DownExpand Up@@ -103,7 +105,10 @@ where
offset_in_parent: u8,
/// The slots storing `XEntry`s, which point to user-given items for leaf nodes and other
/// `XNode`s for interior nodes.
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry<I>; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]>,
/// The marks representing whether each slot is marked or not.
///
/// Users can set mark or unset mark on user-given items, and a leaf node or an interior node
Expand All@@ -112,6 +117,16 @@ where
}

impl<I: ItemEntry> XNode<I> {
#[cfg(feature = "slab-friendly")]
fn empty_slots() -> alloc::boxed::Box<[XEntry<I>; SLOT_SIZE]> {
let mut slots = alloc::vec::Vec::with_capacity(SLOT_SIZE);
slots.resize_with(SLOT_SIZE, || XEntry::EMPTY);
match slots.into_boxed_slice().try_into() {
Ok(slots) => slots,
Err(_) => panic!("xarray: invalid slab-friendly slot length"),
}
}

pub fn new_root(height: Height) -> Self {
Self::new(height, 0)
}
Expand All@@ -120,7 +135,10 @@ impl<I: ItemEntry> XNode<I> {
Self {
height,
offset_in_parent: offset,
#[cfg(not(feature = "slab-friendly"))]
slots: [XEntry::EMPTY; SLOT_SIZE],
#[cfg(feature = "slab-friendly")]
slots: Self::empty_slots(),
marks: [Mark::EMPTY; NUM_MARKS],
}
}
Expand All@@ -147,7 +165,10 @@ impl<I: ItemEntry> XNode<I> {
}

pub fn entries_mut(&mut self) -> &mut [XEntry<I>] {
&mut self.slots
#[cfg(not(feature = "slab-friendly"))]
return &mut self.slots;
#[cfg(feature = "slab-friendly")]
return self.slots.as_mut();
}

pub fn is_marked(&self, offset: u8, mark: usize) -> bool {
Expand Down
48 changes: 48 additions & 0 deletions src/test.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,54 @@ fn test_store_overwrite() {
assert_eq!(*v.as_ref(), 40);
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_store_overwrite_remove() {
#[derive(Debug, Clone, PartialEq, Eq)]
struct Token(u32);

let mut xa: XArray<Arc<Token>> = XArray::new();
let shared = Arc::new(Token(7));

for i in 1..n!(256) {
xa.store(i as u64, shared.clone());
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).as_deref(), Some(&shared));
}

for i in 1..n!(256) {
xa.store(i as u64, Arc::new(Token((i % 251) as u32)));
}
for i in 1..n!(256) {
assert_eq!(xa.load(i as u64).unwrap().0, (i % 251) as u32);
}

for i in 1..n!(256) {
assert!(xa.remove(i as u64).is_some());
assert!(xa.load(i as u64).is_none());
}
}

#[cfg(feature = "slab-friendly")]
#[test]
fn test_slab_friendly_cow_overwrite() {
let mut xa: XArray<Arc<u64>> = XArray::new();
for i in 1..n!(128) {
xa.store(i as u64, Arc::new(i));
}

let mut cloned = xa.clone();
for i in 1..n!(128) {
cloned.store(i as u64, Arc::new(i * 3));
}

for i in 1..n!(128) {
assert_eq!(*xa.load(i as u64).unwrap().as_ref(), i);
assert_eq!(*cloned.load(i as u64).unwrap().as_ref(), i * 3);
}
}

#[test]
fn test_remove() {
let mut xarray_arc: XArray<Arc<i32>> = XArray::new();
Expand Down