122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao//===- ObjectBuilder.h ----------------------------------------------------===// 222add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao// 322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao// The MCLinker Project 422add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao// 522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao// This file is distributed under the University of Illinois Open Source 622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao// License. See LICENSE.TXT for details. 722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao// 822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao//===----------------------------------------------------------------------===// 987f34658dec9097d987d254a990ea7f311bfc95fStephen Hines#ifndef MCLD_OBJECT_OBJECTBUILDER_H 1087f34658dec9097d987d254a990ea7f311bfc95fStephen Hines#define MCLD_OBJECT_OBJECTBUILDER_H 1122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao#include <mcld/LD/LDFileFormat.h> 1222add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao#include <mcld/LD/EhFrame.h> 1322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 1422add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao#include <llvm/Support/DataTypes.h> 1522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 1622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao#include <string> 1722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 1822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liaonamespace mcld { 1922add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 2022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liaoclass Module; 2122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liaoclass LDSection; 2222add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liaoclass SectionData; 2322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liaoclass Fragment; 2487f34658dec9097d987d254a990ea7f311bfc95fStephen Hinesclass Input; 2522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 2622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao/** \class ObjectBuilder 2722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao * \brief ObjectBuilder recieve ObjectAction and build the mcld::Module. 2822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao */ 2922add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liaoclass ObjectBuilder 3022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao{ 3122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liaopublic: 32533eae20118036f425f27bf0536ef0ccbb090b65Stephen Hines ObjectBuilder(Module& pTheModule); 3322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 3422add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao/// @} 3522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao/// @name Section Methods 3622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao/// @{ 3722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// CreateSection - To create an output LDSection in mcld::Module. 3822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// Link scripts and command line options define some SECTIONS commands that 3922add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// specify where input sections are placed into output sections. This function 4022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// checks SECTIONS commands to change given name to the output section name. 4122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// This function creates a new LDSection and push the created LDSection into 4222add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @ref mcld::Module. 4322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// 4422add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// To create an input LDSection in mcld::LDContext, use @ref LDSection::Create(). 4522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// 4622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @see SectionMap 4722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// 4822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @param [in] pName The given name. Returned LDSection used the changed name 4922add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// by SectionMap. 5022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao LDSection* CreateSection(const std::string& pInputName, 5122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao LDFileFormat::Kind pKind, 5222add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao uint32_t pType, 5322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao uint32_t pFlag, 5422add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao uint32_t pAlign = 0x0); 5522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 5622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// MergeSection - merge the pInput section to mcld::Module. 5722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// This function moves all fragments in pInputSection to the corresponding 58551ae4ebd3e9d137ea668fb83ae4a55b8cfba451Stephen Hines /// output section of mcld::Module. 5922add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// 6022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @see SectionMap 6122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @param [in] pInputSection The merged input section. 626f75755c9204b1d8817ae5a65a2f7e5af0ec3f70Stephen Hines /// @return The merged output section. If the corresponding output sections 636f75755c9204b1d8817ae5a65a2f7e5af0ec3f70Stephen Hines /// is not defined, return NULL. 6487f34658dec9097d987d254a990ea7f311bfc95fStephen Hines LDSection* MergeSection(const Input& pInputFile, LDSection& pInputSection); 6522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 6622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// MoveSectionData - move the fragment of pFrom to pTo section data. 6722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao static bool MoveSectionData(SectionData& pFrom, SectionData& pTo); 6822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 696f75755c9204b1d8817ae5a65a2f7e5af0ec3f70Stephen Hines /// UpdateSectionAlign - update alignment for input section 706f75755c9204b1d8817ae5a65a2f7e5af0ec3f70Stephen Hines static void UpdateSectionAlign(LDSection& pTo, const LDSection& pFrom); 716f75755c9204b1d8817ae5a65a2f7e5af0ec3f70Stephen Hines 72551ae4ebd3e9d137ea668fb83ae4a55b8cfba451Stephen Hines /// UpdateSectionAlign - update alignment for the section 73551ae4ebd3e9d137ea668fb83ae4a55b8cfba451Stephen Hines static void UpdateSectionAlign(LDSection& pSection, 74551ae4ebd3e9d137ea668fb83ae4a55b8cfba451Stephen Hines uint32_t pAlignConstraint); 75551ae4ebd3e9d137ea668fb83ae4a55b8cfba451Stephen Hines 7622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao/// @} 7722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao/// @name Fragment Methods 7822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao/// @{ 7922add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// AppendFragment - To append pFrag to the given SectionData pSD. 8022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// In order to keep the alignment of pFrag, This function inserts an 8122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// AlignFragment before pFrag if pAlignConstraint is larger than 1. 8222add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// 8322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @note This function does not update the alignment constraint of LDSection. 8422add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// 8522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @param [in, out] pFrag The appended fragment. The offset of the appended 8622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// pFrag is set to the offset in pSD. 8722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @param [in, out] pSD The section data being appended. 8822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @param [in] pAlignConstraint The alignment constraint. 8922add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @return Total size of the inserted fragments. 9022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao static uint64_t AppendFragment(Fragment& pFrag, SectionData& pSD, 9122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao uint32_t pAlignConstraint = 1); 9222add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 9322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liaoprivate: 9422add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao Module& m_Module; 9522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao}; 9622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 9722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao} // namespace of mcld 9822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 9922add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao#endif 10022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 101