1 (******************************************************************************)
2 (* SXSI : XPath evaluator *)
3 (* Kim Nguyen (Kim.Nguyen@nicta.com.au) *)
4 (* Copyright NICTA 2008 *)
5 (* Distributed under the terms of the LGPL (see LICENCE) *)
6 (******************************************************************************)
10 external init_lib : unit -> unit = "sxsi_cpp_init"
12 exception CPlusPlusError of string
14 let () = Callback.register_exception "CPlusPlusError" (CPlusPlusError "")
18 type node = [ `Tree ] Node.t
22 external register_tag : tree -> string -> Tag.t = "caml_xml_tree_register_tag"
24 external tag_name : tree -> Tag.t -> string = "caml_xml_tree_get_tag_name"
26 let tag t = (); fun s ->
29 | "<@>" -> Tag.attribute
30 | "" -> Tag.document_node
31 | "<@$>" -> Tag.attribute_data
32 | _ -> register_tag t s
36 if t == Tag.pcdata then "<$>"
37 else if t == Tag.attribute_data then "<@$>"
38 else if t == Tag.attribute then "<@>"
39 else if t == Tag.nullt then "<!NIL!>"
46 Tag.to_string = to_string t;
47 Tag.translate = translate
53 external create : unit -> t = "caml_xml_tree_builder_create"
54 external open_document : t -> int -> bool -> int -> unit = "caml_xml_tree_builder_open_document"
55 external close_document : t -> tree = "caml_xml_tree_builder_close_document"
56 external open_tag : t -> string -> unit = "caml_xml_tree_builder_open_tag"
57 external close_tag : t -> string -> unit = "caml_xml_tree_builder_close_tag"
58 external text : t -> string -> unit = "caml_xml_tree_builder_text"
64 (c == '\n' || c == '\t' || c == ' ') && loop len (i+1)
68 loop (String.length s) 0
72 let event_counter = ref 0 in
75 if !event_counter land 0xffffff == 0 then
76 Logger.print Format.err_formatter "Current position: %i@\n@?" (Expat.get_current_byte_index parser_))
80 if Buffer.length t > 0 then begin
81 let s = Buffer.contents t in
90 let output_attr b name value =
91 let atname = "<@>" ^ name in
98 let start_element_handler parser_ b t tag attr_list =
105 List.iter (fun (name, value) -> output_attr b name value) l;
109 let end_element_handler parser_ b t tag =
113 let character_data_handler parser_ _ t text =
114 Buffer.add_string t text
116 let create_parser () =
117 let buf = Buffer.create 512 in
118 let build = create () in
119 let parser_ = Expat.parser_create ~encoding:None in
123 Logger.print Format.err_formatter "Finished parsing@\n";
124 Logger.print Format.err_formatter "Starting index construction@\n";
125 let r = close_document build in
126 Logger.print Format.err_formatter "Finished index construction@\n";
129 Expat.set_start_element_handler parser_ (start_element_handler parser_ build buf);
130 Expat.set_end_element_handler parser_ (end_element_handler parser_ build buf);
131 Expat.set_character_data_handler parser_ (character_data_handler parser_ build buf);
132 Logger.print Format.err_formatter "Started parsing@\n";
133 open_document build !Options.sample_factor !Options.disable_text_collection !Options.text_index_type;
138 let parser_, finalizer = create_parser () in
139 Expat.parse parser_ s;
142 let parse_file file =
143 let in_chan = open_in file in
144 let buffer = String.create 4096 in
145 let parser_, finalizer = create_parser () in
149 let read = input in_chan buffer 0 4096 in
150 if read == 0 then raise End_of_file else
151 Expat.parse_sub parser_ buffer 0 read;
155 | End_of_file -> close_in in_chan
165 type bit_vector = string
167 external bool_of_int : int -> bool = "%identity"
168 external int_of_bool : bool -> int = "%identity"
170 let bit_vector_unsafe_get v i =
172 (((Char.code (String.unsafe_get v (i lsr 3))) lsr (i land 7)) land 1)
173 let chr (c:int) : char = Obj.magic (c land 0xff)
174 let bit_vector_unsafe_set v i b =
176 let c = Char.code v.[j] in
177 let bit = int_of_bool b in
178 let mask = bit lsl (i land 7) in
179 if b then v.[j] <- chr (c lor mask) else v.[j] <- (chr (c land (lnot mask)))
181 let bit_vector_create n =
182 let len = if n <= 0 then 0 else (n - 1) / 8 + 1 in
183 String.make len '\000'
187 elements: Ptset.Int.t;
188 attributes: Ptset.Int.t;
189 attribute_array : Tag.t array;
190 children : Ptset.Int.t array;
191 siblings : Ptset.Int.t array;
192 descendants: Ptset.Int.t array;
193 followings: Ptset.Int.t array;
197 let tag_operations t = mk_tag_ops t.doc
199 external parse_xml_uri : string -> int -> bool -> bool -> int -> tree = "caml_call_shredder_uri"
200 external parse_xml_string : string -> int -> bool -> bool -> int -> tree = "caml_call_shredder_string"
202 external tree_print_xml_fast3 : tree -> [`Tree ] Node.t -> Unix.file_descr -> unit = "caml_xml_tree_print"
203 let print_xml t n fd =
204 tree_print_xml_fast3 t.doc n fd
207 external tree_save : tree -> Unix.file_descr -> string -> unit = "caml_xml_tree_save"
208 external tree_load : Unix.file_descr -> string -> bool -> int -> tree = "caml_xml_tree_load"
210 external nullt : unit -> 'a Node.t = "caml_xml_tree_nullt"
212 let nil : [`Tree ] Node.t = Node.nil
213 let root : [`Tree ] Node.t = Node.null
217 external tag_list_alloc : int -> tag_list = "caml_tag_list_alloc"
218 external tag_list_set : tag_list -> int -> Tag.t -> unit = "caml_tag_list_set" "noalloc"
220 module HPtset = Hashtbl.Make(Ptset.Int)
222 let vector_htbl = HPtset.create MED_H_SIZE
224 let tag_list_of_set s =
226 HPtset.find vector_htbl s
229 let v = tag_list_alloc (Ptset.Int.cardinal s + 1) in
231 let () = Ptset.Int.iter (fun e -> tag_list_set v !i e; incr i) s in
232 let () = tag_list_set v !i Tag.nullt in
233 HPtset.add vector_htbl s v; v
235 (** tree interface *)
237 external tree_root : tree -> [`Tree] Node.t = "caml_xml_tree_root" "noalloc"
240 external tree_first_child : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_first_child" "noalloc"
241 let first_child t n = tree_first_child t.doc n
243 external tree_first_element : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_first_element" "noalloc"
244 let first_element t n = tree_first_element t.doc n
246 external tree_tagged_child : tree -> [`Tree] Node.t -> Tag.t -> [`Tree] Node.t = "caml_xml_tree_tagged_child" "noalloc"
247 let tagged_child t n tag = tree_tagged_child t.doc n tag
249 external tree_select_child : tree -> [`Tree ] Node.t -> tag_list -> [`Tree] Node.t = "caml_xml_tree_select_child" "noalloc"
250 let select_child t n tag_set = tree_select_child t.doc n tag_set
252 external tree_last_child : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_last_child" "noalloc"
253 let last_child t n = tree_last_child t.doc n
256 external tree_next_sibling : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_next_sibling" "noalloc"
257 let next_sibling t n = tree_next_sibling t.doc n
259 external tree_next_element : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_next_element" "noalloc"
260 let next_element t n = tree_next_element t.doc n
263 external tree_tagged_sibling : tree -> [`Tree] Node.t -> Tag.t -> [`Tree] Node.t = "caml_xml_tree_tagged_sibling" "noalloc"
264 let tagged_sibling t n tag = tree_tagged_sibling t.doc n tag
267 external tree_select_sibling : tree -> [`Tree ] Node.t -> tag_list -> [`Tree] Node.t = "caml_xml_tree_select_sibling" "noalloc"
268 let select_sibling t n tag_set = tree_select_sibling t.doc n tag_set
270 external tree_prev_sibling : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_prev_sibling" "noalloc"
271 let prev_sibling t n = tree_prev_sibling t.doc n
275 external tree_tagged_descendant : tree -> [`Tree ] Node.t -> Tag.t -> [`Tree ] Node.t = "caml_xml_tree_tagged_descendant" "noalloc"
276 let tagged_descendant t n tag = tree_tagged_descendant t.doc n tag
278 external tree_tagged_next : tree -> [`Tree ] Node.t -> Tag.t -> [`Tree ] Node.t = "caml_xml_tree_tagged_next" "noalloc"
279 let tagged_next t n tag = tree_tagged_next t.doc n tag
281 external tree_select_descendant : tree -> [`Tree ] Node.t -> tag_list -> [`Tree] Node.t = "caml_xml_tree_select_descendant" "noalloc"
282 let select_descendant t n tag_set = tree_select_descendant t.doc n tag_set
284 external tree_tagged_following_before : tree -> [`Tree ] Node.t -> Tag.t -> [`Tree ] Node.t -> [`Tree ] Node.t = "caml_xml_tree_tagged_following_before" "noalloc"
285 let tagged_following_before t n tag ctx = tree_tagged_following_before t.doc n tag ctx
287 external tree_select_following_before : tree -> [`Tree ] Node.t -> tag_list -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_select_following_before" "noalloc"
288 let select_following_before t n tag_set ctx = tree_select_following_before t.doc n tag_set ctx
290 external tree_parent : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_parent" "noalloc"
291 let parent t n = tree_parent t.doc n
293 external tree_tag : tree -> [`Tree] Node.t -> Tag.t = "caml_xml_tree_tag" "noalloc"
294 let tag t n = tree_tag t.doc n
296 external tree_is_first_child : tree -> [ `Tree ] Node.t -> bool = "caml_xml_tree_is_first_child" "noalloc"
297 let is_first_child t n = tree_is_first_child t.doc n
299 external tree_is_right_descendant : tree -> [ `Tree ] Node.t -> [`Tree] Node.t -> bool =
300 "caml_xml_tree_is_right_descendant" "noalloc"
302 let is_right_descendant t n1 n2 = tree_is_right_descendant t.doc n1 n2
305 let node_tags t = Ptset.Int.add Tag.document_node t.descendants.(Tag.document_node)
307 let attribute_tags t = t.attributes
309 let element_tags t = t.elements
312 t.children.(tag), t.descendants.(tag), t.siblings.(tag), t.followings.(tag)
315 let dump_tag_table t =
317 let printer ppf set =
318 Logger.print ppf "%s: %a"
319 (Tag.to_string !tag) TagSet.print (TagSet.inj_positive set);
322 let set_printer msg set =
324 Logger.print err_formatter "%s :@\n" msg;
325 Pretty.pp_print_array ~sep:pp_force_newline printer err_formatter set;
326 Logger.print err_formatter "-----------------------------@\n";
328 set_printer "Child tags" t.children;
329 set_printer "Descendant tags" t.descendants;
330 set_printer "Sibling tags" t.siblings;
331 set_printer "Following tags" t.followings
333 external tree_subtree_tags : tree -> [`Tree] Node.t -> Tag.t -> int = "caml_xml_tree_subtree_tags" "noalloc"
334 let subtree_tags t n tag = tree_subtree_tags t.doc n tag
336 external tree_subtree_size : tree -> [`Tree] Node.t -> int = "caml_xml_tree_subtree_size" "noalloc"
337 let subtree_size t n = tree_subtree_size t.doc n
339 let subtree_elements t node =
340 let size = tree_subtree_size t.doc node - 1 in
342 else let size = size - (tree_subtree_tags t.doc node Tag.pcdata) in
343 if size < 2 then size else
344 let acc = ref size in
345 for i = 0 to Array.length t.attribute_array - 1 do
346 acc := !acc - tree_subtree_tags t.doc node t.attribute_array.(i)
350 external tree_closing : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_closing" "noalloc"
351 let closing t n = tree_closing t.doc n
353 external tree_num_tags : tree -> int = "caml_xml_tree_num_tags" "noalloc"
354 let num_tags t = tree_num_tags t.doc
356 external tree_size : tree -> int = "caml_xml_tree_size" "noalloc"
357 let size t = tree_size t.doc
362 let rec loop left node acc_d total_d num_leaves =
364 (acc_d+total_d,if left then num_leaves+1 else num_leaves)
366 let d,td = loop true (tree_first_child tree node) (acc_d+1) total_d num_leaves in
367 loop false (tree_next_sibling tree node) (acc_d) d td
369 let a,b = loop true root 0 0 0
371 Logger.print err_formatter "Average depth: %f, number of leaves %i@\n@?" ((float_of_int a)/. (float_of_int b)) b
379 external hash : t -> int = "%identity"
380 external uid : t -> Uid.t = "%identity"
381 external equal : t -> t -> bool = "%eq"
382 external make : t -> int = "%identity"
383 external node : t -> int = "%identity"
384 external stats : unit -> unit = "%identity"
387 let to_ptset s = fold (Ptset.Int.add) s Ptset.Int.empty
391 Hashtbl.Make(struct type t = TagS.t * TagS.t
393 HASHINT2(Uid.to_int x.TagS.Node.id,
394 Uid.to_int y.TagS.Node.id)
401 Hashtbl.Make(struct type t = Tag.t * TagS.t
403 HASHINT2(x, Uid.to_int y.TagS.Node.id)
410 let add_cache = TagTSCache.create 1023
411 let union_cache = TSTSCache.create 1023
412 let subset_cache = TSTSCache.create 1023
415 TSTSCache.clear union_cache;
416 TSTSCache.clear subset_cache;
417 TagTSCache.clear add_cache
420 (x == y) || (x == TagS.empty) ||
421 if y == TagS.empty then false
425 TSTSCache.find subset_cache key
428 let z = TagS.subset x y in
429 TSTSCache.add subset_cache key z; z
431 let order ((x, y) as z) =
432 if x.TagS.Node.id <= y.TagS.Node.id then z
436 if _subset x y then y
437 else if _subset y x then x
439 let key = order (x, y) in
441 TSTSCache.find union_cache key
444 let z = TagS.union x y in
445 TSTSCache.add union_cache key z; z
450 TagTSCache.find add_cache key
453 let z = TagS.add t s in
454 TagTSCache.add add_cache key z;z
456 let child_sibling_labels tree =
457 let table_c = Array.create (tree_num_tags tree) TagS.empty in
458 let table_n = Array.copy table_c in
460 if node == nil then TagS.empty
462 let children = loop (tree_first_child tree node) in
463 let tag = tree_tag tree node in
465 let tc = table_c.(tag) in
466 if _subset children tc then ()
467 else table_c.(tag) <- _union tc children
469 let siblings = loop (tree_next_sibling tree node) in
471 let tn = table_n.(tag) in
472 if _subset siblings tn then ()
473 else table_n.(tag) <- _union tn siblings
480 let descendant_labels tree =
481 let table_d = Array.create (tree_num_tags tree) TagS.empty in
483 if node == nil then TagS.empty else
484 let d1 = loop (tree_first_child tree node) in
485 let d2 = loop (tree_next_sibling tree node) in
486 let tag = tree_tag tree node in
488 let td = table_d.(tag) in
489 if _subset d1 td then ()
490 else table_d.(tag) <- _union td d1;
492 _add tag (_union d1 d2)
497 let collect_labels tree =
498 let table_f = Array.create (tree_num_tags tree) TagS.empty in
499 let table_n = Array.copy table_f in
500 let table_c = Array.copy table_f in
501 let table_d = Array.copy table_f in
502 let rec loop node foll_siblings descendants followings =
503 if node == nil then foll_siblings, descendants, followings else
504 let tag = tree_tag tree node in
506 let tf = table_f.(tag) in
507 if _subset followings tf then ()
508 else table_f.(tag) <- _union tf followings in
510 let tn = table_n.(tag) in
511 if _subset foll_siblings tn then ()
512 else table_n.(tag) <- _union tn foll_siblings in
513 let children, n_descendants, n_followings =
514 loop (tree_last_child tree node) TagS.empty TagS.empty followings
517 let tc = table_c.(tag) in
518 if _subset children tc then ()
519 else table_c.(tag) <- _union tc children
522 let td = table_d.(tag) in
523 if _subset n_descendants td then ()
524 else table_d.(tag) <- _union td n_descendants
526 loop (tree_prev_sibling tree node)
527 (_add tag foll_siblings)
528 (_add tag (_union n_descendants descendants))
529 (_add tag n_followings)
531 ignore (loop root TagS.empty TagS.empty TagS.empty);
532 table_f, table_n, table_c, table_d
535 let is_nil t = t == nil
536 let is_node t = t != nil
537 let is_root t = t == root
540 Logger.print err_formatter "Initializing tag structure@\n";
541 let _ = Tag.init (mk_tag_ops t) in
542 Logger.print err_formatter "Starting tag table construction@\n";
543 let f, n, c, d = time collect_labels t ~msg:"Building tag relationship table" in
544 let c = Array.map TagS.to_ptset c in
545 let n = Array.map TagS.to_ptset n in
546 let f = Array.map TagS.to_ptset f in
547 let d = Array.map TagS.to_ptset d in
548 let () = clear_cache () in
549 let attributes = Ptset.Int.add Tag.attribute d.(Tag.attribute) in
550 let elements = Ptset.Int.add Tag.document_node
551 (Ptset.Int.remove Tag.pcdata
552 (Ptset.Int.diff d.(Tag.document_node) attributes))
555 attributes = attributes;
556 attribute_array = Array.of_list (Ptset.Int.elements attributes);
566 let parse_xml_uri str = node_of_t (TreeBuilder.parse_file str)
567 let parse_xml_string str = node_of_t (TreeBuilder.parse_string str)
569 let size t = tree_size t.doc;;
571 let magic_string = "SXSI_INDEX"
572 let version_string = "3"
575 Unix.lseek fd 0 Unix.SEEK_CUR
577 let pr_pos fd = Logger.print err_formatter "At position %i@\n" (pos fd)
580 let sl = String.length s in
581 let ssl = Printf.sprintf "%020i" sl in
582 ignore (Unix.write fd ssl 0 20);
583 ignore (Unix.write fd s 0 (String.length s))
585 let rec really_read fd buffer start length =
586 if length <= 0 then () else
587 match Unix.read fd buffer start length with
588 0 -> raise End_of_file
589 | r -> really_read fd buffer (start + r) (length - r);;
592 let buffer = String.create 20 in
593 let _ = really_read fd buffer 0 20 in
594 let size = int_of_string buffer in
595 let buffer = String.create size in
596 let _ = really_read fd buffer 0 size in
599 let save_tag_table channel t =
600 let t = Array.map (fun s -> Array.of_list (Ptset.Int.elements s)) t in
601 Marshal.to_channel channel t []
604 let fd = Unix.openfile str [ Unix.O_WRONLY;Unix.O_TRUNC;Unix.O_CREAT] 0o644 in
605 let out_c = Unix.out_channel_of_descr fd in
606 let index_prefix = Filename.chop_suffix str ".srx" in
607 let _ = set_binary_mode_out out_c true in
608 output_string out_c magic_string;
609 output_char out_c '\n';
610 output_string out_c version_string;
611 output_char out_c '\n';
612 save_tag_table out_c t.children;
613 save_tag_table out_c t.siblings;
614 save_tag_table out_c t.descendants;
615 save_tag_table out_c t.followings;
616 (* we need to move the fd to the correct position *)
618 ignore (Unix.lseek fd (pos_out out_c) Unix.SEEK_SET);
619 tree_save t.doc fd index_prefix;
622 let load_tag_table channel =
623 let table : int array array = Marshal.from_channel channel in
624 Array.map (fun a -> Ptset.Int.from_list (Array.to_list a)) table
626 let load ?(sample=64) ?(load_text=true) str =
627 let fd = Unix.openfile str [ Unix.O_RDONLY ] 0o644 in
628 let in_c = Unix.in_channel_of_descr fd in
629 let index_prefix = Filename.chop_suffix str ".srx" in
630 let _ = set_binary_mode_in in_c true in
632 (let ms = input_line in_c in if ms <> magic_string then failwith "Invalid index file");
633 (let vs = input_line in_c in if vs <> version_string then failwith "Invalid version file");
634 let c = load_tag_table in_c in
635 let s = load_tag_table in_c in
636 let d = load_tag_table in_c in
637 let f = load_tag_table in_c in
640 let c, s, d, f = time ~msg:"Loading tag table"(load_table) () in
641 ignore(Unix.lseek fd (pos_in in_c) Unix.SEEK_SET);
642 let xml_tree = tree_load fd index_prefix load_text sample in
643 let () = Tag.init (Obj.magic xml_tree) in
644 let attributes = Ptset.Int.add Tag.attribute d.(Tag.attribute) in
645 let elements = Ptset.Int.add Tag.document_node
646 (Ptset.Int.remove Tag.pcdata
647 (Ptset.Int.diff d.(Tag.document_node) attributes))
649 let tree = { doc = xml_tree;
650 attributes = attributes;
651 attribute_array = Array.of_list (Ptset.Int.elements attributes);
664 let equal a b = a == b
668 | i -> Printf.sprintf "Node (%i)" i
670 let dump_node t = nts (Node.to_int t)
674 type query_result = { bv : bit_vector;
678 external tree_flush : tree -> Unix.file_descr -> unit = "caml_xml_tree_flush"
679 let flush t fd = tree_flush t.doc fd
681 external text_prefix : tree -> string -> bool -> query_result = "caml_text_collection_prefix_bv"
682 let text_prefix t s b = text_prefix t.doc s b
684 external text_suffix : tree -> string -> bool -> query_result = "caml_text_collection_suffix_bv"
685 let text_suffix t s b = text_suffix t.doc s b
687 external text_equals : tree -> string -> bool -> query_result = "caml_text_collection_equals_bv"
688 let text_equals t s b = text_equals t.doc s b
690 external text_contains : tree -> string -> bool -> query_result = "caml_text_collection_contains_bv"
691 let text_contains t s b = text_contains t.doc s b
694 module Predicate = Hcons.Make (
697 type t = (_t -> node -> bool) ref
698 let hash t = Hashtbl.hash t
699 let equal t1 t2 = t1 == t2
702 let string_of_query query =
704 | `Prefix -> "starts-with"
705 | `Suffix -> "ends-with"
706 | `Equals -> "equals"
707 | `Contains -> "contains"
710 let query_fun = function
711 | `Prefix -> text_prefix
712 | `Suffix -> text_suffix
713 | `Equals -> text_equals
714 | `Contains -> text_contains
717 let _pred_cache = Hashtbl.create 17
719 let mk_pred query s =
720 let f = query_fun query in
721 let memo = ref (fun _ _ -> failwith "Undefined") in
722 memo := begin fun tree node ->
724 try Hashtbl.find _pred_cache (query,s) with
726 time ~count:1 ~msg:(Printf.sprintf "Computing text query %s(%s)"
727 (string_of_query query) s)
730 let bv = results.bv in
731 memo := begin fun _ n ->
732 bit_vector_unsafe_get bv (Node.to_int n)
734 bit_vector_unsafe_get bv (Node.to_int node)
739 let full_text_prefix t s = (text_prefix t s true).pos
741 let full_text_suffix t s = (text_suffix t s true).pos
743 let full_text_equals t s = (text_equals t s true).pos
745 let full_text_contains t s = (text_contains t s true).pos
747 let full_text_query q t s =
748 let res = (query_fun q) t s true in
749 Hashtbl.replace _pred_cache (q,s) res;