session_itp.ml 31.9 KB
Newer Older
Clément Fumex's avatar
Clément Fumex committed
1 2 3 4 5
open Stdlib

module Hprover = Whyconf.Hprover

let debug = Debug.register_info_flag "session_itp"
Clément Fumex's avatar
Clément Fumex committed
6 7
    ~desc:"Pring@ debugging@ messages@ about@ Why3@ session@ \
           creation,@ reading@ and@ writing."
Clément Fumex's avatar
Clément Fumex committed
8 9 10 11

type transID = int
type proofNodeID = int

Clément Fumex's avatar
Clément Fumex committed
12 13 14
type theory = {
  theory_name     : Ident.ident;
  theory_goals    : proofNodeID list;
15
  mutable theory_checksum : Termcode.checksum option;
Clément Fumex's avatar
Clément Fumex committed
16 17
}

18
let theory_name t = t.theory_name
19
let theory_goals t = t.theory_goals
20

Clément Fumex's avatar
Clément Fumex committed
21
type proof_parent = Trans of transID | Theory of theory
Clément Fumex's avatar
Clément Fumex committed
22 23

type proof_attempt = {
Clément Fumex's avatar
Clément Fumex committed
24
  prover              : Whyconf.prover;
25
  limit               : Call_provers.resource_limit;
Clément Fumex's avatar
Clément Fumex committed
26
  mutable proof_state : Call_provers.prover_result option;
Clément Fumex's avatar
Clément Fumex committed
27
  (* None means that the call was not done or never returned *)
Clément Fumex's avatar
Clément Fumex committed
28 29
  proof_obsolete      : bool;
  proof_script        : string option;  (* non empty for external ITP *)
Clément Fumex's avatar
Clément Fumex committed
30 31 32 33 34 35 36 37
}

type proof_attempt_node = {
  proofa_parent  : proofNodeID;
  proofa_attempt : proof_attempt;
}

type proof_node = {
Clément Fumex's avatar
Clément Fumex committed
38
  proofn_name                    : Ident.ident;
Clément Fumex's avatar
Clément Fumex committed
39 40
  proofn_task                    : Task.task;
  proofn_parent                  : proof_parent;
41
  proofn_checksum                : Termcode.checksum option;
Clément Fumex's avatar
Clément Fumex committed
42 43 44 45 46 47
  proofn_attempts                : proof_attempt_node Hprover.t;
  mutable proofn_transformations : transID list;
}


type transformation_node = {
48
  transf_name     : string;
49
  transf_args     : string list;
50 51
  transf_subtasks : proofNodeID list;
  transf_parent   : proofNodeID;
Clément Fumex's avatar
Clément Fumex committed
52 53 54 55 56 57 58 59
}

type file = {
  file_name     : string;
  file_format   : string option;
  file_theories : theory list;
}

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
module Proofnodeid = struct
  type t = proofNodeID
  let compare (x : proofNodeID) y  = Pervasives.compare x y
  let equal (x : proofNodeID) y = x = y
  let hash  (x : proofNodeID) = x
end

module Transid = struct
  type t = transID
  let compare (x : transID) y  = Pervasives.compare x y
  let equal (x : transID) y = x = y
  let hash  (x : transID) = x
end

module Hpn = Exthtbl.Make(Proofnodeid)
module Htn = Exthtbl.Make(Transid)

77
type session = {
Clément Fumex's avatar
Clément Fumex committed
78
  proofNode_table               : proof_node Hint.t;
Clément Fumex's avatar
Clément Fumex committed
79 80 81 82 83 84
  mutable next_proofNodeID      : int;
  trans_table                   : transformation_node Hint.t;
  mutable next_transID          : int;
  session_files                 : file Hstr.t;
  mutable session_shape_version : int;
  session_prover_ids            : int Hprover.t;
Clément Fumex's avatar
Clément Fumex committed
85
}
Clément Fumex's avatar
Clément Fumex committed
86

87 88 89 90 91 92 93
(* TODO replace *)
let init_Hpn (s : session) (h: 'a Hpn.t) (d: 'a) : unit =
  Hint.iter (fun k _pn -> Hpn.replace h k d) s.proofNode_table

let init_Htn (s : session) (h: 'a Htn.t) (d: 'a) : unit =
  Hint.iter (fun k _pn -> Htn.replace h k d) s.trans_table

94 95 96 97 98 99 100 101 102 103 104 105
let session_iter_proofNode f s =
  Hint.iter
    (fun id pn -> if id < s.next_proofNodeID then f pn)
    s.proofNode_table

let session_iter_proof_attempt f =
  session_iter_proofNode
    (fun pn ->
       Hprover.iter
         (fun _ pan -> f pan.proofa_attempt)
        pn.proofn_attempts)

106
(* This is not needed. Keeping it as information on the structure
107 108 109 110 111 112 113
type tree = {
    tree_node_id : proofNodeID;
    tree_goal_name : string;
    tree_proof_attempts : proof_attempt list; (* proof attempts on this node *)
    tree_transformations : (transID * string * tree list) list;
                                (* transformations on this node *)
  }
114
*)
MARCHE Claude's avatar
MARCHE Claude committed
115

