1 /* Declarations for use by hardware emulation. */ 2 #ifndef QEMU_HW_H 3 #define QEMU_HW_H 4 5 #include "qemu-common.h" 6 #include "irq.h" 7 8 /* VM Load/Save */ 9 10 /* This function writes a chunk of data to a file at the given position. 11 * The pos argument can be ignored if the file is only being used for 12 * streaming. The handler should try to write all of the data it can. 13 */ 14 typedef int (QEMUFilePutBufferFunc)(void *opaque, const uint8_t *buf, 15 int64_t pos, int size); 16 17 /* Read a chunk of data from a file at the given position. The pos argument 18 * can be ignored if the file is only be used for streaming. The number of 19 * bytes actually read should be returned. 20 */ 21 typedef int (QEMUFileGetBufferFunc)(void *opaque, uint8_t *buf, 22 int64_t pos, int size); 23 24 /* Close a file and return an error code */ 25 typedef int (QEMUFileCloseFunc)(void *opaque); 26 27 /* Called to determine if the file has exceeded it's bandwidth allocation. The 28 * bandwidth capping is a soft limit, not a hard limit. 29 */ 30 typedef int (QEMUFileRateLimit)(void *opaque); 31 32 QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer, 33 QEMUFileGetBufferFunc *get_buffer, 34 QEMUFileCloseFunc *close, 35 QEMUFileRateLimit *rate_limit); 36 QEMUFile *qemu_fopen(const char *filename, const char *mode); 37 QEMUFile *qemu_fopen_socket(int fd); 38 QEMUFile *qemu_popen(FILE *popen_file, const char *mode); 39 QEMUFile *qemu_popen_cmd(const char *command, const char *mode); 40 void qemu_fflush(QEMUFile *f); 41 int qemu_fclose(QEMUFile *f); 42 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size); 43 void qemu_put_byte(QEMUFile *f, int v); 44 45 static inline void qemu_put_ubyte(QEMUFile *f, unsigned int v) 46 { 47 qemu_put_byte(f, (int)v); 48 } 49 50 #define qemu_put_sbyte qemu_put_byte 51 52 void qemu_put_be16(QEMUFile *f, unsigned int v); 53 void qemu_put_be32(QEMUFile *f, unsigned int v); 54 void qemu_put_be64(QEMUFile *f, uint64_t v); 55 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size); 56 int qemu_get_byte(QEMUFile *f); 57 58 static inline unsigned int qemu_get_ubyte(QEMUFile *f) 59 { 60 return (unsigned int)qemu_get_byte(f); 61 } 62 63 #define qemu_get_sbyte qemu_get_byte 64 65 unsigned int qemu_get_be16(QEMUFile *f); 66 unsigned int qemu_get_be32(QEMUFile *f); 67 uint64_t qemu_get_be64(QEMUFile *f); 68 int qemu_file_rate_limit(QEMUFile *f); 69 int qemu_file_has_error(QEMUFile *f); 70 void qemu_file_set_error(QEMUFile *f); 71 72 /* Try to send any outstanding data. This function is useful when output is 73 * halted due to rate limiting or EAGAIN errors occur as it can be used to 74 * resume output. */ 75 void qemu_file_put_notify(QEMUFile *f); 76 77 static inline void qemu_put_be64s(QEMUFile *f, const uint64_t *pv) 78 { 79 qemu_put_be64(f, *pv); 80 } 81 82 static inline void qemu_put_be32s(QEMUFile *f, const uint32_t *pv) 83 { 84 qemu_put_be32(f, *pv); 85 } 86 87 static inline void qemu_put_be16s(QEMUFile *f, const uint16_t *pv) 88 { 89 qemu_put_be16(f, *pv); 90 } 91 92 static inline void qemu_put_8s(QEMUFile *f, const uint8_t *pv) 93 { 94 qemu_put_byte(f, *pv); 95 } 96 97 static inline void qemu_get_be64s(QEMUFile *f, uint64_t *pv) 98 { 99 *pv = qemu_get_be64(f); 100 } 101 102 static inline void qemu_get_be32s(QEMUFile *f, uint32_t *pv) 103 { 104 *pv = qemu_get_be32(f); 105 } 106 107 static inline void qemu_get_be16s(QEMUFile *f, uint16_t *pv) 108 { 109 *pv = qemu_get_be16(f); 110 } 111 112 static inline void qemu_get_8s(QEMUFile *f, uint8_t *pv) 113 { 114 *pv = qemu_get_byte(f); 115 } 116 117 // Signed versions for type safety 118 static inline void qemu_put_sbuffer(QEMUFile *f, const int8_t *buf, int size) 119 { 120 qemu_put_buffer(f, (const uint8_t *)buf, size); 121 } 122 123 static inline void qemu_put_sbe16(QEMUFile *f, int v) 124 { 125 qemu_put_be16(f, (unsigned int)v); 126 } 127 128 static inline void qemu_put_sbe32(QEMUFile *f, int v) 129 { 130 qemu_put_be32(f, (unsigned int)v); 131 } 132 133 static inline void qemu_put_sbe64(QEMUFile *f, int64_t v) 134 { 135 qemu_put_be64(f, (uint64_t)v); 136 } 137 138 static inline size_t qemu_get_sbuffer(QEMUFile *f, int8_t *buf, int size) 139 { 140 return qemu_get_buffer(f, (uint8_t *)buf, size); 141 } 142 143 static inline int qemu_get_sbe16(QEMUFile *f) 144 { 145 return (int)qemu_get_be16(f); 146 } 147 148 static inline int qemu_get_sbe32(QEMUFile *f) 149 { 150 return (int)qemu_get_be32(f); 151 } 152 153 static inline int64_t qemu_get_sbe64(QEMUFile *f) 154 { 155 return (int64_t)qemu_get_be64(f); 156 } 157 158 static inline void qemu_put_s8s(QEMUFile *f, const int8_t *pv) 159 { 160 qemu_put_8s(f, (const uint8_t *)pv); 161 } 162 163 static inline void qemu_put_sbe16s(QEMUFile *f, const int16_t *pv) 164 { 165 qemu_put_be16s(f, (const uint16_t *)pv); 166 } 167 168 static inline void qemu_put_sbe32s(QEMUFile *f, const int32_t *pv) 169 { 170 qemu_put_be32s(f, (const uint32_t *)pv); 171 } 172 173 static inline void qemu_put_sbe64s(QEMUFile *f, const int64_t *pv) 174 { 175 qemu_put_be64s(f, (const uint64_t *)pv); 176 } 177 178 static inline void qemu_get_s8s(QEMUFile *f, int8_t *pv) 179 { 180 qemu_get_8s(f, (uint8_t *)pv); 181 } 182 183 static inline void qemu_get_sbe16s(QEMUFile *f, int16_t *pv) 184 { 185 qemu_get_be16s(f, (uint16_t *)pv); 186 } 187 188 static inline void qemu_get_sbe32s(QEMUFile *f, int32_t *pv) 189 { 190 qemu_get_be32s(f, (uint32_t *)pv); 191 } 192 193 static inline void qemu_get_sbe64s(QEMUFile *f, int64_t *pv) 194 { 195 qemu_get_be64s(f, (uint64_t *)pv); 196 } 197 198 #ifdef NEED_CPU_H 199 #if TARGET_LONG_BITS == 64 200 #define qemu_put_betl qemu_put_be64 201 #define qemu_get_betl qemu_get_be64 202 #define qemu_put_betls qemu_put_be64s 203 #define qemu_get_betls qemu_get_be64s 204 #define qemu_put_sbetl qemu_put_sbe64 205 #define qemu_get_sbetl qemu_get_sbe64 206 #define qemu_put_sbetls qemu_put_sbe64s 207 #define qemu_get_sbetls qemu_get_sbe64s 208 #else 209 #define qemu_put_betl qemu_put_be32 210 #define qemu_get_betl qemu_get_be32 211 #define qemu_put_betls qemu_put_be32s 212 #define qemu_get_betls qemu_get_be32s 213 #define qemu_put_sbetl qemu_put_sbe32 214 #define qemu_get_sbetl qemu_get_sbe32 215 #define qemu_put_sbetls qemu_put_sbe32s 216 #define qemu_get_sbetls qemu_get_sbe32s 217 #endif 218 #endif 219 220 int64_t qemu_ftell(QEMUFile *f); 221 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence); 222 223 typedef void SaveStateHandler(QEMUFile *f, void *opaque); 224 typedef int SaveLiveStateHandler(QEMUFile *f, int stage, void *opaque); 225 typedef int LoadStateHandler(QEMUFile *f, void *opaque, int version_id); 226 227 int register_savevm(const char *idstr, 228 int instance_id, 229 int version_id, 230 SaveStateHandler *save_state, 231 LoadStateHandler *load_state, 232 void *opaque); 233 234 int register_savevm_live(const char *idstr, 235 int instance_id, 236 int version_id, 237 SaveLiveStateHandler *save_live_state, 238 SaveStateHandler *save_state, 239 LoadStateHandler *load_state, 240 void *opaque); 241 242 void unregister_savevm(const char *idstr, void *opaque); 243 244 typedef void QEMUResetHandler(void *opaque); 245 246 void qemu_register_reset(QEMUResetHandler *func, void *opaque); 247 248 /* handler to set the boot_device for a specific type of QEMUMachine */ 249 /* return 0 if success */ 250 typedef int QEMUBootSetHandler(void *opaque, const char *boot_device); 251 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque); 252 253 /* These should really be in isa.h, but are here to make pc.h happy. */ 254 typedef void (IOPortWriteFunc)(void *opaque, uint32_t address, uint32_t data); 255 typedef uint32_t (IOPortReadFunc)(void *opaque, uint32_t address); 256 257 #endif 258