#include <RemoteFile.h>

Inheritance diagram for RemoteFile:

Public Member Functions
	~RemoteFile (void) override

Static Public Member Functions
static std::unique_ptr< Storage >	get (int localfd, const std::string &name, char **cmd, int mode)

static int	local (const std::string &tmpdir, std::string &temp)

Protected Member Functions
void	abort (void) override

void	close (void) override

Protected Member Functions inherited from File
virtual void	attach (IOFD fd)

virtual void	create (const char *name, bool exclusive=false, int perms=0666)

virtual void	create (const std::string &name, bool exclusive=false, int perms=0666)

	File (const char *name, int flags=IOFlags::OpenRead, int perms=0666)

	File (const std::string &name, int flags=IOFlags::OpenRead, int perms=0666)

	File (IOFD fd, bool autoclose=true)

	File (void)

void	flush (void) override

virtual void	open (const char *name, int flags=IOFlags::OpenRead, int perms=0666)

virtual void	open (const std::string &name, int flags=IOFlags::OpenRead, int perms=0666)

IOOffset	position (IOOffset offset, Relative whence=SET) override

virtual IOOffset	position (IOOffset offset, Relative whence=SET)=0

virtual IOOffset	position (void) const

bool	prefetch (const IOPosBuffer *what, IOSize n) override

IOSize	read (IOBuffer into, IOOffset pos)

IOSize	read (void *into, IOSize n) override

virtual IOSize	read (void *into, IOSize n, IOOffset pos)

IOSize	read (void *into, IOSize n, IOOffset pos) override

IOSize	readv (IOBuffer *into, IOSize length) override

virtual IOSize	readv (IOPosBuffer *into, IOSize buffers)

void	resize (IOOffset size) override

virtual void	setAutoClose (bool closeit)

IOOffset	size (void) const override

IOSize	write (const void *from, IOSize n) override

virtual IOSize	write (const void *from, IOSize n, IOOffset pos)

IOSize	write (const void *from, IOSize n, IOOffset pos) override

IOSize	write (IOBuffer from, IOOffset pos)

IOSize	writev (const IOBuffer *from, IOSize length) override

virtual IOSize	writev (const IOPosBuffer *from, IOSize buffers)

	~File (void) override

Protected Member Functions inherited from IOChannel
bool	sysclose (IOFD fd, int *error=nullptr)

virtual void	fd (IOFD value)

virtual IOFD	fd (void) const

	IOChannel (IOFD fd=-1)

virtual bool	isBlocking (void) const

IOSize	read (IOBuffer into)

IOSize	read (void *into, IOSize n) override

virtual IOSize	read (void *into, IOSize n)=0

int	read (void)

IOSize	readv (IOBuffer *into, IOSize buffers) override

virtual void	setBlocking (bool value)

IOSize	write (const void *from, IOSize n) override

virtual IOSize	write (const void *from, IOSize n)=0

IOSize	write (IOBuffer from)

IOSize	write (unsigned char byte)

IOSize	writev (const IOBuffer *from, IOSize buffers) override

	~IOChannel (void) override

Protected Member Functions inherited from IOInput
IOSize	read (IOBuffer into)

int	read (void)

IOSize	xread (IOBuffer into)

IOSize	xread (void *into, IOSize n)

IOSize	xreadv (IOBuffer *into, IOSize buffers)

virtual	~IOInput (void)
	Destruct the stream. A no-op. More...

Protected Member Functions inherited from IOOutput
IOSize	write (IOBuffer from)

IOSize	write (unsigned char byte)

IOSize	xwrite (const void *from, IOSize n)

IOSize	xwrite (IOBuffer from)

IOSize	xwritev (const IOBuffer *from, IOSize buffers)

virtual	~IOOutput (void)
	Destruct the stream. A no-op. More...

Protected Member Functions inherited from Storage
virtual bool	eof (void) const

Storage &	operator= (const Storage &)=delete

virtual IOOffset	position (void) const

IOSize	read (IOBuffer into)

IOSize	read (IOBuffer into, IOOffset pos)

virtual IOSize	read (void *into, IOSize n)=0

int	read (void)

virtual IOSize	readv (IOBuffer *into, IOSize buffers)

virtual IOSize	readv (IOPosBuffer *into, IOSize buffers)

virtual void	rewind (void)

	Storage (const Storage &)=delete

	Storage (void)

virtual IOSize	write (const void *from, IOSize n)=0

IOSize	write (IOBuffer from)

IOSize	write (IOBuffer from, IOOffset pos)

IOSize	write (unsigned char byte)

virtual IOSize	writev (const IOBuffer *from, IOSize buffers)

virtual IOSize	writev (const IOPosBuffer *from, IOSize buffers)

	~Storage (void) override

Private Member Functions
	RemoteFile (IOFD fd, const std::string &name)

void	remove (void)

Private Attributes
std::string	name_

Detailed Description

Definition at line 8 of file RemoteFile.h.

Constructor & Destructor Documentation

◆ ~RemoteFile()

RemoteFile::~RemoteFile ( void )

inlineoverride

Definition at line 10 of file RemoteFile.h.

10 { remove(); }

References remove().

◆ RemoteFile()

RemoteFile::RemoteFile	(	IOFD	fd,
		const std::string &	name
	)

