folly::MemoryMapping::Options Struct Reference

#include <MemoryMapping.h>

Public Member Functions
	Options ()
Options &	setPageSize (off_t v)
Options &	setShared (bool v)
Options &	setPrefault (bool v)
Options &	setReadable (bool v)
Options &	setWritable (bool v)
Options &	setGrow (bool v)

Public Attributes
off_t	pageSize = 0
bool	shared = true
bool	prefault = false
bool	readable = true
bool	writable = false
bool	grow = false
void *	address = nullptr

Detailed Description

Map a portion of the file indicated by filename in memory, causing a CHECK failure on error.

By default, map the whole file. length=-1: map from offset to EOF. Unlike the mmap() system call, offset and length don't need to be page-aligned. length is clipped to the end of the file if it's too large.

The mapping will be destroyed (and the memory pointed-to by data() will likely become inaccessible) when the MemoryMapping object is destroyed.

Definition at line 54 of file MemoryMapping.h.

Constructor & Destructor Documentation

folly::MemoryMapping::Options::Options ( )

inline

Definition at line 55 of file MemoryMapping.h.

{}

Member Function Documentation

Options& folly::MemoryMapping::Options::setGrow ( bool  v )

inline

Definition at line 78 of file MemoryMapping.h.

References v.

Referenced by folly::MemoryMapping::writable().

                             {
      grow = v;
      return *this;
    }

Options& folly::MemoryMapping::Options::setPageSize ( off_t  v )

inline

Definition at line 58 of file MemoryMapping.h.

References v.

                                  {
      pageSize = v;
      return *this;
    }

Options& folly::MemoryMapping::Options::setPrefault ( bool  v )

inline

Definition at line 66 of file MemoryMapping.h.

References v.

                                 {
      prefault = v;
      return *this;
    }

Options& folly::MemoryMapping::Options::setReadable ( bool  v )

inline

Definition at line 70 of file MemoryMapping.h.

References v.

                                 {
      readable = v;
      return *this;
    }

Options& folly::MemoryMapping::Options::setShared ( bool  v )

inline

Definition at line 62 of file MemoryMapping.h.

References v.

                               {
      shared = v;
      return *this;
    }

Options& folly::MemoryMapping::Options::setWritable ( bool  v )

inline

Definition at line 74 of file MemoryMapping.h.

References v, and folly::MemoryMapping::writable().

Referenced by folly::MemoryMapping::writable().

                                 {
      writable = v;
      return *this;
    }

Member Data Documentation

void* folly::MemoryMapping::Options::address = nullptr

Definition at line 114 of file MemoryMapping.h.

Referenced by folly::MemoryMapping::init().

bool folly::MemoryMapping::Options::grow = false

Definition at line 110 of file MemoryMapping.h.

Referenced by folly::MemoryMapping::init().

off_t folly::MemoryMapping::Options::pageSize = 0

Definition at line 86 of file MemoryMapping.h.

Referenced by folly::MemoryMapping::advise(), folly::MemoryMapping::init(), folly::MemoryMapping::mlock(), folly::MemoryMapping::munlock(), and folly::MemoryMapping::~MemoryMapping().

bool folly::MemoryMapping::Options::prefault = false

Definition at line 97 of file MemoryMapping.h.

Referenced by folly::MemoryMapping::init().

bool folly::MemoryMapping::Options::readable = true

Definition at line 102 of file MemoryMapping.h.

Referenced by folly::MemoryMapping::init().

bool folly::MemoryMapping::Options::shared = true

Definition at line 93 of file MemoryMapping.h.

Referenced by folly::MemoryMapping::init().

bool folly::MemoryMapping::Options::writable = false

Definition at line 105 of file MemoryMapping.h.

Referenced by folly::MemoryMapping::asWritableRange(), folly::MemoryMapping::init(), and folly::MemoryMapping::writableRange().

---

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

• proxygen/folly/folly/system/MemoryMapping.h