1 /* 2 * Copyright (C) 2018 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 #pragma once 17 18 #include <sys/types.h> 19 #include <array> 20 #include <cstdint> 21 #include <map> 22 #include <memory> 23 #include <optional> 24 #include <set> 25 #include <string> 26 #include <string_view> 27 #include <vector> 28 29 #include <fmt/ostream.h> 30 31 #include "common/libs/utils/environment.h" 32 #include "common/libs/utils/result.h" 33 #include "host/libs/config/config_constants.h" 34 #include "host/libs/config/config_fragment.h" 35 #include "host/libs/config/config_utils.h" 36 #include "host/libs/config/secure_hals.h" 37 38 namespace Json { 39 class Value; 40 } 41 42 namespace cuttlefish { 43 44 enum class VmmMode { 45 kUnknown, 46 kCrosvm, 47 kGem5, 48 kQemu, 49 }; 50 51 std::ostream& operator<<(std::ostream&, VmmMode); 52 std::string ToString(VmmMode mode); 53 Result<VmmMode> ParseVmm(std::string_view); 54 55 enum class ExternalNetworkMode { 56 kUnknown, 57 kTap, 58 kSlirp, 59 }; 60 61 std::ostream& operator<<(std::ostream&, ExternalNetworkMode); 62 Result<ExternalNetworkMode> ParseExternalNetworkMode(std::string_view); 63 64 // Holds the configuration of the cuttlefish instances. 65 class CuttlefishConfig { 66 public: 67 static const CuttlefishConfig* Get(); 68 static std::unique_ptr<const CuttlefishConfig> GetFromFile( 69 const std::string& path); 70 static bool ConfigExists(); 71 72 CuttlefishConfig(); 73 CuttlefishConfig(CuttlefishConfig&&); 74 ~CuttlefishConfig(); 75 CuttlefishConfig& operator=(CuttlefishConfig&&); 76 77 // Saves the configuration object in a file, it can then be read in other 78 // processes by passing the --config_file option. 79 bool SaveToFile(const std::string& file) const; 80 bool LoadFromFile(const char* file); 81 82 bool SaveFragment(const ConfigFragment&); 83 bool LoadFragment(ConfigFragment&) const; 84 85 std::string root_dir() const; 86 void set_root_dir(const std::string& root_dir); 87 88 std::string instances_dir() const; 89 std::string InstancesPath(const std::string&) const; 90 91 std::string assembly_dir() const; 92 std::string AssemblyPath(const std::string&) const; 93 94 void set_instances_uds_dir(const std::string&); 95 std::string instances_uds_dir() const; 96 std::string InstancesUdsPath(const std::string&) const; 97 98 void set_environments_dir(const std::string&); 99 std::string environments_dir() const; 100 std::string EnvironmentsPath(const std::string&) const; 101 102 void set_environments_uds_dir(const std::string&); 103 std::string environments_uds_dir() const; 104 std::string EnvironmentsUdsPath(const std::string&) const; 105 106 VmmMode vm_manager() const; 107 void set_vm_manager(VmmMode vmm); 108 109 std::string ap_vm_manager() const; 110 void set_ap_vm_manager(const std::string& name); 111 112 struct DisplayConfig { 113 int width; 114 int height; 115 int dpi; 116 int refresh_rate_hz; 117 }; 118 119 struct TouchpadConfig { 120 int width; 121 int height; 122 123 static Json::Value Serialize( 124 const CuttlefishConfig::TouchpadConfig& config); 125 static TouchpadConfig Deserialize(const Json::Value& config_json); 126 }; 127 128 void set_secure_hals(const std::set<SecureHal>&); 129 Result<std::set<SecureHal>> secure_hals() const; 130 131 void set_crosvm_binary(const std::string& crosvm_binary); 132 std::string crosvm_binary() const; 133 134 void set_gem5_debug_flags(const std::string& gem5_debug_flags); 135 std::string gem5_debug_flags() const; 136 137 void set_enable_host_uwb(bool enable_host_uwb); 138 bool enable_host_uwb() const; 139 140 void set_enable_host_uwb_connector(bool enable_host_uwb); 141 bool enable_host_uwb_connector() const; 142 143 void set_enable_host_bluetooth(bool enable_host_bluetooth); 144 bool enable_host_bluetooth() const; 145 146 void set_enable_automotive_proxy(bool enable_automotive_proxy); 147 bool enable_automotive_proxy() const; 148 149 // The vsock port used by vhal_proxy_server 150 void set_vhal_proxy_server_port(int port); 151 int vhal_proxy_server_port() const; 152 153 // Bluetooth is enabled by bt_connector and rootcanal 154 void set_enable_host_bluetooth_connector(bool enable_host_bluetooth); 155 bool enable_host_bluetooth_connector() const; 156 157 void set_enable_host_nfc(bool enable_host_nfc); 158 bool enable_host_nfc() const; 159 160 void set_enable_host_nfc_connector(bool enable_host_nfc_connector); 161 bool enable_host_nfc_connector() const; 162 163 void set_casimir_args(const std::string& casimir_args); 164 std::vector<std::string> casimir_args() const; 165 void set_casimir_instance_num(int casimir_instance_num); 166 int casimir_instance_num() const; 167 void set_casimir_nci_port(int port); 168 int casimir_nci_port() const; 169 void set_casimir_rf_port(int port); 170 int casimir_rf_port() const; 171 172 // Flags for the set of radios that are connected to netsim 173 enum NetsimRadio { 174 Bluetooth = 0b00000001, 175 Wifi = 0b00000010, 176 Uwb = 0b00000100, 177 }; 178 179 void netsim_radio_enable(NetsimRadio flag); 180 bool netsim_radio_enabled(NetsimRadio flag) const; 181 void set_netsim_instance_num(int netsim_instance_num); 182 int netsim_instance_num() const; 183 // Netsim has a built-in connector to forward packets to another daemon based 184 // on instance number. This is set in the serial launch case when FLAGS 185 // rootcanal_instance_num is specified. The non-netsim case uses 186 // bluetooth_connector and rootcanal_hci_port for the same purpose. Purposely 187 // restricted to legacy bluetooth serial invocation because new cases should 188 // use cvd. 189 int netsim_connector_instance_num() const; 190 void set_netsim_connector_instance_num(int netsim_instance_num); 191 void set_netsim_args(const std::string& netsim_args); 192 std::vector<std::string> netsim_args() const; 193 194 enum class Answer { 195 kUnknown = 0, 196 kYes, 197 kNo, 198 }; 199 200 void set_enable_metrics(std::string enable_metrics); 201 CuttlefishConfig::Answer enable_metrics() const; 202 203 void set_metrics_binary(const std::string& metrics_binary); 204 std::string metrics_binary() const; 205 206 void set_extra_kernel_cmdline(const std::string& extra_cmdline); 207 std::vector<std::string> extra_kernel_cmdline() const; 208 209 // A directory containing the SSL certificates for the signaling server 210 void set_webrtc_certs_dir(const std::string& certs_dir); 211 std::string webrtc_certs_dir() const; 212 213 // The port for the webrtc signaling server. It's used by the signaling server 214 // to bind to it and by the webrtc process to connect to and register itself 215 void set_sig_server_port(int port); 216 int sig_server_port() const; 217 218 // The address of the signaling server 219 void set_sig_server_address(const std::string& addr); 220 std::string sig_server_address() const; 221 222 // The path section of the url where the webrtc process registers itself with 223 // the signaling server 224 void set_sig_server_path(const std::string& path); 225 std::string sig_server_path() const; 226 227 // Whether the webrtc process should use a secure connection (WSS) to the 228 // signaling server. 229 void set_sig_server_secure(bool secure); 230 bool sig_server_secure() const; 231 232 // Whether the webrtc process should attempt to verify the authenticity of the 233 // signaling server (reject self signed certificates) 234 void set_sig_server_strict(bool strict); 235 bool sig_server_strict() const; 236 237 void set_host_tools_version(const std::map<std::string, uint32_t>&); 238 std::map<std::string, uint32_t> host_tools_version() const; 239 240 void set_virtio_mac80211_hwsim(bool virtio_mac80211_hwsim); 241 bool virtio_mac80211_hwsim() const; 242 243 void set_ap_rootfs_image(const std::string& path); 244 std::string ap_rootfs_image() const; 245 246 void set_ap_kernel_image(const std::string& path); 247 std::string ap_kernel_image() const; 248 249 void set_pica_uci_port(int pica_uci_port); 250 int pica_uci_port() const; 251 252 void set_rootcanal_args(const std::string& rootcanal_args); 253 std::vector<std::string> rootcanal_args() const; 254 255 void set_rootcanal_hci_port(int rootcanal_hci_port); 256 int rootcanal_hci_port() const; 257 258 void set_rootcanal_link_port(int rootcanal_link_port); 259 int rootcanal_link_port() const; 260 261 void set_rootcanal_link_ble_port(int rootcanal_link_ble_port); 262 int rootcanal_link_ble_port() const; 263 264 void set_rootcanal_test_port(int rootcanal_test_port); 265 int rootcanal_test_port() const; 266 267 // The path of an AP image in composite disk 268 std::string ap_image_dev_path() const; 269 void set_ap_image_dev_path(const std::string& dev_path); 270 271 // path to the saved snapshot file(s) 272 std::string snapshot_path() const; 273 void set_snapshot_path(const std::string& snapshot_path); 274 275 std::set<std::string> straced_host_executables() const; 276 void set_straced_host_executables(const std::set<std::string>& executables); 277 278 bool IsCrosvm() const; 279 280 class InstanceSpecific; 281 class MutableInstanceSpecific; 282 283 MutableInstanceSpecific ForInstance(int instance_num); 284 InstanceSpecific ForInstance(int instance_num) const; 285 InstanceSpecific ForInstanceName(const std::string& name) const; 286 InstanceSpecific ForDefaultInstance() const; 287 288 std::vector<InstanceSpecific> Instances() const; 289 std::vector<std::string> instance_dirs() const; 290 291 void set_instance_names(const std::vector<std::string>& instance_names); 292 std::vector<std::string> instance_names() const; 293 294 // A view into an existing CuttlefishConfig object for a particular instance. 295 class InstanceSpecific { 296 const CuttlefishConfig* config_; 297 std::string id_; 298 friend InstanceSpecific CuttlefishConfig::ForInstance(int num) const; 299 friend std::vector<InstanceSpecific> CuttlefishConfig::Instances() const; 300 InstanceSpecific(const CuttlefishConfig * config,const std::string & id)301 InstanceSpecific(const CuttlefishConfig* config, const std::string& id) 302 : config_(config), id_(id) {} 303 304 Json::Value* Dictionary(); 305 const Json::Value* Dictionary() const; 306 public: 307 std::string serial_number() const; 308 // If any of the following port numbers is 0, the relevant service is not 309 // running on the guest. 310 311 // Port number for qemu to run a vnc server on the host 312 int qemu_vnc_server_port() const; 313 // Port number to connect to the tombstone receiver on the host 314 int tombstone_receiver_port() const; 315 // Port number to connect to the config server on the host 316 int config_server_port() const; 317 // Port number to connect to the audiocontrol server on the guest 318 int audiocontrol_server_port() const; 319 // Port number to connect to the adb server on the host 320 int adb_host_port() const; 321 // Port number to connect to the fastboot server on the host 322 int fastboot_host_port() const; 323 // Device-specific ID to distinguish modem simulators. Must be 4 digits. 324 int modem_simulator_host_id() const; 325 // Port number to connect to the gnss grpc proxy server on the host 326 int gnss_grpc_proxy_server_port() const; 327 std::string adb_ip_and_port() const; 328 // Port number to connect to the camera hal on the guest 329 int camera_server_port() const; 330 // Port number to connect to the lights hal on the guest 331 int lights_server_port() const; 332 333 std::string adb_device_name() const; 334 std::string gnss_file_path() const; 335 std::string fixed_location_file_path() const; 336 std::string mobile_bridge_name() const; 337 std::string mobile_tap_name() const; 338 std::string mobile_mac() const; 339 std::string wifi_bridge_name() const; 340 std::string wifi_tap_name() const; 341 std::string wifi_mac() const; 342 bool use_bridged_wifi_tap() const; 343 std::string ethernet_tap_name() const; 344 std::string ethernet_bridge_name() const; 345 std::string ethernet_mac() const; 346 std::string ethernet_ipv6() const; 347 uint32_t session_id() const; 348 bool use_allocd() const; 349 int vsock_guest_cid() const; 350 std::string vsock_guest_group() const; 351 std::string uuid() const; 352 std::string instance_name() const; 353 std::string environment_name() const; 354 std::vector<std::string> virtual_disk_paths() const; 355 356 // Returns the path to a file with the given name in the instance 357 // directory.. 358 std::string PerInstancePath(const std::string& file_name) const; 359 std::string PerInstanceInternalPath(const std::string& file_name) const; 360 std::string PerInstanceLogPath(const std::string& file_name) const; 361 362 std::string CrosvmSocketPath() const; 363 std::string OpenwrtCrosvmSocketPath() const; 364 std::string instance_dir() const; 365 366 std::string instance_internal_dir() const; 367 368 // Return the Unix domain socket path with given name. Because the 369 // length limitation of Unix domain socket name, it needs to be in 370 // the another directory than normal Instance path. 371 std::string PerInstanceUdsPath(const std::string& file_name) const; 372 std::string PerInstanceInternalUdsPath(const std::string& file_name) const; 373 std::string PerInstanceGrpcSocketPath(const std::string& socket_name) const; 374 375 std::string instance_uds_dir() const; 376 377 std::string instance_internal_uds_dir() const; 378 379 std::string touch_socket_path(int touch_dev_idx) const; 380 std::string mouse_socket_path() const; 381 std::string rotary_socket_path() const; 382 std::string keyboard_socket_path() const; 383 std::string switches_socket_path() const; 384 385 std::string access_kregistry_path() const; 386 387 std::string hwcomposer_pmem_path() const; 388 389 std::string pstore_path() const; 390 391 std::string pflash_path() const; 392 393 std::string console_path() const; 394 395 std::string logcat_path() const; 396 397 std::string kernel_log_pipe_name() const; 398 399 std::string console_pipe_prefix() const; 400 std::string console_in_pipe_name() const; 401 std::string console_out_pipe_name() const; 402 403 std::string gnss_pipe_prefix() const; 404 std::string gnss_in_pipe_name() const; 405 std::string gnss_out_pipe_name() const; 406 407 std::string logcat_pipe_name() const; 408 std::string restore_adbd_pipe_name() const; 409 410 std::string launcher_log_path() const; 411 412 std::string launcher_monitor_socket_path() const; 413 414 std::string sdcard_path() const; 415 std::string sdcard_overlay_path() const; 416 417 std::string persistent_composite_disk_path() const; 418 std::string persistent_composite_overlay_path() const; 419 std::string persistent_ap_composite_disk_path() const; 420 std::string persistent_ap_composite_overlay_path() const; 421 422 std::string os_composite_disk_path() const; 423 424 std::string ap_composite_disk_path() const; 425 426 std::string uboot_env_image_path() const; 427 428 std::string ap_uboot_env_image_path() const; 429 430 std::string ap_esp_image_path() const; 431 432 std::string esp_image_path() const; 433 434 std::string chromeos_state_image() const; 435 436 std::string otheros_esp_grub_config() const; 437 438 std::string ap_esp_grub_config() const; 439 440 std::string audio_server_path() const; 441 442 enum class BootFlow { 443 Android, 444 AndroidEfiLoader, 445 ChromeOs, 446 ChromeOsDisk, 447 Linux, 448 Fuchsia 449 }; 450 451 BootFlow boot_flow() const; 452 453 // modem simulator related 454 std::string modem_simulator_ports() const; 455 456 // The device id the webrtc process should use to register with the 457 // signaling server 458 std::string webrtc_device_id() const; 459 460 // The group id the webrtc process should use to register with the 461 // signaling server 462 std::string group_id() const; 463 464 // Whether this instance should start the webrtc signaling server 465 bool start_webrtc_sig_server() const; 466 467 // Whether to start a reverse proxy to the webrtc signaling server already 468 // running in the host 469 bool start_webrtc_sig_server_proxy() const; 470 471 // Whether this instance should start a rootcanal instance 472 bool start_rootcanal() const; 473 474 // Whether this instance should start a casimir instance 475 bool start_casimir() const; 476 477 // Whether this instance should start a pica instance 478 bool start_pica() const; 479 480 // Whether this instance should start a netsim instance 481 bool start_netsim() const; 482 483 // TODO(b/288987294) Remove this when separating environment is done 484 // Whether this instance should start a wmediumd instance 485 bool start_wmediumd_instance() const; 486 487 const Json::Value& mcu() const; 488 489 enum class APBootFlow { 490 // Not starting AP at all (for example not the 1st instance) 491 None, 492 // Generating ESP and using U-BOOT to boot AP 493 Grub, 494 // Using legacy way to boot AP in case we cannot generate ESP image. 495 // Currently we have only one case when we cannot do it. When users 496 // have ubuntu bionic which doesn't have monolith binaris in the 497 // grub-efi-arm64-bin (for arm64) and grub-efi-ia32-bin (x86) deb packages. 498 // TODO(b/260337906): check is it possible to add grub binaries into the AOSP 499 // to deliver the proper grub environment 500 // TODO(b/260338443): use grub-mkimage from grub-common in case we cannot overcome 501 // legal issues 502 LegacyDirect 503 }; 504 APBootFlow ap_boot_flow() const; 505 506 bool crosvm_use_balloon() const; 507 bool crosvm_use_rng() const; 508 bool use_pmem() const; 509 510 // Wifi MAC address inside the guest 511 int wifi_mac_prefix() const; 512 513 std::string factory_reset_protected_path() const; 514 515 std::string persistent_bootconfig_path() const; 516 517 // used for the persistent_composite_disk vbmeta 518 std::string vbmeta_path() const; 519 520 std::string ap_vbmeta_path() const; 521 522 std::string id() const; 523 524 std::string gem5_binary_dir() const; 525 526 std::string gem5_checkpoint_dir() const; 527 528 // Serial console 529 bool console() const; 530 std::string console_dev() const; 531 bool enable_sandbox() const; 532 bool enable_virtiofs() const; 533 534 // KGDB configuration for kernel debugging 535 bool kgdb() const; 536 537 // TODO (b/163575714) add virtio console support to the bootloader so the 538 // virtio console path for the console device can be taken again. When that 539 // happens, this function can be deleted along with all the code paths it 540 // forces. 541 bool use_bootloader() const; 542 543 Arch target_arch() const; 544 545 int cpus() const; 546 547 std::string vcpu_config_path() const; 548 549 std::string data_policy() const; 550 551 int blank_data_image_mb() const; 552 553 int gdb_port() const; 554 555 std::vector<DisplayConfig> display_configs() const; 556 std::vector<TouchpadConfig> touchpad_configs() const; 557 558 std::string grpc_socket_path() const; 559 int memory_mb() const; 560 int ddr_mem_mb() const; 561 std::string setupwizard_mode() const; 562 std::string userdata_format() const; 563 bool guest_enforce_security() const; 564 bool use_sdcard() const; 565 bool pause_in_bootloader() const; 566 bool run_as_daemon() const; 567 bool enable_audio() const; 568 bool enable_mouse() const; 569 bool enable_gnss_grpc_proxy() const; 570 bool enable_bootanimation() const; 571 bool enable_usb() const; 572 std::vector<std::string> extra_bootconfig_args() const; 573 bool record_screen() const; 574 std::string gem5_debug_file() const; 575 bool protected_vm() const; 576 bool mte() const; 577 std::string boot_slot() const; 578 bool fail_fast() const; 579 bool vhost_user_block() const; 580 581 // Kernel and bootloader logging 582 bool enable_kernel_log() const; 583 bool vhost_net() const; 584 bool vhost_user_vsock() const; 585 int openthread_node_id() const; 586 587 // Mobile network info (RIL) 588 std::string ril_dns() const; 589 std::string ril_ipaddr() const; 590 std::string ril_gateway() const; 591 std::string ril_broadcast() const; 592 uint8_t ril_prefixlen() const; 593 594 bool enable_webrtc() const; 595 std::string webrtc_assets_dir() const; 596 597 // The range of TCP ports available for webrtc sessions. 598 std::pair<uint16_t, uint16_t> webrtc_tcp_port_range() const; 599 600 // The range of UDP ports available for webrtc sessions. 601 std::pair<uint16_t, uint16_t> webrtc_udp_port_range() const; 602 603 bool smt() const; 604 std::string crosvm_binary() const; 605 std::string seccomp_policy_dir() const; 606 std::string qemu_binary_dir() const; 607 608 // Configuration flags for a minimal device 609 bool enable_minimal_mode() const; 610 bool enable_modem_simulator() const; 611 int modem_simulator_instance_number() const; 612 int modem_simulator_sim_type() const; 613 614 std::string gpu_mode() const; 615 std::string gpu_angle_feature_overrides_enabled() const; 616 std::string gpu_angle_feature_overrides_disabled() const; 617 std::string gpu_capture_binary() const; 618 std::string gpu_gfxstream_transport() const; 619 std::string gpu_renderer_features() const; 620 std::string gpu_context_types() const; 621 std::string guest_vulkan_driver() const; 622 bool guest_uses_bgra_framebuffers() const; 623 std::string frames_socket_path() const; 624 625 std::string gpu_vhost_user_mode() const; 626 627 bool enable_gpu_udmabuf() const; 628 bool enable_gpu_vhost_user() const; 629 bool enable_gpu_external_blob() const; 630 bool enable_gpu_system_blob() const; 631 632 std::string hwcomposer() const; 633 634 bool restart_subprocesses() const; 635 636 // android artifacts 637 std::string boot_image() const; 638 std::string new_boot_image() const; 639 std::string init_boot_image() const; 640 std::string data_image() const; 641 std::string new_data_image() const; 642 std::string super_image() const; 643 std::string new_super_image() const; 644 std::string misc_image() const; 645 std::string misc_info_txt() const; 646 std::string metadata_image() const; 647 std::string vendor_boot_image() const; 648 std::string new_vendor_boot_image() const; 649 std::string vbmeta_image() const; 650 std::string new_vbmeta_image() const; 651 std::string vbmeta_system_image() const; 652 std::string vbmeta_vendor_dlkm_image() const; 653 std::string new_vbmeta_vendor_dlkm_image() const; 654 std::string vbmeta_system_dlkm_image() const; 655 std::string new_vbmeta_system_dlkm_image() const; 656 std::string vvmtruststore_path() const; 657 std::string default_target_zip() const; 658 std::string system_target_zip() const; 659 660 // otheros artifacts 661 std::string otheros_esp_image() const; 662 663 // android efi loader flow 664 std::string android_efi_loader() const; 665 666 // chromeos artifacts for otheros flow 667 std::string chromeos_disk() const; 668 std::string chromeos_kernel_path() const; 669 std::string chromeos_root_image() const; 670 671 // linux artifacts for otheros flow 672 std::string linux_kernel_path() const; 673 std::string linux_initramfs_path() const; 674 std::string linux_root_image() const; 675 676 std::string fuchsia_zedboot_path() const; 677 std::string fuchsia_multiboot_bin_path() const; 678 std::string fuchsia_root_image() const; 679 680 std::string custom_partition_path() const; 681 682 std::string hibernation_partition_image() const; 683 684 int blank_metadata_image_mb() const; 685 int blank_sdcard_image_mb() const; 686 std::string bootloader() const; 687 std::string initramfs_path() const; 688 std::string kernel_path() const; 689 std::string guest_android_version() const; 690 bool bootconfig_supported() const; 691 std::string filename_encryption_mode() const; 692 ExternalNetworkMode external_network_mode() const; 693 694 bool start_vhal_proxy_server() const; 695 }; 696 697 // A view into an existing CuttlefishConfig object for a particular instance. 698 class MutableInstanceSpecific { 699 CuttlefishConfig* config_; 700 std::string id_; 701 friend MutableInstanceSpecific CuttlefishConfig::ForInstance(int num); 702 703 MutableInstanceSpecific(CuttlefishConfig* config, const std::string& id); 704 705 Json::Value* Dictionary(); 706 public: 707 void set_serial_number(const std::string& serial_number); 708 void set_qemu_vnc_server_port(int qemu_vnc_server_port); 709 void set_tombstone_receiver_port(int tombstone_receiver_port); 710 void set_config_server_port(int config_server_port); 711 void set_frames_server_port(int config_server_port); 712 void set_touch_server_port(int config_server_port); 713 void set_keyboard_server_port(int config_server_port); 714 void set_gatekeeper_vsock_port(int gatekeeper_vsock_port); 715 void set_keymaster_vsock_port(int keymaster_vsock_port); 716 void set_audiocontrol_server_port(int audiocontrol_server_port); 717 void set_lights_server_port(int lights_server_port); 718 void set_adb_host_port(int adb_host_port); 719 void set_modem_simulator_host_id(int modem_simulator_id); 720 void set_adb_ip_and_port(const std::string& ip_port); 721 void set_fastboot_host_port(int fastboot_host_port); 722 void set_camera_server_port(int camera_server_port); 723 void set_mobile_bridge_name(const std::string& mobile_bridge_name); 724 void set_mobile_tap_name(const std::string& mobile_tap_name); 725 void set_mobile_mac(const std::string& mac); 726 void set_wifi_bridge_name(const std::string& wifi_bridge_name); 727 void set_wifi_tap_name(const std::string& wifi_tap_name); 728 void set_wifi_mac(const std::string& mac); 729 void set_use_bridged_wifi_tap(bool use_bridged_wifi_tap); 730 void set_ethernet_tap_name(const std::string& ethernet_tap_name); 731 void set_ethernet_bridge_name(const std::string& set_ethernet_bridge_name); 732 void set_ethernet_mac(const std::string& mac); 733 void set_ethernet_ipv6(const std::string& ip); 734 void set_session_id(uint32_t session_id); 735 void set_use_allocd(bool use_allocd); 736 void set_vsock_guest_cid(int vsock_guest_cid); 737 void set_vsock_guest_group(const std::string& vsock_guest_group); 738 void set_uuid(const std::string& uuid); 739 void set_environment_name(const std::string& env_name); 740 // modem simulator related 741 void set_modem_simulator_ports(const std::string& modem_simulator_ports); 742 void set_virtual_disk_paths(const std::vector<std::string>& disk_paths); 743 void set_webrtc_device_id(const std::string& id); 744 void set_group_id(const std::string& id); 745 void set_start_webrtc_signaling_server(bool start); 746 void set_start_webrtc_sig_server_proxy(bool start); 747 void set_start_rootcanal(bool start); 748 void set_start_casimir(bool start); 749 void set_start_pica(bool start); 750 void set_start_netsim(bool start); 751 // TODO(b/288987294) Remove this when separating environment is done 752 void set_start_wmediumd_instance(bool start); 753 void set_mcu(const Json::Value &v); 754 void set_ap_boot_flow(InstanceSpecific::APBootFlow flow); 755 void set_crosvm_use_balloon(const bool use_balloon); 756 void set_crosvm_use_rng(const bool use_rng); 757 void set_use_pmem(const bool use_pmem); 758 // Wifi MAC address inside the guest 759 void set_wifi_mac_prefix(const int wifi_mac_prefix); 760 // Gnss grpc proxy server port inside the host 761 void set_gnss_grpc_proxy_server_port(int gnss_grpc_proxy_server_port); 762 // Gnss grpc proxy local file path 763 void set_gnss_file_path(const std::string &gnss_file_path); 764 void set_fixed_location_file_path( 765 const std::string& fixed_location_file_path); 766 void set_gem5_binary_dir(const std::string& gem5_binary_dir); 767 void set_gem5_checkpoint_dir(const std::string& gem5_checkpoint_dir); 768 // Serial console 769 void set_console(bool console); 770 void set_enable_sandbox(const bool enable_sandbox); 771 void set_enable_virtiofs(const bool enable_virtiofs); 772 void set_kgdb(bool kgdb); 773 void set_target_arch(Arch target_arch); 774 void set_cpus(int cpus); 775 void set_vcpu_config_path(const std::string& vcpu_config_path); 776 void set_data_policy(const std::string& data_policy); 777 void set_blank_data_image_mb(int blank_data_image_mb); 778 void set_gdb_port(int gdb_port); 779 void set_display_configs(const std::vector<DisplayConfig>& display_configs); 780 void set_touchpad_configs( 781 const std::vector<TouchpadConfig>& touchpad_configs); 782 void set_memory_mb(int memory_mb); 783 void set_ddr_mem_mb(int ddr_mem_mb); 784 Result<void> set_setupwizard_mode(const std::string& title); 785 void set_userdata_format(const std::string& userdata_format); 786 void set_guest_enforce_security(bool guest_enforce_security); 787 void set_use_sdcard(bool use_sdcard); 788 void set_pause_in_bootloader(bool pause_in_bootloader); 789 void set_run_as_daemon(bool run_as_daemon); 790 void set_enable_audio(bool enable); 791 void set_enable_mouse(bool enable); 792 void set_enable_usb(bool enable); 793 void set_enable_gnss_grpc_proxy(const bool enable_gnss_grpc_proxy); 794 void set_enable_bootanimation(const bool enable_bootanimation); 795 void set_extra_bootconfig_args(const std::string& extra_bootconfig_args); 796 void set_record_screen(bool record_screen); 797 void set_gem5_debug_file(const std::string& gem5_debug_file); 798 void set_protected_vm(bool protected_vm); 799 void set_mte(bool mte); 800 void set_boot_slot(const std::string& boot_slot); 801 void set_grpc_socket_path(const std::string& sockets); 802 void set_fail_fast(bool fail_fast); 803 void set_vhost_user_block(bool qemu_vhost_user_block); 804 805 // Kernel and bootloader logging 806 void set_enable_kernel_log(bool enable_kernel_log); 807 808 void set_enable_webrtc(bool enable_webrtc); 809 void set_webrtc_assets_dir(const std::string& webrtc_assets_dir); 810 811 // The range of TCP ports available for webrtc sessions. 812 void set_webrtc_tcp_port_range(std::pair<uint16_t, uint16_t> range); 813 814 // The range of UDP ports available for webrtc sessions. 815 void set_webrtc_udp_port_range(std::pair<uint16_t, uint16_t> range); 816 817 void set_smt(bool smt); 818 void set_crosvm_binary(const std::string& crosvm_binary); 819 void set_seccomp_policy_dir(const std::string& seccomp_policy_dir); 820 void set_qemu_binary_dir(const std::string& qemu_binary_dir); 821 822 void set_vhost_net(bool vhost_net); 823 void set_vhost_user_vsock(bool vhost_user_vsock); 824 825 void set_openthread_node_id(int node_id); 826 827 // Mobile network (RIL) 828 void set_ril_dns(const std::string& ril_dns); 829 void set_ril_ipaddr(const std::string& ril_ipaddr); 830 void set_ril_gateway(const std::string& ril_gateway); 831 void set_ril_broadcast(const std::string& ril_broadcast); 832 void set_ril_prefixlen(uint8_t ril_prefixlen); 833 834 // Configuration flags for a minimal device 835 void set_enable_minimal_mode(bool enable_minimal_mode); 836 void set_enable_modem_simulator(bool enable_modem_simulator); 837 void set_modem_simulator_instance_number(int instance_numbers); 838 void set_modem_simulator_sim_type(int sim_type); 839 840 void set_gpu_mode(const std::string& name); 841 void set_gpu_angle_feature_overrides_enabled(const std::string& overrides); 842 void set_gpu_angle_feature_overrides_disabled(const std::string& overrides); 843 void set_gpu_capture_binary(const std::string&); 844 void set_gpu_gfxstream_transport(const std::string& transport); 845 void set_gpu_renderer_features(const std::string& features); 846 void set_gpu_context_types(const std::string& context_types); 847 void set_guest_vulkan_driver(const std::string& driver); 848 void set_guest_uses_bgra_framebuffers(bool uses_bgra); 849 void set_frames_socket_path(const std::string& driver); 850 851 void set_enable_gpu_udmabuf(const bool enable_gpu_udmabuf); 852 void set_enable_gpu_vhost_user(const bool enable_gpu_vhost_user); 853 void set_enable_gpu_external_blob(const bool enable_gpu_external_blob); 854 void set_enable_gpu_system_blob(const bool enable_gpu_system_blob); 855 856 void set_hwcomposer(const std::string&); 857 858 void set_restart_subprocesses(bool restart_subprocesses); 859 860 // system image files 861 void set_boot_image(const std::string& boot_image); 862 void set_new_boot_image(const std::string& new_boot_image); 863 void set_init_boot_image(const std::string& init_boot_image); 864 void set_data_image(const std::string& data_image); 865 void set_new_data_image(const std::string& new_data_image); 866 void set_super_image(const std::string& super_image); 867 void set_new_super_image(const std::string& super_image); 868 void set_misc_info_txt(const std::string& misc_image); 869 void set_vendor_boot_image(const std::string& vendor_boot_image); 870 void set_new_vendor_boot_image(const std::string& new_vendor_boot_image); 871 void set_vbmeta_image(const std::string& vbmeta_image); 872 void set_new_vbmeta_image(const std::string& new_vbmeta_image); 873 void set_vbmeta_system_image(const std::string& vbmeta_system_image); 874 void set_vbmeta_vendor_dlkm_image( 875 const std::string& vbmeta_vendor_dlkm_image); 876 void set_new_vbmeta_vendor_dlkm_image( 877 const std::string& vbmeta_vendor_dlkm_image); 878 void set_vbmeta_system_dlkm_image( 879 const std::string& vbmeta_system_dlkm_image); 880 void set_new_vbmeta_system_dlkm_image( 881 const std::string& vbmeta_system_dlkm_image); 882 void set_vvmtruststore_path(const std::string& vvmtruststore_path); 883 void set_default_target_zip(const std::string& default_target_zip); 884 void set_system_target_zip(const std::string& system_target_zip); 885 void set_otheros_esp_image(const std::string& otheros_esp_image); 886 void set_android_efi_loader(const std::string& android_efi_loader); 887 void set_chromeos_disk(const std::string& chromeos_disk); 888 void set_chromeos_kernel_path(const std::string& linux_kernel_path); 889 void set_chromeos_root_image(const std::string& linux_root_image); 890 void set_linux_kernel_path(const std::string& linux_kernel_path); 891 void set_linux_initramfs_path(const std::string& linux_initramfs_path); 892 void set_linux_root_image(const std::string& linux_root_image); 893 void set_fuchsia_zedboot_path(const std::string& fuchsia_zedboot_path); 894 void set_fuchsia_multiboot_bin_path(const std::string& fuchsia_multiboot_bin_path); 895 void set_fuchsia_root_image(const std::string& fuchsia_root_image); 896 void set_custom_partition_path(const std::string& custom_partition_path); 897 void set_blank_metadata_image_mb(int blank_metadata_image_mb); 898 void set_blank_sdcard_image_mb(int blank_sdcard_image_mb); 899 void set_bootloader(const std::string& bootloader); 900 void set_initramfs_path(const std::string& initramfs_path); 901 void set_kernel_path(const std::string& kernel_path); 902 void set_guest_android_version(const std::string& guest_android_version); 903 void set_bootconfig_supported(bool bootconfig_supported); 904 void set_filename_encryption_mode(const std::string& userdata_format); 905 void set_external_network_mode(ExternalNetworkMode network_mode); 906 void set_hibernation_partition_image( 907 const std::string& hibernation_partition_image); 908 909 // Whether we should start vhal_proxy_server for the guest-side VHAL to 910 // connect to. 911 void set_start_vhal_proxy_server(bool enable_vhal_proxy_server); 912 913 private: 914 void SetPath(const std::string& key, const std::string& path); 915 }; 916 917 class EnvironmentSpecific; 918 class MutableEnvironmentSpecific; 919 920 MutableEnvironmentSpecific ForEnvironment(const std::string& envName); 921 EnvironmentSpecific ForEnvironment(const std::string& envName) const; 922 923 MutableEnvironmentSpecific ForDefaultEnvironment(); 924 EnvironmentSpecific ForDefaultEnvironment() const; 925 926 std::vector<std::string> environment_dirs() const; 927 928 class EnvironmentSpecific { 929 friend EnvironmentSpecific CuttlefishConfig::ForEnvironment( 930 const std::string&) const; 931 friend EnvironmentSpecific CuttlefishConfig::ForDefaultEnvironment() const; 932 933 const CuttlefishConfig* config_; 934 std::string envName_; 935 EnvironmentSpecific(const CuttlefishConfig * config,const std::string & envName)936 EnvironmentSpecific(const CuttlefishConfig* config, 937 const std::string& envName) 938 : config_(config), envName_(envName) {} 939 940 Json::Value* Dictionary(); 941 const Json::Value* Dictionary() const; 942 943 public: 944 std::string environment_name() const; 945 946 std::string environment_uds_dir() const; 947 std::string PerEnvironmentUdsPath(const std::string& file_name) const; 948 949 std::string environment_dir() const; 950 std::string PerEnvironmentPath(const std::string& file_name) const; 951 952 std::string PerEnvironmentLogPath(const std::string& file_name) const; 953 954 std::string PerEnvironmentGrpcSocketPath( 955 const std::string& file_name) const; 956 957 std::string control_socket_path() const; 958 std::string launcher_log_path() const; 959 960 std::string casimir_nci_socket_path() const; 961 std::string casimir_rf_socket_path() const; 962 963 // wmediumd related configs 964 bool enable_wifi() const; 965 bool start_wmediumd() const; 966 std::string vhost_user_mac80211_hwsim() const; 967 std::string wmediumd_api_server_socket() const; 968 std::string wmediumd_config() const; 969 int wmediumd_mac_prefix() const; 970 }; 971 972 class MutableEnvironmentSpecific { 973 friend MutableEnvironmentSpecific CuttlefishConfig::ForEnvironment( 974 const std::string&); 975 friend MutableEnvironmentSpecific CuttlefishConfig::ForDefaultEnvironment(); 976 977 CuttlefishConfig* config_; 978 std::string envName_; 979 MutableEnvironmentSpecific(CuttlefishConfig * config,const std::string & envName)980 MutableEnvironmentSpecific(CuttlefishConfig* config, 981 const std::string& envName) 982 : config_(config), envName_(envName) {} 983 984 Json::Value* Dictionary(); 985 986 public: 987 // wmediumd related configs 988 void set_enable_wifi(const bool enable_wifi); 989 void set_start_wmediumd(bool start); 990 void set_vhost_user_mac80211_hwsim(const std::string& path); 991 void set_wmediumd_api_server_socket(const std::string& path); 992 void set_wmediumd_config(const std::string& path); 993 void set_wmediumd_mac_prefix(int mac_prefix); 994 }; 995 996 private: 997 std::unique_ptr<Json::Value> dictionary_; 998 999 static CuttlefishConfig* BuildConfigImpl(const std::string& path); 1000 1001 CuttlefishConfig(const CuttlefishConfig&) = delete; 1002 CuttlefishConfig& operator=(const CuttlefishConfig&) = delete; 1003 }; 1004 1005 // Whether the instance is restored from a snapshot. Stays true until the device 1006 // reboots. 1007 // When the device is booting, the config init function checks if 1008 // "FLAGS_snapshot_path" is not empty, and if it isn't empty, a file called 1009 // "restore" will be created to keep track of the restore. 1010 // This is necessary because we don't want to 1011 // modify the config when the device boots, however we also want to only restore 1012 // once. Tracking via "restore" is necessary as a bug existed when checking if 1013 // "snapshot_path" existed during boot, where a restart or a powerwash of the 1014 // device would actually perform a restore instead of their respective actions. 1015 bool IsRestoring(const CuttlefishConfig&); 1016 1017 // Vhost-user-vsock modes 1018 extern const char* const kVhostUserVsockModeAuto; 1019 extern const char* const kVhostUserVsockModeTrue; 1020 extern const char* const kVhostUserVsockModeFalse; 1021 1022 // GPU modes 1023 extern const char* const kGpuModeAuto; 1024 extern const char* const kGpuModeCustom; 1025 extern const char* const kGpuModeDrmVirgl; 1026 extern const char* const kGpuModeGfxstream; 1027 extern const char* const kGpuModeGfxstreamGuestAngle; 1028 extern const char* const kGpuModeGfxstreamGuestAngleHostSwiftShader; 1029 extern const char* const kGpuModeGuestSwiftshader; 1030 extern const char* const kGpuModeNone; 1031 1032 // GPU vhost user modes 1033 extern const char* const kGpuVhostUserModeAuto; 1034 extern const char* const kGpuVhostUserModeOn; 1035 extern const char* const kGpuVhostUserModeOff; 1036 1037 // HwComposer modes 1038 extern const char* const kHwComposerAuto; 1039 extern const char* const kHwComposerDrm; 1040 extern const char* const kHwComposerRanchu; 1041 extern const char* const kHwComposerNone; 1042 } // namespace cuttlefish 1043 1044 #if FMT_VERSION >= 90000 1045 template <> 1046 struct fmt::formatter<cuttlefish::ExternalNetworkMode> : ostream_formatter {}; 1047 template <> 1048 struct fmt::formatter<cuttlefish::VmmMode> : ostream_formatter {}; 1049 #endif 1050