116
(*
Clément Fumex's avatar
Clément Fumex committed
117
let rec get_tree s id : tree =
MARCHE Claude's avatar
MARCHE Claude committed
118
  let t = Hint.find s.proofNode_table id in
MARCHE Claude's avatar
MARCHE Claude committed
119
  let pal =
120
    Hprover.fold (fun _ pa acc -> pa.proofa_attempt::acc) t.proofn_attempts []
MARCHE Claude's avatar
MARCHE Claude committed
121
  in
MARCHE Claude's avatar
MARCHE Claude committed
122
  let trl = List.map (get_trans s) t.proofn_transformations in
123 124 125 126 127
  { tree_node_id = id;
    tree_goal_name = t.proofn_name.Ident.id_string;
    tree_proof_attempts = pal;
    tree_transformations = trl;
  }
MARCHE Claude's avatar
MARCHE Claude committed
128 129 130

and get_trans s id =
  let tr = Hint.find s.trans_table id in
Clément Fumex's avatar
Clément Fumex committed
131
  (id, tr.transf_name, List.map (get_tree s) tr.transf_subtasks)
132
*)
MARCHE Claude's avatar
MARCHE Claude committed
133

134
(*
Clément Fumex's avatar
Clément Fumex committed
135
let get_theories s =
MARCHE Claude's avatar
MARCHE Claude committed
136
  Hstr.fold
137
    (fun _fn f acc ->
MARCHE Claude's avatar
MARCHE Claude committed
138 139
     let c =
       List.map
Clément Fumex's avatar
Clément Fumex committed
140
         (fun th -> (th.theory_name.Ident.id_string, th.theory_goals))
MARCHE Claude's avatar
MARCHE Claude committed
141 142
         f.file_theories
     in
143
     (f,c) :: acc)
MARCHE Claude's avatar
MARCHE Claude committed
144
    s.session_files []
145 146 147
 *)

let get_files s = s.session_files
MARCHE Claude's avatar
MARCHE Claude committed
148

149
(*
Clément Fumex's avatar
Clément Fumex committed
150 151 152 153 154
let get_node (s : session) (n : int) =
  let _ = Hint.find s.proofNode_table n in n

let get_trans (s : session) (n : int) =
  let _ = Hint.find s.trans_table n in n
155
*)
Clément Fumex's avatar
Clément Fumex committed
156

Clément Fumex's avatar
Clément Fumex committed
157 158 159 160 161 162 163 164 165 166
let gen_transID (s : session) =
  let id = s.next_transID in
  s.next_transID <- id + 1;
  id

let gen_proofNodeID (s : session) =
  let id = s.next_proofNodeID in
  s.next_proofNodeID <- id + 1;
  id

Clément Fumex's avatar
Clément Fumex committed
167
exception BadID
168

Clément Fumex's avatar
Clément Fumex committed
169 170 171 172 173
let get_proofNode (s : session) (id : proofNodeID) =
  try
    Hint.find s.proofNode_table id
  with Not_found -> raise BadID

174 175 176 177
let get_task (s:session) (id:proofNodeID) =
  let node = get_proofNode s id in
  node.proofn_task

Clément Fumex's avatar
Clément Fumex committed
178 179 180 181 182
let get_transfNode (s : session) (id : transID) =
  try
    Hint.find s.trans_table id
  with Not_found -> raise BadID

Clément Fumex's avatar
Clément Fumex committed
183 184 185
let get_transformations (s : session) (id : proofNodeID) =
  (get_proofNode s id).proofn_transformations

186 187 188
let get_proof_attempts (s : session) (id : proofNodeID) =
  Hprover.fold (fun _ a l -> a.proofa_attempt :: l) (get_proofNode s id).proofn_attempts []

Clément Fumex's avatar
Clément Fumex committed
189 190 191
let get_sub_tasks (s : session) (id : transID) =
  (get_transfNode s id).transf_subtasks

192 193 194 195
let get_transf_args (s : session) (id : transID) =
  (get_transfNode s id).transf_args

let get_transf_name (s : session) (id : transID) =
196 197 198 199 200
  (get_transfNode s id).transf_name

let get_proof_name (s : session) (id : proofNodeID) =
  (get_proofNode s id).proofn_name

201 202 203 204 205 206
let get_proof_parent (s : session) (id : proofNodeID) =
  (get_proofNode s id).proofn_parent

let get_trans_parent (s : session) (id : transID) =
  (get_transfNode s id).transf_parent

207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
let rec fold_all_sub_goals_of_proofn s f acc pnid =
  let pn = get_proofNode s pnid in
  let acc =
    List.fold_left
      (fun acc trid ->
         let tr = get_transfNode s trid in
         List.fold_left
           (fold_all_sub_goals_of_proofn s f)
           acc tr.transf_subtasks)
      acc pn.proofn_transformations
  in
  f acc pn

let fold_all_sub_goals_of_theory s f acc th =
  List.fold_left (fold_all_sub_goals_of_proofn s f) acc th.theory_goals

Clément Fumex's avatar
Clément Fumex committed
223 224 225
open Format
open Ident

MARCHE Claude's avatar
MARCHE Claude committed
226 227 228
let print_proof_attempt fmt pa =
  fprintf fmt "%a tl=%d %a"
          Whyconf.print_prover pa.prover
229
          pa.limit.Call_provers.limit_time
MARCHE Claude's avatar
MARCHE Claude committed
230 231
          (Pp.print_option Call_provers.print_prover_result) pa.proof_state

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
let rec print_proof_node s (fmt: Format.formatter) p =
  let pn = get_proofNode s p in
  let parent = match pn.proofn_parent with
  | Theory t -> t.theory_name.id_string
  | Trans id -> (get_transfNode s id).transf_name
  in
  fprintf fmt
    "@[<hv 2> Goal %s;@ parent %s;@ sum %s;@ @[<hov 2>[%a]@]@ @[<hov 2>[%a]@]@]"
    pn.proofn_name.id_string parent
    (Opt.fold (fun _ a -> Termcode.string_of_checksum a) "None" pn.proofn_checksum)
    (Pp.print_list Pp.semi print_proof_attempt)
      (Hprover.fold (fun _key e l -> e.proofa_attempt :: l) pn.proofn_attempts [])
    (Pp.print_list Pp.semi (print_trans_node s)) pn.proofn_transformations

