1 //===- ObjectBuilder.h ----------------------------------------------------===// 2 // 3 // The MCLinker Project 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 #ifndef MCLD_OBJECT_OBJECT_BUILDER_H 10 #define MCLD_OBJECT_OBJECT_BUILDER_H 11 #ifdef ENABLE_UNITTEST 12 #include <gtest.h> 13 #endif 14 #include <mcld/LD/LDFileFormat.h> 15 #include <mcld/LD/EhFrame.h> 16 17 #include <llvm/Support/DataTypes.h> 18 19 #include <string> 20 21 namespace mcld { 22 23 class LinkerConfig; 24 class Module; 25 class LDSection; 26 class SectionData; 27 class RelocData; 28 class Fragment; 29 class Relocation; 30 31 /** \class ObjectBuilder 32 * \brief ObjectBuilder recieve ObjectAction and build the mcld::Module. 33 */ 34 class ObjectBuilder 35 { 36 public: 37 ObjectBuilder(const LinkerConfig& pConfig, 38 Module& pTheModule); 39 40 /// @} 41 /// @name Section Methods 42 /// @{ 43 /// CreateSection - To create an output LDSection in mcld::Module. 44 /// Link scripts and command line options define some SECTIONS commands that 45 /// specify where input sections are placed into output sections. This function 46 /// checks SECTIONS commands to change given name to the output section name. 47 /// This function creates a new LDSection and push the created LDSection into 48 /// @ref mcld::Module. 49 /// 50 /// To create an input LDSection in mcld::LDContext, use @ref LDSection::Create(). 51 /// 52 /// @see SectionMap 53 /// 54 /// @param [in] pName The given name. Returned LDSection used the changed name 55 /// by SectionMap. 56 LDSection* CreateSection(const std::string& pInputName, 57 LDFileFormat::Kind pKind, 58 uint32_t pType, 59 uint32_t pFlag, 60 uint32_t pAlign = 0x0); 61 62 /// MergeSection - merge the pInput section to mcld::Module. 63 /// This function moves all fragments in pInputSection to the corresponding 64 /// output section of mcld::Module. 65 /// 66 /// @see SectionMap 67 /// @param [in] pInputSection The merged input section. 68 /// @return The merged output section. If the corresponding output sections 69 /// is not defined, return NULL. 70 LDSection* MergeSection(LDSection& pInputSection); 71 72 /// MoveSectionData - move the fragment of pFrom to pTo section data. 73 static bool MoveSectionData(SectionData& pFrom, SectionData& pTo); 74 75 /// UpdateSectionAlign - update alignment for input section 76 static void UpdateSectionAlign(LDSection& pTo, const LDSection& pFrom); 77 78 /// @} 79 /// @name Fragment Methods 80 /// @{ 81 /// AppendFragment - To append pFrag to the given SectionData pSD. 82 /// In order to keep the alignment of pFrag, This function inserts an 83 /// AlignFragment before pFrag if pAlignConstraint is larger than 1. 84 /// 85 /// @note This function does not update the alignment constraint of LDSection. 86 /// 87 /// @param [in, out] pFrag The appended fragment. The offset of the appended 88 /// pFrag is set to the offset in pSD. 89 /// @param [in, out] pSD The section data being appended. 90 /// @param [in] pAlignConstraint The alignment constraint. 91 /// @return Total size of the inserted fragments. 92 static uint64_t AppendFragment(Fragment& pFrag, SectionData& pSD, 93 uint32_t pAlignConstraint = 1); 94 95 private: 96 const LinkerConfig& m_Config; 97 Module& m_Module; 98 }; 99 100 } // namespace of mcld 101 102 #endif 103 104
