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 IFTRACE(e) = (e)
 149   ELSE
 150 DEFINE IFTRACE(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/>_______________________<br/>"
 157        (T.preorder tree node)
 158        msg
 159        StateSet.print config.sat
 160        StateSet.print config.todo
 161
 162
 163    let debug msg tree node i config =
 164      let config = config.NodeStatus.node in
 165      eprintf
 166        "DEBUG:%s node: %i\nsat: %a\ntodo: %a\nround: %i\n"
 167        msg
 168        (T.preorder tree node)
 169        StateSet.print config.sat
 170        StateSet.print config.todo
 171        i
 172
 173    let get_form cache2 auto tag q =
 174      let phi =
 175        Cache.N2.find cache2 (tag.QName.id :> int) (q :> int)
 176      in
 177      if phi == dummy_form then
 178        let phi = Ata.get_form auto tag q in
 179        let () =
 180          Cache.N2.add
 181            cache2
 182            (tag.QName.id :> int)
 183            (q :> int) phi
 184        in phi
 185      else phi
 186
 187    type trivalent = False | True | Unknown
 188    let of_bool = function false -> False | true -> True
 189    let or_ t1 t2 =
 190      match t1 with
 191        False -> t2
 192      | True -> True
 193      | Unknown -> if t2 == True then True else Unknown
 194
 195    let and_ t1 t2 =
 196      match t1 with
 197        False -> False
 198      | True -> t2
 199      | Unknown -> if t2 == False then False else Unknown
 200
 201  (* Define as macros to get lazyness *)
 202 DEFINE OR_(t1,t2) =
 203      let __t1 = (t1) in
 204      match t1 with
 205        False -> (t2)
 206      | True -> True
 207      | Unknown -> if (t2) == True then True else Unknown
 208
 209 DEFINE AND_(t1,t2) =
 210      let __t1 = (t1) in
 211      match t1 with
 212        False -> False
 213      | True -> (t2)
 214      | Unknown -> if (t2) == False then False else Unknown
 215
 216
 217    let eval_form phi fcs nss ps ss summary =
 218      let open Ata in
 219          let rec loop phi =
 220            begin match Formula.expr phi with
 221            | Boolean.False -> False
 222            | Boolean.True -> True
 223            | Boolean.Atom (a, b) ->
 224                begin
 225                  let open NodeSummary in
 226                      match a.Atom.node with
 227                      | Move (m, q) ->
 228                          let { NodeStatus.node = n_sum; _ } as sum =
 229                            match m with
 230                              `First_child -> fcs
 231                            | `Next_sibling -> nss
 232                            | `Parent | `Previous_sibling -> ps
 233                            | `Stay -> ss
 234                          in
 235                          if sum == dummy_status || StateSet.mem q n_sum.todo then
 236                            Unknown
 237                          else
 238                            of_bool (b == StateSet.mem q n_sum.sat)
 239                      | Is_first_child -> of_bool (b == is_left summary)
 240                      | Is_next_sibling -> of_bool (b == is_right summary)
 241                      | Is k -> of_bool (b == (k == kind summary))
 242                      | Has_first_child -> of_bool (b == has_left summary)
 243                      | Has_next_sibling -> of_bool (b == has_right summary)
 244                end
 245            | Boolean.And(phi1, phi2) -> AND_ (loop phi1, loop phi2)
 246            | Boolean.Or (phi1, phi2) -> OR_ (loop phi1, loop phi2)
 247            end
 248          in
 249          loop phi
 250
 251
 252    let eval_trans_aux auto cache2 tag fcs nss ps old_status =
 253      let { sat = old_sat;
 254            todo = old_todo;
 255            summary = old_summary } as os_node = old_status.NodeStatus.node
 256      in
 257      let sat, todo =
 258        StateSet.fold (fun q ((a_sat, a_todo) as acc) ->
 259          let phi =
 260            get_form cache2 auto tag q
 261          in
 262          let v = eval_form phi fcs nss ps old_status old_summary in
 263          match v with
 264            True -> StateSet.add q a_sat, a_todo
 265          | False -> acc
 266          | Unknown -> a_sat, StateSet.add q a_todo
 267        ) old_todo (old_sat, StateSet.empty)
 268      in
 269      if old_sat != sat || old_todo != todo then
 270        NodeStatus.make { os_node with sat; todo }
 271      else old_status
 272
 273
 274    let eval_trans auto cache2 cache5 tag fcs nss ps ss =
 275      let rec loop old_status =
 276        let new_status =
 277          eval_trans_aux auto cache2 tag fcs nss ps old_status
 278        in
 279        if new_status == old_status then old_status else loop new_status
 280      in
 281      let fcsid = (fcs.NodeStatus.id :> int) in
 282      let nssid = (nss.NodeStatus.id :> int) in
 283      let psid = (ps.NodeStatus.id :> int) in
 284      let ssid = (ss.NodeStatus.id :> int) in
 285      let tagid = (tag.QName.id :> int) in
 286      let res = Cache.N5.find cache5 tagid ssid fcsid nssid psid in
 287      if res != dummy_status then res
 288      else let new_status = loop ss in
 289           Cache.N5.add cache5 tagid ssid fcsid nssid psid new_status;
 290           new_status
 291
 292
 293
 294   let top_down run =
 295     let _i = run.pass in
 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 init_todo = StateSet.diff (Ata.get_states auto) (Ata.get_starting_states auto) in
 303     let rec loop node =
 304       let node_id = T.preorder tree node in
 305       if node == T.nil || not (Bitvector.get unstable node_id) then false else begin
 306         let parent = T.parent tree node in
 307         let fc = T.first_child tree node in
 308         let fc_id = T.preorder tree fc in
 309         let ns = T.next_sibling tree node in
 310         let ns_id = T.preorder tree ns in
 311         let tag = T.tag tree node in
 312         (* We enter the node from its parent *)
 313
 314         let status0 =
 315           let c = unsafe_get_status status node_id in
 316           if c == dummy_status then
 317             (* first time we visit the node *)
 318             NodeStatus.make
 319               { sat = StateSet.empty;
 320                 todo = init_todo;
 321                 summary = NodeSummary.make
 322                   (node == T.first_child tree parent) (* is_left *)
 323                   (node == T.next_sibling tree parent) (* is_right *)
 324                   (fc != T.nil) (* has_left *)
 325                   (ns != T.nil) (* has_right *)
 326                   (T.kind tree node) (* kind *)
 327               }
 328           else c
 329         in
 330         IFTRACE(html tree node _i status0 "Entering node");
 331
 332         (* get the node_statuses for the first child, next sibling and parent *)
 333         let ps = unsafe_get_status status (T.preorder tree parent) in
 334         let fcs = unsafe_get_status status fc_id in
 335         let nss = unsafe_get_status status ns_id in
 336         (* evaluate the transitions with all this statuses *)
 337         let status1 = if status0.NodeStatus.node.todo == StateSet.empty then status0 else begin
 338           let status1 = eval_trans auto cache2 cache5 tag fcs nss ps status0 in
 339           IFTRACE(html tree node _i status1 "Updating transitions");
 340           (* update the cache if the status of the node changed *)
 341           if status1 != status0 then status.(node_id) <- status1;
 342           status1
 343         end
 344         in
 345         (* recursively traverse the first child *)
 346         let unstable_left = loop fc in
 347         (* here we re-enter the node from its first child,
 348            get the new status of the first child *)
 349         let fcs1 = unsafe_get_status status fc_id in
 350         (* update the status *)
 351         let status2 = if status1.NodeStatus.node.todo == StateSet.empty then status1 else begin
 352           let status2 = eval_trans auto cache2 cache5 tag fcs1 nss ps status1 in
 353           IFTRACE(html tree node _i status2 "Updating transitions (after first-child)");
 354           if status2 != status1 then status.(node_id) <- status2;
 355           status2
 356         end
 357         in
 358         let unstable_right = loop ns in
 359         let nss1 = unsafe_get_status status ns_id in
 360         let status3 = if status2.NodeStatus.node.todo == StateSet.empty then status2 else begin
 361           let status3 = eval_trans auto cache2 cache5 tag fcs1 nss1 ps status2 in
 362           IFTRACE(html tree node _i status3 "Updating transitions (after next-sibling)");
 363           if status3 != status2 then status.(node_id) <- status3;
 364           status3
 365         end
 366         in
 367         let unstable_self =
 368           (* if either our left or right child is unstable or if we still have transitions
 369              pending, the current node is unstable *)
 370           unstable_left
 371           || unstable_right
 372           || StateSet.empty != status3.NodeStatus.node.todo
 373         in
 374         Bitvector.unsafe_set unstable node_id unstable_self;
 375         IFTRACE((if not unstable_self then
 376             Html.finalize_node
 377               node_id
 378               _i
 379               Ata.(StateSet.intersect status3.NodeStatus.node.sat (get_selecting_states auto))));
 380         unstable_self
 381       end
 382     in
 383     run.redo <- loop (T.root tree);
 384     run.pass <- run.pass + 1
 385
 386
 387   let get_results run =
 388     let cache = run.status in
 389     let auto = run.auto in
 390     let tree = run.tree in
 391     let rec loop node acc =
 392       if node == T.nil then acc
 393       else
 394         let acc0 = loop (T.next_sibling tree node) acc in
 395         let acc1 = loop (T.first_child tree node) acc0 in
 396
 397         if Ata.(
 398           StateSet.intersect
 399             cache.(T.preorder tree node).NodeStatus.node.sat
 400             (get_selecting_states auto)) then node::acc1
 401         else acc1
 402     in
 403     loop (T.root tree) []
 404
 405
 406   let get_full_results run =
 407     let cache = run.status in
 408     let auto = run.auto in
 409     let tree = run.tree in
 410     let res_mapper = Hashtbl.create MED_H_SIZE in
 411     let () =
 412       StateSet.iter
 413         (fun q -> Hashtbl.add res_mapper q [])
 414         (Ata.get_selecting_states auto)
 415     in
 416     let dummy = [ T.nil ] in
 417     let res_mapper = Cache.N1.create dummy in
 418     let () =
 419       StateSet.iter
 420         (fun q -> Cache.N1.add res_mapper (q :> int) [])
 421         (Ata.get_selecting_states auto)
 422     in
 423     let rec loop node =
 424       if node != T.nil then
 425         let () = loop (T.next_sibling tree node) in
 426         let () = loop (T.first_child tree node) in
 427         StateSet.iter
 428           (fun q ->
 429             let res = Cache.N1.find res_mapper (q :> int) in
 430             if res != dummy then
 431               Cache.N1.add res_mapper (q :> int) (node::res)
 432           )
 433           cache.(T.preorder tree node).NodeStatus.node.sat
 434     in
 435     loop (T.root tree);
 436     (StateSet.fold_right
 437        (fun q acc -> (q, Cache.N1.find res_mapper (q :> int))::acc)
 438        (Ata.get_selecting_states auto) [])
 439
 440
 441   let prepare_run run list =
 442     let tree = run.tree in
 443     let auto = run.auto in
 444     let status = run.status in
 445     List.iter (fun node ->
 446       let parent = T.parent tree node in
 447       let fc = T.first_child tree node in
 448       let ns = T.next_sibling tree node in
 449       let status0 =
 450         NodeStatus.make
 451           { sat = Ata.get_starting_states auto;
 452             todo =
 453               StateSet.diff (Ata.get_states auto) (Ata.get_starting_states auto);
 454             summary = NodeSummary.make
 455               (node == T.first_child tree parent) (* is_left *)
 456               (node == T.next_sibling tree parent) (* is_right *)
 457               (fc != T.nil) (* has_left *)
 458               (ns != T.nil) (* has_right *)
 459               (T.kind tree node) (* kind *)
 460           }
 461       in
 462       let node_id = T.preorder tree node in
 463       status.(node_id) <- status0) list
 464
 465
 466   let compute_run auto tree nodes =
 467     let run = make auto tree in
 468     prepare_run run nodes;
 469     while run.redo do
 470       top_down run
 471     done;
 472
 473     IFTRACE(Html.gen_trace auto (module T : Tree.S with type t = T.t) tree);
 474
 475     run
 476
 477   let full_eval auto tree nodes =
 478     let r = compute_run auto tree nodes in
 479     get_full_results r
 480
 481   let eval auto tree nodes =
 482     let r = compute_run auto tree nodes in
 483     get_results r
 484
 485 end