and print_trans_node s fmt id =
  let tn = get_transfNode s id in
248
  let args = get_transf_args s id in
249 250 251
  let name = tn.transf_name in
  let l = tn.transf_subtasks in
  let parent = (get_proofNode s tn.transf_parent).proofn_name.id_string in
252
  fprintf fmt "@[<hv 2> Trans %s; args %a; parent %s;@ [%a]@]" name (Pp.print_list Pp.colon pp_print_string) args parent
253 254 255 256
    (Pp.print_list Pp.semi (print_proof_node s)) l


(*
257 258
let rec print_tree s fmt t =
  let pn = get_proofNode s t.tree_node_id in
Clément Fumex's avatar
Clément Fumex committed
259 260 261 262
  let parent = match pn.proofn_parent with
    | Theory t -> t.theory_name.id_string
    | Trans id -> (get_transfNode s id).transf_name
  in
MARCHE Claude's avatar
MARCHE Claude committed
263
  fprintf fmt
264
    "@[<hv 2> Goal %s;@ parent %s;@ sum %s;@ @[<hov 2>[%a]@]@ @[<hov 2>[%a]@]@]"
265
    t.tree_goal_name parent
266
    (Opt.fold (fun _ a -> Termcode.string_of_checksum a) "None" pn.proofn_checksum)
267 268
    (Pp.print_list Pp.semi print_proof_attempt) t.tree_proof_attempts
    (Pp.print_list Pp.semi (print_trans s)) t.tree_transformations
Clément Fumex's avatar
Clément Fumex committed
269 270 271 272 273 274

and print_trans s fmt (id, name, l) =
  let tn = get_transfNode s id in
  let parent = (get_proofNode s tn.transf_parent).proofn_name.id_string in
  fprintf fmt "@[<hv 2> Trans %s;@ parent %s;@ [%a]@]" name parent
    (Pp.print_list Pp.semi (print_tree s)) l
275 276 277 278 279 280 281 282 283 284 285 286
*)

let print_theory s fmt th : unit =
  fprintf fmt "@[<hv 2> Theory %s;@ [%a]@]" th.theory_name.Ident.id_string
    (Pp.print_list Pp.semi (fun fmt a -> print_proof_node s fmt a)) th.theory_goals

let print_file s fmt (file, thl) =
  fprintf fmt "@[<hv 2> File %s;@ [%a]@]" file.file_name
    (Pp.print_list Pp.semi (print_theory s)) thl

let print_s s fmt =
  fprintf fmt "@[%a@]" (Pp.print_list Pp.semi (print_file s))
Clément Fumex's avatar
Clément Fumex committed
287

MARCHE Claude's avatar
MARCHE Claude committed
288
let print_session fmt s =
289
  let l = Hstr.fold (fun _ f acc -> (f,f.file_theories) :: acc) (get_files s) [] in
MARCHE Claude's avatar
MARCHE Claude committed
290
  fprintf fmt "%a@." (print_s s) l;;
Clément Fumex's avatar
Clément Fumex committed
291 292

let empty_session ?shape_version () =
Clément Fumex's avatar
Clément Fumex committed
293 294 295 296
  let shape_version = match shape_version with
    | Some v -> v
    | None -> Termcode.current_shape_version
  in
Clément Fumex's avatar
Clément Fumex committed
297
  { proofNode_table = Hint.create 97;
Clément Fumex's avatar
Clément Fumex committed
298 299 300 301 302 303 304 305
    next_proofNodeID = 0;
    trans_table = Hint.create 97;
    next_transID = 0;
    session_files = Hstr.create 3;
    session_shape_version = shape_version;
    session_prover_ids = Hprover.create 7;
  }

306 307 308
(**************************************************)
(* proof node/attempt/transformation manipulation *)
(**************************************************)
MARCHE Claude's avatar
MARCHE Claude committed
309

Clément Fumex's avatar
Clément Fumex committed
310 311 312
let mk_proof_attempt session pid pa =
  let pn = get_proofNode session pid in
  let node = { proofa_parent = pid; proofa_attempt = pa } in
Clément Fumex's avatar
Clément Fumex committed
313 314
  Hprover.replace pn.proofn_attempts pa.prover node

Clément Fumex's avatar
Clément Fumex committed
315 316 317 318
let graft_proof_attempt (s : session) (id : proofNodeID) (pr : Whyconf.prover)
    ~timelimit =
  let pa = {
    prover = pr;
319 320 321
    limit = { Call_provers.limit_time  = timelimit;
              Call_provers.limit_mem   = 0;
              Call_provers.limit_steps = -1; };
Clément Fumex's avatar
Clément Fumex committed
322 323 324 325 326
    proof_state = None;
    proof_obsolete = false;
    proof_script = None; } in
  mk_proof_attempt s id pa

Clément Fumex's avatar
Clément Fumex committed
327 328 329 330 331
let remove_proof_attempt (s : session) (id : proofNodeID)
    (prover : Whyconf.prover) =
  let pn = get_proofNode s id in
  Hprover.remove pn.proofn_attempts prover

Clément Fumex's avatar
Clément Fumex committed
332
(* [mk_proof_node s n t p id] register in the session [s] a proof node
Clément Fumex's avatar
Clément Fumex committed
333
   of proofNodeID [id] of parent [p] of task [t] *)
Clément Fumex's avatar
Clément Fumex committed
334 335
let mk_proof_node (s : session) (n : Ident.ident) (t : Task.task)
    (parent : proof_parent) (node_id : proofNodeID) =
336
  let sum = Some (Termcode.task_checksum t) in
