XrdPosixAdmin Class Reference

#include <XrdPosixAdmin.hh>

Collaboration diagram for XrdPosixAdmin:

Public Member Functions
	XrdPosixAdmin (const char *path, XrdOucECMsg &ecm)
	~XrdPosixAdmin ()
XrdCl::URL *	FanOut (int &num)
bool	isOK ()
int	Query (XrdCl::QueryCode::Code reqCode, std::string &resp)
int	Query (XrdCl::QueryCode::Code reqCode, void *buff, int bsz)
bool	Stat (mode_t *flags=0, time_t *mtime=0)
bool	Stat (struct stat &Stat)

Public Attributes
XrdOucECMsg &	ecMsg
XrdCl::URL	Url
XrdCl::FileSystem	Xrd

Detailed Description

Definition at line 49 of file XrdPosixAdmin.hh.

Constructor & Destructor Documentation

XrdPosixAdmin()

XrdPosixAdmin::XrdPosixAdmin ( const char * path, XrdOucECMsg & ecm )

inline

Definition at line 74 of file XrdPosixAdmin.hh.

                      : Url((std::string)path), Xrd(Url), ecMsg(ecm) {}

References ecMsg, and Url.

~XrdPosixAdmin()

XrdPosixAdmin::~XrdPosixAdmin ( )

inline

Definition at line 76 of file XrdPosixAdmin.hh.

{}

Member Function Documentation

FanOut()

XrdCl::URL * XrdPosixAdmin::FanOut

(

int &

num

)

Definition at line 46 of file XrdPosixAdmin.cc.

{
   XrdCl::XRootDStatus            xStatus;
   XrdCl::LocationInfo           *info = 0;
   XrdCl::LocationInfo::Iterator  it;
   XrdCl::URL                    *uVec;
   XrdNetAddr netLoc;
   const char *hName;
   unsigned long i;
 
// Make sure admin is ok
//
   if (!isOK()) return 0;
 
// Issue the deep locate and verify that all went well
//
   xStatus = Xrd.DeepLocate(Url.GetPathWithParams(),XrdCl::OpenFlags::PrefName,info);
   if (!xStatus.IsOK())
      {num = XrdPosixMap::Result(xStatus, ecMsg, false);
       return 0;
      }
 
// Allocate an array large enough to hold this information
//
   if (!(i = info->GetSize())) {delete info; return 0;}
   if (i > std::numeric_limits<ptrdiff_t>::max() / sizeof(XrdCl::URL))
      {delete info; return 0;}
   uVec = new XrdCl::URL[i];
 
// Now start filling out the array
//
   num = 0;
   for( it = info->Begin(); it != info->End(); ++it )
      {if (!netLoc.Set(it->GetAddress().c_str()) && (hName = netLoc.Name()))
          {std::string hString(hName);
           uVec[num] = Url;
           uVec[num].SetHostName(hString);
           uVec[num].SetPort(netLoc.Port());
           num++;
          }
      }
 
// Make sure we can return something;
//
   delete info;
   if (!num) {delete [] uVec; return 0;}
   return uVec;
}

References XrdCl::LocationInfo::Begin(), ecMsg, XrdCl::LocationInfo::End(), XrdCl::LocationInfo::GetSize(), XrdCl::Status::IsOK(), isOK(), XrdNetAddrInfo::Name(), XrdNetAddr::Port(), XrdCl::OpenFlags::PrefName, XrdPosixMap::Result(), XrdNetAddr::Set(), XrdCl::URL::SetHostName(), XrdCl::URL::SetPort(), and Url.

Referenced by XrdFfsMisc_get_all_urls_real().

Here is the call graph for this function:

Here is the caller graph for this function:

isOK()

bool XrdPosixAdmin::isOK ( )

inline

Definition at line 57 of file XrdPosixAdmin.hh.

                      {if (Url.IsValid()) return true;
                       ecMsg.Set(EINVAL, 0);
                       ecMsg.Msgf("PosixAdmin", "url '%s' is invalid",
                                  Url.GetObfuscatedURL().c_str());
                       errno = EINVAL;    return false;
                      }

References ecMsg, and Url.

Referenced by FanOut(), XrdPosixXrootd::Mkdir(), Query(), Query(), XrdPosixXrootd::Rename(), XrdPosixXrootd::Rmdir(), Stat(), Stat(), XrdPosixXrootd::Stat(), XrdPosixXrootd::Statvfs(), XrdPosixXrootd::Truncate(), XrdPosixXrootd::Unlink(), XrdFfsMisc_get_all_urls_real(), and XrdFfsMisc_get_current_url().

Here is the caller graph for this function:

