MCAsmLayout.h revision 85f2ecc697a8ca6c8cf08093054cbbb9d2060ccf
148a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org//===- MCAsmLayout.h - Assembly Layout Object -------------------*- C++ -*-===// 248a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org// 348a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org// The LLVM Compiler Infrastructure 448a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org// 548a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org// This file is distributed under the University of Illinois Open Source 648a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org// License. See LICENSE.TXT for details. 748a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org// 848a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org//===----------------------------------------------------------------------===// 948a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 1048a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org#ifndef LLVM_MC_MCASMLAYOUT_H 1148a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org#define LLVM_MC_MCASMLAYOUT_H 1248a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 1348a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org#include "llvm/ADT/SmallVector.h" 1448a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 1548a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.orgnamespace llvm { 1648a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.orgclass MCAssembler; 1748a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.orgclass MCFragment; 1848a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.orgclass MCSectionData; 1948a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.orgclass MCSymbolData; 2048a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 2148a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org/// Encapsulates the layout of an assembly file at a particular point in time. 2248a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org/// 2348a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org/// Assembly may requiring compute multiple layouts for a particular assembly 2448a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org/// file as part of the relaxation process. This class encapsulates the layout 2548a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org/// at a single point in time in such a way that it is always possible to 2648a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org/// efficiently compute the exact addresses of any symbol in the assembly file, 2748a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org/// even during the relaxation process. 2848a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.orgclass MCAsmLayout { 2948a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.orgpublic: 3048a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org typedef llvm::SmallVectorImpl<MCSectionData*>::const_iterator const_iterator; 3148a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org typedef llvm::SmallVectorImpl<MCSectionData*>::iterator iterator; 3248a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 3348a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.orgprivate: 3448a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org MCAssembler &Assembler; 3548a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 3648a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// List of sections in layout order. 3748a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org llvm::SmallVector<MCSectionData*, 16> SectionOrder; 3848a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 3948a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// The last fragment which was layed out, or 0 if nothing has been layed 4048a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// out. Fragments are always layed out in order, so all fragments with a 4148a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// lower ordinal will be up to date. 4248a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org mutable MCFragment *LastValidFragment; 4348a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 4448a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// \brief Make sure that the layout for the given fragment is valid, lazily 4548a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// computing it if necessary. 4648a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org void EnsureValid(const MCFragment *F) const; 4748a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 4848a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org bool isSectionUpToDate(const MCSectionData *SD) const; 4948a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org bool isFragmentUpToDate(const MCFragment *F) const; 5048a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 5148a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.orgpublic: 5248a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org MCAsmLayout(MCAssembler &_Assembler); 5348a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 5448a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// Get the assembler object this is a layout for. 5548a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org MCAssembler &getAssembler() const { return Assembler; } 5648a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 5748a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// \brief Invalidate all following fragments because a fragment has been resized. The 5848a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// fragments size should have already been updated. 5948a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org void Invalidate(MCFragment *F); 6048a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 6148a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// \brief Perform a full layout. 6248a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org void LayoutFile(); 6348a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 6448a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// \brief Perform layout for a single fragment, assuming that the previous 6548a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// fragment has already been layed out correctly, and the parent section has 6648a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// been initialized. 6748a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org void LayoutFragment(MCFragment *Fragment); 6848a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 6948a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// @name Section Access (in layout order) 7048a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// @{ 7148a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 7248a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org llvm::SmallVectorImpl<MCSectionData*> &getSectionOrder() { 7348a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org return SectionOrder; 7448a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org } 7548a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org const llvm::SmallVectorImpl<MCSectionData*> &getSectionOrder() const { 7648a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org return SectionOrder; 7748a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org } 7848a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 7948a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// @} 8048a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// @name Fragment Layout Data 8148a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// @{ 8248a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 8348a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// \brief Get the effective size of the given fragment, as computed in the 8448a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// current layout. 8548a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org uint64_t getFragmentEffectiveSize(const MCFragment *F) const; 8648a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 8748a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// \brief Get the offset of the given fragment inside its containing section. 8848a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org uint64_t getFragmentOffset(const MCFragment *F) const; 8948a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 9048a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// @} 9148a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// @name Utility Functions 9248a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// @{ 9348a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 9448a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// \brief Get the address space size of the given section, as it effects 9548a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// layout. This may differ from the size reported by \see getSectionSize() by 9648a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// not including section tail padding. 9748a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org uint64_t getSectionAddressSize(const MCSectionData *SD) const; 9848a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 9948a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// \brief Get the data size of the given section, as emitted to the object 10048a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// file. This may include additional padding, or be 0 for virtual sections. 10148a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org uint64_t getSectionFileSize(const MCSectionData *SD) const; 10248a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 10348a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// \brief Get the offset of the given symbol, as computed in the current 10448a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// layout. 10548a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org uint64_t getSymbolOffset(const MCSymbolData *SD) const; 10648a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 10748a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org /// @} 10848a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org}; 10948a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 11048a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org} // end namespace llvm 11148a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org 11248a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org#endif 11348a7b2e84057589be933b5182cded67c9885f8e8henrike@webrtc.org