* Added new Handler Classes for HOMER Proxy

[u/mrichter/AliRoot.git] / EVE / EveHLT / AliEveHOMERManager.cxx

// $Id$
// Main authors: Matevz Tadel & Alja Mrak-Tadel: 2006, 2007
// Author: Jochen Thaeder <thaeder@kip.uni-heidelberg.de>                *
//         for The ALICE HLT Project.                                    *

//-*- Mode: C++ -*-

/** @file   AliEveHOMERManager.cxx
    @author Jochen Thaeder
    @date
    @brief  Manger for HOMER in offline
*/

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

#include "AliEveHOMERManager.h"

#define EVE_DEBUG 1
// -- -- -- -- -- -- -- 
#include "AliHLTHOMERLibManager.h"
#include "AliHLTHOMERSourceDesc.h"
#include "AliHLTHOMERBlockDesc.h"
// -- -- -- -- -- -- -- 
#include "AliEveHOMERSource.h"
// -- -- -- -- -- -- -- 
#include "TString.h"
#include <TApplication.h>
#include "Riostream.h"
#include "TXMLAttr.h"
#include "TCollection.h"
#include "TList.h"
#include "TObjString.h"
#include "TObjArray.h"
// -- -- -- -- -- -- -- 
#include "AliLog.h"

//______________________________________________________________________________
//
// Manage connections to HLT data-sources.

ClassImp(AliEveHOMERManager)

/*
 * ---------------------------------------------------------------------------------
 *                            Constructor / Destructor
 * ---------------------------------------------------------------------------------
 */

//##################################################################################
AliEveHOMERManager::AliEveHOMERManager( TString xmlFile ) :
  TEveElementList("AliEveHOMERManager"),
  fLibManager(new AliHLTHOMERLibManager),
  fXMLHandler( new AliEveHOMERXMLHandler( xmlFile ) ),
  fSourceList(NULL),
  fReader(NULL),
  fBlockList(NULL),
  fNBlks(0),
  fEventID(0),
  fCurrentBlk(0),
  fConnected(kFALSE),
  fStateHasChanged(kTRUE),
  fSrcList(NULL) {
  // This Class should handle the communication
  // from the HLT to AliEVE. The HLT sends data via 
  // the HOMER interface on several TCP ports of nodes 
  // in the CERN GPN and DCS network.
  // All this communication is hidden from the user.
  // 
  // Right now, a xml file ( SCC1 ) is used to get the
  // configuration, this will/ has to change to a proxy
  // running on dedicated nodes.

}

//##################################################################################
AliEveHOMERManager::~AliEveHOMERManager() {
  // The destructor

  if ( fLibManager ) {
    if ( fReader )
      fLibManager->DeleteReader(fReader);
    delete fLibManager;
    fLibManager = NULL;
    fReader = NULL;
  }

  if ( fXMLHandler != NULL )
    delete fXMLHandler;
  fXMLHandler = NULL;

  if ( fSourceList != NULL )
    delete fSourceList;
  fSourceList = NULL;

  if ( fBlockList != NULL )
    delete fBlockList;
  fBlockList = NULL;

 if ( fSrcList != NULL )
    delete fSrcList;
  fSrcList = NULL;
}

/*
 * ---------------------------------------------------------------------------------
 *                                 Source Handling
 * ---------------------------------------------------------------------------------
 */

//##################################################################################
Int_t AliEveHOMERManager::CreateHOMERSourcesList() {
  // Create Sources List from HOMER-Proxy

  Int_t iResult = 0;

  // -- Initialize sources list
  DestroyElements();
  if ( fSourceList != NULL )
    delete fSourceList;
  fSourceList = NULL;

  fSourceList = new TList();
  fSourceList->SetOwner( kTRUE );

  iResult = fXMLHandler->FillSourceList( fSourceList );

  if ( iResult ) {
    AliWarning( Form("There have been errors, while creating the sources list.") );
  }
  else {
    AliInfo( Form("New sources list created.") );

    // -- New SourceList has been created --> All Sources are new --> State has changed
    fStateHasChanged = kTRUE;
 
    if ( fSrcList ) 
      delete fSrcList;

    // -- Create new AliEVE sources list 
    fSrcList = new AliEveHOMERSourceList("HLT Sources");
    fSrcList->SetManager(this);
    
    AddElement(fSrcList);
    fSrcList->CreateByType();
  }

  return iResult;
}

