daosFsIoCommon Class Reference

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

#include <daosFsCommon.h>

Inheritance diagram for daosFsIoCommon:

Collaboration diagram for daosFsIoCommon:

Classes
class	attrDataType

Public Member Functions
	daosFsIoCommon (const std::string &aPath, daosFsCommon &aHandler)
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
dfs_obj_t *	obj
daosFsCommon &	handler
Protected Attributes inherited from ioHandle
size_t	blockSize
	in bytes, block size to be used when reading or writing More...

Detailed Description

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

Definition at line 50 of file daosFsCommon.h.

Constructor & Destructor Documentation

daosFsIoCommon()

daosFsIoCommon::daosFsIoCommon	(	const std::string &	aPath,
		daosFsCommon &	aHandler
	)

Definition at line 115 of file daosFsCommon.cpp.

                                                                            :
                                                                  path(aPath),
                                                                  obj(nullptr),
                                                                  handler(aHandler){
}

Member Function Documentation

getAttrData()

std::unique_ptr< ioHandle::attrDataType > daosFsIoCommon::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 184 of file daosFsCommon.cpp.

                                                                                          {
    auto attrData = std::unique_ptr<attrDataType>(new attrDataType());
    attrData->fill(*this);
    if (attrData->xattrs.empty()) {
        return nullptr;
    }
    #if __GNUC__ >= 8
    return attrData;
    #else
    return std::move(attrData);
    #endif
}

getStat()

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

overridevirtual

Implements ioHandle.

Definition at line 123 of file daosFsCommon.cpp.

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

References daosFsCommon::dfs, throwcall::good0(), handler, obj, path, and timerInst.

Here is the call graph for this function:

getXattr()

std::string daosFsIoCommon::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 135 of file daosFsCommon.cpp.

                                                        {
    char buffer[512];
    timerInst(getXattr);
    daos_size_t size = sizeof(buffer);
    auto retval = dfs_getxattr(handler.dfs, obj, name.c_str(), buffer, &size);
    if (retval != 0) {
        if (errno != ENOATTR) {
            throwcall::badval(retval, -1, "can't read xattr '", name, "' from ", path);
        }
        return "";
    } else {
        buffer[size] = '\0';
    }
    return buffer;
}

References throwcall::badval(), daosFsCommon::dfs, ENOATTR, handler, obj, path, and timerInst.

Referenced by daosFsIoCommon::attrDataType::fill().

Here is the call graph for this function:

Here is the caller graph for this function:

removeXattr()

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

overridevirtual

Reimplemented from ioHandle.

Definition at line 151 of file daosFsCommon.cpp.

                                                      {
    timerInst(removexattr);
    auto result = dfs_removexattr(handler.dfs, obj,  name.c_str());
    if (result && errno == ENOATTR) {
        return; // be silent about this
    }
    throwcall::good0(result,
                     "can't remove xattr ", name, " from ", path);
}

References daosFsCommon::dfs, ENOATTR, throwcall::good0(), handler, obj, path, and timerInst.

Here is the call graph for this function:

setXattr()

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

overridevirtual

Reimplemented from ioHandle.

Definition at line 129 of file daosFsCommon.cpp.

                                                                           {
    timerInst(setxattr);
    throwcall::good0(dfs_setxattr(handler.dfs, obj, name.c_str(), value.data(), value.size(), 0),
                     "can't set xattr '", name, "' to '", value, "' on ", path);
}

References daosFsCommon::dfs, throwcall::good0(), handler, obj, path, and timerInst.

Here is the call graph for this function:

Member Data Documentation

handler

daosFsCommon& daosFsIoCommon::handler

protected

Definition at line 54 of file daosFsCommon.h.

Referenced by daosFsIoCommon::attrDataType::fill(), getStat(), getXattr(), inputHandler::daosFs::readerDaosFs::readerDaosFs(), removeXattr(), and setXattr().

obj

dfs_obj_t* daosFsIoCommon::obj

protected

Definition at line 53 of file daosFsCommon.h.

Referenced by daosFsIoCommon::attrDataType::fill(), getStat(), getXattr(), inputHandler::daosFs::readerDaosFs::readerDaosFs(), removeXattr(), setXattr(), and outputHandler::daosFs::writerDaosFs::writerDaosFs().

path

const std::string& daosFsIoCommon::path

protected

Definition at line 52 of file daosFsCommon.h.

Referenced by daosFsIoCommon::attrDataType::fill(), getStat(), getXattr(), inputHandler::daosFs::readerDaosFs::readerDaosFs(), removeXattr(), setXattr(), and outputHandler::daosFs::writerDaosFs::writerDaosFs().

---

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

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