Clément Fumex's avatar
Clément Fumex committed
337 338 339
  let pn = { proofn_name = n;
             proofn_task = t;
             proofn_parent = parent;
340
             proofn_checksum = sum;
Clément Fumex's avatar
Clément Fumex committed
341 342 343
             proofn_attempts = Hprover.create 7;
             proofn_transformations = []} in
  Hint.add s.proofNode_table node_id pn
Clément Fumex's avatar
Clément Fumex committed
344

Clément Fumex's avatar
Clément Fumex committed
345
let mk_proof_node_no_task (s : session) (n : Ident.ident)
346 347 348 349 350 351 352 353
    (parent : proof_parent) (node_id : proofNodeID) sum =
  let pn = { proofn_name = n;
             proofn_task = None;
             proofn_parent = parent;
             proofn_checksum = sum;
             proofn_attempts = Hprover.create 7;
             proofn_transformations = []} in
  Hint.add s.proofNode_table node_id pn
Clément Fumex's avatar
Clément Fumex committed
354 355 356 357 358 359

let mk_proof_node_task (s : session) (t : Task.task)
    (parent : proof_parent) (node_id : proofNodeID) =
  let name,_,_ = Termcode.goal_expl_task ~root:false t in
  mk_proof_node s name t parent node_id

Clément Fumex's avatar
Clément Fumex committed
360
let mk_transf_proof_node (s : session) (tid : int) (t : Task.task) =
Clément Fumex's avatar
Clément Fumex committed
361
  let id = gen_proofNodeID s in
Clément Fumex's avatar
Clément Fumex committed
362
  mk_proof_node_task s t (Trans tid) id;
Clément Fumex's avatar
Clément Fumex committed
363 364
  id

Clément Fumex's avatar
Clément Fumex committed
365
let mk_transf_node (s : session) (id : proofNodeID) (node_id : transID)
366
    (name : string) (args : string list) (pnl : proofNodeID list) =
Clément Fumex's avatar
Clément Fumex committed
367 368 369 370 371 372 373 374 375
  let pn = get_proofNode s id in
  let tn = { transf_name = name;
             transf_args = args;
             transf_subtasks = pnl;
             transf_parent = id; } in
  Hint.add s.trans_table node_id tn;
  pn.proofn_transformations <- node_id::pn.proofn_transformations

let graft_transf  (s : session) (id : proofNodeID) (name : string)
376
    (args : string list) (tl : Task.task list) =
Clément Fumex's avatar
Clément Fumex committed
377
  let tid = gen_transID s in
378 379
  let sub_tasks = List.map (mk_transf_proof_node s tid) tl in
  mk_transf_node s id tid name args sub_tasks;
Clément Fumex's avatar
Clément Fumex committed
380
  tid
Clément Fumex's avatar
Clément Fumex committed
381 382 383 384 385 386

let remove_transformation (s : session) (id : transID) =
  let nt = get_transfNode s id in
  Hint.remove s.trans_table id;
  let pn = get_proofNode s nt.transf_parent in
  let trans_up = List.filter (fun tid -> tid != id) pn.proofn_transformations in
Clément Fumex's avatar
Clément Fumex committed
387 388 389 390 391
  pn.proofn_transformations <- trans_up

let update_proof_attempt s id pr st =
  let n = get_proofNode s id in
  let pa = Hprover.find n.proofn_attempts pr in
392
  pa.proofa_attempt.proof_state <- Some st
Clément Fumex's avatar
Clément Fumex committed
393 394 395 396 397 398 399 400 401 402 403

(****************************)
(*     session opening      *)
(****************************)

exception LoadError of Xml.element * string
exception SessionFileError of string

let bool_attribute field r def =
  try
    match List.assoc field r.Xml.attributes with
Clément Fumex's avatar
Clément Fumex committed
404 405 406
    | "true" -> true
    | "false" -> false
    | _ -> assert false
Clément Fumex's avatar
Clément Fumex committed
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
  with Not_found -> def

let int_attribute_def field r def =
  try
    int_of_string (List.assoc field r.Xml.attributes)
  with Not_found | Invalid_argument _ -> def

let string_attribute_def field r def=
  try
    List.assoc field r.Xml.attributes
  with Not_found -> def

let string_attribute_opt field r =
  try
    Some (List.assoc field r.Xml.attributes)
  with Not_found -> None

let string_attribute field r =
  try
    List.assoc field r.Xml.attributes
  with Not_found ->
    eprintf "[Error] missing required attribute '%s' from element '%s'@."
      field r.Xml.name;
    assert false

let load_result r =
  match r.Xml.name with
Clément Fumex's avatar
Clément Fumex committed
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
  | "result" ->
    let status = string_attribute "status" r in
    let answer =
      match status with
      | "valid" -> Call_provers.Valid
      | "invalid" -> Call_provers.Invalid
      | "unknown" -> Call_provers.Unknown ("", None)
      | "timeout" -> Call_provers.Timeout
      | "outofmemory" -> Call_provers.OutOfMemory
      | "failure" -> Call_provers.Failure ""
      | "highfailure" -> Call_provers.HighFailure
      | "steplimitexceeded" -> Call_provers.StepLimitExceeded
      | "stepslimitexceeded" -> Call_provers.StepLimitExceeded
      | s ->
        Warning.emit
          "[Warning] Session.load_result: unexpected status '%s'@." s;
        Call_provers.HighFailure
    in
    let time =
      try float_of_string (List.assoc "time" r.Xml.attributes)
      with Not_found -> 0.0
    in
    let steps =
      try int_of_string (List.assoc "steps" r.Xml.attributes)
      with Not_found -> -1
    in
    Some {
      Call_provers.pr_answer = answer;
      Call_provers.pr_time = time;
      Call_provers.pr_output = "";
      Call_provers.pr_status = Unix.WEXITED 0;
      Call_provers.pr_steps = steps;
      Call_provers.pr_model = Model_parser.default_model;
    }
  | "undone" -> None
  | "unedited" -> None
  | s ->
    Warning.emit "[Warning] Session.load_result: unexpected element '%s'@."
      s;
    None
Clément Fumex's avatar
Clément Fumex committed
474 475 476 477 478 479 480 481

let load_option attr g =
  try Some (List.assoc attr g.Xml.attributes)
  with Not_found -> None

let load_ident elt =
  let name = string_attribute "name" elt in
  let label = List.fold_left
Clément Fumex's avatar
Clément Fumex committed
482 483 484 485 486 487 488
      (fun acc label ->
         match label with
         | {Xml.name = "label"} ->
           let lab = string_attribute "name" label in
           Ident.Slab.add (Ident.create_label lab) acc
         | _ -> acc
      ) Ident.Slab.empty elt.Xml.elements in
Clément Fumex's avatar
Clément Fumex committed
489 490 491 492 493 494 495 496 497 498 499 500 501
  let preid =
    try
      let load_exn attr g = List.assoc attr g.Xml.attributes in
      let file = load_exn "locfile" elt in
      let lnum =  int_of_string (load_exn "loclnum" elt) in
      let cnumb = int_of_string (load_exn "loccnumb" elt) in
      let cnume = int_of_string (load_exn "loccnume" elt) in
      let pos = Loc.user_position file lnum cnumb cnume in
      Ident.id_user ~label name pos
    with Not_found | Invalid_argument _ ->
      Ident.id_fresh ~label name in
  Ident.id_register preid

Clément Fumex's avatar
Clément Fumex committed
502 503 504 505
(* [load_goal s op p g id] loads the goal of parent [p] from the xml
   [g] of nodeID [id] into the session [s] *)
let rec load_goal session old_provers parent g id =
  match g.Xml.name with
Clément Fumex's avatar
Clément Fumex committed
506 507
  | "goal" ->
    let gname = load_ident g in
508 509 510
    let csum = string_attribute_opt "sum" g in
    let sum = Opt.map Termcode.checksum_of_string csum in
    mk_proof_node_no_task session gname parent id sum;
Clément Fumex's avatar
Clément Fumex committed
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
    List.iter (load_proof_or_transf session old_provers id) g.Xml.elements;
  | "label" -> ()
  | s ->
    Warning.emit "[Warning] Session.load_goal: unexpected element '%s'@." s

(* [load_proof_or_transf s op id a] load either a proof attempt or a
   transformation of parent id [pid] from the xml [a] into the session
   [s] *)
and load_proof_or_transf session old_provers pid a =
  match a.Xml.name with
    | "proof" ->
      begin
        let prover = string_attribute "prover" a in
        try
          let prover = int_of_string prover in
          let (p,timelimit,steplimit,memlimit) = Mint.find prover old_provers in
          let res = match a.Xml.elements with
            | [r] -> load_result r
            | [] -> None
            | _ ->
              Warning.emit "[Error] Too many result elements@.";
              raise (LoadError (a,"too many result elements"))
          in
          let edit = load_option "edited" a in
          let edit = match edit with None | Some "" -> None | _ -> edit in
          let obsolete = bool_attribute "obsolete" a false in
          let timelimit = int_attribute_def "timelimit" a timelimit in
	  let steplimit = int_attribute_def "steplimit" a steplimit in
          let memlimit = int_attribute_def "memlimit" a memlimit in
          let pa = { prover = p;
541 542 543
                     limit = { Call_provers.limit_time  = timelimit;
                               Call_provers.limit_mem   = memlimit;
                               Call_provers.limit_steps = steplimit; };
Clément Fumex's avatar
Clément Fumex committed
544 545 546 547
                     proof_state = res;
                     proof_obsolete = obsolete;
                     proof_script = edit;
                   } in
Clément Fumex's avatar
Clément Fumex committed
548
          mk_proof_attempt session pid pa
Clément Fumex's avatar
Clément Fumex committed
549 550 551 552 553
        with Failure _ | Not_found ->
          Warning.emit "[Error] prover id not listed in header '%s'@." prover;
          raise (LoadError (a,"prover not listing in header"))
      end
    | "transf" ->
554 555 556 557 558 559 560 561 562 563 564
      let trname = string_attribute "name" a in
      let rec get_args id =
        match string_attribute_opt ("arg"^(string_of_int id)) a with
        | Some arg -> arg :: (get_args (id+1))
        | None -> []
      in
      let args = get_args 1 in
      let tid = gen_transID session in
      let subtasks_ids =
        List.rev (List.fold_left
                    (fun goals th ->
565 566 567
                       match th.Xml.name with
                       | "goal" -> (gen_proofNodeID session) :: goals
                       | _ -> goals) [] a.Xml.elements)
568 569 570 571 572
      in
      mk_transf_node session pid tid trname args subtasks_ids;
      List.iter2
        (load_goal session old_provers (Trans tid))
        a.Xml.elements subtasks_ids;
Clément Fumex's avatar
Clément Fumex committed
573 574
    | "metas" -> ()
    | "label" -> ()
Clément Fumex's avatar
Clément Fumex committed
575
    | s ->
576 577 578
      Warning.emit
        "[Warning] Session.load_proof_or_transf: unexpected element '%s'@."
        s
Clément Fumex's avatar
Clément Fumex committed
579 580 581 582 583 584 585

