src/Tools/cache_io.ML
author wenzelm
Sun, 13 Mar 2011 20:21:24 +0100
changeset 41954 fb94df4505a0
parent 41945 8e32c3992cb3
child 42127 8223e7f4b0da
permissions -rw-r--r--
explicit type SHA1.digest;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
35942
667fd8553cd5 use internal SHA1 digest implementation for generating hash keys
boehmes
parents: 35941
diff changeset
     1
(*  Title:      Tools/cache_io.ML
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
     2
    Author:     Sascha Boehme, TU Muenchen
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
     3
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
     4
Cache for output of external processes.
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
     5
*)
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
     6
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
     7
signature CACHE_IO =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
     8
sig
40425
c9b5e0fcee31 return the process return code along with the process outputs
boehmes
parents: 37740
diff changeset
     9
  (*IO wrapper*)
40538
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    10
  type result = {
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    11
    output: string list,
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    12
    redirected_output: string list,
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    13
    return_code: int}
40578
2b098a549450 keep input and output files used to communicate with the SMT solver (for debugging purposes mainly)
boehmes
parents: 40538
diff changeset
    14
  val raw_run: (Path.T -> Path.T -> string) -> string -> Path.T -> Path.T ->
2b098a549450 keep input and output files used to communicate with the SMT solver (for debugging purposes mainly)
boehmes
parents: 40538
diff changeset
    15
    result
40538
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    16
  val run: (Path.T -> Path.T -> string) -> string -> result
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    17
40425
c9b5e0fcee31 return the process return code along with the process outputs
boehmes
parents: 37740
diff changeset
    18
  (*cache*)
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    19
  type cache
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    20
  val make: Path.T -> cache
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    21
  val cache_path_of: cache -> Path.T
40538
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    22
  val lookup: cache -> string -> result option * string
36086
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
    23
  val run_and_cache: cache -> string -> (Path.T -> Path.T -> string) ->
40538
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    24
    string -> result
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    25
  val run_cached: cache -> (Path.T -> Path.T -> string) -> string -> result
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    26
end
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    27
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    28
structure Cache_IO : CACHE_IO =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    29
struct
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    30
40425
c9b5e0fcee31 return the process return code along with the process outputs
boehmes
parents: 37740
diff changeset
    31
(* IO wrapper *)
c9b5e0fcee31 return the process return code along with the process outputs
boehmes
parents: 37740
diff changeset
    32
36086
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
    33
val cache_io_prefix = "cache-io-"
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
    34
40538
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    35
type result = {
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    36
  output: string list,
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    37
  redirected_output: string list,
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    38
  return_code: int}
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    39
40578
2b098a549450 keep input and output files used to communicate with the SMT solver (for debugging purposes mainly)
boehmes
parents: 40538
diff changeset
    40
fun raw_run make_cmd str in_path out_path =
2b098a549450 keep input and output files used to communicate with the SMT solver (for debugging purposes mainly)
boehmes
parents: 40538
diff changeset
    41
  let
2b098a549450 keep input and output files used to communicate with the SMT solver (for debugging purposes mainly)
boehmes
parents: 40538
diff changeset
    42
    val _ = File.write in_path str
2b098a549450 keep input and output files used to communicate with the SMT solver (for debugging purposes mainly)
boehmes
parents: 40538
diff changeset
    43
    val (out2, rc) = bash_output (make_cmd in_path out_path)
2b098a549450 keep input and output files used to communicate with the SMT solver (for debugging purposes mainly)
boehmes
parents: 40538
diff changeset
    44
    val out1 = the_default [] (try (rev o File.fold_lines cons out_path) [])
2b098a549450 keep input and output files used to communicate with the SMT solver (for debugging purposes mainly)
boehmes
parents: 40538
diff changeset
    45
  in {output=split_lines out2, redirected_output=out1, return_code=rc} end
2b098a549450 keep input and output files used to communicate with the SMT solver (for debugging purposes mainly)
boehmes
parents: 40538
diff changeset
    46
36086
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
    47
fun run make_cmd str =
41307
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40743
diff changeset
    48
  Isabelle_System.with_tmp_file cache_io_prefix (fn in_path =>
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40743
diff changeset
    49
    Isabelle_System.with_tmp_file cache_io_prefix (fn out_path =>
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40743
diff changeset
    50
      raw_run make_cmd str in_path out_path))
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    51
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    52
40425
c9b5e0fcee31 return the process return code along with the process outputs
boehmes
parents: 37740
diff changeset
    53
