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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
define_callback_attributes!(
    "Called before translation of each basic block.

    Callback ID: PANDA_CB_BEFORE_BLOCK_TRANSLATE
    
    Arguments:
     CPUState *env:   the current CPU state
     target_ptr_t pc: the guest PC we are about to translate
    
    Helper call location: cpu-exec.c
    
    Return value:
     none
    "
    (before_block_translate, panda_cb_type_PANDA_CB_BEFORE_BLOCK_TRANSLATE, (cpu: &mut CPUState, pc: target_ptr_t)),
    "Called after execution of every basic block.
    If exitCode > TB_EXIT_IDX1, then the block exited early.

    Callback ID: PANDA_CB_AFTER_BLOCK_EXEC

       after_block_exec:

       Arguments:
        CPUState *env:        the current CPU state
        TranslationBlock *tb: the TB we just executed
        uint8_t exitCode:     why the block execution exited

       Helper call location: cpu-exec.c

       Return value:
        none
    "
    (after_block_translate, panda_cb_type_PANDA_CB_AFTER_BLOCK_TRANSLATE, (cpu: &mut CPUState, tb: &mut TranslationBlock)),
    "Called before execution of every basic block, with the option
        to invalidate the TB.

    Callback ID: PANDA_CB_BEFORE_BLOCK_EXEC_INVALIDATE_OPT

       before_block_exec_invalidate_opt:

       Arguments:
        CPUState *env:        the current CPU state
        TranslationBlock *tb: the TB we are about to execute

       Helper call location: cpu-exec.c (indirectly)

       Return value:
        true if we should invalidate the current translation block
        and retranslate, false otherwise.
    "
    (before_block_exec_invalidate_opt, panda_cb_type_PANDA_CB_BEFORE_BLOCK_EXEC_INVALIDATE_OPT, (cpu: &mut CPUState, tb: &mut TranslationBlock) -> bool),
    "Called before execution of every basic block.

    Callback ID: PANDA_CB_BEFORE_BLOCK_EXEC

       Arguments:
        CPUState *env:        the current CPU state
        TranslationBlock *tb: the TB we are about to execute

       Helper call location: cpu-exec.c

       Return value:
        none
    "
    (before_block_exec, panda_cb_type_PANDA_CB_BEFORE_BLOCK_EXEC, (cpu: &mut CPUState, tb: &mut TranslationBlock)),
    "Called after execution of every basic block.
        If exitCode > TB_EXIT_IDX1, then the block exited early.

    Callback ID: PANDA_CB_AFTER_BLOCK_EXEC

       Arguments:
        CPUState *env:        the current CPU state
        TranslationBlock *tb: the TB we just executed
        uint8_t exitCode:     why the block execution exited

       Helper call location: cpu-exec.c

       Return value:
        none
    "
    (after_block_exec, panda_cb_type_PANDA_CB_AFTER_BLOCK_EXEC, (cpu: &mut CPUState, tb: &mut TranslationBlock, exit_code: u8)),
    "Called before the translation of each instruction.

    Callback ID: PANDA_CB_INSN_TRANSLATE

       Arguments:
        CPUState *env:   the current CPU state
        target_ptr_t pc: the guest PC we are about to translate

       Helper call location: panda/target/ARCH/translate.c

       Return value:
        true if PANDA should insert instrumentation into the generated code,
        false otherwise

       Notes:
        This allows a plugin writer to instrument only a small number of
        instructions, avoiding the performance hit of instrumenting everything.
        If you do want to instrument every single instruction, just return
        true. See the documentation for PANDA_CB_INSN_EXEC for more detail.
    "
    (insn_translate, panda_cb_type_PANDA_CB_INSN_TRANSLATE, (cpu: &mut CPUState, pc: target_ptr_t) -> bool),
    "Called before execution of any instruction identified by the
        PANDA_CB_INSN_TRANSLATE callback.

    Callback ID: PANDA_CB_INSN_EXEC

       Arguments:
        CPUState *env:   the current CPU state
        target_ptr_t pc: the guest PC we are about to execute

       Helper call location: TBA

       Return value:
        unused

       Notes:
        This instrumentation is implemented by generating a call to a
        helper function just before the instruction itself is generated.
        This is fairly expensive, which is why it's only enabled via
        the PANDA_CB_INSN_TRANSLATE callback.
    "
    (insn_exec, panda_cb_type_PANDA_CB_INSN_EXEC, (cpu: &mut CPUState, pc: target_ptr_t)),
    "Called after the translation of each instruction.

    Callback ID: PANDA_CB_AFTER_INSN_TRANSLATE

       Arguments:
        CPUState *env:   the current CPU state
        target_ptr_t pc: the next guest PC we've translated

       Helper call location: panda/target/ARCH/translate.c

       Return value:
        true if PANDA should insert instrumentation into the generated code,
        false otherwise

       Notes:
        See `insn_translate`, callbacks are registered via PANDA_CB_AFTER_INSN_EXEC
    "
    (after_insn_translate, panda_cb_type_PANDA_CB_AFTER_INSN_TRANSLATE, (cpu: &mut CPUState, pc: target_ptr_t) -> bool),
    "Called after execution of an instruction identified by the
        PANDA_CB_AFTER_INSN_TRANSLATE callback

    Callback ID: PANDA_CB_AFTER_INSN_EXEC

       Arguments:
        CPUState *env:   the current CPU state
        target_ptr_t pc: the next guest PC already executed

       Helper call location: TBA

       Return value:
        unused

       Notes:
        See `insn_exec`. Enabled via the PANDA_CB_AFTER_INSN_TRANSLATE callback.
    "
    (after_insn_exec, panda_cb_type_PANDA_CB_AFTER_INSN_EXEC, (cpu: &mut CPUState, pc: target_ptr_t)),
    "Called before memory is read.

    Callback ID: PANDA_CB_VIRT_MEM_BEFORE_READ

       Arguments:
        CPUState *env:     the current CPU state
        target_ptr_t pc:   the guest PC doing the read
        target_ptr_t addr: the (virtual) address being read
        size_t size:       the size of the read

       Helper call location: TBA

       Return value:
        none
    "
    (virt_mem_before_read, panda_cb_type_PANDA_CB_VIRT_MEM_BEFORE_READ, (cpu: &mut CPUState, pc: target_ptr_t, addr: target_ptr_t, size: usize)),
    "Called before memory is written.

    Callback ID: PANDA_CB_VIRT_MEM_BEFORE_WRITE

       Arguments:
        CPUState *env:     the current CPU state
        target_ptr_t pc:   the guest PC doing the write
        target_ptr_t addr: the (virtual) address being written
        size_t size:       the size of the write
        uint8_t *buf:      pointer to the data that is to be written

       Helper call location: TBA

       Return value:
        none
    "
    (virt_mem_before_write, panda_cb_type_PANDA_CB_VIRT_MEM_BEFORE_WRITE, (cpu: &mut CPUState, pc: target_ptr_t, addr: target_ptr_t, size: usize, buf: *mut u8)),
    "Called after memory is read.

    Callback ID: PANDA_CB_PHYS_MEM_BEFORE_READ

       Arguments:
        CPUState *env:     the current CPU state
        target_ptr_t pc:   the guest PC doing the read
        target_ptr_t addr: the (physical) address being read
        size_t size:       the size of the read

       Helper call location: TBA

       Return value:
        none
    "
    (phys_mem_before_read, panda_cb_type_PANDA_CB_PHYS_MEM_BEFORE_READ, (cpu: &mut CPUState, pc: target_ptr_t, addr: target_ptr_t, size: usize)),
    "Called before memory is written.

    Callback ID: PANDA_CB_PHYS_MEM_BEFORE_WRITE

       Arguments:
        CPUState *env:     the current CPU state
        target_ptr_t pc:   the guest PC doing the write
        target_ptr_t addr: the (physical) address being written
        size_t size:       the size of the write
        uint8_t *buf:      pointer to the data that is to be written

       Helper call location: TBA

       Return value:
        none
    "
    (phys_mem_before_write, panda_cb_type_PANDA_CB_PHYS_MEM_BEFORE_WRITE, (cpu: &mut CPUState, pc: target_ptr_t, addr: target_ptr_t, size: usize, buf: *mut u8)),
    "Called after memory is read.

    Callback ID: PANDA_CB_VIRT_MEM_AFTER_READ

       Arguments:
        CPUState *env:     the current CPU state
        target_ptr_t pc:   the guest PC doing the read
        target_ptr_t addr: the (virtual) address being read
        size_t size:       the size of the read
        uint8_t *buf:      pointer to data just read

       Helper call location: TBA

       Return value:
        none
    "
    (virt_mem_after_read, panda_cb_type_PANDA_CB_VIRT_MEM_AFTER_READ, (cpu: &mut CPUState, pc: target_ptr_t, addr: target_ptr_t, size: usize, buf: *mut u8)),
    "Called after memory is written.

    Callback ID: PANDA_CB_VIRT_MEM_AFTER_WRITE

       Arguments:
        CPUState *env:     the current CPU state
        target_ptr_t pc:   the guest PC doing the write
        target_ptr_t addr: the (virtual) address being written
        size_t size:       the size of the write
        uint8_t *buf:      pointer to the data that was written

       Helper call location: TBA

       Return value:
        none
    "
    (virt_mem_after_write, panda_cb_type_PANDA_CB_VIRT_MEM_AFTER_WRITE, (cpu: &mut CPUState, pc: target_ptr_t, addr: target_ptr_t, size: usize, buf: *mut u8)),

    "Called after memory is read.

    Callback ID: PANDA_CB_PHYS_MEM_AFTER_READ

       Arguments:
        CPUState *env:     the current CPU state
        target_ptr_t pc:   the guest PC doing the read
        target_ptr_t addr: the (physical) address being read
        size_t size:       the size of the read
        uint8_t *buf:      pointer to data just read

       Helper call location: TBA

       Return value:
        none
    "
    (phys_mem_after_read, panda_cb_type_PANDA_CB_PHYS_MEM_AFTER_READ, (cpu: &mut CPUState, pc: target_ptr_t, addr: target_ptr_t, size: usize, buf: *mut u8)),
    "Called after memory is written.

    Callback ID: PANDA_CB_PHYS_MEM_AFTER_WRITE

       Arguments:
        CPUState *env:     the current CPU state
        target_ptr_t pc:   the guest PC doing the write
        target_ptr_t addr: the (physical) address being written
        size_t size:       the size of the write
        uint8_t *buf:      pointer to the data that was written

       Helper call location: TBA

       Return value:
        none
    "
    (phys_mem_after_write, panda_cb_type_PANDA_CB_PHYS_MEM_AFTER_WRITE, (cpu: &mut CPUState, pc: target_ptr_t, addr: target_ptr_t, size: usize, buf: *mut u8)),
    "Called after MMIO memory is read.

    Callback ID: PANDA_CB_MMIO_AFTER_READ

       Arguments:
        CPUState *env:          the current CPU state
        target_ptr_t physaddr:  the physical address being read from
        target_ptr_t vaddr:     the virtual address being read from
        size_t size:            the size of the read
        uin64_t *val:           the value being read

       Helper call location: cputlb.c

       Return value:
        none
    "
    (mmio_after_read, panda_cb_type_PANDA_CB_MMIO_AFTER_READ, (cpu: &mut CPUState, phys_addr: target_ptr_t, virt_addr: target_ptr_t, size: usize, value: *mut u64)),
    "Called after MMIO memory is written to.

    Callback ID: PANDA_CB_MMIO_BEFORE_WRITE

       Arguments:
        CPUState *env:          the current CPU state
        target_ptr_t physaddr:  the physical address being written to
        target_ptr_t vaddr:     the virtual address being written to
        size_t size:            the size of the write
        uin64_t *val:           the value being written

       Helper call location: cputlb.c

       Return value:
        none
    "
    (mmio_before_write, panda_cb_type_PANDA_CB_MMIO_BEFORE_WRITE, (cpu: &mut CPUState, phys_addr: target_ptr_t, virt_addr: target_ptr_t, size: usize, value: *mut u64)),
    "Called when there is a hard drive read

    Callback ID: PANDA_CB_HD_READ

       Note: this was added to panda_cb_type enum but no callback prototype inserted
       Here is a stub.  I'm not sure what the args should be.
       Arguments
       CPUState *env
    "
    (hd_read, panda_cb_type_PANDA_CB_HD_READ, (cpu: &mut CPUState)),
    "Called when there is a hard drive write

    Callback ID: PANDA_CB_HD_WRITE

       Note: this was added to panda_cb_type enum but no callback prototype inserted
       Here is a stub.  I'm not sure what the args should be.
       Arguments
       CPUState *env
    "
    (hd_write, panda_cb_type_PANDA_CB_HD_WRITE, (cpu: &mut CPUState)),
    "Called when a program inside the guest makes a hypercall to pass
        information from inside the guest to a plugin

    Callback ID: PANDA_CB_GUEST_HYPERCALL

       Arguments:
        CPUState *env: the current CPU state

       Helper call location: target/i386/misc_helper.c

       Return value:
        true if the callback has processed the hypercall, false if the
        hypercall has been ignored.

       Notes:
        On x86, this is called whenever CPUID is executed. On ARM, the
        MCR instructions is used. Plugins should check for magic values
        in the registers to determine if it really is a guest hypercall.
        Parameters can be passed in other registers. If the plugin
        processes the hypercall, it should return true so the execution
        of the normal instruction is skipped.
    "
    (guest_hypercall, panda_cb_type_PANDA_CB_GUEST_HYPERCALL, (cpu: &mut CPUState) -> bool),
    "Called when someone uses the plugin_cmd monitor command.

    Callback ID: PANDA_CB_MONITOR

       Arguments:
        Monitor *mon:    a pointer to the Monitor
        const char *cmd: the command string passed to plugin_cmd

       Helper call location: TBA

       Return value:
        unused

       Notes:
        The command is passed as a single string. No parsing is performed
        on the string before it is passed to the plugin, so each plugin
        must parse the string as it deems appropriate (e.g. by using strtok
        and getopt) to do more complex option processing.
        It is recommended that each plugin implementing this callback respond
        to the \"help\" message by listing the commands supported by the plugin.
        Note that every loaded plugin will have the opportunity to respond to
        each plugin_cmd; thus it is a good idea to ensure that your plugin's
        monitor commands are uniquely named, e.g. by using the plugin name
        as a prefix (\"sample_do_foo\" rather than \"do_foo\").
    "
    (monitor, panda_cb_type_PANDA_CB_MONITOR, (monitor: &mut Monitor, cmd: *const u8)),
    "Called inside of cpu_restore_state(), when there is a CPU
        fault/exception.

    Callback ID: PANDA_CB_CPU_RESTORE_STATE

       Arguments:
        CPUState *env:        the current CPU state
        TranslationBlock *tb: the current translation block

       Helper call location: translate-all.c

       Return value:
        none
    "
    (cpu_restore_state, panda_cb_type_PANDA_CB_CPU_RESTORE_STATE, (cpu: &mut CPUState, tb: &mut TranslationBlock)),
    "Called at start of replay, before loadvm is called. This allows
        us to hook devices' loadvm handlers. Remember to unregister the
        existing handler for the device first. See the example in the
        sample plugin.

    Callback ID: PANDA_CB_BEFORE_LOADVM

       Arguments:
        none

       Helper call location: TBA

       Return value:
        unused
    "
    (before_loadvm, panda_cb_type_PANDA_CB_BEFORE_LOADVM, ()),
    "Called when asid changes.

    Callback ID: PANDA_CB_ASID_CHANGED

       Arguments:
        CPUState *env:       pointer to CPUState
        target_ptr_t oldval: old asid value
        target_ptr_t newval: new asid value

       Helper call location: target/i386/helper.c, target/arm/helper.c

       Return value:
        true if the asid should be prevented from being changed
        false otherwise

       Notes:
        The callback is only invoked implemented for x86 and ARM.
        This should break plugins which rely on it to detect context
        switches in any other architecture.
    "
    (asid_changed, panda_cb_type_PANDA_CB_ASID_CHANGED, (cpu: &mut CPUState, old_asid: target_ptr_t, new_asid: target_ptr_t) -> bool),
    "In replay only. Some kind of data transfer involving hard drive.

    Callback ID:     PANDA_CB_REPLAY_HD_TRANSFER,

       Arguments:
        CPUState *env:          pointer to CPUState
        uint32_t type:          type of transfer  (Hd_transfer_type)
        target_ptr_t src_addr:  address for src
        target_ptr_t dest_addr: address for dest
        size_t num_bytes:       size of transfer in bytes

       Helper call location: panda/src/rr/rr_log.c

       Return value:
        none

       Helper call location: TBA

       Notes:
        Unlike most callbacks, this is neither a \"before\" or \"after\" callback.
        In replay the transfer doesn't really happen. We are *at* the point at
        which it happened, really.
    "
    (replay_hd_transfer, panda_cb_type_PANDA_CB_REPLAY_HD_TRANSFER, (cpu: &mut CPUState, kind: u32, src: target_ptr_t, dest: target_ptr_t, num_bytes: usize)),
    "In replay only, some kind of data transfer within the network card
       (currently, only the E1000 is supported).

    Callback ID:     PANDA_CB_REPLAY_NET_TRANSFER,

       Arguments:
        CPUState *env:          pointer to CPUState
        uint32_t type:          type of transfer  (Net_transfer_type)
        uint64_t src_addr:      address for src
        uint64_t dest_addr:     address for dest
        size_t num_bytes:       size of transfer in bytes

       Helper call location: panda/src/rr/rr_log.c

       Return value:
        none

       Notes:
        Unlike most callbacks, this is neither a \"before\" or \"after\" callback.
        In replay the transfer doesn't really happen. We are *at* the point at
        which it happened, really.
        Also, the src_addr and dest_addr may be for either host (ie. a location
        in the emulated network device) or guest, depending upon the type.
    "
    (replay_net_transfer, panda_cb_type_PANDA_CB_REPLAY_NET_TRANSFER, (cpu: &mut CPUState, kind: u32, src: u64, dest: u64, size: usize)),
    "In replay only, called when a byte is received on the serial port.

    Callback ID:     PANDA_CB_REPLAY_SERIAL_RECEIVE,

       Arguments:
        CPUState *env:          pointer to CPUState
        target_ptr_t fifo_addr: address of the data within the fifo
        uint8_t value:          value received

       Helper call location: panda/src/rr/rr_log.c

       Return value:
        unused
    "
    (replay_serial_receive, panda_cb_type_PANDA_CB_REPLAY_SERIAL_RECEIVE, (cpu: &mut CPUState, fifo_addr: target_ptr_t, value: u8)),
    "In replay only, called when a byte read from the serial RX FIFO

    Callback ID:     PANDA_CB_REPLAY_SERIAL_READ,

       Arguments:
        CPUState *env:          pointer to CPUState
        target_ptr_t fifo_addr: address of the data within the fifo (source)
        uint32_t port_addr:     address of the IO port where data is being read (destination)
        uint8_t value:          value read

       Helper call location: panda/src/rr/rr_log.c

       Return value:
        none
    "
    (replay_serial_read, panda_cb_type_PANDA_CB_REPLAY_SERIAL_READ, (cpu: &mut CPUState, fifo_addr: target_ptr_t, port_addr: u32, value: u8)),
    "In replay only, called when a byte is sent on the serial port.

    Callback ID:     PANDA_CB_REPLAY_SERIAL_SEND,

       Arguments:
        CPUState *env:          pointer to CPUState
        target_ptr_t fifo_addr: address of the data within the fifo
        uint8_t value:          value received

       Helper call location: panda/src/rr/rr_log.c

       Return value:
        none
    "
    (replay_serial_send, panda_cb_type_PANDA_CB_REPLAY_SERIAL_SEND, (cpu: &mut CPUState, fifo_addr: target_ptr_t, value: u8)),
    "In replay only, called when a byte written to the serial TX FIFO

    Callback ID:     PANDA_CB_REPLAY_SERIAL_WRITE,


       Arguments:
        CPUState *env:          pointer to CPUState
        target_ptr_t fifo_addr: address of the data within the fifo (source)
        uint32_t port_addr:     address of the IO port where data is being read (destination)
        uint8_t value:          value read

       Helper call location: panda/src/rr/rr_log.c

       Return value:
        none
    "
    (replay_serial_write, panda_cb_type_PANDA_CB_REPLAY_SERIAL_WRITE, (cpu: &mut CPUState, fifo_addr: target_ptr_t, port_addr: u32, value: u8)),
    "In replay only. We are about to dma between qemu buffer and
        guest memory.

    Callback ID:     PANDA_CB_REPLAY_BEFORE_DMA,

       Arguments:
        CPUState *env:      pointer to CPUState
        const uint8_t *buf: pointer to the QEMU's device buffer ussed in the transfer
        hwaddr addr:        address written to in the guest RAM
        size_t size:        size of transfer
        bool is_write:      indicates whether the DMA transfer writes to memory

       Helper call location: exec.c

       Return value:
        none
    "
    (replay_before_dma, panda_cb_type_PANDA_CB_REPLAY_BEFORE_DMA, (cpu: &mut CPUState, buf: *const u8, addr: hwaddr, size: usize, is_write: bool)),
    "In replay only, we are about to dma between qemu buffer and guest memory

    Callback ID:     PANDA_CB_REPLAY_AFTER_DMA,

       Arguments:
        CPUState *env:      pointer to CPUState
        const uint8_t *buf: pointer to the QEMU's device buffer ussed in the transfer
        hwaddr addr:        address written to in the guest RAM
        size_t size:        size of transfer
        bool is_write:      indicates whether the DMA transfer writes to memory

       Helper call location: exec.c

       Return value:
        none
    "
    (replay_after_dma, panda_cb_type_PANDA_CB_REPLAY_AFTER_DMA, (cpu: &mut CPUState, buf: *mut u8, addr: hwaddr, size: usize, is_write: bool)),
    "In replay only, we have a packet (incoming / outgoing) in hand.

    Callback ID:   PANDA_CB_REPLAY_HANDLE_PACKET,

       Arguments:
        CPUState *env:         pointer to CPUState
        uint8_t *buf:          buffer containing packet data
        size_t size:           num bytes in buffer
        uint8_t direction:     either `PANDA_NET_RX` or `PANDA_NET_TX`
        uint64_t buf_addr_rec: the address of `buf` at the time of recording

       Helper call location: panda/src/rr/rr_log.c

       Return value:
        none

       Notes:
        `buf_addr_rec` corresponds to the address of the device buffer of
        the emulated NIC. I.e. it is the address of a VM-host-side buffer.
        It is useful for implementing network tainting in an OS-agnostic
        way, in conjunction with taint2_label_io().

        FIXME: The `buf_addr_rec` maps to the `uint8_t *buf` field of the
        internal `RR_handle_packet_args` struct. The field is dumped/loaded
        to/from the trace without proper serialization/deserialization. As
        a result, a 64bit build of PANDA will not be able to process traces
        produced by a 32bit of PANDA, and vice-versa.
        There are more internal structs that suffer from the same issue.
        This is an oversight that will eventually be fixed. But as the
        real impact is minimal (virtually nobody uses 32bit builds),
        the fix has a very low priority in the bugfix list.
    "
    (replay_handle_packet, panda_cb_type_PANDA_CB_REPLAY_HANDLE_PACKET, (cpu: &mut CPUState, buf: *mut u8, size: usize, direction: u8, buf_addr_rc: u64)),
    "Called after cpu_exec calls cpu_exec_enter function.

    Callback ID: PANDA_CB_AFTER_CPU_EXEC_ENTER

       Arguments:
        CPUState *env: the current CPU state

       Helper call location: cpu-exec.c

       Return value:
        none
    "
    (after_cpu_exec_enter, panda_cb_type_PANDA_CB_AFTER_CPU_EXEC_ENTER, (cpu: &mut CPUState)),
    "Called before cpu_exec calls cpu_exec_exit function.

    Callback ID: PANDA_CB_BEFORE_CPU_EXEC_EXIT

       Arguments:
        CPUState *env: the current CPU state
        bool ranBlock: true if ran a block since previous cpu_exec_enter

       Helper call location: cpu-exec.c

       Return value:
        none
    "
    (before_cpu_exec_exit, panda_cb_type_PANDA_CB_BEFORE_CPU_EXEC_EXIT, (cpu: &mut CPUState, ran_block: bool)),
    "Called right after the machine has been initialized, but before
        any guest code runs.

    Callback ID:     PANDA_CB_AFTER_MACHINE_INIT

       Arguments:
        void *cpu_env: pointer to CPUState

       Helper call location: TBA

       Return value:
        none

       Notes:
        This callback allows initialization of components that need
        access to the RAM, CPU object, etc. E.g. for the taint2 plugin,
        this is the appropriate place to call taint2_enable_taint().
    "
    (after_machine_init, panda_cb_type_PANDA_CB_AFTER_MACHINE_INIT, (cpu: &mut CPUState)),
    "Called right after a snapshot has been loaded (either with loadvm or replay initialization),
        but before any guest code runs.

    Callback ID:     PANDA_CB_AFTER_LOADVM

       Arguments:
        void *cpu_env: pointer to CPUState

       Return value:
        none

    "
    (after_loadvm, panda_cb_type_PANDA_CB_AFTER_LOADVM, (cpu: &mut CPUState)),
    "Called at the top of the loop that manages emulation.

    Callback ID:     PANDA_CB_TOP_LOOP

       Arguments:
        CPUState *env:          pointer to CPUState

       Helper call location: cpus.c

       Return value:
        unused
     "
    (top_loop, panda_cb_type_PANDA_CB_TOP_LOOP, (cpu: &mut CPUState)),
    "Called in the middle of machine initialization

    Callback ID:     PANDA_CB_DURING_MACHINE_INIT

       Arguments:
         MachineState *machine: pointer to the machine state

       Return value:
         None
     "
    (during_machine_init, panda_cb_type_PANDA_CB_DURING_MACHINE_INIT, (machine: &mut MachineState)),
    "Called in IO thread in place where monitor cmds are processed

    Callback ID:     PANDA_CB_MAIN_LOOP_WAIT

       Arguments:
         None

       Return value:
         None
     "
    (main_loop_wait, panda_cb_type_PANDA_CB_MAIN_LOOP_WAIT, ()),
    "Called just before qemu shuts down

    Callback ID:     PANDA_CB_PRE_SHUTDOWN


       Arguments:
         None

       Return value:
         None
     "
    (pre_shutdown, panda_cb_type_PANDA_CB_PRE_SHUTDOWN, ()),
    "Called when the guest attempts to read from an unmapped peripheral via MMIO

    Callback ID:     PANDA_CB_UNASSIGNED_IO_WRITE

       Arguments:
         pc: Guest program counter at time of write
         addr: Physical address written to
         size: Size of write
         val: Pointer to a buffer that will be passed to the guest as the result of the read

       Return value:
         True if value read was changed by a PANDA plugin and should be returned
         False if error-logic (invalid write) should be run
     "
    (unassigned_io_read, panda_cb_type_PANDA_CB_UNASSIGNED_IO_READ, (cpu: &mut CPUState, pc: target_ptr_t, addr: hwaddr, size: usize, val: u64) -> bool),
    "Called when the guest attempts to write to an unmapped peripheral via MMIO

    Callback ID:     PANDA_CB_UNASSIGNED_IO_WRITE

       Arguments:
         pc: Guest program counter at time of write
         addr: Physical address written to
         size: Size of write
         val: Data being written, up to 8 bytes

       Return value:
         True if the write should be allowed without error
         False if normal behavior should be used (error-logic)
     "
    (unassigned_io_write, panda_cb_type_PANDA_CB_UNASSIGNED_IO_WRITE, (cpu: &mut CPUState, pc: target_ptr_t, addr: hwaddr, size: usize, val: u64) -> bool),
    "Called just before we are about to handle an exception.
    
    Callback ID:     PANDA_CB_BEFORE_HANDLE_EXCEPTION 

       Note: only called for cpu->exception_index > 0

       Aguments:
         exception_index (the current exception number)

       Return value:
         a new exception_index.

       Note: There might be more than one callback for this location.
       First callback that returns an exception index that *differs*
       from the one passed as an arg wins. That is what we return as
       the new exception index, which will replace
       cpu->exception_index
     "
    (before_handle_exception, panda_cb_type_PANDA_CB_BEFORE_HANDLE_EXCEPTION, (cpu: &mut CPUState, exception_index: i32) -> i32),
    (before_handle_interrupt, panda_cb_type_PANDA_CB_BEFORE_HANDLE_INTERRUPT, (cpu: &mut CPUState, exception_index: i32) -> i32),

    " Callback ID: PANDA_CB_START_BLOCK_EXEC

       start_block_exec:
        This is like before_block_exec except its part of the TCG stream.

       Arguments:
        CPUState *env:        the current CPU state
        TranslationBlock *tb: the TB we are executing

       Helper call location: cpu-exec.c

       Return value:
        none
    "

    (start_block_exec, panda_cb_type_PANDA_CB_START_BLOCK_EXEC,(cpu: &mut CPUState, tb: &mut TranslationBlock)),

    "Callback ID: PANDA_CB_END_BLOCK_EXEC

       end_block_exec:
        This is like after_block_exec except its part of the TCG stream.

       Arguments:
        CPUState *env:        the current CPU state
        TranslationBlock *tb: the TB we are executing

       Helper call location: cpu-exec.c

       Return value:
        none
    "

    (end_block_exec, panda_cb_type_PANDA_CB_END_BLOCK_EXEC,(cpu: &mut CPUState, tb: &mut TranslationBlock)),

    "Callback ID: PANDA_CB_BEFORE_TCG_CODEGEN

       before_tcg_codegen:
        Called before host code generation for every basic block. Enables
        inspection and modification of the TCG block after lifting from guest
        code.

       Arguments:
        CPUState *env:        the current CPU state
        TranslationBlock *tb: the TB about to be compiled

       Helper call location: translate-all.c

       Return value:
        None
    "

    (before_tcg_codegen, panda_cb_type_PANDA_CB_BEFORE_TCG_CODEGEN, (cpu: &mut CPUState, tb: &mut TranslationBlock))
);