kernel.h

Go to the documentation of this file.

// === kernel.h ========================================================================================================
//                                               Sen Infrastructure
//                   Released under the Apache License v2.0 (SPDX-License-Identifier Apache-2.0).
//                                    See the LICENSE.txt file for more information.
//                   © Airbus SAS, Airbus Helicopters, and Airbus Defence and Space SAU/GmbH/SAS.
// =====================================================================================================================
 
#ifndef SEN_KERNEL_KERNEL_H
#define SEN_KERNEL_KERNEL_H
 
// sen
#include "sen/core/base/class_helpers.h"
#include "sen/core/base/span.h"
#include "sen/core/meta/class_type.h"
 
// kernel
#include "sen/kernel/kernel_config.h"
 
// generated code
#include "stl/sen/kernel/basic_types.stl.h"
#include "stl/sen/kernel/network_footprint.stl.h"
 
// std
#include <filesystem>
#include <memory>
#include <optional>
 
namespace sen::kernel
{
 
// Forward declarations
class TestKernel;

enum class KernelBlockMode
{
  doNotBlock,  
  doBlock,     
};

class Kernel final
{
  SEN_NOCOPY_NOMOVE(Kernel)
 
public:
  explicit Kernel(KernelConfig config);
  ~Kernel() noexcept;
 
public:
  [[nodiscard]] int run(KernelBlockMode blockMode = KernelBlockMode::doBlock);

  void requestStop(int exitCode = 0);

  [[nodiscard]] NetworkFootprint getNetworkFootprint(Span<const BusAddress> suppliedBusAddresses);

  [[nodiscard]] const KernelConfig& getConfig() const noexcept;

  [[nodiscard]] std::filesystem::path getConfigPath() const noexcept;

  [[nodiscard]] static const BuildInfo& getBuildInfo() noexcept;
 
private:
  friend class KernelApi;
  friend class PreloadApi;
  friend class UnloadApi;
  friend class impl::Runner;
  friend class TestKernel;
 
private:
  std::unique_ptr<impl::KernelImpl> pimpl_;
};

namespace crash
{

bool arm(const std::filesystem::path& reportDirectory = {});

[[nodiscard]] std::optional<int> runHandlerIfRequested(int argc, char* argv[]);
 
}  // namespace crash
 
}  // namespace sen::kernel
 
#endif  // SEN_KERNEL_KERNEL_H