(* cache *)
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    54
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    55
abstype cache = Cache of {
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    56
  path: Path.T,
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    57
  table: (int * (int * int * int) Symtab.table) Synchronized.var }
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    58
with
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    59
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    60
fun cache_path_of (Cache {path, ...}) = path
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    61
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    62
fun load cache_path =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    63
  let
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    64
    fun err () = error ("Cache IO: corrupted cache file: " ^
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    65
      File.shell_path cache_path)
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    66
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    67
    fun int_of_string s =
40627
becf5d5187cc renamed raw "explode" function to "raw_explode" to emphasize its meaning;
wenzelm
parents: 40578
diff changeset
    68
      (case read_int (raw_explode s) of
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    69
        (i, []) => i
41954
fb94df4505a0 explicit type SHA1.digest;
wenzelm
parents: 41945
diff changeset
    70
      | _ => err ())
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    71
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    72
    fun split line =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    73
      (case space_explode " " line of
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    74
        [key, len1, len2] => (key, int_of_string len1, int_of_string len2)
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    75
      | _ => err ())
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    76
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    77
    fun parse line ((i, l), tab) =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    78
      if i = l
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    79
      then
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    80
        let val (key, l1, l2) = split line
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    81
        in ((i+1, l+l1+l2+1), Symtab.update (key, (i+1, l1, l2)) tab) end
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    82
      else ((i+1, l), tab)
41954
fb94df4505a0 explicit type SHA1.digest;
wenzelm
parents: 41945
diff changeset
    83
  in apfst fst (File.fold_lines parse cache_path ((1, 1), Symtab.empty)) end
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    84
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    85
fun make path =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    86
  let val table = if File.exists path then load path else (1, Symtab.empty)
41945
8e32c3992cb3 more conventional variable name;
wenzelm
parents: 41307
diff changeset
    87
  in Cache {path=path, table=Synchronized.var "Cache_IO" table} end
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    88
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    89
fun load_cached_result cache_path (p, len1, len2) =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    90
  let
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    91
    fun load line (i, xsp) =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    92
      if i < p then (i+1, xsp)
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    93
      else if i < p + len1 then (i+1, apfst (cons line) xsp)
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    94
      else if i < p + len2 then (i+1, apsnd (cons line) xsp)
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    95
      else (i, xsp)
40538
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    96
    val (out, err) =
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    97
      pairself rev (snd (File.fold_lines load cache_path (1, ([], []))))
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    98
  in {output=err, redirected_output=out, return_code=0} end
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    99
36086
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   100
fun lookup (Cache {path=cache_path, table}) str =
41954
fb94df4505a0 explicit type SHA1.digest;
wenzelm
parents: 41945
diff changeset
   101
  let val key = SHA1.rep (SHA1.digest str)
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   102
  in
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   103
    (case Symtab.lookup (snd (Synchronized.value table)) key of
36086
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   104
      NONE => (NONE, key)
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   105
    | SOME pos => (SOME (load_cached_result cache_path pos), key))
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   106
  end
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   107
36086
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   108
fun run_and_cache (Cache {path=cache_path, table}) key make_cmd str =
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   109
  let
40538
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
   110
    val {output=err, redirected_output=out, return_code} = run make_cmd str
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
   111
    val (l1, l2) = pairself length (out, err)
36086
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   112
    val header = key ^ " " ^ string_of_int l1 ^ " " ^ string_of_int l2
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   113
    val lines = map (suffix "\n") (header :: out @ err)
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   114
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   115
    val _ = Synchronized.change table (fn (p, tab) =>
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   116
      if Symtab.defined tab key then (p, tab)
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   117
      else
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   118
        let val _ = File.append_list cache_path lines
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   119
        in (p+l1+l2+1, Symtab.update (key, (p+1, l1, l2)) tab) end)
40538
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
   120
  in {output=err, redirected_output=out, return_code=return_code} end
36086
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   121
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   122
fun run_cached cache make_cmd str =
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   123
  (case lookup cache str of
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   124
    (NONE, key) => run_and_cache cache key make_cmd str
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   125
  | (SOME output, _) => output)
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   126
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   127
end
40425
c9b5e0fcee31 return the process return code along with the process outputs
boehmes
parents: 37740
diff changeset
   128
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   129
end