private

Definition at line 34 of file RemoteFile.cc.

34 : File(fd), name_(name) {}

Referenced by get().

Member Function Documentation

◆ abort()

void RemoteFile::abort ( void )

overrideprotectedvirtual

Close the file and ignore all errors.

Reimplemented from File.

Definition at line 43 of file RemoteFile.cc.

                            {
   remove();
   File::abort();
 }

References File::abort(), and remove().

◆ close()

void RemoteFile::close ( void )

overrideprotectedvirtual

Close the file.

Reimplemented from File.

Definition at line 38 of file RemoteFile.cc.

                            {
   remove();
   File::close();
 }

References File::close(), and remove().

Referenced by get(), esMonitoring.AsyncLineReaderMixin::handle_close(), and esMonitoring.FDJsonServer::handle_close().

◆ get()

std::unique_ptr< Storage > RemoteFile::get	(	int	localfd,
		const std::string &	name,
		char **	cmd,
		int	mode
	)

static

Definition at line 78 of file RemoteFile.cc.

                                                                                                {
   // FIXME: On write, create a temporary local file open for write;
   // on close, trigger transfer to destination.  If opening existing
   // file for write, may need to first download.
   assert(!(mode & (IOFlags::OpenWrite | IOFlags::OpenCreate)));
  
   pid_t pid = -1;
   int rc = posix_spawnp(&pid, cmd[0], nullptr, nullptr, cmd, environ);
  
   if (rc == -1) {
     int errsave = errno;
     ::close(localfd);
     unlink(name.c_str());
     throwStorageError("RemoteFile", "Calling RemoteFile::get()", "posix_spawnp()", errsave);
   }
  
   pid_t rcpid;
   do
     rcpid = waitpid(pid, &rc, 0);
   while (rcpid == (pid_t)-1 && errno == EINTR);
  
   if (rcpid == (pid_t)-1) {
     int errsave = errno;
     ::close(localfd);
     unlink(name.c_str());
     throwStorageError("RemoteFile", "Calling RemoteFile::get()", "waitpid()", errsave);
   }
  
   if (WIFEXITED(rc) && WEXITSTATUS(rc) == 0)
     return std::unique_ptr<Storage>(static_cast<Storage *>(new RemoteFile(localfd, name)));
   else {
     ::close(localfd);
     unlink(name.c_str());
     cms::Exception ex("RemoteFile");
     ex << "'" << join(cmd) << "'"
        << (WIFEXITED(rc)     ? " exited with exit code "
            : WIFSIGNALED(rc) ? " died from signal "
                              : " died for an obscure unknown reason with exit status ")
        << (WIFEXITED(rc)     ? WEXITSTATUS(rc)
            : WIFSIGNALED(rc) ? WTERMSIG(rc)
                              : rc);
     ex.addContext("Calling RemoteFile::get()");
     throw ex;
   }
 }

References cms::cuda::assert(), close(), mps_setup::cmd, join(), ALCARECOPromptCalibProdSiPixelAli0T_cff::mode, Skims_PA_cff::name, IOFlags::OpenCreate, IOFlags::OpenWrite, RemoteFile(), and throwStorageError().

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), submitPVValidationJobs.BetterConfigParser::__updateDict(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), submitPVValidationJobs.BetterConfigParser::getResultingSection(), HttpStorageMaker::open(), and GsiFTPStorageMaker::open().

◆ local()

int RemoteFile::local	(	const std::string &	tmpdir,
		std::string &	temp
	)

static

Definition at line 48 of file RemoteFile.cc.

                                                               {
   // Download temporary files to the current directory by default.
   // This is better for grid jobs as the current directory is
   // likely to have more space, and is more optimised for
   // large files, and is cleaned up after the job.
   if (tmpdir.empty() || tmpdir == ".") {
     size_t len = pathconf(".", _PC_PATH_MAX);
     char *buf = (char *)malloc(len);
     getcwd(buf, len);
  
     temp.reserve(len + 32);
     temp = buf;
     free(buf);
   } else {
     temp.reserve(tmpdir.size() + 32);
     temp = tmpdir;
   }
   if (temp[temp.size() - 1] != '/')
     temp += '/';
  
   temp += "storage-factory-local-XXXXXX";
   temp.c_str();  // null terminate for mkstemp
  
   int fd = mkstemp(&temp[0]);
   if (fd == -1)
     throwStorageError("RemoteFile", "Calling RemoteFile::local()", "mkstemp()", errno);
  
   return fd;
 }

References visDQMUpload::buf, IOChannel::fd(), groupFilesInBlocks::temp, and throwStorageError().

Referenced by GsiFTPStorageMaker::open(), and HttpStorageMaker::open().

◆ remove()

void RemoteFile::remove ( void )

private

Definition at line 36 of file RemoteFile.cc.

36 { unlink(name_.c_str()); }

References name_.

Referenced by abort(), close(), and ~RemoteFile().

Member Data Documentation

◆ name_

std::string RemoteFile::name_

private

Definition at line 22 of file RemoteFile.h.

Referenced by remove().

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~RemoteFile()

◆ RemoteFile()

Member Function Documentation

◆ abort()

◆ close()

◆ get()

◆ local()

◆ remove()

Member Data Documentation

◆ name_