memorymanip.hpp

   1 #ifndef _memorymanip__hpp__included__
   2 #define _memorymanip__hpp__included__
   3
   4 #include <string>
   5 #include <list>
   6 #include <vector>
   7 #include <cstdint>
   8 #include <stdexcept>
   9
  10 /**
  11  * \brief Information about region of memory
  12  *
  13  * This structure contains information about memory region.
  14  */
  15 struct memory_region
  16 {
  17 /**
  18  * \brief Name of region.
  19  *
  20  * This is name of region, mainly for debugging and showing to the user.
  21  */
  22         std::string region_name;
  23 /**
  24  * \brief Base address of region.
  25  */
  26         uint32_t baseaddr;
  27 /**
  28  * \brief Size of region in bytes.
  29  */
  30         uint32_t size;
  31 /**
  32  * \brief Last valid address in this region.
  33  */
  34         uint32_t lastaddr;
  35 /**
  36  * \brief True for ROM, false for RAM.
  37  */
  38         bool readonly;
  39 /**
  40  * \brief Endianess of the region.
  41  *
  42  * If true, region uses host endian.
  43  * If false, region uses SNES (big) endian.
  44  */
  45         bool native_endian;
  46 };
  47
  48 /**
  49  * \brief Refresh cart memory mappings
  50  *
  51  * This function rereads cartridge memory map. Call after loading a new cartridge.
  52  *
  53  * \throws std::bad_alloc Not enough memory.
  54  */
  55 void refresh_cart_mappings() throw(std::bad_alloc);
  56
  57 /**
  58  * \brief Get listing of all regions
  59  *
  60  * This function returns a list of all known regions.
  61  *
  62  * \return All regions
  63  * \throws std::bad_alloc Not enough memory.
  64  */
  65 std::vector<struct memory_region> get_regions() throw(std::bad_alloc);
  66
  67 /**
  68  * \brief Read byte from memory
  69  *
  70  * This function reads one byte from memory.
  71  *
  72  * \param addr The address to read.
  73  * \return The byte read.
  74  */
  75 uint8_t memory_read_byte(uint32_t addr) throw();
  76
  77 /**
  78  * \brief Read word from memory
  79  *
  80  * This function reads two bytes from memory.
  81  *
  82  * \param addr The address to read.
  83  * \return The word read.
  84  */
  85 uint16_t memory_read_word(uint32_t addr) throw();
  86
  87 /**
  88  * \brief Read dword from memory
  89  *
  90  * This function reads four bytes from memory.
  91  *
  92  * \param addr The address to read.
  93  * \return The dword read.
  94  */
  95 uint32_t memory_read_dword(uint32_t addr) throw();
  96
  97 /**
  98  * \brief Read qword from memory
  99  *
 100  * This function reads eight bytes from memory.
 101  *
 102  * \param addr The address to read.
 103  * \return The qword read.
 104  */
 105 uint64_t memory_read_qword(uint32_t addr) throw();
 106
 107 /**
 108  * \brief Write byte to memory
 109  *
 110  * This function writes one byte to memory.
 111  *
 112  * \param addr The address to write.
 113  * \param data The value to write.
 114  * \return true if the write succeeded.
 115  */
 116 bool memory_write_byte(uint32_t addr, uint8_t data) throw();
 117
 118 /**
 119  * \brief Write word to memory
 120  *
 121  * This function writes two bytes to memory.
 122  *
 123  * \param addr The address to write.
 124  * \param data The value to write.
 125  * \return true if the write succeeded.
 126  */
 127 bool memory_write_word(uint32_t addr, uint16_t data) throw();
 128
 129 /**
 130  * \brief Write dword to memory
 131  *
 132  * This function writes four bytes to memory.
 133  *
 134  * \param addr The address to write.
 135  * \param data The value to write.
 136  * \return true if the write succeeded.
 137  */
 138 bool memory_write_dword(uint32_t addr, uint32_t data) throw();
 139
 140 /**
 141  * \brief Write qword to memory
 142  *
 143  * This function writes eight bytes to memory.
 144  *
 145  * \param addr The address to write.
 146  * \param data The value to write.
 147  * \return true if the write succeeded.
 148  */
 149 bool memory_write_qword(uint32_t addr, uint64_t data) throw();
 150
 151 /**
 152  * \brief Memory search context
 153  *
 154  * Context for memory search. Each individual context is independent.
 155  */
 156 class memorysearch
 157 {
 158 public:
 159 /**
 160  * \brief Create new memory search context.
 161  *
 162  * Creates a new memory search context with all addresses.
 163  *
 164  * \throws std::bad_alloc Not enough memory.
 165  */
 166         memorysearch() throw(std::bad_alloc);
 167
 168 /**
 169  * \brief Reset the context
 170  *
 171  * Reset the context so all addresses are candidates again.
 172  *
 173  * \throws std::bad_alloc Not enough memory.
 174  */
 175         void reset() throw(std::bad_alloc);
 176
 177 /**
 178  * \brief Search for address satisfying criteria
 179  *
 180  * This searches the memory space, leaving those addresses for which condition object returns true.
 181  *
 182  * \param obj The condition to search for.
 183  */
 184         template<class T>
 185         void search(const T& obj) throw();
 186
 187 /**
 188  * \brief Search for byte with specified value
 189  * \param value The value to search for
 190  */
 191         void byte_value(uint8_t value) throw();
 192 /**
 193  * \brief Search for bytes that are signed less
 194  */
 195         void byte_slt() throw();
 196 /**
 197  * \brief Search for bytes that are signed less or equal
 198  */
 199         void byte_sle() throw();
 200 /**
 201  * \brief Search for bytes that are signed equal
 202  */
 203         void byte_seq() throw();
 204 /**
 205  * \brief Search for bytes that are signed not equal
 206  */
 207         void byte_sne() throw();
 208 /**
 209  * \brief Search for bytes that are signed greater or equal
 210  */
 211         void byte_sge() throw();
 212 /**
 213  * \brief Search for bytes that are signed greater
 214  */
 215         void byte_sgt() throw();
 216 /**
 217  * \brief Search for bytes that are unsigned less
 218  */
 219         void byte_ult() throw();
 220 /**
 221  * \brief Search for bytes that are unsigned less or equal
 222  */
 223         void byte_ule() throw();
 224 /**
 225  * \brief Search for bytes that are unsigned equal
 226  */
 227         void byte_ueq() throw();
 228 /**
 229  * \brief Search for bytes that are unsigned not equal
 230  */
 231         void byte_une() throw();
 232 /**
 233  * \brief Search for bytes that are unsigned greater or equal
 234  */
 235         void byte_uge() throw();
 236 /**
 237  * \brief Search for bytes that are unsigned greater
 238  */
 239         void byte_ugt() throw();
 240
 241 /**
 242  * \brief Search for word with specified value
 243  * \param value The value to search for
 244  */
 245         void word_value(uint16_t value) throw();
 246 /**
 247  * \brief Search for words that are signed less
 248  */
 249         void word_slt() throw();
 250 /**
 251  * \brief Search for words that are signed less or equal
 252  */
 253         void word_sle() throw();
 254 /**
 255  * \brief Search for words that are signed equal
 256  */
 257         void word_seq() throw();
 258 /**
 259  * \brief Search for words that are signed not equal
 260  */
 261         void word_sne() throw();
 262 /**
 263  * \brief Search for words that are signed greater or equal
 264  */
 265         void word_sge() throw();
 266 /**
 267  * \brief Search for words that are signed greater
 268  */
 269         void word_sgt() throw();
 270 /**
 271  * \brief Search for words that are unsigned less
 272  */
 273         void word_ult() throw();
 274 /**
 275  * \brief Search for words that are unsigned less or equal
 276  */
 277         void word_ule() throw();
 278 /**
 279  * \brief Search for words that are unsigned equal
 280  */
 281         void word_ueq() throw();
 282 /**
 283  * \brief Search for words that are unsigned not equal
 284  */
 285         void word_une() throw();
 286 /**
 287  * \brief Search for words that are unsigned greater or equal
 288  */
 289         void word_uge() throw();
 290 /**
 291  * \brief Search for words that are unsigned greater
 292  */
 293         void word_ugt() throw();
 294
 295 /**
 296  * \brief Search for dword with specified value
 297  * \param value The value to search for
 298  */
 299         void dword_value(uint32_t value) throw();
 300 /**
 301  * \brief Search for dwords that are signed less
 302  */
 303         void dword_slt() throw();
 304 /**
 305  * \brief Search for dwords that are signed less or equal
 306  */
 307         void dword_sle() throw();
 308 /**
 309  * \brief Search for dwords that are signed equal
 310  */
 311         void dword_seq() throw();
 312 /**
 313  * \brief Search for dwords that are signed not equal
 314  */
 315         void dword_sne() throw();
 316 /**
 317  * \brief Search for dwords that are signed greater or equal
 318  */
 319         void dword_sge() throw();
 320 /**
 321  * \brief Search for dwords that are signed greater
 322  */
 323         void dword_sgt() throw();
 324 /**
 325  * \brief Search for dwords that are unsigned less
 326  */
 327         void dword_ult() throw();
 328 /**
 329  * \brief Search for dwords that are unsigned less or equal
 330  */
 331         void dword_ule() throw();
 332 /**
 333  * \brief Search for dwords that are unsigned equal
 334  */
 335         void dword_ueq() throw();
 336 /**
 337  * \brief Search for dwords that are unsigned not equal
 338  */
 339         void dword_une() throw();
 340 /**
 341  * \brief Search for dwords that are unsigned greater or equal
 342  */
 343         void dword_uge() throw();
 344 /**
 345  * \brief Search for dwords that are unsigned greater
 346  */
 347         void dword_ugt() throw();
 348
 349 /**
 350  * \brief Search for qword with specified value
 351  * \param value The value to search for
 352  */
 353         void qword_value(uint64_t value) throw();
 354 /**
 355  * \brief Search for qwords that are signed less
 356  */
 357         void qword_slt() throw();
 358 /**
 359  * \brief Search for qwords that are signed less or equal
 360  */
 361         void qword_sle() throw();
 362 /**
 363  * \brief Search for qwords that are signed equal
 364  */
 365         void qword_seq() throw();
 366 /**
 367  * \brief Search for qwords that are signed not equal
 368  */
 369         void qword_sne() throw();
 370 /**
 371  * \brief Search for qwords that are signed greater or equal
 372  */
 373         void qword_sge() throw();
 374 /**
 375  * \brief Search for qwords that are signed greater
 376  */
 377         void qword_sgt() throw();
 378 /**
 379  * \brief Search for qwords that are unsigned less
 380  */
 381         void qword_ult() throw();
 382 /**
 383  * \brief Search for qwords that are unsigned less or equal
 384  */
 385         void qword_ule() throw();
 386 /**
 387  * \brief Search for qwords that are unsigned equal
 388  */
 389         void qword_ueq() throw();
 390 /**
 391  * \brief Search for qwords that are unsigned not equal
 392  */
 393         void qword_une() throw();
 394 /**
 395  * \brief Search for qwords that are unsigned greater or equal
 396  */
 397         void qword_uge() throw();
 398 /**
 399  * \brief Search for qwords that are unsigned greater
 400  */
 401         void qword_ugt() throw();
 402
 403 /**
 404  * \brief Get number of memory addresses that are still candidates
 405  *
 406  * This returns the number of memory addresses satisfying constraints so far.
 407  *
 408  * \return The number of candidates
 409  */
 410         uint32_t get_candidate_count() throw();
 411
 412 /**
 413  * \brief Get List of all candidate addresses
 414  *
 415  * Returns list of all candidates. This function isn't lazy, so be careful when calling with many candidates.
 416  *
 417  * \return Candidate address list
 418  * \throws std::bad_alloc Not enough memory.
 419  */
 420         std::list<uint32_t> get_candidates() throw(std::bad_alloc);
 421 private:
 422         std::vector<uint8_t> previous_content;
 423         std::vector<uint64_t> still_in;
 424         uint32_t candidates;
 425 };
 426
 427 #endif