18
|
1
|
;;; rdb.lisp --- High-level RocksDB API |
|
2
|
|
|
3
|
;; a thin ORM for working with RocksDB storage. |
|
4
|
|
|
5
|
;; Low-level bindings are in rocksdb.lisp. |
|
6
|
|
|
7
|
;; Commentary: |
|
8
|
|
|
9
|
;; Code: |
|
10
|
(uiop:define-package :rdb/pkg |
|
11
|
(:nicknames :rdb) |
83
|
12
|
(:use :cl :std/alien :std/fu :std/sym :rocksdb) |
18
|
13
|
(:import-from :sb-ext :string-to-octets :octets-to-string) |
|
14
|
(:export |
84
|
15
|
;; rdb |
|
16
|
:rdb :make-rdb :open-rdb :close-rdb :destroy-rdb |
|
17
|
:rdb-db :rdb-name :rdb-cfs :rdb-opts |
|
18
|
:push-cf :init-cfs |
|
19
|
:insert-kv :insert-kv-str |
18
|
20
|
;; opts |
82
|
21
|
:rdb-opts :make-rdb-opts |
18
|
22
|
:default-rdb-opts |
|
23
|
;; db |
82
|
24
|
:open-db :with-open-db |
|
25
|
:close-db :destroy-db |
83
|
26
|
;; cfs |
|
27
|
:rdb-cf :make-rdb-cf |
84
|
28
|
:rdb-cf-sap :rdb-cf-name |
|
29
|
:with-cf :create-cf |
47
|
30
|
;; ops |
82
|
31
|
:put-kv :put-kv-str |
|
32
|
:get-kv :get-kv-str |
84
|
33
|
:put-cf :put-cf-str |
|
34
|
:get-cf :get-cf-str |
18
|
35
|
;; iter |
|
36
|
:create-iter :with-iter |
|
37
|
:iter-key :iter-key-str |
|
38
|
:iter-val :iter-val-str |
|
39
|
;; err |
82
|
40
|
:open-db-error |
|
41
|
:put-kv-error |
|
42
|
:get-kv-error)) |
18
|
43
|
|
|
44
|
(in-package :rdb/pkg) |
|
45
|
|
83
|
46
|
(defmacro with-errptr (e &body body) |
|
47
|
`(with-alien ((,e rocksdb-errptr)) |
|
48
|
,@body)) |
|
49
|
|
18
|
50
|
(defstruct rdb-opts |
|
51
|
(create-if-missing nil :type boolean) |
|
52
|
(total-threads 1 :type integer) ;; numcpus is default |
|
53
|
(max-open-files 10000 :type integer) |
|
54
|
(use-fsync nil :type boolean) |
47
|
55
|
(destroy nil :type boolean) ;; * |
45
|
56
|
(disable-auto-compactions nil :type boolean)) |
18
|
57
|
|
83
|
58
|
(defstruct rdb-cf |
84
|
59
|
(name "" :type string) |
|
60
|
(sap nil :type (or null alien))) |
83
|
61
|
|
|
62
|
(defun create-cf (db cf) |
84
|
63
|
(setf (rdb-cf-sap cf) |
|
64
|
(with-errptr err |
|
65
|
(rocksdb-create-column-family db (rocksdb-options-create) (rdb-cf-name cf) err)))) |
83
|
66
|
|
|
67
|
(defmacro with-cf ((cf-var cf) &body body) |
|
68
|
`(let ((,cf-var ,cf)) |
|
69
|
,@body)) |
|
70
|
|
18
|
71
|
;; unsafe |
|
72
|
(defun bind-rocksdb-opts% (opts) |
|
73
|
(let ((o (rocksdb-options-create))) |
|
74
|
(with-slots (create-if-missing total-threads) opts |
|
75
|
(rocksdb-options-set-create-if-missing o create-if-missing) |
|
76
|
(rocksdb-options-increase-parallelism o total-threads)) |
|
77
|
o)) |
|
78
|
|
|
79
|
(defun default-rdb-opts () |
|
80
|
(make-rdb-opts |
|
81
|
:create-if-missing t |
|
82
|
:total-threads 4)) |
|
83
|
|
|
84
|
(defun default-rocksdb-options% () |
|
85
|
(bind-rocksdb-opts% (default-rdb-opts))) |
|
86
|
|
82
|
87
|
(defun open-db (db-path &optional opts) |
|
88
|
(let ((opts (if opts (bind-rocksdb-opts% opts) (default-rocksdb-options%)))) |
|
89
|
(with-alien ((e rocksdb-errptr)) |
|
90
|
(let* ((db-path (if (pathnamep db-path) |
|
91
|
(namestring db-path) |
|
92
|
db-path)) |
|
93
|
(db (rocksdb-open opts db-path e)) |
|
94
|
(err e)) |
83
|
95
|
(unless (null-alien err) |
82
|
96
|
(error 'open-db-error |
|
97
|
:db-path db-path |
83
|
98
|
:error-message e)) |
82
|
99
|
db)))) |
|
100
|
|
|
101
|
(defun close-db (db) |
|
102
|
(rocksdb-close db)) |
|
103
|
|
|
104
|
(defun destroy-db (path) |
83
|
105
|
(with-alien ((err rocksdb-errptr)) |
|
106
|
(rocksdb-destroy-db (rocksdb-options-create) path err))) |
82
|
107
|
|
18
|
108
|
(defmacro with-open-db ((db-var db-path &optional opt) &body body) |
|
109
|
`(let ((,db-var (open-db ,db-path ,opt))) |
|
110
|
(unwind-protect (progn ,@body) |
82
|
111
|
(close-db ,db-var) |
|
112
|
(when (and ,opt (rdb-opts-destroy ,opt)) |
|
113
|
(destroy-db ,db-path))))) |
18
|
114
|
|
|
115
|
(defmacro with-iter ((iter-var db &optional opt) &body body) |
|
116
|
`(let ((,iter-var (create-iter ,db ,opt))) |
|
117
|
(unwind-protect (progn ,@body) |
|
118
|
(rocksdb-iter-destroy ,iter-var)))) |
|
119
|
|
|
120
|
;;; Conditions |
82
|
121
|
(define-condition open-db-error (error) |
18
|
122
|
((db-path :initarg :db-path |
|
123
|
:reader db-path) |
|
124
|
(error-message :initarg :error-message |
|
125
|
:reader error-message))) |
|
126
|
|
82
|
127
|
(defmethod print-object ((obj open-db-error) stream) |
18
|
128
|
(print-unreadable-object (obj stream :type t :identity t) |
|
129
|
(format stream "error-message=~A" (error-message obj)))) |
|
130
|
|
82
|
131
|
(define-condition put-kv-error (error) |
18
|
132
|
((db :initarg :db |
|
133
|
:reader db) |
|
134
|
(key :initarg :key |
|
135
|
:reader key) |
|
136
|
(val :initarg :val |
|
137
|
:reader val) |
|
138
|
(error-message :initarg :error-message |
|
139
|
:reader error-message))) |
|
140
|
|
82
|
141
|
(define-condition get-kv-error (error) |
18
|
142
|
((db :initarg :db |
|
143
|
:reader db) |
|
144
|
(key :initarg :key |
|
145
|
:reader key) |
|
146
|
(error-message :initarg :error-message |
|
147
|
:reader error-message))) |
|
148
|
|
|
149
|
(defun put-kv (db key val &optional opts) |
|
150
|
(let ((opts (or opts (rocksdb-writeoptions-create))) |
|
151
|
(klen (length key)) |
|
152
|
(vlen (length val))) |
82
|
153
|
(with-alien ((k (* char) (make-alien char klen)) |
|
154
|
(v (* char) (make-alien char vlen)) |
|
155
|
(errptr rocksdb-errptr nil)) |
|
156
|
(setfa k key) |
|
157
|
(setfa v val) |
18
|
158
|
(rocksdb-put db |
|
159
|
opts |
|
160
|
k |
|
161
|
klen |
|
162
|
v |
|
163
|
vlen |
|
164
|
errptr) |
|
165
|
(unless (null-alien errptr) |
82
|
166
|
(error 'put-kv-error |
18
|
167
|
:db db |
|
168
|
:key key |
|
169
|
:val val |
|
170
|
:error-message (alien-sap errptr)))))) |
|
171
|
|
|
172
|
(defun put-kv-str (db key val &optional opt) |
|
173
|
(let ((key-octets (string-to-octets key)) |
|
174
|
(val-octets (string-to-octets val))) |
|
175
|
(put-kv db key-octets val-octets opt))) |
|
176
|
|
84
|
177
|
(defun put-cf (db cf key val &optional opt) |
|
178
|
(let ((opts (or opt (rocksdb-writeoptions-create))) |
|
179
|
(klen (length key)) |
|
180
|
(vlen (length val))) |
|
181
|
(with-alien ((k (* char) (make-alien char klen)) |
|
182
|
(v (* char) (make-alien char vlen)) |
|
183
|
(errptr rocksdb-errptr nil)) |
|
184
|
(setfa k key) |
|
185
|
(setfa v val) |
|
186
|
(rocksdb-put-cf db |
|
187
|
opts |
|
188
|
cf |
|
189
|
k |
|
190
|
klen |
|
191
|
v |
|
192
|
vlen |
|
193
|
errptr) |
|
194
|
(unless (null-alien errptr) |
|
195
|
(error 'put-kv-error |
|
196
|
:db db |
|
197
|
:key key |
|
198
|
:val val |
|
199
|
:error-message (alien-sap errptr)))))) |
|
200
|
|
|
201
|
(defun put-cf-str (db cf key val &optional opt) |
|
202
|
(let ((key-octets (string-to-octets key)) |
|
203
|
(val-octets (string-to-octets val))) |
|
204
|
(put-cf db cf key-octets val-octets opt))) |
|
205
|
|
18
|
206
|
(defun get-kv (db key &optional opt) |
|
207
|
(let ((opt (or opt (rocksdb-readoptions-create))) |
|
208
|
(klen (length key))) |
82
|
209
|
(with-alien ((vlen (* size-t) (make-alien size-t 0)) |
18
|
210
|
(errptr rocksdb-errptr nil) |
|
211
|
(k (* char) (make-alien char klen))) |
82
|
212
|
(setfa k key) |
18
|
213
|
(let* ((val (rocksdb-get db |
47
|
214
|
opt |
|
215
|
k |
|
216
|
klen |
82
|
217
|
vlen |
|
218
|
errptr))) |
18
|
219
|
(unless (null-alien errptr) |
82
|
220
|
(error 'get-kv-error |
18
|
221
|
:db db |
|
222
|
:key key |
|
223
|
:error-message (alien-sap errptr))) |
|
224
|
;; helps if we know the vlen beforehand, would need a custom |
|
225
|
;; C-side function probably. |
82
|
226
|
(let ((v (make-array (deref vlen) :element-type 'unsigned-byte))) |
|
227
|
(clone-octets-from-alien val v (deref vlen)) |
47
|
228
|
v))))) |
18
|
229
|
|
47
|
230
|
(defun get-kv-str (db key &optional opt) |
18
|
231
|
(let ((k (string-to-octets key))) |
|
232
|
(let ((v (get-kv db k opt))) |
47
|
233
|
(when v (concatenate 'string (map 'vector #'code-char v)))))) |
18
|
234
|
|
84
|
235
|
(defun get-cf (db cf key &optional opt) |
|
236
|
(let ((opt (or opt (rocksdb-readoptions-create))) |
|
237
|
(klen (length key))) |
|
238
|
(with-alien ((vlen (* size-t) (make-alien size-t 0)) |
|
239
|
(errptr rocksdb-errptr nil) |
|
240
|
(k (* char) (make-alien char klen))) |
|
241
|
(setfa k key) |
|
242
|
(let* ((val (rocksdb-get-cf db |
|
243
|
opt |
|
244
|
cf |
|
245
|
k |
|
246
|
klen |
|
247
|
vlen |
|
248
|
errptr))) |
|
249
|
(unless (null-alien errptr) |
|
250
|
(error 'get-kv-error |
|
251
|
:db db |
|
252
|
:key key |
|
253
|
:error-message (alien-sap errptr))) |
|
254
|
;; helps if we know the vlen beforehand, would need a custom |
|
255
|
;; C-side function probably. |
|
256
|
(let ((v (make-array (deref vlen) :element-type 'unsigned-byte))) |
|
257
|
(clone-octets-from-alien val v (deref vlen)) |
|
258
|
v))))) |
|
259
|
|
|
260
|
(defun get-cf-str (db cf key &optional opt) |
|
261
|
(let ((k (string-to-octets key))) |
|
262
|
(let ((v (get-cf db cf k opt))) |
|
263
|
(when v (concatenate 'string (map 'vector #'code-char v)))))) |
|
264
|
|
18
|
265
|
(defun create-iter (db &optional opt) |
|
266
|
(unless opt |
|
267
|
(setq opt (rocksdb-readoptions-create))) |
|
268
|
(rocksdb-create-iterator db opt)) |
|
269
|
|
|
270
|
(defun iter-key (iter) |
82
|
271
|
(with-alien ((klen-ptr (* size-t) (make-alien size-t 0))) |
18
|
272
|
(let* ((key-ptr (rocksdb-iter-key iter klen-ptr)) |
|
273
|
(klen (deref klen-ptr)) |
|
274
|
(k (make-array klen :element-type '(unsigned-byte 8)))) |
82
|
275
|
(clone-octets-from-alien key-ptr k klen) |
18
|
276
|
k))) |
|
277
|
|
|
278
|
(defun iter-key-str (iter) |
|
279
|
(when-let ((k (iter-key iter))) |
|
280
|
(octets-to-string k))) |
|
281
|
|
|
282
|
(defun iter-val (iter) |
82
|
283
|
(with-alien ((vlen-ptr (* size-t) (make-alien size-t 0))) |
18
|
284
|
(let* ((val-ptr (rocksdb-iter-value iter vlen-ptr)) |
|
285
|
(vlen (deref vlen-ptr)) |
|
286
|
(v (make-array vlen :element-type '(unsigned-byte 8)))) |
82
|
287
|
(clone-octets-from-alien val-ptr v vlen) |
18
|
288
|
v))) |
|
289
|
|
|
290
|
(defun iter-val-str (iter) |
|
291
|
(when-let ((v (iter-val iter))) |
|
292
|
(octets-to-string v))) |
84
|
293
|
|
|
294
|
(defstruct rdb |
|
295
|
(name "" :type string) |
|
296
|
(opts (default-rdb-opts) :type rdb-opts) |
|
297
|
(db nil :type (or null alien)) |
|
298
|
(cfs (make-array 0 :element-type 'rdb-cf :adjustable t :fill-pointer 0) :type (array rdb-cf))) |
|
299
|
|
|
300
|
(defmethod push-cf ((cf rdb-cf) (db rdb)) |
|
301
|
(vector-push cf (rdb-cfs db))) |
|
302
|
|
|
303
|
(defmethod open-rdb ((self rdb)) |
|
304
|
(setf (rdb-db self) |
|
305
|
(open-db (rdb-name self) (rdb-opts self)))) |
|
306
|
|
|
307
|
(defmethod close-rdb ((self rdb)) |
|
308
|
(close-db (rdb-db self)) |
|
309
|
(setf (rdb-db self) nil)) |
|
310
|
|
|
311
|
(defmethod destroy-rdb ((self rdb)) |
|
312
|
(when (rdb-db self) (close-rdb self)) |
|
313
|
(destroy-db (rdb-name self))) |
|
314
|
|
|
315
|
(defmethod init-cfs ((self rdb)) |
|
316
|
(loop for cf across (rdb-cfs self) |
|
317
|
do (create-cf (rdb-db self) cf))) |
|
318
|
|
|
319
|
(defmethod insert-kv ((self rdb) key val &optional cf-name) |
|
320
|
(if cf-name |
|
321
|
(put-cf |
|
322
|
(rdb-db self) |
|
323
|
(rdb-cf-sap (find cf-name (rdb-cfs self) :key #'rdb-cf-name :test #'equal)) |
|
324
|
key |
|
325
|
val) |
|
326
|
(put-kv |
|
327
|
(rdb-db self) |
|
328
|
key |
|
329
|
val))) |
|
330
|
|
|
331
|
(defmethod insert-kv-str ((self rdb) key val &optional cf-name) |
|
332
|
(insert-kv self (string-to-octets key) (string-to-octets val) cf-name)) |
|
333
|
|