GNU CommonC++
|
Create and map a disk file into memory. More...
#include <file.h>
Public Member Functions | |
MappedFile (const char *fname, Access mode) | |
Open a file for mapping. | |
MappedFile (const char *fname, Access mode, size_t size) | |
Create if not exists, and map a file of specified size into memory. | |
MappedFile (const char *fname, pos_t offset, size_t size, Access mode) | |
Map a portion or all of a specified file in the specified shared memory access mode. | |
virtual | ~MappedFile () |
Release a mapped section of memory associated with a file. | |
void | sync (void) |
Synchronize the contents of the mapped portion of memory with the disk file and wait for completion. | |
void | sync (char *address, size_t len) |
Synchronize a segment of memory mapped from a segment fetch. | |
void | update (size_t offset=0, size_t len=0) |
Map a portion of the memory mapped from the file back to the file and do not wait for completion. | |
void | update (char *address, size_t len) |
Update a mapped region back to disk as specified by address and length. | |
void | release (char *address, size_t len) |
Release (unmap) a memory segment. | |
char * | fetch (size_t offset=0) |
Fetch a pointer to an offset within the memory mapped portion of the disk file. | |
char * | fetch (off_t pos, size_t len) |
Fetch and map a portion of a disk file to a logical memory block. | |
bool | lock (void) |
Lock the currently mapped portion of a file. | |
void | unlock (void) |
Unlock a locked mapped portion of a file. | |
size_t | pageAligned (size_t size) |
Compute map size to aligned page boundry. | |
![]() | |
virtual | ~RandomFile () |
Destroy a random access file or it's derived class. | |
bool | initial (void) |
This method should be called right after a RandomFile derived object has been created. | |
off_t | getCapacity (void) |
Get current file capacity. | |
virtual Error | restart (void) |
This method is commonly used to close and re-open an existing database. | |
Error | getErrorNumber (void) |
Return current error id. | |
char * | getErrorString (void) |
Return current error string. | |
bool | operator! (void) |
Additional Inherited Members | ||
![]() | ||
enum | Error { errSuccess = 0 , errNotOpened , errMapFailed , errInitFailed , errOpenDenied , errOpenFailed , errOpenInUse , errReadInterrupted , errReadIncomplete , errReadFailure , errWriteInterrupted , errWriteIncomplete , errWriteFailure , errLockFailure , errExtended } | |
enum | Access { accessReadOnly = O_RDONLY , accessWriteOnly = O_WRONLY , accessReadWrite = O_RDWR } | |
enum | Open { openReadOnly = O_RDONLY , openWriteOnly = O_WRONLY , openReadWrite = O_RDWR , openAppend = O_WRONLY | O_APPEND , openSync = O_RDWR , openTruncate = O_RDWR | O_TRUNC } | |
enum | Attr { attrInvalid = 0 , attrPrivate = 0400 | 0200 , attrGroup = attrPrivate | 0040 | 0020 , attrPublic = attrGroup | 0004 | 0002 } | |
enum | Mapping { mappedRead = accessReadOnly , mappedWrite = accessWriteOnly , mappedReadWrite = accessReadWrite } | |
enum | Complete { completionImmediate , completionDelayed , completionDeferred } | |
typedef enum Error | Error | |
typedef enum Access | Access | |
typedef enum Open | Open | |
typedef enum Attr | Attr | |
typedef enum Complete | Complete | |
typedef enum Mapping | Mapping | |
![]() | ||
static const char * | getExtension (const char *path) | |
static const char * | getFilename (const char *path) | |
static char * | getFilename (const char *path, char *buffer, size_t size=64) | |
static char * | getDirname (const char *path, char *buffer, size_t size=256) | |
static char * | getRealpath (const char *path, char *buffer, size_t size=256) | |
![]() | ||
typedef struct ost::File::_fcb | fcb_t | |
enum | Error { errSuccess = 0 , errNotOpened , errMapFailed , errInitFailed , errOpenDenied , errOpenFailed , errOpenInUse , errReadInterrupted , errReadIncomplete , errReadFailure , errWriteInterrupted , errWriteIncomplete , errWriteFailure , errLockFailure , errExtended } | |
enum | Access { accessReadOnly = O_RDONLY , accessWriteOnly = O_WRONLY , accessReadWrite = O_RDWR } | |
enum | Open { openReadOnly = O_RDONLY , openWriteOnly = O_WRONLY , openReadWrite = O_RDWR , openAppend = O_WRONLY | O_APPEND , openSync = O_RDWR , openTruncate = O_RDWR | O_TRUNC } | |
enum | Attr { attrInvalid = 0 , attrPrivate = 0400 | 0200 , attrGroup = attrPrivate | 0040 | 0020 , attrPublic = attrGroup | 0004 | 0002 } | |
enum | Mapping { mappedRead = accessReadOnly , mappedWrite = accessWriteOnly , mappedReadWrite = accessReadWrite } | |
enum | Complete { completionImmediate , completionDelayed , completionDeferred } | |
typedef enum Error | Error | |
typedef enum Access | Access | |
typedef enum Open | Open | |
typedef enum Attr | Attr | |
typedef enum Complete | Complete | |
typedef enum Mapping | Mapping | |
![]() | ||
RandomFile (const char *name=NULL) | ||
Create an unopened random access file. | ||
RandomFile (const RandomFile &rf) | ||
Default copy constructor. | ||
Error | error (Error errid, char *errstr=NULL) | |
Post an error event. | ||
Error | error (char *err) | |
Post an extended string error message. | ||
void | setError (bool enable) | |
Used to enable or disable throwing of exceptions on errors. | ||
Error | setCompletion (Complete mode) | |
Used to set file completion modes. | ||
void | setTemporary (bool enable) | |
Used to set the temporary attribute for the file. | ||
virtual Attr | initialize (void) | |
This method is used to initialize a newly created file as indicated by the "initial" flag. | ||
void | final (void) | |
Close the file. | ||
![]() | ||
Mutex (const char *name=NULL) | ||
The mutex is always initialized as a recursive entity. | ||
virtual | ~Mutex () | |
Destroying the mutex removes any system resources associated with it. | ||
void | nameMutex (const char *name) | |
Enable setting of mutex name for deadlock debug. | ||
void | enterMutex (void) | |
Entering a Mutex locks the mutex for the current thread. | ||
void | enter (void) | |
Future abi will use enter/leave/test members. | ||
void | leave (void) | |
Future abi will use enter/leave/test members. | ||
bool | test (void) | |
Future abi will use enter/leave/test members. | ||
bool | tryEnterMutex (void) | |
Tries to lock the mutex for the current thread. | ||
void | leaveMutex (void) | |
Leaving a mutex frees that mutex for use by another thread. | ||
![]() | ||
static void | setDebug (bool mode) | |
Enable or disable deadlock debugging. | ||
![]() | ||
static const char * | getExtension (const char *path) | |
static const char * | getFilename (const char *path) | |
static char * | getFilename (const char *path, char *buffer, size_t size=64) | |
static char * | getDirname (const char *path, char *buffer, size_t size=256) | |
static char * | getRealpath (const char *path, char *buffer, size_t size=256) | |
![]() | ||
int | fd | |
Access | access | |
char * | pathname | |
struct { | ||
unsigned count: 16 | ||
bool thrown: 1 | ||
bool initial: 1 | ||
bool immediate: 1 | ||
bool temp: 1 | ||
} | flags | |
![]() | ||
bool __EXPORT | isDir (const char *path) | |
bool __EXPORT | isFile (const char *path) | |
bool __EXPORT | isDevice (const char *path) | |
bool __EXPORT | canAccess (const char *path) | |
bool __EXPORT | canModify (const char *path) | |
time_t __EXPORT | lastModified (const char *path) | |
time_t __EXPORT | lastAccessed (const char *path) | |
Create and map a disk file into memory.
This portable class works under both Posix via mmap and under the win32 API. A mapped file can be referenced directly by it's memory segment. One can map and unmap portions of a file on demand, and update changed memory pages mapped from files immediately through sync().
Map a named disk file into memory.
ost::MappedFile::MappedFile | ( | const char * | fname, |
Access | mode | ||
) |
Open a file for mapping.
More than one segment of a file may be mapped into seperate regions of memory.
fname | file name to access for mapping. |
mode | access mode to map file. |
ost::MappedFile::MappedFile | ( | const char * | fname, |
Access | mode, | ||
size_t | size | ||
) |
Create if not exists, and map a file of specified size into memory.
fname | file name to access for mapping. |
mode | access mode to map file. |
size | of file to map. |
Map a portion or all of a specified file in the specified shared memory access mode.
Valid mapping modes include mappedRead, mappedWrite, and mappedReadWrite.
fname | pathname of file to map into memory. |
offset | from start of file to begin mapping in bytes. |
size | of mapped area in bytes. |
mode | to map file. |
|
virtual |
Release a mapped section of memory associated with a file.
The mapped area is updated back to disk.
char * ost::MappedFile::fetch | ( | off_t | pos, |
size_t | len | ||
) |
Fetch and map a portion of a disk file to a logical memory block.
pos | offset of file segment to map. |
len | size of memory segment to map. |
|
inline |
Fetch a pointer to an offset within the memory mapped portion of the disk file.
This really is used for convience of matching operations between Update and Fetch, as one could simply have accessed the base pointer where the file was mapped directly.
offset | from start of mapped memory. |
References ost::File::_fcb::address.
bool ost::MappedFile::lock | ( | void | ) |
Lock the currently mapped portion of a file.
size_t ost::MappedFile::pageAligned | ( | size_t | size | ) |
Compute map size to aligned page boundry.
size | request. |
void ost::MappedFile::release | ( | char * | address, |
size_t | len | ||
) |
Release (unmap) a memory segment.
address | address of memory segment to release. |
len | length of memory segment to release. |
void ost::MappedFile::sync | ( | char * | address, |
size_t | len | ||
) |
Synchronize a segment of memory mapped from a segment fetch.
address | memory address to update. |
len | size of segment. |
void ost::MappedFile::sync | ( | void | ) |
Synchronize the contents of the mapped portion of memory with the disk file and wait for completion.
This assures the memory mapped from the file is written back.
void ost::MappedFile::unlock | ( | void | ) |
Unlock a locked mapped portion of a file.
void ost::MappedFile::update | ( | char * | address, |
size_t | len | ||
) |
Update a mapped region back to disk as specified by address and length.
address | address of segment. |
len | length of segment. |
void ost::MappedFile::update | ( | size_t | offset = 0 , |
size_t | len = 0 |
||
) |
Map a portion of the memory mapped from the file back to the file and do not wait for completion.
This is useful when mapping a database file and updating a single record.
offset | offset into the mapped region of memory. |
len | length of partial region (example, record length). |