Job.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef EVENT_LOOP_JOB_HH
#define EVENT_LOOP_JOB_HH
 
//          
// Distributed under the Boost Software License, Version 1.0.
//    (See accompanying file LICENSE_1_0.txt or copy at
//          http://www.boost.org/LICENSE_1_0.txt)
 
// Please feel free to contact me (krumnack@iastate.edu) for bug
// reports, feature suggestions, praise and complaints.
 

 
 
 
#include <EventLoop/Global.h>
 
 
#include <AnaAlgorithm/Global.h>
#include <EventLoop/JobConfig.h>
#include <SampleHandler/SampleHandler.h>
#include <SampleHandler/MetaObject.h>
#include <vector>
#include <memory>
class AnaReentrantAlgorithmConfig;
 
namespace asg
{
  class AsgServiceConfig;
}
 
namespace EL
{
  class PythonConfigBase;
 

  void swap (Job& a, Job& b);
 
 
  class Job
  {
    //
    // public interface
    //

  public:
    void testInvariant () const;
 

  public:
    Job ();
 

  public:
    Job (const Job& that);
 

  public:
    ~Job ();
 

  public:
    Job& operator = (const Job& that);
 

  public:
    const SH::SampleHandler& sampleHandler () const;
    void sampleHandler (const SH::SampleHandler& val_sampleHandler);
 

  public:
    void algsAdd (std::unique_ptr<IAlgorithmWrapper> val_algorithm);
    void algsAdd (std::unique_ptr<Algorithm> val_algorithm);
    void algsAdd (Algorithm *alg_swallow);
    void algsAdd (const AnaAlgorithmConfig& config);
    void algsAdd (const AnaReentrantAlgorithmConfig& config);
    void algsAdd (const asg::AsgServiceConfig& config);
    void algsAdd (const EL::PythonConfigBase& config);
 

  public:
    void algsAddClone (const Algorithm& alg);
 

  public:
    bool algsHas (const std::string& name) const;
 

  public:
    typedef OutputStream* outputMIter;
    typedef const OutputStream* outputIter;
    outputMIter outputBegin ();
    outputIter outputBegin () const;
    outputMIter outputEnd ();
    outputIter outputEnd () const;
    void outputAdd (const OutputStream& val_output);
 

  public:
    bool outputHas (const std::string& name) const;
 

  public:
    void useXAOD ();
 

  public:
    SH::MetaObject *options ();
    const SH::MetaObject *options () const;
 

  public:
    const JobConfig& jobConfig () const noexcept;
 

  public:
    static const std::string optRemoveSubmitDir;
 

  public:
    static const std::string optSubmitDirMode;

  public:
    static const std::string optUniqueDateFormat;
 

    static const std::string optAlgorithmTimer;
 

    static const std::string optAlgorithmMemoryMonitor;
 

    static const std::string optFactoryPreload;

    static const std::string optStreamAliases;
 

  public:
    static const std::string optMaxEvents;
 

  public:
    static const std::string optSkipEvents;
 

  public:
    static const std::string optWorkerConfigFile;
 


  public:
    static const std::string optFilesPerWorker;
 

  public:
    static const std::string optEventsPerWorker;
 
  public: 
    static const std::string optWorkerPostClosedOutputsExecutable;
 

  public:
    static const std::string optSubmitFlags;
 

  public:
    static const std::string optCondorConf;
 

  public:
    static const std::string optCacheSize;
 

  public:
    static const std::string optCacheLearnEntries;
 

  public:
    static const std::string optD3PDPerfStats;
 

  public:
    static const std::string optD3PDReadStats;
 

  public:
    static const std::string optXAODPerfStats;
 

  public:
    static const std::string optXAODReadStats;
 

  public:
    static const std::string optD3PDCacheMinEvent;
    static const std::string optD3PDCacheMinEventFraction;
    static const std::string optD3PDCacheMinByte;
    static const std::string optD3PDCacheMinByteFraction;
 

  public:
    static const std::string optPerfTree;
 

  public:
    static const std::string optXAODInput;

  public:
    static const std::string optXaodAccessMode;
    static const std::string optXaodAccessMode_branch;
    static const std::string optXaodAccessMode_class;
    static const std::string optXaodAccessMode_athena;
 
  public:
    static const std::string optOtherMetaDataTreeNamePattern;
 

  public:
    static const std::string optXAODSummaryReport;
 

  public:
    static const std::string optPrintPerFileStats;
 

  public:
    static const std::string optDisableMetrics;
 

  public:
    static const std::string optResetShell;

  public:
    static const std::string optLocalNoUnsetup;

  public:
    static const std::string optNumParallelProcs;
 

  public:
    static const std::string optBackgroundProcess;
 

  public:
    static const std::string optOutputSampleName;
 

  public:
    static const std::string optGridDestSE;
    static const std::string optGridSite;
    static const std::string optGridExcludedSite;
    static const std::string optGridNGBPerJob;
    static const std::string optGridMemory;
    static const std::string optGridMaxCpuCount;
    static const std::string optGridNFiles;
    static const std::string optGridNFilesPerJob;
    static const std::string optGridNJobs;
    static const std::string optGridMaxFileSize;
    static const std::string optGridMaxNFilesPerJob;
    static const std::string optGridNEventsPerJob;
    static const std::string optGridExpress;
    static const std::string optGridNoSubmit;
    static const std::string optGridMergeOutput;
    static const std::string optGridAddNthFieldOfInDSToLFN;
    static const std::string optGridWorkingGroup;
    static const std::string optGridShowCmd;
    static const std::string optGridCpuTimePerEvent;
    static const std::string optGridMaxWalltime;
    static const std::string optGridAvoidVP;
    static const std::string optGridPrunShipAdditionalFilesOrDirs; 

    // (see EventLoopGrid/data/ELG_prun.py script)
    static const std::string optGridPrunNRetrySubmitToGrid;
 
    static const std::string optTmpDir;
    static const std::string optRootVer;
    static const std::string optCmtConfig;
    static const std::string optGridDisableAutoRetry;
    static const std::string optOfficial;
    static const std::string optVoms;

    static const std::string optGridReporting;

 
    static const std::string optRetries;
    static const std::string optRetriesWait;

 

    static const std::string optUserFiles;
 
 

  public:
    static const std::string optBatchSharedFileSystem;
    static const std::string optBatchSlurmExtraConfigLines;
    static const std::string optBatchSlurmWrapperExec;
    static const std::string optBatchSetupCommand;

    static const std::string optDockerImage;

    static const std::string optDockerOptions;

    static const std::string optBatchConfigFile;

    static const std::string optBatchSetupFile;
 
 
  public:

    static const std::string optMemResidentPerEventIncreaseLimit;

    static const std::string optMemVirtualPerEventIncreaseLimit;

    static const std::string optMemResidentIncreaseLimit;

    static const std::string optMemVirtualIncreaseLimit;

    static const std::string optMemFailOnLeak;

 

    static const std::string histogramStreamName;
 
 
 
    //
    // private interface
    //
 
    friend void swap (Job& a, Job& b);

  private:
    SH::SampleHandler m_sampleHandler;
  private:
    std::vector<EL::OutputStream> m_output;
  private:
    SH::MetaObject m_options;

  private:
    EL::JobConfig m_jobConfig;
  };
}
 
#endif