package goblint-cil

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

Source file rmciltmps.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
(* These are functions etc. for removing CIL generated
   temporary variables. Some can be removed immediately,
   others must wait until pretty printing *)
open GoblintCil
open Cilint
open Liveness
module E = Errormsg
module RD = Reachingdefs
module AELV = Availexpslv
module UD = Usedef
module IH = Inthash
module S = Stats

module IS =
  Set.Make(struct
    type t = int
    let compare = Stdlib.compare
  end)

let debug = RD.debug

let doTime = ref false

let time s f a =
  if !doTime then
    S.time s f a
  else f a


(* Type for the form of temporary variable names *)
type nameform = Suffix of string | Prefix of string | Exact of string

(* take the id number of a definition and return
   the rhs of the definition if there is one.
   Returns None if, for example, the definition is
   caused by an assembly instruction *)
(* int -> (rhs * int * IOS.t IH.t) option *)
let getDefRhs = RD.getDefRhs
    RD.ReachingDef.defIdStmtHash
    RD.ReachingDef.stmtStartData

(* exp_is_ok_replacement -
   Returns false if the argument contains a pointer dereference
   or a variable whose address is taken anywhere *)

let exp_ok = ref true
class memReadOrAddrOfFinderClass = object(self)
  inherit nopCilVisitor

  method! vexpr e = match e with
    Lval(Mem _, _) ->
      exp_ok := false;
      SkipChildren
  | _ -> DoChildren

  method! vvrbl vi =
    if vi.vglob then
      (if !debug then ignore(E.log "memReadOrAddrOfFinder: %s is a global\n"
			       vi.vname);
       exp_ok := false;
       SkipChildren)
    else if vi.vaddrof then
      (if !debug then
         ignore(E.log "memReadOrAddrOfFinder: %s has its address taken\n"
		  vi.vname);
       exp_ok := false;
       SkipChildren)
    else (if !debug then ignore(E.log "memReadOrAddrOfFinder: %s does not have its address taken\n"
				  vi.vname);
	  DoChildren)

end

let memReadOrAddrOfFinder = new memReadOrAddrOfFinderClass

(* exp -> bool *)
let exp_is_ok_replacement e =
  if !debug then ignore(E.log "exp_is_ok_replacement: in exp_is_ok_replacement with %a\n"
			  d_exp e);
  exp_ok := true;
  ignore(visitCilExpr memReadOrAddrOfFinder e);
  !exp_ok

let emptyStmt = mkEmptyStmt ()
let fsr = ref emptyStmt
class stmtFinderClass sid = object(self)
  inherit nopCilVisitor

  method! vstmt stm =
    if stm.sid = sid
    then (fsr := stm; SkipChildren)
    else DoChildren

end

let find_statement f sid = RD.getStmt sid

(* Are there writes to memory in between
   the two statements with the given ids *)
(* fundec -> int -> int -> bool *)
let wbHtbl = Hashtbl.create 256
let writes_between f dsid sid =
  if Hashtbl.mem wbHtbl (dsid,sid) then Hashtbl.find wbHtbl (dsid,sid) else
  let dstmo = find_statement f dsid in
  let stmo = find_statement f sid in
  let find_write s = match s.skind with
    Instr il -> List.exists (fun i ->
      match i with
	Set((Mem _,_),_,_,_) -> true (* pointer write *)
      | Set((_,Index (_,_)),_,_,_) -> true (* array write *)
      | Call(_,_,_,_,_) -> true
      | _ -> false) il
  | _ -> false
  in
  (* is there a path from start to goal that includes an
     instruction that writes to memory? Do a dfs *)
  let visited_sid_isr = ref IS.empty in
  let rec dfs goal b start =
    if !debug then ignore(E.log "writes_between: dfs visiting %a\n" d_stmt start);
    if start.sid = goal.sid then
      let wh = find_write start in
      (if !debug && b then ignore(E.log "writes_between: start=goal and found a write\n");
       if !debug && (not b) then ignore(E.log "writes_between: start=goal and no write\n");
       if !debug && wh then ignore(E.log "writes_between: start=goal and write here\n");
       if !debug && (not wh) then ignore(E.log "writes_between: start=goal and no write here\n");
       b || (find_write start))
    else
    (* if time "List.mem1" (List.mem start.sid) (!visited_sid_lr) then false else *)
    if IS.mem start.sid (!visited_sid_isr) then false else
    let w = find_write start in
    if !debug && w then ignore(E.log "writes_between: found write %a\n" d_stmt start);
    visited_sid_isr := IS.add start.sid (!visited_sid_isr);
    let rec proc_succs sl = match sl with [] -> false
    | s::rest -> if dfs goal (w || b) s then true else proc_succs rest
    in
    proc_succs start.succs
  in
  match stmo, dstmo with
    None, _ | _, None ->
      E.s (E.error "writes_between: defining stmt not an instr")
  | Some stm, Some dstm ->
      let _ = visited_sid_isr := IS.singleton stm.sid in
      let from_stm = List.fold_left (dfs stm) false stm.succs in
      let _ = visited_sid_isr := IS.empty in
      let from_dstm = dfs stm false dstm in
      (Hashtbl.add wbHtbl (dsid,sid) (from_stm || from_dstm);
      from_stm || from_dstm)

(* returns true when the variables in uses
   have the same definition ids in both curiosh
   and defiosh or are global and not defined in
   the current function *)
