Class: OsCtld::Daemon

Inherits:

Object

• Object
• OsCtld::Daemon

Includes:

OsCtl::Lib::Utils::Log, OsCtl::Lib::Utils::System, Assets::Definition

Defined in:

lib/osctld/daemon.rb

Defined Under Namespace

Modules: Hooks Classes: ClientHandler

Constant Summary

SOCKET =

File.join(RunState::RUNDIR, 'osctld.sock')

@@instance =

nil

Instance Attribute Summary

• #config ⇒ Config readonly
• #initialized ⇒ Boolean readonly
• #started_at ⇒ Time readonly

Class Method Summary

• .create(config) ⇒ Object
• .get ⇒ Object

Instance Method Summary

• #abort_shutdown ⇒ Object
• #abort_shutdown? ⇒ Boolean
• #assets ⇒ Object
• #begin_shutdown ⇒ Object
• #confirm_shutdown ⇒ Object
• #join_server ⇒ Object
• #log_type ⇒ Object
• #run_pre_stop_hooks ⇒ Object protected
• #serve ⇒ Object
• #setup ⇒ Object
• #shutdown? ⇒ Boolean
• #stop ⇒ Object
• #stopping? ⇒ Boolean
• #user_hook_script_dir ⇒ Object

Methods included from Assets::Definition

#define_assets

Instance Attribute Details

#config ⇒ Config (readonly)

Returns:

• (Config)

# File 'lib/osctld/daemon.rb', line 75

def config
  @config
end

#initialized ⇒ Boolean (readonly)

Returns:

• (Boolean)

# File 'lib/osctld/daemon.rb', line 81

def initialized
  @initialized
end

#started_at ⇒ Time (readonly)

Returns:

• (Time)

# File 'lib/osctld/daemon.rb', line 78

def started_at
  @started_at
end

Class Method Details

.create(config) ⇒ Object

Parameters:

• config (String) —

  path to config file

# File 'lib/osctld/daemon.rb', line 63

def create(config)
  raise 'Daemon already instantiated' if @@instance

  @@instance = new(config)
end

.get ⇒ Object

# File 'lib/osctld/daemon.rb', line 69

def get
  @@instance
end

Instance Method Details

#abort_shutdown ⇒ Object

# File 'lib/osctld/daemon.rb', line 256

def abort_shutdown
  @abort_shutdown = true

  begin
    File.unlink(RunState::SHUTDOWN_MARKER)
  rescue Errno::ENOENT
    # ignore
  end
end

#abort_shutdown? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/osctld/daemon.rb', line 278

def abort_shutdown?
  @abort_shutdown
end

#assets ⇒ Object

# File 'lib/osctld/daemon.rb', line 183

def assets
  define_assets do |add|
    RunState.assets(add)

    add.socket(
      SOCKET,
      desc: 'Management socket',
      user: 0,
      group: 0,
      mode: 0o600
    )

    Devices::V2::BpfProgramCache.assets(add)
  end
end

#begin_shutdown ⇒ Object

# File 'lib/osctld/daemon.rb', line 251

def begin_shutdown
  @abort_shutdown = false
  File.new(RunState::SHUTDOWN_MARKER, 'w', 0o000).close
end

#confirm_shutdown ⇒ Object

# File 'lib/osctld/daemon.rb', line 266

def confirm_shutdown
  unless File.exist?(RunState::SHUTDOWN_MARKER)
    File.new(RunState::SHUTDOWN_MARKER, 'w', 0o100).close
  end

  File.chmod(0o100, RunState::SHUTDOWN_MARKER)
end

#join_server ⇒ Object

# File 'lib/osctld/daemon.rb', line 215

def join_server
  @server_thread.join
end

#log_type ⇒ Object

# File 'lib/osctld/daemon.rb', line 282

def log_type
  'daemon'
end

#run_pre_stop_hooks ⇒ Object (protected)

# File 'lib/osctld/daemon.rb', line 288

def run_pre_stop_hooks
  Hook.run(self, :pre_stop)
rescue HookFailed => e
  log(:warn, "Daemon pre-stop hook failed: #{e.message}")
end

#serve ⇒ Object

# File 'lib/osctld/daemon.rb', line 199

def serve
  @server_thread = Thread.new do
    log(:info, "Listening on control socket at #{SOCKET}")

    socket = UNIXServer.new(SOCKET)
    File.chmod(0o600, SOCKET)

    @server = Generic::Server.new(
      socket,
      Daemon::ClientHandler,
      thread_group: :management
    )
    @server.start
  end
end

#setup ⇒ Object

# File 'lib/osctld/daemon.rb', line 117

def setup
  # Setup /run/osctl
  RunState.create

  # Open start config
  start_cfg = RunState.open_start_config

  SystemLimits.instance

  CpuScheduler.setup

  # Increase allowed number of open files
  PrLimits.set(Process.pid, PrLimits::NOFILE, 131_072, 131_072)

  # Setup shared AppArmor files
  if AppArmor.enabled?
    log(:info, 'AppArmor enabled')
    AppArmor.setup
  else
    log(:info, 'AppArmor disabled')
  end

  # Setup BPF FS
  BpfFs.setup

  # User-control supervisor
  UserControl::Supervisor.instance

  # Send/Receive hooks and server
  SendReceive.setup

  # Setup network interfaces
  NetInterface.setup

  # Start accepting client commands
  serve

  # Load data pools
  if KernelParams.import_pools?
    autostart = KernelParams.autostart_cts?

    Commands::Pool::Import.run(all: true, autostart:)

    unless autostart
      log(:info, 'Container autostart disabled by kernel parameter')
    end
  else
    log(:info, 'Pool autoimport disabled by kernel parameter')
  end

  # Resume shutdown
  if shutdown?
    log(:info, 'Resuming shutdown')
    Commands::Self::Shutdown.run
  end

  # Close start config
  start_cfg.close

  # All components are up
  @initialized = true

  # Wait for the server to finish
  join_server
end

#shutdown? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/osctld/daemon.rb', line 274

def shutdown?
  File.exist?(RunState::SHUTDOWN_MARKER)
end

#stop ⇒ Object

# File 'lib/osctld/daemon.rb', line 219

def stop
  @stopping = true
  log(:info, 'Stopping daemon')
  run_pre_stop_hooks
  @server.stop if @server
  join_server if @server_thread && @server_thread != Thread.current
  FileUtils.rm_f(SOCKET)
  ThreadReaper.drain(group: :management)
  UserControl.stop
  ThreadReaper.stop
  Eventd.shutdown
  SendReceive.stop
  DB::Repositories.each(&:stop)
  DB::Pools.get.each(&:stop)
  CpuScheduler.shutdown
  Monitor::Master.stop
  LockRegistry.stop
  log(:info, 'Daemon stopped successfully')
  # Stop can run from a signal helper thread while other background threads
  # are still reacting to shutdown. The graceful cleanup above is complete,
  # so terminate the process without waiting for unmanaged threads.
  exit!
end

#stopping? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/osctld/daemon.rb', line 243

def stopping?
  @stopping
end

#user_hook_script_dir ⇒ Object

# File 'lib/osctld/daemon.rb', line 247

def user_hook_script_dir
  RunState::DAEMON_HOOK_DIR
end