RemoteFile Class Reference

#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 (void)
	File (IOFD fd, bool autoclose=true)
	File (const char *name, int flags=IOFlags::OpenRead, int perms=0666)
	File (const std::string &name, int flags=IOFlags::OpenRead, int perms=0666)
virtual void	flush (void)
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)
virtual IOOffset	position (IOOffset offset, Relative whence=SET)
virtual bool	prefetch (const IOPosBuffer *what, IOSize n)
virtual IOSize	read (void *into, IOSize n)
virtual IOSize	read (void *into, IOSize n, IOOffset pos)
virtual IOSize	readv (IOBuffer *into, IOSize length)
virtual void	resize (IOOffset size)
virtual void	setAutoClose (bool closeit)
virtual IOOffset	size (void) const
virtual IOSize	write (const void *from, IOSize n)
virtual IOSize	write (const void *from, IOSize n, IOOffset pos)
virtual IOSize	writev (const IOBuffer *from, IOSize length)
	~File (void)
Protected Member Functions inherited from IOChannel
bool	sysclose (IOFD fd, int *error=0)
virtual IOFD	fd (void) const
virtual void	fd (IOFD value)
	IOChannel (IOFD fd=-1)
virtual bool	isBlocking (void) const
virtual void	setBlocking (bool value)
virtual	~IOChannel (void)
Protected Member Functions inherited from IOInput
int	read (void)
IOSize	read (IOBuffer into)
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 (unsigned char byte)
IOSize	write (IOBuffer from)
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
virtual IOOffset	position (void) const
IOSize	read (IOBuffer into, IOOffset pos)
virtual IOSize	readv (IOPosBuffer *into, IOSize buffers)
virtual void	rewind (void)
	Storage (void)
IOSize	write (IOBuffer from, IOOffset pos)
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 ( void  )

inlineoverride

Definition at line 11 of file RemoteFile.h.

References abort(), close(), mps_setup::cmd, IOChannel::fd(), local(), ALCARECOPromptCalibProdSiPixelAli0T_cff::mode, dataset::name, RemoteFile(), AlCaHLTBitMon_QueryRunRegistry::string, and groupFilesInBlocks::temp.

{ remove (); }

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

private

Definition at line 37 of file RemoteFile.cc.

Referenced by get(), and ~RemoteFile().

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

Member Function Documentation

void RemoteFile::abort ( void  )

overrideprotectedvirtual

Close the file and ignore all errors.

Reimplemented from File.

Definition at line 51 of file RemoteFile.cc.

References File::abort().

Referenced by ~RemoteFile().

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

void RemoteFile::close ( void  )

overrideprotectedvirtual

Close the file.

Reimplemented from File.

Definition at line 47 of file RemoteFile.cc.

References File::close().

Referenced by lumiQTWidget.ApplicationWindow::fileQuit(), get(), esMonitoring.AsyncLineReaderMixin::handle_close(), esMonitoring.FDJsonServer::handle_close(), Vispa.Gui.BoxContentDialog.BoxContentDialog::keyPressEvent(), Vispa.Gui.FindDialog.FindDialog::keyPressEvent(), and ~RemoteFile().

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

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

static

Definition at line 90 of file RemoteFile.cc.

References close(), join(), IOFlags::OpenCreate, IOFlags::OpenWrite, sysUtil::pid, RemoteFile(), and throwStorageError().

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

{
  // 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;
  }
}

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

static

Definition at line 55 of file RemoteFile.cc.

References IOChannel::fd(), and throwStorageError().

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

{
  // 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;
}

void RemoteFile::remove ( void  )

private

Definition at line 43 of file RemoteFile.cc.

References name_.

{ unlink (name_.c_str()); }

Member Data Documentation

std::string RemoteFile::name_

private

Definition at line 24 of file RemoteFile.h.

Referenced by remove().