1 #ifndef REPLAY_INTERNAL_H 2 #define REPLAY_INTERNAL_H 3 4 /* 5 * replay-internal.h 6 * 7 * Copyright (c) 2010-2015 Institute for System Programming 8 * of the Russian Academy of Sciences. 9 * 10 * This work is licensed under the terms of the GNU GPL, version 2 or later. 11 * See the COPYING file in the top-level directory. 12 * 13 */ 14 15 #include <stdio.h> 16 17 enum ReplayEvents { 18 /* for instruction event */ 19 EVENT_INSTRUCTION, 20 /* for software interrupt */ 21 EVENT_INTERRUPT, 22 /* for emulated exceptions */ 23 EVENT_EXCEPTION, 24 /* for async events */ 25 EVENT_ASYNC, 26 /* for shutdown request */ 27 EVENT_SHUTDOWN, 28 /* for clock read/writes */ 29 /* some of greater codes are reserved for clocks */ 30 EVENT_CLOCK, 31 EVENT_CLOCK_LAST = EVENT_CLOCK + REPLAY_CLOCK_COUNT - 1, 32 /* for checkpoint event */ 33 /* some of greater codes are reserved for checkpoints */ 34 EVENT_CHECKPOINT, 35 EVENT_CHECKPOINT_LAST = EVENT_CHECKPOINT + CHECKPOINT_COUNT - 1, 36 /* end of log event */ 37 EVENT_END, 38 EVENT_COUNT 39 }; 40 41 /* Asynchronous events IDs */ 42 43 enum ReplayAsyncEventKind { 44 REPLAY_ASYNC_EVENT_BH, 45 REPLAY_ASYNC_COUNT 46 }; 47 48 typedef enum ReplayAsyncEventKind ReplayAsyncEventKind; 49 50 typedef struct ReplayState { 51 /*! Cached clock values. */ 52 int64_t cached_clock[REPLAY_CLOCK_COUNT]; 53 /*! Current step - number of processed instructions and timer events. */ 54 uint64_t current_step; 55 /*! Number of instructions to be executed before other events happen. */ 56 int instructions_count; 57 } ReplayState; 58 extern ReplayState replay_state; 59 60 extern unsigned int replay_data_kind; 61 62 /* File for replay writing */ 63 extern FILE *replay_file; 64 65 void replay_put_byte(uint8_t byte); 66 void replay_put_event(uint8_t event); 67 void replay_put_word(uint16_t word); 68 void replay_put_dword(uint32_t dword); 69 void replay_put_qword(int64_t qword); 70 void replay_put_array(const uint8_t *buf, size_t size); 71 72 uint8_t replay_get_byte(void); 73 uint16_t replay_get_word(void); 74 uint32_t replay_get_dword(void); 75 int64_t replay_get_qword(void); 76 void replay_get_array(uint8_t *buf, size_t *size); 77 void replay_get_array_alloc(uint8_t **buf, size_t *size); 78 79 /* Mutex functions for protecting replay log file */ 80 81 void replay_mutex_init(void); 82 void replay_mutex_destroy(void); 83 void replay_mutex_lock(void); 84 void replay_mutex_unlock(void); 85 86 /*! Checks error status of the file. */ 87 void replay_check_error(void); 88 89 /*! Finishes processing of the replayed event and fetches 90 the next event from the log. */ 91 void replay_finish_event(void); 92 /*! Reads data type from the file and stores it in the 93 replay_data_kind variable. */ 94 void replay_fetch_data_kind(void); 95 96 /*! Saves queued events (like instructions and sound). */ 97 void replay_save_instructions(void); 98 99 /*! Skips async events until some sync event will be found. 100 \return true, if event was found */ 101 bool replay_next_event_is(int event); 102 103 /*! Reads next clock value from the file. 104 If clock kind read from the file is different from the parameter, 105 the value is not used. */ 106 void replay_read_next_clock(unsigned int kind); 107 108 /* Asynchronous events queue */ 109 110 /*! Initializes events' processing internals */ 111 void replay_init_events(void); 112 /*! Clears internal data structures for events handling */ 113 void replay_finish_events(void); 114 /*! Enables storing events in the queue */ 115 void replay_enable_events(void); 116 /*! Flushes events queue */ 117 void replay_flush_events(void); 118 /*! Clears events list before loading new VM state */ 119 void replay_clear_events(void); 120 /*! Returns true if there are any unsaved events in the queue */ 121 bool replay_has_events(void); 122 /*! Saves events from queue into the file */ 123 void replay_save_events(int checkpoint); 124 /*! Read events from the file into the input queue */ 125 void replay_read_events(int checkpoint); 126 127 #endif 128