Detailed Description

Implementation of file based on new[] and memcpy.

Definition at line 27 of file mem_file.h.

Inheritance diagram for stxxl::mem_file:

Collaboration diagram for stxxl::mem_file:

Public Member Functions
	mem_file (int queue_id=DEFAULT_QUEUE, int allocator_id=NO_ALLOCATOR, unsigned int device_id=DEFAULT_DEVICE_ID)
	constructs file object. More...

	~mem_file ()

void	discard (offset_type offset, offset_type size)

const char *	io_type () const
	Identifies the type of I/O implementation. More...

void	lock ()
	Locks file for reading and writing (acquires a lock in the file system). More...

void	serve (void *buffer, offset_type offset, size_type bytes, request::request_type type)

void	set_size (offset_type newsize)

offset_type	size ()
	Returns size of the file. More...

Public Member Functions inherited from stxxl::disk_queued_file
	disk_queued_file (int queue_id, int allocator_id)

request_ptr	aread (void *buffer, offset_type pos, size_type bytes, const completion_handler &on_cmpl=completion_handler())

request_ptr	awrite (void *buffer, offset_type pos, size_type bytes, const completion_handler &on_cmpl=completion_handler())

virtual int	get_allocator_id () const
	Returns the file's disk allocator number. More...

virtual int	get_queue_id () const
	Returns the identifier of the file's queue number. More...

Public Member Functions inherited from stxxl::file
	file (unsigned int device_id=DEFAULT_DEVICE_ID)
	Construct a new file, usually called by a subclass. More...

virtual	~file ()

void	add_request_ref ()
	increment referenced requests More...

virtual request_ptr	aread (void *buffer, offset_type pos, size_type bytes, const completion_handler &on_cmpl=completion_handler())=0
	Schedules an asynchronous read request to the file. More...

virtual request_ptr	awrite (void *buffer, offset_type pos, size_type bytes, const completion_handler &on_cmpl=completion_handler())=0
	Schedules an asynchronous write request to the file. More...

virtual void	close_remove ()
	close and remove file More...

void	delete_request_ref ()
	decrement referenced requests More...

virtual void	discard (offset_type offset, offset_type size)
	Discard a region of the file (mark it unused). Some specialized file types may need to know freed regions. More...

virtual void	export_files (offset_type offset, offset_type length, std::string prefix)

unsigned int	get_device_id () const
	Returns the file's physical device id. More...

unsigned_type	get_request_nref ()
	return number of referenced requests More...

virtual void	serve (void *buffer, offset_type offset, size_type bytes, request::request_type type)=0

virtual void	set_size (offset_type newsize)=0
	Changes the size of the file. More...

Private Attributes
mutex	m_mutex
	sequentialize function calls More...

char *	m_ptr
	pointer to memory area of "file" More...

offset_type	m_size
	size of memory area More...

Additional Inherited Members
Public Types inherited from stxxl::file
typedef request::offset_type	offset_type
	the offset of a request, also the size of the file More...

enum	open_mode { RDONLY = 1, WRONLY = 2, RDWR = 4, CREAT = 8, DIRECT = 16, TRUNC = 32, SYNC = 64, NO_LOCK = 128, REQUIRE_DIRECT = 256 }
	Definition of acceptable file open modes. More...

typedef request::size_type	size_type
	the size of a request More...

Static Public Member Functions inherited from stxxl::file
static int	unlink (const char *path)
	unlink path from filesystem More...

static int	truncate (const char *path, external_size_type length)
	truncate a path to given length. Use this only if you dont have a fileio-specific object, which provides truncate(). More...

Static Public Attributes inherited from stxxl::file
static const unsigned int	DEFAULT_DEVICE_ID = (unsigned int)(-1)

static const int	DEFAULT_LINUXAIO_QUEUE = -2

static const int	DEFAULT_QUEUE = -1

static const int	NO_ALLOCATOR = -1

Protected Attributes inherited from stxxl::file
unsigned int	m_device_id
	The file's physical device id (e.g. used for prefetching sequence calculation) More...

atomic_counted_object	m_request_ref
	count the number of requests referencing this file More...

Constructor & Destructor Documentation

stxxl::mem_file::mem_file	(	int	queue_id = `DEFAULT_QUEUE`,
		int	allocator_id = `NO_ALLOCATOR`,
		unsigned int	device_id = `DEFAULT_DEVICE_ID`
	)

inline

constructs file object.

Definition at line 40 of file mem_file.h.

stxxl::mem_file::~mem_file ( )

Definition at line 45 of file mem_file.cpp.

Member Function Documentation

void stxxl::mem_file::discard	(	offset_type	offset,
		offset_type	size
	)

Definition at line 70 of file mem_file.cpp.

References max(), STXXL_BLOCK_ALIGN, stxxl::STXXL_UNUSED(), and STXXL_VERBOSE.

const char * stxxl::mem_file::io_type ( ) const

virtual

Identifies the type of I/O implementation.

Returns: pointer to null terminated string of characters, containing the name of I/O implementation

Implements stxxl::file.

Definition at line 40 of file mem_file.cpp.

void stxxl::mem_file::lock ( )

virtual

Locks file for reading and writing (acquires a lock in the file system).

Implements stxxl::file.

Definition at line 51 of file mem_file.cpp.

Referenced by stxxl::create_file().

void stxxl::mem_file::serve	(	void *	buffer,
		offset_type	offset,
		size_type	bytes,
		request::request_type	type
	)

Definition at line 23 of file mem_file.cpp.

void stxxl::mem_file::set_size ( offset_type newsize )

Definition at line 61 of file mem_file.cpp.

References max().

file::offset_type stxxl::mem_file::size ( )

virtual

Returns size of the file.

Returns: file size in bytes

Implements stxxl::file.

Definition at line 56 of file mem_file.cpp.

Member Data Documentation

mutex stxxl::mem_file::m_mutex

private

sequentialize function calls

Definition at line 36 of file mem_file.h.

char* stxxl::mem_file::m_ptr

private

pointer to memory area of "file"

Definition at line 30 of file mem_file.h.

offset_type stxxl::mem_file::m_size

private

size of memory area

Definition at line 33 of file mem_file.h.

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

include/stxxl/bits/io/mem_file.h
lib/io/mem_file.cpp

Detailed Description

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation