62be713138fd0e884fe95b5bab9bd6ff0311710a
[tatoo.git] / src / ata.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 (*
17   Time-stamp: <Last modified on 2013-04-22 14:46:08 CEST by Kim Nguyen>
18 *)
19
20 INCLUDE "utils.ml"
21 open Format
22
23 type predicate = | First_child
24                  | Next_sibling
25                  | Parent
26                  | Previous_sibling
27                  | Stay
28                  | Is_first_child
29                  | Is_next_sibling
30                  | Is of (Tree.NodeKind.t)
31                  | Has_first_child
32                  | Has_next_sibling
33
34 let is_move p = match p with
35 | First_child | Next_sibling
36 | Parent | Previous_sibling | Stay -> true
37 | _ -> false
38
39
40 type atom = predicate * bool * State.t
41
42 module Atom : (Formula.ATOM with type data = atom) =
43 struct
44
45   module Node =
46   struct
47     type t = atom
48     let equal n1 n2 = n1 = n2
49     let hash n = Hashtbl.hash n
50   end
51
52   include Hcons.Make(Node)
53
54   let print ppf a =
55     let p, b, q = a.node in
56     if not b then fprintf ppf "%s" Pretty.lnot;
57     match p with
58     | First_child -> fprintf ppf "FC(%a)" State.print q
59     | Next_sibling -> fprintf ppf "NS(%a)" State.print q
60     | Parent -> fprintf ppf "FC%s(%a)" Pretty.inverse State.print q
61     | Previous_sibling -> fprintf ppf "NS%s(%a)" Pretty.inverse State.print q
62     | Stay -> fprintf ppf "%s(%a)" Pretty.epsilon State.print q
63     | Is_first_child -> fprintf ppf "FC%s?" Pretty.inverse
64     | Is_next_sibling -> fprintf ppf "NS%s?" Pretty.inverse
65     | Is k -> fprintf ppf "is-%a?" Tree.NodeKind.print k
66     | Has_first_child -> fprintf ppf "FC?"
67     | Has_next_sibling -> fprintf ppf "NS?"
68
69   let neg a =
70     let p, b, q = a.node in
71     make (p, not b, q)
72
73
74 end
75
76 module SFormula =
77 struct
78   include Formula.Make(Atom)
79   open Tree.NodeKind
80   let mk_atom a b c = atom_ (Atom.make (a,b,c))
81   let mk_kind k = mk_atom (Is k) true State.dummy
82   let has_first_child =
83     (mk_atom Has_first_child true State.dummy)
84
85   let has_next_sibling =
86     (mk_atom Has_next_sibling true State.dummy)
87
88   let is_first_child =
89     (mk_atom Is_first_child true State.dummy)
90
91   let is_next_sibling =
92     (mk_atom Is_next_sibling true State.dummy)
93
94   let is_attribute =
95     (mk_atom (Is Attribute) true State.dummy)
96
97   let is_element =
98     (mk_atom (Is Element) true State.dummy)
99
100   let is_processing_instruction =
101     (mk_atom (Is ProcessingInstruction) true State.dummy)
102
103   let is_comment =
104     (mk_atom (Is Comment) true State.dummy)
105
106   let first_child q =
107   and_
108     (mk_atom First_child true q)
109     has_first_child
110
111   let next_sibling q =
112   and_
113     (mk_atom Next_sibling true q)
114     has_next_sibling
115
116   let parent q =
117   and_
118     (mk_atom Parent true q)
119     is_first_child
120
121   let previous_sibling q =
122   and_
123     (mk_atom Previous_sibling true q)
124     is_next_sibling
125
126   let stay q =
127     (mk_atom Stay true q)
128
129   let get_states phi =
130     fold (fun phi acc ->
131       match expr phi with
132       | Formula.Atom a -> let _, _, q = Atom.node a in
133                           if q != State.dummy then StateSet.add q acc else acc
134       | _ -> acc
135     ) phi StateSet.empty
136
137 end
138
139
140 module Transition = Hcons.Make (struct
141   type t = State.t * QNameSet.t * SFormula.t
142   let equal (a, b, c) (d, e, f) =
143     a == d && b == e && c == f
144   let hash (a, b, c) =
145     HASHINT4 (PRIME1, a, ((QNameSet.uid b) :> int), ((SFormula.uid c) :> int))
146 end)
147
148
149 module TransList : sig
150   include Hlist.S with type elt = Transition.t
151   val print : Format.formatter -> ?sep:string -> t -> unit
152 end =
153   struct
154     include Hlist.Make(Transition)
155     let print ppf ?(sep="\n") l =
156       iter (fun t ->
157         let q, lab, f = Transition.node t in
158         fprintf ppf "%a, %a -> %a%s" State.print q QNameSet.print lab SFormula.print f sep) l
159   end
160
161
162 type t = {
163   id : Uid.t;
164   mutable states : StateSet.t;
165   mutable selection_states: StateSet.t;
166   transitions: (State.t, (QNameSet.t*SFormula.t) list) Hashtbl.t;
167   mutable cache2 : TransList.t Cache.N2.t;
168   mutable cache6 : (TransList.t*StateSet.t) Cache.N6.t;
169 }
170
171 let next = Uid.make_maker ()
172
173 let dummy2 = TransList.cons
174   (Transition.make (State.dummy,QNameSet.empty, SFormula.false_))
175   TransList.nil
176
177 let dummy6 = (dummy2, StateSet.empty)
178
179
180 let create s ss =
181   let auto = { id = next ();
182                states = s;
183                selection_states = ss;
184                transitions = Hashtbl.create 17;
185                cache2 = Cache.N2.create dummy2;
186                cache6 = Cache.N6.create dummy6;
187              }
188   in
189   at_exit (fun () ->
190     let n6 = ref 0 in
191     let n2 = ref 0 in
192     Cache.N2.iteri (fun _ _ _ b -> if b then incr n2) auto.cache2;
193     Cache.N6.iteri (fun _ _ _ _ _ _ _ b -> if b then incr n6) auto.cache6;
194     Format.eprintf "INFO: automaton %i, cache2: %i entries, cache6: %i entries\n%!"
195       (auto.id :> int) !n2 !n6;
196     let c2l, c2u = Cache.N2.stats auto.cache2 in
197     let c6l, c6u = Cache.N6.stats auto.cache6 in
198     Format.eprintf "INFO: cache2: length: %i, used: %i, occupation: %f\n%!" c2l c2u (float c2u /. float c2l);
199     Format.eprintf "INFO: cache6: length: %i, used: %i, occupation: %f\n%!" c6l c6u (float c6u /. float c6l)
200
201   );
202   auto
203
204 let reset a =
205   a.cache2 <- Cache.N2.create dummy2;
206   a.cache6 <- Cache.N6.create dummy6
207
208
209 let get_trans_aux a tag states =
210   StateSet.fold (fun q acc0 ->
211     try
212       let trs = Hashtbl.find a.transitions q in
213       List.fold_left (fun acc1 (labs, phi) ->
214         if QNameSet.mem tag labs then TransList.cons (Transition.make (q, labs, phi)) acc1 else acc1) acc0 trs
215     with Not_found -> acc0
216   ) states TransList.nil
217
218
219 let get_trans a tag states =
220   let trs =
221     Cache.N2.find a.cache2
222       (tag.QName.id :> int) (states.StateSet.id :> int)
223   in
224   if trs == dummy2 then
225     let trs = get_trans_aux a tag states in
226     (Cache.N2.add
227        a.cache2
228        (tag.QName.id :> int)
229        (states.StateSet.id :> int) trs; trs)
230   else trs
231
232
233
234 let eval_form phi fcs nss ps ss is_left is_right has_left has_right kind =
235   let rec loop phi =
236     begin match SFormula.expr phi with
237       Formula.True | Formula.False -> phi
238     | Formula.Atom a ->
239         let p, b, q = Atom.node a in begin
240           match p with
241           | First_child ->
242               if b == StateSet.mem q fcs then SFormula.true_ else phi
243           | Next_sibling ->
244               if b == StateSet.mem q nss then SFormula.true_ else phi
245           | Parent | Previous_sibling ->
246               if b == StateSet.mem q ps then SFormula.true_ else phi
247           | Stay ->
248               if b == StateSet.mem q ss then SFormula.true_ else phi
249           | Is_first_child -> SFormula.of_bool (b == is_left)
250           | Is_next_sibling -> SFormula.of_bool (b == is_right)
251           | Is k -> SFormula.of_bool (b == (k == kind))
252           | Has_first_child -> SFormula.of_bool (b == has_left)
253           | Has_next_sibling -> SFormula.of_bool (b == has_right)
254         end
255     | Formula.And(phi1, phi2) -> SFormula.and_ (loop phi1) (loop phi2)
256     | Formula.Or (phi1, phi2) -> SFormula.or_  (loop phi1) (loop phi2)
257     end
258   in
259   loop phi
260
261 let int_of_conf is_left is_right has_left has_right kind =
262   ((Obj.magic kind) lsl 4) lor
263     ((Obj.magic is_left) lsl 3) lor
264     ((Obj.magic is_right) lsl 2) lor
265     ((Obj.magic has_left) lsl 1) lor
266     (Obj.magic has_right)
267
268 let eval_trans auto ltrs fcs nss ps ss is_left is_right has_left has_right kind =
269   let n = int_of_conf is_left is_right has_left has_right kind
270   and k = (fcs.StateSet.id :> int)
271   and l = (nss.StateSet.id :> int)
272   and m = (ps.StateSet.id :> int) in
273   let rec loop ltrs ss =
274     let i = (ltrs.TransList.id :> int)
275     and j = (ss.StateSet.id :> int) in
276     let (new_ltrs, new_ss) as res =
277       let res = Cache.N6.find auto.cache6 i j k l m n in
278       if res == dummy6 then
279         let res =
280           TransList.fold (fun trs (acct, accs) ->
281             let q, lab, phi = Transition.node trs in
282             if StateSet.mem q accs then (acct, accs) else
283               let new_phi =
284                 eval_form
285                   phi fcs nss ps accs
286                   is_left is_right has_left has_right kind
287               in
288               if SFormula.is_true new_phi then
289                 (acct, StateSet.add q accs)
290               else if SFormula.is_false new_phi then
291                 (acct, accs)
292               else
293                 let new_tr = Transition.make (q, lab, new_phi) in
294                 (TransList.cons new_tr acct, accs)
295           ) ltrs (TransList.nil, ss)
296         in
297         Cache.N6.add auto.cache6 i j k l m n res; res
298       else
299         res
300     in
301     if new_ss == ss then res else
302       loop new_ltrs new_ss
303   in
304   loop ltrs ss
305
306 type node_summary = int
307 let dummy_summary = -1
308 (*
309 4444444444443210
310 4 -> kind
311 3 -> is_left
312 2 -> is_right
313 1 -> has_left
314 0 -> has_right
315 *)
316
317 let has_right (s : node_summary) : bool =
318   Obj.magic (s land 1)
319 let has_left (s : node_summary) : bool =
320   Obj.magic ((s lsr 1) land 1)
321
322 let is_right (s : node_summary) : bool =
323   Obj.magic ((s lsr 2) land 1)
324
325 let is_left (s : node_summary) : bool =
326   Obj.magic ((s lsr 3) land 1)
327
328 let kind (s : node_summary ) : Tree.NodeKind.t =
329   Obj.magic (s lsr 4)
330
331 let node_summary is_left is_right has_left has_right kind =
332   ((Obj.magic kind) lsl 4) lor
333     ((Obj.magic is_left) lsl 3) lor
334     ((Obj.magic is_right) lsl 2) lor
335     ((Obj.magic has_left) lsl 1) lor
336     (Obj.magic has_right)
337
338
339
340 type config = {
341   sat : StateSet.t;
342   unsat : StateSet.t;
343   todo : TransList.t;
344   summary : node_summary;
345 }
346
347 module Config = Hcons.Make(struct
348   type t = config
349   let equal c d =
350     c == d ||
351       c.sat == d.sat &&
352       c.unsat == d.unsat &&
353       c.todo == d.todo &&
354       c.summary == d.summary
355
356   let hash c =
357     HASHINT4((c.sat.StateSet.id :> int),
358              (c.unsat.StateSet.id :> int),
359              (c.todo.TransList.id :> int),
360              c.summary)
361 end
362 )
363
364 let simplify_atom atom pos q { Config.node=config; _ } =
365   if (pos && StateSet.mem q config.sat)
366     || ((not pos) && StateSet.mem q config.unsat) then SFormula.true_
367   else if (pos && StateSet.mem q config.unsat)
368       || ((not pos) && StateSet.mem q config.sat) then SFormula.false_
369   else atom
370
371
372 let eval_form2 phi fcs nss ps ss summary =
373   let rec loop phi =
374     begin match SFormula.expr phi with
375       Formula.True | Formula.False -> phi
376     | Formula.Atom a ->
377         let p, b, q = Atom.node a in begin
378           match p with
379           | First_child -> simplify_atom phi b q fcs
380           | Next_sibling -> simplify_atom phi b q nss
381           | Parent | Previous_sibling -> simplify_atom phi b q ps
382           | Stay -> simplify_atom phi b q ss
383           | Is_first_child -> SFormula.of_bool (b == (is_left summary))
384           | Is_next_sibling -> SFormula.of_bool (b == (is_right summary))
385           | Is k -> SFormula.of_bool (b == (k == (kind summary)))
386           | Has_first_child -> SFormula.of_bool (b == (has_left summary))
387           | Has_next_sibling -> SFormula.of_bool (b == (has_right summary))
388         end
389     | Formula.And(phi1, phi2) -> SFormula.and_ (loop phi1) (loop phi2)
390     | Formula.Or (phi1, phi2) -> SFormula.or_  (loop phi1) (loop phi2)
391     end
392   in
393   loop phi
394
395
396
397 let eval_trans auto fcs nss ps ss =
398   let rec loop old_config =
399     let { sat = old_sat;
400           unsat = old_unsat;
401           todo = old_todo;
402           summary = old_summary } = old_config.Config.node
403     in
404     let sat, unsat, removed, kept, todo =
405       TransList.fold
406         (fun trs acc ->
407           let q, lab, phi = Transition.node trs in
408           let a_sat, a_unsat, a_rem, a_kept, a_todo = acc in
409           if StateSet.mem q a_sat || StateSet.mem q a_unsat then acc else
410             let new_phi =
411             eval_form2  phi fcs nss ps old_config old_summary
412             in
413             if SFormula.is_true new_phi then
414               StateSet.add q a_sat, a_unsat, StateSet.add q a_rem, a_kept, a_todo
415             else if SFormula.is_false new_phi then
416               a_sat, StateSet.add q a_unsat, StateSet.add q a_rem, a_kept, a_todo
417             else
418               let new_tr = Transition.make (q, lab, new_phi) in
419               (a_sat, a_unsat, a_rem, StateSet.add q a_kept, (TransList.cons new_tr a_todo))
420         ) old_todo (old_sat, old_unsat, StateSet.empty, StateSet.empty, TransList.nil)
421     in
422   (* States that have been removed from the todo list and not kept are now
423      unsatisfiable *)
424     let unsat = StateSet.union unsat (StateSet.diff removed kept) in
425     (* States that were found once to be satisfiable remain so *)
426     let unsat = StateSet.diff unsat sat in
427     let new_config = Config.make { sat; unsat; todo ; summary = old_summary } in
428     if sat == old_sat && unsat == old_unsat && todo == old_todo then new_config
429     else loop new_config
430   in
431   loop ss
432
433 (*
434   [add_trans a q labels f] adds a transition [(q,labels) -> f] to the
435   automaton [a] but ensures that transitions remains pairwise disjoint
436 *)
437
438 let add_trans a q s f =
439   let trs = try Hashtbl.find a.transitions q with Not_found -> [] in
440   let cup, ntrs =
441     List.fold_left (fun (acup, atrs) (labs, phi) ->
442       let lab1 = QNameSet.inter labs s in
443       let lab2 = QNameSet.diff labs s in
444       let tr1 =
445         if QNameSet.is_empty lab1 then []
446         else [ (lab1, SFormula.or_ phi f) ]
447       in
448       let tr2 =
449         if QNameSet.is_empty lab2 then []
450         else [ (lab2, SFormula.or_ phi f) ]
451       in
452       (QNameSet.union acup labs, tr1@ tr2 @ atrs)
453     ) (QNameSet.empty, []) trs
454   in
455   let rem = QNameSet.diff s cup in
456   let ntrs = if QNameSet.is_empty rem then ntrs
457     else (rem, f) :: ntrs
458   in
459   Hashtbl.replace a.transitions q ntrs
460
461 let _pr_buff = Buffer.create 50
462 let _str_fmt = formatter_of_buffer _pr_buff
463 let _flush_str_fmt () = pp_print_flush _str_fmt ();
464   let s = Buffer.contents _pr_buff in
465   Buffer.clear _pr_buff; s
466
467 let print fmt a =
468   fprintf fmt
469     "\nInternal UID: %i@\n\
470      States: %a@\n\
471      Selection states: %a@\n\
472      Alternating transitions:@\n"
473     (a.id :> int)
474     StateSet.print a.states
475     StateSet.print a.selection_states;
476   let trs =
477     Hashtbl.fold
478       (fun q t acc -> List.fold_left (fun acc (s , f) -> (q,s,f)::acc) acc t)
479       a.transitions
480       []
481   in
482   let sorted_trs = List.stable_sort (fun (q1, s1, _) (q2, s2, _) ->
483     let c = State.compare q1 q2 in - (if c == 0 then QNameSet.compare s1 s2 else c))
484     trs
485   in
486   let _ = _flush_str_fmt () in
487   let strs_strings, max_pre, max_all = List.fold_left (fun (accl, accp, acca) (q, s, f) ->
488     let s1 = State.print _str_fmt q; _flush_str_fmt () in
489     let s2 = QNameSet.print _str_fmt s;  _flush_str_fmt () in
490     let s3 = SFormula.print _str_fmt f;  _flush_str_fmt () in
491     let pre = Pretty.length s1 + Pretty.length s2 in
492     let all = Pretty.length s3 in
493     ( (q, s1, s2, s3) :: accl, max accp pre, max acca all)
494   ) ([], 0, 0) sorted_trs
495   in
496   let line = Pretty.line (max_all + max_pre + 6) in
497   let prev_q = ref State.dummy in
498   List.iter (fun (q, s1, s2, s3) ->
499     if !prev_q != q && !prev_q != State.dummy then fprintf fmt " %s\n%!"  line;
500     prev_q := q;
501     fprintf fmt " %s, %s" s1 s2;
502     fprintf fmt "%s" (Pretty.padding (max_pre - Pretty.length s1 - Pretty.length s2));
503     fprintf fmt " %s  %s@\n%!" Pretty.right_arrow s3;
504   ) strs_strings;
505   fprintf fmt " %s\n%!" line
506
507 (*
508   [complete transitions a] ensures that for each state q
509   and each symbols s in the alphabet, a transition q, s exists.
510   (adding q, s -> F when necessary).
511 *)
512
513 let complete_transitions a =
514   StateSet.iter (fun q ->
515     let qtrans = Hashtbl.find a.transitions q in
516     let rem =
517       List.fold_left (fun rem (labels, _) ->
518         QNameSet.diff rem labels) QNameSet.any qtrans
519     in
520     let nqtrans =
521       if QNameSet.is_empty rem then qtrans
522       else
523         (rem, SFormula.false_) :: qtrans
524     in
525     Hashtbl.replace a.transitions q nqtrans
526   ) a.states
527
528 let cleanup_states a =
529   let memo = ref StateSet.empty in
530   let rec loop q =
531     if not (StateSet.mem q !memo) then begin
532       memo := StateSet.add q !memo;
533       let trs = try Hashtbl.find a.transitions q with Not_found -> [] in
534       List.iter (fun (_, phi) ->
535         StateSet.iter loop (SFormula.get_states phi)) trs
536     end
537   in
538   StateSet.iter loop a.selection_states;
539   let unused = StateSet.diff a.states !memo in
540   eprintf "Unused states %a\n%!" StateSet.print unused;
541   StateSet.iter (fun q -> Hashtbl.remove a.transitions q) unused;
542   a.states <- !memo
543
544 (* [normalize_negations a] removes negative atoms in the formula
545    complementing the sub-automaton in the negative states.
546    [TODO check the meaning of negative upward arrows]
547 *)
548
549 let normalize_negations auto =
550   eprintf "Automaton before normalize_trans:\n";
551   print err_formatter auto;
552   eprintf "--------------------\n%!";
553
554   let memo_state = Hashtbl.create 17 in
555   let todo = Queue.create () in
556   let rec flip b f =
557     match SFormula.expr f with
558       Formula.True | Formula.False -> if b then f else SFormula.not_ f
559     | Formula.Or(f1, f2) -> (if b then SFormula.or_ else SFormula.and_)(flip b f1) (flip b f2)
560     | Formula.And(f1, f2) -> (if b then SFormula.and_ else SFormula.or_)(flip b f1) (flip b f2)
561     | Formula.Atom(a) -> begin
562       let l, b', q = Atom.node a in
563       if q == State.dummy then if b then f else SFormula.not_ f
564       else
565         if b == b' then begin
566         (* a appears positively, either no negation or double negation *)
567           if not (Hashtbl.mem memo_state (q,b)) then Queue.add (q,true) todo;
568           SFormula.atom_ (Atom.make (l, true, q))
569         end else begin
570         (* need to reverse the atom
571            either we have a positive state deep below a negation
572            or we have a negative state in a positive formula
573            b' = sign of the state
574            b = sign of the enclosing formula
575         *)
576         let not_q =
577           try
578             (* does the inverted state of q exist ? *)
579             Hashtbl.find memo_state (q, false)
580           with
581             Not_found ->
582               (* create a new state and add it to the todo queue *)
583               let nq = State.make () in
584               auto.states <- StateSet.add nq auto.states;
585               Hashtbl.add memo_state (q, false) nq;
586               Queue.add (q, false) todo; nq
587         in
588         SFormula.atom_ (Atom.make (l, true, not_q))
589       end
590     end
591   in
592   (* states that are not reachable from a selection stat are not interesting *)
593   StateSet.iter (fun q -> Queue.add (q, true) todo) auto.selection_states;
594
595   while not (Queue.is_empty todo) do
596     let (q, b) as key = Queue.pop todo in
597     let q' =
598       try
599         Hashtbl.find memo_state key
600       with
601         Not_found ->
602           let nq = if b then q else
603               let nq = State.make () in
604               auto.states <- StateSet.add nq auto.states;
605               nq
606           in
607           Hashtbl.add memo_state key nq; nq
608     in
609     let trans = Hashtbl.find auto.transitions q in
610     let trans' = List.map (fun (lab, f) -> lab, flip b f) trans in
611     Hashtbl.replace auto.transitions q' trans';
612   done;
613   cleanup_states auto
614
615