Google Git
Sign in
android / device / google / cuttlefish_common / 7bc478dca2cf6d09fb6a1339ce367b57b27d5222 / . / host / commands / assemble_cvd / flags.cc
blob: 48d3286ebe3e3ce8d65deb66c8c841fa19ca2921 [file] [log] [blame]
#include "host/commands/assemble_cvd/flags.h"
#include <iostream>
#include <fstream>
#include <android-base/strings.h>
#include <gflags/gflags.h>
#include <glog/logging.h>
#include "common/libs/utils/environment.h"
#include "common/libs/utils/files.h"
#include "host/commands/assemble_cvd/boot_image_unpacker.h"
#include "host/commands/assemble_cvd/data_image.h"
#include "host/commands/assemble_cvd/image_aggregator.h"
#include "host/commands/assemble_cvd/assembler_defs.h"
#include "host/commands/assemble_cvd/super_image_mixer.h"
#include "host/libs/config/fetcher_config.h"
#include "host/libs/vm_manager/crosvm_manager.h"
#include "host/libs/vm_manager/qemu_manager.h"
#include "host/libs/vm_manager/vm_manager.h"
using vsoc::GetPerInstanceDefault;
using cvd::AssemblerExitCodes;
DEFINE_string(cache_image, "", "Location of the cache partition image.");
DEFINE_string(metadata_image, "", "Location of the metadata partition image "
"to be generated.");
DEFINE_int32(blank_metadata_image_mb, 16,
"The size of the blank metadata image to generate, MB.");
DEFINE_int32(cpus, 2, "Virtual CPU count.");
DEFINE_string(data_image, "", "Location of the data partition image.");
DEFINE_string(data_policy, "use_existing", "How to handle userdata partition."
" Either 'use_existing', 'create_if_missing', 'resize_up_to', or "
"'always_create'.");
DEFINE_int32(blank_data_image_mb, 0,
"The size of the blank data image to generate, MB.");
DEFINE_string(blank_data_image_fmt, "f2fs",
"The fs format for the blank data image. Used with mkfs.");
DEFINE_string(qemu_gdb, "",
"Debug flag to pass to qemu. e.g. -qemu_gdb=tcp::1234");
DEFINE_int32(x_res, 720, "Width of the screen in pixels");
DEFINE_int32(y_res, 1280, "Height of the screen in pixels");
DEFINE_int32(dpi, 160, "Pixels per inch for the screen");
DEFINE_int32(refresh_rate_hz, 60, "Screen refresh rate in Hertz");
DEFINE_int32(num_screen_buffers, 3, "The number of screen buffers");
DEFINE_string(kernel_path, "",
"Path to the kernel. Overrides the one from the boot image");
DEFINE_string(initramfs_path, "", "Path to the initramfs");
DEFINE_bool(decompress_kernel, false,
"Whether to decompress the kernel image.");
DEFINE_string(kernel_decompresser_executable,
vsoc::DefaultHostArtifactsPath("bin/extract-vmlinux"),
"Path to the extract-vmlinux executable.");
DEFINE_string(extra_kernel_cmdline, "",
"Additional flags to put on the kernel command line");
DEFINE_int32(loop_max_part, 7, "Maximum number of loop partitions");
DEFINE_bool(guest_enforce_security, true,
"Whether to run in enforcing mode (non permissive).");
DEFINE_bool(guest_audit_security, true,
"Whether to log security audits.");
DEFINE_string(boot_image, "",
"Location of cuttlefish boot image. If empty it is assumed to be "
"boot.img in the directory specified by -system_image_dir.");
DEFINE_string(vendor_boot_image, "",
"Location of cuttlefish vendor boot image. If empty it is assumed to "
"be vendor_boot.img in the directory specified by -system_image_dir.");
DEFINE_int32(memory_mb, 2048,
"Total amount of memory available for guest, MB.");
DEFINE_string(mobile_interface, GetPerInstanceDefault("cvd-mbr-"),
"Network interface to use for mobile networking");
DEFINE_string(mobile_tap_name, GetPerInstanceDefault("cvd-mtap-"),
"The name of the tap interface to use for mobile");
DEFINE_string(serial_number, GetPerInstanceDefault("CUTTLEFISHCVD"),
"Serial number to use for the device");
DEFINE_string(instance_dir, "", // default handled on ParseCommandLine
"A directory to put all instance specific files");
DEFINE_string(
vm_manager, vm_manager::CrosvmManager::name(),
"What virtual machine manager to use, one of {qemu_cli, crosvm}");
DEFINE_string(
gpu_mode, vsoc::kGpuModeGuestSwiftshader,
"What gpu configuration to use, one of {guest_swiftshader, drm_virgl}");
DEFINE_string(wayland_socket, "",
"Location of the wayland socket to use for drm_virgl gpu_mode.");
DEFINE_string(x_display, "",
"X display to use for drm_virgl gpu_mode.");
DEFINE_string(system_image_dir, vsoc::DefaultGuestImagePath(""),
"Location of the system partition images.");
DEFINE_string(super_image, "", "Location of the super partition image.");
DEFINE_string(misc_image, "",
"Location of the misc partition image. If the image does not "
"exist, a blank new misc partition image is created.");
DEFINE_string(composite_disk, "", "Location of the composite disk image. "
"If empty, a composite disk is not used.");
DEFINE_bool(deprecated_boot_completed, false, "Log boot completed message to"
" host kernel. This is only used during transition of our clients."
" Will be deprecated soon.");
DEFINE_bool(start_vnc_server, true, "Whether to start the vnc server process.");
DEFINE_string(vnc_server_binary,
vsoc::DefaultHostArtifactsPath("bin/vnc_server"),
"Location of the vnc server binary.");
DEFINE_string(virtual_usb_manager_binary,
vsoc::DefaultHostArtifactsPath("bin/virtual_usb_manager"),
"Location of the virtual usb manager binary.");
DEFINE_string(kernel_log_monitor_binary,
vsoc::DefaultHostArtifactsPath("bin/kernel_log_monitor"),
"Location of the log monitor binary.");
DEFINE_int32(vnc_server_port, GetPerInstanceDefault(6444),
"The port on which the vnc server should listen");
DEFINE_string(socket_forward_proxy_binary,
vsoc::DefaultHostArtifactsPath("bin/socket_forward_proxy"),
"Location of the socket_forward_proxy binary.");
DEFINE_string(socket_vsock_proxy_binary,
vsoc::DefaultHostArtifactsPath("bin/socket_vsock_proxy"),
"Location of the socket_vsock_proxy binary.");
DEFINE_string(adb_mode, "vsock_half_tunnel",
"Mode for ADB connection. Can be 'usb' for USB forwarding, "
"'tunnel' for a TCP connection tunneled through VSoC, "
"'vsock_tunnel' for a TCP connection tunneled through vsock, "
"'native_vsock' for a direct connection to the guest ADB over "
"vsock, 'vsock_half_tunnel' for a TCP connection forwarded to "
"the guest ADB server, or a comma separated list of types as in "
"'usb,tunnel'");
DEFINE_bool(run_adb_connector, true,
"Maintain adb connection by sending 'adb connect' commands to the "
"server. Only relevant with -adb_mode=tunnel or vsock_tunnel");
DEFINE_string(adb_connector_binary,
vsoc::DefaultHostArtifactsPath("bin/adb_connector"),
"Location of the adb_connector binary. Only relevant if "
"-run_adb_connector is true");
DEFINE_int32(vhci_port, GetPerInstanceDefault(0), "VHCI port to use for usb");
DEFINE_string(wifi_tap_name, GetPerInstanceDefault("cvd-wtap-"),
"The name of the tap interface to use for wifi");
DEFINE_int32(vsock_guest_cid,
vsoc::GetDefaultPerInstanceVsockCid(),
"Guest identifier for vsock. Disabled if under 3.");
DEFINE_string(uuid, vsoc::GetPerInstanceDefault(vsoc::kDefaultUuidPrefix),
"UUID to use for the device. Random if not specified");
DEFINE_bool(daemon, false,
"Run cuttlefish in background, the launcher exits on boot "
"completed/failed");
DEFINE_string(device_title, "", "Human readable name for the instance, "
"used by the vnc_server for its server title");
DEFINE_string(setupwizard_mode, "DISABLED",
"One of DISABLED,OPTIONAL,REQUIRED");
DEFINE_string(qemu_binary,
"/usr/bin/qemu-system-x86_64",
"The qemu binary to use");
DEFINE_string(crosvm_binary,
vsoc::DefaultHostArtifactsPath("bin/crosvm"),
"The Crosvm binary to use");
DEFINE_string(console_forwarder_binary,
vsoc::DefaultHostArtifactsPath("bin/console_forwarder"),
"The Console Forwarder binary to use");
DEFINE_bool(restart_subprocesses, true, "Restart any crashed host process");
DEFINE_string(logcat_receiver_binary,
vsoc::DefaultHostArtifactsPath("bin/logcat_receiver"),
"Binary for the logcat server");
DEFINE_string(logcat_mode, "", "How to send android's log messages from "
"guest to host. One of [serial, vsock]");
DEFINE_int32(logcat_vsock_port, vsoc::GetPerInstanceDefault(5620),
"The port for logcat over vsock");
DEFINE_string(config_server_binary,
vsoc::DefaultHostArtifactsPath("bin/config_server"),
"Binary for the configuration server");
DEFINE_int32(config_server_port, vsoc::GetPerInstanceDefault(4680),
"The (vsock) port for the configuration server");
DEFINE_int32(frames_vsock_port, vsoc::GetPerInstanceDefault(5580),
"The vsock port to receive frames from the guest on");
DEFINE_bool(enable_tombstone_receiver, true, "Enables the tombstone logger on "
"both the guest and the host");
DEFINE_string(tombstone_receiver_binary,
vsoc::DefaultHostArtifactsPath("bin/tombstone_receiver"),
"Binary for the tombstone server");
DEFINE_int32(tombstone_receiver_port, vsoc::GetPerInstanceDefault(5630),
"The vsock port for tombstones");
DEFINE_int32(keyboard_server_port, GetPerInstanceDefault(5540),
"The port on which the vsock keyboard server should listen");
DEFINE_int32(touch_server_port, GetPerInstanceDefault(5640),
"The port on which the vsock touch server should listen");
DEFINE_bool(use_bootloader, false, "Boots the device using a bootloader");
DEFINE_string(bootloader, "", "Bootloader binary path");
DEFINE_string(boot_slot, "", "Force booting into the given slot. If empty, "
"the slot will be chosen based on the misc partition if using a "
"bootloader. It will default to 'a' if empty and not using a "
"bootloader.");
namespace {
const std::string kKernelDefaultPath = "kernel";
const std::string kInitramfsImg = "initramfs.img";
const std::string kRamdiskConcatExt = ".concat";
template<typename S, typename T>
static std::string concat(const S& s, const T& t) {
std::ostringstream os;
os << s << t;
return os.str();
}
bool ResolveInstanceFiles() {
if (FLAGS_system_image_dir.empty()) {
LOG(ERROR) << "--system_image_dir must be specified.";
return false;
}
// If user did not specify location of either of these files, expect them to
// be placed in --system_image_dir location.
std::string default_boot_image = FLAGS_system_image_dir + "/boot.img";
SetCommandLineOptionWithMode("boot_image", default_boot_image.c_str(),
google::FlagSettingMode::SET_FLAGS_DEFAULT);
std::string default_cache_image = FLAGS_system_image_dir + "/cache.img";
SetCommandLineOptionWithMode("cache_image", default_cache_image.c_str(),
google::FlagSettingMode::SET_FLAGS_DEFAULT);
std::string default_data_image = FLAGS_system_image_dir + "/userdata.img";
SetCommandLineOptionWithMode("data_image", default_data_image.c_str(),
google::FlagSettingMode::SET_FLAGS_DEFAULT);
std::string default_metadata_image = FLAGS_system_image_dir + "/metadata.img";
SetCommandLineOptionWithMode("metadata_image", default_metadata_image.c_str(),
google::FlagSettingMode::SET_FLAGS_DEFAULT);
std::string default_super_image = FLAGS_system_image_dir + "/super.img";
SetCommandLineOptionWithMode("super_image", default_super_image.c_str(),
google::FlagSettingMode::SET_FLAGS_DEFAULT);
std::string default_misc_image = FLAGS_system_image_dir + "/misc.img";
SetCommandLineOptionWithMode("misc_image", default_misc_image.c_str(),
google::FlagSettingMode::SET_FLAGS_DEFAULT);
std::string default_composite_disk = FLAGS_system_image_dir + "/composite.img";
SetCommandLineOptionWithMode("composite_disk", default_composite_disk.c_str(),
google::FlagSettingMode::SET_FLAGS_DEFAULT);
std::string default_vendor_boot_image = FLAGS_system_image_dir
+ "/vendor_boot.img";
SetCommandLineOptionWithMode("vendor_boot_image",
default_vendor_boot_image.c_str(),
google::FlagSettingMode::SET_FLAGS_DEFAULT);
return true;
}
std::string GetCuttlefishEnvPath() {
return cvd::StringFromEnv("HOME", ".") + "/.cuttlefish.sh";
}
int GetHostPort() {
constexpr int kFirstHostPort = 6520;
return vsoc::GetPerInstanceDefault(kFirstHostPort);
}
// Initializes the config object and saves it to file. It doesn't return it, all
// further uses of the config should happen through the singleton
bool InitializeCuttlefishConfiguration(
const cvd::BootImageUnpacker& boot_image_unpacker,
const cvd::FetcherConfig& fetcher_config) {
vsoc::CuttlefishConfig tmp_config_obj;
// Set this first so that calls to PerInstancePath below are correct
tmp_config_obj.set_instance_dir(FLAGS_instance_dir);
if (!vm_manager::VmManager::IsValidName(FLAGS_vm_manager)) {
LOG(ERROR) << "Invalid vm_manager: " << FLAGS_vm_manager;
return false;
}
if (!vm_manager::VmManager::IsValidName(FLAGS_vm_manager)) {
LOG(ERROR) << "Invalid vm_manager: " << FLAGS_vm_manager;
return false;
}
tmp_config_obj.set_vm_manager(FLAGS_vm_manager);
tmp_config_obj.set_gpu_mode(FLAGS_gpu_mode);
if (!vm_manager::VmManager::ConfigureGpuMode(&tmp_config_obj)) {
LOG(ERROR) << "Invalid gpu_mode=" << FLAGS_gpu_mode <<
" does not work with vm_manager=" << FLAGS_vm_manager;
return false;
}
tmp_config_obj.set_wayland_socket(FLAGS_wayland_socket);
tmp_config_obj.set_x_display(FLAGS_x_display);
vm_manager::VmManager::ConfigureBootDevices(&tmp_config_obj);
tmp_config_obj.set_serial_number(FLAGS_serial_number);
tmp_config_obj.set_cpus(FLAGS_cpus);
tmp_config_obj.set_memory_mb(FLAGS_memory_mb);
tmp_config_obj.set_dpi(FLAGS_dpi);
tmp_config_obj.set_setupwizard_mode(FLAGS_setupwizard_mode);
tmp_config_obj.set_x_res(FLAGS_x_res);
tmp_config_obj.set_y_res(FLAGS_y_res);
tmp_config_obj.set_num_screen_buffers(FLAGS_num_screen_buffers);
tmp_config_obj.set_refresh_rate_hz(FLAGS_refresh_rate_hz);
tmp_config_obj.set_gdb_flag(FLAGS_qemu_gdb);
std::vector<std::string> adb = android::base::Split(FLAGS_adb_mode, ",");
tmp_config_obj.set_adb_mode(std::set<std::string>(adb.begin(), adb.end()));
tmp_config_obj.set_host_port(GetHostPort());
tmp_config_obj.set_adb_ip_and_port("127.0.0.1:" + std::to_string(GetHostPort()));
tmp_config_obj.set_device_title(FLAGS_device_title);
std::string discovered_kernel = fetcher_config.FindCvdFileWithSuffix(kKernelDefaultPath);
std::string foreign_kernel = FLAGS_kernel_path.size() ? FLAGS_kernel_path : discovered_kernel;
if (foreign_kernel.size()) {
tmp_config_obj.set_kernel_image_path(foreign_kernel);
tmp_config_obj.set_use_unpacked_kernel(false);
} else {
tmp_config_obj.set_kernel_image_path(
tmp_config_obj.PerInstancePath(kKernelDefaultPath.c_str()));
tmp_config_obj.set_use_unpacked_kernel(true);
}
tmp_config_obj.set_decompress_kernel(FLAGS_decompress_kernel);
if (FLAGS_decompress_kernel) {
tmp_config_obj.set_decompressed_kernel_image_path(
tmp_config_obj.PerInstancePath("vmlinux"));
}
auto ramdisk_path = tmp_config_obj.PerInstancePath("ramdisk.img");
auto vendor_ramdisk_path = tmp_config_obj.PerInstancePath("vendor_ramdisk.img");
if (!boot_image_unpacker.HasRamdiskImage()) {
LOG(INFO) << "A ramdisk is required, but the boot image did not have one.";
return false;
}
tmp_config_obj.add_kernel_cmdline(boot_image_unpacker.kernel_cmdline());
tmp_config_obj.add_kernel_cmdline(
concat("androidboot.serialno=", FLAGS_serial_number));
tmp_config_obj.add_kernel_cmdline(concat("androidboot.lcd_density=", FLAGS_dpi));
tmp_config_obj.add_kernel_cmdline(
concat("androidboot.setupwizard_mode=", FLAGS_setupwizard_mode));
tmp_config_obj.add_kernel_cmdline(concat("loop.max_part=", FLAGS_loop_max_part));
if (FLAGS_logcat_mode == cvd::kLogcatVsockMode) {
tmp_config_obj.add_kernel_cmdline(concat("androidboot.vsock_logcat_port=",
FLAGS_logcat_vsock_port));
}
tmp_config_obj.add_kernel_cmdline(concat("androidboot.cuttlefish_config_server_port=",
FLAGS_config_server_port));
if (FLAGS_guest_enforce_security) {
tmp_config_obj.add_kernel_cmdline("enforcing=1");
} else {
tmp_config_obj.add_kernel_cmdline("enforcing=0");
tmp_config_obj.add_kernel_cmdline("androidboot.selinux=permissive");
}
if (FLAGS_guest_audit_security) {
tmp_config_obj.add_kernel_cmdline("audit=1");
} else {
tmp_config_obj.add_kernel_cmdline("audit=0");
}
if (FLAGS_extra_kernel_cmdline.size()) {
tmp_config_obj.add_kernel_cmdline(FLAGS_extra_kernel_cmdline);
}
tmp_config_obj.set_virtual_disk_paths({FLAGS_composite_disk});
tmp_config_obj.set_ramdisk_image_path(ramdisk_path);
tmp_config_obj.set_vendor_ramdisk_image_path(vendor_ramdisk_path);
std::string discovered_ramdisk = fetcher_config.FindCvdFileWithSuffix(kInitramfsImg);
std::string foreign_ramdisk = FLAGS_initramfs_path.size () ? FLAGS_initramfs_path : discovered_ramdisk;
if (foreign_kernel.size() && !foreign_ramdisk.size()) {
// If there's a kernel that's passed in without an initramfs, that implies
// user error or a kernel built with no modules. In either case, let's
// choose to avoid loading the modules from the vendor ramdisk which are
// built for the default cf kernel. Once boot occurs, user error will
// become obvious.
tmp_config_obj.set_final_ramdisk_path(ramdisk_path);
} else {
tmp_config_obj.set_final_ramdisk_path(ramdisk_path + kRamdiskConcatExt);
if(foreign_ramdisk.size()) {
tmp_config_obj.set_initramfs_path(foreign_ramdisk);
}
}
if (tmp_config_obj.adb_mode().count(vsoc::AdbMode::Usb) > 0) {
tmp_config_obj.set_usb_v1_socket_name(
tmp_config_obj.PerInstanceInternalPath("usb-v1"));
tmp_config_obj.set_vhci_port(FLAGS_vhci_port);
tmp_config_obj.set_usb_ip_socket_name(
tmp_config_obj.PerInstanceInternalPath("usb-ip"));
}
tmp_config_obj.set_kernel_log_pipe_name(
tmp_config_obj.PerInstanceInternalPath("kernel-log-pipe"));
tmp_config_obj.set_console_pipe_name(
tmp_config_obj.PerInstanceInternalPath("console-pipe"));
tmp_config_obj.set_deprecated_boot_completed(FLAGS_deprecated_boot_completed);
tmp_config_obj.set_console_path(tmp_config_obj.PerInstancePath("console"));
tmp_config_obj.set_logcat_path(tmp_config_obj.PerInstancePath("logcat"));
tmp_config_obj.set_logcat_receiver_binary(FLAGS_logcat_receiver_binary);
tmp_config_obj.set_config_server_binary(FLAGS_config_server_binary);
tmp_config_obj.set_launcher_log_path(
tmp_config_obj.PerInstancePath("launcher.log"));
tmp_config_obj.set_launcher_monitor_socket_path(
tmp_config_obj.PerInstancePath("launcher_monitor.sock"));
tmp_config_obj.set_mobile_bridge_name(FLAGS_mobile_interface);
tmp_config_obj.set_mobile_tap_name(FLAGS_mobile_tap_name);
tmp_config_obj.set_wifi_tap_name(FLAGS_wifi_tap_name);
tmp_config_obj.set_vsock_guest_cid(FLAGS_vsock_guest_cid);
tmp_config_obj.set_uuid(FLAGS_uuid);
tmp_config_obj.set_qemu_binary(FLAGS_qemu_binary);
tmp_config_obj.set_crosvm_binary(FLAGS_crosvm_binary);
tmp_config_obj.set_console_forwarder_binary(FLAGS_console_forwarder_binary);
tmp_config_obj.set_kernel_log_monitor_binary(FLAGS_kernel_log_monitor_binary);
tmp_config_obj.set_enable_vnc_server(FLAGS_start_vnc_server);
tmp_config_obj.set_vnc_server_binary(FLAGS_vnc_server_binary);
tmp_config_obj.set_vnc_server_port(FLAGS_vnc_server_port);
tmp_config_obj.set_restart_subprocesses(FLAGS_restart_subprocesses);
tmp_config_obj.set_run_adb_connector(FLAGS_run_adb_connector);
tmp_config_obj.set_adb_connector_binary(FLAGS_adb_connector_binary);
tmp_config_obj.set_virtual_usb_manager_binary(
FLAGS_virtual_usb_manager_binary);
tmp_config_obj.set_socket_forward_proxy_binary(
FLAGS_socket_forward_proxy_binary);
tmp_config_obj.set_socket_vsock_proxy_binary(FLAGS_socket_vsock_proxy_binary);
tmp_config_obj.set_run_as_daemon(FLAGS_daemon);
tmp_config_obj.set_data_policy(FLAGS_data_policy);
tmp_config_obj.set_blank_data_image_mb(FLAGS_blank_data_image_mb);
tmp_config_obj.set_blank_data_image_fmt(FLAGS_blank_data_image_fmt);
if(tmp_config_obj.adb_mode().count(vsoc::AdbMode::Usb) == 0) {
tmp_config_obj.disable_usb_adb();
}
tmp_config_obj.set_logcat_mode(FLAGS_logcat_mode);
tmp_config_obj.set_logcat_vsock_port(FLAGS_logcat_vsock_port);
tmp_config_obj.set_config_server_port(FLAGS_config_server_port);
tmp_config_obj.set_frames_vsock_port(FLAGS_frames_vsock_port);
if (tmp_config_obj.enable_vnc_server()) {
tmp_config_obj.add_kernel_cmdline(concat("androidboot.vsock_frames_port=",
FLAGS_frames_vsock_port));
}
tmp_config_obj.set_enable_tombstone_receiver(FLAGS_enable_tombstone_receiver);
tmp_config_obj.set_tombstone_receiver_port(FLAGS_tombstone_receiver_port);
tmp_config_obj.set_tombstone_receiver_binary(FLAGS_tombstone_receiver_binary);
if (FLAGS_enable_tombstone_receiver) {
tmp_config_obj.add_kernel_cmdline("androidboot.tombstone_transmit=1");
tmp_config_obj.add_kernel_cmdline(concat("androidboot.vsock_tombstone_port="
,FLAGS_tombstone_receiver_port));
// TODO (b/128842613) populate a cid flag to read the host CID during
// runtime
} else {
tmp_config_obj.add_kernel_cmdline("androidboot.tombstone_transmit=0");
}
tmp_config_obj.set_touch_socket_port(FLAGS_touch_server_port);
tmp_config_obj.set_keyboard_socket_port(FLAGS_keyboard_server_port);
if (FLAGS_vm_manager == vm_manager::QemuManager::name()) {
tmp_config_obj.add_kernel_cmdline(concat("androidboot.vsock_touch_port=",
FLAGS_touch_server_port));
tmp_config_obj.add_kernel_cmdline(concat("androidboot.vsock_keyboard_port=",
FLAGS_keyboard_server_port));
}
tmp_config_obj.set_use_bootloader(FLAGS_use_bootloader);
tmp_config_obj.set_bootloader(FLAGS_bootloader);
if (!FLAGS_boot_slot.empty()) {
tmp_config_obj.set_boot_slot(FLAGS_boot_slot);
}
if (!FLAGS_use_bootloader) {
std::string slot_suffix;
if (FLAGS_boot_slot.empty()) {
slot_suffix = "_a";
} else {
slot_suffix = "_" + FLAGS_boot_slot;
}
tmp_config_obj.add_kernel_cmdline("androidboot.slot_suffix=" + slot_suffix);
}
tmp_config_obj.set_cuttlefish_env_path(GetCuttlefishEnvPath());
auto config_file = GetConfigFilePath(tmp_config_obj);
auto config_link = vsoc::GetGlobalConfigFileLink();
// Save the config object before starting any host process
if (!tmp_config_obj.SaveToFile(config_file)) {
LOG(ERROR) << "Unable to save config object";
return false;
}
setenv(vsoc::kCuttlefishConfigEnvVarName, config_file.c_str(), true);
if (symlink(config_file.c_str(), config_link.c_str()) != 0) {
LOG(ERROR) << "Failed to create symlink to config file at " << config_link
<< ": " << strerror(errno);
return false;
}
return true;
}
void SetDefaultFlagsForQemu() {
auto default_instance_dir =
cvd::StringFromEnv("HOME", ".") + "/cuttlefish_runtime";
SetCommandLineOptionWithMode("instance_dir",
default_instance_dir.c_str(),
google::FlagSettingMode::SET_FLAGS_DEFAULT);
// TODO(b/144119457) Use the serial port.
SetCommandLineOptionWithMode("logcat_mode", cvd::kLogcatVsockMode,
google::FlagSettingMode::SET_FLAGS_DEFAULT);
}
void SetDefaultFlagsForCrosvm() {
auto default_instance_dir =
cvd::StringFromEnv("HOME", ".") + "/cuttlefish_runtime";
SetCommandLineOptionWithMode("instance_dir",
default_instance_dir.c_str(),
google::FlagSettingMode::SET_FLAGS_DEFAULT);
SetCommandLineOptionWithMode("wayland_socket",
"",
google::FlagSettingMode::SET_FLAGS_DEFAULT);
SetCommandLineOptionWithMode("x_display",
getenv("DISPLAY"),
google::FlagSettingMode::SET_FLAGS_DEFAULT);
SetCommandLineOptionWithMode("logcat_mode", cvd::kLogcatVsockMode,
google::FlagSettingMode::SET_FLAGS_DEFAULT);
}
bool ParseCommandLineFlags(int* argc, char*** argv) {
google::ParseCommandLineNonHelpFlags(argc, argv, true);
bool invalid_manager = false;
if (FLAGS_vm_manager == vm_manager::QemuManager::name()) {
SetDefaultFlagsForQemu();
} else if (FLAGS_vm_manager == vm_manager::CrosvmManager::name()) {
SetDefaultFlagsForCrosvm();
} else {
std::cerr << "Unknown Virtual Machine Manager: " << FLAGS_vm_manager
<< std::endl;
invalid_manager = true;
}
google::HandleCommandLineHelpFlags();
if (invalid_manager) {
return false;
}
// Set the env variable to empty (in case the caller passed a value for it).
unsetenv(vsoc::kCuttlefishConfigEnvVarName);
return ResolveInstanceFiles();
}
bool CleanPriorFiles() {
// Everything on the instance directory
std::string prior_files = FLAGS_instance_dir + "/*";
// The environment file
prior_files += " " + GetCuttlefishEnvPath();
// The global link to the config file
prior_files += " " + vsoc::GetGlobalConfigFileLink();
LOG(INFO) << "Assuming prior files of " << prior_files;
std::string fuser_cmd = "fuser " + prior_files + " 2> /dev/null";
int rval = std::system(fuser_cmd.c_str());
// fuser returns 0 if any of the files are open
if (WEXITSTATUS(rval) == 0) {
LOG(ERROR) << "Clean aborted: files are in use";
return false;
}
std::string clean_command = "rm -rf " + prior_files;
rval = std::system(clean_command.c_str());
if (WEXITSTATUS(rval) != 0) {
LOG(ERROR) << "Remove of files failed";
return false;
}
return true;
}
bool DecompressKernel(const std::string& src, const std::string& dst) {
cvd::Command decomp_cmd(FLAGS_kernel_decompresser_executable);
decomp_cmd.AddParameter(src);
auto output_file = cvd::SharedFD::Creat(dst.c_str(), 0666);
if (!output_file->IsOpen()) {
LOG(ERROR) << "Unable to create decompressed image file: "
<< output_file->StrError();
return false;
}
decomp_cmd.RedirectStdIO(cvd::Subprocess::StdIOChannel::kStdOut, output_file);
auto decomp_proc = decomp_cmd.Start(false);
return decomp_proc.Started() && decomp_proc.Wait() == 0;
}
void ValidateAdbModeFlag(const vsoc::CuttlefishConfig& config) {
auto adb_modes = config.adb_mode();
adb_modes.erase(vsoc::AdbMode::Unknown);
if (adb_modes.size() < 1) {
LOG(INFO) << "ADB not enabled";
}
}
} // namespace
namespace {
std::vector<ImagePartition> disk_config() {
std::vector<ImagePartition> partitions;
partitions.push_back(ImagePartition {
.label = "super",
.image_file_path = FLAGS_super_image,
});
partitions.push_back(ImagePartition {
.label = "userdata",
.image_file_path = FLAGS_data_image,
});
partitions.push_back(ImagePartition {
.label = "cache",
.image_file_path = FLAGS_cache_image,
});
partitions.push_back(ImagePartition {
.label = "metadata",
.image_file_path = FLAGS_metadata_image,
});
partitions.push_back(ImagePartition {
.label = "boot",
.image_file_path = FLAGS_boot_image,
});
partitions.push_back(ImagePartition {
.label = "misc",
.image_file_path = FLAGS_misc_image
});
return partitions;
}
bool ShouldCreateCompositeDisk() {
if (FLAGS_vm_manager == vm_manager::CrosvmManager::name()) {
// The crosvm implementation is very fast to rebuild but also more brittle due to being split
// into multiple files. The QEMU implementation is slow to build, but completely self-contained
// at that point. Therefore, always rebuild on crosvm but check if it is necessary for QEMU.
return true;
}
auto composite_age = cvd::FileModificationTime(FLAGS_composite_disk);
for (auto& partition : disk_config()) {
auto partition_age = cvd::FileModificationTime(partition.image_file_path);
if (partition_age >= composite_age) {
LOG(INFO) << "composite disk age was \"" << std::chrono::system_clock::to_time_t(composite_age) << "\", "
<< "partition age was \"" << std::chrono::system_clock::to_time_t(partition_age) << "\"";
return true;
}
}
return false;
}
bool ConcatRamdisks(const std::string& new_ramdisk_path, const std::string& ramdisk_a_path,
const std::string& ramdisk_b_path) {
// clear out file of any pre-existing content
std::ofstream new_ramdisk(new_ramdisk_path, std::ios_base::binary | std::ios_base::trunc);
std::ifstream ramdisk_a(ramdisk_a_path, std::ios_base::binary);
std::ifstream ramdisk_b(ramdisk_b_path, std::ios_base::binary);
if(!new_ramdisk.is_open() || !ramdisk_a.is_open() || !ramdisk_b.is_open()) {
return false;
}
new_ramdisk << ramdisk_a.rdbuf() << ramdisk_b.rdbuf();
return true;
}
void CreateCompositeDisk(const vsoc::CuttlefishConfig& config) {
if (FLAGS_composite_disk.empty()) {
LOG(FATAL) << "asked to create composite disk, but path was empty";
}
if (FLAGS_vm_manager == vm_manager::CrosvmManager::name()) {
std::string header_path = config.PerInstancePath("gpt_header.img");
std::string footer_path = config.PerInstancePath("gpt_footer.img");
create_composite_disk(disk_config(), header_path, footer_path, FLAGS_composite_disk);
} else {
aggregate_image(disk_config(), FLAGS_composite_disk);
}
}
} // namespace
const vsoc::CuttlefishConfig* InitFilesystemAndCreateConfig(
int* argc, char*** argv, cvd::FetcherConfig fetcher_config) {
if (!ParseCommandLineFlags(argc, argv)) {
LOG(ERROR) << "Failed to parse command arguments";
exit(AssemblerExitCodes::kArgumentParsingError);
}
// Clean up prior files before saving the config file (doing it after would
// delete it)
if (!CleanPriorFiles()) {
LOG(ERROR) << "Failed to clean prior files";
exit(AssemblerExitCodes::kPrioFilesCleanupError);
}
// Create instance directory if it doesn't exist.
if (!cvd::DirectoryExists(FLAGS_instance_dir.c_str())) {
LOG(INFO) << "Setting up " << FLAGS_instance_dir;
if (mkdir(FLAGS_instance_dir.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH) < 0) {
LOG(ERROR) << "Failed to create instance directory: "
<< FLAGS_instance_dir << ". Error: " << errno;
exit(AssemblerExitCodes::kInstanceDirCreationError);
}
}
auto internal_dir = FLAGS_instance_dir + "/" + vsoc::kInternalDirName;
if (!cvd::DirectoryExists(internal_dir)) {
if (mkdir(internal_dir.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH) <
0) {
LOG(ERROR) << "Failed to create internal instance directory: "
<< internal_dir << ". Error: " << errno;
exit(AssemblerExitCodes::kInstanceDirCreationError);
}
}
if (!cvd::FileHasContent(FLAGS_boot_image)) {
LOG(ERROR) << "File not found: " << FLAGS_boot_image;
exit(cvd::kCuttlefishConfigurationInitError);
}
if (!cvd::FileHasContent(FLAGS_vendor_boot_image)) {
LOG(ERROR) << "File not found: " << FLAGS_vendor_boot_image;
exit(cvd::kCuttlefishConfigurationInitError);
}
auto boot_img_unpacker =
cvd::BootImageUnpacker::FromImages(FLAGS_boot_image,
FLAGS_vendor_boot_image);
if (!InitializeCuttlefishConfiguration(*boot_img_unpacker, fetcher_config)) {
LOG(ERROR) << "Failed to initialize configuration";
exit(AssemblerExitCodes::kCuttlefishConfigurationInitError);
}
// Do this early so that the config object is ready for anything that needs it
auto config = vsoc::CuttlefishConfig::Get();
if (!config) {
LOG(ERROR) << "Failed to obtain config singleton";
exit(AssemblerExitCodes::kCuttlefishConfigurationInitError);
}
if (!boot_img_unpacker->Unpack(config->ramdisk_image_path(),
config->vendor_ramdisk_image_path(),
config->use_unpacked_kernel()
? config->kernel_image_path()
: "")) {
LOG(ERROR) << "Failed to unpack boot image";
exit(AssemblerExitCodes::kBootImageUnpackError);
}
// TODO(134522463) as part of the bootloader refactor, repack the vendor boot
// image and use the bootloader to load both the boot and vendor ramdisk.
// Until then, this hack to get gki modules into cuttlefish will suffice.
// If a vendor ramdisk comes in via this mechanism, let it supercede the one
// in the vendor boot image. This flag is what kernel presubmit testing uses
// to pass in the kernel ramdisk.
// If no kernel is passed in or an initramfs is made available, the default
// vendor boot ramdisk or the initramfs provided should be appended to the
// boot ramdisk. If a kernel IS provided with no initramfs, it is safe to
// safe to assume that the kernel was built with no modules and expects no
// modules for cf to run properly.
std::string discovered_kernel = fetcher_config.FindCvdFileWithSuffix(kKernelDefaultPath);
std::string foreign_kernel = FLAGS_kernel_path.size() ? FLAGS_kernel_path : discovered_kernel;
std::string discovered_ramdisk = fetcher_config.FindCvdFileWithSuffix(kInitramfsImg);
std::string foreign_ramdisk = FLAGS_initramfs_path.size () ? FLAGS_initramfs_path : discovered_ramdisk;
if(!foreign_kernel.size() || foreign_ramdisk.size()) {
const std::string& vendor_ramdisk_path =
config->initramfs_path().size() ? config->initramfs_path()
: config->vendor_ramdisk_image_path();
if(!ConcatRamdisks(config->final_ramdisk_path(),
config->ramdisk_image_path(), vendor_ramdisk_path)) {
LOG(ERROR) << "Failed to concatenate ramdisk and vendor ramdisk";
exit(AssemblerExitCodes::kInitRamFsConcatError);
}
}
if (config->decompress_kernel()) {
if (!DecompressKernel(config->kernel_image_path(),
config->decompressed_kernel_image_path())) {
LOG(ERROR) << "Failed to decompress kernel";
exit(AssemblerExitCodes::kKernelDecompressError);
}
}
ValidateAdbModeFlag(*config);
// Create misc if necessary
if (!InitializeMiscImage(FLAGS_misc_image)) {
exit(cvd::kCuttlefishConfigurationInitError);
}
// Create data if necessary
if (!ApplyDataImagePolicy(*config, FLAGS_data_image)) {
exit(cvd::kCuttlefishConfigurationInitError);
}
if (!cvd::FileExists(FLAGS_metadata_image)) {
CreateBlankImage(FLAGS_metadata_image, FLAGS_blank_metadata_image_mb, "none");
}
if (SuperImageNeedsRebuilding(fetcher_config, *config)) {
if (!RebuildSuperImage(fetcher_config, *config, FLAGS_super_image)) {
LOG(ERROR) << "Super image rebuilding requested but could not be completed.";
exit(cvd::kCuttlefishConfigurationInitError);
}
}
if (ShouldCreateCompositeDisk()) {
CreateCompositeDisk(*config);
}
// Check that the files exist
for (const auto& file : config->virtual_disk_paths()) {
if (!file.empty() && !cvd::FileHasContent(file.c_str())) {
LOG(ERROR) << "File not found: " << file;
exit(cvd::kCuttlefishConfigurationInitError);
}
}
return config;
}
std::string GetConfigFilePath(const vsoc::CuttlefishConfig& config) {
return config.PerInstancePath("cuttlefish_config.json");
}