Query() [1/2]

int XrdPosixAdmin::Query	(	XrdCl::QueryCode::Code	reqCode,
		std::string &	resp )

Definition at line 136 of file XrdPosixAdmin.cc.

{
  XrdCl::Buffer reqBuff, *rspBuff = 0;
 
// Make sure we are OK
//
  if (!isOK()) return -1;
 
// Get argument
//
   reqBuff.FromString(Url.GetPathWithParams());
 
// Issue the query
//
   if (!XrdPosixMap::Result(Xrd.Query(reqCode, reqBuff, rspBuff),ecMsg))
      {uint32_t rspSz = rspBuff->GetSize();
       char *rspData = rspBuff->GetBuffer();
       if (rspData && rspSz)
          {std::string tmp(rspData, (size_t)rspSz);
           delete rspBuff;
           resp = std::move(tmp);
           return static_cast<int>(rspSz + 1);
          } else ecMsg.SetErrno(EFAULT,0,"Invalid return results");
      }
 
// Return error
//
   delete rspBuff;
   return -1;
}

References ecMsg, XrdCl::Buffer::FromString(), XrdCl::Buffer::GetBuffer(), XrdCl::Buffer::GetSize(), isOK(), XrdPosixMap::Result(), and Url.

Here is the call graph for this function:

Query() [2/2]

int XrdPosixAdmin::Query	(	XrdCl::QueryCode::Code	reqCode,
		void *	buff,
		int	bsz )

Definition at line 99 of file XrdPosixAdmin.cc.

{
  XrdCl::Buffer reqBuff, *rspBuff = 0;
 
// Make sure we are OK
//
  if (!isOK()) return -1;
 
// Get argument
//
   reqBuff.FromString(Url.GetPathWithParams());
 
// Issue the query
//
   if (!XrdPosixMap::Result(Xrd.Query(reqCode, reqBuff, rspBuff),ecMsg))
      {uint32_t rspSz = rspBuff->GetSize();
       char *rspbuff = rspBuff->GetBuffer();
       if (rspbuff && rspSz)
          {// if the string is null-terminated decrement the size
           if ( !(rspbuff[rspSz - 1]) ) --rspSz;
           if (bsz >= (int)rspSz + 1)
              {strncpy((char *)buff, rspbuff, rspSz);
               ((char*)buff)[rspSz] = 0; // make sure it is null-terminated
               delete rspBuff;
               return static_cast<int>(rspSz + 1);
              } else ecMsg.SetErrno(ERANGE,0,"buffer to small to hold result");
          } else ecMsg.SetErrno(EFAULT,0,"Invalid return results");
      }
 
// Return error
//
   delete rspBuff;
   return -1;
}

References ecMsg, XrdCl::Buffer::FromString(), XrdCl::Buffer::GetBuffer(), XrdCl::Buffer::GetSize(), isOK(), XrdPosixMap::Result(), and Url.

Referenced by XrdPosixExtra::FSctl(), XrdPosixXrootd::Getxattr(), XrdPosixXrootd::QueryChksum(), and XrdPosixXrootd::QueryOpaque().

Here is the call graph for this function:

Here is the caller graph for this function:

Stat() [1/2]

bool XrdPosixAdmin::Stat	(	mode_t *	flags = 0,
		time_t *	mtime = 0 )

Definition at line 170 of file XrdPosixAdmin.cc.

{
   XrdCl::XRootDStatus xStatus;
   XrdCl::StatInfo    *sInfo = 0;
 
// Make sure admin is ok
//
   if (!isOK()) return false;
 
// Issue the stat and verify that all went well
//
   xStatus = Xrd.Stat(Url.GetPathWithParams(), sInfo);
   if (!xStatus.IsOK())
      {XrdPosixMap::Result(xStatus,ecMsg);
       delete sInfo;
       return false;
      }
 
// Return wanted data
//
   if (flags) *flags = XrdPosixMap::Flags2Mode(0, sInfo->GetFlags());
   if (mtime) *mtime = static_cast<time_t>(sInfo->GetModTime());
 
// Delete our status information and return final result
//
   delete sInfo;
   return true;
}

References ecMsg, XrdPosixMap::Flags2Mode(), XrdCl::StatInfo::GetFlags(), XrdCl::StatInfo::GetModTime(), XrdCl::Status::IsOK(), isOK(), XrdPosixMap::Result(), and Url.

Referenced by XrdPosixXrootd::Access(), XrdPosixExtra::FSctl(), XrdPosixXrootd::Getxattr(), XrdPosixXrootd::QueryChksum(), XrdPosixXrootd::QueryOpaque(), Stat(), XrdPosixXrootd::Stat(), and XrdFfsMisc_get_current_url().

