-
Notifications
You must be signed in to change notification settings - Fork 72
/
kv.py
479 lines (366 loc) · 12.1 KB
/
kv.py
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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
import os
import lmdb
import functools
import synapse.eventbus as s_eventbus
import synapse.lib.msgpack as s_msgpack
class KvDict:
'''
A KvDict uses the KvStor to implement a pythonic dict-like object.
Unlike the KvLook object, the KvDict keeps all items in the dictionary
in memory, so retrieval is fast; and only updates needs to be written
to the the underlying KvStor object.
'''
def __init__(self, stor, iden):
self.stor = stor
self.iden = iden
self.vals = {}
# load all the props
for lkey, lval in stor.iterKvProps(iden):
prop = lkey[16:].decode('utf8')
self.vals[prop] = s_msgpack.un(lval)
def items(self):
'''
Yield (prop, valu) tuples from the KvDict.
Notes:
This yields data from the internal dictionary ``items()`` method.
Changes made to the KvDict contents during the consumption of the
results of the ``KvDict.items()`` generator are not present in the
output of this generator.
Yields:
((str, object)): Tuple of prop, valu pairs.
'''
for item in tuple(self.vals.items()):
yield item
def set(self, prop, valu):
'''
Set a property in the KvDict.
Args:
prop (str): The property name.
valu (obj): A msgpack compatible value.
Returns:
None
'''
if self.vals.get(prop) == valu:
return
self.vals[prop] = valu
lkey = self.iden + prop.encode('utf8')
self.stor.setKvProp(lkey, s_msgpack.en(valu))
def get(self, prop):
'''
Get a property from the KvDict.
Args:
prop (str): The property name.
Returns:
(obj): The return value, or None.
'''
return self.vals.get(prop)
def pop(self, prop):
'''
Pop a property from the KvDict.
Args:
prop (str): The property name.
Returns:
object: The object stored in the KvDict, or None if the object was not present.
'''
valu = self.vals.pop(prop, None)
lkey = self.iden + prop.encode('utf8')
self.stor.delKvProp(lkey)
return valu
class KvLook:
'''
A KvLook uses the KvStor to implement key=valu lookup namespace.
The primary APIs, ``get()`` and ``set()``, will use msgpack to decode and
encode objects retrieved from the store. This allows storing complex data
structures in the KV store. ``getraw()`` and ``setraw()`` APIs exist for
purely bytes in / bytes out interfaces.
'''
def __init__(self, stor, iden):
self.stor = stor
self.iden = iden
def set(self, prop, valu):
'''
Set a property in the KvLook.
Args:
prop (str): The property name to set.
valu (obj): A msgpack compatible value.
Returns:
None
'''
lkey = self.iden + prop.encode('utf8')
self.stor.setKvProp(lkey, s_msgpack.en(valu))
def get(self, prop):
'''
Lookup a property from the KvLook.
Args:
prop (str): The property name.
Returns:
object: The valu, aftering being unpacked via msgpack, or None.
'''
lkey = self.iden + prop.encode('utf8')
lval = self.stor.getKvProp(lkey)
if lval is None:
return None
return s_msgpack.un(lval)
def items(self):
'''
Iterate over items stored in the KvLook namespace.
Yields:
((str, object)): The name and object for items in KvLook namespace.
'''
size = len(self.iden)
for lkey, lval in self.stor.iterKvProps(self.iden):
prop = lkey[size:].decode('utf8')
valu = s_msgpack.un(lval)
yield prop, valu
def getraw(self, lkey):
'''
Retrieve a value directly by bytes.
Args:
lkey (bytes): Byte value to retrieve.
Returns:
bytes: Bytes for a given key, or None if it does not exist.
'''
return self.stor.getKvProp(self.iden + lkey)
def setraw(self, lkey, lval):
'''
Set the value directly by bytes.
Args:
lkey (bytes): Byte value to set.
lval (bytes): Bytes to set to the value.
Returns:
None
'''
self.stor.setKvProp(self.iden + lkey, lval)
class KvSet:
'''
A KvSet uses the KvStor to implement a pythonic set-like object.
Unlike the KvLook object, the KvSet keeps all items in the set in
memory, so access is fast; and only updates needs to be written to the
the underlying KvStor object.
'''
def __init__(self, stor, iden):
self.stor = stor
self.iden = iden
self.vals = {s_msgpack.un(b) for b in stor.iterKvDups(iden)}
def remove(self, valu):
'''
Remove a value from the KvSet.
Args:
valu (obj): A msgpack value to remove.
Returns:
(bool): True if the value was found and removed.
'''
try:
self.vals.remove(valu)
except KeyError as e:
return False
lval = s_msgpack.en(valu)
return self.stor.delKvDup(self.iden, lval)
def __iter__(self):
'''
Protect against RuntimeError during iteration
'''
for valu in tuple(self.vals):
yield valu
def __len__(self):
return len(self.vals)
def add(self, valu):
'''
Add a value to the KvSet.
Args:
valu (obj): A msgpack value to add.
Returns:
None
'''
lval = s_msgpack.en(valu)
self.vals.add(valu)
self.stor.addKvDup(self.iden, lval)
def update(self, vals):
'''
Extend the KvSet by adding any new values from vals to the set.
Args:
vals (list): A list of msgpack values to add to the set.
Returns:
None
'''
dups = [(self.iden, s_msgpack.en(v)) for v in vals]
self.vals.update(vals)
self.stor.addKvDups(dups)
class KvStor(s_eventbus.EventBus):
'''
The KvStor uses an LMDB key-value database to implement
persistence and indexing for primitive data structures.
'''
def __init__(self, path):
s_eventbus.EventBus.__init__(self)
self.lenv = lmdb.open(path, writemap=True, max_dbs=16)
self.oob = self.lenv.open_db(b'oob')
self.dups = self.lenv.open_db(b'dups', dupsort=True)
self.onfini(self._onKvFini)
def _onKvFini(self):
self.lenv.sync()
self.lenv.close()
@functools.lru_cache(maxsize=1024)
def genKvAlias(self, name):
'''
Resolve or create a new object alias by name.
Args:
name (str): String to create or resolve an alias for.
Notes:
The iden returned as an alias is randomly generated the first time
that ``genKvAlias`` is called for a given name.
Returns:
bytes: The iden for the name
'''
lkey = b'alias:' + name.encode('utf8')
with self.lenv.begin(db=self.oob, write=True) as xact:
iden = xact.get(lkey)
if iden is None:
iden = os.urandom(16)
xact.put(lkey, iden)
return iden
def getKvSet(self, name):
'''
Create or retrieve a KvSet by name from the KvStor.
Args:
name (str): The name of the KvList.
Returns:
KvSet: The KvList helper instance.
'''
iden = self.genKvAlias(name)
return KvSet(self, iden)
def getKvDict(self, name):
'''
Create or retrieve a KvDict by name from the KvStor.
Args:
name (str): The name of the KvDict.
Returns:
KvDict: The KvDict helper instance.
'''
iden = self.genKvAlias(name)
return KvDict(self, iden)
def getKvLook(self, name):
'''
Create or retrieve a KvLook by name from the KvStor.
Args:
name (str): The name of the KvLook.
Returns:
KvLook: The KvLook helper instance.
'''
iden = self.genKvAlias(name)
return KvLook(self, iden)
def iterKvDups(self, lkey):
'''
Yield lkey, lval tuples for the given dup key.
Args:
lkey (bytes): The kv key.
Yields:
bytes: The value of the dups for a given key.
'''
with self.lenv.begin(db=self.dups) as xact:
with xact.cursor(db=self.dups) as curs:
if not curs.set_key(lkey):
return
for byts in curs.iternext_dup():
yield byts
def hasKvDups(self, lkey):
'''
Returns True if the number of values for lkey is greater than 0.
Args:
lkey (bytes): The kv key.
Returns:
bool: True if the dups key exists, False otherwise.
'''
with self.lenv.begin(db=self.dups) as xact:
with xact.cursor(db=self.dups) as curs:
return curs.set_key(lkey)
def iterKvProps(self, lkey):
'''
Yield lkey, lval tuples for the given prop prefix.
Args:
lkey (bytes): The kv key prefix.
Yields:
((bytes, bytes)): A tuple of key, value pairs which start with
the prefix.
'''
with self.lenv.begin() as xact:
with xact.cursor() as curs:
if not curs.set_range(lkey):
return
for ikey, ival in curs.iternext():
if not ikey.startswith(lkey):
break
yield (ikey, ival)
def addKvDup(self, lkey, lval):
'''
Add a (potentially duplicate) key=valu to the KvStor.
Args:
lkey (bytes): The kv key.
lval (bytes): The kv val.
Returns:
None
'''
with self.lenv.begin(db=self.dups, write=True) as xact:
xact.put(lkey, lval, dupdata=True)
def setKvProp(self, lkey, lval):
'''
Set a non-duplicate key=valu to the KvStor.
Args:
lkey (bytes): The kv key.
lval (bytes): The kv val.
Returns:
None
'''
with self.lenv.begin(write=True) as xact:
xact.put(lkey, lval)
def getKvProp(self, lkey):
'''
Retrieve the lval bytes for a key.
Args:
lkey (bytes): The kv key.
Returns:
bytes: The kv value, or None if it does not exist.
'''
with self.lenv.begin() as xact:
return xact.get(lkey)
def setKvProps(self, props):
'''
Set a multiple non-duplicate key=valu props in the KvStor.
Args:
props (dict): A dict of lkey: lvalu pairs.
Returns:
None
'''
with self.lenv.begin(write=True) as xact:
for lkey, lval in props.items():
xact.put(lkey, lval)
def addKvDups(self, dups):
'''
Add a list of (lkey,lval) dups to the KvStor.
Args:
dups (list): A list of (lkey,lval) tuples.
'''
with self.lenv.begin(db=self.dups, write=True) as xact:
with xact.cursor() as curs:
curs.putmulti(dups, dupdata=True)
def delKvDup(self, lkey, lval):
'''
Delete a single key=value pair from the KvStor.
Args:
lkey: (bytes): The kv key.
lval: (bytes): The kv value.
Returns:
bool: True if at least one key was deleted, False otherwise
'''
with self.lenv.begin(db=self.dups, write=True) as xact:
return xact.delete(lkey, value=lval)
def delKvProp(self, lkey):
'''
Delete a key=val prop from the KvStor.
Args:
lkey (bytes): key to delete
Returns:
bool: True if at least one key was deleted, False otherwise
'''
with self.lenv.begin(write=True) as xact:
return xact.delete(lkey)