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

Address clippy lints #75

Merged
merged 5 commits into from
Jun 25, 2024
Merged

Address clippy lints #75

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8d1f393
Address clippy lints
caass Jun 14, 2024
435933f
Address code review comments
caass Jun 19, 2024
4165607
Try a different strategy for const null pointers
caass Jun 19, 2024
d22485f
Add rust-toolchain.toml
caass Jun 19, 2024
a39c9b1
Revert "Add rust-toolchain.toml"
caass Jun 25, 2024
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
2 changes: 1 addition & 1 deletion examples/arena.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,5 @@ impl<'arena> Arena<'arena> {
}

fn cmp_ref<T>(x: &T, y: &T) -> bool {
x as *const T as usize == y as *const T as usize
std::ptr::eq(x, y)
}
13 changes: 8 additions & 5 deletions examples/fluentresource.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,25 @@ impl<'mgr> FluentResource<'mgr> {
// very simple parse step
FluentResource(&s[0..1])
}

pub fn get(&self) -> &'mgr str {
self.0
}
}

/// Stores loaded files and parsed ASTs
///
/// Parsed ASTs are zero-copy and
/// contain references to the files
#[derive(Default)]
pub struct ResourceManager<'mgr> {
strings: FrozenMap<String, String>,
resources: FrozenMap<String, Box<FluentResource<'mgr>>>,
}

