-
Notifications
You must be signed in to change notification settings - Fork 2
/
mod.rs
420 lines (335 loc) · 13.6 KB
/
mod.rs
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
//! The Order Store A.K.A. The giant map containing the entire market of EVE
use std::fs;
use std::fs::OpenOptions;
use std::io::{BufReader, BufWriter};
use std::hash::{Hash, Hasher};
use std::sync::Arc;
use std::thread;
use std::time;
use bincode::{serialize_into, deserialize_from, Infinite};
use chrono::prelude::*;
use flate2::Compression;
use flate2::write::{DeflateEncoder};
use flate2::bufread::{DeflateDecoder};
use fnv::FnvHasher;
use fnv::FnvHashMap;
use fnv::FnvHashSet;
use parking_lot::{RwLock, RwLockWriteGuard};
use prost::Message;
use prost_types::Timestamp;
use super::esi::types::*;
use super::errors::*;
pub const STORE_PATH: &str = "cache/store";
pub const TEMP_STORE_PATH: &str = "cache/store.part";
/// A vec of orders tagged with external `seen_at`
pub type TaggedOrderVec = Vec<(Order, DateTime<Utc>)>;
/// A serialized order (including `seen_at`).
pub type OrderBlob = Vec<u8>;
/// Main store object wrapped by a `RwLock`.
#[derive(Clone, Debug)]
pub struct Store(Arc<RwLock<InnerStore>>);
/// Result of an update operation.
#[derive(Debug)]
pub struct UpdateResult {
pub is_first_run: bool,
pub new: FnvHashSet<OrderID>,
pub updated: FnvHashSet<OrderID>,
pub unaffected: FnvHashSet<OrderID>,
pub closed: FnvHashSet<OrderID>,
pub region_types: FnvHashSet<RegionType>
}
/// Internal storage structure
#[derive(Debug)]
struct InnerStore {
orders: FnvHashMap<OrderID, StoreObject>,
regions: FnvHashMap<RegionID, FnvHashSet<OrderID>>,
types: FnvHashMap<TypeID, FnvHashSet<OrderID>>,
region_types: FnvHashMap<RegionType, FnvHashSet<OrderID>>
}
/// Simple order + history
#[derive(Debug, Serialize, Deserialize)]
struct StoreObject {
order: OrderBlob,
hash: u64,
region_id: RegionID,
type_id: TypeID,
history: Vec<OrderBlob>
}
impl Store {
pub fn new() -> Result<Store> {
let inner = InnerStore {
orders: FnvHashMap::default(),
regions: FnvHashMap::default(),
types: FnvHashMap::default(),
region_types: FnvHashMap::default()
};
let retval = Store(Arc::new(RwLock::new(inner)));
retval.load_store()?;
retval.schedule_persistence();
Ok(retval)
}
/// Write local state to disk in regular intervals
fn schedule_persistence(&self) {
let clone = self.clone();
thread::spawn(move || {
loop {
thread::sleep(time::Duration::from_secs(60 * 60)); // Hourly
let clone = clone.clone();
thread::spawn(move || {
match clone.persist_store() {
Ok(_) => {}
Err(e) => {
warn!("Saving store to disk failed: {}", e)
}
}
});
}
});
}
/// Save store to disk
pub fn persist_store(&self) -> Result<()> {
debug!("Writing store to disk...");
let store_file = OpenOptions::new()
.write(true)
.create(true)
.open(TEMP_STORE_PATH)?;
let writer = BufWriter::new(store_file);
let mut deflate_writer = DeflateEncoder::new(writer, Compression::Fast);
let res = serialize_into(&mut deflate_writer, &self.0.read().orders, Infinite);
if res.is_ok() {
fs::remove_file(STORE_PATH)?;
fs::rename(TEMP_STORE_PATH, STORE_PATH)?;
debug!("Successfully wrote store to disk.");
} else {
bail!(res.unwrap_err());
}
Ok(())
}
/// Load store from disk or create cache
fn load_store(&self) -> Result<()> {
debug!("Loading store from disk...");
let store_file = OpenOptions::new()
.read(true)
.write(true)
.create(true)
.open(STORE_PATH)?;
let reader = BufReader::new(store_file);
let mut deflate_reader = DeflateDecoder::new(reader);
let store_result = deserialize_from(&mut deflate_reader, Infinite);
if store_result.is_ok() {
let mut lock = self.0.write();
let orders: FnvHashMap<OrderID, StoreObject> = store_result?;
info!("Loaded {} orders from disk.", orders.len());
info!("Creating indices...");
for (id, store_object) in &orders {
add_to_indices(&mut lock, *id, store_object.type_id, store_object.region_id);
}
lock.orders = orders;
info!("Done creating indices.");
} else {
info!("No orders loaded from disk: {:?}", store_result.unwrap_err());
}
Ok(())
}
/// Store multiple orders in the store. Update if existing
pub fn store_region(&mut self, region_id: &RegionID, orders: TaggedOrderVec) -> UpdateResult {
// Acquire write lock
// Iterate over orders, serialize (protobuf, append seen_at field later) and hash (build StoreObjects) -> rayon
// Check if hash is present
// yes -> Is the hash different?
// yes -> Persist in Store (and merge history), add to updated
// no -> Discard Order, add to unaffected
// no -> Persist in store, update indices, add to new
// prune region
// Release write lock
// Return UpdateResult updated (caller can calculate total region_types affected after pruning)
let mut new: FnvHashSet<OrderID> = FnvHashSet::default();
let mut updated: FnvHashSet<OrderID> = FnvHashSet::default();
let mut unaffected: FnvHashSet<OrderID> = FnvHashSet::default();
let mut region_types: FnvHashSet<RegionType> = FnvHashSet::default();
let mut all_oids: FnvHashSet<OrderID> = FnvHashSet::default();
let mut store = self.0.write();
// Check if there are any orders for this region
// if not, this is out first run and we avoid flooding new orders
let is_first_run = !store.regions.contains_key(region_id);
for (mut order, last_modified) in orders {
// Add to all list
all_oids.insert(order.order_id);
// Add region ID to order
order.region_id = *region_id;
// Encode without seen_at
// TODO: parallelize encode/hash, add seen_at step using rayon?
let mut hash_blob = Vec::with_capacity(Message::encoded_len(&order));
Message::encode(&order, &mut hash_blob).unwrap();
// Hash the blob
let mut hasher = FnvHasher::default();
hash_blob.as_slice().hash(&mut hasher);
let hash = hasher.finish();
if store.orders.contains_key(&order.order_id) {
let entry = store.orders.get_mut(&order.order_id).unwrap();
// Check if hash is different
if entry.hash != hash {
// Set seen_at and reencode
order.seen_at = Some(Timestamp::from(time::SystemTime::from(last_modified)));
let mut seen_blob = Vec::with_capacity(Message::encoded_len(&order));
Message::encode(&order, &mut seen_blob).unwrap();
// Update entry
updated.insert(order.order_id);
region_types.insert((*region_id, order.type_id));
entry.hash = hash;
entry.history.push(seen_blob.clone());
entry.order = seen_blob;
} else {
unaffected.insert(order.order_id);
}
} else {
// Not there, new entry
// Set seen_at and reencode
order.seen_at = Some(Timestamp::from(time::SystemTime::from(last_modified)));
let mut seen_blob = Vec::with_capacity(Message::encoded_len(&order));
Message::encode(&order, &mut seen_blob).unwrap();
new.insert(order.order_id);
region_types.insert((*region_id, order.type_id));
store.orders.insert(order.order_id, StoreObject{
hash: hash,
history: vec![seen_blob.clone()],
order: seen_blob,
region_id: *region_id,
type_id: order.type_id
});
add_to_indices(&mut store, order.order_id, order.type_id, *region_id);
}
}
let (rt_closed, closed) = prune_region(&mut store, *region_id, &all_oids);
region_types.extend(rt_closed.iter());
UpdateResult{
is_first_run,
new,
updated,
unaffected,
closed,
region_types
}
}
/// Get order's history
pub fn get_order(&self, order_id: OrderID) -> Vec<OrderBlob> {
// Acquire read lock
// Get order's history from store
// Release read lock
let store = &self.0.read();
let mut orders: Vec<OrderBlob> = Vec::new();
if !store.orders.contains_key(&order_id) {
return orders;
}
for order in &store.orders.get(&order_id).unwrap().history {
orders.push(order.clone());
}
orders
}
/// Get all orders in a region
pub fn get_region(&self, region_id: RegionID) -> Vec<OrderBlob> {
// Acquire read lock
// Get regions[region_id]
// Get OIDs from orders, concat to Vec
// Release read lock
let store = &self.0.read();
let oids_region = store.regions.get(®ion_id);
let mut orders: Vec<OrderBlob> = Vec::new();
if !oids_region.is_some() {
return orders;
}
for order_id in oids_region.unwrap() {
let order = store.orders.get(order_id);
if order.is_some() {
orders.push(order.unwrap().order.clone());
}
}
orders
}
/// Get all orders of a type
pub fn get_type(&self, type_id: TypeID) -> Vec<OrderBlob> {
// Acquire read lock
// Get types[region_id]
// Get OIDs from orders, concat to Vec
// Release read lock
let store = &self.0.read();
let oids_type = store.types.get(&type_id);
let mut orders: Vec<OrderBlob> = Vec::new();
if !oids_type.is_some() {
return orders;
}
for order_id in oids_type.unwrap() {
let order = store.orders.get(order_id);
if order.is_some() {
orders.push(order.unwrap().order.clone());
}
}
orders
}
/// Get all orders of a type in a region
pub fn get_region_type(&self, region_type: RegionType) -> Vec<OrderBlob> {
// Acquire read lock
// Get region_types[region_type]
// Get OIDs from orders, concat to Vec
// Release read lock
let store = &self.0.read();
let oids_region_type = store.region_types.get(®ion_type);
let mut orders: Vec<OrderBlob> = Vec::new();
if !oids_region_type.is_some() {
return orders;
}
for order_id in oids_region_type.unwrap() {
let order = store.orders.get(order_id);
if order.is_some() {
orders.push(order.unwrap().order.clone());
}
}
orders
}
}
/// Add new order to indices in store
fn add_to_indices(store: &mut RwLockWriteGuard<InnerStore>, order_id: OrderID, type_id: TypeID, region_id: RegionID) {
// Add type if unknown
store.types.entry(type_id).or_insert_with(FnvHashSet::default);
// Add order ID to type index
store.types.get_mut(&type_id).unwrap().insert(order_id);
// Add region if unknown
store.regions.entry(region_id).or_insert_with(FnvHashSet::default);
// Add order ID to region index
store.regions.get_mut(®ion_id).unwrap().insert(order_id);
// Add region type if unknown
let region_type: RegionType = (region_id, type_id);
store.region_types.entry(region_type).or_insert_with(FnvHashSet::default);
// Add order ID to region type index
store.region_types.get_mut(®ion_type).unwrap().insert(order_id);
}
/// Clear store of expired orders by comparing OIDs in region, must be done after each full region update!
fn prune_region(store: &mut RwLockWriteGuard<InnerStore>, region_id: RegionID, ids_in_region: &FnvHashSet<OrderID>) -> (FnvHashSet<RegionType>, FnvHashSet<OrderID>) {
// Acquire write lock
// Diff ids_in_region with regions[region_id]
// For those missing in ids_in_region:
// Remove from regions[region_id]
// Get order from orders, read type_id
// Remove from types[type_id]
// Remove from region_types[(region_id, type_id)]
// Remove from orders
//
// regions[region_id] = ids_in_region
// Release write lock
// Return
let mut affected_region_types: FnvHashSet<RegionType> = FnvHashSet::default();
let mut removed_ids: FnvHashSet<OrderID> = FnvHashSet::default();
// why Rust, why?
let orders_to_delete = &store.regions[®ion_id].difference(ids_in_region).cloned().collect::<FnvHashSet<OrderID>>();
for order_id in orders_to_delete {
let type_id = store.orders[order_id].type_id;
let region_type: RegionType = (region_id, type_id);
removed_ids.insert(*order_id);
affected_region_types.insert(region_type);
store.regions.get_mut(®ion_id).unwrap().remove(order_id);
store.types.get_mut(&type_id).unwrap().remove(order_id);
store.region_types.get_mut(&(region_id, type_id)).unwrap().remove(order_id);
store.orders.remove(order_id);
}
(affected_region_types, removed_ids)
}