Merge pull request #135 from just-max/rename_rmtmps

Rename `Rmtmps` module to `RmUnused`

Author: michael-schwarz

doc/cil.tex

@@ -630,7 +630,7 @@ \subsection{Using CIL as a library}
 The \t{Mergecil.merge: Cil.file list -> string -> Cil.file} function merges
 multiple files. You can then invoke your analysis function on the resulting
 \t{Cil.file} data structure.  You might want to call
-\t{Rmtmps.removeUnusedTemps} first to clean up the prototypes and variables
+\t{RmUnused.removeUnused} first to clean up the prototypes and variables
 that are not used. Then you can call the function \t{Cil.dumpFile:
 cilPrinter -> out\_channel -> Cil.file -> unit} to print the file to a
 given output channel. A good \t{cilPrinter} to use is

src/cil.mli

@@ -518,7 +518,7 @@ and varinfo = {
 
     mutable vreferenced: bool;
     (** True if this variable is ever referenced. This is computed by
-       {!Rmtmps.removeUnusedTemps}. It is safe to just initialize this to False *)
+       {!RmUnused.removeUnused}. It is safe to just initialize this to False *)
 
     mutable vdescr: Pretty.doc;
     (** For most temporary variables, a description of what the var holds.

src/ciloptions.ml

@@ -330,24 +330,24 @@ let options : (string * Arg.spec * string) list =
        is_default (not !Cil.useCaseRange));
 
     "--keepunused",
-    Arg.Set Rmtmps.keepUnused,
+    Arg.Set RmUnused.keepUnused,
     (" Do not remove the unused variables and types" ^
-       is_default !Rmtmps.keepUnused);
+       is_default !RmUnused.keepUnused);
 
     "--nokeepunused",
-    Arg.Clear Rmtmps.keepUnused,
+    Arg.Clear RmUnused.keepUnused,
     (" Remove unused variables and types" ^
-       is_default (not !Rmtmps.keepUnused));
+       is_default (not !RmUnused.keepUnused));
 
     "--rmUnusedInlines",
-    Arg.Set Rmtmps.rmUnusedInlines,
+    Arg.Set RmUnused.rmUnusedInlines,
     (" Delete any unused inline functions" ^
-       is_default !Rmtmps.rmUnusedInlines);
+       is_default !RmUnused.rmUnusedInlines);
 
     "--noRmUnusedInlines",
-    Arg.Clear Rmtmps.rmUnusedInlines,
+    Arg.Clear RmUnused.rmUnusedInlines,
     (" Do not delete any unused inline functions" ^
-       is_default (not !Rmtmps.rmUnusedInlines));
+       is_default (not !RmUnused.rmUnusedInlines));
 
     (* Output Options *)
     "", Arg.Unit (fun () -> ()), " \n\t\tOutput Options\n";

src/cilutil.ml

@@ -42,7 +42,7 @@ let strictChecking= ref false   (* If doCheck is true and warnings are found,
 
 let printStats = ref false
 
-(* when 'sliceGlobal' is set, then when 'rmtmps' runs, only globals*)
+(* when 'sliceGlobal' is set, then when 'rmUnused' runs, only globals*)
 (* marked with #pragma cilnoremove(whatever) are kept; when used with *)
 (* cilly.asm.exe, the effect is to slice the input on the noremove symbols *)
 let sliceGlobal = ref false

src/frontc/cparser.mly

@@ -958,13 +958,13 @@ statement_no_null:
 		                 {(* The only attribute that should appear here
                                      is "unused". For now, we drop this on the
                                      floor, since unused labels are usually
-                                     removed anyways by Rmtmps. *)
+                                     removed anyways by RmUnused. *)
                                   LABEL (fst $1, $5, joinLoc (snd $1) $4)}
 |   IDENT COLON attribute_nocv_list location SEMICOLON
 		                 {(* The only attribute that should appear here
                                      is "unused". For now, we drop this on the
                                      floor, since unused labels are usually
-                                     removed anyways by Rmtmps. *)
+                                     removed anyways by RmUnused. *)
                                   LABEL (fst $1, NOP ($5), joinLoc (snd $1) $4)}
 |   CASE expression COLON statement location
 	                         {CASE (fst $2, $4, joinLoc $1 $5, joinLoc $1 $3)}

src/goblintCil.ml

@@ -19,7 +19,7 @@ module Formatcil = Formatcil
 module Machdep = Machdep
 module Machdepenv = Machdepenv
 module Mergecil = Mergecil
-module Rmtmps = Rmtmps
+module RmUnused = RmUnused
 
 (** {1 FrontC modules} *)
 

src/main.ml

@@ -59,12 +59,8 @@ let parseOneFile (fname: string) : C.file =
   if !Cilutil.printStages then ignore (E.log "Parsing %s\n" fname);
   let cil = F.parse fname () in
 
