nix-super/src/libstore/machines.hh

#pragma once
///@file

#include "types.hh"
#include "store-reference.hh"

namespace nix {

class Store;

struct Machine;

typedef std::vector<Machine> Machines;

struct Machine {

    const StoreReference storeUri;
    const std::set<std::string> systemTypes;
    const std::string sshKey;
    const unsigned int maxJobs;
    const float speedFactor;
    const std::set<std::string> supportedFeatures;
    const std::set<std::string> mandatoryFeatures;
    const std::string sshPublicHostKey;
    bool enabled = true;

    /**
     * @return Whether `system` is either `"builtin"` or in
     * `systemTypes`.
     */
    bool systemSupported(const std::string & system) const;

    /**
     * @return Whether `features` is a subset of the union of `supportedFeatures` and
     * `mandatoryFeatures`
     */
    bool allSupported(const std::set<std::string> & features) const;

    /**
     * @return @Whether `mandatoryFeatures` is a subset of `features`
     */
    bool mandatoryMet(const std::set<std::string> & features) const;

    Machine(
        const std::string & storeUri,
        decltype(systemTypes) systemTypes,
        decltype(sshKey) sshKey,
        decltype(maxJobs) maxJobs,
        decltype(speedFactor) speedFactor,
        decltype(supportedFeatures) supportedFeatures,
        decltype(mandatoryFeatures) mandatoryFeatures,
        decltype(sshPublicHostKey) sshPublicHostKey);

    /**
     * Elaborate `storeUri` into a complete store reference,
     * incorporating information from the other fields of the `Machine`
     * as applicable.
     */
    StoreReference completeStoreReference() const;

    /**
     * Open a `Store` for this machine.
     *
     * Just a simple function composition:
     * ```c++
     * nix::openStore(completeStoreReference())
     * ```
     */
    ref<Store> openStore() const;

    /**
     * Parse a machine configuration.
     *
     * Every machine is specified on its own line, and lines beginning
     * with `@` are interpreted as paths to other configuration files in
     * the same format.
     */
    static Machines parseConfig(const std::set<std::string> & defaultSystems, const std::string & config);
};

/**
 * Parse machines from the global config
 *
 * @todo Remove, globals are bad.
 */
Machines getMachines();

}