let load_theory session old_provers acc th =
  match th.Xml.name with
  | "theory" ->
    let thname = load_ident th in
    let csum = string_attribute_opt "sum" th in
    let checksum = Opt.map Termcode.checksum_of_string csum in
Clément Fumex's avatar
Clément Fumex committed
586
    let goals = List.rev (List.fold_left (fun goals th -> match th.Xml.name with
Clément Fumex's avatar
Clément Fumex committed
587
        | "goal" -> (gen_proofNodeID session) :: goals
Clément Fumex's avatar
Clément Fumex committed
588
        | _ -> goals) [] th.Xml.elements) in
Clément Fumex's avatar
Clément Fumex committed
589 590 591 592 593 594 595 596 597 598 599 600
    let mth = { theory_name = thname;
                theory_checksum = checksum;
                theory_goals = goals; } in
    List.iter2
      (load_goal session old_provers (Theory mth))
      th.Xml.elements goals;
    mth::acc
  | s ->
    Warning.emit "[Warning] Session.load_theory: unexpected element '%s'@."
      s;
    acc

601
let load_file session old_provers f =
Clément Fumex's avatar
Clément Fumex committed
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
  match f.Xml.name with
  | "file" ->
    let fn = string_attribute "name" f in
    let fmt = load_option "format" f in
    let ft = List.rev
        (List.fold_left
           (load_theory session old_provers) [] f.Xml.elements) in
    let mf = { file_name = fn;
               file_format = fmt;
               file_theories = ft; } in
    Hstr.add session.session_files fn mf;
    old_provers
  | "prover" ->
    (* The id is just for the session file *)
    let id = string_attribute "id" f in
    begin
      try
        let id = int_of_string id in
        let name = string_attribute "name" f in
        let version = string_attribute "version" f in
        let altern = string_attribute_def "alternative" f "" in
        let timelimit = int_attribute_def "timelimit" f 5 in
        let steplimit = int_attribute_def "steplimit" f 1 in
        let memlimit = int_attribute_def "memlimit" f 1000 in
        let p = {Whyconf.prover_name = name;
                 prover_version = version;
                 prover_altern = altern} in
        Mint.add id (p,timelimit,steplimit,memlimit) old_provers
      with Failure _ ->
        Warning.emit "[Warning] Session.load_file: unexpected non-numeric prover id '%s'@." id;
Clément Fumex's avatar
Clément Fumex committed
632
        old_provers
Clément Fumex's avatar
Clément Fumex committed
633 634 635 636
    end
  | s ->
    Warning.emit "[Warning] Session.load_file: unexpected element '%s'@." s;
    old_provers
Clément Fumex's avatar
Clément Fumex committed
637 638 639

let build_session (s : session) xml =
  match xml.Xml.name with
Clément Fumex's avatar
Clément Fumex committed
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
  | "why3session" ->
    let shape_version = int_attribute_def "shape_version" xml 1 in
    s.session_shape_version <- shape_version;
    Debug.dprintf debug "[Info] load_session: shape version is %d@\n" shape_version;
    (* just to keep the old_provers somewhere *)
    let old_provers =
      List.fold_left (load_file s) Mint.empty xml.Xml.elements
    in
    Mint.iter
      (fun id (p,_,_,_) ->
         Debug.dprintf debug "prover %d: %a@." id Whyconf.print_prover p;
         Hprover.replace s.session_prover_ids p id)
      old_provers;
    Debug.dprintf debug "[Info] load_session: done@\n"
  | s ->
    Warning.emit "[Warning] Session.load_session: unexpected element '%s'@."
      s
Clément Fumex's avatar
Clément Fumex committed
657 658

let load_session (file : string) =
Clément Fumex's avatar
Clément Fumex committed
659
  let session = empty_session () in
660 661 662 663 664
  (* If the xml is present we read it, otherwise we consider it empty *)
  if Sys.file_exists file then
    try
      Termcode.reset_dict ();
      let xml = Xml.from_file file in
Clément Fumex's avatar
Clément Fumex committed
665
      try
666 667 668 669 670 671 672 673 674 675 676 677 678
        build_session session xml.Xml.content;
        session
      with Sys_error msg ->
        failwith ("Open session: sys error " ^ msg)
    with
    | Sys_error msg ->
      (* xml does not exist yet *)
      raise (SessionFileError msg)
    | Xml.Parse_error s ->
      Warning.emit "XML database corrupted, ignored (%s)@." s;
      raise (SessionFileError "XML corrupted")
  else
    session
Clément Fumex's avatar
Clément Fumex committed
679

MARCHE Claude's avatar
MARCHE Claude committed
680
let make_theory_section ?old (s:session) (th:Theory.theory)  : theory =
Clément Fumex's avatar
Clément Fumex committed
681 682 683 684 685 686 687 688 689 690 691
    let add_goal parent goal id =
      let name,_expl,task = Termcode.goal_expl_task ~root:true goal in
      mk_proof_node s name task parent id;
    in
    let tasks = List.rev (Task.split_theory th None None) in
    let goalsID = List.map (fun _ -> gen_proofNodeID s) tasks in
    let theory = { theory_name = th.Theory.th_name;
                   theory_checksum = None;
                   theory_goals = goalsID; } in
    let parent = Theory theory in
    List.iter2 (add_goal parent) tasks goalsID;
MARCHE Claude's avatar
MARCHE Claude committed
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
    begin
      match old with
      | None -> ()
      | Some (old_ses,old_th) ->
         let old_goals_table = Hstr.create 7 in
         List.iter
           (fun id ->
            let pn = get_proofNode old_ses id in
            Hstr.add old_goals_table pn.proofn_name.Ident.id_string pn)
           old_th.theory_goals;
         assert false (* TODO: merge with old theory *)
    end;
    theory

