Source file interpreter_event.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2022 TriliTech <contact@trili.tech>                         *)
(*                                                                           *)
(* Permission is hereby granted, free of charge, to any person obtaining a   *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense,  *)
(* and/or sell copies of the Software, and to permit persons to whom the     *)
(* Software is furnished to do so, subject to the following conditions:      *)
(*                                                                           *)
(* The above copyright notice and this permission notice shall be included   *)
(* in all copies or substantial portions of the Software.                    *)
(*                                                                           *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL   *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING   *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER       *)
(* DEALINGS IN THE SOFTWARE.                                                 *)
(*                                                                           *)
(*****************************************************************************)

module Simple = struct
  include Internal_event.Simple

  let section = ["sc_rollup_node"; "interpreter"]

  let transitioned_pvm =
    declare_4
      ~section
      ~name:"sc_rollup_node_interpreter_transitioned_pvm"
      ~msg:
        "Transitioned PVM at inbox level {inbox_level} to {state_hash} at tick \
         {ticks} with {num_messages} messages"
      ~level:Notice
      ("inbox_level", Data_encoding.int32)
      ("state_hash", State_hash.encoding)
      ("ticks", Data_encoding.z)
      ("num_messages", Data_encoding.int31)

  let intended_failure =
    declare_4
      ~section
      ~name:"sc_rollup_node_interpreter_intended_failure"
      ~msg:
        "Intended failure at level {level} for message indexed {message_index} \
         and at the tick {message_tick} of message processing (internal = \
         {internal})."
      ~level:Notice
      ("level", Data_encoding.int31)
      ("message_index", Data_encoding.int31)
      ("message_tick", Data_encoding.int64)
      ("internal", Data_encoding.bool)
end

(** [transition_pvm inbox_level hash tick n] emits the event that a PVM
   transition is leading to the state of the given [hash] by
   processing [n] messages at [tick]. *)
let transitioned_pvm inbox_level hash tick num_messages =
  Simple.(emit transitioned_pvm (inbox_level, hash, tick, num_messages))

(** [intended_failure level message_index message_tick internal] emits
   the event that an intended failure has been injected at some given
   [level], during the processing of a given [message_index] and at
   tick [message_tick] during this message processing. [internal] is
   [true] if the failure is injected in a PVM internal
   step. [internal] is [false] if the failure is injected in the input
   to the PVM. *)
let intended_failure ~level ~message_index ~message_tick ~internal =
  Simple.(emit intended_failure (level, message_index, message_tick, internal))