class Syskit::RobyApp::Configuration

Syskit engine configuration interface

The main configuration instance is accessible as Syskit.conf or (if running in a Roby application) as Conf.syskit

Constants

ModelOnlyServer
ProcessServerConfig

Attributes

app[R]

The application that we are configuring @return [Roby::Application]

buffer_size_margin[R]

Margin added to computed buffer sizes

The final buffer size is computed_size * margin rounded upwards. The default is 10% (0.1)

@return [Float]

deployed_tasks[R]

A mapping from a task name to the deployment that provides it

@return [{String => Models::ConfiguredDeployment}]

deployments[R]

The set of known deployments on a per-process-server basis

@return [Hash>]

logs[R]

Data logging configuration

@return [LoggingConfiguration]

orocos[R]

Component configuration

This returns an OpenStruct object in which component-specific configuration can be stored. Each component will in {TaskContext#configure} look for a value named as its deployed task name and apply configuration stored there (if there is any)

prefix[RW]

If set to a non-nil value, the deployment processes will be started with the given prefix

It is set from the syskit.prefix configuration variable in app.yml

@return [String,nil]

prefix_blacklist[R]

A set of regular expressions that should match the names of the deployments that should not be prefixed even if {#prefix} is set

It is set from the syskit.prefix_blacklist configuration variable in app.yml

@return [Array<String,Regexp>]

process_servers[R]

The set of process servers registered so far @return [Hash<String,ProcessServerConfig>]

sd_domain[RW]

If set, it is the service discovery domain in which the orocos processes should be published

It is set from the syskit.sd_domain configuration variable in app.yml

@return [String]

sd_publish_list[R]

A set of regular expressions that should match the names of the deployments that should be published on DNS-SD if {#sd_domain} is set

It is set from the syskit.sd_publish_list configuration variable in app.yml

@return [Array<String,Regexp>]

Public Class Methods

new(app) click to toggle source

Calls superclass method

# File lib/syskit/roby_app/configuration.rb, line 59
def initialize(app)
    super()

    @app = app
    @process_servers = Hash.new
    @load_component_extensions = true
    @redirect_local_process_server = true
    @reject_ambiguous_deployments = true
    @only_load_models = nil
    @disables_local_process_server = false
    @local_only = false
    @permanent_deployments = true
    @prefix_blacklist = []
    @sd_publish_list = []
    @ignore_missing_orogen_projects_during_load = false
    @ignore_load_errors = false
    @buffer_size_margin = 0.1
    @use_only_model_pack = false
    clear

    self.export_types = true
end

Public Instance Methods

clear() click to toggle source

Resets this Syskit configuration object

Note that it is called by {#initialize}

# File lib/syskit/roby_app/configuration.rb, line 89
def clear
    @deployments = Hash.new { |h, k| h[k] = Set.new }
    @deployed_tasks = Hash.new
    @logs = LoggingConfiguration.new
    @orocos = Roby::OpenStruct.new
end

clear_deployments() click to toggle source

Remove all registered deployments

# File lib/syskit/roby_app/configuration.rb, line 696
def clear_deployments
    deployments.clear
    deployed_tasks.clear
end

clear_deployments_for(process_server_name) click to toggle source

Deregisters deployments that are coming from a given process server

@param [String] process_server_name the name of the process server @return [Array<Models::ConfiguredDeployment>] the set of

configured deployments that were deregistered

# File lib/syskit/roby_app/configuration.rb, line 707
def clear_deployments_for(process_server_name)
    registered_deployments = deployments.delete(process_server_name) ||
        Array.new

    registered_deployments.each do |d|
        deregister_configured_deployment(d)
    end
    registered_deployments
end

connect_to_orocos_process_server( name, host, port: Orocos::RemoteProcesses::DEFAULT_PORT, log_dir: nil, result_dir: nil, host_id: nil) click to toggle source

Call to declare a new process server and add to the set of servers that can be used by this plan manager

If 'host' is set to localhost, it disables the automatic startup of the local process server (i.e. sets orocos_disables_local_process_server to true)

@return [Orocos::ProcessClient,Orocos::Generation::Project]

@raise [ArgumentError] if host is not 'localhost' and

{#local_only?} is set

@raise [ArgumentError] if there is already a process server

registered with that name

# File lib/syskit/roby_app/configuration.rb, line 627
def connect_to_orocos_process_server(
    name, host, port: Orocos::RemoteProcesses::DEFAULT_PORT,
    log_dir: nil, result_dir: nil, host_id: nil)

    if log_dir || result_dir
        Syskit.warn "specifying log and/or result dir for remote process servers is deprecated. Use 'syskit process_server' instead of 'orocos_process_server' which will take the log dir information from the environment/configuration"
    end

    if only_load_models? || (app.simulation? && app.single?)
        client = ModelOnlyServer.new(app.default_loader)
        register_process_server(name, client, app.log_dir, host_id: host_id || 'syskit')
        return client
    elsif app.single?
        client = Orocos::RemoteProcesses::Client.new(
            'localhost', port, root_loader: app.default_loader)
        register_process_server(name, client, app.log_dir, host_id: host_id || 'localhost')
        return client
    end

    if local_only? && host != 'localhost'
        raise ArgumentError, "in local only mode"
    elsif process_servers[name]
        raise ArgumentError, "we are already connected to a process server called #{name}"
    end

    if host =~ /^(.*):(\d+)$/
        host = $1
        port = Integer($2)
    end

    if host == 'localhost'
        self.disables_local_process_server = true
    end

    client = Orocos::RemoteProcesses::Client.new(
        host, port, root_loader: app.default_loader)
    client.create_log_dir(log_dir, Roby.app.time_tag, Hash['parent' => Roby.app.app_metadata])
    register_process_server(name, client, log_dir, host_id: host_id || name)
    client
end

create_subfield(name) click to toggle source

# File lib/syskit/roby_app/configuration.rb, line 82
def create_subfield(name)
    Roby::OpenStruct.new(model, self, name)
end

default_logging_buffer_size() click to toggle source

@deprecated access {#logs} for logging configuration

# File lib/syskit/roby_app/configuration.rb, line 97
def default_logging_buffer_size
    Roby.warn_deprecated "logging configuration has been moved to Syskit.conf.logs (of type LoggingConfiguration)"
    logs.default_logging_buffer_size
end

default_logging_buffer_size=(size) click to toggle source

@deprecated access {#logs} for logging configuration

# File lib/syskit/roby_app/configuration.rb, line 103
def default_logging_buffer_size=(size)
    Roby.warn_deprecated "logging configuration has been moved to Syskit.conf.logs (of type LoggingConfiguration)"
    logs.default_logging_buffer_size=size
end

default_prefix(deployment_model) click to toggle source

Returns the deployment prefix that should be used to start the given syskit deployment process

@return [String,nil] the prefix that should be used when starting

this deployment, or nil if there should be none

# File lib/syskit/roby_app/configuration.rb, line 520
def default_prefix(deployment_model)
    return if !prefix
    deployment_name = deployment_model.deployment_name

    exclude = prefix_blacklist.any? do |pattern|
        pattern === deployment_name
    end
    if !exclude
        "#{prefix}_"
    end
end

default_run_options(deployment_model) click to toggle source

Returns the set of options that should be given to Process.spawn to start the given deployment model

@return {String=>String} the set of default options that should be

used when starting the given deployment

# File lib/syskit/roby_app/configuration.rb, line 504
def default_run_options(deployment_model)
    result = Hash.new
    if prefix = default_prefix(deployment_model)
        result["prefix"] = prefix
    end
    if sd_domain = default_sd_domain(deployment_model)
        result["sd-domain"] = sd_domain
    end
    result
end

default_sd_domain(deployment_model) click to toggle source

Sets up mDNS support for the syskit deployment processes

@return [String,nil] the SD domain on which this deployment should

be published, or nil if none

# File lib/syskit/roby_app/configuration.rb, line 536
def default_sd_domain(deployment_model)
    return if !sd_domain
    deployment_name = deployment_model.name

    publish = publish_white_list.any? do |pattern|
        pattern === deployment_name
    end
    if publish
        sd_domain
    end
end

deregister_configured_deployment(configured_deployment) click to toggle source

Deregister deployments

@param [ConfiguredDeployment] the deployment to remove, as

returned by e.g. {#use_deployment}

@return [void]

# File lib/syskit/roby_app/configuration.rb, line 448
def deregister_configured_deployment(configured_deployment)
    configured_deployment.each_orogen_deployed_task_context_model do |task|
        if deployed_tasks[task.name] == configured_deployment
            deployed_tasks.delete(task.name)
        end
    end
    deployments[configured_deployment.process_server_name].
        delete(configured_deployment)
end

disable_conf_logging() click to toggle source

@deprecated access {#logs} for logging configuration

# File lib/syskit/roby_app/configuration.rb, line 166
def disable_conf_logging
    Roby.warn_deprecated "logging configuration has been moved to Syskit.conf.logs (of type LoggingConfiguration)"
    logs.disable_conf_logging
end

disable_log_group(name) click to toggle source

@deprecated access {#logs} for logging configuration

# File lib/syskit/roby_app/configuration.rb, line 139
def disable_log_group(name)
    Roby.warn_deprecated "logging configuration has been moved to Syskit.conf.logs (of type LoggingConfiguration)"
    logs.disable_group(name)
end

disable_logging() click to toggle source

@deprecated access {#logs} for logging configuration

# File lib/syskit/roby_app/configuration.rb, line 154
def disable_logging
    Roby.warn_deprecated "logging configuration has been moved to Syskit.conf.logs (of type LoggingConfiguration)"
    logs.disable_port_logging
end

each_configured_deployment(on: nil, except_on: nil, &block) click to toggle source

Enumerate the registered configured deployments

@param [String,nil] on name or regexp matching the name of the

process servers whose deployments should be enumerated, or all
servers if nil

@param [String,nil] except_on name or regexp matching the name of the

process servers whose deployments should NOT be enumerated

@yieldparam [Models::ConfiguredDeployment]

# File lib/syskit/roby_app/configuration.rb, line 466
def each_configured_deployment(on: nil, except_on: nil, &block)
    return enum_for(__method__, on: on, except_on: except_on) if !block

    deployments.each do |process_server_name, process_server_deployments|
        next if except_on && (except_on === process_server_name)
        next if on && !(on === process_server_name)
        process_server_deployments.each(&block)
    end
end

each_process_server() { |client| ... } click to toggle source

Enumerates all available process servers

@yieldparam [Object] #process_server the registered process server,

as an object that conforms to orocos.rb's process server API

@return [void]

# File lib/syskit/roby_app/configuration.rb, line 585
def each_process_server
    return enum_for(__method__) if !block_given?
    process_servers.each_value do |config|
        yield(config.client)
    end
end

each_process_server_config(&block) click to toggle source

Enumerates the registration information for all known process servers

@yieldparam [ProcessServerConfig] #process_server the registered process server,

as an object that conforms to orocos.rb's process server API

@return [void]

# File lib/syskit/roby_app/configuration.rb, line 597
def each_process_server_config(&block)
    process_servers.each_value(&block)
end

enable_conf_logging() click to toggle source

@deprecated access {#logs} for logging configuration

# File lib/syskit/roby_app/configuration.rb, line 160
def enable_conf_logging
    Roby.warn_deprecated "logging configuration has been moved to Syskit.conf.logs (of type LoggingConfiguration)"
    logs.enable_conf_logging
end

enable_log_group(name) click to toggle source

@deprecated access {#logs} for logging configuration

# File lib/syskit/roby_app/configuration.rb, line 133
def enable_log_group(name)
    Roby.warn_deprecated "logging configuration has been moved to Syskit.conf.logs (of type LoggingConfiguration)"
    logs.enable_group(name)
end

enable_logging() click to toggle source

@deprecated access {#logs} for logging configuration

# File lib/syskit/roby_app/configuration.rb, line 149
def enable_logging
    Roby.warn_deprecated "logging configuration has been moved to Syskit.conf.logs (of type LoggingConfiguration)"
    logs.enable_port_logging
end

exclude_from_log(object, subname = nil) click to toggle source

Permanently exclude object from the logging system

object can be

a deployment model, in which case no task in this deployment will be logged
a task model, in which case no port of any task of this type will be logged
a port model, in which case no such port will be logged (regardless of which task it is on)
a string. It can then either be a task name, a port name or a type name

# File lib/syskit/roby_app/configuration.rb, line 127
def exclude_from_log(object, subname = nil)
    main_group.add(object, subname)
end

export_types=(flag) click to toggle source

Controls whether the orogen types should be exported as Ruby constants

@param [Boolean] flag

# File lib/syskit/roby_app/configuration.rb, line 54
def export_types=(flag)
    @export_types = flag
    app.default_loader.export_types = flag
end

has_process_server?(name) click to toggle source

Tests whether there is a registered process server with that name

# File lib/syskit/roby_app/configuration.rb, line 549
def has_process_server?(name)
    process_servers[name.to_str]
end

log_group(name, &block) click to toggle source

@deprecated access {#logs} for logging configuration

# File lib/syskit/roby_app/configuration.rb, line 109
def log_group(name, &block)
    Roby.warn_deprecated "logging configuration has been moved to Syskit.conf.logs (of type LoggingConfiguration)"
    logs.create_group(name) do |group|
        group.instance_eval(&block)
    end
end

only_load_models=(flag) click to toggle source

In normal operations, the plugin initializes the CORBA layer, which takes some time.

In some tools, one only wants to manipulate models offline. In which case we don't need to waste time initializing the layer.

Set this value to true to avoid initializing the CORBA layer

# File lib/syskit/roby_app/configuration.rb, line 188
def only_load_models=(flag)
    @only_load_models = flag
end

only_load_models?() click to toggle source

# File lib/syskit/roby_app/configuration.rb, line 192
def only_load_models?
    if @only_load_models.nil?
        app.modelling_only?
    else
        @only_load_models
    end
end

prefixing?() click to toggle source

True if deployments are going to be started with a prefix

# File lib/syskit/roby_app/configuration.rb, line 217
def prefixing?; !!prefix end

process_server(*args) click to toggle source

@deprecated use {#connect_to_orocos_process_server} instead

# File lib/syskit/roby_app/configuration.rb, line 602
def process_server(*args)
    connect_to_orocos_process_server(*args)
end

process_server_config_for(name) click to toggle source

Returns the process server object named name

@param [String] name the process server name @raise [ArgumentError] if no such process server exists @return [ProcessServerConfig]

# File lib/syskit/roby_app/configuration.rb, line 558
def process_server_config_for(name)
    config = process_servers[name]
    if config then config
    else
        raise ArgumentError, "there is no registered process server called #{name}"
    end
end

process_server_for(name) click to toggle source

Returns the process server object named name

@param (see process_server_config_for) @raise (see process_server_config_for) @return [Object] an object that conforms to orocos.rb's process

server API

# File lib/syskit/roby_app/configuration.rb, line 572
def process_server_for(name)
    process_server_config_for(name).client
end

register_configured_deployment(configured_deployment) click to toggle source

# File lib/syskit/roby_app/configuration.rb, line 430
def register_configured_deployment(configured_deployment)
    configured_deployment.each_orogen_deployed_task_context_model do |task|
        orocos_name = task.name
        if deployed_tasks[orocos_name] && deployed_tasks[orocos_name] != configured_deployment
            raise TaskNameAlreadyInUse.new(orocos_name, deployed_tasks[orocos_name], configured_deployment), "there is already a deployment that provides #{orocos_name}"
        end
    end
    configured_deployment.each_orogen_deployed_task_context_model do |task|
        deployed_tasks[task.name] = configured_deployment
    end
    deployments[configured_deployment.process_server_name] << configured_deployment
end

register_process_server(name, client, log_dir = nil, host_id: name) click to toggle source

Make a process server available to syskit

@param [String] name the process server name @param [Object] client the process server client object, which has

to conform to the API of {Orocos::Remotes::Client}

@param [String] log_dir the path to the server's log directory @return [ProcessServerConfig]

# File lib/syskit/roby_app/configuration.rb, line 685
def register_process_server(name, client, log_dir = nil, host_id: name)
    if process_servers[name]
        raise ArgumentError, "there is already a process server registered as #{name}, call #remove_process_server first"
    end

    ps = ProcessServerConfig.new(name, client, log_dir, host_id)
    process_servers[name] = ps
    ps
end

remove_process_server(name) click to toggle source

Deregisters a process server

@param [String] name the process server name, as given to

{register_process_server}

@raise ArgumentError if there is no process server with that name

# File lib/syskit/roby_app/configuration.rb, line 722
def remove_process_server(name)
    ps = process_servers.delete(name)
    if !ps
        raise ArgumentError, "there is no registered process server called #{name}"
    end

    app.default_loader.remove ps.client.loader
    clear_deployments_for(name)
    if app.simulation? && process_servers["#{name}-sim"]
        remove_process_server("#{name}-sim")
    end
    ps
end

sim_process_server(name) click to toggle source

Ensures that a ruby process server is present with the given name

It is used when running in simulation mode, to “fake” the task contexts

@param [String] name the name of the original process server @return [ProcessServerConfig] the registered process server

# File lib/syskit/roby_app/configuration.rb, line 274
def sim_process_server(name)
    sim_name = "#{name}-sim"
    if !process_servers[sim_name]
        mng = Orocos::RubyTasks::ProcessManager.new(app.default_loader, task_context_class: Orocos::RubyTasks::StubTaskContext)
        register_process_server(sim_name, mng, "", host_id: 'syskit')
    end
    process_server_config_for(sim_name)
end

use_deployment(*names, on: 'localhost', **run_options) click to toggle source

Add the given deployment (referred to by its process name, that is the name given in the oroGen file) to the set of deployments the engine can use.

@option options [String] :on (localhost) the name of the process

server on which this deployment should be started

@return [Array<Models::ConfiguredDeployment>]

# File lib/syskit/roby_app/configuration.rb, line 365
def use_deployment(*names, on: 'localhost', **run_options)
    deployment_spec = Hash.new
    if names.last.kind_of?(Hash)
        deployment_spec = names.pop
    end

    process_server_name = on
    process_server_config =
        if app.simulation?
            sim_process_server(process_server_name)
        else
            process_server_config_for(process_server_name)
        end

    deployments_by_name = Hash.new
    names = names.map do |n|
        if n.respond_to?(:orogen_model)
            if !n.kind_of?(Class)
                raise ArgumentError, "only deployment models can be given "\
                    "without a name"
            elsif n <= Syskit::TaskContext && !(n <= Syskit::RubyTaskContext)
                raise TaskNameRequired, "you must provide a task name when starting a "\
                    "component by type, as e.g. use_deployment "\
                    "OroGen.xsens_imu.Task => 'imu'"
            elsif !(n <= Syskit::Deployment)
                raise ArgumentError, "only deployment models can be given "\
                    "without a name"
            end
            deployments_by_name[n.orogen_model.name] = n
            n.orogen_model
        else n
        end
    end
    deployment_spec = deployment_spec.map_key do |k|
        if k.respond_to?(:to_str)
            k
        else
            is_valid =
                k.kind_of?(Class) &&
                (k <= Syskit::TaskContext || k <= Syskit::Deployment) &&
                !(k <= Syskit::RubyTaskContext)
            unless is_valid
                raise ArgumentError, "only deployment and task context "\
                    "models can be deployed by use_deployment, got #{k}"
            end
            deployments_by_name[k.orogen_model.name] = k
            k.orogen_model
        end
    end

    new_deployments, _ = Orocos::Process.parse_run_options(*names, deployment_spec, loader: app.default_loader, **run_options)
    new_deployments.map do |deployment_name, mappings, name, spawn_options|
        model = deployments_by_name[deployment_name] ||
            app.using_deployment(deployment_name)
        model.default_run_options.merge!(default_run_options(model))

        configured_deployment = Models::ConfiguredDeployment.
            new(process_server_config.name, model, mappings, name, spawn_options)
        register_configured_deployment(configured_deployment)
        configured_deployment
    end
rescue Orocos::Process::TaskNameRequired => e
    raise TaskNameRequired, "you must provide a task name when starting a component by type, as e.g. use_deployment OroGen.xsens_imu.Task => 'imu'", e.backtrace
end

use_deployments_from(project_name, options = Hash.new) click to toggle source

Add all the deployments defined in the given oroGen project to the set of deployments that the engine can use.

@option options [String] :on the name of the process server this

project should be loaded from

@return [Array<Model<Deployment>>] the set of deployments @see use_deployment

# File lib/syskit/roby_app/configuration.rb, line 483
def use_deployments_from(project_name, options = Hash.new)
    Syskit.info "using deployments from #{project_name}"
    orogen = app.using_task_library(project_name, options[:loader])

    result = []
    orogen.deployers.each_value do |deployment_def|
        if deployment_def.install?
            Syskit.info "  #{deployment_def.name}"
            # Currently, the supervision cannot handle orogen_default tasks
            # properly, thus filtering them out for now
            result << use_deployment(deployment_def.name, options)
        end
    end
    result
end

use_ruby_tasks(mappings, remote_task: false, on: 'ruby_tasks') click to toggle source

Declare deployed versions of some Ruby tasks

rubocop:disable Metrics/PerceivedComplexity

# File lib/syskit/roby_app/configuration.rb, line 286
def use_ruby_tasks(mappings, remote_task: false, on: 'ruby_tasks')
    if !mappings.respond_to?(:each_key)
        raise ArgumentError, "mappings should be given as model => name"
    elsif mappings.size > 1
        Roby.warn_deprecated "defining more than one ruby task context " \
            "deployment in a single use_ruby_tasks call is deprecated"
    end

    mappings.each_key do |task_model|
        valid_model = task_model.kind_of?(Class) &&
            (task_model <= Syskit::RubyTaskContext)
        unless valid_model
            raise ArgumentError, "#{task_model} is not a ruby task model"
        end
    end

    task_context_class =
        if remote_task
            Orocos::RubyTasks::RemoteTaskContext
        else
            Orocos::RubyTasks::TaskContext
        end

    mappings.map do |task_model, name|
        deployment_model = task_model.deployment_model
        configured_deployment = Models::ConfiguredDeployment.
            new(on, deployment_model, Hash['task' => name],
                name, Hash[task_context_class: task_context_class])
        register_configured_deployment(configured_deployment)
        configured_deployment
    end
end

use_unmanaged_task(mappings, on: 'unmanaged_tasks') click to toggle source

Declare tasks that are going to be started by some other process, but whose tasks are going to be integrated in the syskit network

# File lib/syskit/roby_app/configuration.rb, line 322
def use_unmanaged_task(mappings, on: 'unmanaged_tasks')
    model_to_name = mappings.map do |task_model, name|
        if task_model.respond_to?(:to_str)
            task_model_name = task_model
            task_model = Syskit::TaskContext.find_model_from_orogen_name(task_model_name)
            if !task_model
                raise ArgumentError, "#{task_model_name} is not a known oroGen model name"
            end
        end
        [task_model, name]
    end

    model_to_name.each do |task_model, _name|
        is_pure_task_context_model =
            task_model.kind_of?(Class) &&
            (task_model <= Syskit::TaskContext) &&
            !(task_model <= Syskit::RubyTaskContext)
        raise ArgumentError, "expected a mapping from a task context "\
            "model to a name, but got #{task_model}" \
            unless is_pure_task_context_model
    end

    model_to_name.map do |task_model, name|
        orogen_model = task_model.orogen_model
        deployment_model = Deployment.new_submodel(name: "Deployment::Unmanaged::#{name}") do
            task name, orogen_model
        end

        configured_deployment = Models::ConfiguredDeployment.
            new(on, deployment_model, Hash[name => name], name, Hash.new)
        register_configured_deployment(configured_deployment)
        configured_deployment
    end
end