src/Tools/cache_io.ML
author boehmes
Wed, 17 Nov 2010 08:14:55 +0100
changeset 40578 2b098a549450
parent 40538 b8482ff0bc92
child 40627 becf5d5187cc
permissions -rw-r--r--
keep input and output files used to communicate with the SMT solver (for debugging purposes mainly)
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*)
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    10
  val with_tmp_file: string -> (Path.T -> 'a) -> 'a
37740
9bb4a74cff4e combinator with_tmp_dir
haftmann
parents: 36086
diff changeset
    11
  val with_tmp_dir: string -> (Path.T -> 'a) -> 'a
40538
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    12
  type result = {
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    13
    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
    14
    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
    15
    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
    16
  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
    17
    result
40538
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    18
  val run: (Path.T -> Path.T -> string) -> string -> result
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    19
40425
c9b5e0fcee31 return the process return code along with the process outputs
boehmes
parents: 37740
diff changeset
    20
  (*cache*)
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    21
  type cache
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    22
  val make: Path.T -> cache
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    23
  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
    24
  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
    25
  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
    26
    string -> result
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    27
  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
    28
end
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    29
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    30
structure Cache_IO : CACHE_IO =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    31
struct
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    32
40425
c9b5e0fcee31 return the process return code along with the process outputs
boehmes
parents: 37740
diff changeset
    33
(* IO wrapper *)
c9b5e0fcee31 return the process return code along with the process outputs
boehmes
parents: 37740
diff changeset
    34
36086
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
    35
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
    36
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    37
fun with_tmp_file name f =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    38
  let
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    39
    val path = File.tmp_path (Path.explode (name ^ serial_string ()))
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    40
    val x = Exn.capture f path
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    41
    val _ = try File.rm path
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    42
  in Exn.release x end
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    43
37740
9bb4a74cff4e combinator with_tmp_dir
haftmann
parents: 36086
diff changeset
    44
fun with_tmp_dir name f =
9bb4a74cff4e combinator with_tmp_dir
haftmann
parents: 36086
diff changeset
    45
  let
9bb4a74cff4e combinator with_tmp_dir
haftmann
parents: 36086
diff changeset
    46
    val path = File.tmp_path (Path.explode (name ^ serial_string ()))
9bb4a74cff4e combinator with_tmp_dir
haftmann
parents: 36086
diff changeset
    47
    val _ = File.mkdir path
9bb4a74cff4e combinator with_tmp_dir
haftmann
parents: 36086
diff changeset
    48
    val x = Exn.capture f path
9bb4a74cff4e combinator with_tmp_dir
haftmann
parents: 36086
diff changeset
    49
    val _ = try File.rm_tree path
9bb4a74cff4e combinator with_tmp_dir
haftmann
parents: 36086
diff changeset
    50
  in Exn.release x end
9bb4a74cff4e combinator with_tmp_dir
haftmann
parents: 36086
diff changeset
    51
40538
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    52
type result = {
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
    53
  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
    54
  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
    55
  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
    56
40578
2b098a549450 keep input and output files used to communicate with the SMT solver (for debugging purposes mainly)
boehmes
parents: 40538
diff changeset
    57
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
    58
  let
2b098a549450 keep input and output files used to communicate with the SMT solver (for debugging purposes mainly)
boehmes
parents: 40538
diff changeset
    59
    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
    60
    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
    61
    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
    62
  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
    63
36086
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
    64
fun run 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
    65
  with_tmp_file cache_io_prefix (fn in_path =>
40578
2b098a549450 keep input and output files used to communicate with the SMT solver (for debugging purposes mainly)
boehmes
parents: 40538
diff changeset
    66
  with_tmp_file cache_io_prefix (raw_run make_cmd str in_path))
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    67
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    68
40425
c9b5e0fcee31 return the process return code along with the process outputs
boehmes
parents: 37740
diff changeset
    69
(* cache *)
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    70
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    71
abstype cache = Cache of {
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    72
  path: Path.T,
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    73
  table: (int * (int * int * int) Symtab.table) Synchronized.var }
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    74
with
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    75
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    76
fun cache_path_of (Cache {path, ...}) = path
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    77
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    78
fun load cache_path =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    79
  let
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    80
    fun err () = error ("Cache IO: corrupted cache file: " ^
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    81
      File.shell_path cache_path)
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    82
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    83
    fun int_of_string s =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    84
      (case read_int (explode s) of
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    85
        (i, []) => i
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    86
      | _ => err ())    
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    87
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    88
    fun split line =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    89
      (case space_explode " " line of
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    90
        [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
    91
      | _ => err ())
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    92
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    93
    fun parse line ((i, l), tab) =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    94
      if i = l
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    95
      then
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    96
        let val (key, l1, l2) = split line
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    97
        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
    98
      else ((i+1, l), tab)
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
    99
  in apfst fst (File.fold_lines parse cache_path ((1, 1), Symtab.empty)) end 
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   100
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   101
fun make path =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   102
  let val table = if File.exists path then load path else (1, Symtab.empty)
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   103
  in Cache {path=path, table=Synchronized.var (Path.implode path) table} end
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   104
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   105
fun load_cached_result cache_path (p, len1, len2) =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   106
  let
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   107
    fun load line (i, xsp) =
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   108
      if i < p then (i+1, xsp)
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   109
      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
   110
      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
   111
      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
   112
    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
   113
      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
   114
  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
   115
36086
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   116
fun lookup (Cache {path=cache_path, table}) str =
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   117
  let val key = SHA1.digest str
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   118
  in
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   119
    (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
   120
      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
   121
    | 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
   122
  end
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   123
36086
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   124
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
   125
  let
40538
b8482ff0bc92 check the return code of the SMT solver and raise an exception if the prover failed
boehmes
parents: 40425
diff changeset
   126
    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
   127
    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
   128
    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
   129
    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
   130
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   131
    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
   132
      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
   133
      else
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   134
        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
   135
        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
   136
  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
   137
8e5454761f26 simplified Cache_IO interface (input is just a string and not already stored in a file)
boehmes
parents: 35942
diff changeset
   138
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
   139
  (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
   140
    (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
   141
  | (SOME output, _) => output)
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   142
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   143
end
40425
c9b5e0fcee31 return the process return code along with the process outputs
boehmes
parents: 37740
diff changeset
   144
35151
117247018b54 added Cache_IO: cache for output of external tools,
boehmes
parents:
diff changeset
   145
end