Rva.C

// Relative Virtual Addresses (RVA)
// An RVA is always relative to the base virtual address (base_va) defined in an executable file header.
// A rose_rva_t is optionally tied to an SgAsmGenericSection so that if the preferred mapped address of the section is
// modified then the RVA stored in the rose_rva_t object is also adjusted.  The section-relative offset is always treated as
// an unsigned quantity, but negative offsets can be accommodated via integer overflow.
//
// Be careful about adjusting the RVA (the address or section) using ROSETTA's accessors.
//     symbol.p_address.set_section(section);          // this works
//     symbol.get_address().set_section(section);      // using ROSETTA accessor modifies a temporary copy of the RVA
// But if ROSETTA returns a vector then we can modify the RVA:
//     symbol.p_addresses[0].set_section(section);     // this works
//     symbol.get_addresses()[0].set_section(section); // so does this.
#include <featureTests.h>
#ifdef ROSE_ENABLE_BINARY_ANALYSIS
#include "sage3basic.h"

rose_rva_t::rose_rva_t() {
    addr = 0;
    section = NULL;
}

rose_rva_t::rose_rva_t(rose_addr_t rva, SgAsmGenericSection *section/*=NULL*/)
{
    addr = rva;
    this->section = NULL;
    set_section(section);
}


rose_rva_t::rose_rva_t(const rose_rva_t &other) 
{
    addr = other.addr;
    section = other.section;
}

rose_rva_t
rose_rva_t::operator=(const rose_rva_t &other) 
{
    addr = other.addr;
    section = other.section;
    return *this;
}

rose_rva_t
rose_rva_t::section_relative(SgAsmGenericSection *section, rose_addr_t offset)
{
    assert(section!=NULL);
    assert(section->is_mapped());
    rose_addr_t rva =section->get_mapped_preferred_rva() + offset;
    return rose_rva_t(rva, section);
}

bool
rose_rva_t::is_bound() const 
{
    return section!=NULL;
}

rose_addr_t
rose_rva_t::get_rva() const
{
    rose_addr_t rva = addr;
    if (section) {
        assert(section->is_mapped());
        rva += section->get_mapped_preferred_rva();
    }
    return rva;
}

rose_rva_t&
rose_rva_t::set_rva(rose_addr_t rva)
{
    addr = rva;
    if (section) {
        assert(section->is_mapped());
        addr -= section->get_mapped_preferred_rva();
    }
    return *this;
}

SgAsmGenericSection *
rose_rva_t::get_section() const
{
    return section;
}

rose_rva_t&
rose_rva_t::set_section(SgAsmGenericSection *new_section)
{
    assert(new_section==NULL || new_section->is_mapped());
    if (section) {
        addr += section->get_mapped_preferred_rva();
        section = NULL;
    }
    if (new_section)
        addr -= new_section->get_mapped_preferred_rva();
    section = new_section;
    return *this;
}

rose_rva_t&
rose_rva_t::bind(SgAsmGenericHeader *fhdr)
{
    rose_addr_t va = get_rva() + fhdr->get_base_va();
    SgAsmGenericSection *secbind = fhdr->get_best_section_by_va(va, true);
    return set_section(secbind);
}

rose_addr_t
rose_rva_t::get_va() const
{
    if (!section)
        return addr;
    assert(section->is_mapped());
    return addr + section->get_mapped_actual_va();
}

rose_addr_t
rose_rva_t::get_rel() const
{
    return addr;
}

rose_addr_t
rose_rva_t::get_rel(SgAsmGenericSection *s)
{
    assert(s!=NULL && s->is_mapped());
    return get_rva() - s->get_mapped_preferred_rva();
}

void
rose_rva_t::increment(rose_addr_t amount)
{
    addr += amount;
}

std::string
rose_rva_t::to_string() const
{
    char s[1024];
    snprintf(s, sizeof(s), "0x%08" PRIx64 " (%" PRIu64 ")", get_rva(), get_rva());
    std::string ss = s;

    if (get_section()) {
        snprintf(s, sizeof(s), " + 0x%08" PRIx64 " (%" PRIu64 ")", get_rel(), get_rel());
        ss += " <" + get_section()->get_name()->get_string(true) + s + ">";
    }
    return ss;
}


std::ostream &
operator<<(std::ostream &os, const rose_rva_t &rva)
{
    os << rva.to_string();
    return os;
}

/* Arithmetic */
rose_addr_t operator+(const rose_rva_t &a1, const rose_rva_t &a2) {return a1.get_rva() + a2.get_rva();}
rose_addr_t operator-(const rose_rva_t &a1, const rose_rva_t &a2) {return a1.get_rva() - a2.get_rva();}

/* Comparisons */
bool operator< (const rose_rva_t &a1, const rose_rva_t &a2) {return a1.get_rva() <  a2.get_rva();}
bool operator<=(const rose_rva_t &a1, const rose_rva_t &a2) {return a1.get_rva() <= a2.get_rva();}
bool operator> (const rose_rva_t &a1, const rose_rva_t &a2) {return a1.get_rva() >  a2.get_rva();}
bool operator>=(const rose_rva_t &a1, const rose_rva_t &a2) {return a1.get_rva() >= a2.get_rva();}
bool operator==(const rose_rva_t &a1, const rose_rva_t &a2) {return a1.get_rva() == a2.get_rva();}
bool operator!=(const rose_rva_t &a1, const rose_rva_t &a2) {return a1.get_rva() != a2.get_rva();}

#endif