outputHandler::Gpfs::writerGpfs Class Reference

#include <outputHandlerGpfs.h>

Inheritance diagram for outputHandler::Gpfs::writerGpfs:

Collaboration diagram for outputHandler::Gpfs::writerGpfs:

Public Member Functions
	writerGpfs (const std::string &aPath, bool mightAppend, size_t sourceSize, size_t readBlockSize, copyRequest::stateType &state, bool noWrite, std::unique_ptr< ioHandle::attrDataType > attrData, std::unique_ptr< acl::list > aAclData)
	writerGpfs (std::string &aPath, size_t sourceSize, bool noWrite, std::unique_ptr< ioHandle::attrDataType > aAttrData, std::unique_ptr< acl::list > aAclData, base &handler)
	~writerGpfs () noexcept(false) override
void	writeBlock (const block &b) override
void	writeBlockP (const block &b) override
Public Member Functions inherited from gpfsIoCommon
	gpfsIoCommon (const std::string &aPath)
	~gpfsIoCommon () override=default
std::unique_ptr< ioHandle::attrDataType >	getAttrData (const outputHandler::base *aOutputHandler) override
	get attributes in the optimal way for setting with aOutputHandler More...
std::unique_ptr< acl::list >	getAclData () override
	get acls More...
Public Member Functions inherited from posixFileIoCommon
	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)

Private Member Functions
void	doSpecialFdHandling (size_t sourceSize)
void	setAclData ()

Static Private Attributes
static options::single< bool >	usePreallocate

Additional Inherited Members
Static Public Member Functions inherited from gpfsIoCommon
static std::unique_ptr< acl::list >	aclFromGpfs (const gpfs_acl_handler &acl, const std::string &aPath)
Protected Member Functions inherited from gpfsIoCommon
void	releaseUsedBlocks (size_t aBlockSize)
void	handleParallelUsedBlocks (size_t aBlockSize, off_t offset)
Protected Attributes inherited from gpfsIoCommon
off_t	leastRecentlyAccessedBlock
off_t	leastRecentlyReleasedBlock
std::bitset< 64 >	usedBlockMap
std::bitset< 64 >	nextUsedBlockMap
std::mutex	blockBookkeepingMutex
Protected Attributes inherited from posixFileIoCommon
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...

Detailed Description

Definition at line 12 of file outputHandlerGpfs.h.

Constructor & Destructor Documentation

writerGpfs() [1/2]

outputHandler::Gpfs::writerGpfs::writerGpfs	(	const std::string &	aPath,
		bool	mightAppend,
		size_t	sourceSize,
		size_t	readBlockSize,
		copyRequest::stateType &	state,
		bool	noWrite,
		std::unique_ptr< ioHandle::attrDataType >	attrData,
		std::unique_ptr< acl::list >	aAclData
	)

Definition at line 74 of file outputHandlerGpfs.cpp.

                                                                 :
        posixFileIoCommon(aPath),
        gpfsIoCommon(aPath),
        writerPosixFile(aPath, mightAppend, sourceSize, readBlockSize, state, noWrite,
                        std::move(aAttrData),
                        std::move(aAclData)) {
        doSpecialFdHandling(sourceSize);
    };

References doSpecialFdHandling().

Here is the call graph for this function:

writerGpfs() [2/2]

outputHandler::Gpfs::writerGpfs::writerGpfs	(	std::string &	aPath,
		size_t	sourceSize,
		bool	noWrite,
		std::unique_ptr< ioHandle::attrDataType >	aAttrData,
		std::unique_ptr< acl::list >	aAclData,
		base &	handler
	)

Definition at line 90 of file outputHandlerGpfs.cpp.

                                               :
        posixFileIoCommon(aPath),
        gpfsIoCommon(aPath),
        writerPosixFile(aPath, noWrite, std::move(aAttrData), std::move(aAclData),handler) {
        doSpecialFdHandling(sourceSize);
    };

References doSpecialFdHandling().

Here is the call graph for this function:

~writerGpfs()

outputHandler::Gpfs::writerGpfs::~writerGpfs ( )

overridenoexcept

Definition at line 102 of file outputHandlerGpfs.cpp.

                                                {
        if (isUnwinding()) {
            return;
        }
        if (fd != -1) {
            if (aclData) {
                setAclData();
            }
            if (doClearCache) {
                gpfs_fcntl_handler fcntl;
                fcntl.buffer.add<gpfsClearFileCache_t>(GPFS_CLEAR_FILE_CACHE);
                timerInst(gpfsClearFileCache);
                fcntl.call(fd, path);
            }
        }
    }

References gpfs_fcntl_handler::buffer, gpfs_fcntl_handler::call(), outputHandler::doClearCache, and timerInst.

Here is the call graph for this function:

Member Function Documentation

doSpecialFdHandling()

