blob: fb7c98c480015b75006de3ebcad09d21cd1cd9d7 [file] [log] [blame]
Jiyong Park9b8253b2021-06-28 18:37:26 +09001// Signature format: 2.0
Alan Stokesca0d27e2022-10-03 11:26:13 +01002package android.system.virtualmachine {
3
4 public class VirtualMachine implements java.lang.AutoCloseable {
5 method public void clearCallback();
Alan Stokesa4e2a4a2022-11-28 12:04:39 +00006 method public void close();
Alan Stokesca0d27e2022-10-03 11:26:13 +01007 method @NonNull public android.os.IBinder connectToVsockServer(int) throws android.system.virtualmachine.VirtualMachineException;
8 method @NonNull public android.os.ParcelFileDescriptor connectVsock(int) throws android.system.virtualmachine.VirtualMachineException;
9 method public int getCid() throws android.system.virtualmachine.VirtualMachineException;
10 method @NonNull public android.system.virtualmachine.VirtualMachineConfig getConfig();
11 method @NonNull public java.io.InputStream getConsoleOutput() throws android.system.virtualmachine.VirtualMachineException;
12 method @NonNull public java.io.InputStream getLogOutput() throws android.system.virtualmachine.VirtualMachineException;
13 method @NonNull public String getName();
14 method public int getStatus();
15 method @RequiresPermission(android.system.virtualmachine.VirtualMachine.MANAGE_VIRTUAL_MACHINE_PERMISSION) public void run() throws android.system.virtualmachine.VirtualMachineException;
16 method public void setCallback(@NonNull java.util.concurrent.Executor, @NonNull android.system.virtualmachine.VirtualMachineCallback);
17 method @NonNull public android.system.virtualmachine.VirtualMachineConfig setConfig(@NonNull android.system.virtualmachine.VirtualMachineConfig) throws android.system.virtualmachine.VirtualMachineException;
18 method public void stop() throws android.system.virtualmachine.VirtualMachineException;
19 method @NonNull public android.system.virtualmachine.VirtualMachineDescriptor toDescriptor() throws android.system.virtualmachine.VirtualMachineException;
20 field public static final String MANAGE_VIRTUAL_MACHINE_PERMISSION = "android.permission.MANAGE_VIRTUAL_MACHINE";
21 field public static final int STATUS_DELETED = 2; // 0x2
22 field public static final int STATUS_RUNNING = 1; // 0x1
23 field public static final int STATUS_STOPPED = 0; // 0x0
24 field public static final String USE_CUSTOM_VIRTUAL_MACHINE_PERMISSION = "android.permission.USE_CUSTOM_VIRTUAL_MACHINE";
25 }
26
27 public interface VirtualMachineCallback {
28 method public void onError(@NonNull android.system.virtualmachine.VirtualMachine, int, @NonNull String);
29 method public void onPayloadFinished(@NonNull android.system.virtualmachine.VirtualMachine, int);
30 method public void onPayloadReady(@NonNull android.system.virtualmachine.VirtualMachine);
31 method public void onPayloadStarted(@NonNull android.system.virtualmachine.VirtualMachine);
32 method public void onRamdump(@NonNull android.system.virtualmachine.VirtualMachine, @NonNull android.os.ParcelFileDescriptor);
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
Alan Stokesca0d27e2022-10-03 11:26:13 +010041 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
Alan Stokes7c459e82022-12-06 12:21:49 +000053 field public static final int STOP_REASON_START_FAILED = 4; // 0x4
Alan Stokesca0d27e2022-10-03 11:26:13 +010054 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 @NonNull public String getApkPath();
60 method @NonNull public int getDebugLevel();
61 method @IntRange(from=0) public int getMemoryMib();
62 method @IntRange(from=1) public int getNumCpus();
63 method @Nullable public String getPayloadBinaryPath();
Alan Stokesca0d27e2022-10-03 11:26:13 +010064 method public boolean isCompatibleWith(@NonNull android.system.virtualmachine.VirtualMachineConfig);
65 method public boolean isProtectedVm();
Seungjae Yoofa22bb02022-12-08 16:38:42 +090066 field public static final int DEBUG_LEVEL_FULL = 1; // 0x1
Alan Stokesca0d27e2022-10-03 11:26:13 +010067 field public static final int DEBUG_LEVEL_NONE = 0; // 0x0
68 }
69
70 public static final class VirtualMachineConfig.Builder {
71 ctor public VirtualMachineConfig.Builder(@NonNull android.content.Context);
72 method @NonNull public android.system.virtualmachine.VirtualMachineConfig build();
73 method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setApkPath(@NonNull String);
74 method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setDebugLevel(int);
75 method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setMemoryMib(@IntRange(from=0) int);
76 method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setNumCpus(@IntRange(from=1) int);
77 method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setPayloadBinaryPath(@NonNull String);
Alan Stokesca0d27e2022-10-03 11:26:13 +010078 method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setProtectedVm(boolean);
79 }
80
81 public final class VirtualMachineDescriptor implements android.os.Parcelable {
82 method public int describeContents();
83 method public void writeToParcel(@NonNull android.os.Parcel, int);
84 field @NonNull public static final android.os.Parcelable.Creator<android.system.virtualmachine.VirtualMachineDescriptor> CREATOR;
85 }
86
87 public class VirtualMachineException extends java.lang.Exception {
88 ctor public VirtualMachineException(@Nullable String);
89 ctor public VirtualMachineException(@Nullable String, @Nullable Throwable);
90 ctor public VirtualMachineException(@Nullable Throwable);
91 }
92
93 public class VirtualMachineManager {
94 method @NonNull @RequiresPermission(android.system.virtualmachine.VirtualMachine.MANAGE_VIRTUAL_MACHINE_PERMISSION) public android.system.virtualmachine.VirtualMachine create(@NonNull String, @NonNull android.system.virtualmachine.VirtualMachineConfig) throws android.system.virtualmachine.VirtualMachineException;
95 method public void delete(@NonNull String) throws android.system.virtualmachine.VirtualMachineException;
96 method @Nullable public android.system.virtualmachine.VirtualMachine get(@NonNull String) throws android.system.virtualmachine.VirtualMachineException;
97 method public int getCapabilities();
Alan Stokesca0d27e2022-10-03 11:26:13 +010098 method @NonNull public android.system.virtualmachine.VirtualMachine getOrCreate(@NonNull String, @NonNull android.system.virtualmachine.VirtualMachineConfig) throws android.system.virtualmachine.VirtualMachineException;
99 method @NonNull public android.system.virtualmachine.VirtualMachine importFromDescriptor(@NonNull String, @NonNull android.system.virtualmachine.VirtualMachineDescriptor) throws android.system.virtualmachine.VirtualMachineException;
100 field public static final int CAPABILITY_NON_PROTECTED_VM = 2; // 0x2
101 field public static final int CAPABILITY_PROTECTED_VM = 1; // 0x1
102 }
103
104}
105