NAME¶

FBB::MemoryAccess - Shared Memory data structure

SYNOPSIS¶

#include <bobcat/memoryaccess>
Linking option: -lbobcat

DESCRIPTION¶

The class FBB::MemoryAccess manages the access to the shared memory data blocks used by Bobcat’s Memory... classes.

NAMESPACE¶

FBB
All constructors, members, operators and manipulators, mentioned in this man-page, are defined in the namespace FBB.

INHERITS FROM¶

-

CONSTRUCTORS¶

There are no publicly available constructors. The static member create (see below) returns a pointer to a MemoryAccess object.

Copy and move constructors and assignment operators are not available.

Note: the MemoryAccess destructor performs no actions. See also the static member create below.

MEMBER FUNCTIONS¶

o

char *beginPtr() const:
Returns a pointer to the first byte of the memory block (cf. memoryblock(3bobcat)) corresponding to the current offset (cf. member offset(), below).

o

size_t blockBegin() const:
Returns the offset of the first byte of the memory block corresponding to the current offset.

o

size_t blockEnd() const:
Returns the offset just beyond the last byte of the memory block corresponding to the current offset.

o

size_t bufLimits(size_t offset):
Computes the values returned by blockBegin and blockEnd corresponding to the absolute offset position offset.

o

char *endPtr() const:
Returns a pointer to the memory block’s byte corresponding to offset blockEnd().

o

char *endReadPtr(size_t offset) const:
Returns a pointer to the position in the current memory block corresponding to the absolute offset position offset.

o

int id() const:
The ID of the memory block (cf. MemoryAccess(3bobcat)) controlling access to the memory data blocks is returned.

o

void info(std::ostream &out):
Information about the MemoryAccess is inserted into out: the IDs of the memory data blocks, their sizes, the current maximum number of memory data blocks, the number of bytes that can be read from the shared memory, and its actual storage capacity.

o

void load():
Loads (makes available) the memory block corresponding to the current offset.

o

size_t maxEnd() const:
Returns the absolute offset position corresponding to blockEnd of the current last available memory block. The value returned by this member can be updated to a larger value after calling extend().

o

char *offsetPtr(size_t offset):
Returns a pointer to the byte of the memory block corresponding to the absolute offset position offset.

o

size_t read(char *dest, size_t len, size_t offset):
Copies at most len bytes from absolute offset position offset of the MemoryAccess’s data to dest, returning the actual number of copied bytes. Reading always stops when reaching the value returned by writtenUntil() (see below).

o

bool truncate(std::streamsize offset):
This member reduces or enlarges the available memory size of a MemoryAccess object to size. If it’s reduced then the shared memory’s data bytes from size to its original size are set to 0: newly allocated shared memory areas are always initialized to 0 byte values.

o

size_t write(char *src, std::streamsize len, size_t offset):
Copies len bytes from src to the MemoryAccess’s data, starting at the absolute offset position offset, returning the actual number of copied bytes. Unless there’s no more physical memory available writing succeeds. If the physical memory is exhausted an exception is thrown.

o

size_t writtenUntil() const:
Returns the highest offset of the byte that was ever written to the MemoryAccess.

o

void writtenUntil(size_t offset) const:
Updates the value returned by writtenUntil() to offset if offset is larger than that value.

STATIC MEMBER FUNCTIONS¶

o

MemoryAccess *create(std::string const &bufSize, size_t access):
Returns a pointer to a newly created MemoryAccess object, defined in the computer’s shared memory.

Note: the MemoryAccess destructor performs no actions. To erase the MemoryAccess object made available by create the static member drop (described next) should be used.

Its default capacity is specified by bufSize (cf. section BUFSIZE).

An FBB::Exception is thrown if the shared memory data segment could not be created.

o

void drop(MemoryAccess *ptr, bool erase):
The currently attached shared memory data block and the MemoryAccess shared block are detached. If erase is true then all available shared memory blocks and the shared memory block containing the MemoryAccess pointed to by ptr are destroyed. This member is used by MemoryBridge’s destructor to disconnect its MemoryAccess object. The MemoryAccess destructor performs no actions.

o

MemoryAccess *extend(size_t offset, MemoryAccess *ptr):
Returns a newly allocated MemoryAccess object managing shared data blocks until at least the absolute offset position offset. Following extend the information at ptr can no longer be used. The caller is responsible for destroying the MemoryAccess object pointed to by ptr.

o

MemoryAccess *loadID(int id):
Returns a newly allocated MemoryAccess object managing the shared data blocks of the MemoryAccess object having ID id (cf. shmat(2)).

BUFSIZE¶

The bufSize parameter required by the second MemoryStream constructor and the open member (see below) specifies the default number nummber of shared memory memory blocks and their sizes. The size of the memory blocks is specified as k, M or G, indicating block sizes in kilo-, Mega- and GigaBytes. Before those letters the default number of blocks is specified. E.g., "100M". Internally the number of kiloBytes is converted to `pages’, using the system’s page size, which is commonly equal to 4 kB (so when specifying "5k" then the stream prepares for two shared data segments, each having a capacity of 4 kB. The number of MegaBytes is used as specified, and when specifying GB the data segments are .5 GB.

The number of shared data segments is aotomatically enlarged when the current capacity is exceeded, and the potentially available data segments are initially not allocated: they’re allocated once information is written into their areas.

EXAMPLE¶

See the sharedstream(3bobcat) man page.

FILES¶

bobcat/memoryaccess - defines the class interface

SEE ALSO¶

bobcat(7), chmod(1), memorybridge(3bobcat), memorybuf(3bobcat), memorystream(3bobcat), shmat(2),

BUGS¶

None Reported.

BOBCAT PROJECT FILES¶

o

https://fbb-git.gitlab.io/bobcat/: gitlab project page;

Debian Bobcat project files:

o

libbobcat6: debian package containing the shared library, changelog and copyright note;

o

libbobcat-dev: debian package containing the static library, headers, manual pages, and developer info;

BOBCAT¶

Bobcat is an acronym of `Brokken’s Own Base Classes And Templates’.

COPYRIGHT¶

This is free software, distributed under the terms of the GNU General Public License (GPL).

AUTHOR¶

Frank B. Brokken (f.b.brokken@rug.nl).