src/run.ml

   1 (***********************************************************************)
   2 (*                                                                     *)
   3 (*                               TAToo                                 *)
   4 (*                                                                     *)
   5 (*                     Kim Nguyen, LRI UMR8623                         *)
   6 (*                   Université Paris-Sud & CNRS                       *)
   7 (*                                                                     *)
   8 (*  Copyright 2010-2013 Université Paris-Sud and Centre National de la *)
   9 (*  Recherche Scientifique. All rights reserved.  This file is         *)
  10 (*  distributed under the terms of the GNU Lesser General Public       *)
  11 (*  License, with the special exception on linking described in file   *)
  12 (*  ../LICENSE.                                                        *)
  13 (*                                                                     *)
  14 (***********************************************************************)
  15
  16 INCLUDE "utils.ml"
  17 open Format
  18 open Misc
  19
  20 module Make (T : Tree.S) =
  21  struct
  22
  23    module NodeSummary =
  24    struct
  25      (* Pack into an integer the result of the is_* and has_ predicates
  26         for a given node *)
  27      type t = int
  28      let dummy = -1
  29     (*
  30       4444444444443210
  31       4 -> kind
  32       3 -> is_left
  33       2 -> is_right
  34       1 -> has_left
  35       0 -> has_right
  36     *)
  37
  38      let has_right (s : t) : bool =
  39        Obj.magic (s land 1)
  40
  41      let has_left (s : t) : bool =
  42        Obj.magic ((s lsr 1) land 1)
  43
  44      let is_right (s : t) : bool =
  45        Obj.magic ((s lsr 2) land 1)
  46
  47      let is_left (s : t) : bool =
  48        Obj.magic ((s lsr 3) land 1)
  49
  50      let kind (s : t) : Tree.NodeKind.t =
  51        Obj.magic (s lsr 4)
  52
  53      let make is_left is_right has_left has_right kind =
  54        ((Obj.magic kind) lsl 4) lor
  55          ((int_of_bool is_left) lsl 3) lor
  56          ((int_of_bool is_right) lsl 2) lor
  57          ((int_of_bool has_left) lsl 1) lor
  58          (int_of_bool has_right)
  59
  60    end
  61
  62    type node_status = {
  63      sat : StateSet.t;  (* States that are satisfied at the current node *)
  64      todo : StateSet.t; (* States that remain to be proven *)
  65                         (* For every node_status and automaton a:
  66                            a.states - (sat U todo) = unsat *)
  67      summary : NodeSummary.t; (* Summary of the shape of the node *)
  68    }
  69 (* Describe what is kept at each node for a run *)
  70
  71    module NodeStatus =
  72      struct
  73        include Hcons.Make(struct
  74          type t = node_status
  75          let equal c d =
  76            c == d ||
  77              c.sat == d.sat &&
  78              c.todo == d.todo &&
  79              c.summary == d.summary
  80
  81          let hash c =
  82            HASHINT3((c.sat.StateSet.id :> int),
  83                     (c.todo.StateSet.id :> int),
  84                     c.summary)
  85        end
  86        )
  87        let print ppf s =
  88          fprintf ppf
  89            "{ sat: %a; todo: %a; summary: _ }"
  90            StateSet.print s.node.sat
  91            StateSet.print s.node.todo
  92      end
  93
  94    let dummy_status =
  95      NodeStatus.make { sat = StateSet.empty;
  96                        todo = StateSet.empty;
  97                        summary = NodeSummary.dummy;
  98                      }
  99
 100
 101    type run = {
 102      tree : T.t ;
 103      (* The argument of the run *)
 104      auto : Ata.t;
 105      (* The automaton to be run *)
 106      status : NodeStatus.t array;
 107      (* A mapping from node preorders to NodeStatus *)
 108      unstable : Bitvector.t;
 109      (* A bitvector remembering whether a subtree is stable *)
 110      mutable redo : bool;
 111      (* A boolean indicating whether the run is incomplete *)
 112      mutable pass : int;
 113      (* The number of times this run was updated *)
 114      mutable cache2 : Ata.Formula.t Cache.N2.t;
 115      (* A cache from states * label to list of transitions *)
 116      mutable cache5 : NodeStatus.t Cache.N5.t;
 117    }
 118
 119    let pass r = r.pass
 120    let stable r = not r.redo
 121    let auto r = r.auto
 122    let tree r = r.tree
 123
 124
 125    let dummy_form = Ata.Formula.stay State.dummy
 126
 127    let make auto tree =
 128      let len = T.size tree in
 129      {
 130        tree = tree;
 131        auto = auto;
 132        status = Array.create len dummy_status;
 133        unstable = Bitvector.create ~init:true len;
 134        redo = true;
 135        pass = 0;
 136        cache2 = Cache.N2.create dummy_form;
 137        cache5 = Cache.N5.create dummy_status;
 138      }
 139
 140    let get_status a i =
 141      if i < 0 then dummy_status else Array.get a i
 142
 143    let unsafe_get_status a i =
 144      if i < 0 then dummy_status else Array.unsafe_get a i
 145
 146 IFDEF HTMLTRACE
 147   THEN
 148 DEFINE TRACE(e) = (e)
 149   ELSE
 150 DEFINE TRACE(e) = ()
 151 END
 152
 153    let html tree node i config msg =
 154      let config = config.NodeStatus.node in
 155      Html.trace (T.preorder tree node) i
 156        "node: %i<br/>%s<br/>sat: %a<br/>todo: %a<br/>round: %i<br/>"
 157        (T.preorder tree node)
 158        msg
 159        StateSet.print config.sat
 160        StateSet.print config.todo
 161        i
 162
 163
 164    let debug msg tree node i config =
 165      let config = config.NodeStatus.node in
 166      eprintf
 167        "DEBUG:%s node: %i\nsat: %a\ntodo: %a\nround: %i\n"
 168        msg
 169        (T.preorder tree node)
 170        StateSet.print config.sat
 171        StateSet.print config.todo
 172        i
 173
 174    let get_form cache2 auto tag q =
 175      let phi =
 176        Cache.N2.find cache2 (tag.QName.id :> int) (q :> int)
 177      in
 178      if phi == dummy_form then
 179        let phi = Ata.get_form auto tag q in
 180        let () =
 181          Cache.N2.add
 182            cache2
 183            (tag.QName.id :> int)
 184            (q :> int) phi
 185        in phi
 186      else phi
 187
 188    type trivalent = False | True | Unknown
 189    let of_bool = function false -> False | true -> True
 190    let or_ t1 t2 =
 191      match t1 with
 192        False -> t2
 193      | True -> True
 194      | Unknown -> if t2 == True then True else Unknown
 195
 196    let and_ t1 t2 =
 197      match t1 with
 198        False -> False
 199      | True -> t2
 200      | Unknown -> if t2 == False then False else Unknown
 201
 202  (* Define as macros to get lazyness *)
 203 DEFINE OR_(t1,t2) =
 204      let __t1 = (t1) in
 205      match t1 with
 206        False -> (t2)
 207      | True -> True
 208      | Unknown -> if (t2) == True then True else Unknown
 209
 210 DEFINE AND_(t1,t2) =
 211      let __t1 = (t1) in
 212      match t1 with
 213        False -> False
 214      | True -> (t2)
 215      | Unknown -> if (t2) == False then False else Unknown
 216
 217
 218    let eval_form phi fcs nss ps ss summary =
 219      let open Ata in
 220          let rec loop phi =
 221            begin match Formula.expr phi with
 222            | Boolean.False -> False
 223            | Boolean.True -> True
 224            | Boolean.Atom (a, b) ->
 225                begin
 226                  let open NodeSummary in
 227                      match a.Atom.node with
 228                      | Move (m, q) ->
 229                          let { NodeStatus.node = n_sum; _ } as sum =
 230                            match m with
 231                              `First_child -> fcs
 232                            | `Next_sibling -> nss
 233                            | `Parent | `Previous_sibling -> ps
 234                            | `Stay -> ss
 235                          in
 236                          if sum == dummy_status || StateSet.mem q n_sum.todo then
 237                            Unknown
 238                          else
 239                            of_bool (b == StateSet.mem q n_sum.sat)
 240                      | Is_first_child -> of_bool (b == is_left summary)
 241                      | Is_next_sibling -> of_bool (b == is_right summary)
 242                      | Is k -> of_bool (b == (k == kind summary))
 243                      | Has_first_child -> of_bool (b == has_left summary)
 244                      | Has_next_sibling -> of_bool (b == has_right summary)
 245                end
 246            | Boolean.And(phi1, phi2) -> AND_ (loop phi1, loop phi2)
 247            | Boolean.Or (phi1, phi2) -> OR_ (loop phi1, loop phi2)
 248            end
 249          in
 250          loop phi
 251
 252
 253    let eval_trans_aux auto cache2 tag fcs nss ps old_status =
 254      let { sat = old_sat;
 255            todo = old_todo;
 256            summary = old_summary } as os_node = old_status.NodeStatus.node
 257      in
 258      let sat, todo =
 259        StateSet.fold (fun q ((a_sat, a_todo) as acc) ->
 260          let phi =
 261            get_form cache2 auto tag q
 262          in
 263          let v = eval_form phi fcs nss ps old_status old_summary in
 264          match v with
 265            True -> StateSet.add q a_sat, a_todo
 266          | False -> acc
 267          | Unknown -> a_sat, StateSet.add q a_todo
 268        ) old_todo (old_sat, StateSet.empty)
 269      in
 270      if old_sat != sat || old_todo != todo then
 271        NodeStatus.make { os_node with sat; todo }
 272      else old_status
 273
 274
 275    let eval_trans auto cache2 cache5 tag fcs nss ps ss =
 276      let rec loop old_status =
 277        let new_status =
 278          eval_trans_aux auto cache2 tag fcs nss ps old_status
 279        in
 280        if new_status == old_status then old_status else loop new_status
 281      in
 282      let fcsid = (fcs.NodeStatus.id :> int) in
 283      let nssid = (nss.NodeStatus.id :> int) in
 284      let psid = (ps.NodeStatus.id :> int) in
 285      let ssid = (ss.NodeStatus.id :> int) in
 286      let tagid = (tag.QName.id :> int) in
 287      let res = Cache.N5.find cache5 tagid ssid fcsid nssid psid in
 288      if res != dummy_status then res
 289      else let new_status = loop ss in
 290           Cache.N5.add cache5 tagid ssid fcsid nssid psid new_status;
 291           new_status
 292
 293
 294
 295   let top_down run =
 296     let tree = run.tree in
 297     let auto = run.auto in
 298     let status = run.status in
 299     let cache2 = run.cache2 in
 300     let cache5 = run.cache5 in
 301     let unstable = run.unstable in
 302     let rec loop node =
 303       let node_id = T.preorder tree node in
 304       if node == T.nil || not (Bitvector.get unstable node_id) then false else begin
 305         let parent = T.parent tree node in
 306         let fc = T.first_child tree node in
 307         let fc_id = T.preorder tree fc in
 308         let ns = T.next_sibling tree node in
 309         let ns_id = T.preorder tree ns in
 310         let tag = T.tag tree node in
 311         (* We enter the node from its parent *)
 312
 313         let status0 =
 314           let c = unsafe_get_status status node_id in
 315           if c == dummy_status then
 316             (* first time we visit the node *)
 317             NodeStatus.make
 318               { sat = StateSet.empty;
 319                 todo = StateSet.diff
 320                   (Ata.get_states auto)
 321                   (Ata.get_starting_states auto);
 322                 summary = NodeSummary.make
 323                   (node == T.first_child tree parent) (* is_left *)
 324                   (node == T.next_sibling tree parent) (* is_right *)
 325                   (fc != T.nil) (* has_left *)
 326                   (ns != T.nil) (* has_right *)
 327                   (T.kind tree node) (* kind *)
 328               }
 329           else c
 330         in
 331         TRACE(html tree node _i config0 "Entering node");
 332
 333         (* get the node_statuses for the first child, next sibling and parent *)
 334         let ps = unsafe_get_status status (T.preorder tree parent) in
 335         let fcs = unsafe_get_status status fc_id in
 336         let nss = unsafe_get_status status ns_id in
 337         (* evaluate the transitions with all this statuses *)
 338         let status1 = eval_trans auto cache2 cache5 tag fcs nss ps status0 in
 339         TRACE(html tree node _i config1 "Updating transitions");
 340
 341         (* update the cache if the status of the node changed *)
 342
 343         if status1 != status0 then status.(node_id) <- status1;
 344         (* recursively traverse the first child *)
 345         let unstable_left = loop fc in
 346         (* here we re-enter the node from its first child,
 347            get the new status of the first child *)
 348         let fcs1 = unsafe_get_status status fc_id in
 349         (* update the status *)
 350         let status2 = eval_trans auto cache2 cache5 tag fcs1 nss ps status1 in
 351
 352         TRACE(html tree node _i config2 "Updating transitions (after first-child)");
 353
 354         if status2 != status1 then status.(node_id) <- status2;
 355         let unstable_right = loop ns in
 356         let nss1 = unsafe_get_status status ns_id in
 357         let status3 = eval_trans auto cache2 cache5 tag fcs1 nss1 ps status2 in
 358
 359         TRACE(html tree node _i config3 "Updating transitions (after next-sibling)");
 360
 361         if status3 != status2 then status.(node_id) <- status3;
 362
 363         let unstable_self =
 364           (* if either our left or right child is unstable or if we still have transitions
 365              pending, the current node is unstable *)
 366           unstable_left
 367           || unstable_right
 368           || StateSet.empty != status3.NodeStatus.node.todo
 369         in
 370         Bitvector.unsafe_set unstable node_id unstable_self;
 371         TRACE((if not unstable_self then
 372             Html.finalize_node
 373               node_id
 374               _i
 375               Ata.(StateSet.intersect config3.Config.node.sat auto.selection_states)));
 376         unstable_self
 377       end
 378     in
 379     run.redo <- loop (T.root tree);
 380     run.pass <- run.pass + 1
 381
 382 (*
 383   let stats run =
 384     let count = ref 0 in
 385     let len = Bitvector.length run.unstable in
 386     for i = 0 to len - 1 do
 387       if not (Bitvector.unsafe_get run.unstable i) then
 388         incr count
 389     done;
 390     Logger.msg `STATS
 391       "%i nodes over %i were skipped in iteration %i (%.2f %%), redo is: %b"
 392       !count len run.pass (100. *. (float !count /. float len))
 393       run.redo
 394
 395
 396   let eval auto tree node =
 397     let len = T.size tree in
 398     let run = { config = Array.create len Ata.dummy_config;
 399                 unstable = Bitvector.create ~init:true len;
 400                 redo = true;
 401                 pass = 0
 402               }
 403     in
 404     while run.redo do
 405       run.redo <- false;
 406       Ata.reset auto; (* prevents the .cache2 and .cache4 memoization tables from growing too much *)
 407       run.redo <- top_down_run auto tree node run;
 408       stats run;
 409       run.pass <- run.pass + 1;
 410     done;
 411     at_exit (fun () -> Logger.msg `STATS "%i iterations" run.pass);
 412     at_exit (fun () -> stats run);
 413     let r = get_results auto tree node run.config in
 414
 415     TRACE(Html.gen_trace (module T : Tree.S with type t = T.t) (tree));
 416
 417     r
 418 *)
 419
 420   let get_results run =
 421     let cache = run.status in
 422     let auto = run.auto in
 423     let tree = run.tree in
 424     let rec loop node acc =
 425       if node == T.nil then acc
 426       else
 427         let acc0 = loop (T.next_sibling tree node) acc in
 428         let acc1 = loop (T.first_child tree node) acc0 in
 429
 430         if Ata.(
 431           StateSet.intersect
 432             cache.(T.preorder tree node).NodeStatus.node.sat
 433             (get_selecting_states auto)) then node::acc1
 434         else acc1
 435     in
 436     loop (T.root tree) []
 437
 438
 439   let get_full_results run =
 440     let cache = run.status in
 441     let auto = run.auto in
 442     let tree = run.tree in
 443     let res_mapper = Hashtbl.create MED_H_SIZE in
 444     let () =
 445       StateSet.iter
 446         (fun q -> Hashtbl.add res_mapper q [])
 447         (Ata.get_selecting_states auto)
 448     in
 449     let rec loop node =
 450       if node != T.nil then
 451         let () = loop (T.next_sibling tree node) in
 452         let () = loop (T.first_child tree node) in
 453         StateSet.iter
 454           (fun q ->
 455             try
 456               let acc = Hashtbl.find res_mapper q in
 457               Hashtbl.replace res_mapper q (node::acc)
 458             with
 459               Not_found -> ())
 460           cache.(T.preorder tree node).NodeStatus.node.sat
 461     in
 462     loop (T.root tree);
 463     StateSet.fold
 464       (fun q acc -> (q, Hashtbl.find res_mapper q)::acc)
 465       (Ata.get_selecting_states auto) []
 466
 467   let prepare_run run list =
 468     let tree = run.tree in
 469     let auto = run.auto in
 470     let status = run.status in
 471     List.iter (fun node ->
 472       let parent = T.parent tree node in
 473       let fc = T.first_child tree node in
 474       let ns = T.next_sibling tree node in
 475       let status0 =
 476         NodeStatus.make
 477           { sat = Ata.get_starting_states auto;
 478             todo =
 479               StateSet.diff (Ata.get_states auto) (Ata.get_starting_states auto);
 480             summary = NodeSummary.make
 481               (node == T.first_child tree parent) (* is_left *)
 482               (node == T.next_sibling tree parent) (* is_right *)
 483               (fc != T.nil) (* has_left *)
 484               (ns != T.nil) (* has_right *)
 485               (T.kind tree node) (* kind *)
 486           }
 487       in
 488       let node_id = T.preorder tree node in
 489       status.(node_id) <- status0) list
 490
 491
 492   let eval full auto tree nodes =
 493     let run = make auto tree in
 494     prepare_run run nodes;
 495     while run.redo do
 496       top_down run
 497     done;
 498     if full then `Full (get_full_results run)
 499     else `Normal (get_results run)
 500
 501
 502   let full_eval auto tree nodes =
 503     match eval true auto tree nodes with
 504       `Full l -> l
 505     | _ -> assert false
 506
 507   let eval auto tree nodes =
 508     match eval false auto tree nodes with
 509       `Normal l -> l
 510     | _ -> assert false
 511
 512 end