Revert "Remove the need for a NOP operation in automata bytecode."
[SXSI/xpathcomp.git] / src / l2JIT.ml
1 INCLUDE "debug.ml"
2 INCLUDE "utils.ml"
3 INCLUDE "trace.ml"
4
5 open Format
6 open Ata
7
8 type jump =
9   | NOP of unit
10   | FIRST_CHILD of StateSet.t
11   | NEXT_SIBLING of StateSet.t
12   | FIRST_ELEMENT of StateSet.t
13   | NEXT_ELEMENT of StateSet.t
14   | TAGGED_DESCENDANT of StateSet.t * Tag.t
15   | TAGGED_FOLLOWING of StateSet.t * Tag.t
16   | SELECT_DESCENDANT of StateSet.t * Ptset.Int.t * Tree.unordered_set
17   | SELECT_FOLLOWING of StateSet.t * Ptset.Int.t * Tree.unordered_set
18   | TAGGED_CHILD of StateSet.t * Tag.t
19   | TAGGED_FOLLOWING_SIBLING of StateSet.t * Tag.t
20   | SELECT_CHILD of StateSet.t * Ptset.Int.t * Tree.unordered_set
21   | SELECT_FOLLOWING_SIBLING of StateSet.t * Ptset.Int.t * Tree.unordered_set
22   | TAGGED_SUBTREE of StateSet.t * Tag.t
23   | ELEMENT_SUBTREE of StateSet.t
24
25 type dir = DIR_LEFT | DIR_RIGHT
26
27 let _nop = NOP ()
28 let _first_child s = FIRST_CHILD s
29 let _next_sibling s = NEXT_SIBLING s
30 let _first_element s = FIRST_ELEMENT s
31 let _next_element s = NEXT_ELEMENT s
32 let _tagged_descendant s t = TAGGED_DESCENDANT(s,t)
33 let _tagged_following s t = TAGGED_FOLLOWING(s,t)
34 let _select_descendant s t = SELECT_DESCENDANT(s,t, Tree.unordered_set_of_set t)
35 let _select_following s t = SELECT_FOLLOWING(s,t, Tree.unordered_set_of_set t)
36 let _tagged_child s t = TAGGED_CHILD(s,t)
37 let _tagged_following_sibling s t = TAGGED_FOLLOWING_SIBLING(s,t)
38 let _select_child s t = SELECT_CHILD(s,t, Tree.unordered_set_of_set t)
39 let _select_following_sibling s t = SELECT_FOLLOWING_SIBLING(s,t, Tree.unordered_set_of_set t)
40 let _tagged_subtree s t = TAGGED_SUBTREE (s, t)
41 let _element_subtree s = ELEMENT_SUBTREE s
42
43
44 let jump_stat_table = Hashtbl.create 17
45 let jump_stat_init () = Hashtbl.clear jump_stat_table
46 let jump_stat j =
47   let i = try Hashtbl.find jump_stat_table j with Not_found -> 0 in
48     Hashtbl.replace jump_stat_table j (i+1)
49
50 let print_jump fmt j =
51   match j with
52     | NOP _ -> fprintf fmt "nop"
53     | FIRST_CHILD _ -> fprintf fmt "first_child"
54     | NEXT_SIBLING _ -> fprintf fmt "next_sibling"
55     | FIRST_ELEMENT _ -> fprintf fmt "first_element"
56     | NEXT_ELEMENT _ -> fprintf fmt "next_element"
57
58     | TAGGED_DESCENDANT (_, tag) -> fprintf fmt "tagged_descendant(%s)" (Tag.to_string tag)
59
60     | TAGGED_FOLLOWING (_, tag) -> fprintf fmt "tagged_following(%s)" (Tag.to_string tag)
61
62     | SELECT_DESCENDANT (_, tags, _) -> fprintf fmt "select_descendant(%a)"
63         TagSet.print (TagSet.inj_positive tags)
64
65     | SELECT_FOLLOWING (_, tags, _) -> fprintf fmt "select_following(%a)"
66         TagSet.print (TagSet.inj_positive tags)
67
68     | TAGGED_CHILD (_, tag) -> fprintf fmt "tagged_child(%s)" (Tag.to_string tag)
69
70     | TAGGED_FOLLOWING_SIBLING (_, tag) ->
71         fprintf fmt "tagged_following_sibling(%s)" (Tag.to_string tag)
72
73     | SELECT_CHILD (_, tags, _) -> fprintf fmt "select_child(%a)"
74         TagSet.print (TagSet.inj_positive tags)
75
76     | SELECT_FOLLOWING_SIBLING (_, tags, _) -> fprintf fmt "select_following_sibling(%a)"
77         TagSet.print (TagSet.inj_positive tags)
78
79     | TAGGED_SUBTREE (_, tag) -> fprintf fmt "tagged_subtree(%s)" (Tag.to_string tag)
80     | ELEMENT_SUBTREE (_) -> fprintf fmt "element_subtree"
81
82 let jump_stat_summary fmt =
83   fprintf fmt "Jump function summary:\n%!";
84   Hashtbl.iter (fun k v -> fprintf fmt "%i calls to %a\n" v print_jump k) jump_stat_table;
85   fprintf fmt "%!"
86
87
88 type opcode =
89   | CACHE
90   | RETURN
91   | LEFT of Translist.t * jump
92   | RIGHT of Translist.t * jump
93   | BOTH of Translist.t * jump * jump
94
95 type t = opcode Cache.Lvl2.t
96
97 let dummy = CACHE
98 let print_opcode fmt o = match o with
99   | CACHE  -> fprintf fmt "CACHE"
100   | RETURN  -> fprintf fmt "RETURN"
101   | LEFT (tl, j) -> fprintf fmt "LEFT(\n[%a], %a)" Translist.print tl print_jump j
102   | RIGHT (tl, j) -> fprintf fmt "RIGHT(\n[%a], %a)" Translist.print tl print_jump j
103   | BOTH (tl, j1, j2) -> fprintf fmt "BOTH(\n[%a], %a, %a)" Translist.print tl print_jump j1 print_jump j2
104 (*
105 let print_cache fmt d =
106   let c = Cache.Lvl2.to_array d in
107   Array.iteri begin fun tag a ->
108     let tagstr = Tag.to_string tag in
109     if a != Cache.Lvl2.dummy_line d && tagstr <> "<INVALID TAG>"
110     then begin
111       fprintf fmt "Entry %s: \n" tagstr;
112       Array.iter (fun o -> if o != dummy then begin
113         print_opcode fmt o;
114         fprintf fmt "\n%!" end) a;
115       fprintf fmt "---------------------------\n%!"
116     end
117   end c
118 *)
119 let create () = Cache.Lvl2.create 4096 dummy
120 (*
121 let stats fmt c =
122   let d = Cache.Lvl2.to_array c in
123   let len = Array.fold_left (fun acc a -> Array.length a + acc) 0 d in
124   let lvl1 = Array.fold_left (fun acc a -> if Array.length a == 0 then acc else acc+1) 0 d in
125   let lvl2 = Array.fold_left (fun acc a ->
126                                 Array.fold_left (fun acc2 a2 -> if a2 == dummy then acc2 else acc2+1)
127                                   acc a) 0 d
128   in
129   fprintf fmt "L2JIT Statistics:
130 \t%i entries
131 \t%i used L1 lines
132 \t%i used L2 lines
133 \ttable size: %ikb\n"
134       len lvl1 lvl2 (Ocaml.size_kb d);
135   fprintf fmt "%s" "L2JIT Content:\n";
136   print_cache fmt c
137 *)
138
139 let find t tag set = Cache.Lvl2.find t (Uid.to_int set.StateSet.Node.id) tag
140
141 let add t tag set v = Cache.Lvl2.add t (Uid.to_int set.StateSet.Node.id) tag v
142
143 let collect_trans tag ((a_t, a_s1, a_s2) as acc) (labels, tr) =
144   if TagSet.mem tag labels
145   then
146     let _, _, _, f = Transition.node tr in
147     let  s1,  s2 = Formula.st f in
148       (Translist.cons tr a_t,
149        StateSet.union s1 a_s1,
150        StateSet.union s2 a_s2)
151   else acc
152
153 let has_text l = Ptset.Int.mem Tag.pcdata l
154
155 let rec translate_jump tree tag (jkind:Ata.jump_kind) dir s =
156   let child, desc, sib, fol = Tree.tags tree tag in
157      match jkind, dir with
158       | NIL, _ -> _nop
159       | NODE, DIR_LEFT -> FIRST_CHILD s
160       | STAR, DIR_LEFT -> FIRST_ELEMENT s
161       | NODE, DIR_RIGHT -> NEXT_SIBLING s
162       | STAR, DIR_RIGHT -> NEXT_ELEMENT s
163       | JUMP_ONE t, _ ->
164           let l_one, l_many, tagged_one, select_one, any, any_notext =
165             if dir = DIR_LEFT then
166               child, desc, _tagged_child, _select_child,_first_child, _first_element
167             else
168               sib, fol, _tagged_following_sibling, _select_following_sibling,
169             _next_sibling, _next_element
170           in
171           let labels = Ptset.Int.inter l_one t in
172           let c = Ptset.Int.cardinal labels in
173             if c == 0 then _nop
174             else if Ptset.Int.for_all (fun lab -> not (Ptset.Int.mem lab l_many)) labels then
175               translate_jump tree tag (JUMP_MANY(labels)) dir s
176             else if c == 1 then tagged_one s (Ptset.Int.choose labels)
177             else if c > 5 then if has_text labels then any s else any_notext s
178             else select_one s labels
179
180       | JUMP_MANY t, _ ->
181           let l_many, tagged_many, select_many, any, any_notext =
182             if dir == DIR_LEFT then
183               desc, _tagged_descendant, _select_descendant,_first_child, _first_element
184             else
185               fol, _tagged_following, _select_following, _next_sibling, _next_element
186           in
187           let labels = Ptset.Int.inter l_many t in
188           let c = Ptset.Int.cardinal labels in
189             if c == 0 then _nop
190             else if c == 1 then tagged_many s (Ptset.Int.choose labels)
191             else if c > 5 then if has_text labels then any s else any_notext s
192             else select_many s labels
193
194       | CAPTURE_MANY (t), DIR_LEFT ->
195           if Ptset.Int.is_singleton t then TAGGED_SUBTREE(s, Ptset.Int.choose t)
196           else if t == Tree.element_tags tree then ELEMENT_SUBTREE s
197           else assert false
198       | _ -> assert false
199
200 let compute_jump auto tree tag states dir =
201   if !Options.no_jump then
202     if dir == DIR_LEFT then FIRST_CHILD states
203     else NEXT_SIBLING states
204   else
205     let jkind = Ata.top_down_approx auto states tree in
206     let jump = translate_jump tree tag jkind dir states in
207       TRACE("level2-jit", 2,
208             __ "Computed jumps for %s %a %s: %a\n%!"
209               (Tag.to_string tag)
210               StateSet.print states
211               (if dir == DIR_LEFT then "left" else "right")
212               print_jump jump
213       );
214     jump
215
216 let compile cache2 auto tree tag states =
217   let tr_list, states1, states2 =
218     StateSet.fold
219       (fun q acc ->
220          List.fold_left (collect_trans tag)
221            acc
222            (Hashtbl.find auto.trans q))
223       states
224       (Translist.nil, StateSet.empty, StateSet.empty)
225   in
226   let op =
227     let empty_s1 = StateSet.is_empty states1 in
228     let empty_s2 = StateSet.is_empty states2 in
229       if empty_s1 && empty_s2 then RETURN
230       else if empty_s1 then
231         RIGHT (tr_list,
232                compute_jump auto tree tag states2 DIR_RIGHT)
233       else if empty_s2 then
234         LEFT (tr_list,
235               compute_jump auto tree tag states1 DIR_LEFT)
236       else
237         let j1 = compute_jump auto tree tag states1 DIR_LEFT in
238         let j2 = compute_jump auto tree tag states2 DIR_RIGHT in
239         BOTH (tr_list, j1, j2);
240   in
241   let op = match op with
242       (*BOTH(_, NOP _, NOP _) |  LEFT(_, NOP _) | RIGHT(_, NOP _) -> RETURN() *)
243     | BOTH(tr, ((NOP _) as l) , NOP _) -> LEFT (tr, l)
244     | BOTH(tr, l, NOP _) -> LEFT (tr, l)
245     | BOTH(tr, NOP _, r) -> RIGHT (tr, r)
246     | _ -> op
247   in
248     add cache2 tag states op;
249     op
250
251 let get_transitions = function
252   | CACHE  | RETURN  -> failwith "get_transitions"
253   | LEFT (tr, _)
254   | RIGHT (tr, _)
255   | BOTH (tr, _, _) -> tr
256