XrdOssMirageXAttr Class Reference

#include <XrdOssMirageXAttr.hh>

Inheritance diagram for XrdOssMirageXAttr:

Collaboration diagram for XrdOssMirageXAttr:

Public Member Functions
	XrdOssMirageXAttr ()=default
virtual	~XrdOssMirageXAttr ()=default
virtual int	Del (const char *Aname, const char *Path, int fd=-1) override
virtual void	Free (AList *aPL) override
virtual int	Get (const char *Aname, void *Aval, int Avsz, const char *Path, int fd=-1) override
virtual int	List (AList **aPL, const char *Path, int fd=-1, int getSz=0) override
virtual int	Set (const char *Aname, const void *Aval, int Avsz, const char *Path, int fd=-1, int isNew=0) override
void	setOss (XrdOssMirage &oss)
Public Member Functions inherited from XrdSysXAttr
	XrdSysXAttr ()
	Constructor and Destructor.
virtual	~XrdSysXAttr ()
virtual int	Copy (const char *iPath, int iFD, const char *oPath, int oFD, const char *Aname=0)
virtual XrdSysError *	SetMsgRoute (XrdSysError *errP)

Additional Inherited Members
Protected Attributes inherited from XrdSysXAttr
XrdSysError *	Say

Detailed Description

Definition at line 10 of file XrdOssMirageXAttr.hh.

Constructor & Destructor Documentation

XrdOssMirageXAttr()

XrdOssMirageXAttr::XrdOssMirageXAttr ( )

default

Referenced by XrdSysGetXAttrObject().

Here is the caller graph for this function:

~XrdOssMirageXAttr()

virtual XrdOssMirageXAttr::~XrdOssMirageXAttr ( )

virtualdefault

References Del(), Free(), Get(), List(), Path, Set(), and setOss().

Here is the call graph for this function:

Member Function Documentation

Del()

int XrdOssMirageXAttr::Del ( const char * Aname, const char * Path, int fd = -1 )

overridevirtual

Remove an extended attribute.

Parameters

Aname	-> The attribute name.
Path	-> Path of the file whose attribute is to be removed.
fd	If >=0 is the file descriptor of the opened subject file.

Returns

=0 Attribute was successfully removed.

<0 Attribute was not removed or does not exist. The return value is -errno that describes the reason for the failure.

Implements XrdSysXAttr.

Definition at line 20 of file XrdOssMirageXAttr.cc.

{
    if (this->oss == nullptr)
        return -ENOTSUP;
 
    const auto opt = oss->get_entry_write(Path);
    if (!opt.has_value())
        return -EINVAL;
 
    auto entry = opt.value();
 
    const std::string_view name{Aname};
 
    if (name == "U.open.return_code"sv)
        entry->open.return_code = {};
    else if (name == "U.close.return_code"sv)
        entry->close.return_code = {};
    else if (name == "U.read.return_code"sv)
        entry->read.return_code = {};
    else if (name == "U.read.return_position"sv)
        entry->read.return_position = {};
    else if (name == "U.write.return_code"sv)
        entry->write.return_code = {};
    else if (name == "U.write.return_position"sv)
        entry->write.return_position = {};
    else if (name == "U.pattern"sv)
        entry->pattern = {};
    else
        return -EINVAL;
 
    return 0;
}

References Path.

Referenced by ~XrdOssMirageXAttr().

Here is the caller graph for this function:

Free()

void XrdOssMirageXAttr::Free ( AList * aPL )

overridevirtual

Release storage occupied by the Alist structure returned by List().

Parameters

aPL	-> The first element of the AList structure.

Implements XrdSysXAttr.

Definition at line 53 of file XrdOssMirageXAttr.cc.

{
}

Referenced by ~XrdOssMirageXAttr().

Here is the caller graph for this function:

Get()

int XrdOssMirageXAttr::Get ( const char * Aname, void * Aval, int Avsz, const char * Path, int fd = -1 )

overridevirtual

Get an attribute value and its size.

Parameters

Aname	-> The attribute name.
Aval	-> Buffer to receive the attribute value.
Avsz	Length of the buffer in bytes. Only up to this number of bytes should be returned. However, should Avsz be zero the the size of the attribute value should be returned and the Aval argument should be ignored.
Path	-> Path of the file whose attribute is to be fetched.
fd	-> If >=0 is the file descriptor of the opened subject file.

Returns

>0 The number of bytes placed in Aval. However, if avsz is zero then the value is the actual size of the attribute value.

=0 The attribute exists but has no associated value.

<0 The attribute value could not be returned. The returned value is -errno describing the reason.

Implements XrdSysXAttr.

Definition at line 57 of file XrdOssMirageXAttr.cc.

