01fa63961763022f2bba37c4807abc3813dbb40b
[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-24 23:14:46 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
163 type node_summary = int
164 let dummy_summary = -1
165 (*
166 4444444444443210
167 4 -> kind
168 3 -> is_left
169 2 -> is_right
170 1 -> has_left
171 0 -> has_right
172 *)
173
174 let has_right (s : node_summary) : bool =
175   Obj.magic (s land 1)
176 let has_left (s : node_summary) : bool =
177   Obj.magic ((s lsr 1) land 1)
178
179 let is_right (s : node_summary) : bool =
180   Obj.magic ((s lsr 2) land 1)
181
182 let is_left (s : node_summary) : bool =
183   Obj.magic ((s lsr 3) land 1)
184
185 let kind (s : node_summary ) : Tree.NodeKind.t =
186   Obj.magic (s lsr 4)
187
188 let node_summary is_left is_right has_left has_right kind =
189   ((Obj.magic kind) lsl 4) lor
190     ((Obj.magic is_left) lsl 3) lor
191     ((Obj.magic is_right) lsl 2) lor
192     ((Obj.magic has_left) lsl 1) lor
193     (Obj.magic has_right)
194
195
196
197 type config = {
198   sat : StateSet.t;
199   unsat : StateSet.t;
200   todo : TransList.t;
201   summary : node_summary;
202   (** optimization infos,
203       not taken into account during hashconsing *)
204   mutable round : int;
205 }
206
207 module Config = Hcons.Make(struct
208   type t = config
209   let equal c d =
210     c == d ||
211       c.sat == d.sat &&
212       c.unsat == d.unsat &&
213       c.todo == d.todo &&
214       c.summary == d.summary
215
216   let hash c =
217     HASHINT4((c.sat.StateSet.id :> int),
218              (c.unsat.StateSet.id :> int),
219              (c.todo.TransList.id :> int),
220              c.summary)
221 end
222 )
223
224 type t = {
225   id : Uid.t;
226   mutable states : StateSet.t;
227   mutable selection_states: StateSet.t;
228   transitions: (State.t, (QNameSet.t*SFormula.t) list) Hashtbl.t;
229   mutable cache2 : TransList.t Cache.N2.t;
230   mutable cache4 : Config.t Cache.N4.t;
231 }
232
233 let next = Uid.make_maker ()
234
235 let dummy2 = TransList.cons
236   (Transition.make (State.dummy,QNameSet.empty, SFormula.false_))
237   TransList.nil
238
239
240
241 let dummy_config = Config.make { sat = StateSet.empty;
242                                  unsat = StateSet.empty;
243                                  todo = TransList.nil;
244                                  summary = dummy_summary;
245                                  round = 0;
246                                }
247
248
249 let create s ss =
250   let auto = { id = next ();
251                states = s;
252                selection_states = ss;
253                transitions = Hashtbl.create 17;
254                cache2 = Cache.N2.create dummy2;
255                cache4 = Cache.N4.create dummy_config;
256              }
257   in
258   at_exit (fun () ->
259     let n4 = ref 0 in
260     let n2 = ref 0 in
261     Cache.N2.iteri (fun _ _ _ b -> if b then incr n2) auto.cache2;
262     Cache.N4.iteri (fun _ _ _ _ _ b -> if b then incr n4) auto.cache4;
263     Format.eprintf "STATS: automaton %i, cache2: %i entries, cache6: %i entries\n%!"
264       (auto.id :> int) !n2 !n4;
265     let c2l, c2u = Cache.N2.stats auto.cache2 in
266     let c4l, c4u = Cache.N4.stats auto.cache4 in
267     Format.eprintf "STATS: cache2: length: %i, used: %i, occupation: %f\n%!" c2l c2u (float c2u /. float c2l);
268     Format.eprintf "STATS: cache4: length: %i, used: %i, occupation: %f\n%!" c4l c4u (float c4u /. float c4l)
269
270   );
271   auto
272
273 let reset a =
274   a.cache2 <- Cache.N2.create (Cache.N2.dummy a.cache2);
275   a.cache4 <- Cache.N4.create (Cache.N4.dummy a.cache4)
276
277
278 let get_trans_aux a tag states =
279   StateSet.fold (fun q acc0 ->
280     try
281       let trs = Hashtbl.find a.transitions q in
282       List.fold_left (fun acc1 (labs, phi) ->
283         if QNameSet.mem tag labs then TransList.cons (Transition.make (q, labs, phi)) acc1 else acc1) acc0 trs
284     with Not_found -> acc0
285   ) states TransList.nil
286
287
288 let get_trans a tag states =
289   let trs =
290     Cache.N2.find a.cache2
291       (tag.QName.id :> int) (states.StateSet.id :> int)
292   in
293   if trs == dummy2 then
294     let trs = get_trans_aux a tag states in
295     (Cache.N2.add
296        a.cache2
297        (tag.QName.id :> int)
298        (states.StateSet.id :> int) trs; trs)
299   else trs
300
301
302 (*
303 let eval_form phi fcs nss ps ss is_left is_right has_left has_right kind =
304   let rec loop phi =
305     begin match SFormula.expr phi with
306       Formula.True | Formula.False -> phi
307     | Formula.Atom a ->
308         let p, b, q = Atom.node a in begin
309           match p with
310           | First_child ->
311               if b == StateSet.mem q fcs then SFormula.true_ else phi
312           | Next_sibling ->
313               if b == StateSet.mem q nss then SFormula.true_ else phi
314           | Parent | Previous_sibling ->
315               if b == StateSet.mem q ps then SFormula.true_ else phi
316           | Stay ->
317               if b == StateSet.mem q ss then SFormula.true_ else phi
318           | Is_first_child -> SFormula.of_bool (b == is_left)
319           | Is_next_sibling -> SFormula.of_bool (b == is_right)
320           | Is k -> SFormula.of_bool (b == (k == kind))
321           | Has_first_child -> SFormula.of_bool (b == has_left)
322           | Has_next_sibling -> SFormula.of_bool (b == has_right)
323         end
324     | Formula.And(phi1, phi2) -> SFormula.and_ (loop phi1) (loop phi2)
325     | Formula.Or (phi1, phi2) -> SFormula.or_  (loop phi1) (loop phi2)
326     end
327   in
328   loop phi
329
330 let int_of_conf is_left is_right has_left has_right kind =
331   ((Obj.magic kind) lsl 4) lor
332     ((Obj.magic is_left) lsl 3) lor
333     ((Obj.magic is_right) lsl 2) lor
334     ((Obj.magic has_left) lsl 1) lor
335     (Obj.magic has_right)
336
337 let eval_trans auto ltrs fcs nss ps ss is_left is_right has_left has_right kind =
338   let n = int_of_conf is_left is_right has_left has_right kind
339   and k = (fcs.StateSet.id :> int)
340   and l = (nss.StateSet.id :> int)
341   and m = (ps.StateSet.id :> int) in
342   let rec loop ltrs ss =
343     let i = (ltrs.TransList.id :> int)
344     and j = (ss.StateSet.id :> int) in
345     let (new_ltrs, new_ss) as res =
346       let res = Cache.N6.find auto.cache6 i j k l m n in
347       if res == dummy6 then
348         let res =
349           TransList.fold (fun trs (acct, accs) ->
350             let q, lab, phi = Transition.node trs in
351             if StateSet.mem q accs then (acct, accs) else
352               let new_phi =
353                 eval_form
354                   phi fcs nss ps accs
355                   is_left is_right has_left has_right kind
356               in
357               if SFormula.is_true new_phi then
358                 (acct, StateSet.add q accs)
359               else if SFormula.is_false new_phi then
360                 (acct, accs)
361               else
362                  let new_tr = Transition.make (q, lab, new_phi) in
363                 (TransList.cons new_tr acct, accs)
364           ) ltrs (TransList.nil, ss)
365         in
366         Cache.N6.add auto.cache6 i j k l m n res; res
367       else
368         res
369     in
370     if new_ss == ss then res else
371       loop new_ltrs new_ss
372   in
373   loop ltrs ss
374
375 *)
376
377 let simplify_atom atom pos q { Config.node=config; _ } =
378   if (pos && StateSet.mem q config.sat)
379     || ((not pos) && StateSet.mem q config.unsat) then SFormula.true_
380   else if (pos && StateSet.mem q config.unsat)
381       || ((not pos) && StateSet.mem q config.sat) then SFormula.false_
382   else atom
383
384 let eval_form phi fcs nss ps ss summary =
385   let rec loop phi =
386     begin match SFormula.expr phi with
387       Formula.True | Formula.False -> phi
388     | Formula.Atom a ->
389         let p, b, q = Atom.node a in begin
390           match p with
391           | First_child -> simplify_atom phi b q fcs
392           | Next_sibling -> simplify_atom phi b q nss
393           | Parent | Previous_sibling -> simplify_atom phi b q ps
394           | Stay -> simplify_atom phi b q ss
395           | Is_first_child -> SFormula.of_bool (b == (is_left summary))
396           | Is_next_sibling -> SFormula.of_bool (b == (is_right summary))
397           | Is k -> SFormula.of_bool (b == (k == (kind summary)))
398           | Has_first_child -> SFormula.of_bool (b == (has_left summary))
399           | Has_next_sibling -> SFormula.of_bool (b == (has_right summary))
400         end
401     | Formula.And(phi1, phi2) -> SFormula.and_ (loop phi1) (loop phi2)
402     | Formula.Or (phi1, phi2) -> SFormula.or_  (loop phi1) (loop phi2)
403     end
404   in
405   loop phi
406
407
408
409 let eval_trans auto fcs nss ps ss =
410   let fcsid = (fcs.Config.id :> int) in
411   let nssid = (nss.Config.id :> int) in
412   let psid = (ps.Config.id :> int) in
413   let rec loop old_config =
414     let oid = (old_config.Config.id :> int) in
415     let res =
416       let res = Cache.N4.find auto.cache4 oid fcsid nssid psid in
417       if res != dummy_config then res
418       else
419         let { sat = old_sat;
420               unsat = old_unsat;
421               todo = old_todo;
422               summary = old_summary } = old_config.Config.node
423         in
424         let sat, unsat, removed, kept, todo =
425           TransList.fold
426             (fun trs acc ->
427               let q, lab, phi = Transition.node trs in
428               let a_sat, a_unsat, a_rem, a_kept, a_todo = acc in
429               if StateSet.mem q a_sat || StateSet.mem q a_unsat then acc else
430                 let new_phi =
431                   eval_form phi fcs nss ps old_config old_summary
432                 in
433                 if SFormula.is_true new_phi then
434                   StateSet.add q a_sat, a_unsat, StateSet.add q a_rem, a_kept, a_todo
435                 else if SFormula.is_false new_phi then
436                   a_sat, StateSet.add q a_unsat, StateSet.add q a_rem, a_kept, a_todo
437                 else
438                   let new_tr = Transition.make (q, lab, new_phi) in
439                   (a_sat, a_unsat, a_rem, StateSet.add q a_kept, (TransList.cons new_tr a_todo))
440             ) old_todo (old_sat, old_unsat, StateSet.empty, StateSet.empty, TransList.nil)
441         in
442         (* States that have been removed from the todo list and not kept are now
443            unsatisfiable *)
444         let unsat = StateSet.union unsat (StateSet.diff removed kept) in
445         (* States that were found once to be satisfiable remain so *)
446         let unsat = StateSet.diff unsat sat in
447         let new_config = Config.make { old_config.Config.node with sat; unsat; todo; } in
448         Cache.N4.add auto.cache4 oid fcsid nssid psid new_config;
449         new_config
450     in
451     if res == old_config then res else loop res
452   in
453   loop ss
454
455 (*
456   [add_trans a q labels f] adds a transition [(q,labels) -> f] to the
457   automaton [a] but ensures that transitions remains pairwise disjoint
458 *)
459
460 let add_trans a q s f =
461   let trs = try Hashtbl.find a.transitions q with Not_found -> [] in
462   let cup, ntrs =
463     List.fold_left (fun (acup, atrs) (labs, phi) ->
464       let lab1 = QNameSet.inter labs s in
465       let lab2 = QNameSet.diff labs s in
466       let tr1 =
467         if QNameSet.is_empty lab1 then []
468         else [ (lab1, SFormula.or_ phi f) ]
469       in
470       let tr2 =
471         if QNameSet.is_empty lab2 then []
472         else [ (lab2, SFormula.or_ phi f) ]
473       in
474       (QNameSet.union acup labs, tr1@ tr2 @ atrs)
475     ) (QNameSet.empty, []) trs
476   in
477   let rem = QNameSet.diff s cup in
478   let ntrs = if QNameSet.is_empty rem then ntrs
479     else (rem, f) :: ntrs
480   in
481   Hashtbl.replace a.transitions q ntrs
482
483 let _pr_buff = Buffer.create 50
484 let _str_fmt = formatter_of_buffer _pr_buff
485 let _flush_str_fmt () = pp_print_flush _str_fmt ();
486   let s = Buffer.contents _pr_buff in
487   Buffer.clear _pr_buff; s
488
489 let print fmt a =
490   fprintf fmt
491     "Internal UID: %i@\n\
492      States: %a@\n\
493      Selection states: %a@\n\
494      Alternating transitions:@\n"
495     (a.id :> int)
496     StateSet.print a.states
497     StateSet.print a.selection_states;
498   let trs =
499     Hashtbl.fold
500       (fun q t acc -> List.fold_left (fun acc (s , f) -> (q,s,f)::acc) acc t)
501       a.transitions
502       []
503   in
504   let sorted_trs = List.stable_sort (fun (q1, s1, _) (q2, s2, _) ->
505     let c = State.compare q1 q2 in - (if c == 0 then QNameSet.compare s1 s2 else c))
506     trs
507   in
508   let _ = _flush_str_fmt () in
509   let strs_strings, max_pre, max_all = List.fold_left (fun (accl, accp, acca) (q, s, f) ->
510     let s1 = State.print _str_fmt q; _flush_str_fmt () in
511     let s2 = QNameSet.print _str_fmt s;  _flush_str_fmt () in
512     let s3 = SFormula.print _str_fmt f;  _flush_str_fmt () in
513     let pre = Pretty.length s1 + Pretty.length s2 in
514     let all = Pretty.length s3 in
515     ( (q, s1, s2, s3) :: accl, max accp pre, max acca all)
516   ) ([], 0, 0) sorted_trs
517   in
518   let line = Pretty.line (max_all + max_pre + 6) in
519   let prev_q = ref State.dummy in
520   fprintf fmt "%s@\n" line;
521   List.iter (fun (q, s1, s2, s3) ->
522     if !prev_q != q && !prev_q != State.dummy then fprintf fmt "%s@\n"  line;
523     prev_q := q;
524     fprintf fmt "%s, %s" s1 s2;
525     fprintf fmt "%s" (Pretty.padding (max_pre - Pretty.length s1 - Pretty.length s2));
526     fprintf fmt " %s  %s@\n" Pretty.right_arrow s3;
527   ) strs_strings;
528   fprintf fmt "%s@\n" line
529
530 (*
531   [complete transitions a] ensures that for each state q
532   and each symbols s in the alphabet, a transition q, s exists.
533   (adding q, s -> F when necessary).
534 *)
535
536 let complete_transitions a =
537   StateSet.iter (fun q ->
538     let qtrans = Hashtbl.find a.transitions q in
539     let rem =
540       List.fold_left (fun rem (labels, _) ->
541         QNameSet.diff rem labels) QNameSet.any qtrans
542     in
543     let nqtrans =
544       if QNameSet.is_empty rem then qtrans
545       else
546         (rem, SFormula.false_) :: qtrans
547     in
548     Hashtbl.replace a.transitions q nqtrans
549   ) a.states
550
551 let cleanup_states a =
552   let memo = ref StateSet.empty in
553   let rec loop q =
554     if not (StateSet.mem q !memo) then begin
555       memo := StateSet.add q !memo;
556       let trs = try Hashtbl.find a.transitions q with Not_found -> [] in
557       List.iter (fun (_, phi) ->
558         StateSet.iter loop (SFormula.get_states phi)) trs
559     end
560   in
561   StateSet.iter loop a.selection_states;
562   let unused = StateSet.diff a.states !memo in
563   StateSet.iter (fun q -> Hashtbl.remove a.transitions q) unused;
564   a.states <- !memo
565
566 (* [normalize_negations a] removes negative atoms in the formula
567    complementing the sub-automaton in the negative states.
568    [TODO check the meaning of negative upward arrows]
569 *)
570
571 let normalize_negations auto =
572   let memo_state = Hashtbl.create 17 in
573   let todo = Queue.create () in
574   let rec flip b f =
575     match SFormula.expr f with
576       Formula.True | Formula.False -> if b then f else SFormula.not_ f
577     | Formula.Or(f1, f2) -> (if b then SFormula.or_ else SFormula.and_)(flip b f1) (flip b f2)
578     | Formula.And(f1, f2) -> (if b then SFormula.and_ else SFormula.or_)(flip b f1) (flip b f2)
579     | Formula.Atom(a) -> begin
580       let l, b', q = Atom.node a in
581       if q == State.dummy then if b then f else SFormula.not_ f
582       else
583         if b == b' then begin
584         (* a appears positively, either no negation or double negation *)
585           if not (Hashtbl.mem memo_state (q,b)) then Queue.add (q,true) todo;
586           SFormula.atom_ (Atom.make (l, true, q))
587         end else begin
588         (* need to reverse the atom
589            either we have a positive state deep below a negation
590            or we have a negative state in a positive formula
591            b' = sign of the state
592            b = sign of the enclosing formula
593         *)
594         let not_q =
595           try
596             (* does the inverted state of q exist ? *)
597             Hashtbl.find memo_state (q, false)
598           with
599             Not_found ->
600               (* create a new state and add it to the todo queue *)
601               let nq = State.make () in
602               auto.states <- StateSet.add nq auto.states;
603               Hashtbl.add memo_state (q, false) nq;
604               Queue.add (q, false) todo; nq
605         in
606         SFormula.atom_ (Atom.make (l, true, not_q))
607       end
608     end
609   in
610   (* states that are not reachable from a selection stat are not interesting *)
611   StateSet.iter (fun q -> Queue.add (q, true) todo) auto.selection_states;
612
613   while not (Queue.is_empty todo) do
614     let (q, b) as key = Queue.pop todo in
615     let q' =
616       try
617         Hashtbl.find memo_state key
618       with
619         Not_found ->
620           let nq = if b then q else
621               let nq = State.make () in
622               auto.states <- StateSet.add nq auto.states;
623               nq
624           in
625           Hashtbl.add memo_state key nq; nq
626     in
627     let trans = Hashtbl.find auto.transitions q in
628     let trans' = List.map (fun (lab, f) -> lab, flip b f) trans in
629     Hashtbl.replace auto.transitions q' trans';
630   done;
631   cleanup_states auto
632
633