impl<'mgr> ResourceManager<'mgr> {
pub fn new() -> Self {
ResourceManager {
strings: FrozenMap::new(),
resources: FrozenMap::new(),
}
Self::default()
}

pub fn get_resource(&'mgr self, path: &str) -> &'mgr FluentResource<'mgr> {
Expand All @@ -46,5 +48,6 @@ impl<'mgr> ResourceManager<'mgr> {
fn main() {
let manager = ResourceManager::new();
let resource = manager.get_resource("somefile.ftl");
println!("{:?}", resource);

assert_eq!(resource.get(), "f");
}
24 changes: 12 additions & 12 deletions src/map.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,10 @@ impl<K: Eq + Hash, V: StableDeref, S: BuildHasher> FrozenMap<K, V, S> {
/// assert_eq!(map.get(&1), Some(&"a"));
/// assert_eq!(map.get(&2), None);
/// ```
pub fn get<Q: ?Sized>(&self, k: &Q) -> Option<&V::Target>
pub fn get<Q>(&self, k: &Q) -> Option<&V::Target>
where
K: Borrow<Q>,
Q: Hash + Eq,
Q: Hash + Eq + ?Sized,
{
assert!(!self.in_use.get());
self.in_use.set(true);
Expand Down Expand Up @@ -128,10 +128,10 @@ impl<K: Eq + Hash, V: StableDeref, S: BuildHasher> FrozenMap<K, V, S> {
/// assert_eq!(map.map_get(&1, Clone::clone), Some(Box::new("a")));
/// assert_eq!(map.map_get(&2, Clone::clone), None);
/// ```
pub fn map_get<Q: ?Sized, T, F>(&self, k: &Q, f: F) -> Option<T>
pub fn map_get<Q, T, F>(&self, k: &Q, f: F) -> Option<T>
where
K: Borrow<Q>,
Q: Hash + Eq,
Q: Hash + Eq + ?Sized,
F: FnOnce(&V) -> T,
{
assert!(!self.in_use.get());
Expand Down Expand Up @@ -192,10 +192,10 @@ impl<K: Eq + Hash + StableDeref, V: StableDeref, S: BuildHasher> FrozenMap<K, V,
/// assert_eq!(map.get_key_value(&"1"), Some((&"1", &"a")));
/// assert_eq!(map.get_key_value(&"2"), None);
/// ```
pub fn get_key_value<Q: ?Sized>(&self, k: &Q) -> Option<(&K::Target, &V::Target)>
pub fn get_key_value<Q>(&self, k: &Q) -> Option<(&K::Target, &V::Target)>
where
K: Borrow<Q>,
Q: Hash + Eq,
Q: Hash + Eq + ?Sized,
{
assert!(!self.in_use.get());
self.in_use.set(true);
Expand Down Expand Up @@ -279,7 +279,7 @@ impl<K: Clone, V: Clone, S: Clone> Clone for FrozenMap<K, V, S> {
in_use: Cell::from(false),
};
self.in_use.set(false);
return self_clone;
self_clone
}
}

Expand Down Expand Up @@ -384,10 +384,10 @@ impl<K: Clone + Ord, V: StableDeref> FrozenBTreeMap<K, V> {
/// assert_eq!(map.get(&1), Some(&"a"));
/// assert_eq!(map.get(&2), None);
/// ```
pub fn get<Q: ?Sized>(&self, k: &Q) -> Option<&V::Target>
pub fn get<Q>(&self, k: &Q) -> Option<&V::Target>
where
K: Borrow<Q>,
Q: Ord,
Q: Ord + ?Sized,
{
assert!(!self.in_use.get());
self.in_use.set(true);
Expand Down Expand Up @@ -415,10 +415,10 @@ impl<K: Clone + Ord, V: StableDeref> FrozenBTreeMap<K, V> {
/// assert_eq!(map.map_get(&1, Clone::clone), Some(Box::new("a")));
/// assert_eq!(map.map_get(&2, Clone::clone), None);
/// ```
pub fn map_get<Q: ?Sized, T, F>(&self, k: &Q, f: F) -> Option<T>
pub fn map_get<Q, T, F>(&self, k: &Q, f: F) -> Option<T>
where
K: Borrow<Q>,
Q: Ord,
Q: Ord + ?Sized,
F: FnOnce(&V) -> T,
{
assert!(!self.in_use.get());
Expand Down Expand Up @@ -531,7 +531,7 @@ impl<K: Clone, V: Clone> Clone for FrozenBTreeMap<K, V> {
in_use: Cell::from(false),
};
self.in_use.set(false);
return self_clone;
self_clone
}
}

Expand Down
61 changes: 37 additions & 24 deletions src/sync.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,10 +188,10 @@ impl<K: Eq + Hash, V: StableDeref> FrozenMap<K, V> {
/// assert_eq!(map.get(&1), Some(&"a"));
/// assert_eq!(map.get(&2), None);
/// ```
pub fn get<Q: ?Sized>(&self, k: &Q) -> Option<&V::Target>
pub fn get<Q>(&self, k: &Q) -> Option<&V::Target>
where
K: Borrow<Q>,
Q: Hash + Eq,
Q: Hash + Eq + ?Sized,
{
let map = self.map.read().unwrap();
let ret = unsafe { map.get(k).map(|x| &*(&**x as *const V::Target)) };
Expand All @@ -214,10 +214,10 @@ impl<K: Eq + Hash, V: StableDeref> FrozenMap<K, V> {
/// assert_eq!(map.map_get(&1, Clone::clone), Some(Box::new("a")));
/// assert_eq!(map.map_get(&2, Clone::clone), None);
/// ```
pub fn map_get<Q: ?Sized, T, F>(&self, k: &Q, f: F) -> Option<T>
pub fn map_get<Q, T, F>(&self, k: &Q, f: F) -> Option<T>
where
K: Borrow<Q>,
Q: Hash + Eq,
Q: Hash + Eq + ?Sized,
F: FnOnce(&V) -> T,
{
let map = self.map.read().unwrap();
Expand Down Expand Up @@ -308,10 +308,10 @@ impl<K: Eq + Hash, V: Copy> FrozenMap<K, V> {
/// assert_eq!(map.get_copy(&1), Some(6));
/// assert_eq!(map.get_copy(&2), None);
/// ```
pub fn get_copy<Q: ?Sized>(&self, k: &Q) -> Option<V>
pub fn get_copy<Q>(&self, k: &Q) -> Option<V>
where
K: Borrow<Q>,
Q: Hash + Eq,
Q: Hash + Eq + ?Sized,
{
let map = self.map.read().unwrap();
map.get(k).cloned()
Expand Down Expand Up @@ -511,7 +511,7 @@ impl<T: StableDeref> FrozenVec<T> {
let mut vec = self.vec.write().unwrap();
let index = vec.len();
vec.push(val);
return index;
index
}

pub fn get(&self, index: usize) -> Option<&T::Target> {
Expand Down Expand Up @@ -704,15 +704,18 @@ impl<T: Copy> Default for LockFreeFrozenVec<T> {
/// any heap allocations until the first time data is pushed to it.
fn default() -> Self {
Self {
data: [Self::NULL; NUM_BUFFERS],
data: std::array::from_fn(|_| Self::null()),
Copy link
Owner

Choose a reason for hiding this comment

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

nit: we can just use [Self::null(); NUM_BUFFERS] here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So, we can't use [Self::null; NUM_BUFFERS] because AtomicPtr doesn't impl Copy. The workaround is to define some const (i.e., what happened before clippy said anything). With the new const context syntax it's possible to do [const { Self::null() }; NUM_BUFFERS] instead, which is what I did in the second commit.

Copy link
Owner

Choose a reason for hiding this comment

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

In that case I'd just allow the lint? I think the const is fine, and from_fn isn't guaranteed const so I'd rather not use it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Another alternative is to do

impl<T: Copy> LockFreeFrozenVec<T> {
    const fn null() -> [AtomicPtr<T>; NUM_BUFFERS] {
        [const { AtomicPtr::new(std::ptr::null_mut()) }; NUM_BUFFERS]
    }
}

And replace calls to [Self::NULL; NUM_BUFFERS] with Self::null()

Copy link
Owner

Choose a reason for hiding this comment

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

works for me!

len: AtomicUsize::new(0),
locked: AtomicBool::new(false),
}
}
}

impl<T: Copy> LockFreeFrozenVec<T> {
const NULL: AtomicPtr<T> = AtomicPtr::new(std::ptr::null_mut());
const fn null() -> AtomicPtr<T> {
AtomicPtr::new(std::ptr::null_mut())
}

pub fn new() -> Self {
Default::default()
}
Expand Down Expand Up @@ -752,7 +755,7 @@ impl<T: Copy> LockFreeFrozenVec<T> {
}
self.lock(|| {
// These values must be consistent with the pointer we got.
let len = self.len.load(Ordering::Acquire);
let len = self.len();
let buffer_idx = buffer_index(len);
let mut ptr = self.data[buffer_idx].load(Ordering::Acquire);
if ptr.is_null() {
Expand Down Expand Up @@ -789,8 +792,7 @@ impl<T: Copy> LockFreeFrozenVec<T> {
// independently of the read is fine. Worst case we
// read an old length value and end up returning `None` even if
// another thread already inserted the value.
let len = self.len.load(Ordering::Acquire);
if index >= len {
if index >= self.len() {
return None;
}
let buffer_idx = buffer_index(index);
Expand All @@ -800,12 +802,22 @@ impl<T: Copy> LockFreeFrozenVec<T> {
}

pub fn is_empty(&self) -> bool {
self.len.load(Ordering::Relaxed) == 0
self.len() == 0
caass marked this conversation as resolved.
Show resolved Hide resolved
}

#[inline(always)]
pub fn len(&self) -> usize {
self.len.load(Ordering::Acquire)
}

/// Load an element (if it exists). This operation is lock-free and
/// performs no synchronized atomic operations. This is a useful primitive to
/// implement your own data structure with newtypes around the index.
///
/// ## Safety
///
/// `index` must be in bounds, i.e. it must be less than `self.len()`
#[inline]
pub unsafe fn get_unchecked(&self, index: usize) -> T {
let buffer_idx = buffer_index(index);
let buffer_ptr = self.data[buffer_idx].load(Ordering::Relaxed);
Expand Down Expand Up @@ -844,8 +856,8 @@ impl<T: Copy> LockFreeFrozenVec<T> {
impl<T: Copy + PartialEq> PartialEq for LockFreeFrozenVec<T> {
fn eq(&self, other: &Self) -> bool {
// first check the length
let self_len = self.len.load(Ordering::Acquire);
let other_len = other.len.load(Ordering::Acquire);
let self_len = self.len();
let other_len = other.len();
if self_len != other_len {
return false;
}
Expand All @@ -857,7 +869,8 @@ impl<T: Copy + PartialEq> PartialEq for LockFreeFrozenVec<T> {
return false;
}
}
return true;

true
}
}

Expand Down Expand Up @@ -897,7 +910,7 @@ fn test_non_lockfree_unchecked() {

impl<T: Copy + Clone> Clone for LockFreeFrozenVec<T> {
fn clone(&self) -> Self {
let mut coppied_data = [Self::NULL; NUM_BUFFERS];
let mut coppied_data = std::array::from_fn(|_| Self::null());
caass marked this conversation as resolved.
Show resolved Hide resolved
// for each buffer, copy the data
self.for_each_buffer(|buffer_slice, buffer_index| {
// allocate a new buffer
Expand All @@ -916,11 +929,11 @@ impl<T: Copy + Clone> Clone for LockFreeFrozenVec<T> {
*coppied_data[buffer_index].get_mut() = new_buffer_ptr;
});

return Self {
Self {
data: coppied_data,
len: AtomicUsize::new(self.len.load(Ordering::Relaxed)),
len: AtomicUsize::new(self.len()),
caass marked this conversation as resolved.
Show resolved Hide resolved
locked: AtomicBool::new(false),
};
}
}
}

Expand Down Expand Up @@ -1015,10 +1028,10 @@ impl<K: Clone + Ord, V: StableDeref> FrozenBTreeMap<K, V> {
/// assert_eq!(map.get(&1), Some(&"a"));
/// assert_eq!(map.get(&2), None);
/// ```
pub fn get<Q: ?Sized>(&self, k: &Q) -> Option<&V::Target>
pub fn get<Q>(&self, k: &Q) -> Option<&V::Target>
where
K: Borrow<Q>,
Q: Ord,
Q: Ord + ?Sized,
{
let map = self.0.read().unwrap();
let ret = unsafe { map.get(k).map(|x| &*(&**x as *const V::Target)) };
Expand Down Expand Up @@ -1061,10 +1074,10 @@ impl<K: Clone + Ord, V: StableDeref> FrozenBTreeMap<K, V> {
/// assert_eq!(map.map_get(&1, Clone::clone), Some(Box::new("a")));
/// assert_eq!(map.map_get(&2, Clone::clone), None);
/// ```
pub fn map_get<Q: ?Sized, T, F>(&self, k: &Q, f: F) -> Option<T>
pub fn map_get<Q, T, F>(&self, k: &Q, f: F) -> Option<T>
where
K: Borrow<Q>,
Q: Ord,
Q: Ord + ?Sized,
F: FnOnce(&V) -> T,
{
let map = self.0.read().unwrap();
Expand Down
10 changes: 5 additions & 5 deletions src/vec.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ impl<T: StableDeref> FrozenVec<T> {
/// `index` must be in bounds, i.e. it must be less than `self.len()`
pub unsafe fn get_unchecked(&self, index: usize) -> &T::Target {
let vec = self.vec.get();
&**(*vec).get_unchecked(index)
(*vec).get_unchecked(index)
}
}

Expand Down Expand Up @@ -309,7 +309,7 @@ fn test_iteration() {
fn test_accessors() {
let vec: FrozenVec<String> = FrozenVec::new();

assert_eq!(vec.is_empty(), true);
assert!(vec.is_empty());
assert_eq!(vec.len(), 0);
assert_eq!(vec.first(), None);
assert_eq!(vec.last(), None);
Expand All @@ -319,7 +319,7 @@ fn test_accessors() {
vec.push("b".to_string());
vec.push("c".to_string());

assert_eq!(vec.is_empty(), false);
assert!(!vec.is_empty());
assert_eq!(vec.len(), 3);
assert_eq!(vec.first(), Some("a"));
assert_eq!(vec.last(), Some("c"));
Expand All @@ -332,15 +332,15 @@ fn test_non_stable_deref() {
struct Moo(i32);
let vec: FrozenVec<Moo> = FrozenVec::new();

assert_eq!(vec.is_empty(), true);
assert!(vec.is_empty());
assert_eq!(vec.len(), 0);
assert_eq!(vec.get_copy(1), None);

vec.push(Moo(1));
vec.push(Moo(2));
vec.push(Moo(3));

assert_eq!(vec.is_empty(), false);
assert!(!vec.is_empty());
assert_eq!(vec.len(), 3);
assert_eq!(vec.get_copy(1), Some(Moo(2)));
}
Expand Down