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_COUNT 53 }; 54 55 typedef enum ReplayAsyncEventKind ReplayAsyncEventKind; 56 57 typedef struct ReplayState { 58 /*! Cached clock values. */ 59 int64_t cached_clock[REPLAY_CLOCK_COUNT]; 60 /*! Current step - number of processed instructions and timer events. */ 61 uint64_t current_step; 62 /*! Number of instructions to be executed before other events happen. */ 63 int instructions_count; 64 } ReplayState; 65 extern ReplayState replay_state; 66 67 extern unsigned int replay_data_kind; 68 69 /* File for replay writing */ 70 extern FILE *replay_file; 71 72 void replay_put_byte(uint8_t byte); 73 void replay_put_event(uint8_t event); 74 void replay_put_word(uint16_t word); 75 void replay_put_dword(uint32_t dword); 76 void replay_put_qword(int64_t qword); 77 void replay_put_array(const uint8_t *buf, size_t size); 78 79 uint8_t replay_get_byte(void); 80 uint16_t replay_get_word(void); 81 uint32_t replay_get_dword(void); 82 int64_t replay_get_qword(void); 83 void replay_get_array(uint8_t *buf, size_t *size); 84 void replay_get_array_alloc(uint8_t **buf, size_t *size); 85 86 /* Mutex functions for protecting replay log file */ 87 88 void replay_mutex_init(void); 89 void replay_mutex_destroy(void); 90 void replay_mutex_lock(void); 91 void replay_mutex_unlock(void); 92 93 /*! Checks error status of the file. */ 94 void replay_check_error(void); 95 96 /*! Finishes processing of the replayed event and fetches 97 the next event from the log. */ 98 void replay_finish_event(void); 99 /*! Reads data type from the file and stores it in the 100 replay_data_kind variable. */ 101 void replay_fetch_data_kind(void); 102 103 /*! Saves queued events (like instructions and sound). */ 104 void replay_save_instructions(void); 105 106 /*! Skips async events until some sync event will be found. 107 \return true, if event was found */ 108 bool replay_next_event_is(int event); 109 110 /*! Reads next clock value from the file. 111 If clock kind read from the file is different from the parameter, 112 the value is not used. */ 113 void replay_read_next_clock(unsigned int kind); 114 115 /* Asynchronous events queue */ 116 117 /*! Initializes events' processing internals */ 118 void replay_init_events(void); 119 /*! Clears internal data structures for events handling */ 120 void replay_finish_events(void); 121 /*! Enables storing events in the queue */ 122 void replay_enable_events(void); 123 /*! Flushes events queue */ 124 void replay_flush_events(void); 125 /*! Clears events list before loading new VM state */ 126 void replay_clear_events(void); 127 /*! Returns true if there are any unsaved events in the queue */ 128 bool replay_has_events(void); 129 /*! Saves events from queue into the file */ 130 void replay_save_events(int checkpoint); 131 /*! Read events from the file into the input queue */ 132 void replay_read_events(int checkpoint); 133 /*! Adds specified async event to the queue */ 134 void replay_add_event(ReplayAsyncEventKind event_kind, void *opaque, 135 void *opaque2, uint64_t id); 136 137 /* Input events */ 138 139 /*! Saves input event to the log */ 140 void replay_save_input_event(InputEvent *evt); 141 /*! Reads input event from the log */ 142 InputEvent *replay_read_input_event(void); 143 /*! Adds input event to the queue */ 144 void replay_add_input_event(struct InputEvent *event); 145 /*! Adds input sync event to the queue */ 146 void replay_add_input_sync_event(void); 147 148 /* Character devices */ 149 150 /*! Called to run char device read event. */ 151 void replay_event_char_read_run(void *opaque); 152 /*! Writes char read event to the file. */ 153 void replay_event_char_read_save(void *opaque); 154 /*! Reads char event read from the file. */ 155 void *replay_event_char_read_load(void); 156 157 #endif 158