DriverInfo.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
#ifndef O2_FRAMEWORK_DRIVERINFO_H_
#define O2_FRAMEWORK_DRIVERINFO_H_
 
#include <cstddef>
#include <vector>
 
#include <csignal>
#include <sys/select.h>
 
#include "Framework/ChannelConfigurationPolicy.h"
#include "Framework/ConfigParamSpec.h"
#include "Framework/ProcessingPolicies.h"
#include "Framework/CallbacksPolicy.h"
#include "Framework/CompletionPolicy.h"
#include "Framework/DispatchPolicy.h"
#include "Framework/DeviceMetricsInfo.h"
#include "Framework/LogParsingHelpers.h"
#include "Framework/SendingPolicy.h"
#include "DataProcessorInfo.h"
#include "ResourcePolicy.h"
 
namespace o2::framework
{
 
struct ConfigContext;
 
enum struct DriverState {
  INIT = 0,
  SCHEDULE,
  RUNNING,
  REDEPLOY_GUI,
  QUIT_REQUESTED,
  HANDLE_CHILDREN,
  EXIT,
  UNKNOWN,
  PERFORM_CALLBACKS,
  MATERIALISE_WORKFLOW,
  IMPORT_CURRENT_WORKFLOW,
  DO_CHILD,
  MERGE_CONFIGS,
  BIND_GUI_PORT,
  LAST
};
 
struct DriverInfo {
  std::vector<DriverState> states;
 
  // Signal handler for children
  struct sigaction sa_handle_child;
  bool sigintRequested;
  bool sigchldRequested;
  std::vector<ChannelConfigurationPolicy> channelPolicies;
  std::vector<CompletionPolicy> completionPolicies;
  std::vector<DispatchPolicy> dispatchPolicies;
 
  std::vector<ResourcePolicy> resourcePolicies;
 
  std::vector<SendingPolicy> sendingPolicies;
  std::vector<ForwardingPolicy> forwardingPolicies;
  int argc;
  char** argv;
  ProcessingPolicies processingPolicies;
  std::vector<CallbacksPolicy> callbacksPolicies;
  uint64_t startTime;
  uint64_t startTimeMsFromEpoch;
  double timeout;
  std::string deployHostname;
  std::string resources;
  std::vector<DataProcessorInfo> processorInfo;
  ConfigContext const* configContext;
  float frameCost;
  float frameLatency;
  std::string uniqueWorkflowId = "";
  unsigned short resourcesMonitoringInterval = 0;
  std::string resourcesMonitoringFilename = "performanceMetrics.json";
  unsigned short resourcesMonitoringDumpInterval = 0;
  unsigned short port = 0;
  LogParsingHelpers::LogLevel minFailureLevel = LogParsingHelpers::LogLevel::Fatal;
 
  DeviceMetricsInfo metrics;
  bool noSHMCleanup;
  std::string defaultDriverClient = "invalid";
 
  std::string lastError;
  DriverMode mode = DriverMode::STANDALONE;
};
 
struct DriverInfoHelper {
  static char const* stateToString(enum DriverState state);
};
 
} // namespace o2::framework
 
#endif // O2_FRAMEWORK_DRIVERINFO_H_