src/HOL/Tools/Sledgehammer/sledgehammer_mash.ML
author blanchet
Fri, 20 Jul 2012 22:19:46 +0200
changeset 49404 65679f12df4c
parent 49401 b903ea11b3bc
child 49405 4147f2bc4442
permissions -rw-r--r--
eliminated special handling of init case, now that "mash.py" has been optimized to handle sequences of add gracefully
blanchet@49395
     1
(*  Title:      HOL/Tools/Sledgehammer/sledgehammer_mash.ML
blanchet@49263
     2
    Author:     Jasmin Blanchette, TU Muenchen
blanchet@49263
     3
blanchet@49263
     4
Sledgehammer's machine-learning-based relevance filter (MaSh).
blanchet@49263
     5
*)
blanchet@49263
     6
blanchet@49396
     7
signature SLEDGEHAMMER_MASH =
blanchet@49263
     8
sig
blanchet@49266
     9
  type stature = ATP_Problem_Generate.stature
blanchet@49311
    10
  type fact = Sledgehammer_Fact.fact
blanchet@49311
    11
  type fact_override = Sledgehammer_Fact.fact_override
blanchet@49266
    12
  type params = Sledgehammer_Provers.params
blanchet@49303
    13
  type relevance_fudge = Sledgehammer_Provers.relevance_fudge
blanchet@49266
    14
  type prover_result = Sledgehammer_Provers.prover_result
blanchet@49266
    15
blanchet@49323
    16
  val trace : bool Config.T
blanchet@49334
    17
  val MaShN : string
blanchet@49394
    18
  val mepoN : string
blanchet@49394
    19
  val mashN : string
blanchet@49329
    20
  val meshN : string
blanchet@49329
    21
  val fact_filters : string list
blanchet@49318
    22
  val escape_meta : string -> string
blanchet@49318
    23
  val escape_metas : string list -> string
blanchet@49323
    24
  val unescape_meta : string -> string
blanchet@49323
    25
  val unescape_metas : string -> string list
blanchet@49326
    26
  val extract_query : string -> string * string list
blanchet@49393
    27
  val nickname_of : thm -> string
blanchet@49336
    28
  val suggested_facts : string list -> ('a * thm) list -> ('a * thm) list
blanchet@49336
    29
  val mesh_facts :
