| // Copyright 2018 The Chromium OS Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef VM_TOOLS_CONCIERGE_PLUGIN_VM_H_ |
| #define VM_TOOLS_CONCIERGE_PLUGIN_VM_H_ |
| |
| #include <stdint.h> |
| |
| #include <deque> |
| #include <list> |
| #include <memory> |
| #include <string> |
| #include <tuple> |
| #include <utility> |
| #include <vector> |
| |
| #include <base/files/file_descriptor_watcher_posix.h> |
| #include <base/files/file_path.h> |
| #include <base/files/scoped_file.h> |
| #include <base/logging.h> |
| #include <base/macros.h> |
| #include <brillo/process/process.h> |
| #include <dbus/exported_object.h> |
| #include <chromeos/patchpanel/subnet.h> |
| #include <vm_concierge/proto_bindings/concierge_service.pb.h> |
| |
| #include "vm_tools/common/vm_id.h" |
| #include "vm_tools/concierge/plugin_vm_usb.h" |
| #include "vm_tools/concierge/seneschal_server_proxy.h" |
| #include "vm_tools/concierge/vm_base_impl.h" |
| |
| namespace vm_tools { |
| namespace concierge { |
| |
| class PluginVm final : public VmBaseImpl { |
| public: |
| static std::unique_ptr<PluginVm> Create( |
| const VmId id, |
| uint32_t cpus, |
| std::vector<std::string> params, |
| base::FilePath stateful_dir, |
| base::FilePath iso_dir, |
| base::FilePath root_dir, |
| base::FilePath runtime_dir, |
| std::unique_ptr<patchpanel::Client> network_client, |
| int subnet_index, |
| bool enable_vnet_hdr, |
| std::unique_ptr<SeneschalServerProxy> seneschal_server_proxy, |
| dbus::ObjectProxy* vm_permission_service_proxy, |
| dbus::ObjectProxy* vmplugin_service_proxy); |
| ~PluginVm() override; |
| |
| // VmInterface overrides. |
| bool Shutdown() override; |
| VmInterface::Info GetInfo() override; |
| // Currently only implemented for termina, returns "Not implemented". |
| bool GetVmEnterpriseReportingInfo( |
| GetVmEnterpriseReportingInfoResponse* response) override; |
| bool AttachUsbDevice(uint8_t bus, |
| uint8_t addr, |
| uint16_t vid, |
| uint16_t pid, |
| int fd, |
| UsbControlResponse* response) override; |
| bool DetachUsbDevice(uint8_t port, UsbControlResponse* response) override; |
| bool ListUsbDevice(std::vector<UsbDevice>* devices) override; |
| bool SetResolvConfig(const std::vector<std::string>& nameservers, |
| const std::vector<std::string>& search_domains) override; |
| bool SetTime(std::string* failure_reason) override { return true; } |
| void SetTremplinStarted() override { NOTREACHED(); } |
| void VmToolsStateChanged(bool running) override; |
| vm_tools::concierge::DiskImageStatus ResizeDisk( |
| uint64_t new_size, std::string* failure_reason) override; |
| vm_tools::concierge::DiskImageStatus GetDiskResizeStatus( |
| std::string* failure_reason) override; |
| |
| static bool WriteResolvConf(const base::FilePath& parent_dir, |
| const std::vector<std::string>& nameservers, |
| const std::vector<std::string>& search_domains); |
| |
| static base::ScopedFD CreateUnixSocket(const base::FilePath& path, int type); |
| |
| // Adjusts the amount of CPU the Plugin VM processes are allowed to use. |
| static bool SetVmCpuRestriction(CpuRestrictionState cpu_restriction_state); |
| |
| // The 9p server managed by seneschal that provides access to shared files for |
| // this VM. Returns 0 if there is no seneschal server associated with this |
| // VM. |
| uint32_t seneschal_server_handle() const { |
| if (seneschal_server_proxy_) { |
| return seneschal_server_proxy_->handle(); |
| } |
| |
| return 0; |
| } |
| |
| private: |
| PluginVm(const VmId id, |
| std::unique_ptr<patchpanel::Client> network_client, |
| int subnet_index, |
| bool enable_vnet_hdr, |
| std::unique_ptr<SeneschalServerProxy> seneschal_server_proxy, |
| dbus::ObjectProxy* vm_perrmission_service_proxy, |
| dbus::ObjectProxy* vmplugin_service_proxy, |
| base::FilePath iso_dir, |
| base::FilePath root_dir, |
| base::FilePath runtime_dir); |
| void HandleSuspendImminent() override {} |
| void HandleSuspendDone() override {} |
| bool Start(uint32_t cpus, |
| std::vector<std::string> params, |
| base::FilePath stateful_dir); |
| bool CreateUsbListeningSocket(); |
| void HandleUsbControlResponse(); |
| |
| // Attempt to stop VM. |
| bool StopVm(); |
| |
| void OnListenFileCanReadWithoutBlocking(); |
| void OnVmFileCanReadWithoutBlocking(); |
| void OnVmFileCanWriteWithoutBlocking(); |
| |
| // This VM ID. It is used to communicate with the dispatcher to request |
| // VM state changes. |
| const VmId id_; |
| std::size_t id_hash_; |
| |
| // Specifies directory holding ISO images that can be attached to the VM. |
| base::FilePath iso_dir_; |
| |
| // Allows to build skeleton of root file system for the plugin. |
| // Individual directories, such as /etc, are mounted plugin jail. |
| base::ScopedTempDir root_dir_; |
| |
| // The subnet assigned to the VM. |
| std::unique_ptr<patchpanel::Subnet> subnet_; |
| // The requested subnet index. |
| const int subnet_index_; |
| // Toggles the use of the IFF_VNET_HDR option on the TAP device. |
| const bool enable_vnet_hdr_; |
| |
| // Proxy to the server providing shared directory access for this VM. |
| std::unique_ptr<SeneschalServerProxy> seneschal_server_proxy_; |
| |
| // Proxy to the dispatcher service. Not owned. |
| dbus::ObjectProxy* vm_permission_service_proxy_; |
| |
| // Token assigned to the VM by the permission service. |
| std::string permission_token_; |
| |
| // Proxy to the dispatcher service. Not owned. |
| dbus::ObjectProxy* vmplugin_service_proxy_; |
| |
| // List of USB devices attached to VM (vid, pid, handle) |
| using UsbDeviceInfo = std::tuple<uint16_t, uint16_t, uint32_t>; |
| std::list<UsbDeviceInfo> usb_devices_; |
| |
| // Monotonically increasing handle (port) number for USB devices passed |
| // to the Plugin VM. |
| uint32_t usb_last_handle_; |
| |
| // Outstanding control requests waiting to be transmitted to plugin. |
| std::deque<std::pair<UsbCtrlRequest, base::ScopedFD>> usb_req_waiting_xmit_; |
| |
| // Outstanding control requests waiting response from plugin. |
| std::list<UsbCtrlRequest> usb_req_waiting_response_; |
| |
| // File descriptors to pass USB devices over to plugin. |
| base::ScopedFD usb_listen_fd_; |
| base::ScopedFD usb_vm_fd_; |
| std::unique_ptr<base::FileDescriptorWatcher::Controller> usb_listen_watcher_; |
| std::unique_ptr<base::FileDescriptorWatcher::Controller> usb_vm_read_watcher_; |
| std::unique_ptr<base::FileDescriptorWatcher::Controller> |
| usb_vm_write_watcher_; |
| |
| DISALLOW_COPY_AND_ASSIGN(PluginVm); |
| }; |
| |
| } // namespace concierge |
| } // namespace vm_tools |
| |
| #endif // VM_TOOLS_CONCIERGE_PLUGIN_VM_H_ |