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
191
192
193
194
195
196
197
198
use std::cell::RefCell;
use std::cmp::PartialEq;
use std::fmt::{self, Debug, Formatter};
use std::ops::Deref;
use std::rc::Rc;

/// A Buffer wraps a Vec<u8> and provides a means of tracking the total byte usage of certain
/// classes of data.  This is used to determine our receiver window, among other things.
#[derive(Clone)]
pub struct Buffer {
    data: Rc<Vec<u8>>,
    tracker: Option<BufferTracker>,
}

impl Buffer {
    pub fn new(slice: &[u8]) -> Buffer {
        Buffer {
            data: Rc::new(slice.to_vec()),
            tracker: None,
        }
    }
    pub fn from_vec(vec: Vec<u8>) -> Buffer {
        Buffer {
            data: Rc::new(vec),
            tracker: None,
        }
    }
    pub fn empty() -> Buffer {
        Buffer {
            data: Rc::new(vec![]),
            tracker: None,
        }
    }
    pub fn track(&mut self, tracker: &BufferTracker) {
        // If this buffer is already being tracked, remove it from the previous tracking realm
        // before adding it to the new one.  This happens when buffers in the send_queue are moved
        // to the sent_queue.
        if let Some(ref mut existing_tracker) = self.tracker {
            existing_tracker.subtract(self.data.len());
        }
        tracker.add(self.data.len());
        self.tracker = Some(tracker.clone());
    }
    pub fn untrack(&mut self) {
        if let Some(tracker) = self.tracker.take() {
            tracker.subtract(self.data.len());
        }
    }
    pub fn track_same_as(&mut self, other: &Buffer) {
        if let Some(ref tracker) = other.tracker {
            self.track(tracker);
        }
    }
    pub fn tracker(&self) -> Option<BufferTracker> {
        if let Some(ref tracker) = self.tracker {
            Some(tracker.clone())
        } else {
            None
        }
    }
    pub fn to_vec(self) -> Vec<u8> {
        (&self.data[..]).to_vec()
    }
    pub fn len(&self) -> usize {
        self.data.len()
    }
}

impl Drop for Buffer {
    fn drop(&mut self) {
        if Rc::strong_count(&self.data) == 1 {
            if let Some(ref tracker) = self.tracker {
                tracker.subtract(self.data.len());
            }
        }
    }
}

impl Deref for Buffer {
    type Target = [u8];

    fn deref(&self) -> &[u8] {
        &self.data
    }
}

impl Debug for Buffer {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        self.data.fmt(f)
    }
}

impl PartialEq for Buffer {
    fn eq(&self, other: &Self) -> bool {
        (&*self.data).eq(&*other.data)
    }
}

#[derive(Clone)]
pub struct BufferTracker {
    inner: Rc<RefCell<Inner>>,
}

struct Inner {
    count: usize,
    bytes: usize,
}

impl BufferTracker {
    pub fn new() -> BufferTracker {
        BufferTracker {
            inner: Rc::new(RefCell::new(Inner { count: 0, bytes: 0 })),
        }
    }

    pub fn count(&self) -> usize {
        self.inner.borrow().count
    }

    pub fn bytes(&self) -> usize {
        self.inner.borrow().bytes
    }

    fn add(&self, bytes: usize) {
        let mut inner = self.inner.borrow_mut();
        inner.count += 1;
        inner.bytes += bytes;
    }

    fn subtract(&self, bytes: usize) {
        let mut inner = self.inner.borrow_mut();
        inner.count -= 1;
        inner.bytes -= bytes;
    }
}

impl Debug for BufferTracker {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        write!(f, "[c={},t={}]", self.count(), self.bytes())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use rand;

    const BUFFERS: usize = 8192;
    const MIN_BUFFER: usize = 1;
    const MAX_BUFFER: usize = 1500;
    const FILL_BYTE: u8 = 0xAA;

    fn make_buffer() -> Buffer {
        let len = rand::random::<usize>() % (MAX_BUFFER - MIN_BUFFER) + MIN_BUFFER;
        let mut vec = Vec::<u8>::with_capacity(len);
        vec.resize(len, FILL_BYTE);
        Buffer::new(&vec)
    }

    #[test]
    fn test_buffer() {
        let tracker = BufferTracker::new();
        {
            let mut buffers = Vec::<Buffer>::new();
            let mut count = 0usize;
            let mut bytes = 0usize;

            for _ in 0..BUFFERS {
                let mut buffer = make_buffer();
                count += 1;
                bytes += buffer.len();

                buffer.track(&tracker);
                buffers.push(buffer);

                assert_eq!(tracker.count(), count);
                assert_eq!(tracker.bytes(), bytes);
            }

            for _ in 0..BUFFERS {
                assert_eq!(tracker.count(), count);
                assert_eq!(tracker.bytes(), bytes);

                let index = rand::random::<usize>() % buffers.len();
                let buffer = buffers.remove(index);

                assert_eq!(tracker.count(), count);
                assert_eq!(tracker.bytes(), bytes);

                count -= 1;
                bytes -= buffer.len();
                // buffer is dropped here.
            }
        }
        assert_eq!(tracker.count(), 0);
        assert_eq!(tracker.bytes(), 0);
    }
}