(* add a why file from a session *)
let add_file_section (s:session) (fn:string) (theories:Theory.theory list) format
    (old_ses:session) (old_theories: theory list) : unit =
  let old_th_table = Hstr.create 7 in
  List.iter
    (fun th -> Hstr.add old_th_table th.theory_name.Ident.id_string th)
    old_theories;
  let add_theory (th: Theory.theory) =
    try
      let old_th = Hstr.find old_th_table th.Theory.th_name.Ident.id_string in
      Hstr.remove old_th_table th.Theory.th_name.Ident.id_string;
      make_theory_section ~old:(old_ses,old_th) s th
    with Not_found ->
      make_theory_section s th
Clément Fumex's avatar
Clément Fumex committed
720
  in
MARCHE Claude's avatar
MARCHE Claude committed
721 722
  let theories = List.rev_map add_theory theories in
  (* TODO : put remaining theories in old_th_table in the new session *)
Clément Fumex's avatar
Clément Fumex committed
723 724 725 726 727
  let f = { file_name = fn;
            file_format = format;
            file_theories = List.rev theories }
  in
  Hstr.add s.session_files fn f
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902

(************************)
(* saving state on disk *)
(************************)

module Mprover = Whyconf.Mprover
module Sprover = Whyconf.Sprover
module PHprover = Whyconf.Hprover

open Format

let save_string = Pp.html_string

type save_ctxt = {
  prover_ids : int PHprover.t;
  provers : (int * int * int * int) Mprover.t;
}

let get_used_provers_with_stats session =
  let prover_table = PHprover.create 5 in
  session_iter_proof_attempt
    (fun pa ->
      (* record mostly used pa.proof_timelimit pa.proof_memlimit *)
      let prover = pa.prover in
      let timelimits,steplimits,memlimits =
        try PHprover.find prover_table prover
        with Not_found ->
          let x = (Hashtbl.create 5,Hashtbl.create 5,Hashtbl.create 5) in
          PHprover.add prover_table prover x;
          x
      in
      let lim_time = pa.limit.Call_provers.limit_time in
      let lim_mem = pa.limit.Call_provers.limit_mem in
      let lim_steps = pa.limit.Call_provers.limit_steps in
      let tf = try Hashtbl.find timelimits lim_time with Not_found -> 0 in
      let sf = try Hashtbl.find steplimits lim_steps with Not_found -> 0 in
      let mf = try Hashtbl.find memlimits lim_mem with Not_found -> 0 in
      Hashtbl.replace timelimits lim_time (tf+1);
      Hashtbl.replace steplimits lim_steps (sf+1);
      Hashtbl.replace memlimits lim_mem (mf+1))
    session;
  prover_table