let verify_unmodified uses fdefs curiosh defiosh =
  UD.VS.fold (fun vi b ->
    let curido = RD.iosh_singleton_lookup curiosh vi in
    let defido = RD.iosh_singleton_lookup defiosh vi in
    match curido, defido with
      Some(curid), Some(defid) ->
	(if !debug then ignore (E.log "verify_unmodified: curido: %d defido: %d\n" curid defid);
	 curid = defid && b)
    | None, None ->
	if not(UD.VS.mem vi fdefs) then
	  (if !debug then ignore (E.log "verify_unmodified: %s not defined in function\n" vi.vname);
	   b)
	else (* if the same set of definitions reaches, we can replace, also *)
	  let curios = try IH.find curiosh vi.vid
	  with Not_found -> RD.IOS.empty in
	  let defios = try IH.find defiosh vi.vid
	  with Not_found -> RD.IOS.empty in
	  RD.IOS.compare curios defios == 0 && b
    | _, _ ->
	(if !debug then ignore (E.log "verify_unmodified: %s has conflicting definitions. cur: %a\n def: %a\n"
				  vi.vname RD.ReachingDef.pretty ((),0,curiosh)
				  RD.ReachingDef.pretty ((),0,defiosh));
	 false))
    uses true

let fdefs = ref UD.VS.empty
let udDeepSkindHtbl = IH.create 64
class defCollectorClass = object(self)
  inherit nopCilVisitor

  method! vstmt s =
    let _,d = if IH.mem udDeepSkindHtbl s.sid
    then IH.find udDeepSkindHtbl s.sid
    else let u',d' = UD.computeDeepUseDefStmtKind s.skind in
    IH.add udDeepSkindHtbl s.sid (u',d');
    (u',d') in
    fdefs := UD.VS.union !fdefs d;
    DoChildren

end

let defCollector = new defCollectorClass

let collect_fun_defs fd =
  fdefs := UD.VS.empty;
  ignore(visitCilFunction defCollector fd);
  !fdefs

(* ok_to_replace *)
(* is it alright to replace a variable use with the expression
   that the variable was defined to be? *)
(* Takes the definitions that reached the place where the
   variable was defined and the definitions that reach the
   place the variable is used. If the same definitions for
   the variables used in the expression reach both places,
   then it is okay to replace the variable with the expression. *)
(* With regards to globals and parameters there are two
   possibilities if the reverse lookup returns None for both
   sets of reaching definitions:
   1) The global or parameter is actually not redefined.
   2) At both points no one definition *must* reach there.
   For this reason, this function also takes the fundec,
   so that it can be figured out which is the case *)
(* varinfo -> varinfo IH.t -> sid -> varinfo IH.t -> fundec -> rhs -> bool *)
(* sid is an int that is the statement id of the statement where
   we are trying to do a replacement *)
(* vi is the varinfo of the variable that we are trying to replace *)
let ok_to_replace vi curiosh sid defiosh dsid f r =
  let uses, safe = match r with
    RD.RDExp e -> (UD.computeUseExp e, exp_is_ok_replacement e)
  | RD.RDCall (Call(_,_,el,_,_) as i) ->
      let safe = List.fold_left (fun b e ->
	(exp_is_ok_replacement e) && b) true el in
      let u,d = UD.computeUseDefInstr i in
      u, safe
  | _ -> E.s (E.bug "ok_to_replace: got non Call in RDCall.")
  in
  let target_addrof = if vi.vaddrof || vi.vglob then
    (if !debug then ignore(E.log "ok_to_replace: target %s had its address taken or is a global\n" vi.vname);
    true)
  else (if !debug then ignore(E.log "ok_to_replace: target %s does not have its address taken\n" vi.vname);
	false) in
  let writes = if safe && not(target_addrof) then false else (time "writes_between" (writes_between f dsid) sid) in
  if (not safe || target_addrof) && writes
  then
    (if !debug then ignore (E.log "ok_to_replace: replacement not safe because of pointers or addrOf\n");
     false)
  else let fdefs = collect_fun_defs f in
  let _ = if !debug then ignore (E.log "ok_to_replace: card fdefs = %d\n" (UD.VS.cardinal fdefs)) in
  let _ = if !debug then ignore (E.log "ok_to_replace: card uses = %d\n" (UD.VS.cardinal uses)) in
  verify_unmodified uses fdefs curiosh defiosh

let useList = ref []
(* Visitor for making a list of statements that use a definition *)
class useListerClass (defid:int) (vi:varinfo) = object(self)
    inherit RD.rdVisitorClass

  method! vexpr e =
    match e with
    | Lval(Var vi', off) -> begin
	match self#get_cur_iosh() with
	  Some iosh ->
	    let vido = RD.iosh_defId_find iosh defid in
	    let exists = match vido with Some _ -> true | None -> false in
	    if Util.equals vi vi' && exists
	    then (useList := sid::(!useList); DoChildren)
	    else DoChildren
	| _ -> DoChildren (*E.s (E.error "useLister: no data for statement")*)
    end
    | _ -> DoChildren

end

(* ok_to_replace_with_incdec *)
(* Find out if it is alright to replace the use of a variable
   with a post-increment/decrement of the variable it is assigned to be *)
(* Takes the definitions reaching the variable use, the definitions
   reaching the place where the variable was defined, the fundec,
   the varinfo for the variable being considered and the right
   hand side of its definition. *)
let ok_to_replace_with_incdec curiosh defiosh f id vi r =

  (* number of uses of vi where definition id reaches *)
  let num_uses () =
    let _ = useList := [] in
    let ulc = new useListerClass id vi in
    let _ = visitCilFunction (ulc :> cilVisitor) f in
    List.length (!useList)
  in

  (* Is e the addition or subtraction of one to vi?
     Return Some(PlusA) if it's an addition,
     Some(MinusA) if it's a subtraction,
     and None otherwise *)
  let inc_or_dec e vi =
    match e with
      BinOp((PlusA|PlusPI|IndexPI), Lval(Var vi', NoOffset),
	    Const(CInt(a,_,_)),_) ->
	      if vi.vid = vi'.vid && compare_cilint a one_cilint = 0
	      then Some(PlusA)
	      else if vi.vid = vi'.vid && compare_cilint a mone_cilint = 0
	      then Some(MinusA)
	      else None
    | BinOp((MinusA|MinusPI), Lval(Var vi', NoOffset),
	    Const(CInt(a,_,_)),_) ->
	      if vi.vid = vi'.vid && compare_cilint a one_cilint = 0
	      then Some(MinusA)
	      else None
    | _ -> None
  in

  match r with
    RD.RDExp(Lval(Var rhsvi, NoOffset)) ->
      let curido = RD.iosh_singleton_lookup curiosh rhsvi in
      let defido = RD.iosh_singleton_lookup defiosh rhsvi in
      (match  curido, defido with
	Some(curid), _ ->
	  let defios = try IH.find defiosh rhsvi.vid
	  with Not_found -> RD.IOS.empty in
	  let redefrhso = getDefRhs curid in
	  (match redefrhso with
	    None -> (if !debug then ignore (E.log "ok_to_replace: couldn't get rhs for redef: %d\n" curid);
		     None)
	  | Some(redefrhs, _, redefiosh) ->
	      let tmprdido = RD.iosh_singleton_lookup redefiosh vi in
	      match tmprdido with
		None -> (if !debug then ignore (E.log "ok_to_replace: conflicting defs of %s reach redef of %s\n" vi.vname rhsvi.vname);
			 None)
	      | Some tmprdid ->
		  if not (tmprdid = id) then
		    (if !debug then ignore (E.log "ok_to_replace: initial def of %s doesn't reach redef of %s\n" vi.vname rhsvi.vname);
		     None)
		  else let redefios = try IH.find redefiosh rhsvi.vid
		  with Not_found -> RD.IOS.empty in
		  let curdef_stmt = try IH.find RD.ReachingDef.defIdStmtHash curid
		  with Not_found -> E.s (E.error "ok_to_replace: couldn't find statement defining %d" curid) in
		  if not (RD.IOS.compare defios redefios = 0) then
		    (if !debug then ignore (E.log "ok_to_replace: different sets of definitions of %s reach the def of %s and the redef of %s\n"
					      rhsvi.vname vi.vname rhsvi.vname);
		     None)
		  else
		    (match redefrhs with
		      RD.RDExp(e) -> (match inc_or_dec e rhsvi with
			Some(PlusA) ->
			  if num_uses () = 1 then
			    Some(curdef_stmt.sid, curid, rhsvi, PlusA)
			  else (if !debug then ignore (E.log "ok_to_replace: tmp used more than once\n");
				None)
		      | Some(MinusA) ->
			  if num_uses () = 1 then
			    Some(curdef_stmt.sid, curid, rhsvi, MinusA)
			  else (if !debug then ignore (E.log "ok_to_replace: tmp used more than once\n");
				None)
		      | None ->
			  (if !debug then ignore (E.log "ok_to_replace: redef isn't adding or subtracting one from itself\n");
			   None)
		      | _ -> E.s (E.error "ok_to_replace: unexpected op in inc/dec info."))
		    | _ -> (if !debug then ignore (E.log "ok_to_replace: redef a call\n");
			    None)))
      | _ -> (if !debug then ignore (E.log "ok_to_replace: %s has conflicting definitions\n" rhsvi.vname);
	      None))
  | _ -> (if !debug then ignore (E.log "ok_to_replace: rhs not of correct form\n");
	  None)

(* A hash from variable ids to Call instruction
   options. If a variable id is in this table,
   and it is mapped to Some(Call()), then the
   function call can be printed instead of the
   variable *)
let iioh = IH.create 16

(* A hash from variable ids to information that
   can be used to print a post increment/decrement
   that can replace the variable *)
let incdecHash = IH.create 16

(* A hash from variable ids to a list of statement ids.
   Because a post-inc/dec will be printed elsewhere,
   the assignments of the variable in these statements
   don't need to be printed *)
let idDefHash = IH.create 16

(* Add a pair to the list for vid and create a list if one
   doesn't exist *)
let id_dh_add vid p =
  if IH.mem idDefHash vid then
    let oldlist = IH.find idDefHash vid in
    let newlist = p::oldlist in
    IH.replace idDefHash vid newlist
  else
    IH.add idDefHash vid [p]

(* check if a name matches a form *)
(* string -> nameform -> bool *)
let check_form s f =
    match f with
      Suffix sfx ->
	let frmlen = String.length sfx in
	let slen = String.length s in
	slen >= frmlen &&
	compare (String.sub s (slen - frmlen) frmlen) sfx = 0
    | Prefix pfx ->
	let frmlen = String.length pfx in
	String.length s >= frmlen &&
	compare (String.sub s 0 frmlen) pfx = 0
    | Exact ext ->
	let frmlen = String.length ext in
	String.length s = frmlen &&
	compare s ext = 0

(* check a name against a list of forms
   if it matches any then return true *)
(* string -> nameform list -> bool *)
let check_forms s fl =
  List.fold_left (fun b f -> b || check_form s f)
    false fl

let forms = [Exact "tmp";
	     Prefix "tmp___";
	     Prefix "__cil_tmp";
	     Suffix "__e";
	     Suffix "__b";]

(* action: 'a -> varinfo -> fundec -> bool -> exp option
   iosh: 'a
   fd: fundec
   nofrm: bool

   Replace Lval(Var vi, NoOffset) with
   e where action iosh sid vi fd nofrm returns Some(e) *)
let varXformClass action data sid fd nofrm = object(self)
    inherit nopCilVisitor

  method! vexpr e = match e with
    Lval(Var vi, NoOffset) ->
      (match action data sid vi fd nofrm with
	None -> DoChildren
      | Some e' ->
          (* Cast e' to the correct type. *)
          let e'' = mkCast ~e:e' ~newt:vi.vtype in
          ChangeTo e'')
  | Lval(Mem e', off) ->
      (* don't substitute constants in memory lvals *)
      let post e = match e with
	Lval(Mem(Const _),off') -> Lval(Mem e', off')
      | _ -> e
      in
      ChangeDoChildrenPost(Lval(Mem e', off), post)
  | _ -> DoChildren

end

(* action: 'a -> lval -> fundec -> bool -> exp option
   lvh: 'a
   fd: fundec
   nofrm: bool

   Replace Lval(lv) with
   e where action lvh sid lv fd nofrm returns Some(e) *)
let lvalXformClass action data sid fd nofrm = object(self)
  inherit nopCilVisitor

  method! vexpr e =
    let castrm e = e
      (*stripCastsForPtrArith e*)
    in
    match e with
    | Lval((Mem e', off) as lv)-> begin
	match action data sid lv fd nofrm with
	| None ->
	    (* don't substitute constants in memory lvals *)
	    let post e =
	      match e with
	      | Lval(Mem(Const _),off') -> Lval(Mem e', off')
	      | _ -> castrm e
	    in
	    ChangeDoChildrenPost(Lval(Mem e', off), post)
	| Some e' ->
	    let e'' = mkCast ~e:e' ~newt:(typeOf(Lval lv)) in
	    ChangeDoChildrenPost(e'', castrm)
    end
    | Lval lv -> begin
	match action data sid lv fd nofrm with
	| None -> DoChildren
	| Some e' -> begin
            (* Cast e' to the correct type. *)
            let e'' = mkCast ~e:e' ~newt:(typeOf(Lval lv)) in
            ChangeDoChildrenPost(e'', castrm)
	end
    end
    | e -> ChangeDoChildrenPost(castrm e, castrm)

end

(* Returns the set of definitions of vi in iosh that
   are not due to assignments of the form x = x *)
(* IOS.t IH.t -> varinfo -> int option *)
let iosh_get_useful_def iosh vi =
  if IH.mem iosh vi.vid then
    let ios = IH.find iosh vi.vid in
    let ios' = RD.IOS.filter (fun ido  ->
      match ido with None -> true | Some(id) ->
	match time "getDefRhs" getDefRhs id with
	  Some(RD.RDExp(Lval(Var vi',NoOffset)),_,_)
	| Some(RD.RDExp(CastE(_,Lval(Var vi',NoOffset))),_,_) ->
	    not(vi.vid = vi'.vid) (* false if they are the same *)
	| _ -> true) ios
    in
    if not(RD.IOS.cardinal ios' = 1)
    then (if !debug then ignore(E.log "iosh_get_useful_def: multiple different defs of %d:%s(%d)\n"
				  vi.vid vi.vname (RD.IOS.cardinal ios'));
	  None)
    else RD.IOS.choose ios'
  else (if !debug then ignore(E.log "iosh_get_useful_def: no def of %s reaches here\n" vi.vname);
	None)

let ae_tmp_to_exp_change = ref false
let ae_tmp_to_exp eh sid vi fd nofrm =
  if nofrm || (check_forms vi.vname forms)
  then try begin
    let e = IH.find eh vi.vid in
    if !debug then ignore(E.log "tmp_to_exp: changing %s to %a\n"
			    vi.vname d_plainexp e);
    match e with
    | Const(CStr _)
    | Const(CWStr _) -> None (* don't fwd subst str lits *)
    | _ -> begin
	ae_tmp_to_exp_change := true;
	Some e
    end
  end
  with Not_found -> None
  else None

let ae_lval_to_exp_change = ref false
let ae_lval_to_exp ?(propStrings:bool = false) lvh sid lv fd nofrm =
  match lv, nofrm with
  | (Var vi, NoOffset), false ->
      (* If the var is not a temp, then don't replace *)
      if check_forms vi.vname forms then begin
	try
	  let e = AELV.LvExpHash.find lvh lv in
	  match e with
	  | Const(CStr _)
	  | Const(CWStr _) ->
	      if propStrings then (Some e) else None
	  | _ -> begin
	      ae_lval_to_exp_change := true;
	      if !debug then ignore(E.log "ae: replacing %a with %a\n"
				      d_lval lv d_exp e);
	      Some e
	  end
	with Not_found -> None
      end else None
  | _, true -> begin
      (* replace everything *)
      try
	let e = AELV.LvExpHash.find lvh lv in
	match e with
	| Const(CStr _)
	| Const(CWStr _) ->
	    if propStrings then (Some e) else None
	| _ -> begin
	    ae_lval_to_exp_change := true;
	    if !debug then ignore(E.log "ae: replacing %a with %a\n"
				    d_lval lv d_exp e);
	    Some e
	end
      with Not_found -> None
  end
  | _, _ -> None


(* if the temp with varinfo vi can be
   replaced by an expression then return
   Some of that expression. o/w None.
   If b is true, then don't check the form *)
(* IOS.t IH.t -> sid -> varinfo -> fundec -> bool -> exp option *)
let rd_tmp_to_exp_change = ref false
let rd_tmp_to_exp iosh sid vi fd nofrm =
  if nofrm || (check_forms vi.vname forms)
  then let ido = iosh_get_useful_def iosh vi in
  match ido with None ->
    if !debug then ignore(E.log "tmp_to_exp: non-single def: %s\n" vi.vname);
    None
  | Some(id) -> let defrhs = time "getDefRhs" getDefRhs id in
    match defrhs with None ->
      if !debug then ignore(E.log "tmp_to_exp: no def of %s\n" vi.vname);
      None
    | Some(RD.RDExp(e) as r, dsid , defiosh) ->
	if time "ok_to_replace" (ok_to_replace vi iosh sid defiosh dsid fd) r
	then
	  (if !debug then ignore(E.log "tmp_to_exp: changing %s to %a\n" vi.vname d_plainexp e);
	   match e with
	   | Const(CStr _)
	   | Const(CWStr _) -> None
	   | _ -> begin
	       rd_tmp_to_exp_change := true;
	       Some e
	   end)
	else
	  (if !debug then ignore(E.log "tmp_to_exp: not ok to replace %s\n" vi.vname);
	   None)
    | _ ->
	if !debug then ignore(E.log "tmp_to_exp: rhs is call %s\n" vi.vname);
	None
  else
    (if !debug then ignore(E.log "tmp_to_exp: %s didn't match form or nofrm\n" vi.vname);
     None)

let rd_fwd_subst data sid e fd nofrm =
  rd_tmp_to_exp_change := false;
  let e' = visitCilExpr (varXformClass rd_tmp_to_exp data sid fd nofrm) e in
  (e', !rd_tmp_to_exp_change)

let ae_fwd_subst data sid e fd nofrm =
  ae_tmp_to_exp_change := false;
  let e' = visitCilExpr (varXformClass ae_tmp_to_exp data sid fd nofrm) e in
  (e', !ae_tmp_to_exp_change)

let ae_lv_fwd_subst ?(propStrings:bool = false) data sid e fd nofrm =
  ae_lval_to_exp_change := false;
  let e' = visitCilExpr (lvalXformClass (ae_lval_to_exp ~propStrings:propStrings)
			   data sid fd nofrm) e
  in
  (e', !ae_lval_to_exp_change)

let ae_simp_fwd_subst data e nofrm =
  ae_fwd_subst data (-1) e dummyFunDec nofrm

let ae_lv_simp_fwd_subst data e nofrm =
  ae_lv_fwd_subst data (-1) e dummyFunDec nofrm

let ae_tmp_to_const_change = ref false
let ae_tmp_to_const eh sid vi fd nofrm =
  if nofrm || check_forms vi.vname forms then
    try begin let e = IH.find eh vi.vid in
    match e with Const c -> begin
      ae_tmp_to_const_change := true;
      Some(Const c) end
    | _ -> None end
    with Not_found -> None
  else None

(* See if vi can be replaced by a constant
   by checking all of the definitions reaching
   this use of vi *)
let tmp_to_const_change = ref false
let tmp_to_const iosh sid vi fd nofrm =
  if nofrm || check_forms vi.vname forms then
    match RD.iosh_lookup iosh vi with
      None -> None
    | Some(ios) ->
        let defido =
	  try RD.IOS.choose ios
	  with Not_found -> None in
	match defido with None -> None | Some defid ->
	  match time "getDefRhs" getDefRhs defid with
	    None -> None
	  | Some(RD.RDExp(Const c), _, defiosh) ->
	      (match RD.getDefIdStmt defid with
		None -> E.s (E.error "tmp_to_const: defid has no statement")
	      | Some(stm) -> if ok_to_replace vi iosh sid defiosh stm.sid fd (RD.RDExp(Const c)) then
		  let same = RD.IOS.for_all (fun defido ->
		    match defido with None -> false | Some defid ->
		      match time "getDefRhs" getDefRhs defid with
			None -> false
		      | Some(RD.RDExp(Const c'),_,defiosh) ->
			  if Util.equals c c' then
			    match RD.getDefIdStmt defid with
			      None -> E.s (E.error "tmp_to_const: defid has no statement")
			    | Some(stm) -> ok_to_replace vi iosh sid defiosh stm.sid fd (RD.RDExp(Const c'))
			  else false
		      | _ -> false) ios
		  in
		  if same
		  then (tmp_to_const_change := true; Some(Const c))
		  else None
	      else None)
	  | _ -> None
  else None

let const_prop iosh sid e fd nofrm =
  tmp_to_const_change := false;
  let e' = visitCilExpr (varXformClass tmp_to_const iosh sid fd nofrm) e in
  (e', !tmp_to_const_change)

let ae_const_prop eh sid e fd nofrm =
  ae_tmp_to_const_change := false;
  let e' = visitCilExpr (varXformClass ae_tmp_to_const eh sid fd nofrm) e in
  (e', !ae_tmp_to_const_change)

class expTempElimClass (fd:fundec) = object (self)
  inherit RD.rdVisitorClass

  method! vexpr e =

    let do_change iosh vi =
      let ido = RD.iosh_singleton_lookup iosh vi in
      (match ido with
	Some id ->
	  let riviho = getDefRhs id in
	  (match riviho with
	    Some(RD.RDExp(e) as r, dsid, defiosh) ->
	      if !debug then ignore(E.log "Can I replace %s with %a?\n" vi.vname d_exp e);
	      if ok_to_replace vi iosh sid defiosh dsid fd r
	      then
		(if !debug then ignore(E.log "Yes.\n");
		 ChangeTo(e))
	      else (if !debug then ignore(E.log "No.\n");
		    DoChildren)
	  | _ -> DoChildren)
      | _ -> DoChildren)
    in

    match e with
      Lval (Var vi,NoOffset) ->
	(if check_forms vi.vname forms then
	 (* only allowed to replace a tmp with a function call once *)
	  (match cur_rd_dat with
	    Some(_,s,iosh) -> do_change iosh vi
	  | None -> let iviho = RD.getRDs sid in
	    match iviho with
	      Some(_,s,iosh) ->
		(if !debug then ignore (E.log "Try to change %s outside of instruction.\n" vi.vname);
		 do_change iosh vi)
	    | None ->
		(if !debug then ignore (E.log "%s in statement w/o RD info\n" vi.vname);
		 DoChildren))
	else DoChildren)
    | _ -> DoChildren

end

class expLvTmpElimClass (fd : fundec) = object(self)
  inherit AELV.aeVisitorClass

  method! vexpr e =
    match self#get_cur_eh () with
    | None -> DoChildren
    | Some eh -> begin
	let e', _ = ae_lv_fwd_subst ~propStrings:true eh sid e fd false in
	ChangeTo e'
    end

end

class incdecTempElimClass (fd:fundec) = object (self)
  inherit RD.rdVisitorClass

  method! vexpr e =

    let do_change iosh vi =
      let ido = RD.iosh_singleton_lookup iosh vi in
      (match ido with
	Some id ->
	  let riviho = getDefRhs id in
	  (match riviho with
	    Some(RD.RDExp(e) as r, _, defiosh) ->
	      (match ok_to_replace_with_incdec iosh defiosh fd id vi r with
		Some(curdef_stmt_id,redefid, rhsvi, b) ->
		  (if !debug then ignore(E.log "No, but I can replace it with a post-inc/dec\n");
		   if !debug then ignore(E.log "cdsi: %d redefid: %d name: %s\n"
					   curdef_stmt_id redefid rhsvi.vname);
		   IH.add incdecHash vi.vid (redefid, rhsvi, b);
		   id_dh_add rhsvi.vid (curdef_stmt_id, redefid);
		   DoChildren)
	      | None ->
		  (if !debug then ignore(E.log "No.\n");
		   DoChildren))
	  | _ -> DoChildren)
      | _ -> DoChildren)
    in

    match e with
      Lval (Var vi,NoOffset) ->
	(if check_forms vi.vname forms then
	 (* only allowed to replace a tmp with an inc/dec if there is only one use *)
	  (match cur_rd_dat with
	    Some(_,s,iosh) -> do_change iosh vi
	  | None -> let iviho = RD.getRDs sid in
	    match iviho with
	      Some(_,s,iosh) ->
		(if !debug then ignore (E.log "Try to change %s outside of instruction.\n" vi.vname);
		 do_change iosh vi)
	    | None ->
		(if !debug then ignore (E.log "%s in statement w/o RD info\n" vi.vname);
		 DoChildren))
	else DoChildren)
    | _ -> DoChildren

end

class callTempElimClass (fd:fundec) = object (self)
  inherit RD.rdVisitorClass

  method! vexpr e =

    let do_change iosh vi =
      let ido = RD.iosh_singleton_lookup iosh vi in
      (match ido with
	Some id ->
	  let riviho = getDefRhs id in
	  (match riviho with
	    Some(RD.RDCall(i) as r, dsid, defiosh) ->
	      if !debug then ignore(E.log "Can I replace %s with %a?\n" vi.vname d_instr i);
	      if ok_to_replace vi iosh sid defiosh dsid fd r
	      then (if !debug then ignore(E.log "Yes.\n");
		    IH.add iioh vi.vid (Some(i));
		    DoChildren)
	      else (if !debug then ignore(E.log "No.\n");
		    DoChildren)
	  | _ -> DoChildren)
      | _ -> DoChildren)
    in

    match e with
      Lval (Var vi,NoOffset) ->
	(if check_forms vi.vname forms then
	 (* only allowed to replace a tmp with a function call if there is only one use *)
	  if IH.mem iioh vi.vid
	  then (IH.replace iioh vi.vid None; DoChildren)
	  else
	    (match cur_rd_dat with
	      Some(_,s,iosh) -> do_change iosh vi
	    | None -> let iviho = RD.getRDs sid in
	      match iviho with
		Some(_,s,iosh) ->
		  (if !debug then ignore (E.log "Try to change %s:%d outside of instruction.\n" vi.vname vi.vid);
		   do_change iosh vi)
	      | None ->
		  (if !debug then ignore (E.log "%s in statement w/o RD info\n" vi.vname);
		   DoChildren))
	  else DoChildren)
    | _ -> DoChildren

    (* Unused definitions cause multiple replacements
       unless they are found and the replacement prevented.
       It will be possible to replace more temps if dead
       code elimination is performed before printing. *)
  method! vinst i =
    (* Need to copy this from rdVisitorClass because we are overriding *)
    if !debug then ignore(E.log "rdVis: before %a, rd_dat_lst is %d long\n"
			    d_instr i (List.length rd_dat_lst));
    (try
      cur_rd_dat <- Some(List.hd rd_dat_lst);
      rd_dat_lst <- List.tl rd_dat_lst
    with Failure _ ->
      if !debug then ignore(E.log "rdVis: il rd_dat_lst mismatch\n"));
    match i with
      Set((Var vi,off),_,_,_) ->
	if IH.mem iioh vi.vid
	then (IH.replace iioh vi.vid None; DoChildren)
	else (IH.add iioh vi.vid None; DoChildren)
    | _ -> DoChildren

end



(* Remove local declarations that aren't set or used *)
(* fundec -> unit *)
let rm_unused_locals fd =
  let oldIgnoreSizeof = !UD.ignoreSizeof in
  UD.ignoreSizeof := false;
  let used = List.fold_left (fun u s ->
    let u', d' = UD.computeDeepUseDefStmtKind s.skind in
    UD.VS.union u (UD.VS.union u' d')) UD.VS.empty fd.sbody.bstmts in
  UD.ignoreSizeof := oldIgnoreSizeof;

  let good_var vi = UD.VS.mem vi used in
  let good_locals = List.filter good_var fd.slocals in
  fd.slocals <- good_locals


(* see if a vi is volatile *)
let is_volatile vi =
  let vi_vol =
    List.exists (function (Attr("volatile",_)) -> true
      | _ -> false) vi.vattr in
  let typ_vol =
    List.exists (function (Attr("volatile",_)) -> true
      | _ -> false) (typeAttrs vi.vtype) in
  if !debug && (vi_vol || typ_vol) then
    ignore(E.log "unusedRemover: %s is volatile\n" vi.vname);
  if !debug && not(vi_vol || typ_vol) then
    ignore(E.log "unusedRemover: %s is not volatile\n" vi.vname);
  vi_vol || typ_vol


(* Remove temp variables that are set but not used *)
(* This is different from dead code elimination because
   temps that can be eliminated during pretty printing
   are also considered *)
class unusedRemoverClass : cilVisitor = object(self)
  inherit nopCilVisitor

  val mutable unused_set = UD.VS.empty
  val mutable cur_func = dummyFunDec

      (* figure out which locals aren't used *)
  method! vfunc f =
    cur_func <- f;
    (* the set of used variables *)
    let used = List.fold_left (fun u s ->
      let u', _ = UD.computeDeepUseDefStmtKind s.skind in
      UD.VS.union u u') UD.VS.empty f.sbody.bstmts in
    let used = UD.computeUseLocalTypes ~acc_used:used f in

    (* the set of unused locals *)
    let unused = List.fold_left (fun un vi ->
      if UD.VS.mem vi used
      then un
      else (if !debug then ignore (E.log "unusedRemoverClass: %s is unused\n" vi.vname);
	UD.VS.add vi un)) UD.VS.empty f.slocals in

    (* a filter function for picking out
       the local variables that need to be kept *)
    let good_var vi =
      (is_volatile vi) || (* have to keep if it's volatile *)
      (not(UD.VS.mem vi unused) && (* have to keep if it's used and if *)
       (not(IH.mem iioh vi.vid) ||  (* it's not getting eliminated during pp *)
       (match IH.find iioh vi.vid with (* getting eliminated *)
	 None -> true | Some _ -> false)) &&
       not(IH.mem incdecHash vi.vid))
    in
    let good_locals = List.filter good_var f.slocals in
    f.slocals <- good_locals;
    unused_set <- unused;
    DoChildren

  (* remove instructions that set variables
     that aren't used. Also remove instructions
     that set variables mentioned in iioh *)
  method! vstmt stm =

    (* return the list of pairs with fst = f *)
    let findf_in_pl f pl =
      List.filter (fun (fst,snd) ->
	if fst = f then true else false)
	pl
    in

    (* Return true if the assignment of this
       variable in this statement is going to be
       replaced by a post-inc/dec *)
    let check_incdec vi e =
      if IH.mem idDefHash vi.vid then
	let pl = IH.find idDefHash vi.vid in
	match findf_in_pl stm.sid pl with (sid,redefid)::l ->
	  let rhso = getDefRhs redefid in
	  (match rhso with
	    None -> (if !debug then ignore (E.log "check_incdec: couldn't find rhs for def %d\n" redefid);
		     false)
	  | Some(rhs, _, indiosh) ->
	      (match rhs with
		RD.RDCall _ -> (if !debug then ignore (E.log "check_incdec: rhs not an expression\n");
				false)
	      | RD.RDExp e' ->
		  if Util.equals e e' then true
		  else (if !debug then ignore (E.log "check_incdec: rhs of %d: %a, and needed redef %a not equal\n"
						 redefid d_plainexp e' d_plainexp e);
			false)))
	| [] -> (if !debug then ignore (E.log "check_incdec: current statement not in list: %d. %s = %a\n"
					  stm.sid vi.vname d_exp e);
		 false)
      else (if !debug then ignore (E.log "check_incdec: %s not in idDefHash\n" vi.vname);
	    false)
    in

    (* return true if the rhs will get
       pretty printed as a function call *)
    let will_be_call e =
      match e with
	Lval(Var vi,NoOffset) ->
	  if not(IH.mem iioh vi.vid) then false
	  else (match IH.find iioh vi.vid with
	    None -> false | Some _ -> true)
      | _ -> false
    in

    (* a filter function for picking out
       the instructions that we want to keep *)
    (* instr -> bool *)
    let good_instr i =
      match i with
      | Set((Var(vi),_),e,_,_) -> begin
	  if will_be_call e &&
	    not(List.mem vi cur_func.slocals) &&
	    not vi.vglob
	  then cur_func.slocals <- vi::cur_func.slocals;
	  is_volatile vi ||
	  (not (UD.VS.mem vi unused_set) &&
	   not (IH.mem incdecHash vi.vid) &&
	   not (check_incdec vi e)) ||
	   will_be_call e
      end
      | Call (Some(Var(vi),_),_,_,_,_) -> begin
	     (* If not in the table or entry is None,
		then it's good *)
	  not (IH.mem iioh vi.vid) ||
	  (match IH.find iioh vi.vid with
	    None -> true | Some _ -> false)
      end
      | Asm(_,_,slvlst,_,_,_) -> begin
	  (* make sure the outputs are in the locals list *)
	  List.iter (fun (_,s,lv) ->
	    match lv with (Var vi,_) ->
	      if List.mem vi cur_func.slocals
	      then ()
	      else cur_func.slocals <- vi::cur_func.slocals
	    |_ -> ()) slvlst;
	  true
      end
      | _ -> true
    in

    (* If the result of a function call isn't used,
       then change to Call(None,...) *)
    let call_fixer i =
      match i with
	Call (Some(Var(vi),_),e,el,l,eloc) as c ->
	  if UD.VS.mem vi unused_set then
	    Call(None,e,el,l,eloc)
	  else c
      | _ -> i
    in

    match stm.skind with
      Instr il ->
	let newil = List.filter good_instr il in
	let newil' = Util.list_map call_fixer newil in
	stm.skind <- Instr(newil');
	SkipChildren
    | _ -> DoChildren

end

(* from cleaner.ml *)

(* Lifts child blocks into parents if the block has no attributes or labels *)
let rec fold_blocks b =
    b.bstmts <- List.fold_right
	(fun s acc ->
	  match s.skind with
	    Block ib ->
	      fold_blocks ib;
	      if (List.length ib.battrs = 0 &&
		  List.length s.labels = 0) then
		ib.bstmts @ acc
	      else
		s::acc
	  | Instr il when il = [] && s.labels = [] ->
	      acc
	  | _ -> s::acc)
	b.bstmts
	[]

class removeBrackets = object (self)
  inherit nopCilVisitor
  method! vblock b =
    fold_blocks b;
    DoChildren
end

(* clean up the code and
   eliminate some temporaries
   for pretty printing a whole function *)
(* Cil.fundec -> Cil.fundec *)
let eliminate_temps f =
  ignore(visitCilFunction (new removeBrackets) f);
  Cfg.clearCFGinfo f;
  ignore(Cfg.cfgFun f);
  UD.ignoreSizeof := false;
  RD.computeRDs f;
  IH.clear iioh;
  IH.clear incdecHash;
  IH.clear idDefHash;
  let etec = new expLvTmpElimClass f in
  let f' = visitCilFunction (etec :> cilVisitor) f in
  RD.clearMemos (); (* we changed instructions and invalidated the "cache" *)
  let idtec = new incdecTempElimClass f' in
  let f' = visitCilFunction (idtec :> cilVisitor) f' in
  let ctec = new callTempElimClass f' in
  let f' = visitCilFunction (ctec :> cilVisitor) f' in
  let f' = visitCilFunction (new unusedRemoverClass) f' in
  f'

(* same as above, but doesn't remove the
   obviated instructions and declarations.
   Use this before using zrapp to print
   expressions without temps *)
let eliminateTempsForExpPrinting f =
  Cfg.clearCFGinfo f;
  ignore(Cfg.cfgFun f);
  UD.ignoreSizeof := false;
  RD.computeRDs f;
  IH.clear iioh;
  IH.clear incdecHash;
  IH.clear idDefHash;
  let etec = new expLvTmpElimClass f in
  let f' = visitCilFunction (etec :> cilVisitor) f in
  RD.clearMemos (); (* we changed instructions and invalidated the "cache" *)
  let idtec = new incdecTempElimClass f' in
  let f' = visitCilFunction (idtec :> cilVisitor) f' in
  let ctec = new callTempElimClass f' in
  let f' = visitCilFunction (ctec :> cilVisitor) f' in
  f'
OCaml

Innovation. Community. Security.