Here is the call graph for this function:

Here is the caller graph for this function:

Stat() [2/2]

bool XrdPosixAdmin::Stat

(

struct stat &

Stat

)

Definition at line 201 of file XrdPosixAdmin.cc.

{
   XrdCl::XRootDStatus xStatus;
   XrdCl::StatInfo    *sInfo = 0;
 
// Make sure admin is ok
//
   if (!isOK()) return false;
 
// Issue the stat and verify that all went well
//
   xStatus = Xrd.Stat(Url.GetPathWithParams(), sInfo);
   if (!xStatus.IsOK())
      {XrdPosixMap::Result(xStatus,ecMsg);
       delete sInfo;
       return false;
      }
 
// Return the data
//
   Stat.st_size   = static_cast<size_t>(sInfo->GetSize());
   Stat.st_blocks = Stat.st_size/512 + Stat.st_size%512;
   Stat.st_ino    = static_cast<ino_t>(strtoll(sInfo->GetId().c_str(), 0, 10));
#if defined(__mips__) && _MIPS_SIM == _ABIO32
   // Work around inconsistent type definitions on MIPS
   // The st_rdev field in struct stat (which is 32 bits) is not type
   // dev_t (which is 64 bits)
   dev_t tmp_rdev = Stat.st_rdev;
   Stat.st_mode   = XrdPosixMap::Flags2Mode(&tmp_rdev, sInfo->GetFlags());
   Stat.st_rdev = tmp_rdev;
#else
   Stat.st_mode   = XrdPosixMap::Flags2Mode(&Stat.st_rdev, sInfo->GetFlags());
#endif
   Stat.st_mtime  = static_cast<time_t>(sInfo->GetModTime());
 
   if (sInfo->ExtendedFormat())
   {
     // Flags2Mode only maps the simplified protocol flags to owner permission
     // bits (S_IRUSR, S_IWUSR, S_IXUSR). The extended stat response carries
     // the full POSIX permission mode as an octal string (e.g. "0644").
     // Replace the permission bits while preserving the file type (S_IFMT).
     mode_t realPerms = strtol(sInfo->GetModeAsString().c_str(), nullptr, 8);
     Stat.st_mode = (Stat.st_mode & S_IFMT) | (realPerms & 07777);
     Stat.st_ctime = static_cast<time_t>(sInfo->GetChangeTime());
     Stat.st_atime = static_cast<time_t>(sInfo->GetAccessTime());
   } else {
     Stat.st_ctime = Stat.st_mtime;
     Stat.st_atime = time(0);
   }
 
// Delete our status information and return final result
//
   delete sInfo;
   return true;
}

References ecMsg, XrdCl::StatInfo::ExtendedFormat(), XrdPosixMap::Flags2Mode(), XrdCl::StatInfo::GetAccessTime(), XrdCl::StatInfo::GetChangeTime(), XrdCl::StatInfo::GetFlags(), XrdCl::StatInfo::GetId(), XrdCl::StatInfo::GetModeAsString(), XrdCl::StatInfo::GetModTime(), XrdCl::StatInfo::GetSize(), XrdCl::Status::IsOK(), isOK(), XrdPosixMap::Result(), Stat(), stat, and Url.

Here is the call graph for this function:

Member Data Documentation

ecMsg

XrdOucECMsg& XrdPosixAdmin::ecMsg

Definition at line 55 of file XrdPosixAdmin.hh.

Referenced by XrdPosixAdmin(), FanOut(), isOK(), Query(), Query(), Stat(), and Stat().

Url

XrdCl::URL XrdPosixAdmin::Url

Definition at line 53 of file XrdPosixAdmin.hh.

Referenced by XrdPosixAdmin(), FanOut(), isOK(), XrdPosixXrootd::Mkdir(), Query(), Query(), XrdPosixXrootd::Rename(), XrdPosixXrootd::Rmdir(), Stat(), Stat(), XrdPosixXrootd::Statvfs(), XrdPosixXrootd::Truncate(), and XrdPosixXrootd::Unlink().

Xrd

XrdCl::FileSystem XrdPosixAdmin::Xrd

Definition at line 54 of file XrdPosixAdmin.hh.

Referenced by XrdPosixXrootd::Mkdir(), XrdPosixXrootd::Rename(), XrdPosixXrootd::Rmdir(), XrdPosixXrootd::Statvfs(), XrdPosixXrootd::Truncate(), and XrdPosixXrootd::Unlink().

---

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

• XrdPosixAdmin.hh
• XrdPosixAdmin.cc