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 /* Any changes to order/number of events will need to bump REPLAY_VERSION */ 16 enum ReplayEvents { 17 /* for instruction event */ 18 EVENT_INSTRUCTION, 19 /* for software interrupt */ 20 EVENT_INTERRUPT, 21 /* for emulated exceptions */ 22 EVENT_EXCEPTION, 23 /* for async events */ 24 EVENT_ASYNC, 25 /* for shutdown requests, range allows recovery of ShutdownCause */ 26 EVENT_SHUTDOWN, 27 EVENT_SHUTDOWN_LAST = EVENT_SHUTDOWN + SHUTDOWN_CAUSE__MAX, 28 /* for character device write event */ 29 EVENT_CHAR_WRITE, 30 /* for character device read all event */ 31 EVENT_CHAR_READ_ALL, 32 EVENT_CHAR_READ_ALL_ERROR, 33 /* for audio out event */ 34 EVENT_AUDIO_OUT, 35 /* for audio in event */ 36 EVENT_AUDIO_IN, 37 /* for clock read/writes */ 38 /* some of greater codes are reserved for clocks */ 39 EVENT_CLOCK, 40 EVENT_CLOCK_LAST = EVENT_CLOCK + REPLAY_CLOCK_COUNT - 1, 41 /* for checkpoint event */ 42 /* some of greater codes are reserved for checkpoints */ 43 EVENT_CHECKPOINT, 44 EVENT_CHECKPOINT_LAST = EVENT_CHECKPOINT + CHECKPOINT_COUNT - 1, 45 /* end of log event */ 46 EVENT_END, 47 EVENT_COUNT 48 }; 49 50 /* Asynchronous events IDs */ 51 52 enum ReplayAsyncEventKind { 53 REPLAY_ASYNC_EVENT_BH, 54 REPLAY_ASYNC_EVENT_INPUT, 55 REPLAY_ASYNC_EVENT_INPUT_SYNC, 56 REPLAY_ASYNC_EVENT_CHAR_READ, 57 REPLAY_ASYNC_EVENT_BLOCK, 58 REPLAY_ASYNC_EVENT_NET, 59 REPLAY_ASYNC_COUNT 60 }; 61 62 typedef enum ReplayAsyncEventKind ReplayAsyncEventKind; 63 64 typedef struct ReplayState { 65 /*! Cached clock values. */ 66 int64_t cached_clock[REPLAY_CLOCK_COUNT]; 67 /*! Current step - number of processed instructions and timer events. */ 68 uint64_t current_step; 69 /*! Number of instructions to be executed before other events happen. */ 70 int instructions_count; 71 /*! Type of the currently executed event. */ 72 unsigned int data_kind; 73 /*! Flag which indicates that event is not processed yet. */ 74 unsigned int has_unread_data; 75 /*! Temporary variable for saving current log offset. */ 76 uint64_t file_offset; 77 /*! Next block operation id. 78 This counter is global, because requests from different 79 block devices should not get overlapping ids. */ 80 uint64_t block_request_id; 81 /*! Prior value of the host clock */ 82 uint64_t host_clock_last; 83 } ReplayState; 84 extern ReplayState replay_state; 85 86 /* File for replay writing */ 87 extern FILE *replay_file; 88 89 void replay_put_byte(uint8_t byte); 90 void replay_put_event(uint8_t event); 91 void replay_put_word(uint16_t word); 92 void replay_put_dword(uint32_t dword); 93 void replay_put_qword(int64_t qword); 94 void replay_put_array(const uint8_t *buf, size_t size); 95 96 uint8_t replay_get_byte(void); 97 uint16_t replay_get_word(void); 98 uint32_t replay_get_dword(void); 99 int64_t replay_get_qword(void); 100 void replay_get_array(uint8_t *buf, size_t *size); 101 void replay_get_array_alloc(uint8_t **buf, size_t *size); 102 103 /* Mutex functions for protecting replay log file */ 104 105 void replay_mutex_init(void); 106 void replay_mutex_destroy(void); 107 void replay_mutex_lock(void); 108 void replay_mutex_unlock(void); 109 110 /*! Checks error status of the file. */ 111 void replay_check_error(void); 112 113 /*! Finishes processing of the replayed event and fetches 114 the next event from the log. */ 115 void replay_finish_event(void); 116 /*! Reads data type from the file and stores it in the 117 data_kind variable. */ 118 void replay_fetch_data_kind(void); 119 120 /*! Saves queued events (like instructions and sound). */ 121 void replay_save_instructions(void); 122 123 /*! Skips async events until some sync event will be found. 124 \return true, if event was found */ 125 bool replay_next_event_is(int event); 126 127 /*! Reads next clock value from the file. 128 If clock kind read from the file is different from the parameter, 129 the value is not used. */ 130 void replay_read_next_clock(unsigned int kind); 131 132 /* Asynchronous events queue */ 133 134 /*! Initializes events' processing internals */ 135 void replay_init_events(void); 136 /*! Clears internal data structures for events handling */ 137 void replay_finish_events(void); 138 /*! Flushes events queue */ 139 void replay_flush_events(void); 140 /*! Clears events list before loading new VM state */ 141 void replay_clear_events(void); 142 /*! Returns true if there are any unsaved events in the queue */ 143 bool replay_has_events(void); 144 /*! Saves events from queue into the file */ 145 void replay_save_events(int checkpoint); 146 /*! Read events from the file into the input queue */ 147 void replay_read_events(int checkpoint); 148 /*! Adds specified async event to the queue */ 149 void replay_add_event(ReplayAsyncEventKind event_kind, void *opaque, 150 void *opaque2, uint64_t id); 151 152 /* Input events */ 153 154 /*! Saves input event to the log */ 155 void replay_save_input_event(InputEvent *evt); 156 /*! Reads input event from the log */ 157 InputEvent *replay_read_input_event(void); 158 /*! Adds input event to the queue */ 159 void replay_add_input_event(struct InputEvent *event); 160 /*! Adds input sync event to the queue */ 161 void replay_add_input_sync_event(void); 162 163 /* Character devices */ 164 165 /*! Called to run char device read event. */ 166 void replay_event_char_read_run(void *opaque); 167 /*! Writes char read event to the file. */ 168 void replay_event_char_read_save(void *opaque); 169 /*! Reads char event read from the file. */ 170 void *replay_event_char_read_load(void); 171 172 /* Network devices */ 173 174 /*! Called to run network event. */ 175 void replay_event_net_run(void *opaque); 176 /*! Writes network event to the file. */ 177 void replay_event_net_save(void *opaque); 178 /*! Reads network from the file. */ 179 void *replay_event_net_load(void); 180 181 /* VMState-related functions */ 182 183 /* Registers replay VMState. 184 Should be called before virtual devices initialization 185 to make cached timers available for post_load functions. */ 186 void replay_vmstate_register(void); 187 188 #endif 189