Squid Web Cache master
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
MmappedFile Class Reference

#include <MmappedFile.h>

Inheritance diagram for MmappedFile:
[legend]
Collaboration diagram for MmappedFile:
[legend]

Public Types

typedef RefCount< DiskFile > Pointer
 

Public Member Functions

 MmappedFile (char const *path)
 
 ~MmappedFile () override
 
void open (int flags, mode_t mode, RefCount< IORequestor > callback) override
 
void create (int flags, mode_t mode, RefCount< IORequestor > callback) override
 
void read (ReadRequest *) override
 
void write (WriteRequest *) override
 
void close () override
 
bool error () const override
 
int getFD () const override
 
bool canRead () const override
 
bool canWrite () const override
 
bool ioInProgress () const override
 we only support blocking I/O
 
virtual void configure (const Config &)
 notes supported configuration options; kids must call this first
 

Private Member Functions

 CBDATA_CLASS (MmappedFile)
 
void doClose ()
 

Private Attributes

char const * path_
 
RefCount< IORequestor > ioRequestor
 
int fd
 
int64_t minOffset
 enforced if not negative (to preserve file headers)
 
int64_t maxOffset
 enforced if not negative (to avoid crashes)
 
bool error_
 

Detailed Description

Definition at line 16 of file MmappedFile.h.

Member Typedef Documentation

◆ Pointer

typedef RefCount<DiskFile> DiskFile::Pointer
inherited

Definition at line 39 of file DiskFile.h.

Constructor & Destructor Documentation

◆ MmappedFile()

MmappedFile::MmappedFile ( char const *  path)

Definition at line 56 of file MmappedFile.cc.

References assert, debugs, path_, and xstrdup.

◆ ~MmappedFile()

MmappedFile::~MmappedFile ( )
override

Definition at line 64 of file MmappedFile.cc.

References doClose(), path_, and safe_free.

Member Function Documentation

◆ canRead()

bool MmappedFile::canRead ( ) const
overridevirtual

Implements DiskFile.

Definition at line 127 of file MmappedFile.cc.

References fd.

◆ canWrite()

bool MmappedFile::canWrite ( ) const
overridevirtual

Reimplemented from DiskFile.

Definition at line 133 of file MmappedFile.cc.

References fd.

◆ CBDATA_CLASS()

MmappedFile::CBDATA_CLASS ( MmappedFile  )
private

◆ close()

void MmappedFile::close ( )
overridevirtual

Implements DiskFile.

Definition at line 118 of file MmappedFile.cc.

References assert, IORequestor::closeCompleted(), debugs, doClose(), and ioRequestor.

◆ configure()

virtual void DiskFile::configure ( const Config &  )
inlinevirtualinherited

Reimplemented in IpcIoFile.

Definition at line 42 of file DiskFile.h.

Referenced by IpcIoFile::configure().

◆ create()

void MmappedFile::create ( int  flags,
mode_t  mode,
RefCount< IORequestor >  callback 
)
overridevirtual

Alias for MmappedFile::open(...)

Implements DiskFile.

Definition at line 102 of file MmappedFile.cc.

References open().

◆ doClose()

void MmappedFile::doClose ( )
private

Definition at line 108 of file MmappedFile.cc.

References fd, file_close(), and store_open_disk_fd.

Referenced by ~MmappedFile(), close(), and write().

◆ error()

bool MmappedFile::error ( ) const
overridevirtual

Implements DiskFile.

Definition at line 139 of file MmappedFile.cc.

References error_.

◆ getFD()

int MmappedFile::getFD ( ) const
inlineoverridevirtual

During migration only

Reimplemented from DiskFile.

Definition at line 29 of file MmappedFile.h.

References fd.

◆ ioInProgress()

bool MmappedFile::ioInProgress ( ) const
overridevirtual

Implements DiskFile.

Definition at line 215 of file MmappedFile.cc.

◆ open()

void MmappedFile::open ( int  flags,
mode_t  mode,
RefCount< IORequestor >  callback 
)
overridevirtual

Implements DiskFile.

Definition at line 72 of file MmappedFile.cc.

References assert, debugs, error_, fd, file_open(), ioRequestor, maxOffset, path_, store_open_disk_fd, and xstrerr().

Referenced by create().

◆ read()

void MmappedFile::read ( ReadRequest *  aRequest)
overridevirtual

Implements DiskFile.

Definition at line 145 of file MmappedFile.cc.

References assert, ReadRequest::buf, debugs, DISK_ERROR, DISK_OK, error_, fd, ioRequestor, ReadRequest::len, Mmapping::map(), MAP_NORESERVE, maxOffset, minOffset, ReadRequest::offset, IORequestor::readCompleted(), and Mmapping::unmap().

◆ write()

void MmappedFile::write ( WriteRequest *  aRequest)
overridevirtual

Implements DiskFile.

Definition at line 175 of file MmappedFile.cc.

References assert, WriteRequest::buf, DBG_IMPORTANT, debugs, DISK_ERROR, DISK_OK, doClose(), error_, fd, WriteRequest::free_func, ioRequestor, WriteRequest::len, maxOffset, minOffset, WriteRequest::offset, IORequestor::writeCompleted(), and xstrerr().

Member Data Documentation

◆ error_

bool MmappedFile::error_
private

Definition at line 46 of file MmappedFile.h.

Referenced by error(), open(), read(), and write().

◆ fd

int MmappedFile::fd
private

Definition at line 40 of file MmappedFile.h.

Referenced by canRead(), canWrite(), doClose(), getFD(), open(), read(), and write().

◆ ioRequestor

RefCount<IORequestor> MmappedFile::ioRequestor
private

Definition at line 37 of file MmappedFile.h.

Referenced by close(), open(), read(), and write().

◆ maxOffset

int64_t MmappedFile::maxOffset
private

Definition at line 44 of file MmappedFile.h.

Referenced by open(), read(), and write().

◆ minOffset

int64_t MmappedFile::minOffset
private

Definition at line 43 of file MmappedFile.h.

Referenced by read(), and write().

◆ path_

char const* MmappedFile::path_
private

Definition at line 36 of file MmappedFile.h.

Referenced by MmappedFile(), ~MmappedFile(), and open().

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