//##################################################################################
void AliEveHOMERManager::SetSourceState( AliHLTHOMERSourceDesc * source, Bool_t state ) {
  // Set state of a source
  // * param source      Pointer to AliHLTHOMERSourceDesc object.
  // * param state       New (selected/not selected) state.
  
  if ( source->IsSelected() != state ) {
    source->SetState( state );
    fStateHasChanged = kTRUE;
  }

  return;
}

/*
 * ---------------------------------------------------------------------------------
 *                            Connection Handling
 * ---------------------------------------------------------------------------------
 */

//##################################################################################
Int_t AliEveHOMERManager::ConnectHOMER(){
  // Connect to HOMER sources, out of Readout List, which gets created when state has changed
  // * return            0 on sucess, "HOMER" errors on error

  Int_t iResult = 0;

  fStateHasChanged = fSrcList->GetSelectedSources();

  // -- Check if already connected and state has not changed
  if ( fStateHasChanged == kFALSE && IsConnected() ) {
    AliInfo( Form("No need for reconnection.") );
    return iResult;
  }

  // -- If already connected, disconnect before connect
  if ( IsConnected() )
    DisconnectHOMER();

  // *** Create the Readoutlist

  UShort_t* sourcePorts = new UShort_t [fSourceList->GetEntries()];
  const char ** sourceHostnames = new const char* [fSourceList->GetEntries()];
  UInt_t sourceCount = 0;

  CreateReadoutList( sourceHostnames, sourcePorts, sourceCount );

  if ( sourceCount == 0 ) {
    AliError(Form("No sources selected, aborting.") );
    return iResult;
  }

  // *** Connect to data sources

  if ( !fReader ) {
    if ( fLibManager )
      fReader = fLibManager->OpenReader( sourceCount, sourceHostnames, sourcePorts );
  }

  iResult = fReader->GetConnectionStatus();

  if ( iResult ) {
    // -- Connection failed

    UInt_t ndx = fReader->GetErrorConnectionNdx();

    if ( ndx < sourceCount ) {
      AliError( Form("Error : Error establishing connection to TCP source %s:%hu: %s (%d)",
		     sourceHostnames[ndx], sourcePorts[ndx], strerror(iResult), iResult) );
    }
    else {
      AliError( Form("Error : Error establishing connection to unknown source with index %d: %s (%d)",
		     ndx, strerror(iResult), iResult) );
    }

    if ( fReader )
      fLibManager->DeleteReader( fReader );
    fReader = NULL;

  }
  else {
    // -- Connection ok - set reader
    fConnected = kTRUE;

    AliInfo( Form("Connection established") );
  }

  delete[] sourceHostnames;
  delete[] sourcePorts;

  return iResult;
}

//##################################################################################
void AliEveHOMERManager::DisconnectHOMER(){
  // Disconnect from HOMER sources

  if ( ! IsConnected() )
    return;

  if ( fReader )
    fLibManager->DeleteReader( fReader );
  fReader = NULL;

  fStateHasChanged = kTRUE;
  fConnected = kFALSE;

  AliInfo( Form("Connection closed") );

  return;
}

//##################################################################################
Int_t AliEveHOMERManager::ReconnectHOMER(){
  // Reconnect from HOMER sources
  // * return            0 on sucess, "ConnectHOMER()" errors on error

  Int_t iResult = 0;

  if ( IsConnected() )
    DisconnectHOMER();

  iResult = ConnectHOMER();
  if ( iResult ) {
    AliError( Form("Error connecting.") );
  }

  return iResult;
}

