15460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao//===- MemoryRegion.h -----------------------------------------------------===// 25460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// 35460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// The MCLinker Project 45460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// 55460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// This file is distributed under the University of Illinois Open Source 65460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// License. See LICENSE.TXT for details. 75460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// 85460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao//===----------------------------------------------------------------------===// 95460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#ifndef LD_MEMORY_REGION_H 105460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#define LD_MEMORY_REGION_H 115460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#ifdef ENABLE_UNITTEST 125460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#include <gtest.h> 135460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#endif 145460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 155460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#include <mcld/ADT/Uncopyable.h> 165460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#include <mcld/ADT/SizeTraits.h> 175460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#include <mcld/ADT/TypeTraits.h> 185460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#include <mcld/Support/FileSystem.h> 195460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#include <mcld/Support/MemoryArea.h> 205460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#include <llvm/ADT/ilist.h> 215460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#include <llvm/ADT/StringRef.h> 225460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 235460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaonamespace mcld 245460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao{ 255460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 265460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao/** \class MemoryRegion 275460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * \brief MemoryRegion is a range of virtual memory which is mapped onto a 285460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * range of files which is opened by MemoryArea. 295460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * 305460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * MemoryArea maps a file onto virtual memory. Clients can get a range of 315460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * mapped memory space by requesting a MemoryRegion from MemoryArea, and 325460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * read/write the mapped file through the MemoryRegion. 335460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * 345460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * When two different MemoryRegion may overlap memory space, race condition 355460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * may occurs. Clients must call MemoryRegion::sync() explicit to tell the 365460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * MemoryArea when to synchronize the virtual memory space with the mapped 375460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * file. 385460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao */ 395460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaoclass MemoryRegion : private Uncopyable 405460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao{ 415460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaofriend class RegionFactory; 425460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaofriend class MemoryArea; 435460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 445460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaopublic: 455460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaotypedef NonConstTraits<mcld::sys::fs::detail::Address>::value_type Address; 465460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaotypedef ConstTraits<mcld::sys::fs::detail::Address>::value_type ConstAddress; 475460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaotypedef NonConstTraits<mcld::sys::fs::detail::Offset>::value_type Offset; 485460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaotypedef ConstTraits<mcld::sys::fs::detail::Offset>::value_type ConstOffset; 495460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 505460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaoprivate: 515460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao MemoryRegion(MemoryArea::Space* pParentSpace, 525460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao const Address pVMAStart, 535460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao size_t pSize); 545460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 555460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao // drift - leave parent space 565460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao void drift(); 575460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 585460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao MemoryArea::Space* parent() 595460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_pParentSpace; } 605460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 615460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao const MemoryArea::Space* parent() const 625460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_pParentSpace; } 635460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 645460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaopublic: 655460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao ~MemoryRegion(); 665460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 675460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao Address start() 685460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_VMAStart; } 695460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 705460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao ConstAddress start() const 715460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_VMAStart; } 725460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 735460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao Address end() 745460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_VMAStart+m_Length; } 755460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 765460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao ConstAddress end() const 775460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_VMAStart+m_Length; } 785460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 795460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao size_t size() const 805460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_Length; } 815460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 825460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao Address getBuffer(Offset pOffset = 0) 835460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_VMAStart+pOffset; } 845460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 855460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao ConstAddress getBuffer(Offset pOffset = 0) const 865460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_VMAStart+pOffset; } 875460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 885460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaoprivate: 895460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao MemoryArea::Space* m_pParentSpace; 905460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao Address m_VMAStart; 915460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao size_t m_Length; 925460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao}; 935460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 945460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao} // namespace of mcld 955460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 965460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#endif 975460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 98