package mopsa

  1. Overview
  2. Docs
package mopsa
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file Clang_to_C.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
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
(****************************************************************************)
(*                                                                          *)
(* This file is part of MOPSA, a Modular Open Platform for Static Analysis. *)
(*                                                                          *)
(* Copyright (C) 2017-2019 The MOPSA Project.                               *)
(*                                                                          *)
(* This program is free software: you can redistribute it and/or modify     *)
(* it under the terms of the GNU Lesser General Public License as published *)
(* by the Free Software Foundation, either version 3 of the License, or     *)
(* (at your option) any later version.                                      *)
(*                                                                          *)
(* This program is distributed in the hope that it will be useful,          *)
(* but WITHOUT ANY WARRANTY; without even the implied warranty of           *)
(* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *)
(* GNU Lesser General Public License for more details.                      *)
(*                                                                          *)
(* You should have received a copy of the GNU Lesser General Public License *)
(* along with this program.  If not, see <http://www.gnu.org/licenses/>.    *)
(*                                                                          *)
(****************************************************************************)

(**
  Clang_to_C - Translates Clang AST to C AST and link C AST
 *)

open C_AST
open C_utils
open C_print
open C_simplify
open Mopsa_utils

module C =
  struct
    include Clang_AST
    include Clang_dump
    include Clang_utils
  end

(** {2 Debug} *)

let dump_decls = ref false
(* dump each C declarations found, for debugging *)

let log_rename = ref false
(* log when renaming (or assign a name to an anonymous) *)

let log_merge = ref false
(* log when merging declarations *)

let log_remove = ref false
(* log when removed (unused) declarations *)


(** {2 Config} *)

let dump_dir = ref "out"
(** Log destination directory. *)

let simplify = ref true
(* Whether to apply simplification *)

let fix_va_list = true
(* Clang 4 transforms va_list into struct __va_list_tag *; transform it back
   so that, after printing, Clang accepts the generated C code
   as it refuses to call __builtin_va_arg with anything other than va_list
 *)

let remove_unused_static = true
(* remove static functions that are not referenced in a translation unit
   to improve performance
 *)


(** {2 Conversion & linking} *)


type context = {
    ctx_name: string;
    mutable ctx_tu: translation_unit list;
    ctx_target: C.target_info;

    (* local to the current TU: *)
    (* maps from (TU-local) Clang uid to definition *)
    ctx_tu_enums: (C.uid,enum_type) Hashtbl.t;
    ctx_tu_records: (C.uid,record_type) Hashtbl.t;
    ctx_tu_typedefs: (C.uid,typedef) Hashtbl.t;
    ctx_tu_vars: (C.uid,variable) Hashtbl.t;
    ctx_tu_funcs: (C.uid,func) Hashtbl.t;
    ctx_tu_static_funcs: (string,func) Hashtbl.t;
    ctx_tu_static_vars: (string,variable) Hashtbl.t;

    (* shared among all TU *)
    mutable ctx_uid: uid; (* counter to generate new uid *)
    ctx_names: (string,string) Hashtbl.t; (* set to generate unique names *)

    (* maps for original (possibly empty) name to all definitions with that name *)
    ctx_enums: (string,enum_type) Hashtbl.t;
    ctx_enum_vals: (string,enum_value) Hashtbl.t;
    ctx_records: (string,record_type) Hashtbl.t;
    ctx_typedefs: (string,typedef) Hashtbl.t;
    ctx_vars: (string,variable) Hashtbl.t; (* globals (extern & static) *)
    ctx_funcs: (string,func) Hashtbl.t;
    mutable ctx_file_scope_asm: string RangeMap.t;

    ctx_simplify: C_simplify.context;

    mutable ctx_files : SetExt.StringSet.t; (** set of parsed files *)

    (* comments are stored in a map so that we can remove duplicates
       we attach the macros to each comment to apply preprocessing correctly later
     *)
    mutable ctx_comments: (comment * macro StringMap.t) list RangeMap.t;
    ctx_macros: (string,macro) Hashtbl.t;
  }
(** Structure used internally during project parsing & linking. *)



let create_context ?(min_uid=0) (project_name:string) (info:C.target_info) =
  { ctx_name = project_name;
    ctx_tu = [];
    ctx_target = info;
    ctx_tu_enums = Hashtbl.create 16;
    ctx_tu_records = Hashtbl.create 16;
    ctx_tu_typedefs = Hashtbl.create 16;
    ctx_tu_vars = Hashtbl.create 16;
    ctx_tu_funcs = Hashtbl.create 16;
    ctx_tu_static_vars = Hashtbl.create 16;
    ctx_tu_static_funcs = Hashtbl.create 16;
    ctx_uid = min_uid;
    ctx_enums = Hashtbl.create 16;
    ctx_enum_vals = Hashtbl.create 16;
    ctx_records = Hashtbl.create 16;
    ctx_typedefs = Hashtbl.create 16;
    ctx_vars = Hashtbl.create 16;
    ctx_funcs = Hashtbl.create 16;
    ctx_names = Hashtbl.create 16;
    ctx_simplify = C_simplify.create_context ~min_uid info;
    ctx_files = SetExt.StringSet.empty;
    ctx_comments = RangeMap.empty;
    ctx_macros = Hashtbl.create 16;
    ctx_file_scope_asm = RangeMap.empty;
  }

let new_uid ctx =
  let i = ctx.ctx_uid + 1 in
  ctx.ctx_uid <- i;
  i

let find_function name ctx =
  Hashtbl.find ctx.ctx_funcs name

let empty_scope () = {
    scope_var_added = [];
    scope_var_removed = [];
  }

let empty_block = {
    blk_stmts = [];
    blk_local_vars = [];
  }


let has_stub_comment l =
  List.exists
    (fun c ->
       let s = c.C.com_text in
       String.length s >= 3 && s.[2] = '$'
    ) l


let add_translation_unit (ctx:context) (tu_name:string) (decl:C.decl) (files: string list) (coms:comment list) (macros:C.macro list) (keep_static:bool) (forced_stub_list: string list) =
  (* utilities *)
  (* ********* *)

  let rec make_unique_name force hash org =
    (* choose a first name for anonymous *)
    let name = if org = "" then "anonymous" else org in
    (* loop to create a unique name *)
    let rec gen () =
      let n = Printf.sprintf "%s_%i" name (new_uid ctx) in
      if Hashtbl.mem ctx.ctx_names n then gen () else n
    in
    (* if the name exists in the hash, create a new unique one *)
    let unique = if org = "" || Hashtbl.mem hash org || force then gen () else name in
    Hashtbl.add ctx.ctx_names unique name;
    if !log_rename && unique <> org then Printf.printf "renamed '%s' into '%s'\n" org unique;
    unique
  in

  (* map from functions id (None denotes the toplevel)
     to static function referenced in the body
   *)
  let static_func_use = Hashtbl.create 16 in
  let get_func_ref id =
    try Hashtbl.find static_func_use id
    with Not_found -> UidSet.empty
  in
  let add_func_ref (caller:func option) (callee:func) =
    if callee.func_is_static then
      let id = match caller with Some f -> Some f.func_uid | None -> None in
      let old = get_func_ref id in
      Hashtbl.replace static_func_use id (UidSet.add callee.func_uid old)
  in


  (* init *)
  (* **** *)

  Hashtbl.clear ctx.ctx_tu_enums;
  Hashtbl.clear ctx.ctx_tu_records;
  Hashtbl.clear ctx.ctx_tu_typedefs;
  Hashtbl.clear ctx.ctx_tu_vars;
  Hashtbl.clear ctx.ctx_tu_funcs;
  Hashtbl.clear ctx.ctx_tu_static_vars;
  Hashtbl.clear ctx.ctx_tu_static_funcs;

  let tu = {
      tu_uid = new_uid ctx;
      tu_name;
      tu_range = decl.C.decl_range;
    }
  in

  (* converts macros to string map *)
  let macros_map =
    List.fold_left
      (fun acc m -> StringMap.add m.C.macro_name m acc)
      StringMap.empty
      macros
  in

  let out =
    if !dump_decls then
      Some (open_out (Filename.concat !dump_dir (Filename.basename tu_name)))
    else None
  in
  let debug f x =
    match out with
    | Some out -> output_string out (f x)
    | None -> ()
  in


  (* translate types *)
  (* *************** *)


  let fix_va_list (t,q) = match t with
    | T_pointer (T_record { record_org_name = "__va_list_tag" },_)
         when fix_va_list && Hashtbl.mem ctx.ctx_typedefs "va_list"
      ->
       T_typedef (Hashtbl.find ctx.ctx_typedefs "va_list"), q
    | _ -> t,q
  in

  let rec type_qual range ((t,q):C.type_qual) : type_qual  =
    let tt,qq = typ range t in
    tt, merge_qualifiers qq { qual_is_const = q.C.qual_is_const; }

  and typ range (t:C.typ) : type_qual =
    match t with

    | C.DecayedType (tq,_) -> type_qual range tq

    | C.ArrayType a ->
       (*
       if a.C.array_size_modifier <> C.Size_Normal
       then error None "unhandled array size modifer" (C.string_of_type t);
        *)
       let len = match a.C.array_size with
         | C.Size_Constant cst -> Length_cst cst
         | C.Size_Variable (Some e) -> Length_expr (expr None e)
         | C.Size_Variable None -> No_length
         | C.Size_Incomplete -> No_length
         | _ -> error range "unhandled array size" (C.string_of_type t)
       in
       T_array (type_qual range a.C.array_element_type, len), no_qual

    | C.AtomicType a -> type_qual range a

    | C.AttributedType a -> type_qual range a

    | C.BuiltinType b ->
       (match b with
        | C.Type_Void -> T_void, no_qual
        | C.Type_Bool -> T_bool, no_qual
        | C.Type_Char_U -> T_integer (Char UNSIGNED), no_qual
        | C.Type_UChar -> T_integer UNSIGNED_CHAR, no_qual
        | C.Type_UShort -> T_integer UNSIGNED_SHORT, no_qual
        | C.Type_UInt -> T_integer UNSIGNED_INT, no_qual
        | C.Type_ULong -> T_integer UNSIGNED_LONG, no_qual
        | C.Type_ULongLong -> T_integer UNSIGNED_LONG_LONG, no_qual
        | C.Type_UInt128 -> T_integer UNSIGNED_INT128, no_qual
        | C.Type_Char_S -> T_integer (Char SIGNED), no_qual
        | C.Type_SChar -> T_integer SIGNED_CHAR, no_qual
        | C.Type_Short -> T_integer SIGNED_SHORT, no_qual
        | C.Type_Int -> T_integer SIGNED_INT, no_qual
        | C.Type_Int128 -> T_integer SIGNED_INT128, no_qual
        | C.Type_Long -> T_integer SIGNED_LONG, no_qual
        | C.Type_LongLong -> T_integer SIGNED_LONG_LONG, no_qual
        | C.Type_Float -> T_float FLOAT, no_qual
        | C.Type_Double -> T_float DOUBLE, no_qual
        | C.Type_LongDouble -> T_float LONG_DOUBLE, no_qual
        | C.Type_Float128 -> T_float FLOAT128, no_qual
        | C.Type_BuiltinFn -> T_builtin_fn, no_qual
        | C.Type_unknown_builtin s -> T_unknown_builtin s, no_qual
        | _ -> error range "unhandled builtin type" (C.string_of_type t)
       )

    | C.ComplexType (tt,qq) ->
       (match type_qual range (tt,qq) with
        | T_float f, q -> T_complex f, q
        | _ -> error range "unhandled complex type" (C.string_of_type t)
       )

    | C.FunctionProtoType f ->
       let ftype_return = fix_va_list (type_qual range f.C.proto_return_type)
       and ftype_params = List.map (fun x -> fix_va_list (type_qual range x)) (Array.to_list f.C.proto_params)
       and ftype_variadic = f.C.proto_variadic in
       T_function (Some { ftype_return; ftype_params; ftype_variadic; }), no_qual

    | C.FunctionNoProtoType f -> T_function None, no_qual
    | C.ParenType tq -> type_qual range tq
    | C.PointerType tq -> T_pointer (type_qual range tq), no_qual
    | C.EnumType e -> T_enum (enum_decl e), no_qual
    | C.RecordType r -> T_record (record_decl r), no_qual
    | C.TypedefType t -> T_typedef (typedef_decl t), no_qual
    | C.ElaboratedType t -> type_qual range t
    | C.UnaryTransformType t -> type_qual range t.C.unary_underlying_type
    | C.TypeOfExprType { C.expr_type = Some t; } -> type_qual range t
    | C.TypeOfType t -> type_qual range t
    | C.VectorType (t,s,k) ->
       T_vector { vector_type = type_qual range t; vector_size = s; vector_kind = k; },
       no_qual
    | _ -> error range "unhandled type" (C.string_of_type t)


  (* translate type declarations *)
  (* *************************** *)

  and fmt_range fmt r = Format.fprintf fmt "%s--%s" (Clang_dump.string_of_loc r.Clang_AST.range_begin) (Clang_dump.string_of_loc r.Clang_AST.range_end)


  (* enums *)

  and enum_decl e =
    if Hashtbl.mem ctx.ctx_tu_enums e.C.enum_uid then
      (* already in translation unit *)
      Hashtbl.find ctx.ctx_tu_enums e.C.enum_uid
    else
      (* name *)
      let org_name = e.C.enum_name.C.name_print in
      let nice_name =
        if org_name <> "" then org_name else
          match e.C.enum_typedef with
          | Some t -> t.C.typedef_name.C.name_print
          | None -> ""
      in
      let range = e.C.enum_range in
      (* integer type *)
      let itype = match e.C.enum_integer_type with
      | None -> None 
      | Some tq ->
        Some (
          match type_qual range tq with
          | T_integer i, _ -> i
          | _ -> SIGNED_INT
        )
      in
      (* create record *)
      let enum =
        { enum_uid = new_uid ctx;
          enum_org_name = org_name;
          enum_unique_name = make_unique_name false ctx.ctx_enums nice_name;
          enum_range = range;
          enum_values = [];
          enum_integer_type = itype;
          enum_defined = e.C.enum_cst <> [];
          enum_com = e.C.enum_com;
        }
      in
      (* fill in enumerator constants *)
      enum.enum_values <-
        List.map
          (fun e ->
            let org_name = e.C.enum_cst_name.C.name_print in
            let v =
              { enum_val_uid = new_uid ctx;
                enum_val_org_name = org_name;
                enum_val_unique_name = make_unique_name false ctx.ctx_enum_vals org_name;
                enum_val_value = e.C.enum_cst_val;
                enum_val_enum = enum;
                enum_val_range = e.C.enum_cst_range;
                enum_val_com = e.C.enum_cst_com;
              }
            in
            Hashtbl.add ctx.ctx_enum_vals org_name v;
            v
          ) e.C.enum_cst;
      (* sort them by value, and then by name if the values are equal *)
      enum.enum_values <-
        List.sort
          (fun v1 v2 ->
            let c = Z.compare v1.enum_val_value v2.enum_val_value in
            if c <> 0 then c
            else compare v1.enum_val_org_name v2.enum_val_org_name
          )
          enum.enum_values;
      (* attempt to merge with previous declaration *)
      let rec merge = function
        | [] ->
           (* new def *)
           Hashtbl.add ctx.ctx_enums org_name enum;
           if !log_merge then Printf.printf "no prior enum declaration found for '%s' ('%s')\n" org_name enum.enum_unique_name;
           enum
        | a::rest ->
           if type_unifiable ctx.ctx_target (T_enum enum) (T_enum a) then (
             (* found compatible type *)
             let () =
               if !log_merge then
                 Format.printf "found enum declaration for '%s' (%s@%a and %s@%a)@." org_name enum.enum_unique_name fmt_range enum.enum_range a.enum_unique_name fmt_range enum.enum_range
               else ()
             in
             enum_unify ctx.ctx_target a enum
           )
           else merge rest
      in
      let enum = merge (if org_name = "" then
                          (Hashtbl.fold (fun _ r acc ->
                               if Stdlib.compare r.enum_range enum.enum_range = 0 then r::acc else acc) ctx.ctx_enums [])
                        else Hashtbl.find_all ctx.ctx_enums org_name) in
      if nice_name <> "" then Hashtbl.add ctx.ctx_enums nice_name enum;
      Hashtbl.add ctx.ctx_tu_enums e.C.enum_uid enum;
      enum


  (* struct, unions *)

  and record_decl e =
    if Hashtbl.mem ctx.ctx_tu_records e.C.record_uid then
      (* already in translation unit *)
      Hashtbl.find ctx.ctx_tu_records e.C.record_uid
    else
      (* name *)
      let org_name = e.C.record_name.C.name_print in
      let nice_name =
        if org_name <> "" then org_name else
          match e.C.record_typedef with
          | Some t -> t.C.typedef_name.C.name_print
          | None -> ""
      in
      let range = e.C.record_range in
      (* create (empty) record *)
      let kind = match e.C.record_kind with
        | C.Record_Struct -> STRUCT
        | C.Record_Union -> UNION
        | t -> error range "unhandled record kind" (C.record_kind_name t)
      in
      let record =
        { record_uid = new_uid ctx;
          record_org_name = org_name;
          record_unique_name = make_unique_name false ctx.ctx_records nice_name;
          record_range = range;
          record_sizeof = Z.of_int64 e.C.record_size;
          record_alignof = Z.of_int64 e.C.record_alignment;
          record_fields = [||];
          record_kind = kind;
          record_defined = false;
          record_com = e.C.record_com;
        }
      in
      (* add empty record to context to handle recursive types *)
      Hashtbl.add ctx.ctx_tu_records e.C.record_uid record;
      (* fill in record fields *)
      record.record_fields <-
        Array.mapi
          (fun i f ->
            let org_name = f.C.field_name.C.name_print in
            let name =
              if org_name = "" then make_unique_name false ctx.ctx_names ""
              else org_name
            in
            let typ = type_qual f.C.field_range f.C.field_type in
            let typ = match f.C.field_bitwidth with
              | Some b -> T_bitfield (fst typ,b), snd typ
              | None -> typ
            in
            { field_uid = new_uid ctx;
              field_org_name = org_name;
              field_name = name;
              field_index = i;
              field_offset = Int64.to_int f.C.field_offset / 8;
              field_bit_offset = Int64.to_int f.C.field_offset mod 8;
              field_record = record;
              field_range = f.C.field_range;
              field_type = typ;
              field_com = f.C.field_com;
            }
          ) (Array.of_list e.C.record_fields);
      record.record_defined <- record.record_fields <> [||];
      (* attempt to merge with previous declaration *)
      let rec merge = function
        | [] ->
           (* new def *)
           if !log_merge then
             (Printf.printf "no prior record declaration found for '%s' ('%s')\n" org_name record.record_unique_name;
              Printf.printf "this decl: %s\n" (string_of_record_decl record);
              List.iter (fun r -> Printf.printf "candidate: %s\n" (string_of_record_decl r)) (Hashtbl.find_all ctx.ctx_records org_name)
             );
           Hashtbl.add ctx.ctx_records org_name record;
           record
        | a::rest ->
           if type_unifiable ctx.ctx_target (T_record record) (T_record a) then (
             (* found compatible type *)
             if !log_merge then Printf.printf "found prior record declaration for '%s' (%s and %s)\n" org_name record.record_unique_name a.record_unique_name;
             record_unify ctx.ctx_target a record
           )
           else merge rest
      in
      let record =
        if org_name = "" then (
          merge (Hashtbl.fold (fun _ r acc ->
              if Stdlib.compare r.record_range record.record_range = 0 then r::acc else acc) ctx.ctx_records [])
        )
        else merge (Hashtbl.find_all ctx.ctx_records org_name)
      in
      if nice_name <> "" then Hashtbl.add ctx.ctx_records nice_name record;
      Hashtbl.replace ctx.ctx_tu_records e.C.record_uid record;
      record


  (* typedef *)

  and typedef_decl t =
    if Hashtbl.mem ctx.ctx_tu_typedefs t.C.typedef_uid then
      (* already in translation unit *)
      Hashtbl.find ctx.ctx_tu_typedefs t.C.typedef_uid
    else
      let org_name = t.C.typedef_name.C.name_print in
      let range = t.C.typedef_range in
      let def = {
          typedef_uid = new_uid ctx;
          typedef_org_name = org_name;
          typedef_unique_name = make_unique_name false ctx.ctx_typedefs org_name;
          typedef_def = (T_void, no_qual);
          typedef_range = range;
          typedef_com = t.C.typedef_com;
        }
      in
      (* define *)
      Hashtbl.add ctx.ctx_tu_typedefs t.C.typedef_uid def;
      def.typedef_def <- type_qual range t.C.typedef_underlying_type;
      (* attempt to merge with previous declaration *)
      let rec merge = function
        | [] ->
           (* new def *)
           if !log_merge then Printf.printf "no prior typedef found for '%s' ('%s')\n" org_name def.typedef_unique_name;
           Hashtbl.add ctx.ctx_typedefs org_name def;
           def
        | a::rest ->
           if type_unifiable ctx.ctx_target (T_typedef def) (T_typedef a) then (
             (* found compatible type *)
             if !log_merge then Printf.printf "found prior typedef declaration for '%s' (%s and %s)\n" org_name def.typedef_unique_name a.typedef_unique_name;
             typedef_unify ctx.ctx_target a def
           )
           else merge rest
      in
      let def = merge (Hashtbl.find_all ctx.ctx_typedefs org_name) in
      Hashtbl.replace ctx.ctx_tu_typedefs t.C.typedef_uid def;
      def


  (* translate variable declarations *)
  (* ******************************* *)

  and var_decl (func:func option) v =
    if Hashtbl.mem ctx.ctx_tu_vars v.C.var_uid then
      (* already in translation unit *)
      Hashtbl.find ctx.ctx_tu_vars v.C.var_uid
    else
      let org_name = v.C.var_name.C.name_print in
      let range = v.C.var_range in
      let typ = type_qual range v.C.var_type in
      let kind = match v.C.var_storage_class, func with
        | C.SC_Extern, _ -> Variable_extern
        | C.SC_Static, Some f -> Variable_func_static f
        | C.SC_Static, None -> Variable_file_static tu
        | C.SC_PrivateExtern, _ -> Variable_file_static tu
        | _, Some f when v.C.var_is_local -> Variable_local f
        | _ -> Variable_global
      in
      (* get previous definition *)
      let rec find_extern = function
        | [] -> None
        | v::r ->
           if v.var_kind = Variable_global || v.var_kind = Variable_extern
           then Some v else find_extern r
      in
      let prev =
        if not (variable_is_global kind) then None
        else if variable_is_file_static kind then Hashtbl.find_opt ctx.ctx_tu_static_vars org_name
        else find_extern (Hashtbl.find_all ctx.ctx_vars org_name)
      in
      (* merge types *)
      let c = ref v.C.var_com in
      (match prev with
       | None ->
          if !log_merge then Printf.printf "no previous declaration found for variable %s\n" org_name
       | Some prev ->
          if !log_merge then Printf.printf "found previous declaration for variable %s (%s)\n" org_name prev.var_unique_name;
          try
            c := comment_unify !c prev.var_com;
            let t = type_unify_qual ctx.ctx_target prev.var_type typ in
            prev.var_type <- t;
            prev.var_com <- !c
          with Invalid_argument msg ->
            warning range "incompatible variable types" (Format.asprintf "variable %s (ranges %a %a) type1 %s, type2 %s, %s" org_name fmt_range range fmt_range prev.var_range (string_of_type_qual prev.var_type) (string_of_type_qual typ) msg)
      );
      (* make variable *)
      let var = match prev with
        | Some var -> var
        | None -> {
            var_uid = new_uid ctx;
            var_org_name = org_name;
            var_unique_name =
              if variable_is_global kind
              then make_unique_name (variable_is_static kind) ctx.ctx_vars org_name
              else org_name;
            var_type = typ;
            var_kind = kind;
            var_init = None;
            var_range = range;
            var_com = !c;
            var_before_stmts = [];
            var_after_stmts = [];
          }
      in
      if variable_is_global kind && prev = None then Hashtbl.add ctx.ctx_vars org_name var;
      Hashtbl.add ctx.ctx_tu_vars v.C.var_uid var;
      if variable_is_file_static kind then Hashtbl.add ctx.ctx_tu_static_vars org_name var;
      (* init *)
      if var.var_kind = Variable_extern && (kind = Variable_global || var.var_init <> None)
      then var.var_kind <- Variable_global;
      (match v.C.var_init with
       | None -> ()
       | Some i ->
          if var.var_init <> None
          then warning range "variable is defined twice with initializers" org_name;
          let init = init func i in
          if variable_is_global kind && !simplify then
            let before, init, after = simplify_global_init ctx.ctx_simplify init in
            var.var_init <- Some init;
            var.var_before_stmts <- before;
            var.var_after_stmts <- after
          else
            var.var_init <- Some init;
          var.var_range <- range
        );
      var


  (* translate function declarations *)
  (* ******************************* *)

  and func_decl f =
    if Hashtbl.mem ctx.ctx_tu_funcs f.C.function_uid then
      (* already in translation unit *)
      Hashtbl.find ctx.ctx_tu_funcs f.C.function_uid
    else
      let org_name = f.C.function_name.C.name_print in
      let static = match f.C.function_storage_class with
        | C.SC_Static | C.SC_PrivateExtern -> true
        | _ -> false
      in
      let range = f.C.function_range in
      let name_range = f.C.function_name_range in
      (* get previous definition *)
      let rec find_extern = function
        | [] -> None
        | f::r -> if f.func_is_static then find_extern r else Some f
      in
      let prev =
        if static then Hashtbl.find_opt ctx.ctx_tu_static_funcs org_name
        else find_extern (Hashtbl.find_all ctx.ctx_funcs org_name)
      in
      (* create structure *)
      let return = type_qual range f.C.function_return_type in
      let func =
        match prev with
        | Some func ->
           if !log_merge then Printf.printf "found previous declaration for function %s (%s)\n" org_name func.func_unique_name;
           func
        | None ->
           if !log_merge then Printf.printf "no previous declaration found for function %s\n" org_name;
           {
             func_uid = new_uid ctx;
             func_org_name = org_name;
             func_unique_name = make_unique_name static ctx.ctx_funcs org_name;
             func_is_static = static;
             func_return = return;
             func_parameters = [||];
             func_body = None;
             func_static_vars = [];
             func_local_vars = [];
             func_range = range;
             func_name_range = name_range;
             func_variadic = f.C.function_is_variadic;
             func_com = [];
           }
      in
      if static then Hashtbl.replace ctx.ctx_tu_static_funcs org_name func
      else if prev = None then Hashtbl.add ctx.ctx_funcs org_name func;
      Hashtbl.add ctx.ctx_tu_funcs f.C.function_uid func;
      (* fill in parameters & return *)
      let params =
        Array.map
          (fun p ->
            let v_org_name = p.C.var_name.C.name_print in
            let typ = fix_va_list (type_qual p.C.var_range p.C.var_type) in
            let var = {
                var_uid = new_uid ctx;
                var_org_name = v_org_name;
                var_unique_name = v_org_name;
                var_type = typ;
                var_kind = Variable_parameter func;
                var_init = None;
                var_range = p.C.var_range;
                var_com = p.C.var_com;
                var_before_stmts = [];
                var_after_stmts = [];
              }
            in
            Hashtbl.add ctx.ctx_tu_vars p.C.var_uid var;
            var
          ) f.C.function_params
      in
      (* check compatibility and merge declarations *)
      if params <> [||] && func.func_parameters <> [||] then (
        if Array.length params <> Array.length func.func_parameters
        then error range "multiple declaration of a function with different number of arguments" org_name;
        for i=0 to Array.length params-1 do
          try
            let t = type_unify_qual ctx.ctx_target params.(i).var_type func.func_parameters.(i).var_type in
            params.(i).var_type <- t;
            func.func_parameters.(i).var_type <- t;
            let c = comment_unify params.(i).var_com func.func_parameters.(i).var_com in
            params.(i).var_com <- c;
            func.func_parameters.(i).var_com <- c;
          with Invalid_argument msg ->
            warning range "multiple declaration of a function have incompatible argument type" msg
        done
      );
      (try
         let t = type_unify_qual ctx.ctx_target return func.func_return in
         func.func_return <- t
       with Invalid_argument msg ->
         warning range "multiple declaration of a function have incompatible return type" msg
      );
      (* favor argument names from functions with a body, a
         non-empty argument list, or from stubs
      *)
      if
        ((func.func_parameters = [||] &&  params <> [||]) ||
         has_stub_comment f.C.function_com)
        &&
        ((match func.func_body with
         | None -> true
         | Some b ->
           List.length b.blk_stmts = 0) || (List.mem func.func_org_name forced_stub_list) )
      then
      (
        func.func_parameters <- params;
        func.func_variadic <- f.C.function_is_variadic
      );

      let coms = List.map (fun m -> m, macros_map) f.C.function_com in
      func.func_com <- comment_macro_unify func.func_com coms;
      (* fill in body, override parameters in that case (to avoid inconsistencies) *)
      if func.func_body <> None && f.C.function_body <> None
      then warning range "function is defined twice with a body" org_name;
      (match f.C.function_body with
       | None -> ()
       | Some b ->
         func.func_parameters <- params;
         func.func_variadic <- f.C.function_is_variadic;
             func.func_body <-
            Some (stmt (Some func) b |> deblock |> resolve_scope);
          func.func_range <- range;
          func.func_name_range <- name_range
      );
      if !simplify then simplify_func ctx.ctx_simplify func;
      func


  (* translate statements *)
  (* ******************** *)

  and stmt (func:func option) (s:C.stmt) : statement list =
    let range = s.C.stmt_range in
    match s.C.stmt_kind with

    | C.AttributedStmt s -> stmt func s

    | C.CompoundStmt l -> [S_block (deblock (ListExt.map_merge (stmt func) l)), range]

    | C.NullStmt -> []

    | C.BreakStmt _ -> [S_jump (S_break (empty_scope())), range]

    | C.ContinueStmt _ -> [S_jump (S_continue (empty_scope())), range]

    | C.GotoStmt (lbl,_) -> [S_jump (S_goto (lbl.C.name_print, empty_scope())), range]

    | C.ReturnStmt (Some e) ->  [S_jump (S_return (Some (expr func e), empty_scope())), range]

    | C.ReturnStmt None -> [S_jump (S_return (None, empty_scope())), range]

    | C.SwitchStmt s ->
      if s.C.switch_init <> None
       then error range "unsupported init in switch statement" "";
       let c = expr func s.C.switch_cond
       and b = deblock (stmt func s.C.switch_body)
       in
       [S_jump (S_switch (c,b)), range]

    | C.CaseStmt s ->
      (* TODO: constant folding? *)
      begin match s.C.case_end with
        | Some case_end ->
          let values = match s.C.case_value.expr_kind, case_end.expr_kind with
            | ConstantExpr {expr_kind = IntegerLiteral b},
              ConstantExpr {expr_kind = IntegerLiteral e} ->
              let rec process i acc =
                if Z.(i <= e) then
                  process Z.(i + one) ({case_end with expr_kind = IntegerLiteral i}::acc)
                else
                  List.rev acc
              in
              process b []
            | _ ->
              error range "range case statement extension currently supports constant integers" (Format.asprintf "%s" (Clang_dump.string_of_expr (OptionExt.none_to_exn s.C.case_end)));
          in 
          (S_target (S_case (List.map (expr func) values, empty_scope())), range)::
          (stmt func s.C.case_stmt)

        | None ->
       (* in case of nested case stmts, we extract all of them in other_values, and keep the leaf statements *)
       let process s =
         let rec aux acc s = match s.C.stmt_kind with
           | C.CaseStmt s -> aux (s.C.case_value :: acc) s.C.case_stmt
           | _ -> List.rev acc, s in
         aux [] s in 
       let other_values, statements = process s.C.case_stmt in
       let values = s.C.case_value :: other_values in 
       (S_target (S_case (List.map (expr func) values, empty_scope())), range)::
         (stmt func statements)
      end

    | C.DefaultStmt s ->
       (S_target (S_default (empty_scope())), range)::(stmt func s)

    | C.LabelStmt (lbl,s) ->
       (S_target (S_label lbl.C.name_print), range)::(stmt func s)

    | C.ExprStmt e -> [S_expression (expr func e), range]

    | C.DeclStmt decls ->
       ListExt.map_merge
         (fun d ->
           let range = d.C.decl_range in
           match d.C.decl_kind with
           | C.EmptyDecl -> []
           | C.EnumDecl e -> ignore (enum_decl e); []
           | C.RecordDecl r -> ignore (record_decl r); []
           | C.TypedefDecl d -> ignore (typedef_decl d); []
           | C.FunctionDecl f -> ignore (func_decl f); []
           | C.VarDecl v ->
              let var = var_decl func v in
              (match var.var_kind with
               | Variable_func_static f -> f.func_static_vars <- var::f.func_static_vars
               | Variable_local f -> f.func_local_vars <- var::f.func_local_vars
               | _ -> ()
              );
              if variable_is_global var.var_kind then []
              else [S_local_declaration var, range]
           | C.StaticAssertDecl a ->
              if a.C.assert_is_failed then
                warning decl.C.decl_range "static assertion failed: %s" a.C.assert_msg;
              []
           | _ -> error range "unhandled declaration in function" (C.decl_kind_name d.C.decl_kind)
         )
         decls

    | C.IfStmt s ->
       if s.C.if_init <> None
       then error range "unsupported init in if statement" "";
       let c = match s.C.if_cond with
         | None -> error range "if without a condition" ""
         | Some c -> expr func c
       and t = match s.C.if_then with
         | None -> empty_block
         | Some s -> deblock (stmt func s)
       and e = match s.C.if_else with
         | None -> empty_block
         | Some s -> deblock (stmt func s)
       in
       [S_if (c,t,e), range]

    | C.WhileStmt s ->
       let c = expr func s.C.while_cond
       and b = deblock (stmt func s.C.while_body) in
       [S_while (c,b), range]

    | C.DoStmt s ->
       let c = expr func s.C.do_cond
       and b = deblock (stmt func s.C.do_body) in
       [S_do_while (b,c), range]

    | C.ForStmt s ->
       let i = match s.C.for_init with
         | None -> empty_block
         | Some s -> deblock (stmt func s)
       and c = match s.C.for_cond with
         | None -> None
         | Some c -> Some (expr func c)
       and p = match s.C.for_inc with
         | None -> None
         | Some s -> Some (expr func s)
       and b = deblock (stmt func s.C.for_body)
       in
       [S_for (i,c,p,b), range]

    | C.AsmStmt s ->
       let a = {
           asm_style = s.C.asm_style;
           asm_is_simple = s.C.asm_is_simple;
           asm_is_volatile = s.C.asm_is_volatile;
           asm_body = s.C.asm_body;
           asm_outputs =
             Array.map
               (fun o -> {
                    asm_output_string = o.C.asm_output_string;
                    asm_output_expr = expr func o.C.asm_output_expr;
                    asm_output_constraint = o.C.asm_output_constraint;
                  }
               ) s.C.asm_outputs;
           asm_inputs =
             Array.map
               (fun o -> {
                    asm_input_string = o.C.asm_input_string;
                    asm_input_expr = expr func o.C.asm_input_expr;
                  }
               ) s.C.asm_inputs;
           asm_clobbers = s.C.asm_clobbers;
           asm_labels = s.C.asm_labels;
         }
       in
       [S_asm a, range]

    | s -> error range "unhandled statement" (C.stmt_kind_name s)

  (* remove useless levels of blocks *)
  and deblock (l:statement list) : block = match l with
    | [S_block b,_] -> deblock b.blk_stmts
    | _ -> make_block l


  (* translate expressions *)
  (* ********************* *)

  and check_type range t1 t2 =
    if not (type_qual_compatible ctx.ctx_target t1 t2) then
      error range "incompatible types" (Printf.sprintf "%s and %s" (string_of_type_qual t1) (string_of_type_qual t2))


  and expr (func:func option) e =
    let range = e.C.expr_range in
    let typ = match e.C.expr_type with
      | None -> error range "expression without type" (C.expr_kind_name e.C.expr_kind)
      | Some t -> type_qual range t
    in
    match e.C.expr_kind with

    | C.ConditionalOperator c ->
       E_conditional (expr func c.C.cond_cond, expr func c.C.cond_true, expr func c.C.cond_false),
       typ, range

    | C.BinaryConditionalOperator c ->
       E_binary_conditional (expr func c.C.bcond_cond, expr func c.C.bcond_false),
       typ, range

    | C.ArraySubscriptExpr e ->
       E_array_subscript (expr func e.C.subscript_base, expr func e.C.subscript_index),
       typ, range

    | C.CompoundAssignOperator c ->
       let op = match c.C.compound_op with
         | C.BO_MulAssign -> MUL
         | C.BO_DivAssign -> DIV
         | C.BO_RemAssign -> MOD
         | C.BO_AddAssign -> ADD
         | C.BO_SubAssign -> SUB
         | C.BO_ShlAssign -> LEFT_SHIFT
         | C.BO_ShrAssign -> RIGHT_SHIFT
         | C.BO_AndAssign -> BIT_AND
         | C.BO_XorAssign -> BIT_XOR
         | C.BO_OrAssign -> BIT_OR
       in
       E_compound_assign
         (expr func c.C.compound_lval, type_qual range c.C.compound_comp_lval_type,
          op, expr func c.C.compound_rval, type_qual range c.C.compound_comp_result_type),
       typ, range

   | C.BinaryOperator (l,op,r) ->
      let l,r = expr func l, expr func r in
      if op = C.BO_Assign then check_type range (expr_type l) (expr_type r);
      (match op with
       | C.BO_Mul -> E_binary (O_arithmetic MUL, l, r)
       | C.BO_Div -> E_binary (O_arithmetic DIV, l, r)
       | C.BO_Rem -> E_binary (O_arithmetic MOD, l, r)
       | C.BO_Add -> E_binary (O_arithmetic ADD, l, r)
       | C.BO_Sub -> E_binary (O_arithmetic SUB, l, r)
       | C.BO_Shl -> E_binary (O_arithmetic LEFT_SHIFT, l, r)
       | C.BO_Shr -> E_binary (O_arithmetic RIGHT_SHIFT, l, r)
       | C.BO_And -> E_binary (O_arithmetic BIT_AND, l, r)
       | C.BO_Xor -> E_binary (O_arithmetic BIT_XOR, l, r)
       | C.BO_Or -> E_binary (O_arithmetic BIT_OR, l, r)
       | C.BO_LT -> E_binary (O_logical LESS, l, r)
       | C.BO_GT -> E_binary (O_logical GREATER, l, r)
       | C.BO_LE -> E_binary (O_logical LESS_EQUAL, l, r)
       | C.BO_GE -> E_binary (O_logical GREATER_EQUAL, l, r)
       | C.BO_EQ -> E_binary (O_logical EQUAL, l, r)
       | C.BO_NE -> E_binary (O_logical NOT_EQUAL, l, r)
       | C.BO_LAnd -> E_binary (O_logical LOGICAL_AND, l, r)
       | C.BO_LOr -> E_binary (O_logical LOGICAL_OR, l, r)
       | C.BO_Comma -> E_comma (l, r)
       | C.BO_Assign -> E_assign (l, r)
       | _ -> error range "unhandled binary operator" (C.binary_operator_name op)
      ), typ, range

   | C.UnaryOperator (op,a) ->
      let (_,ta,_) as a = expr func a in
      (match op with
       | C.UO_PostInc -> E_increment (INC, POST, a)
       | C.UO_PostDec -> E_increment (DEC, POST, a)
       | C.UO_PreInc -> E_increment (INC, PRE, a)
       | C.UO_PreDec -> E_increment (DEC, PRE, a)
       | C.UO_AddrOf -> E_address_of a
       | C.UO_Deref -> E_deref a
       | C.UO_Plus -> let e,_,_ = a in e
       | C.UO_Minus -> E_unary (NEG, a)
       | C.UO_Not -> E_unary (BIT_NOT, a)
       | C.UO_LNot -> E_unary (LOGICAL_NOT, a)
       | C.UO_Extension -> let e,_,_ = a in e
       | _ -> error range "unhandled unary operator" (C.unary_operator_name op)
      ), typ, range

   | C.CallExpr e ->
      let c = expr func e.C.call_callee
      and a = Array.map (expr func) e.C.call_args
      in
      E_call (c,a), typ, range

   | C.CastExpr (e,k) ->
      let e = expr func e in
      let o = match k with
        | C.CStyleCast -> EXPLICIT
        | C.ImplicitCast -> IMPLICIT
        | _ -> error range "unhandled cast kind" (C.cast_kind_name k)
      in
      E_cast (e, o), typ, range

   | C.CharacterLiteral (z,k) ->
      E_character_literal (Z.of_int32 z, k), typ, range

   | C.ChooseExpr e ->
      expr func (if e.C.choose_cond_true then e.C.choose_true else e.C.choose_false)

   | C.CompoundLiteralExpr (i,scope) ->
      let func = if scope then None else func in
      E_compound_literal (init func i), typ, range

   | C.DeclRefExpr d ->
      (match d.C.decl_kind with
       | C.VarDecl v -> E_variable (var_decl func v)
       | C.FunctionDecl f ->
          let decl = func_decl f in
          add_func_ref func decl;
          E_function decl
       | C.EnumConstantDecl e -> E_integer_literal e.C.enum_cst_val
       | k -> error decl.C.decl_range "unhandled reference to a declaration in expression" (C.decl_kind_name k)
      ), typ, range

   | C.FloatingLiteral f ->
      E_float_literal f, typ, range

   | C.GenericSelectionExpr g ->
      expr func (g.C.select_assoc.(g.C.select_result))

   | C.IntegerLiteral v ->
      E_integer_literal v, typ, range

   | C.MemberExpr e ->
      let ee = expr func e.C.member_base in
      let ff = match e.C.member_decl.C.decl_kind with
        | C.FieldDecl f -> f
        | k -> error range "unhandled field declaration kind in member expression" (C.decl_kind_name k)
      in
      (if e.C.member_arrow then E_arrow_access (ee, ff.C.field_index, ff.C.field_name.C.name_print)
       else E_member_access (ee, ff.C.field_index, ff.C.field_name.C.name_print)
      ), typ, range

   | C.OffsetOfExpr (n,Some o) -> E_integer_literal o, typ, range
   | C.OffsetOfExpr (n,None) -> error range "offsetof incomplete type" ""

   | C.OpaqueValueExpr o ->
      (match o.C.opaque_source with
       | None ->
       (*error range "empty opaque expression" "" *)
       (* TODO: check the meanng of None in OpaqueValueExpr *)
          E_integer_literal Z.zero, typ, range
       | Some e -> expr func e
      )

   | C.ParenExpr e ->
      expr func e

   | C.PredefinedExpr (_,name) ->
      E_predefined name, typ, range

   | C.StmtExpr l ->
      E_statement (deblock (ListExt.map_merge (stmt func) l)), typ, range

   | C.StringLiteral (s,k) ->
      E_string_literal (s, k), typ, range

   | C.UnaryExprOrTypeTraitExpr (op,t) ->
      let tt,_ = type_qual range t in
      (try
         match op with
         | C.UETT_SizeOf -> sizeof_expr ctx.ctx_target range typ tt
         | C.UETT_AlignOf | C.UETT_PreferredAlignOf ->
            E_integer_literal (alignof_type ctx.ctx_target tt), typ, range
       with Invalid_argument msg ->
         warning range msg (C.string_of_type (fst t));
         E_integer_literal Z.zero, typ, range
      )
   | C.VAArgExpr e ->
      E_var_args (expr func e), typ, range

   | C.AtomicExpr e ->
      (* TODO: update when the AtomicExpr Clang node is handled better *)
      E_atomic (e.C.atomic_op, expr func e.C.atomic_ptr, expr func e.C.atomic_order),
      typ, range

   | C.FullExpr e | C.ConstantExpr e ->
      expr func e

   | C.ConvertVectorExpr e ->
      E_convert_vector (expr func e), typ, range

   | C.ExtVectorElementExpr (e,s) ->
      E_vector_element (expr func e, s), typ, range

   | ShuffleVectorExpr ea ->
      E_shuffle_vector (Array.map (expr func) ea), typ, range

   | e -> error range "unhandled expression" (C.expr_kind_name e)


  (* translate initializers *)
  (* ********************** *)

  and init (func:func option) e =
    let range = e.C.expr_range in
    let typ = match e.C.expr_type with
      | None -> error range "expression without type" (C.expr_kind_name e.C.expr_kind)
      | Some t -> type_qual range t
    in
    match e.C.expr_kind with

    | C.InitListExpr i ->
       let filler =
         match i.C.init_list_filler with
         | None -> None
         | Some i -> Some (init func i)
       in
       let list = Array.to_list i.C.init_list_init in
       I_init_list (List.map (init func) list, filler)

    | C.ImplicitValueInitExpr ->
       zero_init range (fst typ)
    (* I_init_implicit typ *) (* NOTE: we translate implicit-init into zero-init *)


    | _ -> I_init_expr (expr func e)



  (* translate toplevel declarations *)
  (* ******************************* *)

  and toplevel decl =
    match decl.C.decl_kind with

    (* types *)
    | C.EnumDecl e ->
       let d = enum_decl e in
       debug string_of_enum_decl d

    | C.RecordDecl r ->
       let d = record_decl r in
       debug string_of_record_decl d

    | C.TypedefDecl d ->
       let d = typedef_decl d in
       debug string_of_typedef d

    (* declarations *)
    | C.VarDecl v ->
       let d = var_decl None v in
       debug string_of_var_decl d

    | C.FunctionDecl f ->
       let d = func_decl f in
       debug string_of_func_decl d

    | C.EmptyDecl -> ()

    | C.StaticAssertDecl a ->
       if a.C.assert_is_failed then
         warning decl.C.decl_range "static assertion failed: %s" a.C.assert_msg

    | C.FileScopeAsmDecl s ->
       ctx.ctx_file_scope_asm <-
         RangeMap.add decl.C.decl_range s ctx.ctx_file_scope_asm;
       debug (fun x -> x) s

    | _ -> error decl.C.decl_range "unhandled toplevel declaration" (C.decl_kind_name decl.C.decl_kind)

  in

  (match decl.C.decl_kind with
  | C.TranslationUnitDecl decls -> List.iter toplevel decls
  | _ -> error decl.C.decl_range "expected TranslationUnitDecl" (C.decl_kind_name decl.C.decl_kind)
  );

  (* add parsed files *)
  ctx.ctx_files <- SetExt.StringSet.(union ctx.ctx_files (of_list files));

  (* add comments, attach macros, merging duplicates *)
  let c =
    List.fold_left
      (fun ctx c ->
        let r = c.Clang_AST.com_range in
        if RangeMap.mem r ctx then
          let old = RangeMap.find r ctx in
          if List.exists (fun (c',_) -> c = c') old then ctx
          else RangeMap.add r ((c,macros_map)::old) ctx
        else RangeMap.add r [(c,macros_map)] ctx
      )
      ctx.ctx_comments coms
  in
  ctx.ctx_comments <- c;

  (* add macros globally *)
  List.iter (fun macro ->
      if Hashtbl.mem ctx.ctx_macros macro.C.macro_name then
        begin
          let old_macro = Hashtbl.find ctx.ctx_macros macro.C.macro_name in
          if Compare.list Stdlib.compare
              macro.macro_contents old_macro.macro_contents
             != 0
          then
            let range = C.{ range_begin = macro.macro_loc; range_end = macro.macro_loc } in
            warning range "macro is defined twice" macro.macro_name
        end;
      Hashtbl.add ctx.ctx_macros macro.C.macro_name macro
    ) macros;


  (* shifts static funcs to funcs *)
  if remove_unused_static && not keep_static then (
    (* functions transitively referenced by id *)
    let rec close_func_ref id acc =
      if UidSet.mem id acc then acc else
        UidSet.fold close_func_ref
          (get_func_ref (Some id)) (UidSet.add id acc)
    in
    (* functions transitively referenced by toplevel or non-static *)
    let func_refs = ref  UidSet.empty in
    let toplevel = get_func_ref None in
    Hashtbl.iter
      (fun _ f ->
        if (not f.func_is_static) || UidSet.mem f.func_uid toplevel
        then func_refs := close_func_ref f.func_uid !func_refs
      )
      ctx.ctx_tu_funcs;
    (* only keep referenced static functions *)
    Hashtbl.iter
      (fun name f ->
        if UidSet.mem f.func_uid !func_refs then
          Hashtbl.add ctx.ctx_funcs f.func_org_name f
        else if !log_remove then
          Printf.printf "removing static function %s not used in translation unit\n" name;
      )
      ctx.ctx_tu_static_funcs
  )
  else
    (* keep all statics *)
    Hashtbl.iter
      (fun _ f -> Hashtbl.add ctx.ctx_funcs f.func_org_name f)
      ctx.ctx_tu_static_funcs;


  (match out with Some o -> close_out o | None -> ())


let link_project ctx =
  let cvt hash name =
    Hashtbl.fold
      (fun org_name def map -> StringMap.add (name def) def map) hash StringMap.empty
  in
  { proj_name = ctx.ctx_name;
    proj_tu = ctx.ctx_tu;
    proj_target = ctx.ctx_target;

    proj_typedefs = cvt ctx.ctx_typedefs (fun t -> t.typedef_unique_name);
    proj_enums = cvt ctx.ctx_enums (fun t -> t.enum_unique_name);
    proj_records = cvt ctx.ctx_records (fun t -> t.record_unique_name);
    proj_vars = cvt ctx.ctx_vars (fun t -> t.var_unique_name);
    proj_funcs = cvt ctx.ctx_funcs (fun t -> t.func_unique_name);
    proj_files = ctx.ctx_files |> SetExt.StringSet.elements;
    proj_file_scope_asm = ctx.ctx_file_scope_asm;
    proj_comments = ctx.ctx_comments;
    proj_macros = cvt ctx.ctx_macros (fun t -> t.macro_name);
  }


let get_parsed_files ctx = ctx.ctx_files |> SetExt.StringSet.elements
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct