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