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 EVENT_COUNT 37 }; 38 39 /* Asynchronous events IDs */ 40 41 enum ReplayAsyncEventKind { 42 REPLAY_ASYNC_COUNT 43 }; 44 45 typedef enum ReplayAsyncEventKind ReplayAsyncEventKind; 46 47 typedef struct ReplayState { 48 /*! Cached clock values. */ 49 int64_t cached_clock[REPLAY_CLOCK_COUNT]; 50 /*! Current step - number of processed instructions and timer events. */ 51 uint64_t current_step; 52 /*! Number of instructions to be executed before other events happen. */ 53 int instructions_count; 54 } ReplayState; 55 extern ReplayState replay_state; 56 57 extern unsigned int replay_data_kind; 58 59 /* File for replay writing */ 60 extern FILE *replay_file; 61 62 void replay_put_byte(uint8_t byte); 63 void replay_put_event(uint8_t event); 64 void replay_put_word(uint16_t word); 65 void replay_put_dword(uint32_t dword); 66 void replay_put_qword(int64_t qword); 67 void replay_put_array(const uint8_t *buf, size_t size); 68 69 uint8_t replay_get_byte(void); 70 uint16_t replay_get_word(void); 71 uint32_t replay_get_dword(void); 72 int64_t replay_get_qword(void); 73 void replay_get_array(uint8_t *buf, size_t *size); 74 void replay_get_array_alloc(uint8_t **buf, size_t *size); 75 76 /* Mutex functions for protecting replay log file */ 77 78 void replay_mutex_init(void); 79 void replay_mutex_destroy(void); 80 void replay_mutex_lock(void); 81 void replay_mutex_unlock(void); 82 83 /*! Checks error status of the file. */ 84 void replay_check_error(void); 85 86 /*! Finishes processing of the replayed event and fetches 87 the next event from the log. */ 88 void replay_finish_event(void); 89 /*! Reads data type from the file and stores it in the 90 replay_data_kind variable. */ 91 void replay_fetch_data_kind(void); 92 93 /*! Saves queued events (like instructions and sound). */ 94 void replay_save_instructions(void); 95 96 /*! Skips async events until some sync event will be found. 97 \return true, if event was found */ 98 bool replay_next_event_is(int event); 99 100 /*! Reads next clock value from the file. 101 If clock kind read from the file is different from the parameter, 102 the value is not used. */ 103 void replay_read_next_clock(unsigned int kind); 104 105 /* Asynchronous events queue */ 106 107 /*! Initializes events' processing internals */ 108 void replay_init_events(void); 109 /*! Clears internal data structures for events handling */ 110 void replay_finish_events(void); 111 /*! Enables storing events in the queue */ 112 void replay_enable_events(void); 113 /*! Flushes events queue */ 114 void replay_flush_events(void); 115 /*! Clears events list before loading new VM state */ 116 void replay_clear_events(void); 117 /*! Returns true if there are any unsaved events in the queue */ 118 bool replay_has_events(void); 119 /*! Saves events from queue into the file */ 120 void replay_save_events(int checkpoint); 121 /*! Read events from the file into the input queue */ 122 void replay_read_events(int checkpoint); 123 124 #endif 125