{
    if (this->oss == nullptr)
        return -ENOTSUP;
 
    const auto opt = oss->get_entry_read(Path);
    if (!opt.has_value())
        return -EINVAL;
 
    const auto entry = opt.value();
 
    const std::string_view name{Aname};
    std::string value{};
 
    if (name == "U.open.return_code"sv)
        value = std::to_string(entry.open.return_code);
    else if (name == "U.close.return_code"sv)
        value = std::to_string(entry.close.return_code);
    else if (name == "U.read.return_code"sv)
        value = std::to_string(entry.read.return_code);
    else if (name == "U.read.return_position"sv)
        value = std::to_string(entry.read.return_position);
    else if (name == "U.write.return_code"sv)
        value = std::to_string(entry.write.return_code);
    else if (name == "U.write.return_position"sv)
        value = std::to_string(entry.write.return_position);
    else if (name == "U.pattern"sv)
        value = entry.pattern;
    else
        return -EINVAL;
 
    const int num_bytes = std::min(static_cast<std::size_t>(Avsz), value.size());
    std::copy_n(value.begin(), num_bytes, static_cast<char *>(Aval));
 
    return num_bytes;
}

References Path.

Referenced by ~XrdOssMirageXAttr().

Here is the caller graph for this function:

List()

int XrdOssMirageXAttr::List ( AList ** aPL, const char * Path, int fd = -1, int getSz = 0 )

overridevirtual

Get all of the attributes associated with a file.

Parameters

aPL	-> the pointer to hold the first element of AList. The storage occupied by the returned AList must be released by calling Free().
Path	-> Path of the file whose attributes are t be returned.
fd	-> If >=0 is the file descriptor of the opened subject file.
getSz	When != 0 then the size of the maximum attribute value should be returned. Otherwise, upon success 0 is returned.

Returns

>0 Attributes were returned and aPL points to the first attribute value. The returned value is the largest size of an attribute value encountered (getSz != 0).

=0 Attributes were returned and aPL points to the first attribute value (getSz == 0).

<0 The attribute values could not be returned. The returned value is -errno describing the reason.

Implements XrdSysXAttr.

Definition at line 94 of file XrdOssMirageXAttr.cc.

{
    return -ENOTSUP;
}

References Path.

Referenced by ~XrdOssMirageXAttr().

Here is the caller graph for this function:

Set()

int XrdOssMirageXAttr::Set ( const char * Aname, const void * Aval, int Avsz, const char * Path, int fd = -1, int isNew = 0 )

overridevirtual

Set an attribute.

Parameters

Aname	-> The attribute name.
Aval	-> Buffer holding the attribute value.
Avsz	Length of the buffer in bytes. This is the length of the attribute value which may contain binary data.
Path	-> Path of the file whose attribute is to be set.
fd	-> If >=0 is the file descriptor of the opened subject file.
isNew	When !0 then the attribute must not exist (i.e. new). Otherwise, if it does exist, the value is replaced. In either case, if it does not exist it should be created.

Returns

=0 The attribute was successfully set.

<0 The attribute values could not be set. The returned value is -errno describing the reason.

Implements XrdSysXAttr.

Definition at line 99 of file XrdOssMirageXAttr.cc.

{
    if (this->oss == nullptr)
        return -ENOTSUP;
 
    const auto opt = oss->get_entry_write(Path);
    if (!opt.has_value())
        return -EINVAL;
 
    auto entry = opt.value();
 
    const std::string_view name{Aname};
    const std::string value(static_cast<const char *>(Aval), Avsz);
 
    try
    {
        constexpr static auto parse_return_code = [](auto value) {
 
            auto code = std::stoi(value);
            if (code < 0)
                throw std::invalid_argument("return code is negative");
 
            return code;
        };
 
        constexpr static auto parse_return_position = [](auto value) {
 
            auto position = std::stoll(value);
            if (position < 0)
                throw std::invalid_argument("return position is negative");
            if (static_cast<std::uint64_t>(position) > XrdOssMirageEntry::max_file_size)
                throw std::invalid_argument("return position is greater than the max file size");
 
            return position;
        };
 
        if (name == "U.open.return_code"sv)
            entry->open.return_code = parse_return_code(value);
        else if (name == "U.close.return_code"sv)
            entry->close.return_code = parse_return_code(value);
        else if (name == "U.read.return_code"sv)
            entry->read.return_code = parse_return_code(value);
        else if (name == "U.read.return_position"sv)
            entry->read.return_position = parse_return_position(value);
        else if (name == "U.write.return_code"sv)
            entry->write.return_code = parse_return_code(value);
        else if (name == "U.write.return_position"sv)
            entry->write.return_position = parse_return_position(value);
        else if (name == "U.pattern"sv)
            entry->pattern = value;
        else
            return -EINVAL;
    }
    catch(std::out_of_range &)
    {
        return -ERANGE;
    }
    catch(std::invalid_argument &)
    {
        return -EINVAL;
    }
 
    return 0;
}

References XrdOssMirageEntry::max_file_size, and Path.

Referenced by ~XrdOssMirageXAttr().

Here is the caller graph for this function:

setOss()

void XrdOssMirageXAttr::setOss

(

XrdOssMirage &

oss

)

Definition at line 164 of file XrdOssMirageXAttr.cc.

{
    if (this->oss == nullptr)
        this->oss = &oss;
}

Referenced by ~XrdOssMirageXAttr().

Here is the caller graph for this function:

---

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

• XrdOssMirageXAttr.hh
• XrdOssMirageXAttr.cc