//##################################################################################
void AliEveHOMERManager::CreateReadoutList( const char** sourceHostnames, UShort_t *sourcePorts, UInt_t &sourceCount ){
  //  Create a readout list for Hostname and ports
  // * param socurceHostnames   Array of selected hostnames
  // * param socurcePorts       Array of selected ports
  // * param socurceCount       Number of selected hostname:port

  AliHLTHOMERSourceDesc * source= NULL;

  // -- Read all sources and check if they should be read out
  TIter next( fSourceList );
  while ( ( source = (AliHLTHOMERSourceDesc*)next() ) ) {

    if ( ! source->IsSelected() )
      continue;

    Bool_t exists = kFALSE;

    // -- Loop over existing entries and check if entry is already in readout list
    for ( UInt_t ii = 0; ii < sourceCount; ii++ ){
      if ( !strcmp( sourceHostnames[ii], source->GetHostname().Data() ) &&  sourcePorts[ii] == source->GetPort() ) {
	exists = kTRUE;
	break;
      }
    }

    // -- Add new entires to readout list
    if ( ! exists ) {
      sourcePorts[sourceCount] = source->GetPort();
      sourceHostnames[sourceCount] = source->GetHostname().Data();
      sourceCount++;
    }

  } // while ( ( source = (AliHLTHOMERSourceDesc*)next() ) ) {

  fStateHasChanged = kFALSE;

  return;
}

/*
 * ---------------------------------------------------------------------------------
 *                            Event Handling
 * ---------------------------------------------------------------------------------
 */

//##################################################################################
Int_t AliEveHOMERManager::NextEvent(){
  // Loads the next Event, after being connected
  // * return            0 on sucess, "HOMER" errors on error

  Int_t iResult = 0;
  Int_t iRetryCount = 0;

  if ( !fReader || ! IsConnected() ) {
    AliWarning( Form( "Not connected yet." ) );
    return 1;
  }

  //  fReader->SetEventRequestAdvanceTime( 20000000 /*timeout in us*/ );

  // -- Read next event data and error handling for HOMER (error codes and empty blocks)
  while( 1 ) {

    iResult = fReader->ReadNextEvent( 40000000 /*timeout in us*/);

    if ( iResult == 111 || iResult == 32 || iResult == 6 ) {
      Int_t ndx = fReader->GetErrorConnectionNdx();
      AliError( Form("Error, No Connection to source %d: %s (%d)", 
		     ndx, strerror(iResult), iResult) );
      return 2;
    }
    else if ( iResult == 110 ) {
      Int_t ndx = fReader->GetErrorConnectionNdx();
      AliError( Form("Timout occured, reading event from source %d: %s (%d)", 
		     ndx, strerror(iResult), iResult) );
      return 3;
    }
    else if ( iResult == 56) {
      Int_t ndx = fReader->GetErrorConnectionNdx();

      ++iRetryCount;

      if ( iRetryCount >= 20 ) {
	AliError( Form("Retry Failed: Error reading event from source %d: %s (%d)", 
		       ndx, strerror(iResult), iResult) );
	return 4;
      }
      else {
	AliError( Form("Retry: Error reading event from source %d: %s (%d)", 
		       ndx, strerror(iResult), iResult) );
	continue;
      }
    }
    else if ( iResult ) {
      Int_t ndx = fReader->GetErrorConnectionNdx();
      AliError( Form("General Error reading event from source %d: %s (%d)", 
		     ndx, strerror(iResult), iResult) );
      fConnected = kFALSE;
      return 2;
    }
    else {
      break;
    }
  } // while( 1 ) {

  if ( iResult )
    return iResult;
  
  // -- Get blockCnt and eventID
  fNBlks = (ULong_t) fReader->GetBlockCnt();
  fEventID = (ULong64_t) fReader->GetEventID();
  fCurrentBlk = 0;

  AliInfo( Form("Event 0x%016LX (%Lu) with %lu blocks", fEventID, fEventID, fNBlks) );

#if EVE_DEBUG
  // Loop for Debug only
  for ( ULong_t i = 0; i < fNBlks; i++ ) {
    Char_t tmp1[9], tmp2[5];
    memset( tmp1, 0, 9 );
    memset( tmp2, 0, 5 );
    void *tmp11 = tmp1;
    ULong64_t* tmp12 = (ULong64_t*)tmp11;
    *tmp12 = fReader->GetBlockDataType( i );
    void *tmp21 = tmp2;
    ULong_t* tmp22 = (ULong_t*)tmp21;
    *tmp22 = fReader->GetBlockDataOrigin( i );
    AliInfo( Form("Block %lu length: %lu - type: %s - origin: %s",
		  i, fReader->GetBlockDataLength( i ), tmp1, tmp2) );
  } // end for ( ULong_t i = 0; i < fNBlks; i++ ) {
#endif

  // -- Create BlockList
  AliInfo( Form("Create Block List") );
  iResult = CreateBlockList();

  return iResult;
}

