Define DebianService for host-guest communication
1. Use TCP/IP socket for now
2. IP address reporter uses that
3. Refactoring: remove timeout for shell page because systemd unit for
ip addr reporter 'requires' ttyd
4. move source files for guest(debian) to guest dir
Bug: 372666638
Test: check if shell shows
Change-Id: Ida94a05de9998a06b4b5c7efebbae97c78617bf4
diff --git a/android/TerminalApp/java/com/android/virtualization/terminal/MainActivity.java b/android/TerminalApp/java/com/android/virtualization/terminal/MainActivity.java
index 846f975..0e2a7d1 100644
--- a/android/TerminalApp/java/com/android/virtualization/terminal/MainActivity.java
+++ b/android/TerminalApp/java/com/android/virtualization/terminal/MainActivity.java
@@ -19,8 +19,6 @@
import android.content.ClipboardManager;
import android.content.Intent;
import android.os.Bundle;
-import android.os.Handler;
-import android.os.Looper;
import android.util.Log;
import android.view.Menu;
import android.view.MenuItem;
@@ -96,10 +94,7 @@
public void onIpAddrAvailable(String ipAddr) {
mVmIpAddr = ipAddr;
((TextView) findViewById(R.id.ip_addr_textview)).setText(mVmIpAddr);
-
- // TODO(b/359523803): Use AVF API to be notified when shell is ready instead of using dealy
- new Handler(Looper.getMainLooper())
- .postDelayed(() -> gotoURL("http://" + mVmIpAddr + ":7681"), 2000);
+ gotoURL("http://" + mVmIpAddr + ":7681");
}
@Override
diff --git a/build/debian/build.sh b/build/debian/build.sh
index 0d13019..97d9373 100755
--- a/build/debian/build.sh
+++ b/build/debian/build.sh
@@ -60,6 +60,7 @@
fai-setup-storage
fdisk
make
+ protobuf-compiler
python3
python3-libcloud
python3-marshmallow
@@ -115,7 +116,7 @@
wget "${url}" -O "${dst}/files/usr/local/bin/ttyd/AVF"
chmod 777 "${dst}/files/usr/local/bin/ttyd/AVF"
- pushd "$(dirname "$0")/forwarder_guest" > /dev/null
+ pushd "$(dirname "$0")/../../guest/forwarder_guest" > /dev/null
RUSTFLAGS="-C linker=${arch}-linux-gnu-gcc" cargo build \
--target "${arch}-unknown-linux-gnu" \
--target-dir "${workdir}/forwarder_guest"
@@ -123,6 +124,15 @@
cp "${workdir}/forwarder_guest/${arch}-unknown-linux-gnu/debug/forwarder_guest" "${dst}/files/usr/local/bin/forwarder_guest/AVF"
chmod 777 "${dst}/files/usr/local/bin/forwarder_guest/AVF"
popd > /dev/null
+
+ pushd $(dirname $0)/../../guest/ip_addr_reporter > /dev/null
+ RUSTFLAGS="-C linker=aarch64-linux-gnu-gcc" cargo build \
+ --target aarch64-unknown-linux-gnu \
+ --target-dir ${workdir}/ip_addr_reporter
+ mkdir -p ${dst}/files/usr/local/bin/ip_addr_reporter
+ cp ${workdir}/ip_addr_reporter/aarch64-unknown-linux-gnu/debug/ip_addr_reporter ${dst}/files/usr/local/bin/ip_addr_reporter/AVF
+ chmod 777 ${dst}/files/usr/local/bin/ip_addr_reporter/AVF
+ popd > /dev/null
}
run_fai() {
diff --git a/build/debian/fai_config/files/etc/systemd/system/ip_addr_reporter.service/AVF b/build/debian/fai_config/files/etc/systemd/system/ip_addr_reporter.service/AVF
new file mode 100644
index 0000000..7d163fb
--- /dev/null
+++ b/build/debian/fai_config/files/etc/systemd/system/ip_addr_reporter.service/AVF
@@ -0,0 +1,13 @@
+[Unit]
+Description=ip report service
+After=syslog.target
+After=network.target
+Requires=ttyd.service
+[Service]
+ExecStart=/usr/local/bin/ip_addr_reporter
+Type=simple
+Restart=on-failure
+User=root
+Group=root
+[Install]
+WantedBy=multi-user.target
diff --git a/build/debian/fai_config/files/etc/systemd/system/vsockip.service/AVF b/build/debian/fai_config/files/etc/systemd/system/vsockip.service/AVF
deleted file mode 100644
index a29020b..0000000
--- a/build/debian/fai_config/files/etc/systemd/system/vsockip.service/AVF
+++ /dev/null
@@ -1,12 +0,0 @@
-[Unit]
-Description=vsock ip service
-After=syslog.target
-After=network.target
-[Service]
-ExecStart=/usr/bin/python3 /usr/local/bin/vsock.py
-Type=simple
-Restart=always
-User=root
-Group=root
-[Install]
-WantedBy=multi-user.target
diff --git a/build/debian/fai_config/files/usr/local/bin/vsock.py/AVF b/build/debian/fai_config/files/usr/local/bin/vsock.py/AVF
deleted file mode 100755
index 292d953..0000000
--- a/build/debian/fai_config/files/usr/local/bin/vsock.py/AVF
+++ /dev/null
@@ -1,57 +0,0 @@
-#!/usr/bin/env python3
-
-import socket
-
-# Constants for vsock (from linux/vm_sockets.h)
-AF_VSOCK = 40
-SOCK_STREAM = 1
-VMADDR_CID_ANY = -1
-
-def get_local_ip():
- """Retrieves the first IPv4 address found on the system.
-
- Returns:
- str: The local IPv4 address, or '127.0.0.1' if no IPv4 address is found.
- """
-
- s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
- try:
- s.connect(('8.8.8.8', 80))
- ip = s.getsockname()[0]
- except Exception:
- ip = '127.0.0.1'
- finally:
- s.close()
- return ip
-
-def main():
- PORT = 1024
-
- # Create a vsock socket
- server_socket = socket.socket(AF_VSOCK, SOCK_STREAM)
-
- # Bind the socket to the server address
- server_address = (VMADDR_CID_ANY, PORT)
- server_socket.bind(server_address)
-
- # Listen for incoming connections
- server_socket.listen(1)
- print(f"VSOCK server listening on port {PORT}...")
-
- while True:
- # Accept a connection
- connection, client_address = server_socket.accept()
- print(f"Connection from: {client_address}")
-
- try:
- # Get the local IP address
- local_ip = get_local_ip()
-
- # Send the IP address to the client
- connection.sendall(local_ip.encode())
- finally:
- # Close the connection
- connection.close()
-
-if __name__ == "__main__":
- main()
diff --git a/build/debian/fai_config/scripts/AVF/10-systemd b/build/debian/fai_config/scripts/AVF/10-systemd
index d33b92a..09d1bd1 100755
--- a/build/debian/fai_config/scripts/AVF/10-systemd
+++ b/build/debian/fai_config/scripts/AVF/10-systemd
@@ -1,7 +1,7 @@
#!/bin/bash
chmod +x $target/usr/local/bin/forwarder_guest
+chmod +x $target/usr/local/bin/ip_addr_reporter
chmod +x $target/usr/local/bin/ttyd
-chmod +x $target/usr/local/bin/vsock.py
ln -s /etc/systemd/system/ttyd.service $target/etc/systemd/system/multi-user.target.wants/ttyd.service
-ln -s /etc/systemd/system/vsockip.service $target/etc/systemd/system/multi-user.target.wants/vsockip.service
\ No newline at end of file
+ln -s /etc/systemd/system/ip_addr_reporter.service $target/etc/systemd/system/multi-user.target.wants/ip_addr_reporter.service
\ No newline at end of file
diff --git a/build/debian/forwarder_guest/Cargo.toml b/guest/forwarder_guest/Cargo.toml
similarity index 79%
rename from build/debian/forwarder_guest/Cargo.toml
rename to guest/forwarder_guest/Cargo.toml
index e70dcd4..65f57cf 100644
--- a/build/debian/forwarder_guest/Cargo.toml
+++ b/guest/forwarder_guest/Cargo.toml
@@ -5,7 +5,7 @@
[dependencies]
clap = { version = "4.5.19", features = ["derive"] }
-forwarder = { path = "../../../libs/libforwarder" }
+forwarder = { path = "../../libs/libforwarder" }
poll_token_derive = "0.1.0"
remain = "0.2.14"
vmm-sys-util = "0.12.1"
diff --git a/build/debian/forwarder_guest/src/main.rs b/guest/forwarder_guest/src/main.rs
similarity index 100%
rename from build/debian/forwarder_guest/src/main.rs
rename to guest/forwarder_guest/src/main.rs
diff --git a/guest/ip_addr_reporter/.gitignore b/guest/ip_addr_reporter/.gitignore
new file mode 100644
index 0000000..ea8c4bf
--- /dev/null
+++ b/guest/ip_addr_reporter/.gitignore
@@ -0,0 +1 @@
+/target
diff --git a/guest/ip_addr_reporter/Cargo.toml b/guest/ip_addr_reporter/Cargo.toml
new file mode 100644
index 0000000..e255eaf
--- /dev/null
+++ b/guest/ip_addr_reporter/Cargo.toml
@@ -0,0 +1,13 @@
+[package]
+name = "ip_addr_reporter"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+netdev = "0.31.0"
+prost = "0.13.3"
+tokio = { version = "1.40.0", features = ["rt-multi-thread"] }
+tonic = "0.12.3"
+
+[build-dependencies]
+tonic-build = "0.12.3"
diff --git a/guest/ip_addr_reporter/build.rs b/guest/ip_addr_reporter/build.rs
new file mode 100644
index 0000000..e3939d4
--- /dev/null
+++ b/guest/ip_addr_reporter/build.rs
@@ -0,0 +1,7 @@
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+ let proto_file = "../../libs/debian_service/proto/DebianService.proto";
+
+ tonic_build::compile_protos(proto_file).unwrap();
+
+ Ok(())
+}
diff --git a/guest/ip_addr_reporter/src/main.rs b/guest/ip_addr_reporter/src/main.rs
new file mode 100644
index 0000000..5784a83
--- /dev/null
+++ b/guest/ip_addr_reporter/src/main.rs
@@ -0,0 +1,26 @@
+use api::debian_service_client::DebianServiceClient;
+use api::IpAddr;
+
+pub mod api {
+ tonic::include_proto!("com.android.virtualization.vmlauncher.proto");
+}
+
+#[tokio::main]
+async fn main() -> Result<(), String> {
+ let gateway_ip_addr = netdev::get_default_gateway()?.ipv4[0];
+ let ip_addr = netdev::get_default_interface()?.ipv4[0].addr();
+ const PORT: i32 = 12000;
+
+ let server_addr = format!("http://{}:{}", gateway_ip_addr.to_string(), PORT);
+
+ println!("local ip addr: {}", ip_addr.to_string());
+ println!("coonect to grpc server {}", server_addr);
+
+ let mut client = DebianServiceClient::connect(server_addr).await.map_err(|e| e.to_string())?;
+
+ let request = tonic::Request::new(IpAddr { addr: ip_addr.to_string() });
+
+ let response = client.report_vm_ip_addr(request).await.map_err(|e| e.to_string())?;
+ println!("response from server: {:?}", response);
+ Ok(())
+}
diff --git a/build/debian/port_listener/build.sh b/guest/port_listener/build.sh
similarity index 100%
rename from build/debian/port_listener/build.sh
rename to guest/port_listener/build.sh
diff --git a/build/debian/port_listener/src/common.h b/guest/port_listener/src/common.h
similarity index 100%
rename from build/debian/port_listener/src/common.h
rename to guest/port_listener/src/common.h
diff --git a/build/debian/port_listener/src/listen_tracker.ebpf.c b/guest/port_listener/src/listen_tracker.ebpf.c
similarity index 99%
rename from build/debian/port_listener/src/listen_tracker.ebpf.c
rename to guest/port_listener/src/listen_tracker.ebpf.c
index 030ded0..9e98aad 100644
--- a/build/debian/port_listener/src/listen_tracker.ebpf.c
+++ b/guest/port_listener/src/listen_tracker.ebpf.c
@@ -16,11 +16,10 @@
// src/platform2/vm_tools/port_listener/listen_tracker.ebpf.c
// bpf_helpers.h uses types defined here
-#include "vmlinux.h"
-
#include <bpf/bpf_helpers.h>
#include "common.h"
+#include "vmlinux.h"
// For some reason 6.1 doesn't include these symbols in the debug build
// so they don't get included in vmlinux.h. These features have existed since
diff --git a/build/debian/port_listener/src/main.cc b/guest/port_listener/src/main.cc
similarity index 99%
rename from build/debian/port_listener/src/main.cc
rename to guest/port_listener/src/main.cc
index b0b0979..1caceaf 100644
--- a/build/debian/port_listener/src/main.cc
+++ b/guest/port_listener/src/main.cc
@@ -18,9 +18,8 @@
#include <bpf/libbpf.h>
#include <bpf/libbpf_legacy.h>
#include <glog/logging.h>
-#include <sys/socket.h>
-
#include <linux/vm_sockets.h> // Needs to come after sys/socket.h
+#include <sys/socket.h>
#include <memory>
#include <unordered_map>
diff --git a/libs/debian_service/Android.bp b/libs/debian_service/Android.bp
new file mode 100644
index 0000000..0495825
--- /dev/null
+++ b/libs/debian_service/Android.bp
@@ -0,0 +1,56 @@
+package {
+ default_applicable_licenses: ["Android-Apache-2.0"],
+}
+
+JAVA_LITE_PROTO_CMD = "mkdir -p $(genDir)/gen && " +
+ "$(location aprotoc) --java_opt=annotate_code=false " +
+ "-Iexternal/protobuf/src " +
+ "-Ipackages/modules/Virtualization/libs/debian_service/proto " +
+ "--plugin=protoc-gen-grpc-java=$(location protoc-gen-grpc-java-plugin) " +
+ "--grpc-java_out=lite:$(genDir)/gen $(in) && " +
+ "$(location soong_zip) -o $(out) -C $(genDir)/gen -D $(genDir)/gen"
+
+java_genrule {
+ name: "debian-service-stub-lite",
+ tools: [
+ "aprotoc",
+ "protoc-gen-grpc-java-plugin",
+ "soong_zip",
+ ],
+ cmd: JAVA_LITE_PROTO_CMD,
+ srcs: [
+ "proto/*.proto",
+ ":libprotobuf-internal-protos",
+ ],
+ out: [
+ "protos.srcjar",
+ ],
+}
+
+java_library {
+ name: "debian-service-grpclib-lite",
+ proto: {
+ type: "lite",
+ include_dirs: [
+ "external/protobuf/src",
+ "external/protobuf/java",
+ ],
+ },
+ srcs: [
+ ":debian-service-stub-lite",
+ "proto/*.proto",
+ ":libprotobuf-internal-protos",
+ ],
+ libs: ["javax_annotation-api_1.3.2"],
+ static_libs: [
+ "libprotobuf-java-lite",
+ "grpc-java-core-android",
+ "grpc-java-okhttp-client-lite",
+ "guava",
+ ],
+ sdk_version: "current",
+ apex_available: [
+ "//apex_available:platform",
+ "com.android.virt",
+ ],
+}
diff --git a/libs/debian_service/proto/DebianService.proto b/libs/debian_service/proto/DebianService.proto
new file mode 100644
index 0000000..5adf615
--- /dev/null
+++ b/libs/debian_service/proto/DebianService.proto
@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2024 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.
+ */
+
+syntax = "proto3";
+
+package com.android.virtualization.vmlauncher.proto;
+
+option java_package = "com.android.virtualization.vmlauncher.proto";
+option java_multiple_files = true;
+
+service DebianService {
+ rpc ReportVmIpAddr (IpAddr) returns (ReportVmIpAddrResponse) {}
+}
+
+message IpAddr {
+ string addr = 1;
+}
+
+message ReportVmIpAddrResponse {
+ bool success = 1;
+}
\ No newline at end of file
diff --git a/libs/vm_launcher_lib/Android.bp b/libs/vm_launcher_lib/Android.bp
index cb6fc9e..5267508 100644
--- a/libs/vm_launcher_lib/Android.bp
+++ b/libs/vm_launcher_lib/Android.bp
@@ -12,6 +12,7 @@
platform_apis: true,
static_libs: [
"gson",
+ "debian-service-grpclib-lite",
],
libs: [
"framework-virtualization.impl",
diff --git a/libs/vm_launcher_lib/java/com/android/virtualization/vmlauncher/DebianServiceImpl.java b/libs/vm_launcher_lib/java/com/android/virtualization/vmlauncher/DebianServiceImpl.java
new file mode 100644
index 0000000..2f7666a
--- /dev/null
+++ b/libs/vm_launcher_lib/java/com/android/virtualization/vmlauncher/DebianServiceImpl.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright (C) 2024 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.
+ */
+
+package com.android.virtualization.vmlauncher;
+
+import android.util.Log;
+
+import com.android.virtualization.vmlauncher.proto.DebianServiceGrpc;
+import com.android.virtualization.vmlauncher.proto.IpAddr;
+import com.android.virtualization.vmlauncher.proto.ReportVmIpAddrResponse;
+
+import io.grpc.stub.StreamObserver;
+
+class DebianServiceImpl extends DebianServiceGrpc.DebianServiceImplBase {
+ public static final String TAG = "DebianService";
+ private final DebianServiceCallback mCallback;
+
+ protected DebianServiceImpl(DebianServiceCallback callback) {
+ super();
+ mCallback = callback;
+ }
+
+ @Override
+ public void reportVmIpAddr(
+ IpAddr request, StreamObserver<ReportVmIpAddrResponse> responseObserver) {
+ Log.d(DebianServiceImpl.TAG, "reportVmIpAddr: " + request.toString());
+ mCallback.onIpAddressAvailable(request.getAddr());
+ ReportVmIpAddrResponse reply = ReportVmIpAddrResponse.newBuilder().setSuccess(true).build();
+ responseObserver.onNext(reply);
+ responseObserver.onCompleted();
+ }
+
+ protected interface DebianServiceCallback {
+ void onIpAddressAvailable(String ipAddr);
+ }
+}
diff --git a/libs/vm_launcher_lib/java/com/android/virtualization/vmlauncher/VmLauncherService.java b/libs/vm_launcher_lib/java/com/android/virtualization/vmlauncher/VmLauncherService.java
index 5e78f99..4cca110 100644
--- a/libs/vm_launcher_lib/java/com/android/virtualization/vmlauncher/VmLauncherService.java
+++ b/libs/vm_launcher_lib/java/com/android/virtualization/vmlauncher/VmLauncherService.java
@@ -22,25 +22,23 @@
import android.app.Service;
import android.content.Intent;
import android.os.Bundle;
-import android.os.Handler;
import android.os.IBinder;
-import android.os.Looper;
-import android.os.ParcelFileDescriptor;
import android.os.ResultReceiver;
import android.system.virtualmachine.VirtualMachine;
import android.system.virtualmachine.VirtualMachineConfig;
import android.system.virtualmachine.VirtualMachineException;
import android.util.Log;
-import java.io.BufferedReader;
-import java.io.FileInputStream;
+import io.grpc.InsecureServerCredentials;
+import io.grpc.Server;
+import io.grpc.okhttp.OkHttpServerBuilder;
+
import java.io.IOException;
-import java.io.InputStreamReader;
import java.nio.file.Path;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
-public class VmLauncherService extends Service {
+public class VmLauncherService extends Service implements DebianServiceImpl.DebianServiceCallback {
private static final String TAG = "VmLauncherService";
// TODO: this path should be from outside of this service
private static final String VM_CONFIG_PATH = "/data/local/tmp/vm_config.json";
@@ -54,6 +52,7 @@
private ExecutorService mExecutorService;
private VirtualMachine mVirtualMachine;
private ResultReceiver mResultReceiver;
+ private Server mServer;
@Override
public IBinder onBind(Intent intent) {
@@ -113,10 +112,9 @@
startForeground();
mResultReceiver.send(RESULT_START, null);
- if (config.getCustomImageConfig().useNetwork()) {
- Handler handler = new Handler(Looper.getMainLooper());
- gatherIpAddrFromVm(handler);
- }
+
+ startDebianServer();
+
return START_NOT_STICKY;
}
@@ -134,6 +132,7 @@
mExecutorService = null;
mVirtualMachine = null;
}
+ stopDebianServer();
}
private boolean isVmRunning() {
@@ -141,34 +140,37 @@
&& mVirtualMachine.getStatus() == VirtualMachine.STATUS_RUNNING;
}
- // TODO(b/359523803): Use AVF API to get ip addr when it exists
- private void gatherIpAddrFromVm(Handler handler) {
- handler.postDelayed(
- () -> {
- if (!isVmRunning()) {
- Log.d(TAG, "A virtual machine instance isn't running");
- return;
- }
- int INTERNAL_VSOCK_SERVER_PORT = 1024;
- try (ParcelFileDescriptor pfd =
- mVirtualMachine.connectVsock(INTERNAL_VSOCK_SERVER_PORT)) {
- try (BufferedReader input =
- new BufferedReader(
- new InputStreamReader(
- new FileInputStream(pfd.getFileDescriptor())))) {
- String vmIpAddr = input.readLine().strip();
- Bundle b = new Bundle();
- b.putString(KEY_VM_IP_ADDR, vmIpAddr);
- mResultReceiver.send(RESULT_IPADDR, b);
- return;
- } catch (IOException e) {
- Log.e(TAG, e.toString());
- }
- } catch (Exception e) {
- Log.e(TAG, e.toString());
- }
- gatherIpAddrFromVm(handler);
- },
- 1000);
+ private void startDebianServer() {
+ new Thread(
+ () -> {
+ // TODO(b/372666638): gRPC for java doesn't support vsock for now.
+ // In addition, let's consider using a dynamic port and SSL(and client
+ // certificate)
+ int port = 12000;
+ try {
+ mServer =
+ OkHttpServerBuilder.forPort(
+ port, InsecureServerCredentials.create())
+ .addService(new DebianServiceImpl(this))
+ .build()
+ .start();
+ } catch (IOException e) {
+ Log.d(TAG, "grpc server error", e);
+ }
+ })
+ .start();
+ }
+
+ private void stopDebianServer() {
+ if (mServer != null) {
+ mServer.shutdown();
+ }
+ }
+
+ @Override
+ public void onIpAddressAvailable(String ipAddr) {
+ Bundle b = new Bundle();
+ b.putString(VmLauncherService.KEY_VM_IP_ADDR, ipAddr);
+ mResultReceiver.send(VmLauncherService.RESULT_IPADDR, b);
}
}