/*===================== begin_copyright_notice ==================================

Copyright (c) 2017 Intel Corporation

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


======================= end_copyright_notice ==================================*/

#include "ElfWriter.h"
#include "secure_mem.h" // needed for memcpy_s on linux/android
#include <cstring>

namespace CLElfLib
{
/******************************************************************************\
 Constructor: CElfWriter::CElfWriter
\******************************************************************************/
CElfWriter::CElfWriter(
    E_EH_TYPE type,
    E_EH_MACHINE machine,
    Elf64_Xword flags )
{
    m_type = type;
    m_machine = machine;
    m_flags = flags;
    m_dataSize = 0;
    m_numSections = 0;
    m_stringTableSize = 0;
}

/******************************************************************************\
 Destructor: CElfWriter::~CElfWriter
\******************************************************************************/
CElfWriter::~CElfWriter()
{
    SSectionNode* pNode = NULL;

    // Walk through the section nodes
    while( m_nodeQueue.empty() == false )
    {
        pNode = m_nodeQueue.front();
        m_nodeQueue.pop();

        // delete the node and it's data
        if( pNode )
        {
            if( pNode->pData )
            {
                delete[] pNode->pData;
                pNode->pData = NULL;
            }

            delete pNode;
        }
    }
}

/******************************************************************************\
 Member Function: CElfWriter::Create
\******************************************************************************/
CElfWriter* CElfWriter::Create(
    E_EH_TYPE type,
    E_EH_MACHINE machine,
    Elf64_Xword flags )
{
    CElfWriter* pWriter = new CElfWriter(
        type, machine, flags );

    if( ( pWriter ) && ( pWriter->Initialize() != SUCCESS ) )
    {
        Delete( pWriter );
    }

    return pWriter;
}

/******************************************************************************\
 Member Function: CElfWriter::Delete
\******************************************************************************/
void CElfWriter::Delete(
    CElfWriter* &pWriter )
{
    if( pWriter )
    {
        delete pWriter;
        pWriter = NULL;
    }
}

/******************************************************************************\
 Member Function: CElfWriter::AddSection
\******************************************************************************/
E_RETVAL CElfWriter::AddSection(
    SSectionNode* pSectionNode )
{
    E_RETVAL retVal = SUCCESS;
    SSectionNode* pNode = NULL;
    size_t nameSize = 0;
    unsigned int dataSize = 0;

    // The section header must be non-NULL
    if( pSectionNode )
    {
        pNode = new SSectionNode();

        if( !pNode )
        {
            retVal = OUT_OF_MEMORY;
        }
    }
    else
    {
        retVal = FAILURE;
    }

    if( retVal == SUCCESS )
    {
        pNode->Flags = pSectionNode->Flags;
        pNode->Type  = pSectionNode->Type;

        nameSize = pSectionNode->Name.size() + 1;
        dataSize = pSectionNode->DataSize;

        pNode->Name = pSectionNode->Name;

        // ok to have NULL data
        if( dataSize > 0 )
        {
            pNode->pData = new char[dataSize];

            if( pNode->pData )
            {
                memcpy_s( pNode->pData, dataSize, pSectionNode->pData, dataSize );
                pNode->DataSize = dataSize;
            }
            else
            {
                retVal = OUT_OF_MEMORY;
            }
        }

        if( retVal == SUCCESS )
        {
            // push the node onto the queue
            m_nodeQueue.push( pNode );

            // increment the sizes for each section
            m_dataSize += dataSize;
            m_stringTableSize += nameSize;
            m_numSections++;
        }
        else
        {
            // cleanup allocations
            if( pNode )
            {
                if( pNode->pData )
                {
                    delete[] pNode->pData;
                    pNode->pData = NULL;
                }

                delete pNode;
            }
        }
    }

    return retVal;
}

/******************************************************************************\
 Member Function: CElfWriter::ResolveBinary
\******************************************************************************/
E_RETVAL CElfWriter::ResolveBinary(
    char* const pBinary,
    size_t& binarySize )
{
    E_RETVAL retVal = SUCCESS;
    SSectionNode* pNode = NULL;
    SElf64SectionHeader* pCurSectionHeader = NULL;
    char* pData = NULL;
    char* pStringTable = NULL;
    char* pCurString = NULL;

    m_totalBinarySize =
        sizeof( SElf64Header ) +
        ( ( m_numSections + 1 ) * sizeof( SElf64SectionHeader ) ) + // +1 to account for string table entry
        m_dataSize +
        m_stringTableSize;

    if( pBinary )
    {
        // get a pointer to the first section header
        pCurSectionHeader = (SElf64SectionHeader*)( pBinary + sizeof( SElf64Header ) );

        // get a pointer to the data
        pData = pBinary +
            sizeof( SElf64Header ) +
            ( ( m_numSections + 1 ) * sizeof( SElf64SectionHeader ) ); // +1 to account for string table entry


        // get a pointer to the string table
        pStringTable = pBinary + sizeof( SElf64Header ) +
            ( ( m_numSections + 1 ) * sizeof( SElf64SectionHeader ) ) + // +1 to account for string table entry
            m_dataSize ;

        pCurString = pStringTable;

        // Walk through the section nodes
        while( m_nodeQueue.empty() == false )
        {
            pNode = m_nodeQueue.front();

            if( pNode )
            {
                m_nodeQueue.pop();

                // Copy data into the section header
                memset( pCurSectionHeader, 0, sizeof( SElf64SectionHeader ) );
                pCurSectionHeader->Type = pNode->Type;
                pCurSectionHeader->Flags = pNode->Flags;
                pCurSectionHeader->DataSize = pNode->DataSize;
                pCurSectionHeader->DataOffset = pData - pBinary;
                pCurSectionHeader->Name = (Elf64_Word)( pCurString - pStringTable );
                pCurSectionHeader = (SElf64SectionHeader*)(
                    (unsigned char*)pCurSectionHeader + sizeof( SElf64SectionHeader ) );

                // copy the data, move the data pointer
                memcpy_s( pData, pNode->DataSize, pNode->pData, pNode->DataSize );
                pData += pNode->DataSize;

                // copy the name into the string table, move the string pointer
                if ( pNode->Name.size() > 0 )
                {
                    memcpy_s( pCurString, pNode->Name.size(), pNode->Name.c_str(), pNode->Name.size() );
                    pCurString += pNode->Name.size();
                }
                *(pCurString++) = '\0';

                // delete the node and it's data
                if( pNode )
                {
                    if( pNode->pData )
                    {
                        delete[] pNode->pData;
                        pNode->pData = NULL;
                    }

                    delete pNode;
                }
            }
        }

        // add the string table section header
        SElf64SectionHeader stringSectionHeader = { 0 };
        stringSectionHeader.Type = SH_TYPE_STR_TBL;
        stringSectionHeader.Flags = 0;
        stringSectionHeader.DataOffset = pStringTable - pBinary;
        stringSectionHeader.DataSize = m_stringTableSize;
        stringSectionHeader.Name = 0;

        // Copy into the last section header
        memcpy_s( pCurSectionHeader, sizeof( SElf64SectionHeader ),
            &stringSectionHeader, sizeof( SElf64SectionHeader ) );

        // Add to our section number
        m_numSections++;

        // patch up the ELF header
        retVal = PatchElfHeader( pBinary );
    }

    if( retVal == SUCCESS )
    {
        binarySize = m_totalBinarySize;
    }

    return retVal;
}

/******************************************************************************\
 Member Function: CElfWriter::Initialize
\******************************************************************************/
E_RETVAL CElfWriter::Initialize()
{
    E_RETVAL retVal = SUCCESS;
    SSectionNode emptySection;

    // Add an empty section 0 (points to "no-bits")
    AddSection( &emptySection );

    return retVal;
}

/******************************************************************************\
 Member Function: CElfWriter::PatchElfHeader
\******************************************************************************/
E_RETVAL CElfWriter::PatchElfHeader( char* const pBinary )
{
    E_RETVAL   retVal   = SUCCESS;
    SElf64Header* pElfHeader = (SElf64Header*)pBinary;

    if( pElfHeader )
    {
        // Setup the identity
        memset( pElfHeader, 0x00, sizeof( SElf64Header ) );
        pElfHeader->Identity[ID_IDX_MAGIC0]       = ELF_MAG0;
        pElfHeader->Identity[ID_IDX_MAGIC1]       = ELF_MAG1;
        pElfHeader->Identity[ID_IDX_MAGIC2]       = ELF_MAG2;
        pElfHeader->Identity[ID_IDX_MAGIC3]       = ELF_MAG3;
        pElfHeader->Identity[ID_IDX_CLASS]        = EH_CLASS_64;
        pElfHeader->Identity[ID_IDX_VERSION]      = EH_VERSION_CURRENT;

        // Add other non-zero info
        pElfHeader->Type = m_type;
        pElfHeader->Machine = m_machine;
        pElfHeader->Flags = (unsigned int)m_flags;
        pElfHeader->ElfHeaderSize = sizeof( SElf64Header );
        pElfHeader->SectionHeaderEntrySize = sizeof( SElf64SectionHeader );
        pElfHeader->NumSectionHeaderEntries = (Elf64_Short)m_numSections;
        pElfHeader->SectionHeadersOffset = (unsigned int)( sizeof( SElf64Header ) );
        pElfHeader->SectionNameTableIndex = m_numSections-1; // last index
    }

    return retVal;
}

} // namespace OclElfLib
