components return -ENOSPC if output buffer too small, second trial by the AliRoot...

[u/mrichter/AliRoot.git] / HLT / BASE / util / AliHLTFilePublisher.cxx

// $Id$

/**************************************************************************
 * This file is property of and copyright by the ALICE HLT Project        * 
 * ALICE Experiment at CERN, All rights reserved.                         *
 *                                                                        *
 * Primary Authors: Matthias Richter <Matthias.Richter@ift.uib.no>        *
 *                  for The ALICE HLT Project.                            *
 *                                                                        *
 * Permission to use, copy, modify and distribute this software and its   *
 * documentation strictly for non-commercial purposes is hereby granted   *
 * without fee, provided that the above copyright notice appears in all   *
 * copies and that both the copyright notice and this permission notice   *
 * appear in the supporting documentation. The authors make no claims     *
 * about the suitability of this software for any purpose. It is          *
 * provided "as is" without express or implied warranty.                  *
 **************************************************************************/

/** @file   AliHLTFilePublisher.cxx
    @author Matthias Richter
    @date   
    @brief  HLT file publisher component implementation. */

#if __GNUC__>= 3
using namespace std;
#endif

#include "AliHLTFilePublisher.h"
#include <TObjString.h>
#include <TMath.h>
#include <TFile.h>

/** the global object for component registration */
AliHLTFilePublisher gAliHLTFilePublisher;

/** ROOT macro for the implementation of ROOT specific class methods */
ClassImp(AliHLTFilePublisher)

AliHLTFilePublisher::AliHLTFilePublisher()
  :
  AliHLTDataSource(),
  fFileNames(),
  fFiles(),
  fpCurrent(NULL),
  fDataType(kAliHLTVoidDataType),
  fSpecification(~(AliHLTUInt32_t)0),
  fMaxSize(0)
{
  // see header file for class documentation
  // or
  // refer to README to build package
  // or
  // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt

  // make the lists owners of their objects in order to automatically
  // de-allocate the objects
  fFileNames.SetOwner();
  fFiles.SetOwner();
}

AliHLTFilePublisher::AliHLTFilePublisher(const AliHLTFilePublisher&)
  :
  AliHLTDataSource(),
  fFileNames(),
  fFiles(),
  fpCurrent(NULL),
  fDataType(kAliHLTVoidDataType),
  fSpecification(0),
  fMaxSize(0)
{
  // see header file for class documentation
  HLTFatal("copy constructor untested");
}

AliHLTFilePublisher& AliHLTFilePublisher::operator=(const AliHLTFilePublisher&)
{ 
  // see header file for class documentation
  HLTFatal("assignment operator untested");
  return *this;
}

AliHLTFilePublisher::~AliHLTFilePublisher()
{
  // see header file for class documentation

  // file list and file name list are owner of their objects and
  // delete all the objects
}

const char* AliHLTFilePublisher::GetComponentID()
{
  // see header file for class documentation
  return "FilePublisher";
}

AliHLTComponentDataType AliHLTFilePublisher::GetOutputDataType()
{
  // see header file for class documentation
  return fDataType;
}

void AliHLTFilePublisher::GetOutputDataSize( unsigned long& constBase, double& inputMultiplier )
{
  // see header file for class documentation
  constBase=fMaxSize;
  inputMultiplier=1.0;
}

AliHLTComponent* AliHLTFilePublisher::Spawn()
{
  // see header file for class documentation
  return new AliHLTFilePublisher;
}

