package goblint
Static analysis framework for C
Install
Dune Dependency
Authors
Maintainers
Sources
goblint-2.5.0.tbz
sha256=452d8491527aea21f2cbb11defcc14ba0daf9fdb6bdb9fc0af73e56eac57b916
sha512=1993cd45c4c7fe124ca6e157f07d17ec50fab5611b270a434ed1b7fb2910aa85a8e6eaaa77dad770430710aafb2f6d676c774dd33942d921f23e2f9854486551
doc/src/goblint.incremental/compareCIL.ml.html
Source file compareCIL.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
(** Comparison of CIL files. *) open GoblintCil open MyCFG include CompareAST include CompareCFG include CilMaps module GlobalMap = Map.Make(String) type global_def = Var of varinfo | Fun of fundec type global_col = {decls: varinfo option; def: global_def option} let name_of_global_col gc = match gc.def with | Some (Fun f) -> f.svar.vname | Some (Var v) -> v.vname | None -> match gc.decls with | Some v -> v.vname | None -> raise (Failure "empty global record") let compare_global_col gc1 gc2 = compare (name_of_global_col gc1) (name_of_global_col gc2) let equal_name_global_col gc1 gc2 = compare_global_col gc1 gc2 = 0 let get_varinfo gc = match gc.decls, gc.def with | _, Some (Var v) -> v | _, Some (Fun f) -> f.svar | Some v, _ -> v | _ -> failwith "A global should have at least a declaration or a definition" module GlobalColMap = Map.Make( struct type t = global_col [@@deriving ord] end) let name_of_global g = match g with | GVar (v,_,_) -> v.vname | GFun (f,_) -> f.svar.vname | GVarDecl (v,_) -> v.vname | _ -> failwith "global constructor not supported" type nodes_diff = { unchangedNodes: (node * node) list; primObsoleteNodes: node list; (** primary obsolete nodes -> all obsolete nodes are reachable from these *) } type unchanged_global = { old: global_col; current: global_col } (** For semantically unchanged globals, still keep old and current version of global for resetting current to old. *) type changed_global = { old: global_col; current: global_col; unchangedHeader: bool; diff: nodes_diff option } module VarinfoSet = Set.Make(CilType.Varinfo) type change_info = { mutable changed: changed_global list; mutable unchanged: unchanged_global list; mutable removed: global_col list; mutable added: global_col list; mutable exclude_from_rel_destab: VarinfoSet.t; (** Set of functions that are to be force-reanalyzed. These functions are additionally included in the [changed] field, among the other changed globals. *) } let empty_change_info () : change_info = {added = []; removed = []; changed = []; unchanged = []; exclude_from_rel_destab = VarinfoSet.empty} (* 'ChangedFunHeader' is used for functions whose varinfo or formal parameters changed. 'Changed' is used only for * changed functions whose header is unchanged and changed non-function globals *) type change_status = Unchanged | Changed | ChangedFunHeader of Cil.fundec | ForceReanalyze of Cil.fundec (** Given a boolean that indicates whether the code object is identical to the previous version, returns the corresponding [change_status]*) let unchanged_to_change_status = function | true -> Unchanged | false -> Changed let empty_rename_mapping: rename_mapping = (StringMap.empty, VarinfoMap.empty, VarinfoMap.empty, ([], [])) let should_reanalyze (fdec: Cil.fundec) = List.mem fdec.svar.vname (GobConfig.get_string_list "incremental.force-reanalyze.funs") let performRenames (renamesOnSuccess: renamesOnSuccess) = begin let (compinfoRenames, enumRenames) = renamesOnSuccess in (* Reset cnames and ckeys to the old value. Only affects anonymous structs/unions where names are not checked for equality. *) List.iter (fun (compinfo2, compinfo1) -> compinfo2.cname <- compinfo1.cname; compinfo2.ckey <- compinfo1.ckey) compinfoRenames; List.iter (fun (enum2, enum1) -> enum2.ename <- enum1.ename) enumRenames; end let preservesSameNameMatches n_old oldMap n_new newMap = n_old = n_new || (not (GlobalMap.mem n_old newMap) && not (GlobalMap.mem n_new oldMap)) let addToFinalMatchesMapping oV nV final_matches = VarinfoMap.add oV nV (fst final_matches), VarinfoMap.add nV oV (snd final_matches) let empty_rename_assms m = VarinfoMap.for_all (fun vo vn -> vo.vname = vn.vname) m let already_matched oV nV final_matches = match VarinfoMap.find_opt oV (fst final_matches) with | None -> false | Some v -> v.vid = oV.vid (* looks up the result of the already executed comparison and returns true if it is unchanged, false if it is changed. Throws an exception if not found. *) let change_info_lookup old_glob new_glob change_info = List.exists (fun (u : unchanged_global) -> equal_name_global_col u.old old_glob && equal_name_global_col u.current new_glob) change_info.unchanged (* Compares two varinfos of globals. finalizeOnlyExactMatch=true allows to check a rename assumption and discard the comparison result in case they do not match *) let eq_glob_var ?(finalizeOnlyExactMatch=false) oV gc_old oldMap nV gc_new newMap change_info final_matches = if already_matched oV nV final_matches then (* check if this function was already matched and lookup the result *) change_info_lookup gc_old gc_new change_info, change_info, final_matches else if not (preservesSameNameMatches oV.vname oldMap nV.vname newMap) then (* do not allow for matches between differently named variables if one of the variables names exists in both, the new and old file *) false, change_info, final_matches else ( let identical, (_, function_dependencies, global_var_dependencies, renamesOnSuccess) = eq_varinfo oV nV ~rename_mapping:empty_rename_mapping in if not finalizeOnlyExactMatch || identical then performRenames renamesOnSuccess; (* updates enum names and compinfo names and keys that were collected during comparison of this matched function *) if identical then ( change_info.unchanged <- {old = gc_old; current = gc_new} :: change_info.unchanged; true, change_info, addToFinalMatchesMapping oV nV final_matches ) else if not finalizeOnlyExactMatch then ( change_info.changed <- {old = gc_old; current = gc_new; unchangedHeader = true; diff = None} :: change_info.changed; false, change_info, addToFinalMatchesMapping oV nV final_matches ) else false, change_info, final_matches ) let compare_varinfo_exact = eq_glob_var ~finalizeOnlyExactMatch:true (* If some CFGs of the two functions to be compared are provided, a fine-grained CFG comparison is done that also determines which * nodes of the function changed. If on the other hand no CFGs are provided, the "old" AST comparison on the CIL.file is * used for functions. Then no information is collected regarding which parts/nodes of the function changed. *) let eqF (old: Cil.fundec) (current: Cil.fundec) (cfgs : (cfg * (cfg * cfg)) option) (global_function_rename_mapping: method_rename_assumptions) (global_var_rename_mapping: glob_var_rename_assumptions) = let identical, diffOpt, (_, renamed_method_dependencies, renamed_global_vars_dependencies, renamesOnSuccess) = if should_reanalyze current then ForceReanalyze current, None, empty_rename_mapping else let add_locals_to_rename_mapping la lb map = try List.fold_left2 (fun map a b -> StringMap.add a.vname b.vname map) map la lb with Invalid_argument _ -> map in let parameterMapping = add_locals_to_rename_mapping old.sformals current.sformals StringMap.empty in let renameMapping = (parameterMapping, global_function_rename_mapping, global_var_rename_mapping, ([], [])) in (* compare the function header based on the collected rename assumptions for parameters *) let unchangedHeader, renameMapping = eq_varinfo old.svar current.svar ~rename_mapping:renameMapping &&>> forward_list_equal eq_varinfo old.sformals current.sformals in if not unchangedHeader then ChangedFunHeader current, None, empty_rename_mapping else (* include matching of local variables into rename mapping *) let renameMapping = match renameMapping with | (pm, gf, gv, re) -> (add_locals_to_rename_mapping old.slocals current.slocals pm, gf, gv, re) in let sameLocals, renameMapping = forward_list_equal eq_varinfo old.slocals current.slocals ~rename_mapping:renameMapping in if not sameLocals then (Changed, None, empty_rename_mapping) else match cfgs with | None -> let (identical, new_rename_mapping) = eq_block (old.sbody, old) (current.sbody, current) ~rename_mapping:renameMapping in unchanged_to_change_status identical, None, new_rename_mapping | Some (cfgOld, (cfgNew, cfgNewBack)) -> let module CfgOld : MyCFG.CfgForward = struct let next = cfgOld end in let module CfgNew : MyCFG.CfgBidir = struct let prev = cfgNewBack let next = cfgNew end in let matches, diffNodes1, updated_rename_mapping = compareFun (module CfgOld) (module CfgNew) old current renameMapping in if diffNodes1 = [] then (Unchanged, None, updated_rename_mapping) else (Changed, Some {unchangedNodes = matches; primObsoleteNodes = diffNodes1}, updated_rename_mapping) in identical, diffOpt, renamed_method_dependencies, renamed_global_vars_dependencies, renamesOnSuccess let eqF_only_consider_exact_match gc_old gc_new change_info final_matches oldMap newMap = match gc_old.def, gc_new.def with | None, None -> ( match gc_old.decls, gc_new.decls with | Some old_var, Some new_var -> compare_varinfo_exact old_var gc_old oldMap new_var gc_new newMap change_info final_matches | _ -> failwith "A global collection should never be empty") | Some (Fun f1), Some (Fun f2) -> ( if already_matched f1.svar f2.svar final_matches then (* check if this function was already matched and lookup the result *) change_info_lookup gc_old gc_new change_info, change_info, final_matches else if not (preservesSameNameMatches f1.svar.vname oldMap f2.svar.vname newMap) then (* check that names of match are each only contained in new or old file *) false, change_info, final_matches else (* the exact comparison is always uses the AST comparison because only when unchanged this match is manifested *) let doMatch, diff, fun_deps, global_deps, renamesOnSuccess = eqF f1 f2 None VarinfoMap.empty VarinfoMap.empty in match doMatch with | Unchanged when empty_rename_assms (VarinfoMap.filter (fun vo vn -> not (vo.vname = f1.svar.vname && vn.vname = f2.svar.vname)) fun_deps) && empty_rename_assms global_deps -> performRenames renamesOnSuccess; change_info.unchanged <- {old = gc_old; current = gc_new} :: change_info.unchanged; let final_matches = addToFinalMatchesMapping f1.svar f2.svar final_matches in true, change_info, final_matches | Unchanged -> false, change_info, final_matches | Changed -> false, change_info, final_matches | ChangedFunHeader _ -> false, change_info, final_matches | ForceReanalyze _ -> false, change_info, final_matches) | _, _ -> false, change_info, final_matches let eqF_check_contained_renames ~renameDetection f1 f2 oldMap newMap cfgs gc_old gc_new (change_info, final_matches) = let doMatch, diff, function_dependencies, global_var_dependencies, renamesOnSuccess = eqF f1 f2 cfgs VarinfoMap.empty VarinfoMap.empty in performRenames renamesOnSuccess; (* updates enum names and compinfo names and keys that were collected during comparison of this matched function *) (* for rename detection, check whether the rename assumptions collected during the function comparison actually match exactly, otherwise check that the function comparison was successful without collecting any rename assumptions *) let dependenciesMatch, change_info, final_matches = if renameDetection then let extract_globs _ gc map = let v = get_varinfo gc in VarinfoMap.add v gc map in let var_glob_old = GlobalMap.fold extract_globs oldMap VarinfoMap.empty in let var_glob_new = GlobalMap.fold extract_globs newMap VarinfoMap.empty in let funDependenciesMatch, change_info, final_matches = VarinfoMap.fold (fun f_old_var f_new_var (acc, ci, fm) -> let gc_old = VarinfoMap.find f_old_var var_glob_old in let gc_new = VarinfoMap.find f_new_var var_glob_new in if acc then eqF_only_consider_exact_match gc_old gc_new ci fm oldMap newMap else false, ci, fm ) function_dependencies (true, change_info, final_matches) in let globalDependenciesMatch, change_info, final_matches = VarinfoMap.fold (fun old_var new_var (acc, ci, fm) -> let glob_old = VarinfoMap.find old_var var_glob_old in let glob_new = VarinfoMap.find new_var var_glob_new in if acc then compare_varinfo_exact old_var glob_old oldMap new_var glob_new newMap ci fm else false, ci, fm ) global_var_dependencies (true, change_info, final_matches) in funDependenciesMatch && globalDependenciesMatch, change_info, final_matches else empty_rename_assms function_dependencies && empty_rename_assms global_var_dependencies, change_info, final_matches in let append_to_changed ~unchangedHeader ~diff = change_info.changed <- {current = gc_new; old = gc_old; unchangedHeader; diff} :: change_info.changed in (match doMatch with | Unchanged when dependenciesMatch -> change_info.unchanged <- {old = gc_old; current = gc_new} :: change_info.unchanged | Unchanged -> (* no diff is stored, also when comparing functions based on CFG because currently there is no mechanism to detect which part was affected by the *) append_to_changed ~unchangedHeader:true ~diff:None | Changed -> append_to_changed ~unchangedHeader:true ~diff:diff | _ -> (* this can only be ForceReanalyze or ChangedFunHeader *) change_info.exclude_from_rel_destab <- VarinfoSet.add f1.svar change_info.exclude_from_rel_destab; append_to_changed ~unchangedHeader:false ~diff:None); change_info, addToFinalMatchesMapping f1.svar f2.svar final_matches let eq_glob ?(matchVars=true) ?(matchFuns=true) ?(renameDetection=false) oldMap newMap cfgs gc_old gc_new (change_info, final_matches) = match gc_old.def, gc_new.def with | Some (Var v1), Some (Var v2) when matchVars -> let _, ci, fm = eq_glob_var v1 gc_old oldMap v2 gc_new newMap change_info final_matches in ci, fm | Some (Fun f1), Some (Fun f2) when matchFuns -> eqF_check_contained_renames ~renameDetection f1 f2 oldMap newMap cfgs gc_old gc_new (change_info, final_matches) | None, None -> (match gc_old.decls, gc_new.decls with | Some v1, Some v2 when matchVars -> let _, ci, fm = eq_glob_var v1 gc_old oldMap v2 gc_new newMap change_info final_matches in ci, fm | _ -> change_info, final_matches (* a global collection should never be empty *)) (* Without rename detection a global definition or declaration that does not have respective counterpart in the other version is considered to be changed (not added or removed) because a global collection only exists in the map if there is at least one declaration or definition for this global. For the rename detection they can only be added to changed when the according flag is set, because there would be duplicates when iterating over the globals several times. *) | Some (Var _), None | None, Some (Var _) -> if matchVars then ( change_info.changed <- {old = gc_old; current = gc_new; diff = None; unchangedHeader = true} :: change_info.changed; change_info, addToFinalMatchesMapping (get_varinfo gc_old) (get_varinfo gc_new) final_matches) else change_info, final_matches | _, _ -> if matchVars && matchFuns then ( change_info.changed <- {old = gc_old; current = gc_new; diff = None; unchangedHeader = true} :: change_info.changed; change_info, addToFinalMatchesMapping (get_varinfo gc_old) (get_varinfo gc_new) final_matches) else change_info, final_matches let addNewGlobals name gc_new (change_info, final_matches) = if not (VarinfoMap.mem (get_varinfo gc_new) (snd final_matches)) then change_info.added <- gc_new :: change_info.added; (change_info, final_matches) let addOldGlobals name gc_old (change_info, final_matches) = if not (VarinfoMap.mem (get_varinfo gc_old) (fst final_matches)) then change_info.removed <- gc_old :: change_info.removed; (change_info, final_matches) let compareCilFiles ?(eq=eq_glob) (oldAST: file) (newAST: file) = let cfgs = if GobConfig.get_string "incremental.compare" = "cfg" then Some Batteries.(CfgTools.getCFG oldAST |> Tuple3.first, CfgTools.getCFG newAST |> Tuple3.get12) else None in let addGlobal map global = try let name, col = match global with | GVar (v,_,_) -> v.vname, {decls = None; def = Some (Var v)} | GFun (f,_) -> f.svar.vname, {decls = None; def = Some (Fun f)} | GVarDecl (v,_) -> v.vname, {decls = Some v; def = None} | _ -> raise Not_found in let merge_d def1 def2 = match def1, def2 with | Some d, None -> Some d | None, Some d -> Some d | None, None -> None | _ -> failwith "there can only be one definition and one declaration per global" in let merge_global_col entry = match entry with | None -> Some col | Some col' -> Some {decls = merge_d col.decls col'.decls; def = merge_d col.def col'.def} in GlobalMap.update name merge_global_col map; with Not_found -> map in (* Store a map from global names in the old file to the globals declarations and/or definition *) let oldMap = Cil.foldGlobals oldAST addGlobal GlobalMap.empty in let newMap = Cil.foldGlobals newAST addGlobal GlobalMap.empty in let changes = empty_change_info () in global_typ_acc := []; let findChanges ?(matchVars=true) ?(matchFuns=true) ?(renameDetection=false) oldMap newMap cfgs name gc_new (change_info, final_matches) = try let gc_old = GlobalMap.find name oldMap in eq ~matchVars ~matchFuns ~renameDetection oldMap newMap cfgs gc_old gc_new (change_info, final_matches) with Not_found -> if not renameDetection then change_info.added <- gc_new::change_info.added; (* Global could not be found in old map -> added *) change_info, final_matches in if GobConfig.get_bool "incremental.detect-renames" then ( let _ = (changes, (VarinfoMap.empty, VarinfoMap.empty)) (* change_info and final_matches (bi-directional) is propagated *) |> GlobalMap.fold (findChanges ~matchVars:true ~matchFuns:false ~renameDetection:true oldMap newMap cfgs) newMap |> GlobalMap.fold (findChanges ~matchVars:false ~matchFuns:true ~renameDetection:true oldMap newMap cfgs) newMap |> GlobalMap.fold addNewGlobals newMap |> GlobalMap.fold addOldGlobals oldMap in () ) else ( let _ = (changes, (VarinfoMap.empty, VarinfoMap.empty)) (* change_info and final_matches (bi-directional) is propagated *) |> GlobalMap.fold (findChanges oldMap newMap cfgs) newMap |> GlobalMap.fold addOldGlobals oldMap in () ); changes (** Given an (optional) equality function between [Cil.global]s, an old and a new [Cil.file], this function computes a [change_info], which describes which [global]s are changed, unchanged, removed and added. *) let compareCilFiles ?eq (oldAST: file) (newAST: file) = Timing.wrap "compareCilFiles" (compareCilFiles ?eq oldAST) newAST
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>