let get_prover_to_save prover_ids p (timelimits,steplimits,memlimits) provers =
  let mostfrequent_timelimit,_ =
    Hashtbl.fold
      (fun t f ((_,f') as t') -> if f > f' then (t,f) else t')
      timelimits
      (0,0)
  in
  let mostfrequent_steplimit,_ =
    Hashtbl.fold
      (fun s f ((_,f') as s') -> if f > f' then (s,f) else s')
      steplimits
      (0,0)
  in
  let mostfrequent_memlimit,_ =
    Hashtbl.fold
      (fun m f ((_,f') as m') -> if f > f' then (m,f) else m')
      memlimits
      (0,0)
  in
  let id =
    try
      PHprover.find prover_ids p
    with Not_found ->
      (* we need to find an unused prover id *)
      let occurs = Hashtbl.create 7 in
      PHprover.iter (fun _ n -> Hashtbl.add occurs n ()) prover_ids;
      let id = ref 0 in
      try
        while true do
          try
            let _ = Hashtbl.find occurs !id in incr id
          with Not_found -> raise Exit
        done;
        assert false
      with Exit ->
        PHprover.add prover_ids p !id;
        !id
  in
  Mprover.add p (id,mostfrequent_timelimit,mostfrequent_steplimit,mostfrequent_memlimit) provers

let opt pr lab fmt = function
  | None -> ()
  | Some s -> fprintf fmt "@ %s=\"%a\"" lab pr s

let opt_string = opt save_string

let save_prover fmt id (p,mostfrequent_timelimit,mostfrequent_steplimit,mostfrequent_memlimit) =
  let steplimit =
    if mostfrequent_steplimit < 0 then None else Some mostfrequent_steplimit
  in
  fprintf fmt "@\n@[<h><prover@ id=\"%i\"@ name=\"%a\"@ \
               version=\"%a\"%a@ timelimit=\"%d\"%a@ memlimit=\"%d\"/>@]"
    id save_string p.Whyconf.prover_name save_string p.Whyconf.prover_version
    (fun fmt s -> if s <> "" then fprintf fmt "@ alternative=\"%a\""
        save_string s)
    p.Whyconf.prover_altern
    mostfrequent_timelimit
    (opt pp_print_int "steplimit") steplimit
    mostfrequent_memlimit

let save_bool_def name def fmt b =
  if b <> def then fprintf fmt "@ %s=\"%b\"" name b

let save_int_def name def fmt n =
  if n <> def then fprintf fmt "@ %s=\"%d\"" name n

let save_result fmt r =
  let steps = if  r.Call_provers.pr_steps >= 0 then
                Some  r.Call_provers.pr_steps
              else
                None
  in
  fprintf fmt "<result@ status=\"%s\"@ time=\"%.2f\"%a/>"
    (match r.Call_provers.pr_answer with
       | Call_provers.Valid -> "valid"
       | Call_provers.Failure _ -> "failure"
       | Call_provers.Unknown _ -> "unknown"
       | Call_provers.HighFailure -> "highfailure"
       | Call_provers.Timeout -> "timeout"
       | Call_provers.OutOfMemory -> "outofmemory"
       | Call_provers.StepLimitExceeded -> "steplimitexceeded"
       | Call_provers.Invalid -> "invalid")
    r.Call_provers.pr_time
    (opt pp_print_int "steps") steps

let save_status fmt s =
  match s with
  | Some result -> save_result fmt result
  | None -> fprintf fmt "<undone/>"

let save_proof_attempt fmt ((id,tl,sl,ml),a) =
  fprintf fmt
    "@\n@[<h><proof@ prover=\"%i\"%a%a%a%a>"
    id
    (save_int_def "timelimit" tl) (a.limit.Call_provers.limit_time)
    (save_int_def "steplimit" sl) (a.limit.Call_provers.limit_steps)
    (save_int_def "memlimit" ml) (a.limit.Call_provers.limit_mem)
    (save_bool_def "obsolete" false) a.proof_obsolete;
  save_status fmt a.proof_state;
  fprintf fmt "</proof>@]"

let save_ident fmt id =
  let n=
    try
      let (_,_,l) = Theory.restore_path id in
      String.concat "." l
    with Not_found -> id.Ident.id_string
  in
  fprintf fmt "name=\"%a\"" save_string n

let save_checksum fmt s =
  fprintf fmt "%s" (Termcode.string_of_checksum s)

let rec save_goal s ctxt fmt pnid =
  let pn = get_proofNode s pnid in
  fprintf fmt
    "@\n@[<v 0>@[<h><goal@ %a>@]"
    save_ident pn.proofn_name;
  let l = Hprover.fold
      (fun _ a acc -> (Mprover.find a.proofa_attempt.prover ctxt.provers,
                       a.proofa_attempt) :: acc)
      pn.proofn_attempts [] in
  let l = List.sort (fun ((i1,_,_,_),_) ((i2,_,_,_),_) -> compare i1 i2) l in
  List.iter (save_proof_attempt fmt) l;
  let l =
    List.fold_left (fun acc t -> (get_transfNode s t) :: acc) [] pn.proofn_transformations
  in
  let l = List.sort (fun t1 t2 -> compare t1.transf_name t2.transf_name) l in
  List.iter (save_trans s ctxt fmt) l;
  fprintf fmt "@]@\n</goal>"

and save_trans s ctxt fmt t =
903 904 905 906 907 908 909
  let arg_id = ref 0 in
  let save_arg fmt s =
    arg_id := !arg_id + 1;
    fprintf fmt "arg%i=\"%a\"" !arg_id save_string s
  in
  fprintf fmt "@\n@[<hov 1>@[<h><transf@ name=\"%a\" %a>@]"
    save_string t.transf_name (Pp.print_list Pp.space save_arg) t.transf_args;
910 911 912 913 914 915 916 917 918 919 920 921
  List.iter (save_goal s ctxt fmt) t.transf_subtasks;
  fprintf fmt "@]@\n</transf>"

module CombinedTheoryChecksum = struct

  let b = Buffer.create 1024

  let f () pn =
    match pn.proofn_checksum with
    | None -> assert false
    | Some c -> Buffer.add_string b (Termcode.string_of_checksum c)

922
  let _compute s th =
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
    let () = fold_all_sub_goals_of_theory s f () th in
    let c = Termcode.buffer_checksum b in
    Buffer.clear b; c

end

let save_theory s ctxt fmt t =
  (* commented out since the session needs to be updated for goals to
     have a checksum *)
  (* let c = CombinedTheoryChecksum.compute s t in *)
  (* t.theory_checksum <- Some c; *)
  fprintf fmt
    "@\n@[<v 1>@[<h><theory@ %a%a>@]"
    save_ident t.theory_name
    (opt save_checksum "sum") t.theory_checksum;
  List.iter (save_goal s ctxt fmt) t.theory_goals;
  fprintf fmt "@]@\n</theory>"

let save_file s ctxt fmt _ f =
  fprintf fmt
    "@\n@[<v 0>@[<h><file@ name=\"%a\"%a>@]"
    save_string f.file_name (opt_string "format")
    f.file_format;
  List.iter (save_theory s ctxt fmt) f.file_theories;
  fprintf fmt "@]@\n</file>"

let save fname session =
  let ch = open_out fname in
  let fmt = formatter_of_out_channel ch in
  fprintf fmt "<?xml version=\"1.0\" encoding=\"UTF-8\"?>@\n";
  fprintf fmt "<!DOCTYPE why3session PUBLIC \"-//Why3//proof session v5//EN\"@ \"http://why3.lri.fr/why3session.dtd\">@\n";
  fprintf fmt "@[<v 0><why3session shape_version=\"%d\">"
    session.session_shape_version;
  Termcode.reset_dict ();
  let prover_ids = session.session_prover_ids in
  let provers =
    PHprover.fold (get_prover_to_save prover_ids)
      (get_used_provers_with_stats session) Mprover.empty
  in
  let provers_to_save =
    Mprover.fold
      (fun p (id,mostfrequent_timelimit,mostfrequent_steplimit,mostfrequent_memlimit) acc ->
        Mint.add id (p,mostfrequent_timelimit,mostfrequent_steplimit,mostfrequent_memlimit) acc)
      provers Mint.empty
  in
  Mint.iter (save_prover fmt) provers_to_save;
  let ctxt = { prover_ids = prover_ids; provers = provers } in
  Hstr.iter (save_file session ctxt fmt) session.session_files;
  fprintf fmt "@]@\n</why3session>";
  fprintf fmt "@.";
  close_out ch

let save_session (f : string) (s : session) =
  Sysutil.backup_file f;
  save f s