void outputHandler::Gpfs::writerGpfs::doSpecialFdHandling ( size_t  sourceSize )

private

Definition at line 51 of file outputHandlerGpfs.cpp.

                                                              {
        if (fd != -1) {
            if (usePreallocate) {
                //calculate size which uses entire blocks
                auto truncatedSize = (sourceSize / getBlockSize()) * getBlockSize();
                if (truncatedSize > 0) {
                    timerInst(gpfs_prealloc);
                    throwcall::good0(gpfs_prealloc(fd, 0, truncatedSize),
                                     "can't gpfs_prealloc ", truncatedSize, " bytes for ", path);
                }
            }
            if (useRange) {
                gpfs_fcntl_handler fcntl;
                auto& range = fcntl.buffer.add<gpfsAccessRange_t>(GPFS_ACCESS_RANGE);
                range.start = 0;
                range.length = sourceSize;
                range.isWrite = 1;
                timerInst(gpfsAccessRange);
                fcntl.call(fd, path);
            }
        }
    }

References gpfs_fcntl_handler::buffer, gpfs_fcntl_handler::call(), posixFileIoCommon::fd, ioHandle::getBlockSize(), throwcall::good0(), posixFileIoCommon::path, timerInst, usePreallocate, and outputHandler::useRange.

Referenced by writerGpfs().

Here is the call graph for this function:

Here is the caller graph for this function:

setAclData()

void outputHandler::Gpfs::writerGpfs::setAclData ( )

private

Definition at line 134 of file outputHandlerGpfs.cpp.

                                    {
        gpfs_acl_handler aclHandler(aclData->entries.size());
 
        auto gpfs_ace = aclHandler.begin();
        for (const auto& rich_ace : aclData->entries) {
            gpfs_ace->aceType = rich_ace.isAllowedType() ? ACE4_TYPE_ALLOW : ACE4_TYPE_DENY;
            gpfs_ace->aceFlags =    rich_ace.getFlagBits() & (ACE4_FLAG_FILE_INHERIT |
                                    ACE4_FLAG_DIR_INHERIT |
                                    ACE4_FLAG_NO_PROPAGATE |
                                    ACE4_FLAG_INHERIT_ONLY |
                                    ACE4_FLAG_GROUP_ID |
                                    ACE4_FLAG_INHERITED);
            gpfs_ace->aceIFlags = 0;
            gpfs_ace->aceMask = rich_ace.getMaskBits();
            if (rich_ace.isFlagSet(acl::list::entryType::flagsType::special_who)) {
                gpfs_ace->aceIFlags = ACE4_IFLAG_SPECIAL_ID;
                switch (rich_ace.e_id) {
                    case acl::list::entryType::specialIdType::owner_special_id:
                        gpfs_ace->aceWho = ACE4_SPECIAL_OWNER;
                        break;
                    case acl::list::entryType::specialIdType::group_special_id:
                        gpfs_ace->aceWho = ACE4_SPECIAL_GROUP;
                        break;
                    case acl::list::entryType::specialIdType::everyone_special_id:
                        gpfs_ace->aceWho = ACE4_SPECIAL_EVERYONE;
                        break;
                    default:
                        throw std::runtime_error("illegal special id");
                }
            } else {
                gpfs_ace->aceWho = rich_ace.e_id;
            }
            gpfs_ace++;
        }
        aclHandler.set(fd, path);
    }

References gpfs_acl_handler::begin(), gpfs_acl_handler::set(), and acl::list::entryType::special_who.

Here is the call graph for this function:

writeBlock()

void outputHandler::Gpfs::writerGpfs::writeBlock ( const block &  b )

override

Definition at line 119 of file outputHandlerGpfs.cpp.

                                                  {
        writerPosixFile::writeBlock(b);
        leastRecentlyAccessedBlock = b.offset();
        if (freeRange) {
            releaseUsedBlocks(b.max_size());
        }
    }

References outputHandler::freeRange, block::max_size(), block::offset(), and outputHandler::posixFile::writerPosixFile::writeBlock().

Here is the call graph for this function:

writeBlockP()

void outputHandler::Gpfs::writerGpfs::writeBlockP ( const block &  b )

override

Definition at line 127 of file outputHandlerGpfs.cpp.

                                                   {
        writerPosixFile::writeBlockP(b);
        if (freeRange) {
            handleParallelUsedBlocks(b.max_size(), b.offset());
        }
    }

References outputHandler::freeRange, block::max_size(), block::offset(), and outputHandler::posixFile::writerPosixFile::writeBlockP().

Here is the call graph for this function:

Member Data Documentation

usePreallocate

options::single<bool> outputHandler::Gpfs::writerGpfs::usePreallocate

staticprivate

Definition at line 13 of file outputHandlerGpfs.h.

Referenced by doSpecialFdHandling().

---

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

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