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