//##################################################################################
Int_t AliEveHOMERManager::CreateBlockList() {
  // Create a TList of blocks, which have been readout


  Int_t iResult = 0;
#if 0
  // -- Initialize block list
  if ( fBlockList != NULL )
    delete fBlockList;
  fBlockList = NULL;

  fBlockList = new TList();
  fBlockList->SetOwner( kTRUE );

  void* iter = GetFirstBlk();

  // -- Fill block list
  while ( iter != NULL ){

    // -- Create new block
    AliHLTHOMERBlockDesc * block = new AliHLTHOMERBlockDesc( GetBlk(), GetBlkSize(), GetBlkOrigin(),
							     GetBlkType(), GetBlkSpecification() );

    // -- Check sources list if block is requested
    if ( CheckIfRequested( block ) )
      fBlockList->Add( block );
    else {
      //The Following 2 line commented out and the previous is added.
      //       delete block;
      //       block = NULL;
      fBlockList->Add( block );
    }
    iter = GetNextBlk();

  } // while ( iter != NULL ){
#endif
  return iResult;
}

/*
 * ---------------------------------------------------------------------------------
 *                            BlockHandling
 * ---------------------------------------------------------------------------------
 */

//##################################################################################
void* AliEveHOMERManager::GetBlk( Int_t ndx ) {
  // Get pointer to current block in current event
  // * param ndx        Block index
  // * return           returns pointer to blk, NULL if no block present
   
  void* data = NULL;

  if ( !fReader || ! IsConnected() ) {
    AliError( Form("Not connected yet.") );
  }
  else {
    if ( ( ndx ) < (Int_t) fNBlks )
      data = (void*) fReader->GetBlockData( ndx );
  }

  return data;
}

//##################################################################################
ULong_t AliEveHOMERManager::GetBlkSize( Int_t ndx ) {
  // Get size of block ndx
  // * param ndx        Block index
  // * return           returns pointer to blk, 0 if no block present
   
  ULong_t length = 0;

  if ( !fReader || ! IsConnected() ) {
    AliError( Form("Not connected yet.") );
  }
  else {
    if ( ( ndx ) < (Int_t) fNBlks )
      length = (ULong_t) fReader->GetBlockDataLength( ndx );
  }

  return length;
}

//##################################################################################
TString AliEveHOMERManager::GetBlkOrigin( Int_t ndx ) {
  // Get origin of block ndx
  // * param ndx        Block index
  // * return           origin of block

  TString origin = "";

  // -- Check for Connection
  if ( !fReader || ! IsConnected() ) {
    AliError( Form("Not connected yet.") );
    return origin;
  }

  // -- Check block index
  if ( ( ndx ) >= (Int_t) fNBlks ) {
    AliError( Form("Block index %d out of range.", ndx ) );
    return origin;
  }

  // -- Get origin
  union{
    UInt_t data;
    Char_t array[4];
  } reverseOrigin;

  reverseOrigin.data = (UInt_t) fReader->GetBlockDataOrigin( ndx );

  // -- Reverse the order
  for (Int_t ii = 3; ii >= 0; ii-- )
    if ( reverseOrigin.array[ii] != ' ')
      origin.Append( reverseOrigin.array[ii] );

  return origin;
}

