Source file minidebug_db.ml
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
(** Database-backed tracing runtime for ppx_minidebug.
This module provides a database backend for storing debug traces with
content-addressed deduplication. It implements the Debug_runtime interface and stores
logs in a SQLite database with automatic deduplication of repeated values. *)
module CFormat = Format
(** Schema management and database initialization *)
module Schema = struct
(** Database schema version for migration management *)
let schema_version = 3
(** Initialize metadata database with runs table. The metadata DB tracks all runs across
versioned database files. *)
let initialize_meta_db db =
Sqlite3.exec db
{|CREATE TABLE IF NOT EXISTS runs (
run_id INTEGER PRIMARY KEY AUTOINCREMENT,
run_name TEXT,
timestamp TEXT NOT NULL,
elapsed_ns INTEGER NOT NULL,
command_line TEXT,
db_file TEXT NOT NULL,
status TEXT DEFAULT 'active'
)|}
|> ignore;
Sqlite3.exec db
"CREATE INDEX IF NOT EXISTS idx_runs_timestamp ON runs(timestamp DESC)"
|> ignore;
Sqlite3.exec db "CREATE INDEX IF NOT EXISTS idx_runs_name ON runs(run_name)" |> ignore;
Sqlite3.exec db
{|CREATE TABLE IF NOT EXISTS schema_version (
version INTEGER PRIMARY KEY
)|}
|> ignore;
Sqlite3.exec db "INSERT OR IGNORE INTO schema_version (version) VALUES (3)" |> ignore
(** Initialize versioned database tables (no runs table - that's in metadata DB) *)
let initialize_db db =
Sqlite3.exec db
{|CREATE TABLE IF NOT EXISTS value_atoms (
value_id INTEGER PRIMARY KEY AUTOINCREMENT,
value_hash TEXT UNIQUE NOT NULL,
value_content TEXT NOT NULL,
value_type TEXT,
size_bytes INTEGER
)|}
|> ignore;
Sqlite3.exec db "CREATE INDEX IF NOT EXISTS idx_value_hash ON value_atoms(value_hash)"
|> ignore;
Sqlite3.exec db
{|CREATE TABLE IF NOT EXISTS entry_parents (
scope_id INTEGER PRIMARY KEY,
parent_id INTEGER
)|}
|> ignore;
Sqlite3.exec db
{|CREATE TABLE IF NOT EXISTS entries (
scope_id INTEGER NOT NULL,
seq_id INTEGER NOT NULL,
child_scope_id INTEGER,
depth INTEGER NOT NULL,
message_value_id INTEGER REFERENCES value_atoms(value_id),
location_value_id INTEGER REFERENCES value_atoms(value_id),
data_value_id INTEGER REFERENCES value_atoms(value_id),
structure_value_id INTEGER REFERENCES value_atoms(value_id),
elapsed_start_ns INTEGER NOT NULL,
elapsed_end_ns INTEGER,
is_result BOOLEAN DEFAULT FALSE,
log_level INTEGER,
entry_type TEXT,
PRIMARY KEY (scope_id, seq_id)
)|}
|> ignore;
Sqlite3.exec db
"CREATE INDEX IF NOT EXISTS idx_entries_child_scope ON entries(child_scope_id)"
|> ignore;
Sqlite3.exec db "CREATE INDEX IF NOT EXISTS idx_entries_depth ON entries(depth)"
|> ignore;
Sqlite3.exec db
{|CREATE TABLE IF NOT EXISTS schema_version (
version INTEGER PRIMARY KEY
)|}
|> ignore;
Sqlite3.exec db
(Printf.sprintf "INSERT OR IGNORE INTO schema_version (version) VALUES (%d)"
schema_version)
|> ignore;
Sqlite3.exec db "PRAGMA journal_mode=DELETE" |> ignore;
Sqlite3.exec db "PRAGMA synchronous=OFF" |> ignore
end
(** Content-addressed value storage with O(1) deduplication *)
module ValueIntern = struct
type t = {
db : Sqlite3.db; [@warning "-69"]
insert_stmt : Sqlite3.stmt;
lookup_stmt : Sqlite3.stmt;
}
(** Create a new value interning context *)
let create db =
let insert_stmt =
Sqlite3.prepare db
"INSERT OR IGNORE INTO value_atoms (value_hash, value_content, value_type, \
size_bytes) VALUES (?, ?, ?, ?)"
in
let lookup_stmt =
Sqlite3.prepare db "SELECT value_id FROM value_atoms WHERE value_hash = ?"
in
{ db; insert_stmt; lookup_stmt }
(** Hash a string value for content addressing *)
let hash_value content = Digest.to_hex (Digest.string content)
(** Intern a value and return its value_id *)
let intern t ~value_type content =
let hash = hash_value content in
let size = String.length content in
Sqlite3.reset t.lookup_stmt |> ignore;
Sqlite3.bind_text t.lookup_stmt 1 hash |> ignore;
match Sqlite3.step t.lookup_stmt with
| Sqlite3.Rc.ROW ->
let value_id = Sqlite3.Data.to_int_exn (Sqlite3.column t.lookup_stmt 0) in
Sqlite3.reset t.lookup_stmt |> ignore;
value_id
| _ ->
Sqlite3.reset t.lookup_stmt |> ignore;
Sqlite3.reset t.insert_stmt |> ignore;
Sqlite3.bind_text t.insert_stmt 1 hash |> ignore;
Sqlite3.bind_text t.insert_stmt 2 content |> ignore;
Sqlite3.bind_text t.insert_stmt 3 value_type |> ignore;
Sqlite3.bind_int t.insert_stmt 4 size |> ignore;
(match Sqlite3.step t.insert_stmt with
| Sqlite3.Rc.DONE -> ()
| _ -> failwith "Failed to insert value");
Sqlite3.reset t.insert_stmt |> ignore;
Sqlite3.reset t.lookup_stmt |> ignore;
Sqlite3.bind_text t.lookup_stmt 1 hash |> ignore;
let value_id =
match Sqlite3.step t.lookup_stmt with
| Sqlite3.Rc.ROW -> Sqlite3.Data.to_int_exn (Sqlite3.column t.lookup_stmt 0)
| _ -> failwith "Failed to retrieve value_id after insert"
in
Sqlite3.reset t.lookup_stmt |> ignore;
value_id
(** Finalize prepared statements *)
let finalize t =
Sqlite3.finalize t.insert_stmt |> ignore;
Sqlite3.finalize t.lookup_stmt |> ignore
end
(** Extended config module type *)
module type Db_config = sig
include Minidebug_runtime.Shared_config
end
(** Global counter for versioning database files. Each runtime instance gets a unique run
number to prevent conflicts. This is process-global, shared across all DatabaseBackend
functor instances. *)
let global_run_counter = Atomic.make 0
(** Database backend implementing Debug_runtime interface *)
module DatabaseBackend (Log_to : Db_config) : Minidebug_runtime.Debug_runtime = struct
open Log_to
let log_level = ref init_log_level
let max_nesting_depth = ref None
let max_num_children = ref None
(** Calculate the size of a sexp (number of atoms) *)
let sexp_size sexp =
let open Sexplib0.Sexp in
let rec loop = function
| Atom _ -> 1
| List l -> List.fold_left ( + ) 0 (List.map loop l)
in
loop sexp
type entry_info = {
scope_id : int;
parent_id : int option; [@warning "-69"]
depth : int; [@warning "-69"]
elapsed_start : Mtime.span; [@warning "-69"]
mutable num_children : int;
message : string; [@warning "-69"]
fname : string; [@warning "-69"]
log_level : int; [@warning "-69"]
}
let db_path = ref None
let db = ref None
let meta_db = ref None
let run_id = ref None
let intern = ref None
let transaction_started =
ref false
let stack : entry_info list ref = ref []
let hidden_entries = ref []
let root_seq_counter = ref 0
let boxify_scope_id_counter = ref 0
let orphaned_seq_counters =
ref []
(** Cache for boxified sexp structures - maps sexp content hash to scope_id. Enables
deduplication of repeated substructures. Uses MD5 hash of sexp string for proper
content-based deduplication. *)
module SexpCache = struct
let cache : (string, int) Hashtbl.t = Hashtbl.create 1000
let hash sexp =
let str = Sexplib0.Sexp.to_string sexp in
Digest.to_hex (Digest.string str)
let find_opt sexp =
let h = hash sexp in
Hashtbl.find_opt cache h
let add sexp scope_id =
let h = hash sexp in
Hashtbl.add cache h scope_id
end
(** Initialize database connection *)
let initialize_database base_filename =
let run_number = Atomic.fetch_and_add global_run_counter 1 + 1 in
let filename =
let base = Filename.remove_extension base_filename in
let ext = Filename.extension base_filename in
Printf.sprintf "%s_%d%s" base run_number ext
in
let meta_filename =
let base = Filename.remove_extension base_filename in
Printf.sprintf "%s_meta.db" base
in
let meta_handle = Sqlite3.db_open meta_filename in
Sqlite3.busy_timeout meta_handle 5000;
Schema.initialize_meta_db meta_handle;
meta_db := Some meta_handle;
if Sys.file_exists filename then Sys.remove filename;
let db_handle = Sqlite3.db_open filename in
Sqlite3.busy_timeout db_handle 5000;
Schema.initialize_db db_handle;
db := Some db_handle;
db_path := Some filename;
(try
if Sys.file_exists base_filename then Sys.remove base_filename;
Unix.symlink (Filename.basename filename) base_filename
with _ -> ());
intern := Some (ValueIntern.create db_handle);
let timestamp =
let buf = Buffer.create 512 in
let formatter = CFormat.formatter_of_buffer buf in
let tz_offset_s = Ptime_clock.current_tz_offset_s () in
Ptime.(pp_human ~frac_s:6 ?tz_offset_s ()) formatter (Ptime_clock.now ());
CFormat.pp_print_flush formatter ();
Buffer.contents buf
in
let elapsed_ns =
match Int64.unsigned_to_int @@ Mtime.Span.to_uint64_ns (Mtime_clock.elapsed ()) with
| None -> 0
| Some ns -> ns
in
let cmd = String.concat " " (Array.to_list Sys.argv) in
let run_name_str = if global_prefix = "" then None else Some global_prefix in
let stmt =
Sqlite3.prepare meta_handle
"INSERT INTO runs (run_name, timestamp, elapsed_ns, command_line, db_file, \
status) VALUES (?, ?, ?, ?, ?, ?)"
in
(match run_name_str with
| Some name -> Sqlite3.bind_text stmt 1 name
| None -> Sqlite3.bind stmt 1 Sqlite3.Data.NULL)
|> ignore;
Sqlite3.bind_text stmt 2 timestamp |> ignore;
Sqlite3.bind_int stmt 3 elapsed_ns |> ignore;
Sqlite3.bind_text stmt 4 cmd |> ignore;
Sqlite3.bind_text stmt 5 (Filename.basename filename) |> ignore;
Sqlite3.bind_text stmt 6 "active" |> ignore;
(match Sqlite3.step stmt with
| Sqlite3.Rc.DONE -> ()
| _ -> failwith "Failed to create run in metadata DB");
Sqlite3.finalize stmt |> ignore;
run_id := Some (Int64.to_int (Sqlite3.last_insert_rowid meta_handle));
at_exit (fun () ->
try
if !transaction_started then (
Sqlite3.exec db_handle "COMMIT" |> ignore;
transaction_started := false)
with _ -> ());
let commit_and_exit _signal =
(try
if !transaction_started then (
Sqlite3.exec db_handle "COMMIT" |> ignore;
transaction_started := false;
Printf.eprintf "\nDebug trace committed to %s before exit.\n%!" filename)
with _ -> ());
raise Sys.Break
in
Sys.set_signal Sys.sigint (Sys.Signal_handle commit_and_exit);
Sys.set_signal Sys.sigterm (Sys.Signal_handle commit_and_exit)
(** Get or create database connection *)
let get_db () =
match !db with
| Some db -> db
| None ->
let base_filename = debug_ch_name () in
let filename =
if Filename.check_suffix base_filename ".db" then base_filename
else base_filename ^ ".db"
in
initialize_database filename;
Option.get !db
let get_intern () = Option.get !intern
let check_log_level level = level <= !log_level
(** Start transaction when entering a top-level scope. This is called from open_log when
stack is empty. *)
let begin_toplevel_transaction () =
if not !transaction_started then (
let db = get_db () in
Sqlite3.exec db "BEGIN TRANSACTION" |> ignore;
transaction_started := true)
(** Commit transaction when leaving a top-level scope. This is called from close_log
when stack becomes empty. This unlocks the database so other processes can read it.
*)
let commit_toplevel_transaction () =
if !transaction_started then (
let db = get_db () in
Sqlite3.exec db "COMMIT" |> ignore;
transaction_started := false)
let should_log_path fname message =
match Log_to.path_filter with
| None -> true
| Some (`Whitelist re) -> Re.execp re (fname ^ "/" ^ message)
| Some (`Blacklist re) -> not (Re.execp re (fname ^ "/" ^ message))
let should_log ~log_level ~fname ~message =
check_log_level log_level && should_log_path fname message
let open_log ~fname ~start_lnum ~start_colnum ~end_lnum ~end_colnum ~message ~scope_id
~log_level log_type =
if not (should_log ~log_level ~fname ~message) then
hidden_entries := scope_id :: !hidden_entries
else
let db = get_db () in
let intern = get_intern () in
let parent_scope_id, seq_id =
match !stack with
| [] ->
begin_toplevel_transaction ();
let seq = !root_seq_counter in
incr root_seq_counter;
(None, seq)
| parent :: _ -> (Some parent.scope_id, parent.num_children)
in
let depth = List.length !stack in
let elapsed_start = Mtime_clock.elapsed () in
let parent_stmt =
Sqlite3.prepare db "INSERT INTO entry_parents (scope_id, parent_id) VALUES (?, ?)"
in
Sqlite3.bind_int parent_stmt 1 scope_id |> ignore;
(match parent_scope_id with
| None -> Sqlite3.bind parent_stmt 2 Sqlite3.Data.NULL
| Some pid -> Sqlite3.bind_int parent_stmt 2 pid)
|> ignore;
(match Sqlite3.step parent_stmt with
| Sqlite3.Rc.DONE -> ()
| _ -> failwith "Failed to insert entry parent");
Sqlite3.finalize parent_stmt |> ignore;
let message_value_id = ValueIntern.intern intern ~value_type:"message" message in
let location =
Printf.sprintf "%s:%d:%d-%d:%d" fname start_lnum start_colnum end_lnum end_colnum
in
let location_value_id = ValueIntern.intern intern ~value_type:"location" location in
let stmt =
Sqlite3.prepare db
"INSERT INTO entries (scope_id, seq_id, child_scope_id, depth, \
message_value_id, location_value_id, elapsed_start_ns, log_level, entry_type) \
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)"
in
(match parent_scope_id with
| None -> Sqlite3.bind_int stmt 1 0
| Some pid -> Sqlite3.bind_int stmt 1 pid)
|> ignore;
Sqlite3.bind_int stmt 2 seq_id |> ignore;
Sqlite3.bind_int stmt 3 scope_id |> ignore;
Sqlite3.bind_int stmt 4 depth |> ignore;
Sqlite3.bind_int stmt 5 message_value_id |> ignore;
Sqlite3.bind_int stmt 6 location_value_id |> ignore;
let elapsed_ns =
match Int64.unsigned_to_int @@ Mtime.Span.to_uint64_ns elapsed_start with
| None -> 0
| Some ns -> ns
in
Sqlite3.bind_int stmt 7 elapsed_ns |> ignore;
Sqlite3.bind_int stmt 8 log_level |> ignore;
let entry_type_str =
match log_type with `Diagn -> "diagn" | `Debug -> "debug" | `Track -> "track"
in
Sqlite3.bind_text stmt 9 entry_type_str |> ignore;
(match Sqlite3.step stmt with
| Sqlite3.Rc.DONE -> ()
| rc ->
let errmsg = Sqlite3.errmsg db in
let existing_info =
let query_stmt =
Sqlite3.prepare db
"SELECT child_scope_id, depth, message_value_id, location_value_id, \
log_level, entry_type FROM entries WHERE scope_id = ? AND seq_id = ?"
in
Sqlite3.bind_int query_stmt 1
(match parent_scope_id with None -> 0 | Some pid -> pid)
|> ignore;
Sqlite3.bind_int query_stmt 2 seq_id |> ignore;
match Sqlite3.step query_stmt with
| Sqlite3.Rc.ROW ->
let existing =
Printf.sprintf
"Existing: child_scope_id=%s, depth=%s, message_value_id=%s, \
location_value_id=%s, log_level=%s, entry_type=%s"
(Sqlite3.Data.to_string_debug (Sqlite3.column query_stmt 0))
(Sqlite3.Data.to_string_debug (Sqlite3.column query_stmt 1))
(Sqlite3.Data.to_string_debug (Sqlite3.column query_stmt 2))
(Sqlite3.Data.to_string_debug (Sqlite3.column query_stmt 3))
(Sqlite3.Data.to_string_debug (Sqlite3.column query_stmt 4))
(Sqlite3.Data.to_string_debug (Sqlite3.column query_stmt 5))
in
Sqlite3.finalize query_stmt |> ignore;
existing
| _ ->
Sqlite3.finalize query_stmt |> ignore;
"No existing entry found"
in
failwith
(Printf.sprintf
"Failed to insert header entry: %s (rc=%s)\n\
Trying to insert: scope_id=%d, seq_id=%d, child_scope_id=%d, depth=%d, \
log_level=%d, entry_type=%s\n\
%s"
errmsg (Sqlite3.Rc.to_string rc)
(match parent_scope_id with None -> 0 | Some pid -> pid)
seq_id scope_id depth log_level entry_type_str existing_info));
Sqlite3.finalize stmt |> ignore;
let entry =
{
scope_id;
parent_id = parent_scope_id;
depth;
elapsed_start;
num_children = 0;
message;
fname;
log_level;
}
in
stack := entry :: !stack;
match !stack with
| _ :: parent :: _ -> parent.num_children <- parent.num_children + 1
| _ -> ()
let open_log_no_source ~message ~scope_id ~log_level log_type =
open_log ~fname:"" ~start_lnum:0 ~start_colnum:0 ~end_lnum:0 ~end_colnum:0 ~message
~scope_id ~log_level log_type
(** Generate a fresh synthetic scope_id for boxified values *)
let get_boxify_scope_id () =
decr boxify_scope_id_counter;
!boxify_scope_id_counter
(** Helper to insert a header entry with data into the database. Used for
indentation-based sub-scopes. *)
let ~parent_scope_id ~seq_id ~new_scope_id ~depth ~message
~content_str ~is_result =
let db = get_db () in
let intern = get_intern () in
let parent_stmt =
Sqlite3.prepare db "INSERT INTO entry_parents (scope_id, parent_id) VALUES (?, ?)"
in
Sqlite3.bind_int parent_stmt 1 new_scope_id |> ignore;
Sqlite3.bind_int parent_stmt 2 parent_scope_id |> ignore;
(match Sqlite3.step parent_stmt with
| Sqlite3.Rc.DONE -> ()
| _ -> failwith "Failed to insert entry parent for header");
Sqlite3.finalize parent_stmt |> ignore;
let message_value_id = ValueIntern.intern intern ~value_type:"message" message in
let value_type = if is_result then "result" else "value" in
let data_value_id = ValueIntern.intern intern ~value_type content_str in
let elapsed_start = Mtime_clock.elapsed () in
let elapsed_ns =
match Int64.unsigned_to_int @@ Mtime.Span.to_uint64_ns elapsed_start with
| None -> 0
| Some ns -> ns
in
let stmt =
Sqlite3.prepare db
"INSERT INTO entries (scope_id, seq_id, child_scope_id, depth, message_value_id, \
data_value_id, elapsed_start_ns, elapsed_end_ns, is_result, log_level, \
entry_type) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)"
in
Sqlite3.bind_int stmt 1 parent_scope_id |> ignore;
Sqlite3.bind_int stmt 2 seq_id |> ignore;
Sqlite3.bind_int stmt 3 new_scope_id |> ignore;
Sqlite3.bind_int stmt 4 depth |> ignore;
Sqlite3.bind_int stmt 5 message_value_id |> ignore;
Sqlite3.bind_int stmt 6 data_value_id |> ignore;
Sqlite3.bind_int stmt 7 elapsed_ns |> ignore;
Sqlite3.bind_int stmt 8 elapsed_ns |> ignore;
Sqlite3.bind_int stmt 9 (if is_result then 1 else 0) |> ignore;
Sqlite3.bind_int stmt 10 !log_level |> ignore;
Sqlite3.bind_text stmt 11 "value" |> ignore;
(match Sqlite3.step stmt with
| Sqlite3.Rc.DONE -> ()
| rc ->
let err_msg =
Printf.sprintf "Failed to insert header with data: %s (scope_id=%d, seq_id=%d)"
(Sqlite3.Rc.to_string rc) parent_scope_id seq_id
in
Sqlite3.finalize stmt |> ignore;
failwith err_msg);
Sqlite3.finalize stmt |> ignore
(** Helper to insert a value entry into the database *)
let insert_value_entry ~scope_id ~seq_id ~depth ~message ~content_str ~is_result =
let db = get_db () in
let intern = get_intern () in
let message_value_id = ValueIntern.intern intern ~value_type:"message" message in
let value_type = if is_result then "result" else "value" in
let data_value_id = ValueIntern.intern intern ~value_type content_str in
let elapsed_start = Mtime_clock.elapsed () in
let elapsed_ns =
match Int64.unsigned_to_int @@ Mtime.Span.to_uint64_ns elapsed_start with
| None -> 0
| Some ns -> ns
in
let stmt =
Sqlite3.prepare db
"INSERT INTO entries (scope_id, seq_id, child_scope_id, depth, message_value_id, \
data_value_id, elapsed_start_ns, elapsed_end_ns, is_result, log_level, \
entry_type) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)"
in
Sqlite3.bind_int stmt 1 scope_id |> ignore;
Sqlite3.bind_int stmt 2 seq_id |> ignore;
Sqlite3.bind stmt 3 Sqlite3.Data.NULL |> ignore;
Sqlite3.bind_int stmt 4 depth |> ignore;
Sqlite3.bind_int stmt 5 message_value_id |> ignore;
Sqlite3.bind_int stmt 6 data_value_id |> ignore;
Sqlite3.bind_int stmt 7 elapsed_ns |> ignore;
Sqlite3.bind_int stmt 8 elapsed_ns |> ignore;
Sqlite3.bind_int stmt 9 (if is_result then 1 else 0) |> ignore;
Sqlite3.bind_int stmt 10 1 |> ignore;
Sqlite3.bind_text stmt 11 "value" |> ignore;
(match Sqlite3.step stmt with
| Sqlite3.Rc.DONE -> ()
| rc ->
let err_msg =
Printf.sprintf
"Failed to insert value row: %s (scope_id=%d, seq_id=%d, depth=%d, \
message=%S, content=%S)"
(Sqlite3.Rc.to_string rc) scope_id seq_id depth message content_str
in
Sqlite3.finalize stmt |> ignore;
failwith err_msg);
Sqlite3.finalize stmt |> ignore
(** Boxify a sexp: split it into multiple database entries with synthetic scope_ids.
Directly inserts entries into the database, creating proper nested scope structure.
Returns the number of entries inserted. *)
let boxify ~descr ~depth ~parent_scope_id ~is_result sexp =
let open Sexplib0.Sexp in
let parent_entry = List.find_opt (fun e -> e.scope_id = parent_scope_id) !stack in
let seq_counter =
ref (match parent_entry with Some p -> p.num_children | None -> 0)
in
let get_next_seq () =
let s = !seq_counter in
incr seq_counter;
s
in
let boxify_threshold = 10 in
let num_inserted = ref 0 in
let rec loop ~is_toplevel ~depth ~parent_eid ~get_seq sexp =
let message =
if is_toplevel then match descr with Some d -> d | None -> "" else ""
in
let is_result = is_toplevel && is_result in
match SexpCache.find_opt sexp with
| Some cached_scope_id when not is_toplevel ->
let seq_id = get_seq () in
let db = get_db () in
let intern = get_intern () in
let first_atom =
match sexp with
| Atom s -> Some s
| List (Atom s :: _) -> Some s
| List _ -> Some "<scope>"
in
let message_value_id =
if message = "" then None
else Some (ValueIntern.intern intern ~value_type:"message" message)
in
let data_value_id =
match first_atom with
| Some d -> Some (ValueIntern.intern intern ~value_type:"value" d)
| None -> None
in
let elapsed_start = Mtime_clock.elapsed () in
let elapsed_ns =
match Int64.unsigned_to_int @@ Mtime.Span.to_uint64_ns elapsed_start with
| None -> 0
| Some ns -> ns
in
let stmt =
Sqlite3.prepare db
"INSERT INTO entries (scope_id, seq_id, child_scope_id, depth, \
message_value_id, data_value_id, elapsed_start_ns, elapsed_end_ns, \
is_result, log_level, entry_type) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, \
?)"
in
Sqlite3.bind_int stmt 1 parent_eid |> ignore;
Sqlite3.bind_int stmt 2 seq_id |> ignore;
Sqlite3.bind_int stmt 3 cached_scope_id |> ignore;
Sqlite3.bind_int stmt 4 depth |> ignore;
(match message_value_id with
| Some mid -> Sqlite3.bind_int stmt 5 mid
| None -> Sqlite3.bind stmt 5 Sqlite3.Data.NULL)
|> ignore;
(match data_value_id with
| Some did -> Sqlite3.bind_int stmt 6 did
| None -> Sqlite3.bind stmt 6 Sqlite3.Data.NULL)
|> ignore;
Sqlite3.bind_int stmt 7 elapsed_ns |> ignore;
Sqlite3.bind_int stmt 8 elapsed_ns |> ignore;
Sqlite3.bind_int stmt 9 0 |> ignore;
Sqlite3.bind_int stmt 10 !log_level |> ignore;
Sqlite3.bind_text stmt 11 "value" |> ignore;
(match Sqlite3.step stmt with
| Sqlite3.Rc.DONE -> ()
| rc ->
failwith
(Printf.sprintf "Failed to insert cached reference: %s"
(Sqlite3.Rc.to_string rc)));
Sqlite3.finalize stmt |> ignore;
incr num_inserted
| _ -> (
let process_and_return_scope () =
match sexp with
| List (Atom s :: body) ->
let synthetic_id = get_boxify_scope_id () in
insert_header_with_data ~parent_scope_id:parent_eid ~seq_id:(get_seq ())
~new_scope_id:synthetic_id ~depth ~message ~content_str:s ~is_result;
incr num_inserted;
let synthetic_seq = ref 0 in
let get_synthetic_seq () =
let s = !synthetic_seq in
incr synthetic_seq;
s
in
List.iter
(fun child ->
loop ~is_toplevel:false ~depth:(depth + 1) ~parent_eid:synthetic_id
~get_seq:get_synthetic_seq child)
body;
Some synthetic_id
| List body when is_toplevel ->
loop ~is_toplevel ~depth ~parent_eid ~get_seq
(List (Atom "<scope>" :: body));
None
| _ when sexp_size sexp < boxify_threshold ->
let content = Sexplib0.Sexp.to_string_hum sexp in
insert_value_entry ~scope_id:parent_eid ~seq_id:(get_seq ()) ~depth
~message ~content_str:content ~is_result;
incr num_inserted;
None
| Atom s ->
insert_value_entry ~scope_id:parent_eid ~seq_id:(get_seq ()) ~depth
~message ~content_str:s ~is_result;
incr num_inserted;
None
| List [] ->
if is_toplevel then
if message <> "" || is_result then (
insert_value_entry ~scope_id:parent_eid ~seq_id:(get_seq ()) ~depth
~message ~content_str:"()" ~is_result;
incr num_inserted);
None
| List [ s ] ->
loop ~is_toplevel ~depth:(depth + 1) ~parent_eid ~get_seq s;
None
| List l ->
List.iter
(fun child ->
loop ~is_toplevel:false ~depth:(depth + 1) ~parent_eid ~get_seq child)
l;
None
in
let created_scope_id_opt = process_and_return_scope () in
match created_scope_id_opt with
| Some created_scope_id when not is_toplevel ->
SexpCache.add sexp created_scope_id
| _ -> ())
in
loop ~is_toplevel:true ~depth ~parent_eid:parent_scope_id ~get_seq:get_next_seq sexp;
(match parent_entry with
| Some p -> p.num_children <- !seq_counter
| None -> ());
!num_inserted
let log_value_common ~descr ~scope_id ~log_level:_ ~is_result content_str =
if List.mem scope_id !hidden_entries then ()
else
let db = get_db () in
let intern = get_intern () in
let depth, seq_id, parent_scope_id =
if List.exists (fun e -> e.scope_id = scope_id) !stack then
match !stack with
| parent_entry :: _ ->
(parent_entry.depth + 1, parent_entry.num_children, parent_entry.scope_id)
| [] -> assert false
else
let seq =
match List.assoc_opt scope_id !orphaned_seq_counters with
| Some counter ->
let s = !counter in
incr counter;
s
| None ->
let max_seq_stmt =
Sqlite3.prepare db
"SELECT COALESCE(MAX(seq_id), -1) FROM entries WHERE scope_id = ?"
in
Sqlite3.bind_int max_seq_stmt 1 scope_id |> ignore;
let max_seq =
match Sqlite3.step max_seq_stmt with
| Sqlite3.Rc.ROW ->
Sqlite3.Data.to_int_exn (Sqlite3.column max_seq_stmt 0)
| _ -> -1
in
Sqlite3.reset max_seq_stmt |> ignore;
Sqlite3.finalize max_seq_stmt |> ignore;
let start_seq = max_seq + 1 in
let counter = ref (start_seq + 1) in
orphaned_seq_counters := (scope_id, counter) :: !orphaned_seq_counters;
start_seq
in
( List.length !stack,
seq,
scope_id )
in
let message =
match descr with Some d -> d | None -> if is_result then "=>" else ""
in
let message_value_id = ValueIntern.intern intern ~value_type:"message" message in
let value_type = if is_result then "result" else "value" in
let data_value_id = ValueIntern.intern intern ~value_type content_str in
let elapsed_start = Mtime_clock.elapsed () in
let elapsed_ns =
match Int64.unsigned_to_int @@ Mtime.Span.to_uint64_ns elapsed_start with
| None -> 0
| Some ns -> ns
in
let stmt =
Sqlite3.prepare db
"INSERT INTO entries (scope_id, seq_id, child_scope_id, depth, \
message_value_id, data_value_id, elapsed_start_ns, elapsed_end_ns, is_result, \
log_level, entry_type) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)"
in
Sqlite3.bind_int stmt 1 parent_scope_id |> ignore;
Sqlite3.bind_int stmt 2 seq_id |> ignore;
Sqlite3.bind stmt 3 Sqlite3.Data.NULL |> ignore;
Sqlite3.bind_int stmt 4 depth |> ignore;
Sqlite3.bind_int stmt 5 message_value_id |> ignore;
Sqlite3.bind_int stmt 6 data_value_id |> ignore;
Sqlite3.bind_int stmt 7 elapsed_ns |> ignore;
Sqlite3.bind_int stmt 8 elapsed_ns |> ignore;
Sqlite3.bind_int stmt 9 (if is_result then 1 else 0) |> ignore;
Sqlite3.bind_int stmt 10 1 |> ignore;
Sqlite3.bind_text stmt 11 "value" |> ignore;
(match Sqlite3.step stmt with
| Sqlite3.Rc.DONE -> ()
| rc ->
let err_msg = Sqlite3.errmsg db in
failwith
(Printf.sprintf
"Failed to insert value row: %s (error: %s, scope_id=%d, seq_id=%d)"
(Sqlite3.Rc.to_string rc) err_msg parent_scope_id seq_id));
Sqlite3.finalize stmt |> ignore;
match !stack with
| parent_entry :: _ -> parent_entry.num_children <- parent_entry.num_children + 1
| [] -> ()
let log_value_sexp ?descr ~scope_id ~log_level ~is_result v =
if not (check_log_level log_level) then ()
else if List.mem scope_id !hidden_entries then ()
else
let sexp = Lazy.force v in
if sexp = Sexplib0.Sexp.List [] then ()
else if sexp_size sexp >= 10 then
let depth =
match List.find_opt (fun e -> e.scope_id = scope_id) !stack with
| Some parent_entry -> parent_entry.depth + 1
| None -> List.length !stack
in
let _num_inserted =
boxify ~descr ~depth ~parent_scope_id:scope_id ~is_result sexp
in
()
else
let content = Sexplib0.Sexp.to_string_hum sexp in
log_value_common ~descr ~scope_id ~log_level ~is_result content
let log_value_pp ?descr ~scope_id ~log_level ~pp ~is_result v =
if not (check_log_level log_level) then ()
else
let value = Lazy.force v in
let buf = Buffer.create 512 in
let formatter = CFormat.formatter_of_buffer buf in
pp formatter value;
CFormat.pp_print_flush formatter ();
let content = Buffer.contents buf in
log_value_common ~descr ~scope_id ~log_level ~is_result content
let log_value_show ?descr ~scope_id ~log_level ~is_result v =
if not (check_log_level log_level) then ()
else
let content = Lazy.force v in
log_value_common ~descr ~scope_id ~log_level ~is_result content
let log_value_printbox ~scope_id ~log_level v =
if not (check_log_level log_level) then ()
else
let content = PrintBox_text.to_string v in
log_value_common ~descr:None ~scope_id ~log_level ~is_result:false content
let exceeds ~value ~limit =
match limit with None -> false | Some limit -> limit < value
let close_log ~fname:_ ~start_lnum:_ ~scope_id =
match !stack with
| [] -> ()
| top :: rest when top.scope_id = scope_id ->
let elapsed_end = Mtime_clock.elapsed () in
let db = get_db () in
let parent_stmt =
Sqlite3.prepare db "SELECT parent_id FROM entry_parents WHERE scope_id = ?"
in
Sqlite3.bind_int parent_stmt 1 scope_id |> ignore;
let parent_scope_id =
match Sqlite3.step parent_stmt with
| Sqlite3.Rc.ROW -> (
match Sqlite3.column parent_stmt 0 with
| Sqlite3.Data.INT id -> Some (Int64.to_int id)
| Sqlite3.Data.NULL ->
Some 0
| _ -> None)
| _ -> None
in
Sqlite3.finalize parent_stmt |> ignore;
(match parent_scope_id with
| Some parent_id ->
let stmt =
Sqlite3.prepare db
"UPDATE entries SET elapsed_end_ns = ? WHERE scope_id = ? AND \
child_scope_id = ?"
in
let elapsed_ns =
match Int64.unsigned_to_int @@ Mtime.Span.to_uint64_ns elapsed_end with
| None -> 0
| Some ns -> ns
in
Sqlite3.bind_int stmt 1 elapsed_ns |> ignore;
Sqlite3.bind_int stmt 2 parent_id |> ignore;
Sqlite3.bind_int stmt 3 scope_id |> ignore;
let rec retry_step attempts delay =
Sqlite3.reset stmt |> ignore;
match Sqlite3.step stmt with
| Sqlite3.Rc.DONE -> ()
| Sqlite3.Rc.BUSY when attempts > 0 ->
Unix.sleepf delay;
retry_step (attempts - 1) (min (delay *. 1.5) 0.1)
| rc ->
failwith ("Failed to update entry end time: " ^ Sqlite3.Rc.to_string rc)
in
retry_step 50 0.001;
Sqlite3.finalize stmt |> ignore
| None -> ());
stack := rest;
hidden_entries := List.filter (( <> ) scope_id) !hidden_entries;
if rest = [] then commit_toplevel_transaction ()
| _ -> ()
let exceeds_max_nesting () =
exceeds ~value:(List.length !stack) ~limit:!max_nesting_depth
let exceeds_max_children () =
match !stack with
| [] -> false
| { num_children; _ } :: _ -> exceeds ~value:num_children ~limit:!max_num_children
let get_scope_id =
let global_id = ref 0 in
fun () ->
incr global_id;
!global_id
let global_prefix = global_prefix
let snapshot () = ()
let no_debug_if condition =
if not condition then ()
else
match !stack with
| [] -> ()
| top :: _ ->
let db = get_db () in
let scope_id = top.scope_id in
let descendant_ids = ref [] in
let to_process = ref [ scope_id ] in
while !to_process <> [] do
let current_ids = !to_process in
to_process := [];
List.iter
(fun parent_scope_id ->
let child_stmt =
Sqlite3.prepare db
"SELECT DISTINCT child_scope_id FROM entries WHERE scope_id = ? AND \
child_scope_id IS NOT NULL"
in
Sqlite3.bind_int child_stmt 1 parent_scope_id |> ignore;
let rec collect_children () =
match Sqlite3.step child_stmt with
| Sqlite3.Rc.ROW ->
let child_id =
Sqlite3.Data.to_int_exn (Sqlite3.column child_stmt 0)
in
descendant_ids := child_id :: !descendant_ids;
to_process := child_id :: !to_process;
collect_children ()
| Sqlite3.Rc.DONE -> ()
| _ -> failwith "Failed to collect child entries"
in
collect_children ();
Sqlite3.finalize child_stmt |> ignore)
current_ids
done;
let delete_children_stmt =
Sqlite3.prepare db "DELETE FROM entries WHERE scope_id = ?"
in
Sqlite3.bind_int delete_children_stmt 1 scope_id |> ignore;
(match Sqlite3.step delete_children_stmt with
| Sqlite3.Rc.DONE -> ()
| _ -> failwith "Failed to delete entry children");
Sqlite3.finalize delete_children_stmt |> ignore;
let =
Sqlite3.prepare db "DELETE FROM entries WHERE child_scope_id = ?"
in
Sqlite3.bind_int delete_header_stmt 1 scope_id |> ignore;
(match Sqlite3.step delete_header_stmt with
| Sqlite3.Rc.DONE -> ()
| _ -> failwith "Failed to delete entry header");
Sqlite3.finalize delete_header_stmt |> ignore;
List.iter
(fun desc_id ->
let delete_children_stmt =
Sqlite3.prepare db "DELETE FROM entries WHERE scope_id = ?"
in
Sqlite3.bind_int delete_children_stmt 1 desc_id |> ignore;
(match Sqlite3.step delete_children_stmt with
| Sqlite3.Rc.DONE -> ()
| _ -> failwith "Failed to delete descendant children");
Sqlite3.finalize delete_children_stmt |> ignore;
let =
Sqlite3.prepare db "DELETE FROM entries WHERE child_scope_id = ?"
in
Sqlite3.bind_int delete_header_stmt 1 desc_id |> ignore;
(match Sqlite3.step delete_header_stmt with
| Sqlite3.Rc.DONE -> ()
| _ -> failwith "Failed to delete descendant header");
Sqlite3.finalize delete_header_stmt |> ignore)
!descendant_ids
let finish_and_cleanup () =
match !db with
| None -> ()
| Some db_handle ->
if !transaction_started then (
Sqlite3.exec db_handle "COMMIT" |> ignore;
transaction_started := false);
(match !intern with Some intern -> ValueIntern.finalize intern | None -> ());
Sqlite3.db_close db_handle |> ignore;
db := None;
run_id := None;
intern := None;
(match !meta_db with
| Some meta_handle -> Sqlite3.db_close meta_handle |> ignore
| None -> ());
meta_db := None
end
(** Create a database-specific config that doesn't create file channels *)
let db_config ?(time_tagged = Minidebug_runtime.Not_tagged)
?(elapsed_times = Minidebug_runtime.Not_reported)
?(location_format = Minidebug_runtime.Beg_pos) ?(print_scope_ids = false)
?(verbose_scope_ids = false) ?(run_name = "") ?(log_level = 9) ?path_filter
db_filename : (module Db_config) =
let module Config = struct
let refresh_ch () = false
let debug_ch () = stdout
let debug_ch_name () = db_filename
let snapshot_ch () = ()
let reset_to_snapshot () = ()
let table_of_contents_ch = None
let time_tagged = time_tagged
let elapsed_times = elapsed_times
let location_format = location_format
let print_scope_ids = print_scope_ids
let verbose_scope_ids = verbose_scope_ids
let global_prefix = if run_name = "" then "" else run_name ^ " "
let prefix_all_logs = false
let split_files_after = None
let toc_entry = Minidebug_runtime.And []
let init_log_level = log_level
let path_filter = path_filter
end in
(module Config)
(** Factory function to create a database runtime *)
let debug_db_file ?(time_tagged = Minidebug_runtime.Not_tagged)
?(elapsed_times = Minidebug_runtime.Not_reported)
?(location_format = Minidebug_runtime.Beg_pos) ?(print_scope_ids = false)
?(verbose_scope_ids = false) ?(run_name = "") ?(for_append = true) ?(log_level = 9)
?path_filter filename =
let _ = for_append in
let config =
db_config ~time_tagged ~elapsed_times ~location_format ~print_scope_ids
~verbose_scope_ids ~run_name ~log_level ?path_filter filename
in
let module Config = (val config : Db_config) in
let module Backend = DatabaseBackend (Config) in
(module Backend : Minidebug_runtime.Debug_runtime)
(** Factory function for database runtime with channel (uses filename from config) *)
let debug_db ?(debug_ch = stdout) ?(time_tagged = Minidebug_runtime.Not_tagged)
?(elapsed_times = Minidebug_runtime.Not_reported)
?(location_format = Minidebug_runtime.Beg_pos) ?(print_scope_ids = false)
?(verbose_scope_ids = false) ?(run_name = "") ?(log_level = 9) ?path_filter () =
let _ = debug_ch in
let filename = "debug" in
debug_db_file ~time_tagged ~elapsed_times ~location_format ~print_scope_ids
~verbose_scope_ids ~run_name ~for_append:true ~log_level ?path_filter filename