posixFileIoCommon Class Reference

base class for posixFile reader and writer class with the common stuff like fd, path and xattr handling More...

#include <posixFileCommon.h>

Inheritance diagram for posixFileIoCommon:

Collaboration diagram for posixFileIoCommon:

Classes
class	attrDataType

Public Member Functions
	posixFileIoCommon (const std::string &aPath)
void	setXattr (const std::string &name, const std::string &value) override
std::string	getXattr (const std::string &name) override
	get one extended attribute value More...
void	removeXattr (const std::string &name) override
std::unique_ptr< const genericStat >	getStat () override
std::unique_ptr< ioHandle::attrDataType >	getAttrData (const outputHandler::base *aOutputHandler) override
	get attributes in the optimal way for setting with aOutputHandler More...
Public Member Functions inherited from ioHandle
	ioHandle ()
virtual	~ioHandle () noexcept(false)
virtual bool	parallelizable () const
	tell if this handler is capable of parallel IO. Unsually not the case More...
virtual size_t	getBlockSize () const
virtual void	setBlockSize (size_t newSize)
virtual std::unique_ptr< acl::list >	getAclData ()
	get acls More...

Protected Attributes
const std::string &	path
int	fd = -1
Protected Attributes inherited from ioHandle
size_t	blockSize
	in bytes, block size to be used when reading or writing More...

Friends
class	gpfsIoCommon

Detailed Description

base class for posixFile reader and writer class with the common stuff like fd, path and xattr handling

Definition at line 17 of file posixFileCommon.h.

Constructor & Destructor Documentation

posixFileIoCommon()

posixFileIoCommon::posixFileIoCommon

(

const std::string &

aPath

)

Definition at line 110 of file posixFileCommon.cpp.

                                                          :
    path(aPath) {
}

Member Function Documentation

getAttrData()

std::unique_ptr< ioHandle::attrDataType > posixFileIoCommon::getAttrData ( const outputHandler::base *  )

overridevirtual

get attributes in the optimal way for setting with aOutputHandler

Returns

std::unique_ptr to the attribute data or nullptr if none available

Exceptions

std::system_error

when reading of attributes fails

Reimplemented from ioHandle.

Definition at line 205 of file posixFileCommon.cpp.

                                                                                                          {
    return ioHandle::getAttrData(aOutputHandler);
}

References ioHandle::getAttrData().

Here is the call graph for this function:

getStat()

std::unique_ptr< const genericStat > posixFileIoCommon::getStat ( )

overridevirtual

Implements ioHandle.

Definition at line 116 of file posixFileCommon.cpp.

                                                            {
    struct stat statBuf;
    timerInst(fstat);
    throwcall::good0(fstat(fd, &statBuf), "can't stat", path);
    return std::unique_ptr<const genericStat>(new genericStat(statBuf, std::chrono::nanoseconds(1)));
}

References fd, throwcall::good0(), path, and timerInst.

Here is the call graph for this function:

getXattr()

std::string posixFileIoCommon::getXattr ( const std::string &  )

overridevirtual

get one extended attribute value

Returns

value or empty string if attribute not present

Exceptions

std::system_error	if attribute setting fails
unimplementedActionError	if not implemented (most handlers)

Reimplemented from ioHandle.

Definition at line 132 of file posixFileCommon.cpp.

                                                           {
    #if defined(WithXattr) || defined(WithXattrUgly)
    char buffer[512];
    timerInst(getXattr);
    auto retval = fgetxattr(fd, name.c_str(), buffer, sizeof(buffer));
    if (retval == -1) {
        if (errno != ENOATTR) {
            throwcall::badval(retval, -1, "can't read xattr '", name, "' from ", path);
        }
        return "";
    } else {
        buffer[retval] = '\0';
    }
    return buffer;
    #else
    throw unimplementedActionError("no xattr support");
    return ""; // newver reached
    #endif
 
}

References throwcall::badval(), ENOATTR, fd, path, and timerInst.

Here is the call graph for this function:

removeXattr()

void posixFileIoCommon::removeXattr ( const std::string &  name )

overridevirtual

Reimplemented from ioHandle.

Definition at line 153 of file posixFileCommon.cpp.

                                                         {
    #if defined(WithXattr) || defined(WithXattrUgly)
    timerInst(fremovexattr);
    auto result = fremovexattr(fd, name.c_str());
    if (result && errno == ENOATTR) {
        return; // be silent about this
    }
    throwcall::good0(result,
                     "can't remove xattr ", name, " from ", path);
    #else
    throw unimplementedActionError("no xattr support");
    #endif
 
}

References ENOATTR, fd, throwcall::good0(), path, and timerInst.

Here is the call graph for this function:

setXattr()

void posixFileIoCommon::setXattr ( const std::string &  name, const std::string &  value  )

overridevirtual

Reimplemented from ioHandle.

Definition at line 122 of file posixFileCommon.cpp.

                                                                              {
    #if defined(WithXattr) || defined(WithXattrUgly)
    timerInst(fsetxattr);
    throwcall::good0(fsetxattr(fd, name.c_str(), value.data(), value.size(), 0),
                     "can't set xattr '", name, "' to '", value, "' on ", path);
    #else
    throw unimplementedActionError("no xattr support");
    #endif
}

References fd, throwcall::good0(), path, and timerInst.

Here is the call graph for this function:

Friends And Related Function Documentation

gpfsIoCommon

friend class gpfsIoCommon

friend

Definition at line 18 of file posixFileCommon.h.

Member Data Documentation

fd

int posixFileIoCommon::fd = -1

protected

Definition at line 21 of file posixFileCommon.h.

Referenced by outputHandler::Gpfs::writerGpfs::doSpecialFdHandling(), gpfsIoCommon::getAclData(), gpfsIoCommon::getAttrData(), getStat(), getXattr(), inputHandler::Gpfs::readerGpfs::readerGpfs(), inputHandler::posixFile::readerPosixFile::readerPosixFile(), gpfsIoCommon::releaseUsedBlocks(), removeXattr(), setXattr(), and outputHandler::posixFile::writerPosixFile::writerPosixFile().

path

const std::string& posixFileIoCommon::path

protected

Definition at line 20 of file posixFileCommon.h.

Referenced by outputHandler::Gpfs::writerGpfs::doSpecialFdHandling(), gpfsIoCommon::getAclData(), gpfsIoCommon::getAttrData(), getStat(), getXattr(), gpfsIoCommon::handleParallelUsedBlocks(), inputHandler::Gpfs::readerGpfs::readerGpfs(), inputHandler::posixFile::readerPosixFile::readerPosixFile(), gpfsIoCommon::releaseUsedBlocks(), removeXattr(), setXattr(), and outputHandler::posixFile::writerPosixFile::writerPosixFile().

---

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

• src/posixFileCommon.h (v0.19-24-g0617ca1 with changes)
• src/posixFileCommon.cpp (v0.19-24-g0617ca1 with changes)