-  if (not (Feature.enabled "epicenter")) then (
-    (* sm: remove unused temps to cut down on gcc warnings  *)
-    (* (Stats.time "usedVar" Rmtmps.removeUnusedTemps cil);  *)
-    (* (trace "sm" (dprintf "removing unused temporaries\n")); *)
-    (Rmtmps.removeUnusedTemps cil)
-  );
+  (* remove unused temps and globals to cut down on gcc warnings  *)
+  RmUnused.removeUnused cil;
   cil
 
 let processOneFile (cil: C.file) =

src/rmtmps.ml renamed to src/rmUnused.ml

@@ -36,8 +36,9 @@
 
  *)
 
-(* rmtmps.ml *)
-(* implementation for rmtmps.mli *)
+(* rmUnused.ml *)
+(* implementation for rmUnused.mli *)
+(* previously named Rmtmps, renamed to RmUnused to clarify that not only temporaries are removed *)
 
 open Pretty
 open Cil
@@ -50,7 +51,7 @@ let keepUnused = ref false
 let rmUnusedInlines = ref false
 
 
-let trace = Trace.trace "rmtmps"
+let trace = Trace.trace "rmunused"
 
 
 
@@ -637,7 +638,7 @@ class markUsedLabels (labelMap: (string, unit) H.t) = object
       Goto (dest, _) ->
         let (ln, _, _), _ = labelsToKeep !dest.labels in
         if ln = "" then
-          E.s (E.bug "rmtmps: destination of statement does not have labels");
+          E.s (E.bug "rmUnused: destination of statement does not have labels");
         (* Mark it as used *)
         H.replace labelMap ln ();
         DoChildren
@@ -648,7 +649,7 @@ class markUsedLabels (labelMap: (string, unit) H.t) = object
   | AddrOfLabel dest ->
       let (ln, _, _), _ = labelsToKeep !dest.labels in
       if ln = "" then
-        E.s (E.bug "rmtmps: destination of address of label does not have labels");
+        E.s (E.bug "rmUnused: destination of address of label does not have labels");
       (* Mark it as used *)
       H.replace labelMap ln ();
       SkipChildren
@@ -778,7 +779,7 @@ type rootsFilter = global -> bool
 
 let isDefaultRoot = isExportedRoot
 
-let removeUnusedTemps ?(isRoot : rootsFilter = isDefaultRoot) file =
+let removeUnused ?(isRoot : rootsFilter = isDefaultRoot) file =
   if !keepUnused || Trace.traceActive "disableTmpRemoval" then
     Trace.trace "disableTmpRemoval" (dprintf "temp removal disabled\n")
   else

src/rmtmps.mli renamed to src/rmUnused.mli

@@ -36,7 +36,7 @@
 
  *)
 
-(* rmtmps.mli *)
+(* rmUnused.mli *)
 (* remove unused things from cil files:               *)
 (*   - local temporaries introduced but not used      *)
 (*   - global declarations that are not used          *)
@@ -46,18 +46,18 @@
 
 (* Some clients may wish to augment or replace the standard strategy
    for finding the initially reachable roots.  The optional
-   "isRoot" argument to Rmtmps.removeUnusedTemps grants this
+   "isRoot" argument to RmUnused.removeUnused grants this
    flexibility.  If given, it should name a function which will return
    true if a given global should be treated as a retained root.
    
-   Function Rmtmps.isDefaultRoot encapsulates the default root
+   Function RmUnused.isDefaultRoot encapsulates the default root
    collection, which consists of those global variables and functions
    which are visible to the linker and runtime loader.  A client's
    root filter can use this if the goal is to augment rather than
-   replace the standard logic.  Function Rmtmps.isExportedRoot is an
+   replace the standard logic.  Function RmUnused.isExportedRoot is an
    alternate name for this same function.
    
-   Function Rmtmps.isCompleteProgramRoot is an example of an alternate
+   Function RmUnused.isCompleteProgramRoot is an example of an alternate
    root collection.  This function assumes that it is operating on a
    complete program rather than just one object file.  It treats
    "main()" as a root, as well as any function carrying the
@@ -75,8 +75,8 @@ val isExportedRoot : rootsFilter
 val isCompleteProgramRoot : rootsFilter
 
 (* process a complete Cil file *)
-val removeUnusedTemps: ?isRoot:rootsFilter -> Cil.file -> unit
+val removeUnused : ?isRoot:rootsFilter -> Cil.file -> unit
 
 
-val keepUnused: bool ref (* Set this to true to turn off this module *)
-val rmUnusedInlines: bool ref (* Delete unused inline funcs in gcc mode? *)
+val keepUnused : bool ref (* Set this to true to turn off this module *)
+val rmUnusedInlines : bool ref (* Delete unused inline funcs in gcc mode? *)