llvm::sys::fs::mapped_file_region Class Reference

This class represents a memory mapped file. More...

#include "llvm/Support/FileSystem.h"

Public Types
enum	mapmode { readonly, readwrite, priv }

Public Member Functions
	mapped_file_region ()=delete
	mapped_file_region (mapped_file_region &)=delete
mapped_file_region &	operator= (mapped_file_region &)=delete
	mapped_file_region (int fd, mapmode mode, size_t length, uint64_t offset, std::error_code &ec)
	~mapped_file_region ()
size_t	size () const
char *	data () const
const char *	const_data () const
	Get a const view of the data. More...

Static Public Member Functions
static int	alignment ()

Detailed Description

This class represents a memory mapped file.

It is based on boost::iostreams::mapped_file.

Definition at line 1075 of file FileSystem.h.

Member Enumeration Documentation

mapmode

enum llvm::sys::fs::mapped_file_region::mapmode

Enumerator
readonly	May only access map via const_data as read only.
readwrite	May access map via data and modify it. Written to path.
priv	May modify via data, but changes are lost on destruction.

Definition at line 1077 of file FileSystem.h.

Constructor & Destructor Documentation

mapped_file_region() [1/3]

llvm::sys::fs::mapped_file_region::mapped_file_region ( )

delete

mapped_file_region() [2/3]

llvm::sys::fs::mapped_file_region::mapped_file_region ( mapped_file_region &  )

delete

mapped_file_region() [3/3]

llvm::sys::fs::mapped_file_region::mapped_file_region	(	int	fd,
		mapmode	mode,
		size_t	length,
		uint64_t	offset,
		std::error_code &	ec
	)

Parameters

fd	An open file descriptor to map. mapped_file_region takes ownership if closefd is true. It must have been opended in the correct mode.

~mapped_file_region()

llvm::sys::fs::mapped_file_region::~mapped_file_region

(

)

Member Function Documentation

alignment()

static int llvm::sys::fs::mapped_file_region::alignment ( )

static

Returns

The minimum alignment offset must be.

Referenced by llvm::MemoryBuffer::getFileSlice().

const_data()

const char* llvm::sys::fs::mapped_file_region::const_data

(

)

const

Get a const view of the data.

Modifying this memory has undefined behavior.

Referenced by llvm::MemoryBuffer::getFileSlice().

data()

char* llvm::sys::fs::mapped_file_region::data

(

)

const

Referenced by llvm::xray::loadProfile(), llvm::xray::loadTraceFile(), and loadYAML().

operator=()

mapped_file_region& llvm::sys::fs::mapped_file_region::operator= ( mapped_file_region &  )

delete

size()

size_t llvm::sys::fs::mapped_file_region::size

(

)

const

Referenced by llvm::xray::loadProfile(), llvm::xray::loadTraceFile(), and loadYAML().

---

The documentation for this class was generated from the following file:

• include/llvm/Support/FileSystem.h