src/Pure/Tools/simplifier_trace.ML
author wenzelm
Mon Jul 21 16:04:45 2014 +0200 (2014-07-21)
changeset 57591 8c095aef6769
parent 57041 aceaca232177
child 57592 b73d74d0e428
permissions -rw-r--r--
clarified "simp_trace_new" and corresponding isar-ref section;
wenzelm@54730
     1
(*  Title:      Pure/Tools/simplifier_trace.ML
lars@55316
     2
    Author:     Lars Hupel
wenzelm@54730
     3
wenzelm@54730
     4
Interactive Simplifier trace.
wenzelm@54730
     5
*)
wenzelm@54730
     6
wenzelm@54730
     7
signature SIMPLIFIER_TRACE =
wenzelm@54730
     8
sig
lars@55316
     9
  val add_term_breakpoint: term -> Context.generic -> Context.generic
lars@55316
    10
  val add_thm_breakpoint: thm -> Context.generic -> Context.generic
wenzelm@54730
    11
end
wenzelm@54730
    12
wenzelm@54730
    13
structure Simplifier_Trace: SIMPLIFIER_TRACE =
wenzelm@54730
    14
struct
wenzelm@54730
    15
wenzelm@55552
    16
(** context data **)
lars@55316
    17
lars@55316
    18
datatype mode = Disabled | Normal | Full
lars@55316
    19
lars@55316
    20
fun merge_modes Disabled m = m
lars@55316
    21
  | merge_modes Normal Full = Full
lars@55316
    22
  | merge_modes Normal _ = Normal
lars@55316
    23
  | merge_modes Full _ = Full
lars@55316
    24
lars@55316
    25
