1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
#![cfg_attr(feature = "nightly", deny(missing_docs))]
#![cfg_attr(feature = "nightly", feature(external_doc))]
#![cfg_attr(feature = "nightly", doc(include = "../README.md"))]
#![cfg_attr(test, deny(warnings))]

#[macro_use]
extern crate failure;
extern crate random_access_storage;

use random_access_storage::{RandomAccess, RandomAccessMethods};
use failure::Error;
use std::cmp;

/// Main constructor.
#[derive(Debug)]
pub struct RandomAccessMemory;

impl RandomAccessMemory {
  /// Create a new instance.
  // #[cfg_attr(test, allow(new_ret_no_self))]
  pub fn new(page_size: usize) -> RandomAccess<RandomAccessMemoryMethods> {
    let methods = RandomAccessMemoryMethods {
      buffers: Vec::new(),
      page_size,
      length: 0,
    };

    RandomAccess::new(methods)
  }

  /// Create a new instance with a 1mb page size.
  // We cannot use the `Default` trait here because we aren't returning `Self`.
  pub fn default() -> RandomAccess<RandomAccessMemoryMethods> {
    let methods = RandomAccessMemoryMethods {
      buffers: Vec::new(),
      page_size: 1024 * 1024,
      length: 0,
    };

    RandomAccess::new(methods)
  }

  /// Create a new instance, but pass the initial buffers to the constructor.
  pub fn with_buffers(
    page_size: usize,
    buffers: Vec<Vec<u8>>,
  ) -> RandomAccess<RandomAccessMemoryMethods> {
    let methods = RandomAccessMemoryMethods {
      page_size,
      buffers,
      length: 0,
    };

    RandomAccess::new(methods)
  }
}

/// Methods that have been implemented to provide synchronous access to memory
/// buffers. These should generally be kept private, but exposed to prevent
/// leaking internals.
#[derive(Debug)]
pub struct RandomAccessMemoryMethods {
  /// The length length of each buffer.
  pub page_size: usize,

  /// The memory we read/write to.
  // TODO: initialize as a sparse vector.
  pub buffers: Vec<Vec<u8>>,

  /// Total length of the data.
  length: usize,
}

impl RandomAccessMethods for RandomAccessMemoryMethods {
  fn open(&mut self) -> Result<(), Error> {
    Ok(())
  }

  fn write(&mut self, offset: usize, data: &[u8]) -> Result<(), Error> {
    let new_len = offset + data.len();
    if new_len > self.length {
      self.length = new_len;
    }

    let mut page_num = offset / self.page_size;
    let mut page_cursor = offset - (page_num * self.page_size);
    let mut data_cursor = 0;

    // Iterate over data, write to buffers. Subslice if the data is bigger than
    // what we can write in a single go.
    while data_cursor < data.len() {
      let data_bound = data.len() - data_cursor;
      let upper_bound = cmp::min(self.page_size, page_cursor + data_bound);
      let range = page_cursor..upper_bound;
      let range_len = range.len();

      // Allocate buffer if needed. Either append a new buffer to the end, or
      // set a buffer in the center.
      if self.buffers.get(page_num).is_none() {
        let buf = vec![0; self.page_size];
        if self.buffers.len() < page_num + 1 {
          self.buffers.resize(page_num + 1, buf);
        } else {
          self.buffers[page_num] = buf;
        }
      }

      // Copy data from the vec slice.
      // TODO: use a batch operation such as `.copy_from_slice()` so it can be
      // optimized.
      let buffer = &mut self.buffers[page_num];
      for (index, buf_index) in range.enumerate() {
        buffer[buf_index] = data[data_cursor + index];
      }

      page_num += 1;
      page_cursor = 0;
      data_cursor += range_len;
    }

    Ok(())
  }

  fn read(&mut self, offset: usize, length: usize) -> Result<Vec<u8>, Error> {
    ensure!(
      (offset + length) <= self.length,
      format!("Read bounds exceeded. {} < {}..{}",
              self.length, offset, offset + length)
    );

    let mut page_num = offset / self.page_size;
    let mut page_cursor = offset - (page_num * self.page_size);

    let mut res_buf = vec![0; length];
    let mut res_cursor = 0; // Keep track we read the right amount of bytes.
    let res_capacity = length;

    while res_cursor < res_capacity {
      let res_bound = res_capacity - res_cursor;
      let page_bound = self.page_size - page_cursor;
      let relative_bound = cmp::min(res_bound, page_bound);
      let upper_bound = page_cursor + relative_bound;
      let range = page_cursor..upper_bound;

      // Fill until either we're done reading the page, or we're done
      // filling the buffer. Whichever arrives sooner.
      match self.buffers.get(page_num) {
        Some(buf) => {
          for (index, buf_index) in range.enumerate() {
            res_buf[res_cursor + index] = buf[buf_index];
          }
        }
        None => {
          for (index, _) in range.enumerate() {
            res_buf[res_cursor + index] = 0;
          }
        }
      }

      res_cursor += relative_bound;
      page_num += 1;
      page_cursor = 0;
    }

    Ok(res_buf)
  }

  fn del(&mut self, offset: usize, length: usize) -> Result<(), Error> {
    let overflow = offset % self.page_size;
    let inc = match overflow {
      0 => 0,
      _ => self.page_size - overflow,
    };

    if inc < length {
      let mut offset = offset + inc;
      let length = length - overflow;
      let end = offset + length;
      let mut i = offset - self.page_size;

      while (offset + self.page_size <= end) && i < self.buffers.capacity() {
        self.buffers.remove(i);
        offset += self.page_size;
        i += 1;
      }
    }

    Ok(())
  }
}