blanchet@49336
    30
    int -> (('a * thm) list * ('a * thm) list) list -> ('a * thm) list
blanchet@49339
    31
  val is_likely_tautology_or_too_meta : thm -> bool
blanchet@49266
    32
  val theory_ord : theory * theory -> order
blanchet@49266
    33
  val thm_ord : thm * thm -> order
blanchet@49333
    34
  val features_of :
blanchet@49400
    35
    Proof.context -> string -> theory -> stature -> term list -> string list
blanchet@49331
    36
  val isabelle_dependencies_of : unit Symtab.table -> thm -> string list
blanchet@49266
    37
  val goal_of_thm : theory -> thm -> thm
blanchet@49336
    38
  val run_prover_for_mash :
blanchet@49333
    39
    Proof.context -> params -> string -> fact list -> thm -> prover_result
blanchet@49347
    40
  val mash_CLEAR : Proof.context -> unit
blanchet@49323
    41
  val mash_ADD :
blanchet@49331
    42
    Proof.context -> bool
blanchet@49331
    43
    -> (string * string list * string list * string list) list -> unit
blanchet@49331
    44
  val mash_QUERY :
blanchet@49333
    45
    Proof.context -> bool -> int -> string list * string list -> string list
blanchet@49347
    46
  val mash_unlearn : Proof.context -> unit
blanchet@49333
    47
  val mash_could_suggest_facts : unit -> bool
blanchet@49336
    48
  val mash_can_suggest_facts : Proof.context -> bool
blanchet@49313
    49
  val mash_suggest_facts :
blanchet@49336
    50
    Proof.context -> params -> string -> int -> term list -> term
blanchet@49336
    51
    -> ('a * thm) list -> ('a * thm) list * ('a * thm) list
blanchet@49398
    52
  val mash_learn_proof :
blanchet@49399
    53
    Proof.context -> params -> string -> term -> ('a * thm) list -> thm list
blanchet@49399
    54
    -> unit
blanchet@49334
    55
  val mash_learn_thy :
blanchet@49334
    56
    Proof.context -> params -> theory -> Time.time -> fact list -> string
blanchet@49398
    57
  val mash_learn : Proof.context -> params -> unit
blanchet@49303
    58
  val relevant_facts :
blanchet@49307
    59
    Proof.context -> params -> string -> int -> fact_override -> term list
blanchet@49311
    60
    -> term -> fact list -> fact list
blanchet@49334
    61
  val kill_learners : unit -> unit
blanchet@49334
    62
  val running_learners : unit -> unit
blanchet@49263
    63
end;
blanchet@49263
    64
blanchet@49396
    65
structure Sledgehammer_MaSh : SLEDGEHAMMER_MASH =
blanchet@49263
    66
struct
blanchet@49264
    67
blanchet@49266
    68
open ATP_Util
blanchet@49266
    69
open ATP_Problem_Generate
blanchet@49266
    70
open Sledgehammer_Util
blanchet@49266
    71
open Sledgehammer_Fact
blanchet@49266
    72
open Sledgehammer_Provers
blanchet@49333
    73
open Sledgehammer_Minimize
blanchet@49396
    74
open Sledgehammer_MePo
blanchet@49266
    75
blanchet@49323
    76
val trace =
blanchet@49395
    77
  Attrib.setup_config_bool @{binding sledgehammer_mash_trace} (K false)
blanchet@49323
    78
fun trace_msg ctxt msg = if Config.get ctxt trace then tracing (msg ()) else ()
blanchet@49323
    79
blanchet@49334
    80
val MaShN = "MaSh"
blanchet@49334
    81
blanchet@49394
    82
val mepoN = "mepo"
blanchet@49394
    83
val mashN = "mash"
blanchet@49329
    84
val meshN = "mesh"
blanchet@49329
    85
blanchet@49394
    86
val fact_filters = [meshN, mepoN, mashN]
blanchet@49329
    87
blanchet@49329
    88
fun mash_home () = getenv "MASH_HOME"
blanchet@49329
    89
fun mash_state_dir () =
blanchet@49324
    90
  getenv "ISABELLE_HOME_USER" ^ "/mash"
blanchet@49331
    91
  |> tap (Isabelle_System.mkdir o Path.explode)
blanchet@49329
    92
fun mash_state_path () = mash_state_dir () ^ "/state" |> Path.explode
blanchet@49266
    93
blanchet@49345
    94
blanchet@49266
    95
(*** Isabelle helpers ***)
blanchet@49266
    96
blanchet@49323
    97
fun meta_char c =
blanchet@49266
    98
  if Char.isAlphaNum c orelse c = #"_" orelse c = #"." orelse c = #"(" orelse
blanchet@49266
    99
     c = #")" orelse c = #"," then
blanchet@49266
   100
    String.str c
blanchet@49266
   101
  else
blanchet@49266
   102
    (* fixed width, in case more digits follow *)
blanchet@49266
   103
    "\\" ^ stringN_of_int 3 (Char.ord c)
blanchet@49266
   104
blanchet@49323
   105
fun unmeta_chars accum [] = String.implode (rev accum)
blanchet@49323
   106
  | unmeta_chars accum (#"\\" :: d1 :: d2 :: d3 :: cs) =
blanchet@49323
   107
    (case Int.fromString (String.implode [d1, d2, d3]) of
blanchet@49323
   108
       SOME n => unmeta_chars (Char.chr n :: accum) cs
blanchet@49323
   109
     | NONE => "" (* error *))
blanchet@49323
   110
  | unmeta_chars _ (#"\\" :: _) = "" (* error *)
blanchet@49323
   111
  | unmeta_chars accum (c :: cs) = unmeta_chars (c :: accum) cs
blanchet@49323
   112
blanchet@49323
   113
val escape_meta = String.translate meta_char
blanchet@49318
   114
val escape_metas = map escape_meta #> space_implode " "
blanchet@49330
   115
val unescape_meta = String.explode #> unmeta_chars []
blanchet@49330
   116
val unescape_metas =
blanchet@49330
   117
  space_explode " " #> filter_out (curry (op =) "") #> map unescape_meta
blanchet@49266
   118
blanchet@49326
   119
fun extract_query line =
blanchet@49326
   120
  case space_explode ":" line of
blanchet@49330
   121
    [goal_name, suggs] => (unescape_meta goal_name, unescape_metas suggs)
blanchet@49327
   122
  | _ => ("", [])
blanchet@49326
   123
blanchet@49393
   124
fun parent_of_local_thm th =
blanchet@49393
   125
  let
blanchet@49393
   126
    val thy = th |> Thm.theory_of_thm
blanchet@49393
   127
    val facts = thy |> Global_Theory.facts_of
blanchet@49393
   128
    val space = facts |> Facts.space_of
blanchet@49393
   129
    fun id_of s = #id (Name_Space.the_entry space s)
blanchet@49393
   130
    fun max_id (s', _) (s, id) =
blanchet@49393
   131
      let val id' = id_of s' in if id > id' then (s, id) else (s', id') end
blanchet@49393
   132
  in ("", ~1) |> Facts.fold_static max_id facts |> fst end
blanchet@49393
   133
blanchet@49393
   134
val local_prefix = "local" ^ Long_Name.separator
blanchet@49393
   135
blanchet@49393
   136
fun nickname_of th =
blanchet@49393
   137
  let val hint = Thm.get_name_hint th in
blanchet@49393
   138
    (* FIXME: There must be a better way to detect local facts. *)
blanchet@49393
   139
    case try (unprefix local_prefix) hint of
blanchet@49393
   140
      SOME suff =>
blanchet@49393
   141
      parent_of_local_thm th ^ Long_Name.separator ^ Long_Name.separator ^ suff
blanchet@49393
   142
    | NONE => hint
blanchet@49393
   143
  end
blanchet@49393
   144
blanchet@49345
   145
fun suggested_facts suggs facts =
blanchet@49345
   146
  let
blanchet@49393
   147
    fun add_fact (fact as (_, th)) = Symtab.default (nickname_of th, fact)
blanchet@49345
   148
    val tab = Symtab.empty |> fold add_fact facts
blanchet@49345
   149
  in map_filter (Symtab.lookup tab) suggs end
blanchet@49326
   150
blanchet@49344
   151
(* Ad hoc score function roughly based on Blanchette's Ringberg 2011 data. *)
blanchet@49344
   152
fun score x = Math.pow (1.5, 15.5 - 0.05 * Real.fromInt x) + 15.0
blanchet@49343
   153
blanchet@49343
   154
fun sum_sq_avg [] = 0
blanchet@49344
   155
  | sum_sq_avg xs =
blanchet@49344
   156
    Real.ceil (100000.0 * fold (curry (op +) o score) xs 0.0) div length xs
blanchet@49328
   157
blanchet@49335
   158
fun mesh_facts max_facts [(selected, unknown)] =
blanchet@49335
   159
    take max_facts selected @ take (max_facts - length selected) unknown
blanchet@49329
   160
  | mesh_facts max_facts mess =
blanchet@49329
   161
    let
blanchet@49335
   162
      val mess = mess |> map (apfst (`length))
blanchet@49329
   163
      val fact_eq = Thm.eq_thm o pairself snd
blanchet@49335
   164
      fun score_in fact ((sel_len, sels), unks) =
blanchet@49335
   165
        case find_index (curry fact_eq fact) sels of
blanchet@49335
   166
          ~1 => (case find_index (curry fact_eq fact) unks of
blanchet@49344
   167
                   ~1 => SOME sel_len
blanchet@49335
   168
                 | _ => NONE)
blanchet@49344
   169
        | j => SOME j
blanchet@49343
   170
      fun score_of fact = mess |> map_filter (score_in fact) |> sum_sq_avg
blanchet@49335
   171
      val facts = fold (union fact_eq o take max_facts o snd o fst) mess []
blanchet@49329
   172
    in
blanchet@49343
   173
      facts |> map (`score_of) |> sort (int_ord o swap o pairself fst)
blanchet@49343
   174
            |> map snd |> take max_facts
blanchet@49329
   175
    end
blanchet@49327
   176
blanchet@49318
   177
val thy_feature_prefix = "y_"
blanchet@49266
   178
blanchet@49318
   179
val thy_feature_name_of = prefix thy_feature_prefix
blanchet@49318
   180
val const_name_of = prefix const_prefix
blanchet@49318
   181
val type_name_of = prefix type_const_prefix
blanchet@49318
   182
val class_name_of = prefix class_prefix
blanchet@49266
   183
blanchet@49339
   184
fun is_likely_tautology_or_too_meta th =
blanchet@49339
   185
  let
blanchet@49339
   186
    val is_boring_const = member (op =) atp_widely_irrelevant_consts
blanchet@49339
   187
    fun is_boring_bool t =
blanchet@49339
   188
      not (exists_Const (not o is_boring_const o fst) t) orelse
blanchet@49339
   189
      exists_type (exists_subtype (curry (op =) @{typ prop})) t
blanchet@49339
   190
    fun is_boring_prop (@{const Trueprop} $ t) = is_boring_bool t
blanchet@49339
   191
      | is_boring_prop (@{const "==>"} $ t $ u) =
blanchet@49339
   192
        is_boring_prop t andalso is_boring_prop u
blanchet@49339
   193
      | is_boring_prop (Const (@{const_name all}, _) $ (Abs (_, _, t)) $ u) =
blanchet@49339
   194
        is_boring_prop t andalso is_boring_prop u
blanchet@49339
   195
      | is_boring_prop (Const (@{const_name "=="}, _) $ t $ u) =
blanchet@49339
   196
        is_boring_bool t andalso is_boring_bool u
blanchet@49339
   197
      | is_boring_prop _ = true
blanchet@49339
   198
  in
blanchet@49339
   199
    is_boring_prop (prop_of th) andalso not (Thm.eq_thm_prop (@{thm ext}, th))
blanchet@49339
   200
  end
blanchet@49339
   201
blanchet@49339
   202
fun theory_ord p =
blanchet@49339
   203
  if Theory.eq_thy p then
blanchet@49339
   204
    EQUAL
blanchet@49339
   205
  else if Theory.subthy p then
blanchet@49339
   206
    LESS
blanchet@49339
   207
  else if Theory.subthy (swap p) then
blanchet@49339
   208
    GREATER
blanchet@49339
   209
  else case int_ord (pairself (length o Theory.ancestors_of) p) of
blanchet@49339
   210
    EQUAL => string_ord (pairself Context.theory_name p)
blanchet@49339
   211
  | order => order
blanchet@49339
   212
blanchet@49339
   213
val thm_ord = theory_ord o pairself theory_of_thm
blanchet@49339
   214
blanchet@49341
   215
val bad_types = [@{type_name prop}, @{type_name bool}, @{type_name fun}]
blanchet@49341
   216
blanchet@49333
   217
fun interesting_terms_types_and_classes ctxt prover term_max_depth
blanchet@49333
   218
                                        type_max_depth ts =
blanchet@49266
   219
  let
blanchet@49333
   220
    fun is_bad_const (x as (s, _)) args =
blanchet@49333
   221
      member (op =) atp_logical_consts s orelse
blanchet@49333
   222
      fst (is_built_in_const_for_prover ctxt prover x args)
blanchet@49319
   223
    fun add_classes @{sort type} = I
blanchet@49319
   224
      | add_classes S = union (op =) (map class_name_of S)
blanchet@49266
   225
    fun do_add_type (Type (s, Ts)) =
blanchet@49266
   226
        (not (member (op =) bad_types s) ? insert (op =) (type_name_of s))
blanchet@49266
   227
        #> fold do_add_type Ts
blanchet@49319
   228
      | do_add_type (TFree (_, S)) = add_classes S
blanchet@49319
   229
      | do_add_type (TVar (_, S)) = add_classes S
blanchet@49266
   230
    fun add_type T = type_max_depth >= 0 ? do_add_type T
blanchet@49266
   231
    fun mk_app s args =
blanchet@49266
   232
      if member (op <>) args "" then s ^ "(" ^ space_implode "," args ^ ")"
blanchet@49266
   233
      else s
blanchet@49266
   234
    fun patternify ~1 _ = ""
blanchet@49266
   235
      | patternify depth t =
blanchet@49266
   236
        case strip_comb t of
blanchet@49266
   237
          (Const (s, _), args) =>
blanchet@49266
   238
          mk_app (const_name_of s) (map (patternify (depth - 1)) args)
blanchet@49266
   239
        | _ => ""
blanchet@49266
   240
    fun add_term_patterns ~1 _ = I
blanchet@49266
   241
      | add_term_patterns depth t =
blanchet@49266
   242
        insert (op =) (patternify depth t)
blanchet@49266
   243
        #> add_term_patterns (depth - 1) t
blanchet@49266
   244
    val add_term = add_term_patterns term_max_depth
blanchet@49266
   245
    fun add_patterns t =
blanchet@49266
   246
      let val (head, args) = strip_comb t in
blanchet@49266
   247
        (case head of
blanchet@49333
   248
           Const (x as (_, T)) =>
blanchet@49333
   249
           not (is_bad_const x args) ? (add_term t #> add_type T)
blanchet@49266
   250
         | Free (_, T) => add_type T
blanchet@49266
   251
         | Var (_, T) => add_type T
blanchet@49266
   252
         | Abs (_, T, body) => add_type T #> add_patterns body
blanchet@49266
   253
         | _ => I)
blanchet@49266
   254
        #> fold add_patterns args
blanchet@49266
   255
      end
blanchet@49341
   256
  in [] |> fold add_patterns ts end
blanchet@49266
   257
blanchet@49266
   258
fun is_exists (s, _) = (s = @{const_name Ex} orelse s = @{const_name Ex1})
blanchet@49266
   259
blanchet@49312
   260
val term_max_depth = 1
blanchet@49312
   261
val type_max_depth = 1
blanchet@49266
   262
blanchet@49266
   263
(* TODO: Generate type classes for types? *)
blanchet@49400
   264
fun features_of ctxt prover thy (scope, status) ts =
blanchet@49318
   265
  thy_feature_name_of (Context.theory_name thy) ::
blanchet@49333
   266
  interesting_terms_types_and_classes ctxt prover term_max_depth type_max_depth
blanchet@49333
   267
                                      ts
blanchet@49347
   268
  |> forall is_lambda_free ts ? cons "no_lams"
blanchet@49347
   269
  |> forall (not o exists_Const is_exists) ts ? cons "no_skos"
blanchet@49400
   270
  |> scope <> Global ? cons "local"
blanchet@49317
   271
  |> (case status of
blanchet@49317
   272
        General => I
blanchet@49317
   273
      | Induction => cons "induction"
blanchet@49317
   274
      | Intro => cons "intro"
blanchet@49317
   275
      | Inductive => cons "inductive"
blanchet@49317
   276
      | Elim => cons "elim"
blanchet@49317
   277
      | Simp => cons "simp"
blanchet@49317
   278
      | Def => cons "def")
blanchet@49266
   279
blanchet@49341
   280
fun isabelle_dependencies_of all_facts = thms_in_proof (SOME all_facts)
blanchet@49266
   281
blanchet@49266
   282
val freezeT = Type.legacy_freeze_type
blanchet@49266
   283
blanchet@49266
   284
fun freeze (t $ u) = freeze t $ freeze u
blanchet@49266
   285
  | freeze (Abs (s, T, t)) = Abs (s, freezeT T, freeze t)
blanchet@49266
   286
  | freeze (Var ((s, _), T)) = Free (s, freezeT T)
blanchet@49266
   287
  | freeze (Const (s, T)) = Const (s, freezeT T)
blanchet@49266
   288
  | freeze (Free (s, T)) = Free (s, freezeT T)
blanchet@49266
   289
  | freeze t = t
blanchet@49266
   290
blanchet@49266
   291
fun goal_of_thm thy = prop_of #> freeze #> cterm_of thy #> Goal.init
blanchet@49266
   292
blanchet@49336
   293
fun run_prover_for_mash ctxt params prover facts goal =
blanchet@49266
   294
  let
blanchet@49266
   295
    val problem =
blanchet@49266
   296
      {state = Proof.init ctxt, goal = goal, subgoal = 1, subgoal_count = 1,
blanchet@49304
   297
       facts = facts |> map (apfst (apfst (fn name => name ())))
blanchet@49333
   298
                     |> map Untranslated_Fact}
blanchet@49336
   299
    val prover = get_minimizing_prover ctxt Normal (K ()) prover
blanchet@49266
   300
  in prover params (K (K (K ""))) problem end
blanchet@49266
   301
blanchet@49266
   302
blanchet@49317
   303
(*** Low-level communication with MaSh ***)
blanchet@49317
   304
blanchet@49338
   305
fun write_file (xs, f) file =
blanchet@49333
   306
  let val path = Path.explode file in
blanchet@49338
   307
    File.write path "";
blanchet@49338
   308
    xs |> chunk_list 500
blanchet@49338
   309
       |> List.app (File.append path o space_implode "" o map f)
blanchet@49333
   310
  end
blanchet@49331
   311
blanchet@49331
   312
fun mash_info overlord =
blanchet@49331
   313
  if overlord then (getenv "ISABELLE_HOME_USER", "")
blanchet@49331
   314
  else (getenv "ISABELLE_TMP", serial_string ())
blanchet@49331
   315
blanchet@49397
   316
fun and_rm_files overlord flags files =
blanchet@49397
   317
  if overlord then
blanchet@49397
   318
    ""
blanchet@49397
   319
  else
blanchet@49397
   320
    " && rm -f" ^ flags ^ " -- " ^
blanchet@49397
   321
    space_implode " " (map File.shell_quote files)
blanchet@49397
   322
blanchet@49397
   323
fun run_mash ctxt overlord (temp_dir, serial) async core =
blanchet@49326
   324
  let
blanchet@49331
   325
    val log_file = temp_dir ^ "/mash_log" ^ serial
blanchet@49331
   326
    val err_file = temp_dir ^ "/mash_err" ^ serial
blanchet@49326
   327
    val command =
blanchet@49397
   328
      "(" ^ mash_home () ^ "/mash --quiet --outputDir " ^ mash_state_dir () ^
blanchet@49397
   329
      " --log " ^ log_file ^ " " ^ core ^ ") 2>&1 > " ^ err_file ^
blanchet@49397
   330
      and_rm_files overlord "" [log_file, err_file] ^
blanchet@49397
   331
      (if async then " &" else "")
blanchet@49331
   332
  in
blanchet@49397
   333
    trace_msg ctxt (fn () =>
blanchet@49397
   334
        (if async then "Launching " else "Running ") ^ command);
blanchet@49338
   335
    write_file ([], K "") log_file;
blanchet@49338
   336
    write_file ([], K "") err_file;
blanchet@49347
   337
    Isabelle_System.bash command;
blanchet@49397
   338
    if not async then trace_msg ctxt (K "Done") else ()
blanchet@49331
   339
  end
blanchet@49326
   340
blanchet@49398
   341
fun run_mash_commands ctxt overlord save max_suggs write_cmds read_suggs =
blanchet@49331
   342
  let
blanchet@49331
   343
    val info as (temp_dir, serial) = mash_info overlord
blanchet@49333
   344
    val sugg_file = temp_dir ^ "/mash_suggs" ^ serial
blanchet@49331
   345
    val cmd_file = temp_dir ^ "/mash_commands" ^ serial
blanchet@49331
   346
  in
blanchet@49338
   347
    write_file ([], K "") sugg_file;
blanchet@49331
   348
    write_file write_cmds cmd_file;
blanchet@49398
   349
    run_mash ctxt overlord info false
blanchet@49333
   350
             ("--inputFile " ^ cmd_file ^ " --predictions " ^ sugg_file ^
blanchet@49333
   351
              " --numberOfPredictions " ^ string_of_int max_suggs ^
blanchet@49397
   352
              (if save then " --saveModel" else "") ^
blanchet@49397
   353
              (and_rm_files overlord "" [sugg_file, cmd_file]));
blanchet@49333
   354
    read_suggs (fn () => File.read_lines (Path.explode sugg_file))
blanchet@49331
   355
  end
blanchet@49331
   356
blanchet@49331
   357
fun str_of_update (name, parents, feats, deps) =
blanchet@49331
   358
  "! " ^ escape_meta name ^ ": " ^ escape_metas parents ^ "; " ^
blanchet@49326
   359
  escape_metas feats ^ "; " ^ escape_metas deps ^ "\n"
blanchet@49326
   360
blanchet@49331
   361
fun str_of_query (parents, feats) =
blanchet@49331
   362
  "? " ^ escape_metas parents ^ "; " ^ escape_metas feats
blanchet@49331
   363
blanchet@49347
   364
fun mash_CLEAR ctxt =
blanchet@49329
   365
  let val path = mash_state_dir () |> Path.explode in
blanchet@49347
   366
    trace_msg ctxt (K "MaSh CLEAR");
blanchet@49324
   367
    File.fold_dir (fn file => fn () =>
blanchet@49324
   368
                      File.rm (Path.append path (Path.basic file)))
blanchet@49324
   369
                  path ()
blanchet@49324
   370
  end
blanchet@49317
   371
blanchet@49331
   372
fun mash_ADD _ _ [] = ()
blanchet@49331
   373
  | mash_ADD ctxt overlord upds =
blanchet@49331
   374
    (trace_msg ctxt (fn () => "MaSh ADD " ^
blanchet@49331
   375
         elide_string 1000 (space_implode " " (map #1 upds)));
blanchet@49398
   376
     run_mash_commands ctxt overlord true 0 (upds, str_of_update) (K ()))
blanchet@49317
   377
blanchet@49333
   378
fun mash_QUERY ctxt overlord max_suggs (query as (_, feats)) =
blanchet@49329
   379
  (trace_msg ctxt (fn () => "MaSh QUERY " ^ space_implode " " feats);
blanchet@49398
   380
   run_mash_commands ctxt overlord false  max_suggs
blanchet@49338
   381
       ([query], str_of_query)
blanchet@49333
   382
       (fn suggs => snd (extract_query (List.last (suggs ()))))
blanchet@49326
   383
   handle List.Empty => [])
blanchet@49317
   384
blanchet@49317
   385
blanchet@49266
   386
(*** High-level communication with MaSh ***)
blanchet@49266
   387
blanchet@49336
   388
fun try_graph ctxt when def f =
blanchet@49336
   389
  f ()
blanchet@49336
   390
  handle Graph.CYCLES (cycle :: _) =>
blanchet@49336
   391
         (trace_msg ctxt (fn () =>
blanchet@49336
   392
              "Cycle involving " ^ commas cycle ^ " when " ^ when); def)
blanchet@49336
   393
       | Graph.UNDEF name =>
blanchet@49336
   394
         (trace_msg ctxt (fn () =>
blanchet@49336
   395
              "Unknown fact " ^ quote name ^ " when " ^ when); def)
blanchet@49336
   396
blanchet@49316
   397
type mash_state =
blanchet@49331
   398
  {thys : bool Symtab.table,
blanchet@49331
   399
   fact_graph : unit Graph.T}
blanchet@49264
   400
blanchet@49331
   401
val empty_state = {thys = Symtab.empty, fact_graph = Graph.empty}
blanchet@49316
   402
blanchet@49316
   403
local
blanchet@49316
   404
blanchet@49336
   405
fun mash_load _ (state as (true, _)) = state
blanchet@49336
   406
  | mash_load ctxt _ =
blanchet@49324
   407
    let val path = mash_state_path () in
blanchet@49317
   408
      (true,
blanchet@49317
   409
       case try File.read_lines path of
blanchet@49331
   410
         SOME (comp_thys :: incomp_thys :: fact_lines) =>
blanchet@49317
   411
         let
blanchet@49331
   412
           fun add_thy comp thy = Symtab.update (thy, comp)
blanchet@49337
   413
           fun add_edge_to name parent =
blanchet@49337
   414
             Graph.default_node (parent, ())
blanchet@49337
   415
             #> Graph.add_edge (parent, name)
blanchet@49331
   416
           fun add_fact_line line =
blanchet@49331
   417
             case extract_query line of
blanchet@49331
   418
               ("", _) => I (* shouldn't happen *)
blanchet@49331
   419
             | (name, parents) =>
blanchet@49331
   420
               Graph.default_node (name, ())
blanchet@49337
   421
               #> fold (add_edge_to name) parents
blanchet@49331
   422
           val thys =
blanchet@49331
   423
             Symtab.empty |> fold (add_thy true) (unescape_metas comp_thys)
blanchet@49331
   424
                          |> fold (add_thy false) (unescape_metas incomp_thys)
blanchet@49336
   425
           val fact_graph =
blanchet@49337
   426
             try_graph ctxt "loading state" Graph.empty (fn () =>
blanchet@49336
   427
                 Graph.empty |> fold add_fact_line fact_lines)
blanchet@49331
   428
         in {thys = thys, fact_graph = fact_graph} end
blanchet@49319
   429
       | _ => empty_state)
blanchet@49317
   430
    end
blanchet@49316
   431
blanchet@49331
   432
fun mash_save ({thys, fact_graph, ...} : mash_state) =
blanchet@49316
   433
  let
blanchet@49324
   434
    val path = mash_state_path ()
blanchet@49331
   435
    val thys = Symtab.dest thys
blanchet@49333
   436
    val line_for_thys = escape_metas o AList.find (op =) thys
blanchet@49333
   437
    fun fact_line_for name parents =
blanchet@49333
   438
      escape_meta name ^ ": " ^ escape_metas parents
blanchet@49331
   439
    val append_fact = File.append path o suffix "\n" oo fact_line_for
blanchet@49316
   440
  in
blanchet@49331
   441
    File.write path (line_for_thys true ^ "\n" ^ line_for_thys false ^ "\n");
blanchet@49331
   442
    Graph.fold (fn (name, ((), (parents, _))) => fn () =>
blanchet@49331
   443
                   append_fact name (Graph.Keys.dest parents))
blanchet@49331
   444
        fact_graph ()
blanchet@49316
   445
  end
blanchet@49316
   446
blanchet@49317
   447
val global_state =
blanchet@49396
   448
  Synchronized.var "Sledgehammer_MaSh.global_state" (false, empty_state)
blanchet@49316
   449
blanchet@49316
   450
in
blanchet@49316
   451
blanchet@49336
   452
fun mash_map ctxt f =
blanchet@49336
   453
  Synchronized.change global_state (mash_load ctxt ##> (f #> tap mash_save))
blanchet@49316
   454
blanchet@49336
   455
fun mash_get ctxt =
blanchet@49336
   456
  Synchronized.change_result global_state (mash_load ctxt #> `snd)
blanchet@49317
   457
blanchet@49347
   458
fun mash_unlearn ctxt =
blanchet@49317
   459
  Synchronized.change global_state (fn _ =>
blanchet@49347
   460
      (mash_CLEAR ctxt; File.write (mash_state_path ()) "";
blanchet@49323
   461
       (true, empty_state)))
blanchet@49316
   462
blanchet@49316
   463
end
blanchet@49316
   464
blanchet@49333
   465
fun mash_could_suggest_facts () = mash_home () <> ""
blanchet@49336
   466
fun mash_can_suggest_facts ctxt =
blanchet@49336
   467
  not (Graph.is_empty (#fact_graph (mash_get ctxt)))
blanchet@49264
   468
blanchet@49347
   469
fun parents_wrt_facts facts fact_graph =
blanchet@49331
   470
  let
blanchet@49393
   471
    val facts = [] |> fold (cons o nickname_of o snd) facts
blanchet@49345
   472
    val tab = Symtab.empty |> fold (fn name => Symtab.update (name, ())) facts
blanchet@49392
   473
    fun insert_not_seen seen name =
blanchet@49392
   474
      not (member (op =) seen name) ? insert (op =) name
blanchet@49393
   475
    fun parents_of _ parents [] = parents
blanchet@49392
   476
      | parents_of seen parents (name :: names) =
blanchet@49347
   477
        if Symtab.defined tab name then
blanchet@49392
   478
          parents_of (name :: seen) (name :: parents) names
blanchet@49347
   479
        else
blanchet@49392
   480
          parents_of (name :: seen) parents
blanchet@49392
   481
                     (Graph.Keys.fold (insert_not_seen seen)
blanchet@49392
   482
                                      (Graph.imm_preds fact_graph name) names)
blanchet@49392
   483
  in parents_of [] [] (Graph.maximals fact_graph) end
blanchet@49331
   484
blanchet@49333
   485
(* Generate more suggestions than requested, because some might be thrown out
blanchet@49333
   486
   later for various reasons and "meshing" gives better results with some
blanchet@49333
   487
   slack. *)
blanchet@49333
   488
fun max_suggs_of max_facts = max_facts + Int.min (200, max_facts)
blanchet@49333
   489
blanchet@49335
   490
fun is_fact_in_graph fact_graph (_, th) =
blanchet@49393
   491
  can (Graph.get_node fact_graph) (nickname_of th)
blanchet@49335
   492
blanchet@49333
   493
fun mash_suggest_facts ctxt ({overlord, ...} : params) prover max_facts hyp_ts
blanchet@49333
   494
                       concl_t facts =
blanchet@49316
   495
  let
blanchet@49317
   496
    val thy = Proof_Context.theory_of ctxt
blanchet@49336
   497
    val fact_graph = #fact_graph (mash_get ctxt)
blanchet@49347
   498
    val parents = parents_wrt_facts facts fact_graph
blanchet@49400
   499
    val feats = features_of ctxt prover thy (Local, General) (concl_t :: hyp_ts)
blanchet@49333
   500
    val suggs =
blanchet@49335
   501
      if Graph.is_empty fact_graph then []
blanchet@49335
   502
      else mash_QUERY ctxt overlord (max_suggs_of max_facts) (parents, feats)
blanchet@49335
   503
    val selected = facts |> suggested_facts suggs
blanchet@49335
   504
    val unknown = facts |> filter_out (is_fact_in_graph fact_graph)
blanchet@49335
   505
  in (selected, unknown) end
blanchet@49264
   506
blanchet@49331
   507
fun add_thys_for thy =
blanchet@49331
   508
  let fun add comp thy = Symtab.update (Context.theory_name thy, comp) in
blanchet@49331
   509
    add false thy #> fold (add true) (Theory.ancestors_of thy)
blanchet@49331
   510
  end
blanchet@49319
   511
blanchet@49331
   512
fun update_fact_graph ctxt (name, parents, feats, deps) (upds, graph) =
blanchet@49331
   513
  let
blanchet@49331
   514
    fun maybe_add_from from (accum as (parents, graph)) =
blanchet@49336
   515
      try_graph ctxt "updating graph" accum (fn () =>
blanchet@49336
   516
          (from :: parents, Graph.add_edge_acyclic (from, name) graph))
blanchet@49336
   517
    val graph = graph |> Graph.default_node (name, ())
blanchet@49331
   518
    val (parents, graph) = ([], graph) |> fold maybe_add_from parents
blanchet@49331
   519
    val (deps, graph) = ([], graph) |> fold maybe_add_from deps
blanchet@49331
   520
  in ((name, parents, feats, deps) :: upds, graph) end
blanchet@49321
   521
blanchet@49399
   522
val learn_timeout_slack = 2.0
blanchet@49333
   523
blanchet@49399
   524
fun launch_thread timeout task =
blanchet@49398
   525
  let
blanchet@49399
   526
    val hard_timeout = time_mult learn_timeout_slack timeout
blanchet@49399
   527
    val birth_time = Time.now ()
blanchet@49399
   528
    val death_time = Time.+ (birth_time, hard_timeout)
blanchet@49399
   529
    val desc = ("machine learner for Sledgehammer", "")
blanchet@49399
   530
  in Async_Manager.launch MaShN birth_time death_time desc task end
blanchet@49399
   531
blanchet@49399
   532
fun mash_learn_proof ctxt ({overlord, timeout, ...} : params) prover t facts
blanchet@49399
   533
                     used_ths =
blanchet@49399
   534
  if is_smt_prover ctxt prover then
blanchet@49399
   535
    ()
blanchet@49399
   536
  else
blanchet@49399
   537
    launch_thread timeout
blanchet@49399
   538
        (fn () =>
blanchet@49399
   539
            let
blanchet@49399
   540
              val thy = Proof_Context.theory_of ctxt
blanchet@49399
   541
              val name = timestamp () ^ " " ^ serial_string () (* freshish *)
blanchet@49400
   542
              val feats = features_of ctxt prover thy (Local, General) [t]
blanchet@49399
   543
              val deps = used_ths |> map nickname_of
blanchet@49399
   544
            in
blanchet@49399
   545
              mash_map ctxt (fn {thys, fact_graph} =>
blanchet@49399
   546
                  let
blanchet@49399
   547
                    val parents = parents_wrt_facts facts fact_graph
blanchet@49399
   548
                    val upds = [(name, parents, feats, deps)]
blanchet@49399
   549
                    val (upds, fact_graph) =
blanchet@49399
   550
                      ([], fact_graph) |> fold (update_fact_graph ctxt) upds
blanchet@49399
   551
                  in
blanchet@49399
   552
                    mash_ADD ctxt overlord upds;
blanchet@49399
   553
                    {thys = thys, fact_graph = fact_graph}
blanchet@49399
   554
                  end);
blanchet@49399
   555
              (true, "")
blanchet@49399
   556
            end)
blanchet@49398
   557
blanchet@49347
   558
(* Too many dependencies is a sign that a decision procedure is at work. There
blanchet@49347
   559
   isn't much too learn from such proofs. *)
blanchet@49347
   560
val max_dependencies = 10
blanchet@49399
   561
val pass1_learn_timeout_factor = 0.75
blanchet@49347
   562
blanchet@49333
   563
(* The timeout is understood in a very slack fashion. *)
blanchet@49334
   564
fun mash_learn_thy ctxt ({provers, verbose, overlord, ...} : params) thy timeout
blanchet@49334
   565
                   facts =
blanchet@49319
   566
  let
blanchet@49333
   567
    val timer = Timer.startRealTimer ()
blanchet@49333
   568
    val prover = hd provers
blanchet@49333
   569
    fun timed_out frac =
blanchet@49333
   570
      Time.> (Timer.checkRealTimer timer, time_mult frac timeout)
blanchet@49336
   571
    val {fact_graph, ...} = mash_get ctxt
blanchet@49335
   572
    val new_facts =
blanchet@49335
   573
      facts |> filter_out (is_fact_in_graph fact_graph)
blanchet@49335
   574
            |> sort (thm_ord o pairself snd)
blanchet@49323
   575
  in
blanchet@49323
   576
    if null new_facts then
blanchet@49334
   577
      ""
blanchet@49323
   578
    else
blanchet@49319
   579
      let
blanchet@49323
   580
        val ths = facts |> map snd
blanchet@49330
   581
        val all_names =
blanchet@49339
   582
          ths |> filter_out is_likely_tautology_or_too_meta
blanchet@49393
   583
              |> map (rpair () o nickname_of)
blanchet@49331
   584
              |> Symtab.make
blanchet@49347
   585
        fun trim_deps deps = if length deps > max_dependencies then [] else deps
blanchet@49333
   586
        fun do_fact _ (accum as (_, true)) = accum
blanchet@49400
   587
          | do_fact ((_, stature), th) ((parents, upds), false) =
blanchet@49333
   588
            let
blanchet@49393
   589
              val name = nickname_of th
blanchet@49347
   590
              val feats =
blanchet@49400
   591
                features_of ctxt prover (theory_of_thm th) stature [prop_of th]
blanchet@49347
   592
              val deps = isabelle_dependencies_of all_names th |> trim_deps
blanchet@49333
   593
              val upd = (name, parents, feats, deps)
blanchet@49333
   594
            in (([name], upd :: upds), timed_out pass1_learn_timeout_factor) end
blanchet@49347
   595
        val parents = parents_wrt_facts facts fact_graph
blanchet@49333
   596
        val ((_, upds), _) =
blanchet@49333
   597
          ((parents, []), false) |> fold do_fact new_facts |>> apsnd rev
blanchet@49333
   598
        val n = length upds
blanchet@49331
   599
        fun trans {thys, fact_graph} =
blanchet@49331
   600
          let
blanchet@49331
   601
            val (upds, fact_graph) =
blanchet@49331
   602
              ([], fact_graph) |> fold (update_fact_graph ctxt) upds
blanchet@49331
   603
          in
blanchet@49404
   604
            (mash_ADD ctxt overlord (rev upds);
blanchet@49398
   605
             {thys = thys |> add_thys_for thy, fact_graph = fact_graph})
blanchet@49331
   606
          end
blanchet@49333
   607
      in
blanchet@49336
   608
        mash_map ctxt trans;
blanchet@49334
   609
        if verbose then
blanchet@49398
   610
          "Learned " ^ string_of_int n ^ " proof" ^ plural_s n ^
blanchet@49334
   611
          (if verbose then
blanchet@49334
   612
             " in " ^ string_from_time (Timer.checkRealTimer timer)
blanchet@49334
   613
           else
blanchet@49334
   614
             "") ^ "."
blanchet@49334
   615
        else
blanchet@49334
   616
          ""
blanchet@49333
   617
      end
blanchet@49323
   618
  end
blanchet@49319
   619
blanchet@49398
   620
fun mash_learn ctxt params =
blanchet@49331
   621
  let
blanchet@49331
   622
    val thy = Proof_Context.theory_of ctxt
blanchet@49398
   623
    val _ = Output.urgent_message "MaShing..."
blanchet@49398
   624
    val css_table = Sledgehammer_Fact.clasimpset_rule_table_of ctxt
blanchet@49398
   625
    val facts = all_facts_of thy css_table
blanchet@49331
   626
  in
blanchet@49398
   627
     mash_learn_thy ctxt params thy infinite_timeout facts
blanchet@49398
   628
     |> (fn "" => "Learned nothing." | msg => msg)
blanchet@49398
   629
     |> Output.urgent_message
blanchet@49331
   630
  end
blanchet@49264
   631
blanchet@49333
   632
(* The threshold should be large enough so that MaSh doesn't kick in for Auto
blanchet@49333
   633
   Sledgehammer and Try. *)
blanchet@49333
   634
val min_secs_for_learning = 15
blanchet@49333
   635
blanchet@49336
   636
fun relevant_facts ctxt (params as {learn, fact_filter, timeout, ...}) prover
blanchet@49336
   637
        max_facts ({add, only, ...} : fact_override) hyp_ts concl_t facts =
blanchet@49329
   638
  if not (subset (op =) (the_list fact_filter, fact_filters)) then
blanchet@49329
   639
    error ("Unknown fact filter: " ^ quote (the fact_filter) ^ ".")
blanchet@49329
   640
  else if only then
blanchet@49304
   641
    facts
blanchet@49336
   642
  else if max_facts <= 0 orelse null facts then
blanchet@49303
   643
    []
blanchet@49303
   644
  else
blanchet@49303
   645
    let
blanchet@49333
   646
      val thy = Proof_Context.theory_of ctxt
blanchet@49342
   647
      fun maybe_learn () =
blanchet@49399
   648
        if learn andalso not (Async_Manager.has_running_threads MaShN) andalso
blanchet@49399
   649
           Time.toSeconds timeout >= min_secs_for_learning then
blanchet@49399
   650
          let val timeout = time_mult learn_timeout_slack timeout in
blanchet@49399
   651
            launch_thread timeout
blanchet@49399
   652
                (fn () => (true, mash_learn_thy ctxt params thy timeout facts))
blanchet@49334
   653
          end
blanchet@49333
   654
        else
blanchet@49333
   655
          ()
blanchet@49329
   656
      val fact_filter =
blanchet@49329
   657
        case fact_filter of
blanchet@49394
   658
          SOME ff => (() |> ff <> mepoN ? maybe_learn; ff)
blanchet@49333
   659
        | NONE =>
blanchet@49401
   660
          if is_smt_prover ctxt prover then mepoN
blanchet@49401
   661
          else if mash_can_suggest_facts ctxt then (maybe_learn (); meshN)
blanchet@49394
   662
          else if mash_could_suggest_facts () then (maybe_learn (); mepoN)
blanchet@49394
   663
          else mepoN
blanchet@49303
   664
      val add_ths = Attrib.eval_thms ctxt add
blanchet@49307
   665
      fun prepend_facts ths accepts =
blanchet@49303
   666
        ((facts |> filter (member Thm.eq_thm_prop ths o snd)) @
blanchet@49307
   667
         (accepts |> filter_out (member Thm.eq_thm_prop ths o snd)))
blanchet@49308
   668
        |> take max_facts
blanchet@49329
   669
      fun iter () =
blanchet@49313
   670
        iterative_relevant_facts ctxt params prover max_facts NONE hyp_ts
blanchet@49313
   671
                                 concl_t facts
blanchet@49329
   672
      fun mash () =
blanchet@49335
   673
        mash_suggest_facts ctxt params prover max_facts hyp_ts concl_t facts
blanchet@49329
   674
      val mess =
blanchet@49335
   675
        [] |> (if fact_filter <> mashN then cons (iter (), []) else I)
blanchet@49394
   676
           |> (if fact_filter <> mepoN then cons (mash ()) else I)
blanchet@49303
   677
    in
blanchet@49328
   678
      mesh_facts max_facts mess
blanchet@49303
   679
      |> not (null add_ths) ? prepend_facts add_ths
blanchet@49303
   680
    end
blanchet@49303
   681
blanchet@49334
   682
fun kill_learners () = Async_Manager.kill_threads MaShN "learner"
blanchet@49334
   683
fun running_learners () = Async_Manager.running_threads MaShN "learner"
blanchet@49334
   684
blanchet@49263
   685
end;