memorymanip.hpp

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