15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2011 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef COURGETTE_DISASSEMBLER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define COURGETTE_DISASSEMBLER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "courgette/courgette.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1268043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles)// COURGETTE_HISTOGRAM_TARGETS prints out a histogram of how frequently 1368043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles)// different target addresses are referenced. Purely for debugging. 1468043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles)#define COURGETTE_HISTOGRAM_TARGETS 0 1568043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace courgette { 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class AssemblyProgram; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A Relative Virtual Address is the address in the image file after it is 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// loaded into memory relative to the image load address. 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef uint32 RVA; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Disassembler { 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~Disassembler(); 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ExecutableType kind() { return EXE_UNKNOWN; } 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ok() may always be called but returns 'true' only after ParseHeader 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // succeeds. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ok() const { return failure_reason_ == NULL; } 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns 'true' if the buffer appears to be a valid executable of the 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // expected type. It is not required that this be called before Disassemble. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool ParseHeader() = 0; 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Disassembles the item passed to the factory method into the output 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // parameter 'program'. 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool Disassemble(AssemblyProgram* program) = 0; 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the length of the source executable. May reduce after ParseHeader. 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t length() const { return length_; } 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const uint8* start() const { return start_; } 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const uint8* end() const { return end_; } 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a pointer into the memory copy of the file format. 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // FileOffsetToPointer(0) returns a pointer to the start of the file format. 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const uint8* OffsetToPointer(size_t offset) const; 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Disassembler(const void* start, size_t length); 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Good(); 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Bad(const char *reason); 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These helper functions avoid the need for casts in the main code. 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint16 ReadU16(const uint8* address, size_t offset) { 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *reinterpret_cast<const uint16*>(address + offset); 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint32 ReadU32(const uint8* address, size_t offset) { 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *reinterpret_cast<const uint32*>(address + offset); 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint64 ReadU64(const uint8* address, size_t offset) { 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *reinterpret_cast<const uint64*>(address + offset); 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static uint32 Read32LittleEndian(const void* address) { 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *reinterpret_cast<const uint32*>(address); 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 74a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch static uint16 Read16LittleEndian(const void* address) { 75a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch return *reinterpret_cast<const uint16*>(address); 76a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch } 77a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Reduce the length of the image in memory. Does not actually free 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // (or realloc) any memory. Usually only called via ParseHeader() 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ReduceLength(size_t reduced_length); 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* failure_reason_; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Basic information that is always valid after Construction, though 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ParseHeader may shorten the length if the executable is shorter than 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the total data. 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t length_; // In current memory. 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const uint8* start_; // In current memory, base for 'file offsets'. 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const uint8* end_; // In current memory. 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(Disassembler); 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace courgette 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // COURGETTE_DISASSEMBLER_H_ 99