int AliHLTFilePublisher::DoInit( int argc, const char** argv )
{
  // see header file for class documentation

  //HLTDebug("%d %s", argc, argv[0]);
  int iResult=0;
  TString argument="";
  int bMissingParam=0;
  for (int i=0; i<argc && iResult>=0; i++) {
    argument=argv[i];
    if (argument.IsNull()) continue;

    // -datafile
    if (argument.CompareTo("-datafile")==0) {
      if ((bMissingParam=(++i>=argc))) break;
      TObjString* parameter=new TObjString(argv[i]);
      if (parameter) {
	fFileNames.Add(parameter);
      } else {
	iResult=-ENOMEM;
      }

      // -datafilelist
    } else if (argument.CompareTo("-datafilelist")==0) {
      if ((bMissingParam=(++i>=argc))) break;
      HLTWarning("-datafilelist option not yet implemented");

      // -datatype
    } else if (argument.CompareTo("-datatype")==0) {
      if ((bMissingParam=(++i>=argc))) break;
      memcpy(&fDataType.fID, argv[i], TMath::Min(kAliHLTComponentDataTypefIDsize, (Int_t)strlen(argv[i])));
      if ((bMissingParam=(++i>=argc))) break;
      memcpy(&fDataType.fOrigin, argv[i], TMath::Min(kAliHLTComponentDataTypefOriginSize, (Int_t)strlen(argv[i])));

      // -dataspec
    } else if (argument.CompareTo("-dataspec")==0) {
      if ((bMissingParam=(++i>=argc))) break;
      TString parameter(argv[i]);
      parameter.Remove(TString::kLeading, ' '); // remove all blanks
      if (parameter.IsDigit()) {
	fSpecification=(AliHLTUInt32_t)parameter.Atoi();
      } else if (parameter.BeginsWith("0x") &&
		 parameter.Replace(0,2,"",0).IsHex()) {
	sscanf(parameter.Data(),"%x", &fSpecification);
      } else {
	HLTError("wrong parameter for argument %s, number expected", argument.Data());
	iResult=-EINVAL;
      }
    } else {
      if ((iResult=ScanArgument(argc-i, &argv[i]))==-EINVAL) {
	HLTError("unknown argument %s", argument.Data());
	break;
      } else if (iResult==-EPROTO) {
	bMissingParam=1;
	break;
      } else if (iResult>=0) {
	i+=iResult;
	iResult=0;
      }
    }
  }
  if (bMissingParam) {
    HLTError("missing parameter for argument %s", argument.Data());
    iResult=-EINVAL;
  }
  if (fFileNames.GetSize()==0) {
    HLTError("the publisher needs at least one file argument");
    iResult=-EINVAL;
  }
  if (iResult>=0) iResult=OpenFiles();
  if (iResult<0) {
    fFileNames.Clear();
  }
  return iResult;
}

int AliHLTFilePublisher::ScanArgument(int argc, const char** argv)
{
  // see header file for class documentation

  // there are no other arguments than the standard ones
  if (argc==0 && argv==NULL) {
    // this is just to get rid of the warning "unused parameter"
  }
  return -EPROTO;
}

int AliHLTFilePublisher::OpenFiles()
{
  // see header file for class documentation
  int iResult=0;
  TObjLink *lnk=fFileNames.FirstLink();
  while (lnk && iResult>=0) {
    TObjString* pFileName=(TObjString*)lnk->GetObject();
    if (pFileName) {
      TString fullFN= pFileName->GetString() + "?filetype=raw";
      TFile* pFile = new TFile(fullFN);
      if (pFile) {
	if (pFile->IsZombie()==0) {
	  fFiles.Add(pFile);
	  if (pFile->GetSize()>fMaxSize) fMaxSize=pFile->GetSize();
	} else {
	  HLTError("can not open file %s", (pFileName->GetString()).Data());
	  fFiles.Clear();
	  iResult=-ENOENT;
	}
      }
    }
    lnk = lnk->Next();
  }

  return iResult;
}

int AliHLTFilePublisher::DoDeinit()
{
  // see header file for class documentation
  int iResult=0;
  fFileNames.Clear();
  fFiles.Clear();
  return iResult;
}

int AliHLTFilePublisher::GetEvent( const AliHLTComponentEventData& /*evtData*/,
				   AliHLTComponentTriggerData& /*trigData*/,
	      AliHLTUInt8_t* outputPtr, 
	      AliHLTUInt32_t& size,
	      vector<AliHLTComponentBlockData>& outputBlocks )
{
  int iResult=0;
  TObjLink *lnk=fpCurrent;
  if (lnk==NULL) lnk=fFiles.FirstLink();
  fpCurrent=lnk;
  if (lnk) {
    TFile* pFile=(TFile*)lnk->GetObject();
    if (pFile) {
      int iCopy=pFile->GetSize();
      pFile->Seek(0);
      if (iCopy<=(int)size) {
      if (pFile->ReadBuffer((char*)outputPtr, iCopy)!=0) {
	// ReadBuffer returns 1 in case of failure and 0 in case of success
	iResult=-EIO;
      } else {
	AliHLTComponentBlockData bd;
	FillBlockData(bd);
	bd.fPtr=outputPtr;
	bd.fOffset=0;
	bd.fSize=iCopy;
	bd.fDataType=fDataType;
	bd.fSpecification=fSpecification;
	outputBlocks.push_back(bd);
	size=iCopy;
      }
      } else {
	// output buffer too small, update GetOutputDataSize for the second trial
	fMaxSize=iCopy;
	iResult=-ENOSPC;
      }
    } else {
      HLTError("no file available");
      iResult=-EFAULT;
    }
  } else {
    iResult=-ENOENT;
  }
  if (iResult>=0 && fpCurrent) fpCurrent=fpCurrent->Next();

  return iResult;
}

AliHLTComponentDataType AliHLTFilePublisher::GetCurrentDataType() const
{
  return fDataType;
}

AliHLTUInt32_t          AliHLTFilePublisher::GetCurrentSpecification() const
{
  return fSpecification;
}