lru-cache-macros

An attribute procedural macro to automatically cache the result of a function given a set of inputs.

This crate has been deprecated in favor of cache-macro which maintains the same functionality, but supports more than just lru caches. New code should use that crate instead.

Example:

use lru_cache_macros::lru_cache;

#[lru_cache(20)]
fn fib(x: u32) -> u64 {
    println!("{:?}", x);
    if x <= 1 {
        1
    } else {
        fib(x - 1) + fib(x - 2)
    }
}

assert_eq!(fib(19), 6765);

The above example only calls fib twenty times, with the values from 0 to 19. All intermediate results because of the recursion hit the cache.

Usage:

Simply place #[lru_cache([size])] above your function. The function must obey a few properties to use lru_cache:

• All arguments and return values must implement Clone.
• The function may not take self in any form.

The macro will use the LruCache at ::lru_cache::LruCache by default. This can be changed by setting the cache_type config variable as shown in the configuration section.

The LruCache type used must accept two generic parameters <Args, Return> and must support methods get_mut(&K) and insert(K, V). The lru-cache crate meets these requirements.

Currently, this crate only works on nightly rust. However, once the 2018 edition stabilizes as well as the procedural macro diagnostic interface, it should be able to run on stable.

Configuration:

The lru_cache macro can be configured by adding additional attributes under #[lru_cache(size)].

All configuration attributes take the form #[lru_config(...)]. The available attributes are:

• #[lru_config(cache_type = ...)]

  This allows the cache type used internally to be changed. The default is equivalent to

  #[lru_config(cache_type = ::lru_cache::LruCache)]

• #[lru_config(ignore_args = ...)]

  This allows certain arguments to be ignored for the purposes of caching. That means they are not part of the hash table key and thus should never influence the output of the function. It can be useful for diagnostic settings, returning the number of times executed, or other introspection purposes.

  ignore_args takes a comma-separated list of variable identifiers to ignore.

  Example:

  use lru_cache_macros::lru_cache;
  #[lru_cache(20)]
  #[lru_config(ignore_args = call_count)]
  fn fib(x: u64, call_count: &mut u32) -> u64 {
      *call_count += 1;
      if x <= 1 {
          1
      } else {
          fib(x - 1, call_count) + fib(x - 2, call_count)
      }
  }
  
  let mut call_count = 0;
  assert_eq!(fib(39, &mut call_count), 102_334_155);
  assert_eq!(call_count, 40);
  

  The call_count argument can vary, caching is only done based on x.

• #[lru_config(thread_local)]

  Store the cache in thread-local storage instead of global static storage. This avoids the overhead of Mutex locking, but each thread will be given its own cache, and all caching will not affect any other thread.

  Expanding on the first example:

  use lru_cache_macros::lru_cache;
  
  #[lru_cache(20)]
  #[lru_config(thread_local)]
  fn fib(x: u32) -> u64 {
      println!("{:?}", x);
      if x <= 1 {
          1
      } else {
          fib(x - 1) + fib(x - 2)
      }
  }
  
  assert_eq!(fib(19), 6765);
  

Details

The created cache is stored as a static variable protected by a mutex unless the #[lru_config(thread_local)] configuration is added.

With the default settings, the fibonacci example will generate the following code:

fn __lru_base_fib(x: u32) -> u64 {
    if x <= 1 { 1 } else { fib(x - 1) + fib(x - 2) }
}
fn fib(x: u32) -> u64 {
    use lazy_static::lazy_static;
    use std::sync::Mutex;

    lazy_static! {
        static ref cache: Mutex<::lru_cache::LruCache<(u32,), u64>> =
            Mutex::new(::lru_cache::LruCache::new(20usize));
    }
    
    let cloned_args = (x.clone(),);
    let mut cache_unlocked = cache.lock().unwrap();
    let stored_result = cache_unlocked.get_mut(&cloned_args);
    if let Some(stored_result) = stored_result {
        return stored_result.clone();
    };
    drop(cache_unlocked);
    let ret = __lru_base_fib(x);
    let mut cache_unlocked = cache.lock().unwrap();
    cache_unlocked.insert(cloned_args, ret.clone());
    ret
}

Whereas, if you use the #[lru_config(thread_local)] the generated code will look like:

fn __lru_base_fib(x: u32) -> u64 {
    if x <= 1 { 1 } else { fib(x - 1) + fib(x - 2) }
}
fn fib(x: u32) -> u64 {
    use std::cell::UnsafeCell;
    use std::thread_local;

    thread_local!(
         static cache: UnsafeCell<::lru_cache::LruCache<(u32,), u64>> =
             UnsafeCell::new(::lru_cache::LruCache::new(20usize));
    );

    cache.with(|c|
        {
            let mut cache_ref = unsafe { &mut *c.get() };
            let cloned_args = (x.clone(),);
            let stored_result = cache_ref.get_mut(&cloned_args);
            if let Some(stored_result) = stored_result {
                stored_result.clone()
            } else {
                let ret = __lru_base_fib(x);
                cache_ref.insert(cloned_args, ret.clone());
                ret
            }
        })
}