//##################################################################################
TString AliEveHOMERManager::GetBlkType( Int_t ndx ) {
  // Get type of block ndx
  // * param ndx        Block index
  // * return           type of block

  TString type = "";

  // -- Check for Connection
  if ( !fReader || ! IsConnected() ) {
    AliError( Form("Not connected yet.") );
    return type;
  }

  // -- Check blockk index
  if ( ( ndx ) >= (Int_t) fNBlks ) {
    AliError( Form("Block index %d out of range.", ndx ) );
    return type;
  }

  // -- Get type
  union{
    ULong64_t data;
    Char_t array[8];
  } reverseType;

  reverseType.data = (ULong64_t) fReader->GetBlockDataType( ndx );

  // -- Reverse the order
  for (Int_t ii = 7; ii >= 0; ii-- )
    if ( reverseType.array[ii] != ' ')
      type.Append( reverseType.array[ii] );

  return type;
}

//##################################################################################
ULong_t AliEveHOMERManager::GetBlkSpecification( Int_t ndx ) {
  // Get specification of block ndx
  // * param ndx        Block index
  // * return           specification of block

  ULong_t spec = 0;

  // -- Check for Connection
  if ( !fReader || ! IsConnected() ) {
    AliError( Form("Not connected yet.") );
    return spec;
  }

  // -- Check blockk index
  if ( ( ndx ) >= (Int_t) fNBlks ) {
    AliError( Form("Block index %d out of range.", ndx ) );
    return spec;
  }

  spec = (ULong_t) fReader->GetBlockDataSpec( ndx );

  return spec;
}

//##################################################################################
Bool_t AliEveHOMERManager::CheckIfRequested( AliHLTHOMERBlockDesc */* block*/ ) {
  // Checks if current Block should was requested
  // * return           returns kTRUE, if block should was requested

  Bool_t requested = kFALSE;
#if 0
  AliHLTHOMERSourceDesc * source= NULL;

  // -- Read all sources and check if they should be read out
  TIter next( fSourceList );
  while ( ( source = (AliHLTHOMERSourceDesc*)next() ) ) {
    
    if ( ! source->IsSelected() )
      continue;

    if ( !( block->GetDetector().CompareTo( "*** " ) && block->GetDetector().CompareTo( "***" ) ) ) {
      // if not any detector
      if ( source->GetDetector().CompareTo( block->GetDetector() ) )
	continue;
    }

    if ( ! ( block->GetDataType().CompareTo( "******* " ) && block->GetDataType().CompareTo( "******* " ) ) ) {
      if ( source->GetDataType().CompareTo( block->GetDataType() ) )
	continue;
    }

    if ( ! block->HasSubDetectorRange() ) {
      if ( source->GetSubDetector().Atoi() != block->GetSubDetector().Atoi() )
	continue;

      if ( ! block->HasSubSubDetectorRange() ) {

	if ( source->GetSubSubDetector().Atoi() != block->GetSubSubDetector().Atoi() )
	  continue;

      } // if ( ! block->HasSubSubDetectorRange ) {
    } //  if ( ! block->HasSubDetectorRange ) {

    requested = kTRUE;
    break;

  } // while ( ( source = (AliHLTHOMERSourceDesc*)next() ) ) {
  
#if EVE_DEBUG

  if ( block->GetDataType().CompareTo("CLUSTERS") ) {
  if ( requested ) {
    AliError( Form("Block requested : %s - %s : %s/%s -> %s ", block->GetDetector().Data(), block->GetDataType().Data(),
		   block->GetSubDetector().Data(), block->GetSubSubDetector().Data(), block->GetClassName().Data() ) );
  }
  else {
    AliError( Form("Block NOT requested : %s - %s : %s/%s -> %s ", block->GetDetector().Data(), block->GetDataType().Data(),
		   block->GetSubDetector().Data(), block->GetSubSubDetector().Data(), block->GetClassName().Data() ) );
  }

  }
#endif
#endif
  return requested;
}