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