val empty_breakpoints =
wenzelm@55560
    26
  (Item_Net.init (op aconv) single,
lars@55316
    27
   Item_Net.init eq_rrule (single o Thm.full_prop_of o #thm))
lars@55316
    28
lars@55316
    29
fun merge_breakpoints ((term_bs1, thm_bs1), (term_bs2, thm_bs2)) =
lars@55316
    30
  (Item_Net.merge (term_bs1, term_bs2),
lars@55316
    31
   Item_Net.merge (thm_bs1, thm_bs2))
lars@55316
    32
lars@55316
    33
structure Data = Generic_Data
lars@55316
    34
(
lars@55316
    35
  type T =
lars@55316
    36
    {max_depth: int,
lars@55316
    37
     mode: mode,
lars@55316
    38
     interactive: bool,
lars@55390
    39
     memory: bool,
lars@55316
    40
     parent: int,
lars@55316
    41
     breakpoints: term Item_Net.T * rrule Item_Net.T}
lars@55316
    42
  val empty =
lars@55316
    43
    {max_depth = 10,
lars@55316
    44
     mode = Disabled,
lars@55316
    45
     interactive = false,
lars@55390
    46
     memory = true,
lars@55316
    47
     parent = 0,
lars@55316
    48
     breakpoints = empty_breakpoints}
lars@55316
    49
  val extend = I
wenzelm@55552
    50
  fun merge
wenzelm@55552
    51
    ({max_depth = max_depth1, mode = mode1, interactive = interactive1,
wenzelm@55552
    52
      memory = memory1, breakpoints = breakpoints1, ...}: T,
wenzelm@55552
    53
     {max_depth = max_depth2, mode = mode2, interactive = interactive2,
wenzelm@55552
    54
      memory = memory2, breakpoints = breakpoints2, ...}: T) =
lars@55316
    55
    {max_depth = Int.max (max_depth1, max_depth2),
lars@55316
    56
     mode = merge_modes mode1 mode2,
lars@55316
    57
     interactive = interactive1 orelse interactive2,
lars@55390
    58
     memory = memory1 andalso memory2,
lars@55316
    59
     parent = 0,
lars@55335
    60
     breakpoints = merge_breakpoints (breakpoints1, breakpoints2)}: T
lars@55316
    61
)
lars@55316
    62
lars@55316
    63
fun map_breakpoints f_term f_thm =
lars@55390
    64
  Data.map
lars@55946
    65
    (fn {max_depth, mode, interactive, parent, memory, breakpoints = (term_bs, thm_bs)} =>
lars@55390
    66
      {max_depth = max_depth,
lars@55390
    67
       mode = mode,
lars@55390
    68
       interactive = interactive,
lars@55390
    69
       memory = memory,
lars@55390
    70
       parent = parent,
lars@55390
    71
       breakpoints = (f_term term_bs, f_thm thm_bs)})
lars@55316
    72
lars@55316
    73
fun add_term_breakpoint term =
lars@55316
    74
  map_breakpoints (Item_Net.update term) I
lars@55316
    75
lars@55316
    76
fun add_thm_breakpoint thm context =
lars@55316
    77
  let
lars@55316
    78
    val rrules = mk_rrules (Context.proof_of context) [thm]
lars@55316
    79
  in
lars@55316
    80
    map_breakpoints I (fold Item_Net.update rrules) context
lars@55316
    81
  end
lars@55316
    82
lars@55316
    83
fun is_breakpoint (term, rrule) context =
lars@55316
    84
  let
lars@55316
    85
    val {breakpoints, ...} = Data.get context
lars@55316
    86
lars@55316
    87
    fun matches pattern = Pattern.matches (Context.theory_of context) (pattern, term)
lars@55316
    88
    val term_matches = filter matches (Item_Net.retrieve_matching (fst breakpoints) term)
lars@55316
    89
lars@55316
    90
    val {thm = thm, ...} = rrule
lars@55316
    91
    val thm_matches = exists (eq_rrule o pair rrule)
lars@55316
    92
      (Item_Net.retrieve_matching (snd breakpoints) (Thm.full_prop_of thm))
lars@55316
    93
  in
lars@55316
    94
    (term_matches, thm_matches)
lars@55316
    95
  end
lars@55316
    96
wenzelm@55552
    97
wenzelm@55552
    98
lars@55316
    99
(** config and attributes **)
lars@55316
   100
lars@55390
   101
fun config raw_mode interactive max_depth memory =
lars@55316
   102
  let
wenzelm@55552
   103
    val mode =
wenzelm@55552
   104
      (case raw_mode of
wenzelm@55552
   105
        "normal" => Normal
wenzelm@55552
   106
      | "full" => Full
wenzelm@55552
   107
      | _ => error ("Simplifier_Trace.config: unknown mode " ^ raw_mode))
lars@55316
   108
lars@55946
   109
    val update = Data.map (fn {parent, breakpoints, ...} =>
lars@55316
   110
      {max_depth = max_depth,
lars@55316
   111
       mode = mode,
lars@55316
   112
       interactive = interactive,
lars@55390
   113
       memory = memory,
lars@55316
   114
       parent = parent,
lars@55316
   115
       breakpoints = breakpoints})
lars@55316
   116
  in Thm.declaration_attribute (K update) end
lars@55316
   117
lars@57041
   118
fun breakpoint terms =
lars@57041
   119
  Thm.declaration_attribute (fn thm => add_thm_breakpoint thm o fold add_term_breakpoint terms)
lars@55316
   120
wenzelm@55552
   121
wenzelm@55552
   122
lars@55316
   123
(** tracing state **)
lars@55316
   124
lars@55316
   125
val futures =
lars@55316
   126
  Synchronized.var "Simplifier_Trace.futures" (Inttab.empty: string future Inttab.table)
lars@55316
   127
wenzelm@55552
   128
wenzelm@55552
   129
lars@55316
   130
(** markup **)
lars@55316
   131
lars@55316
   132
fun output_result (id, data) =
wenzelm@56333
   133
  Output.result (Markup.serial_properties id) [data]
lars@55316
   134
lars@55316
   135
val parentN = "parent"
lars@55316
   136
val textN = "text"
lars@55390
   137
val memoryN = "memory"
lars@55316
   138
val successN = "success"
lars@55316
   139
lars@55316
   140
type payload =
lars@55316
   141
  {props: Properties.T,
lars@55316
   142
   pretty: Pretty.T}
lars@55316
   143
lars@55316
   144
fun empty_payload () : payload =
lars@55316
   145
  {props = [], pretty = Pretty.str ""}
lars@55316
   146
lars@55316
   147
fun mk_generic_result markup text triggered (payload : unit -> payload) ctxt =
lars@55316
   148
  let
lars@55946
   149
    val {mode, interactive, memory, parent, ...} = Data.get (Context.Proof ctxt)
lars@55316
   150
lars@55316
   151
    val eligible =
wenzelm@55552
   152
      (case mode of
lars@55316
   153
        Disabled => false
lars@55316
   154
      | Normal => triggered
wenzelm@55552
   155
      | Full => true)
lars@55316
   156
wenzelm@55553
   157
    val markup' =
wenzelm@55553
   158
      if markup = Markup.simp_trace_stepN andalso not interactive
wenzelm@55553
   159
      then Markup.simp_trace_logN
wenzelm@55553
   160
      else markup
lars@55316
   161
  in
lars@55946
   162
    if not eligible then NONE
lars@55316
   163
    else
lars@55316
   164
      let
lars@55316
   165
        val {props = more_props, pretty} = payload ()
lars@55316
   166
        val props =
lars@55316
   167
          [(textN, text),
lars@55390
   168
           (memoryN, Markup.print_bool memory),
lars@55316
   169
           (parentN, Markup.print_int parent)]
lars@55316
   170
        val data =
lars@55316
   171
          Pretty.string_of (Pretty.markup (markup', props @ more_props) [pretty])
lars@55316
   172
      in
lars@55316
   173
        SOME (serial (), data)
lars@55316
   174
      end
lars@55316
   175
  end
lars@55316
   176
wenzelm@55552
   177
wenzelm@55552
   178
lars@55316
   179
(** tracing output **)
lars@55316
   180
lars@55316
   181
fun send_request (result_id, content) =
lars@55316
   182
  let
lars@55316
   183
    fun break () =
wenzelm@56333
   184
      (Output.protocol_message (Markup.simp_trace_cancel result_id) [];
lars@55316
   185
       Synchronized.change futures (Inttab.delete_safe result_id))
lars@55316
   186
    val promise = Future.promise break : string future
lars@55316
   187
  in
lars@55316
   188
    Synchronized.change futures (Inttab.update_new (result_id, promise));
lars@55316
   189
    output_result (result_id, content);
lars@55316
   190
    promise
lars@55316
   191
  end
lars@55316
   192
lars@55316
   193
lars@55335
   194
type data = {term: term, thm: thm, unconditional: bool, ctxt: Proof.context, rrule: rrule}
lars@55335
   195
lars@55335
   196
fun step ({term, thm, unconditional, ctxt, rrule}: data) =
lars@55316
   197
  let
lars@55316
   198
    val (matching_terms, thm_triggered) = is_breakpoint (term, rrule) (Context.Proof ctxt)
lars@55316
   199
lars@55316
   200
    val {name, ...} = rrule
lars@55316
   201
    val term_triggered = not (null matching_terms)
wenzelm@54730
   202
lars@55316
   203
    val text =
wenzelm@55552
   204
      if unconditional then "Apply rewrite rule?"
wenzelm@55552
   205
      else "Apply conditional rewrite rule?"
lars@55316
   206
lars@55316
   207
    fun payload () =
lars@55316
   208
      let
lars@55316
   209
        (* FIXME pretty printing via Proof_Context.pretty_fact *)
lars@55316
   210
        val pretty_thm = Pretty.block
lars@55316
   211
          [Pretty.str ("Instance of " ^ name ^ ":"),
lars@55316
   212
           Pretty.brk 1,
lars@55316
   213
           Syntax.pretty_term ctxt (Thm.prop_of thm)]
lars@55316
   214
lars@55316
   215
        val pretty_term = Pretty.block
lars@55316
   216
          [Pretty.str "Trying to rewrite:",
lars@55316
   217
           Pretty.brk 1,
lars@55316
   218
           Syntax.pretty_term ctxt term]
lars@55316
   219
lars@55316
   220
        val pretty_matchings =
lars@55316
   221
          let
lars@55316
   222
            val items = map (Pretty.item o single o Syntax.pretty_term ctxt) matching_terms
lars@55316
   223
          in
lars@55316
   224
            if not (null matching_terms) then
lars@55316
   225
              [Pretty.block (Pretty.fbreaks (Pretty.str "Matching terms:" :: items))]
wenzelm@55552
   226
            else []
lars@55316
   227
          end
lars@55316
   228
lars@55316
   229
        val pretty =
lars@55316
   230
          Pretty.chunks ([pretty_thm, pretty_term] @ pretty_matchings)
lars@55316
   231
      in
lars@55316
   232
        {props = [], pretty = pretty}
lars@55316
   233
      end
lars@55316
   234
lars@55946
   235
    val {max_depth, mode, interactive, memory, breakpoints, ...} =
lars@55316
   236
      Data.get (Context.Proof ctxt)
lars@55316
   237
lars@55316
   238
    fun mk_promise result =
lars@55316
   239
      let
lars@55316
   240
        val result_id = #1 result
lars@55316
   241
lars@55316
   242
        fun put mode' interactive' = Data.put
lars@55316
   243
          {max_depth = max_depth,
lars@55316
   244
           mode = mode',
lars@55316
   245
           interactive = interactive',
lars@55390
   246
           memory = memory,
lars@55316
   247
           parent = result_id,
lars@55316
   248
           breakpoints = breakpoints} (Context.Proof ctxt) |>
lars@55316
   249
          Context.the_proof
lars@55316
   250
lars@55316
   251
        fun to_response "skip" = NONE
lars@55316
   252
          | to_response "continue" = SOME (put mode true)
lars@55316
   253
          | to_response "continue_trace" = SOME (put Full true)
lars@55316
   254
          | to_response "continue_passive" = SOME (put mode false)
lars@55316
   255
          | to_response "continue_disable" = SOME (put Disabled false)
lars@55316
   256
          | to_response _ = raise Fail "Simplifier_Trace.step: invalid message"
lars@55316
   257
      in
lars@55316
   258
        if not interactive then
lars@55316
   259
          (output_result result; Future.value (SOME (put mode false)))
wenzelm@55552
   260
        else Future.map to_response (send_request result)
lars@55316
   261
      end
lars@55316
   262
lars@55316
   263
  in
wenzelm@55553
   264
    (case mk_generic_result Markup.simp_trace_stepN text
wenzelm@55553
   265
        (thm_triggered orelse term_triggered) payload ctxt of
lars@55316
   266
      NONE => Future.value (SOME ctxt)
wenzelm@55552
   267
    | SOME res => mk_promise res)
lars@55316
   268
  end
lars@55316
   269
lars@55946
   270
fun recurse text depth term ctxt =
lars@55316
   271
  let
lars@55316
   272
    fun payload () =
lars@55316
   273
      {props = [],
lars@55316
   274
       pretty = Syntax.pretty_term ctxt term}
lars@55316
   275
lars@55946
   276
    val {max_depth, mode, interactive, memory, breakpoints, ...} =
lars@55390
   277
      Data.get (Context.Proof ctxt)
lars@55316
   278
lars@55316
   279
    fun put result_id = Data.put
lars@55316
   280
      {max_depth = max_depth,
lars@55316
   281
       mode = if depth >= max_depth then Disabled else mode,
lars@55316
   282
       interactive = interactive,
lars@55390
   283
       memory = memory,
lars@55316
   284
       parent = result_id,
lars@55316
   285
       breakpoints = breakpoints} (Context.Proof ctxt)
lars@55316
   286
lars@55316
   287
    val context' =
wenzelm@55553
   288
      (case mk_generic_result Markup.simp_trace_recurseN text true payload ctxt of
wenzelm@55552
   289
        NONE => put 0
wenzelm@55552
   290
      | SOME res => (output_result res; put (#1 res)))
lars@55316
   291
  in Context.the_proof context' end
lars@55316
   292
lars@55335
   293
fun indicate_failure ({term, ctxt, thm, rrule, ...}: data) ctxt' =
lars@55316
   294
  let
lars@55316
   295
    fun payload () =
lars@55316
   296
      let
lars@55316
   297
        val {name, ...} = rrule
lars@55316
   298
        val pretty_thm =
lars@55316
   299
          (* FIXME pretty printing via Proof_Context.pretty_fact *)
lars@55316
   300
          Pretty.block
lars@55316
   301
            [Pretty.str ("In an instance of " ^ name ^ ":"),
lars@55316
   302
             Pretty.brk 1,
lars@55316
   303
             Syntax.pretty_term ctxt (Thm.prop_of thm)]
lars@55316
   304
lars@55316
   305
        val pretty_term =
lars@55316
   306
          Pretty.block
lars@55316
   307
            [Pretty.str "Was trying to rewrite:",
lars@55316
   308
             Pretty.brk 1,
lars@55316
   309
             Syntax.pretty_term ctxt term]
lars@55316
   310
lars@55316
   311
        val pretty =
lars@55316
   312
          Pretty.chunks [pretty_thm, pretty_term]
lars@55316
   313
      in
lars@55316
   314
        {props = [(successN, "false")], pretty = pretty}
lars@55316
   315
      end
lars@55316
   316
lars@55316
   317
    val {interactive, ...} = Data.get (Context.Proof ctxt)
lars@55316
   318
lars@55316
   319
    fun mk_promise result =
lars@55316
   320
      let
wenzelm@55552
   321
        fun to_response "exit" = false
lars@55316
   322
          | to_response "redo" =
lars@55316
   323
              (Option.app output_result
wenzelm@55553
   324
                (mk_generic_result Markup.simp_trace_ignoreN "Ignore" true empty_payload ctxt');
lars@55316
   325
               true)
wenzelm@55552
   326
          | to_response _ = raise Fail "Simplifier_Trace.indicate_failure: invalid message"
lars@55316
   327
      in
lars@55316
   328
        if not interactive then
lars@55316
   329
          (output_result result; Future.value false)
wenzelm@55552
   330
        else Future.map to_response (send_request result)
lars@55316
   331
      end
lars@55316
   332
  in
wenzelm@55553
   333
    (case mk_generic_result Markup.simp_trace_hintN "Step failed" true payload ctxt' of
lars@55316
   334
      NONE => Future.value false
wenzelm@55552
   335
    | SOME res => mk_promise res)
lars@55316
   336
  end
lars@55316
   337
lars@55316
   338
fun indicate_success thm ctxt =
lars@55316
   339
  let
lars@55316
   340
    fun payload () =
lars@55316
   341
      {props = [(successN, "true")],
lars@55316
   342
       pretty = Syntax.pretty_term ctxt (Thm.prop_of thm)}
lars@55316
   343
  in
wenzelm@55553
   344
    Option.app output_result
wenzelm@55553
   345
      (mk_generic_result Markup.simp_trace_hintN "Successfully rewrote" true payload ctxt)
lars@55316
   346
  end
lars@55316
   347
wenzelm@55552
   348
wenzelm@55552
   349
lars@55316
   350
(** setup **)
lars@55316
   351
lars@55390
   352
fun simp_apply args ctxt cont =
lars@55316
   353
  let
lars@55316
   354
    val {unconditional: bool, term: term, thm: thm, rrule: rrule} = args
lars@55316
   355
    val data =
lars@55316
   356
      {term = term,
lars@55316
   357
       unconditional = unconditional,
lars@55316
   358
       ctxt = ctxt,
lars@55316
   359
       thm = thm,
lars@55316
   360
       rrule = rrule}
lars@55316
   361
  in
wenzelm@55552
   362
    (case Future.join (step data) of
wenzelm@55552
   363
      NONE => NONE
lars@55316
   364
    | SOME ctxt' =>
lars@55316
   365
        let val res = cont ctxt' in
wenzelm@55552
   366
          (case res of
lars@55316
   367
            NONE =>
lars@55316
   368
              if Future.join (indicate_failure data ctxt') then
lars@55390
   369
                simp_apply args ctxt cont
wenzelm@55552
   370
              else NONE
wenzelm@55552
   371
          | SOME (thm, _) => (indicate_success thm ctxt'; res))
wenzelm@55552
   372
        end)
lars@55316
   373
  end
lars@55316
   374
lars@55316
   375
val _ = Session.protocol_handler "isabelle.Simplifier_Trace$Handler"
wenzelm@54730
   376
wenzelm@54730
   377
val _ = Theory.setup
wenzelm@54731
   378
  (Simplifier.set_trace_ops
lars@55946
   379
    {trace_invoke = fn {depth, term} => recurse "Simplifier invoked" depth term,
lars@55390
   380
     trace_apply = simp_apply})
lars@55316
   381
lars@55316
   382
val _ =
wenzelm@55553
   383
  Isabelle_Process.protocol_command "Simplifier_Trace.reply"
lars@55316
   384
    (fn [s, r] =>
lars@55316
   385
      let
lars@55316
   386
        val serial = Markup.parse_int s
lars@55316
   387
        fun lookup_delete tab =
lars@55316
   388
          (Inttab.lookup tab serial, Inttab.delete_safe serial tab)
lars@55316
   389
        fun apply_result (SOME promise) = Future.fulfill promise r
lars@55316
   390
          | apply_result NONE = () (* FIXME handle protocol failure, just like in active.ML? *)
lars@55316
   391
      in
lars@55316
   392
        (Synchronized.change_result futures lookup_delete |> apply_result)
lars@55316
   393
          handle exn => if Exn.is_interrupt exn then () (*sic!*) else reraise exn
lars@55316
   394
      end)
lars@55316
   395
wenzelm@55552
   396
wenzelm@55552
   397
lars@55316
   398
(** attributes **)
lars@55316
   399
wenzelm@55560
   400
val mode_parser =
lars@55316
   401
  Scan.optional
lars@55316
   402
    (Args.$$$ "mode" |-- Args.$$$ "=" |-- (Args.$$$ "normal" || Args.$$$ "full"))
lars@55316
   403
    "normal"
wenzelm@54730
   404
wenzelm@55560
   405
val interactive_parser =
lars@55316
   406
  Scan.optional (Args.$$$ "interactive" >> K true) false
lars@55316
   407
wenzelm@55560
   408
val memory_parser =
lars@55390
   409
  Scan.optional (Args.$$$ "no_memory" >> K false) true
lars@55390
   410
lars@55316
   411
val depth_parser =
lars@55316
   412
  Scan.optional (Args.$$$ "depth" |-- Args.$$$ "=" |-- Parse.nat) 10
lars@55316
   413
lars@55316
   414
val config_parser =
lars@55390
   415
  (interactive_parser -- mode_parser -- depth_parser -- memory_parser) >>
lars@55390
   416
    (fn (((interactive, mode), depth), memory) => config mode interactive depth memory)
wenzelm@54730
   417
lars@55316
   418
val _ = Theory.setup
lars@57041
   419
  (Attrib.setup @{binding simp_break}
lars@57041
   420
    (Scan.repeat Args.term_pattern >> breakpoint)
lars@57041
   421
    "declaration of a simplifier breakpoint" #>
wenzelm@57591
   422
   Attrib.setup @{binding simp_trace_new} (Scan.lift config_parser)
lars@55316
   423
    "simplifier trace configuration")
wenzelm@54730
   424
wenzelm@54730
   425
end