16#include "llvm/Config/config.h"
32#include <system_error>
33#if !defined(_MSC_VER) && !defined(__MINGW32__)
50 bool RequiresNullTerminator) {
51 assert((!RequiresNullTerminator || BufEnd[0] == 0) &&
52 "Buffer is not null terminated!");
53 BufferStart = BufStart;
70struct NamedBufferAlloc {
72 NamedBufferAlloc(
const Twine &Name) :
Name(
Name) {}
76void *
operator new(
size_t N,
const NamedBufferAlloc &
Alloc) {
87 static_cast<char *
>(std::malloc(
N +
sizeof(
size_t) + NameRef.
size() + 1));
90 *
reinterpret_cast<size_t *
>(Mem +
N) = NameRef.
size();
98class MemoryBufferMem :
public MB {
100 MemoryBufferMem(StringRef InputData,
bool RequiresNullTerminator) {
102 RequiresNullTerminator);
107 void operator delete(
void *
p) { std::free(p); }
109 StringRef getBufferIdentifier()
const override {
111 return StringRef(
reinterpret_cast<const char *
>(
this + 1) +
sizeof(
size_t),
112 *
reinterpret_cast<const size_t *
>(
this + 1));
121template <
typename MB>
124 bool IsText,
bool RequiresNullTerminator,
bool IsVolatile,
125 std::optional<Align> Alignment);
127std::unique_ptr<MemoryBuffer>
129 bool RequiresNullTerminator) {
130 auto *Ret =
new (NamedBufferAlloc(BufferName))
131 MemoryBufferMem<MemoryBuffer>(InputData, RequiresNullTerminator);
132 return std::unique_ptr<MemoryBuffer>(Ret);
135std::unique_ptr<MemoryBuffer>
138 Ref.getBuffer(),
Ref.getBufferIdentifier(), RequiresNullTerminator));
150 return std::move(Buf);
153std::unique_ptr<MemoryBuffer>
157 return std::move(*Buf);
163 bool RequiresNullTerminator,
164 std::optional<Align> Alignment) {
168 StringRef NameRef = Filename.toStringRef(NameBuf);
172 return getFile(Filename, IsText, RequiresNullTerminator,
179 std::optional<Align> Alignment) {
193template <
typename MB>
210class MemoryBufferMMapFile :
public MB {
221 const char *getStart(uint64_t Len, uint64_t
Offset) {
226 MemoryBufferMMapFile(
bool RequiresNullTerminator,
sys::fs::file_t FD, uint64_t Len,
227 uint64_t
Offset, std::error_code &EC)
228 : MFR(FD, Mapmode<MB>, getLegalMapSize(
Len,
Offset),
238 void operator delete(
void *
p) { std::free(p); }
240 StringRef getBufferIdentifier()
const override {
242 return StringRef(
reinterpret_cast<const char *
>(
this + 1) +
sizeof(
size_t),
243 *
reinterpret_cast<const size_t *
>(
this + 1));
250 void dontNeedIfMmap()
override { MFR.
dontNeed(); }
264 bool RequiresNullTerminator,
bool IsVolatile,
265 std::optional<Align> Alignment) {
269 IsText, RequiresNullTerminator, IsVolatile,
273template <
typename MB>
277 bool IsVolatile, std::optional<Align> Alignment);
279template <
typename MB>
282 bool IsText,
bool RequiresNullTerminator,
bool IsVolatile,
283 std::optional<Align> Alignment) {
290 RequiresNullTerminator, IsVolatile, Alignment);
297 std::optional<Align> Alignment) {
301 Filename, -1, 0,
false,
302 false, IsVolatile, Alignment);
308 std::optional<Align> Alignment) {
312 Filename, MapSize,
Offset,
false,
313 false, IsVolatile, Alignment);
316std::unique_ptr<WritableMemoryBuffer>
318 const Twine &BufferName,
319 std::optional<Align> Alignment) {
320 using MemBuffer = MemoryBufferMem<WritableMemoryBuffer>;
323 Align BufAlign = Alignment.value_or(
Align(16));
330 size_t StringLen =
sizeof(MemBuffer) +
sizeof(
size_t) + NameRef.
size() + 1;
331 size_t RealLen = StringLen +
Size + 1 + BufAlign.
value();
341 char *Mem =
static_cast<char *
>(std::malloc(RealLen));
346 *
reinterpret_cast<size_t *
>(Mem +
sizeof(MemBuffer)) = NameRef.
size();
347 CopyStringRef(Mem +
sizeof(MemBuffer) +
sizeof(
size_t), NameRef);
350 char *Buf = (
char *)
alignAddr(Mem + StringLen, BufAlign);
354 return std::unique_ptr<WritableMemoryBuffer>(Ret);
357std::unique_ptr<WritableMemoryBuffer>
362 memset(SB->getBufferStart(), 0,
Size);
370 bool RequiresNullTerminator,
381 if (IsVolatile && RequiresNullTerminator)
386 if (MapSize < 4 * 4096 || MapSize < (
unsigned)
PageSize)
389 if (!RequiresNullTerminator)
396 if (FileSize ==
size_t(-1)) {
400 FileSize =
Status.getSize();
405 size_t End =
Offset + MapSize;
412 if ((FileSize & (
PageSize -1)) == 0)
415#if defined(__CYGWIN__)
419 if ((FileSize & (4096 - 1)) == 0)
452 FileSize =
Status.getSize();
458 std::unique_ptr<WriteThroughMemoryBuffer> Result(
459 new (NamedBufferAlloc(Filename))
460 MemoryBufferMMapFile<WriteThroughMemoryBuffer>(
false, FD, MapSize,
464 return std::move(Result);
483template <
typename MB>
487 bool IsVolatile, std::optional<Align> Alignment) {
508 FileSize =
Status.getSize();
516 std::unique_ptr<MB> Result(
517 new (NamedBufferAlloc(Filename)) MemoryBufferMMapFile<MB>(
518 RequiresNullTerminator, FD, MapSize,
Offset, EC));
524 if (!RequiresNullTerminator || *Result->getBufferEnd() ==
'\0')
525 return std::move(Result);
530 ErrorOr<bool> NeedsConversion = needConversion(Filename, FD);
531 if (std::error_code EC = NeedsConversion.
getError())
538 if (*NeedsConversion &&
Offset == 0 && MapSize == FileSize)
552 while (!ToRead.
empty()) {
557 if (*ReadBytes == 0) {
558 std::memset(ToRead.
data(), 0, ToRead.
size());
565 return std::move(Buf);
570 uint64_t FileSize,
bool RequiresNullTerminator,
571 bool IsVolatile, std::optional<Align> Alignment) {
575 RequiresNullTerminator, IsVolatile,
581 bool IsVolatile, std::optional<Align> Alignment) {
587 IsVolatile, Alignment);
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
AMDGPU Prepare AGPR Alloc
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static cl::opt< int > PageSize("imp-null-check-page-size", cl::desc("The page size of the target in bytes"), cl::init(4096), cl::Hidden)
static bool shouldUseMmap(sys::fs::file_t FD, size_t FileSize, size_t MapSize, off_t Offset, bool RequiresNullTerminator, int PageSize, bool IsVolatile)
static ErrorOr< std::unique_ptr< MB > > getFileAux(const Twine &Filename, uint64_t MapSize, uint64_t Offset, bool IsText, bool RequiresNullTerminator, bool IsVolatile, std::optional< Align > Alignment)
static ErrorOr< std::unique_ptr< WriteThroughMemoryBuffer > > getReadWriteFile(const Twine &Filename, uint64_t FileSize, uint64_t MapSize, uint64_t Offset)
static ErrorOr< std::unique_ptr< MB > > getOpenFileImpl(sys::fs::file_t FD, const Twine &Filename, uint64_t FileSize, uint64_t MapSize, int64_t Offset, bool RequiresNullTerminator, bool IsVolatile, std::optional< Align > Alignment)
static ErrorOr< std::unique_ptr< WritableMemoryBuffer > > getMemBufferCopyImpl(StringRef InputData, const Twine &BufferName)
static void CopyStringRef(char *Memory, StringRef Data)
CopyStringRef - Copies contents of a StringRef into a block of memory and null-terminates it.
static ErrorOr< std::unique_ptr< WritableMemoryBuffer > > getMemoryBufferForStream(sys::fs::file_t FD, const Twine &BufferName)
Provides a library for accessing information about this process and other processes on the operating ...
This file defines the SmallString class.
size_t size() const
size - Get the array size.
bool empty() const
empty - Check if the array is empty.
Represents either an error or a value T.
std::error_code getError() const
Lightweight error class with error context and mandatory checking.
Tagged union holding either a T or a Error.
Error takeError()
Take ownership of the stored error.
static ErrorOr< std::unique_ptr< MemoryBuffer > > getOpenFile(sys::fs::file_t FD, const Twine &Filename, uint64_t FileSize, bool RequiresNullTerminator=true, bool IsVolatile=false, std::optional< Align > Alignment=std::nullopt)
Given an already-open file descriptor, read the file and return a MemoryBuffer.
static std::unique_ptr< MemoryBuffer > getMemBuffer(StringRef InputData, StringRef BufferName="", bool RequiresNullTerminator=true)
Open the specified memory range as a MemoryBuffer.
BufferKind
The kind of memory backing used to support the MemoryBuffer.
virtual StringRef getBufferIdentifier() const
Return an identifier for this buffer, typically the filename it was read from.
static std::unique_ptr< MemoryBuffer > getMemBufferCopy(StringRef InputData, const Twine &BufferName="")
Open the specified memory range as a MemoryBuffer, copying the contents and taking ownership of it.
static ErrorOr< std::unique_ptr< MemoryBuffer > > getOpenFileSlice(sys::fs::file_t FD, const Twine &Filename, uint64_t MapSize, int64_t Offset, bool IsVolatile=false, std::optional< Align > Alignment=std::nullopt)
Given an already-open file descriptor, map some slice of it into a MemoryBuffer.
void init(const char *BufStart, const char *BufEnd, bool RequiresNullTerminator)
init - Initialize this MemoryBuffer as a reference to externally allocated memory,...
StringRef getBuffer() const
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFileAsStream(const Twine &Filename)
Read all of the specified file into a MemoryBuffer as a stream (i.e.
MemoryBufferRef getMemBufferRef() const
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFileOrSTDIN(const Twine &Filename, bool IsText=false, bool RequiresNullTerminator=true, std::optional< Align > Alignment=std::nullopt)
Open the specified file as a MemoryBuffer, or open stdin if the Filename is "-".
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFileSlice(const Twine &Filename, uint64_t MapSize, uint64_t Offset, bool IsVolatile=false, std::optional< Align > Alignment=std::nullopt)
Map a subrange of the specified file as a MemoryBuffer.
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFile(const Twine &Filename, bool IsText=false, bool RequiresNullTerminator=true, bool IsVolatile=false, std::optional< Align > Alignment=std::nullopt)
Open the specified file as a MemoryBuffer, returning a new MemoryBuffer if successful,...
static ErrorOr< std::unique_ptr< MemoryBuffer > > getSTDIN()
Read all of stdin into a file buffer, and return it.
MutableArrayRef - Represent a mutable reference to an array (0 or more elements consecutively in memo...
MutableArrayRef< T > drop_front(size_t N=1) const
Drop the first N elements of the array.
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
~SmallVectorMemoryBuffer() override
StringRef - Represent a constant reference to a string, i.e.
constexpr size_t size() const
size - Get the string size.
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
StringRef toStringRef(SmallVectorImpl< char > &Out) const
This returns the twine as a single StringRef if it can be represented as such.
The instances of the Type class are immutable: once they are created, they are never changed.
static LLVM_ABI std::unique_ptr< WritableMemoryBuffer > getNewMemBuffer(size_t Size, const Twine &BufferName="")
Allocate a new zero-initialized MemoryBuffer of the specified size.
static LLVM_ABI ErrorOr< std::unique_ptr< WritableMemoryBuffer > > getFile(const Twine &Filename, bool IsVolatile=false, std::optional< Align > Alignment=std::nullopt)
static LLVM_ABI std::unique_ptr< WritableMemoryBuffer > getNewUninitMemBuffer(size_t Size, const Twine &BufferName="", std::optional< Align > Alignment=std::nullopt)
Allocate a new MemoryBuffer of the specified size that is not initialized.
static LLVM_ABI ErrorOr< std::unique_ptr< WritableMemoryBuffer > > getFileSlice(const Twine &Filename, uint64_t MapSize, uint64_t Offset, bool IsVolatile=false, std::optional< Align > Alignment=std::nullopt)
Map a subrange of the specified file as a WritableMemoryBuffer.
static LLVM_ABI ErrorOr< std::unique_ptr< WriteThroughMemoryBuffer > > getFile(const Twine &Filename, int64_t FileSize=-1)
static LLVM_ABI ErrorOr< std::unique_ptr< WriteThroughMemoryBuffer > > getFileSlice(const Twine &Filename, uint64_t MapSize, uint64_t Offset)
Map a subrange of the specified file as a ReadWriteMemoryBuffer.
This class provides various memory handling functions that manipulate MemoryBlock instances.
static unsigned getPageSizeEstimate()
Get the process's estimated page size.
Represents the result of a call to sys::fs::status().
This class represents a memory mapped file.
static LLVM_ABI int alignment()
@ priv
May modify via data, but changes are lost on destruction.
@ readonly
May only access map via const_data as read only.
@ readwrite
May access map via data and modify it. Written to path.
LLVM_ABI const char * const_data() const
Get a const view of the data.
LLVM_ABI std::error_code closeFile(file_t &F)
Close the file object.
LLVM_ABI Error readNativeFileToEOF(file_t FileHandle, SmallVectorImpl< char > &Buffer, ssize_t ChunkSize=DefaultReadChunkSize)
Reads from FileHandle until EOF, appending to Buffer in chunks of size ChunkSize.
@ OF_Text
The file should be opened in text mode on platforms like z/OS that make this distinction.
@ OF_TextWithCRLF
The file should be opened in text mode and use a carriage linefeed '\r '.
file_type
An enumeration for the file system's view of the type.
@ CD_OpenExisting
CD_OpenExisting - When opening a file:
LLVM_ABI Expected< size_t > readNativeFileSlice(file_t FileHandle, MutableArrayRef< char > Buf, uint64_t Offset)
Reads Buf.size() bytes from FileHandle at offset Offset into Buf.
Expected< file_t > openNativeFileForReadWrite(const Twine &Name, CreationDisposition Disp, OpenFlags Flags, unsigned Mode=0666)
Opens the file with the given name in a write-only or read-write mode, returning its open file descri...
LLVM_ABI Expected< file_t > openNativeFileForRead(const Twine &Name, OpenFlags Flags=OF_None, SmallVectorImpl< char > *RealPath=nullptr)
Opens the file with the given name in a read-only mode, returning its open file descriptor.
LLVM_ABI std::error_code status(const Twine &path, file_status &result, bool follow=true)
Get file status as if by POSIX stat().
LLVM_ABI file_t getStdinHandle()
Return an open handle to standard in.
void violationIfEnabled()
LLVM_ABI std::error_code ChangeStdinMode(fs::OpenFlags Flags)
This is an optimization pass for GlobalISel generic memory operations.
std::error_code make_error_code(BitcodeError E)
@ Ref
The access may reference the value stored in memory.
FunctionAddr VTableAddr uintptr_t uintptr_t Data
OutputIt copy(R &&Range, OutputIt Out)
LLVM_ABI std::error_code errorToErrorCode(Error Err)
Helper for converting an ECError to a std::error_code.
LLVM_ABI void report_bad_alloc_error(const char *Reason, bool GenCrashDiag=true)
Reports a bad alloc error, calling any user defined bad alloc error handler.
uintptr_t alignAddr(const void *Addr, Align Alignment)
Aligns Addr to Alignment bytes, rounding up.
This struct is a compact representation of a valid (non-zero power of two) alignment.
constexpr uint64_t value() const
This is a hole in the type system and should not be abused.