crosvm_builder.h

Go to the documentation of this file.

//
// Copyright (C) 2021 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#pragma once
 
#include <optional>
#include <string>
 
#include "json/value.h"
 
#include "cuttlefish/host/libs/vm_manager/pci.h"
#include "cuttlefish/process/command.h"
#include "cuttlefish/result/result.h"
 
namespace cuttlefish {
 
class CrosvmBuilder {
 public:
  static std::string FormatPciArgument(std::optional<pci::Address> pci);
 
  CrosvmBuilder();
 
  void ApplyProcessRestarter(const std::string& crosvm_binary,
                             const std::string& first_time_argument,
                             int exit_code);
  void AddControlSocket(const std::string&, const std::string&);
 
  Result<void> AddCpus(size_t cpus, const std::string& vcpu_config_path);
  Result<void> AddCpus(const Json::Value&);
  void AddCpus(size_t cpus);
 
  void AddHvcSink();
  void AddHvcReadOnly(const std::string& output, bool console = false);
  void AddHvcReadWrite(const std::string& output, const std::string& input);
  void AddHvcSocket(const std::string& socket);
 
  void AddKvmPath(const std::string& path);
 
  void AddReadOnlyDisk(const std::string& path,
                       std::optional<pci::Address> pci = std::nullopt);
  void AddReadWriteDisk(const std::string& path,
                        std::optional<pci::Address> pci = std::nullopt);
 
  void AddSerialSink();
  void AddSerialConsoleReadOnly(const std::string& output);
  void AddSerialConsoleReadWrite(const std::string& output,
                                 const std::string& input, bool earlycon);
  // [[deprecated("do not add any more users")]]
  void AddSerial(const std::string& output, const std::string& input);
 
#ifdef __linux__
  void AddTap(const std::string& tap_name,
              std::optional<std::string_view> mac = std::nullopt,
              const std::optional<pci::Address>& pci = std::nullopt);
#endif
  // Adds a vhost-user device to the crosvm command.
  // The max_queue_size parameter represents the maximum number of buffers the
  // virtqueues can hold at a given time and must be a power of 2. It must be
  // large enough to avoid dropping buffers during peak usage but not so large
  // that it consumes excesive amounts of guest RAM. Most sources recommend a
  // value between 256 and 1024, suggesting to start with 256 when in doubt and
  // increase as needed for performance.
  void AddVhostUser(const std::string& type, const std::string& socket_path,
                    int max_queue_size = 256);
 
  int HvcNum();
 
  Command& Cmd();
 
 private:
  Command command_;
  int hvc_num_ = 0;
  int serial_num_ = 0;
};
 
}  // namespace cuttlefish