-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathserver.clj
More file actions
2385 lines (2168 loc) · 99.2 KB
/
Copy pathserver.clj
File metadata and controls
2385 lines (2168 loc) · 99.2 KB
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
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;; server.clj — narrow TermStore v2 database server.
;;
;; Run long-lived servers with `clojure -M`, never Babashka. This surface stays
;; deliberately small until schema/query/pull projections consume TermStore
;; directly; it never reconstructs the removed fact-object APIs.
(ns server
(:require [clojure.java.io :as io]
[framrpc :as framrpc]
[fram.datalog :as datalog]
[fram.kernel :as kernel]
[fram.query :as query]
[fram.store :as term-store]
[fram.text-search :as text-search]
[fram.types :as t]
[fri-port :as fri])
(:import [java.net ServerSocket Socket SocketException SocketTimeoutException]
[java.io ByteArrayOutputStream InputStream OutputStream Writer]
[java.nio ByteBuffer ByteOrder]
[java.security MessageDigest]
[java.time Instant]
[java.util.concurrent ArrayBlockingQueue LinkedBlockingQueue
ThreadFactory ThreadPoolExecutor TimeUnit]
[java.util.concurrent.atomic AtomicLong]))
(load-file "database.clj")
(load-file "writer_authority.clj")
(def database (atom nil))
(def server-role (atom nil))
(def writer-authority (atom nil))
(def listener (atom nil))
(def stopping? (atom false))
(def active-requests (atom {}))
(def connection-executor (atom nil))
(def connection-sockets (atom #{}))
(def active-connections (atom 0))
(def admission-rejections (atom 0))
(def ^:private connection-drain-monitor (Object.))
(def ^:private connection-thread-sequence (AtomicLong. 0))
(def published-snapshot (atom nil))
(def server-generation (atom 0))
(def commit-sequencer (atom nil))
(def commit-sequencer-stats
(atom {:cohorts 0 :frames 0 :barriers 0 :publications 0}))
(def ^:private commit-cohort-max-frames 32)
(def ^:private commit-cohort-max-bytes (* 1024 1024))
(def ^:private commit-cohort-max-wait-ns 1000000)
(def ^:private query-page-snapshot-limit 4)
(def ^:private query-page-snapshots (atom {:order [] :by-version {}}))
(def ^:private query-result-version-limit 4)
(def ^:private query-result-per-version-limit 8)
(def ^:private query-result-byte-limit (* 64 1024 1024))
(def query-archive-manifest (atom []))
(def ^:private query-archive-databases (atom {}))
(def ^:private query-archive-magic
(.getBytes "FRAMQAR1" java.nio.charset.StandardCharsets/UTF_8))
(def ^:private text-index-version-limit 4)
(def ^:private text-index-byte-limit (* 64 1024 1024))
(defn- empty-query-result-cache [generation]
{:generation generation
:entries {}
:lru []
:version-lru []
:in-flight {}
:bytes 0
:hits 0
:misses 0
:evictions 0})
(def query-result-cache (atom (empty-query-result-cache 0)))
(defn- empty-text-index-cache [generation]
{:generation generation
:entries {}
:lru []
:in-flight {}
:bytes 0
:hits 0
:misses 0
:evictions 0})
(def text-index-cache (atom (empty-text-index-cache 0)))
(declare start-commit-sequencer! stop-commit-sequencer! sequence-commit!
stop-connection-admission! serve-connection! response-version
read-query-archive-manifest!)
;; Request observability: the slow threshold is checked before the quiet gate,
;; so a stalled request still leaves a trace under FRAM_SERVER_QUIET.
(defn- env-string [name]
(not-empty (System/getenv name)))
(defn- env-long [name fallback]
(or (when-let [raw (env-string name)]
(try (Long/parseLong (.trim ^String raw)) (catch Throwable _ nil)))
fallback))
(defn- bounded-positive-env-int [name fallback ceiling]
(let [raw (env-string name)
value (some-> raw parse-long)]
(cond
(nil? raw) fallback
(or (nil? value) (not (pos? value)) (> value ceiling))
(throw (ex-info (str name " must be an integer in [1," ceiling "]")
{:variable name :value raw :ceiling ceiling}))
:else (int value))))
(def request-log-path (env-string "FRAM_SERVER_LOG"))
(def request-log-quiet? (= "1" (System/getenv "FRAM_SERVER_QUIET")))
(def slow-request-ms (env-long "FRAM_SLOW_MS" 1000))
(def connection-worker-limit
(bounded-positive-env-int "FRAM_CONNECTION_WORKERS" 32 512))
(def connection-pending-limit
(bounded-positive-env-int "FRAM_CONNECTION_QUEUE" 128 65536))
(def connection-first-frame-timeout-ms
(bounded-positive-env-int "FRAM_CONNECTION_READ_TIMEOUT_MS" 5000 600000))
(def connection-drain-grace-ms
(bounded-positive-env-int "FRAM_SHUTDOWN_CONNECTION_GRACE_MS" 3000 600000))
(def connection-stop-timeout-ms
(bounded-positive-env-int "FRAM_SHUTDOWN_TIMEOUT_MS" 8000 600000))
(def runtime-engine (atom :rpc/jvm))
(def query-checkpoint-interval
(max 1 (env-long "FRAM_QUERY_CHECKPOINT_INTERVAL" 1000)))
(def request-stats
(atom {:requests 0 :errors 0 :slow 0 :ops {} :max-ms 0 :last-ms 0 :last nil}))
(def ^:private request-log-writer (atom nil))
(defn- request-log-sink []
(when request-log-path
(or @request-log-writer
(swap! request-log-writer
#(or % (try (io/writer (io/file request-log-path) :append true)
(catch Throwable _ nil)))))))
(defn- emit-log-line! [line]
;; System/err rather than *err*: a server thread must not inherit whatever
;; dynamic binding happened to be live when the connection thread forked.
(if-let [^Writer writer (request-log-sink)]
(locking request-log-writer
(.write writer ^String line)
(.write writer "\n")
(.flush writer))
(.println System/err line)))
(defn- close-request-log! []
(locking request-log-writer
(when-let [^Writer writer @request-log-writer]
(try (.close writer) (catch Throwable _ nil)))
(reset! request-log-writer nil)))
(defn record-request!
"Account one served request and log it. `elapsed-ns` covers server-side work
only — decode to response-written — so client send time never reads as
database latency."
[operation elapsed-ns outcome code response-bytes]
(let [ms (quot (long elapsed-ns) 1000000)
slow? (>= ms slow-request-ms)]
(swap! request-stats
(fn [stats]
(cond-> stats
true (update :requests inc)
(= :error outcome) (update :errors inc)
slow? (update :slow inc)
true (update-in [:ops (or operation :unknown)] (fnil inc 0))
true (update :max-ms max ms)
true (assoc :last-ms ms
:last {:op operation :ms ms
:outcome outcome :code code}))))
(when (or slow? (not request-log-quiet?))
(emit-log-line!
(str "fram-rpc ts=" (Instant/now)
" op=" (or operation :unknown)
" ms=" ms
" outcome=" (name outcome)
(when code (str " code=" code))
(when response-bytes (str " bytes=" response-bytes))
(when slow? " slow=1"))))
ms))
(defn- response-outcome
"Errors reach the client as a response field, not a thrown exception, so the
only place an error code is observable is the encoded response frame."
[frame]
(if-let [error (some-> frame t/rpcframev2-response t/rpcresponse-error)]
[:error (t/rpcerror-code error)]
[:ok nil]))
(def native-rpc-operations
#{:rpc/version :rpc/status :rpc/assert :rpc/retract :rpc/batch :rpc/scan
:rpc/query :rpc/occurrences :rpc/lease-acquire :rpc/lease-renew
:rpc/lease-release :rpc/lease-check :rpc/validate})
(def paged-rpc-operations #{:rpc/query :rpc/scan :rpc/occurrences})
(def read-only-rpc-operations
(apply disj native-rpc-operations
[:rpc/assert :rpc/retract :rpc/batch :rpc/lease-acquire
:rpc/lease-renew :rpc/lease-release]))
(defn- server-fail! [code message data]
(throw (ex-info message (assoc data :type code :fram/code code :code code))))
(defn- canonical-path [path]
(.getPath (.getCanonicalFile (io/file (str path)))))
(defn writer-authority-status []
(when @database
(let [physical (writer-authority/status
@server-role @writer-authority (:log @database))
lock-held (:write-authorized physical)
recovery (database/database-recovery-state @database)]
(assoc physical
:lock-held lock-held
:write-authorized (and lock-held
(database/mutation-ready? @database))
:database-recovery recovery))))
(defn- writer-lock-held? []
(boolean (and (= :active @server-role)
(writer-authority/held? @writer-authority))))
(defn write-authorized? []
(boolean (and (writer-lock-held?)
(database/mutation-ready? @database))))
;; A published snapshot has to stay frozen while later commits land, and a
;; TermStore is an identity the writer keeps mutating, so the read view is a
;; fork of the current state rather than the live store itself.
(defn- snapshot-of [db]
(let [root (term-store/fork-state @(database/database-store db))]
{:generation @server-generation
:space (database/database-space db)
:version (dec (deref (t/termstore-next-sequence root)))
:root root}))
(defn- publish-snapshot! [db]
(let [snapshot (snapshot-of db)]
(reset! published-snapshot snapshot)
snapshot))
(defn- drop-query-caches! []
(reset! query-page-snapshots {:order [] :by-version {}})
(reset! query-result-cache
(empty-query-result-cache @server-generation))
(reset! text-index-cache
(empty-text-index-cache @server-generation)))
(defn- advance-server-generation! []
(swap! server-generation inc)
(drop-query-caches!))
(defn shutdown! []
(reset! stopping? true)
(when-let [^ServerSocket server @listener]
(try (.close server) (catch Throwable _ nil)))
(doseq [cancellation (vals @active-requests)]
(reset! (:cancelled cancellation) true)
(when-let [control @(:query-control cancellation)]
(datalog/cancel-query! control :server-shutdown)))
(stop-connection-admission!)
(stop-commit-sequencer!)
(reset! active-requests {})
(drop-query-caches!)
(reset! query-archive-manifest [])
(reset! query-archive-databases {})
(reset! published-snapshot nil)
(writer-authority/release! @writer-authority)
(reset! writer-authority nil)
(reset! database nil)
(reset! server-role nil)
(reset! listener nil)
(close-request-log!)
nil)
(defn boot!
"Install one FRAMLOG generation. Active boot acquires lifetime writer
authority before creation or torn-tail repair; standby boot stays read-only."
([path expected-space]
(boot! path expected-space (writer-authority/server-role-from-env)))
([path expected-space role]
(shutdown!)
(reset! stopping? false)
(let [canonical (canonical-path path)
file (io/file canonical)
role (writer-authority/server-role-from (name role))
authority (when (= :active role)
(writer-authority/acquire! canonical))]
(try
(when-not (.exists file)
(when-not expected-space
(server-fail! :space-id-required
"new FRAMLOG generation requires an explicit SpaceId"
{:path canonical}))
(database/create-triple-log! canonical expected-space))
(let [opened (database/open-database!
canonical expected-space {:repair-torn? (= :active role)})]
(advance-server-generation!)
(reset! database opened)
(read-query-archive-manifest! opened)
(publish-snapshot! opened)
(reset! server-role role)
(reset! writer-authority authority)
(when (= :active role)
(start-commit-sequencer!))
opened)
(catch Throwable error
(writer-authority/release! authority)
(throw error))))))
(defn- refresh-standby! []
(when (= :standby @server-role)
(locking database
(let [current @database
opened (database/open-database! (:log current) (:space-id current))]
(advance-server-generation!)
(reset! database opened)
(publish-snapshot! opened)))))
(defn native-op-disposition [operation]
(if (contains? native-rpc-operations operation) :supported :unsupported))
(defn- current-version [db]
(t/triple-t3 (database/current-transaction db)))
(defn- require-term! [value label]
(when-not (t/term? value)
(server-fail! :rpc-invalid-payload (str label " must be a Term") {}))
value)
(defn- require-triple! [value label]
(when-not (t/triple? value)
(server-fail! :rpc-invalid-payload (str label " must be a Triple") {}))
value)
(defn- require-keyword! [value label]
(when-not (keyword? value)
(server-fail! :rpc-invalid-payload (str label " must be a Keyword") {}))
value)
(defn- require-string! [value label]
(when-not (string? value)
(server-fail! :rpc-invalid-payload (str label " must be a String") {}))
value)
(defn- require-int! [value label]
(when-not (integer? value)
(server-fail! :rpc-invalid-payload (str label " must be an Int") {}))
value)
(defn- require-bool! [value label]
(when-not (boolean? value)
(server-fail! :rpc-invalid-payload (str label " must be a Bool") {}))
value)
(defn- record-fields! [value tag field-count]
(framrpc/rpc-record-fields! value tag field-count))
(defn- list-values! [value]
(framrpc/rpc-list-values! value))
(defn- option-value! [value]
[(framrpc/rpc-option-present?! value) (framrpc/rpc-option-value! value)])
(defn- require-unit! [payload]
(when-not (= framrpc/rpc-unit payload)
(server-fail! :rpc-invalid-payload "operation payload must be :rpc/unit" {})))
(defn- cancelled! [cancellation]
(when @(:cancelled cancellation)
(server-fail! :rpc/cancelled "request was cancelled before completion" {})))
(defn- require-writer! []
(when-not (writer-lock-held?)
(server-fail! :rpc/writer-authority-required
"active writer authority is required" {}))
(database/require-mutation-ready! @database))
(defn- require-version-expected! [version expected]
(when (and (some? expected) (not= expected version))
(server-fail! :rpc/conflict "expected-version does not match current version" {})))
(defn- require-expected! [db expected]
(require-version-expected! (current-version db) expected))
(defn- occurrence-epoch [coordinate]
(t/triple-t3 (t/triple-t1 coordinate)))
(defn- millis->instant [value]
(let [seconds (quot value 1000)
millis (mod value 1000)]
(t/instant seconds (* millis 1000000))))
(defn- parse-fence! [value]
(let [[resource holder epoch] (record-fields! value :rpc/fence 3)]
[(require-term! resource "fence resource")
(require-term! holder "fence holder")
(require-int! epoch "fence epoch")]))
(defn- current-fence [db resource]
(when-let [lease (database/current-lease db resource)]
[(:holder lease) (occurrence-epoch (:occurrence lease))
(:occurrence lease) (:expires-ms lease)]))
(defn- valid-fence? [db resource holder epoch now-ms]
(when-let [[current-holder current-epoch _ expires-ms]
(current-fence db resource)]
(and (= holder current-holder) (= epoch current-epoch)
(> expires-ms now-ms))))
(defn- require-fence! [db fence]
(when fence
(let [[resource holder epoch] (parse-fence! fence)]
(when-not (valid-fence? db resource holder epoch
(System/currentTimeMillis))
(server-fail! :rpc/lease-fence-mismatch
"lease fence is not current and unexpired" {})))))
(defn- parse-policy! [value]
(require-keyword! value "subject policy")
(when-not (or (= value framrpc/rpc-subject-any)
(= value framrpc/rpc-subject-existing))
(server-fail! :rpc-invalid-policy "subject policy is unsupported" {}))
value)
(defn- parse-action! [value]
(let [[operation proposition policy] (record-fields! value :rpc/action 3)]
(require-keyword! operation "action operation")
(when-not (or (= operation :rpc/assert) (= operation :rpc/retract))
(server-fail! :rpc-invalid-action "action operation is unsupported" {}))
[operation (require-triple! proposition "action proposition")
(parse-policy! policy)]))
(defn- remove-last-equal [values target]
(let [position (last (keep-indexed (fn [index value]
(when (= value target) index))
values))]
(if (nil? position)
[values false]
[(into (subvec values 0 position) (subvec values (inc position))) true])))
(defn- subject-known? [propositions proposition]
(let [t1 (t/triple-t1 proposition)]
(boolean (some #(= t1 (t/triple-t1 %)) propositions))))
(defn- prepare-actions! [propositions actions]
(loop [remaining actions index 0 simulated propositions
operations [] decisions []]
(if (empty? remaining)
[operations decisions]
(let [[operation proposition policy] (first remaining)]
(when (and (= policy framrpc/rpc-subject-existing)
(not (subject-known? simulated proposition)))
(server-fail! :rpc/subject-not-found
"subject-existing policy requires a live t1" {}))
(if (= operation :rpc/assert)
(recur (rest remaining) (inc index) (conj simulated proposition)
(conj operations {:action :assert :proposition proposition})
(conj decisions [index true]))
(let [[next-propositions changed] (remove-last-equal simulated proposition)]
(recur (rest remaining) (inc index) next-propositions
(conj operations {:action :retract :proposition proposition})
(conj decisions [index changed]))))))))
(defn- prepare-actions-on-store! [db actions]
(if (every? (fn [[operation _ policy]]
(and (= operation :rpc/assert)
(= policy framrpc/rpc-subject-any)))
actions)
[(mapv (fn [[_ proposition _]]
{:action :assert :proposition proposition})
actions)
(mapv (fn [index] [index true]) (range (count actions)))]
(prepare-actions! (database/live-propositions db) actions)))
(defn- predicted-mutation-occurrences [db operations]
(when (seq operations)
(let [transaction
(t/transaction-coordinate
(database/database-space db)
(term-store/next-sequence (database/database-store db)))]
(mapv #(t/occurrence-coordinate transaction %) (range (count operations))))))
(defn- mutation-result [decisions occurrences]
(loop [remaining decisions occurrences (vec occurrences) results []]
(if (empty? remaining)
(framrpc/rpc-mutation-result! results)
(let [[input-index changed] (first remaining)
occurrence (first occurrences)]
(recur (rest remaining)
(subvec occurrences 1)
(conj results
(framrpc/rpc-action-result!
input-index changed occurrence)))))))
(defn- require-encodable-rpc-response!
[request served-version payload]
(framrpc/encode-rpc-frame-v2!
(framrpc/rpc-response-frame
0
(framrpc/rpc-response!
(t/rpcrequest-space request)
(t/rpcrequest-op request)
served-version nil nil payload)))
nil)
(defn- mutation-payload! [db request actions fence cancellation]
(let [expected (t/rpcrequest-expected-version request)]
(require-writer!)
(require-expected! db expected)
(require-fence! db fence)
(cancelled! cancellation)
(let [[operations decisions] (prepare-actions-on-store! db actions)
base (when (some? expected)
(t/transaction-coordinate (database/database-space db) expected))
occurrences (predicted-mutation-occurrences db operations)
served-version
(if (seq operations)
(term-store/next-sequence (database/database-store db))
(term-store/current-sequence (database/database-store db)))
payload (mutation-result decisions occurrences)
_ (require-encodable-rpc-response!
request served-version payload)
committed
(when (seq operations)
(cancelled! cancellation)
(database/commit! db {:base base :operations operations}))]
(when (:reject committed)
(server-fail! :rpc/conflict "expected-version lost its commit race" {}))
payload)))
(defn- handle-write! [request operation cancellation]
(let [[proposition policy fence-option]
(record-fields! (t/rpc-request-payload-value request) :rpc/write 3)
[fence-present fence] (option-value! fence-option)]
(sequence-commit!
request cancellation
(fn [db]
(mutation-payload!
db request [[operation (require-triple! proposition "write proposition")
(parse-policy! policy)]]
(when fence-present (require-triple! fence "write fence")) cancellation)))))
(defn- handle-batch! [request cancellation]
(let [[action-list fence-option]
(record-fields! (t/rpc-request-payload-value request) :rpc/batch 2)
action-values (list-values! action-list)
_ (when (> (count action-values) framrpc/rpc-v2-max-batch-actions)
(server-fail!
:term-depth-exceeded
"batch action count exceeds the TermCodecV1 depth bound"
{:actions (count action-values)
:maximum framrpc/rpc-v2-max-batch-actions}))
actions (mapv parse-action! action-values)
[fence-present fence] (option-value! fence-option)]
(when (empty? actions)
(server-fail! :rpc-invalid-action "batch requires at least one action" {}))
(sequence-commit!
request cancellation
(fn [db]
(mutation-payload!
db request actions
(when fence-present (require-triple! fence "batch fence"))
cancellation)))))
(defn- scan-match? [options proposition]
(every? identity
(map-indexed
(fn [index [present value]]
(or (not present)
(= value ((case index
0 t/triple-t1
1 t/triple-t2
t/triple-t3)
proposition))))
options)))
(defn- query-record-tag [value]
(when (and (t/triple? value) (= :rpc/record (t/triple-t3 value)))
(t/triple-t1 value)))
(defn- parse-query-term! [value]
(case (query-record-tag value)
:query/var
(let [[name] (record-fields! value :query/var 1)]
(datalog/variable (require-string! name "query variable")))
:query/const
(let [[constant] (record-fields! value :query/const 1)]
(datalog/constant (require-term! constant "query constant")))
(server-fail! :query-invalid-term
"query term must be query/var or query/const" {})))
(defn- parse-query-terms! [value]
(mapv parse-query-term! (list-values! value)))
(defn- parse-query-head! [value]
(let [[relation terms] (record-fields! value :query/head 2)]
[(require-string! relation "query head relation")
(parse-query-terms! terms)]))
(defn- parse-query-clause! [value]
(case (query-record-tag value)
:query/relation
(let [[relation terms negated] (record-fields! value :query/relation 3)
relation (require-string! relation "query relation")
terms (parse-query-terms! terms)
negated (require-bool! negated "query negation")]
(if negated
(datalog/negated-literal relation terms)
(datalog/relation-literal relation terms)))
:query/predicate
(let [[operation left right]
(record-fields! value :query/predicate 3)
operation (require-keyword! operation "query predicate")]
(when-not (contains? datalog/comparison-operators operation)
(server-fail! :query-invalid-predicate
"query predicate operation is unsupported" {}))
(datalog/comparison-literal
operation [(parse-query-term! left) (parse-query-term! right)]))
:query/function
(let [[operation terms binding]
(record-fields! value :query/function 3)
operation (require-keyword! operation "query function")]
(when-not (contains? datalog/builtin-operators operation)
(server-fail! :query-invalid-function
"query function operation is unsupported" {}))
(datalog/builtin-literal operation (parse-query-terms! terms)
(require-string! binding "query function binding")))
(server-fail! :query-invalid-clause "query clause record is unsupported" {})))
(defn- parse-query-rule! [value]
(let [[head clauses] (record-fields! value :query/rule 2)
[relation terms] (parse-query-head! head)]
(datalog/rule relation terms (mapv parse-query-clause! (list-values! clauses)))))
(defn- parse-query-stratum! [value]
(let [[rules] (record-fields! value :query/stratum 1)]
(mapv parse-query-rule! (list-values! rules))))
(defn- parse-query-aggregate! [value]
(let [[operation argument-option]
(record-fields! value :query/aggregate 2)
operation (require-keyword! operation "query aggregate")
[argument-present argument] (option-value! argument-option)]
(when-not (contains? query/aggregate-operators operation)
(server-fail! :query-invalid-aggregate
"query aggregate operation is unsupported" {}))
(query/aggregate-spec operation
(when argument-present
(require-int! argument "aggregate argument index")))))
(defn- parse-query-having! [value]
(let [[comparison aggregate-index comparison-value]
(record-fields! value :query/having 3)
comparison (require-keyword! comparison "having comparison")]
(when-not (contains? datalog/comparison-operators comparison)
(server-fail! :query-invalid-having
"having comparison operation is unsupported" {}))
(query/having-clause comparison
(require-int! aggregate-index "having aggregate index")
(require-term! comparison-value "having value"))))
(defn- parse-query-find! [value]
(case (query-record-tag value)
:query/find-relation
(let [[relation] (record-fields! value :query/find-relation 1)]
(query/relation-find (require-string! relation "find relation")))
:query/find-aggregate
(let [[relation grouping aggregates having]
(record-fields! value :query/find-aggregate 4)]
(query/aggregate-find
(require-string! relation "aggregate find relation")
(mapv #(require-int! % "aggregate grouping index")
(list-values! grouping))
(mapv parse-query-aggregate! (list-values! aggregates))
(mapv parse-query-having! (list-values! having))))
(server-fail! :query-invalid-find "query find record is unsupported" {})))
(defn- parse-query-order! [value]
(let [[column direction] (record-fields! value :query/order 2)]
(query/order-clause
(require-int! column "query order column")
(require-keyword! direction "query order direction"))))
(defn- parse-query-plan! [value]
(let [[find strata order limit-option]
(record-fields! value :query/plan 4)
[limit-present limit] (option-value! limit-option)
plan (query/ordered-query-plan
(parse-query-find! find)
(mapv parse-query-stratum! (list-values! strata))
(mapv parse-query-order! (list-values! order))
(when limit-present
(require-int! limit "query limit")))
errors (query/validate-plan! plan)]
(when-let [error (first errors)]
(server-fail! (query/error-code error) (query/error-message error) {}))
plan))
(defn- query-checkpoint-directory [db]
(when-let [log (:log db)]
(io/file (str log ".query-checkpoints"))))
(defn- query-checkpoint-version [^java.io.File file]
(some->> (.getName file)
(re-matches #"snapshot-([0-9]+)\.fri")
second
Long/parseLong))
(defn- query-checkpoint-files [db upper-inclusive]
(if-let [directory (query-checkpoint-directory db)]
(->> (or (.listFiles directory) (make-array java.io.File 0))
(keep (fn [file]
(when-let [version (query-checkpoint-version file)]
(when (<= version upper-inclusive) [version file]))))
(sort-by first >))
[]))
(defn- query-checkpoint-source! [db version]
(let [{:keys [space-id fingerprint valid-bytes sequence]}
(database/triple-log-prefix-source! (:log db) version)]
{:binding (fri/source-binding space-id fingerprint valid-bytes)
:sequence sequence}))
(defn- load-query-checkpoint-root! [db upper-inclusive]
(some
(fn [[version file]]
(try
(let [{:keys [binding sequence]}
(query-checkpoint-source! db version)
image (fri/open-fri! (.getPath ^java.io.File file) binding)
context (term-store/new-term-store (database/database-space db))]
(fri/restore-store! image context)
(let [root @context]
(when (= sequence (dec (deref (t/termstore-next-sequence root)))) root)))
(catch Throwable _ nil)))
(query-checkpoint-files db upper-inclusive)))
(defn- prune-query-checkpoints! [db]
(doseq [[_ file] (drop query-page-snapshot-limit
(query-checkpoint-files db Long/MAX_VALUE))]
(try (.delete ^java.io.File file) (catch Throwable _ nil))))
(defn- write-query-checkpoint! [db version root]
(when (and (:log db)
(pos? version)
(zero? (mod version query-checkpoint-interval)))
(try
(let [directory (query-checkpoint-directory db)
_ (.mkdirs ^java.io.File directory)
path (.getPath (io/file directory (str "snapshot-" version ".fri")))
{:keys [binding]} (query-checkpoint-source! db version)]
(fri/write-fri! (term-store/dump-term-store (atom root)) path binding)
(prune-query-checkpoints! db))
(catch Throwable _ nil)))
root)
(defn- query-archive-directory [db]
(io/file (str (:log db) ".query-archives")))
(defn- query-archive-manifest-file [db]
(io/file (query-archive-directory db) "ranges.v1"))
(defn- write-archive-text! [^java.io.DataOutputStream output value]
(let [bytes (.getBytes (str value) java.nio.charset.StandardCharsets/UTF_8)]
(.writeInt output (alength bytes))
(.write output bytes)))
(defn- read-archive-text! [^java.io.DataInputStream input]
(let [length (.readInt input)]
(when (or (neg? length) (> length 1048576))
(throw (ex-info "query archive manifest string is invalid"
{:type :query/archive-unavailable})))
(let [bytes (byte-array length)]
(.readFully input bytes)
(String. bytes java.nio.charset.StandardCharsets/UTF_8))))
(defn- write-query-archive-manifest! [db entries]
(let [directory (query-archive-directory db)
_ (.mkdirs ^java.io.File directory)
target (query-archive-manifest-file db)
temporary (io/file directory "ranges.v1.tmp")]
(with-open [file-output (java.io.FileOutputStream. temporary)
output (java.io.DataOutputStream.
(java.io.BufferedOutputStream. file-output))]
(.write output query-archive-magic)
(.writeInt output (count entries))
(doseq [{:keys [lower upper expired path fingerprint]} entries]
(.writeLong output lower)
(.writeLong output upper)
(.writeBoolean output (boolean expired))
(write-archive-text! output path)
(write-archive-text! output fingerprint))
(.flush output)
(.force (.getChannel file-output) true))
(java.nio.file.Files/move
(.toPath temporary) (.toPath target)
(into-array java.nio.file.CopyOption
[java.nio.file.StandardCopyOption/ATOMIC_MOVE
java.nio.file.StandardCopyOption/REPLACE_EXISTING]))
(reset! query-archive-manifest entries)
entries))
(defn- read-query-archive-manifest! [db]
(let [file (query-archive-manifest-file db)]
(if-not (.isFile file)
(reset! query-archive-manifest [])
(with-open [input (java.io.DataInputStream.
(java.io.BufferedInputStream.
(java.io.FileInputStream. file)))]
(let [magic (byte-array (alength query-archive-magic))
_ (.readFully input magic)
count-value (.readInt input)]
(when (or (not (java.util.Arrays/equals magic query-archive-magic))
(neg? count-value) (> count-value 100000))
(server-fail! :query/archive-unavailable
"query archive range manifest is invalid" {}))
(reset!
query-archive-manifest
(mapv (fn [_]
{:lower (.readLong input)
:upper (.readLong input)
:expired (.readBoolean input)
:path (read-archive-text! input)
:fingerprint (read-archive-text! input)})
(range count-value))))))))
(defn seal-query-epoch!
"Seal a canonical inclusive prefix and publish its range before cache GC."
[upper-inclusive]
(let [db @database
head (current-version db)]
(when (or (neg? upper-inclusive) (> upper-inclusive head))
(server-fail! :query-invalid-snapshot
"query epoch cut is outside available history" {}))
(let [{:keys [valid-bytes fingerprint]}
(database/triple-log-prefix-source! (:log db) upper-inclusive)
directory (query-archive-directory db)
_ (.mkdirs ^java.io.File directory)
target (io/file directory (str "epoch-through-" upper-inclusive ".framlog"))
temporary (io/file directory (str ".epoch-through-" upper-inclusive ".tmp"))
bytes (java.nio.file.Files/readAllBytes
(.toPath (io/file (:log db))))
prefix (java.util.Arrays/copyOfRange bytes 0 valid-bytes)
prior (vec (remove #(= upper-inclusive (:upper %))
@query-archive-manifest))
lower (if-let [previous (last (sort-by :upper prior))]
(inc (:upper previous)) 0)
entry {:lower lower :upper upper-inclusive :expired false
:path (.getCanonicalPath target)
:fingerprint fingerprint}
entries (vec (sort-by :lower (conj prior entry)))]
(with-open [output (java.io.FileOutputStream. temporary)]
(.write output prefix)
(.flush output)
(.force (.getChannel output) true))
(java.nio.file.Files/move
(.toPath temporary) (.toPath target)
(into-array java.nio.file.CopyOption
[java.nio.file.StandardCopyOption/ATOMIC_MOVE
java.nio.file.StandardCopyOption/REPLACE_EXISTING]))
(write-query-archive-manifest! db entries)
(reset! query-archive-databases {})
(drop-query-caches!)
entry)))
(defn expire-query-epoch!
"Mark one sealed range unavailable by retention policy; canonical deletion is separate."
[upper-inclusive]
(let [db @database
entries (mapv (fn [entry]
(cond-> entry
(= upper-inclusive (:upper entry))
(assoc :expired true)))
@query-archive-manifest)]
(write-query-archive-manifest! db entries)
(reset! query-archive-databases {})
(drop-query-caches!)
entries))
(defn- query-archive-entry [version]
(some #(when (<= (:lower %) version (:upper %)) %) @query-archive-manifest))
(defn- query-history-database! [active version]
(if-let [{:keys [expired path fingerprint upper] :as entry}
(query-archive-entry version)]
(do
(when expired
(server-fail! :query/snapshot-expired
"query snapshot was removed by explicit retention policy"
{:range [(:lower entry) upper]}))
(or (get @query-archive-databases [path fingerprint])
(try
(let [source (database/triple-log-prefix-source! path upper)]
(when-not (= fingerprint (:fingerprint source))
(server-fail! :query/archive-unavailable
"query archive fingerprint does not match its manifest"
{:range [(:lower entry) upper]}))
(let [opened (database/open-database!
path (database/database-space active))]
(swap! query-archive-databases
assoc [path fingerprint] opened)
opened))
(catch Throwable error
(if (contains? #{:query/archive-unavailable
:query/snapshot-expired}
(:fram/code (ex-data error)))
(throw error)
(server-fail! :query/archive-unavailable
"query archive is temporarily unavailable"
{:range [(:lower entry) upper]}))))))
active))
(defn- replayed-store-root! [db version]
(let [head (current-version db)]
(when (or (neg? version) (> version head))
(server-fail! :query-invalid-snapshot
"query snapshot is outside available history" {}))
(if (= version head)
@(database/database-store db)
(let [history-db (query-history-database! db version)
head-root @(database/database-store history-db)
base (load-query-checkpoint-root! history-db version)
context (if base
(atom base)
(term-store/new-term-store
(database/database-space history-db)))
lower-exclusive (dec (deref (t/termstore-next-sequence @context)))]
(doseq [frame (term-store/transaction-frames-between
head-root lower-exclusive version)]
(term-store/replay-transaction! context frame))
(write-query-checkpoint! history-db version @context)))))
(defn- snapshot-image [version root]
(let [context (atom root)]
{:version version
:store-root root
:propositions (term-store/live-propositions context)}))
(defn- occurrence-candidate-source [root lower-exclusive upper-inclusive]
(datalog/occurrence-candidate-source root lower-exclusive upper-inclusive))
(defn- withdrawal-candidate-source [root lower-exclusive upper-inclusive]
(datalog/withdrawal-candidate-source root lower-exclusive upper-inclusive))
(defn- one-triple-pattern [plan]
(let [find (query/queryplan-find plan)
strata (query/queryplan-strata plan)
rules (when (= 1 (count strata)) (first strata))
rule (when (= 1 (count rules)) (first rules))
body (when rule (datalog/rule-body rule))
literal (when (= 1 (count body)) (first body))
head-arguments (when rule (datalog/rule-head-arguments rule))
arguments (when literal (datalog/literal-arguments literal))]
(when (and (some? rule)
(some? literal)
(empty? (query/queryplan-order plan))
(nil? (query/queryplan-limit plan))
(not (query/aggregate-find? find))
(= (query/findspec-relation find)
(datalog/rule-head-relation rule))
(= :relation (datalog/literal-kind literal))
(= datalog/triple-relation (datalog/literal-relation literal))
(not (datalog/literal-negated literal))
(= 3 (count arguments)))
{:arguments arguments :head-arguments head-arguments})))
(defn- plan-uses-text? [plan]
(boolean
(some (fn [stratum]
(some (fn [rule]
(some #(and (= :relation (datalog/literal-kind %))
(contains? datalog/text-relations
(datalog/literal-relation %)))
(datalog/rule-body rule)))
stratum))
(query/queryplan-strata plan))))
(def ^:private history-relations
#{datalog/occurrence-relation datalog/withdrawal-relation})
(defn- plan-history-relations [plan]
(into #{}
(comp
(mapcat identity)
(mapcat datalog/rule-body)
(filter #(= :relation (datalog/literal-kind %)))
(map datalog/literal-relation)
(filter history-relations))
(query/queryplan-strata plan)))