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//===----------------------------------------------------------------------===// 937b74a387bb3993387029859c2d9d051c41c724eStephen Hines#ifndef MCLD_OBJECT_OBJECTBUILDER_H_ 1037b74a387bb3993387029859c2d9d051c41c724eStephen Hines#define MCLD_OBJECT_OBJECTBUILDER_H_ 1137b74a387bb3993387029859c2d9d051c41c724eStephen Hines#include "mcld/LD/EhFrame.h" 1237b74a387bb3993387029859c2d9d051c41c724eStephen Hines#include "mcld/LD/LDFileFormat.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 Fragment; 2187f34658dec9097d987d254a990ea7f311bfc95fStephen Hinesclass Input; 2237b74a387bb3993387029859c2d9d051c41c724eStephen Hinesclass LDSection; 2337b74a387bb3993387029859c2d9d051c41c724eStephen Hinesclass Module; 2437b74a387bb3993387029859c2d9d051c41c724eStephen Hinesclass SectionData; 2522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 2622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao/** \class ObjectBuilder 2722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao * \brief ObjectBuilder recieve ObjectAction and build the mcld::Module. 2822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao */ 2937b74a387bb3993387029859c2d9d051c41c724eStephen Hinesclass ObjectBuilder { 3037b74a387bb3993387029859c2d9d051c41c724eStephen Hines public: 3137b74a387bb3993387029859c2d9d051c41c724eStephen Hines explicit ObjectBuilder(Module& pTheModule); 3222add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 3337b74a387bb3993387029859c2d9d051c41c724eStephen Hines /// @} 3437b74a387bb3993387029859c2d9d051c41c724eStephen Hines /// @name Section Methods 3537b74a387bb3993387029859c2d9d051c41c724eStephen Hines /// @{ 3622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// CreateSection - To create an output LDSection in mcld::Module. 3722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// Link scripts and command line options define some SECTIONS commands that 3837b74a387bb3993387029859c2d9d051c41c724eStephen Hines /// specify where input sections are placed into output sections. This 3937b74a387bb3993387029859c2d9d051c41c724eStephen Hines /// 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 /// 4437b74a387bb3993387029859c2d9d051c41c724eStephen Hines /// To create an input LDSection in mcld::LDContext, use @ref 4537b74a387bb3993387029859c2d9d051c41c724eStephen Hines /// LDSection::Create(). 4622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// 4722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @see SectionMap 4822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// 4922add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @param [in] pName The given name. Returned LDSection used the changed name 5022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// by SectionMap. 5122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao LDSection* CreateSection(const std::string& pInputName, 5222add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao LDFileFormat::Kind pKind, 5322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao uint32_t pType, 5422add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao uint32_t pFlag, 5522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao uint32_t pAlign = 0x0); 5622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 5722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// MergeSection - merge the pInput section to mcld::Module. 5822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// This function moves all fragments in pInputSection to the corresponding 59551ae4ebd3e9d137ea668fb83ae4a55b8cfba451Stephen Hines /// output section of mcld::Module. 6022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// 6122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @see SectionMap 6222add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @param [in] pInputSection The merged input section. 636f75755c9204b1d8817ae5a65a2f7e5af0ec3f70Stephen Hines /// @return The merged output section. If the corresponding output sections 646f75755c9204b1d8817ae5a65a2f7e5af0ec3f70Stephen Hines /// is not defined, return NULL. 6587f34658dec9097d987d254a990ea7f311bfc95fStephen Hines LDSection* MergeSection(const Input& pInputFile, LDSection& pInputSection); 6622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 6722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// MoveSectionData - move the fragment of pFrom to pTo section data. 6822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao static bool MoveSectionData(SectionData& pFrom, SectionData& pTo); 6922add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 706f75755c9204b1d8817ae5a65a2f7e5af0ec3f70Stephen Hines /// UpdateSectionAlign - update alignment for input section 716f75755c9204b1d8817ae5a65a2f7e5af0ec3f70Stephen Hines static void UpdateSectionAlign(LDSection& pTo, const LDSection& pFrom); 726f75755c9204b1d8817ae5a65a2f7e5af0ec3f70Stephen Hines 73551ae4ebd3e9d137ea668fb83ae4a55b8cfba451Stephen Hines /// UpdateSectionAlign - update alignment for the section 74551ae4ebd3e9d137ea668fb83ae4a55b8cfba451Stephen Hines static void UpdateSectionAlign(LDSection& pSection, 75551ae4ebd3e9d137ea668fb83ae4a55b8cfba451Stephen Hines uint32_t pAlignConstraint); 76551ae4ebd3e9d137ea668fb83ae4a55b8cfba451Stephen Hines 7737b74a387bb3993387029859c2d9d051c41c724eStephen Hines /// @} 7837b74a387bb3993387029859c2d9d051c41c724eStephen Hines /// @name Fragment Methods 7937b74a387bb3993387029859c2d9d051c41c724eStephen Hines /// @{ 8022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// AppendFragment - To append pFrag to the given SectionData pSD. 8122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// In order to keep the alignment of pFrag, This function inserts an 8222add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// AlignFragment before pFrag if pAlignConstraint is larger than 1. 8322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// 8422add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @note This function does not update the alignment constraint of LDSection. 8522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// 8622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @param [in, out] pFrag The appended fragment. The offset of the appended 8722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// pFrag is set to the offset in pSD. 8822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @param [in, out] pSD The section data being appended. 8922add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @param [in] pAlignConstraint The alignment constraint. 9022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// @return Total size of the inserted fragments. 9137b74a387bb3993387029859c2d9d051c41c724eStephen Hines static uint64_t AppendFragment(Fragment& pFrag, 9237b74a387bb3993387029859c2d9d051c41c724eStephen Hines SectionData& pSD, 9322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao uint32_t pAlignConstraint = 1); 9422add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 9537b74a387bb3993387029859c2d9d051c41c724eStephen Hines private: 9622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao Module& m_Module; 9722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao}; 9822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 9937b74a387bb3993387029859c2d9d051c41c724eStephen Hines} // namespace mcld 10022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 10137b74a387bb3993387029859c2d9d051c41c724eStephen Hines#endif // MCLD_OBJECT_OBJECTBUILDER_H_ 102