xref: /aosp_15_r20/prebuilts/sdk/35/system/api/framework-virtualization.txt (revision 344a7f5ef16c479e7a7f54ee6567a9d112f9e72b) 
1// Signature format: 2.0
2package android.system.virtualmachine {
3
4  public class VirtualMachine implements java.lang.AutoCloseable {
5    method public void clearCallback();
6    method @WorkerThread public void close();
7    method @NonNull @WorkerThread public android.os.IBinder connectToVsockServer(@IntRange(from=android.system.virtualmachine.VirtualMachine.MIN_VSOCK_PORT, to=android.system.virtualmachine.VirtualMachine.MAX_VSOCK_PORT) long) throws android.system.virtualmachine.VirtualMachineException;
8    method @NonNull @WorkerThread public android.os.ParcelFileDescriptor connectVsock(@IntRange(from=android.system.virtualmachine.VirtualMachine.MIN_VSOCK_PORT, to=android.system.virtualmachine.VirtualMachine.MAX_VSOCK_PORT) long) throws android.system.virtualmachine.VirtualMachineException;
9    method @NonNull @WorkerThread public android.system.virtualmachine.VirtualMachineConfig getConfig();
10    method @NonNull @WorkerThread public java.io.InputStream getConsoleOutput() throws android.system.virtualmachine.VirtualMachineException;
11    method @NonNull @WorkerThread public java.io.InputStream getLogOutput() throws android.system.virtualmachine.VirtualMachineException;
12    method @NonNull public String getName();
13    method @WorkerThread public int getStatus();
14    method @RequiresPermission(android.system.virtualmachine.VirtualMachine.MANAGE_VIRTUAL_MACHINE_PERMISSION) @WorkerThread public void run() throws android.system.virtualmachine.VirtualMachineException;
15    method public void setCallback(@NonNull java.util.concurrent.Executor, @NonNull android.system.virtualmachine.VirtualMachineCallback);
16    method @NonNull @WorkerThread public android.system.virtualmachine.VirtualMachineConfig setConfig(@NonNull android.system.virtualmachine.VirtualMachineConfig) throws android.system.virtualmachine.VirtualMachineException;
17    method @WorkerThread public void stop() throws android.system.virtualmachine.VirtualMachineException;
18    method @NonNull @WorkerThread public android.system.virtualmachine.VirtualMachineDescriptor toDescriptor() throws android.system.virtualmachine.VirtualMachineException;
19    field public static final String MANAGE_VIRTUAL_MACHINE_PERMISSION = "android.permission.MANAGE_VIRTUAL_MACHINE";
20    field public static final long MAX_VSOCK_PORT = 4294967295L; // 0xffffffffL
21    field public static final long MIN_VSOCK_PORT = 1024L; // 0x400L
22    field public static final int STATUS_DELETED = 2; // 0x2
23    field public static final int STATUS_RUNNING = 1; // 0x1
24    field public static final int STATUS_STOPPED = 0; // 0x0
25    field public static final String USE_CUSTOM_VIRTUAL_MACHINE_PERMISSION = "android.permission.USE_CUSTOM_VIRTUAL_MACHINE";
26  }
27
28  public interface VirtualMachineCallback {
29    method public void onError(@NonNull android.system.virtualmachine.VirtualMachine, int, @NonNull String);
30    method public void onPayloadFinished(@NonNull android.system.virtualmachine.VirtualMachine, int);
31    method public void onPayloadReady(@NonNull android.system.virtualmachine.VirtualMachine);
32    method public void onPayloadStarted(@NonNull android.system.virtualmachine.VirtualMachine);
33    method public void onStopped(@NonNull android.system.virtualmachine.VirtualMachine, int);
34    field public static final int ERROR_PAYLOAD_CHANGED = 2; // 0x2
35    field public static final int ERROR_PAYLOAD_INVALID_CONFIG = 3; // 0x3
36    field public static final int ERROR_PAYLOAD_VERIFICATION_FAILED = 1; // 0x1
37    field public static final int ERROR_UNKNOWN = 0; // 0x0
38    field public static final int STOP_REASON_BOOTLOADER_INSTANCE_IMAGE_CHANGED = 10; // 0xa
39    field public static final int STOP_REASON_BOOTLOADER_PUBLIC_KEY_MISMATCH = 9; // 0x9
40    field public static final int STOP_REASON_CRASH = 6; // 0x6
41    field public static final int STOP_REASON_HANGUP = 16; // 0x10
42    field public static final int STOP_REASON_INFRASTRUCTURE_ERROR = 0; // 0x0
43    field public static final int STOP_REASON_KILLED = 1; // 0x1
44    field public static final int STOP_REASON_MICRODROID_FAILED_TO_CONNECT_TO_VIRTUALIZATION_SERVICE = 11; // 0xb
45    field public static final int STOP_REASON_MICRODROID_INVALID_PAYLOAD_CONFIG = 14; // 0xe
46    field public static final int STOP_REASON_MICRODROID_PAYLOAD_HAS_CHANGED = 12; // 0xc
47    field public static final int STOP_REASON_MICRODROID_PAYLOAD_VERIFICATION_FAILED = 13; // 0xd
48    field public static final int STOP_REASON_MICRODROID_UNKNOWN_RUNTIME_ERROR = 15; // 0xf
49    field public static final int STOP_REASON_PVM_FIRMWARE_INSTANCE_IMAGE_CHANGED = 8; // 0x8
50    field public static final int STOP_REASON_PVM_FIRMWARE_PUBLIC_KEY_MISMATCH = 7; // 0x7
51    field public static final int STOP_REASON_REBOOT = 5; // 0x5
52    field public static final int STOP_REASON_SHUTDOWN = 3; // 0x3
53    field public static final int STOP_REASON_START_FAILED = 4; // 0x4
54    field public static final int STOP_REASON_UNKNOWN = 2; // 0x2
55    field public static final int STOP_REASON_VIRTUALIZATION_SERVICE_DIED = -1; // 0xffffffff
56  }
57
58  public final class VirtualMachineConfig {
59    method @Nullable public String getApkPath();
60    method public int getCpuTopology();
61    method public int getDebugLevel();
62    method @IntRange(from=0) public long getEncryptedStorageBytes();
63    method @IntRange(from=0) public long getMemoryBytes();
64    method @Nullable public String getPayloadBinaryName();
65    method public boolean isCompatibleWith(@NonNull android.system.virtualmachine.VirtualMachineConfig);
66    method public boolean isEncryptedStorageEnabled();
67    method public boolean isProtectedVm();
68    method public boolean isVmOutputCaptured();
69    field public static final int CPU_TOPOLOGY_MATCH_HOST = 1; // 0x1
70    field public static final int CPU_TOPOLOGY_ONE_CPU = 0; // 0x0
71    field public static final int DEBUG_LEVEL_FULL = 1; // 0x1
72    field public static final int DEBUG_LEVEL_NONE = 0; // 0x0
73  }
74
75  public static final class VirtualMachineConfig.Builder {
76    ctor public VirtualMachineConfig.Builder(@NonNull android.content.Context);
77    method @NonNull public android.system.virtualmachine.VirtualMachineConfig build();
78    method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setApkPath(@NonNull String);
79    method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setCpuTopology(int);
80    method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setDebugLevel(int);
81    method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setEncryptedStorageBytes(@IntRange(from=1) long);
82    method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setMemoryBytes(@IntRange(from=1) long);
83    method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setPayloadBinaryName(@NonNull String);
84    method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setProtectedVm(boolean);
85    method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setVmOutputCaptured(boolean);
86  }
87
88  public final class VirtualMachineDescriptor implements java.lang.AutoCloseable android.os.Parcelable {
89    method public void close();
90    method public int describeContents();
91    method public void writeToParcel(@NonNull android.os.Parcel, int);
92    field @NonNull public static final android.os.Parcelable.Creator<android.system.virtualmachine.VirtualMachineDescriptor> CREATOR;
93  }
94
95  public class VirtualMachineException extends java.lang.Exception {
96  }
97
98  public class VirtualMachineManager {
99    method @NonNull @RequiresPermission(android.system.virtualmachine.VirtualMachine.MANAGE_VIRTUAL_MACHINE_PERMISSION) @WorkerThread public android.system.virtualmachine.VirtualMachine create(@NonNull String, @NonNull android.system.virtualmachine.VirtualMachineConfig) throws android.system.virtualmachine.VirtualMachineException;
100    method @WorkerThread public void delete(@NonNull String) throws android.system.virtualmachine.VirtualMachineException;
101    method @Nullable @WorkerThread public android.system.virtualmachine.VirtualMachine get(@NonNull String) throws android.system.virtualmachine.VirtualMachineException;
102    method public int getCapabilities();
103    method @NonNull @WorkerThread public android.system.virtualmachine.VirtualMachine getOrCreate(@NonNull String, @NonNull android.system.virtualmachine.VirtualMachineConfig) throws android.system.virtualmachine.VirtualMachineException;
104    method @NonNull @WorkerThread public android.system.virtualmachine.VirtualMachine importFromDescriptor(@NonNull String, @NonNull android.system.virtualmachine.VirtualMachineDescriptor) throws android.system.virtualmachine.VirtualMachineException;
105    field public static final int CAPABILITY_NON_PROTECTED_VM = 2; // 0x2
106    field public static final int CAPABILITY_PROTECTED_VM = 1; // 0x1
107  }
108
109}
110
111