Gitiles
Code Review Sign In
gerrit.omnirom.org / android_packages_modules_Virtualization / 93d85cd0254592560feae087642c6862d817ac81 / . / java / framework / api / system-current.txt
blob: d9bafa1ffcda0a70731e817864ff5cb48ef245a0 [file] [log] [blame]
Jiyong Park9b8253b2021-06-28 18:37:26 +0900[diff] [blame]1// Signature format: 2.0
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]2package android.system.virtualmachine {
3
4 public class VirtualMachine implements java.lang.AutoCloseable {
5 method public void clearCallback();
Alan Stokes3afd9f92023-01-04 17:28:59 +0000[diff] [blame]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;
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]12 method @NonNull public String getName();
Alan Stokes3afd9f92023-01-04 17:28:59 +0000[diff] [blame]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;
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]15 method public void setCallback(@NonNull java.util.concurrent.Executor, @NonNull android.system.virtualmachine.VirtualMachineCallback);
Alan Stokes3afd9f92023-01-04 17:28:59 +0000[diff] [blame]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;
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]19 field public static final String MANAGE_VIRTUAL_MACHINE_PERMISSION = "android.permission.MANAGE_VIRTUAL_MACHINE";
Alan Stokes10c47672022-12-13 17:17:08 +0000[diff] [blame]20 field public static final long MAX_VSOCK_PORT = 4294967295L; // 0xffffffffL
21 field public static final long MIN_VSOCK_PORT = 1024L; // 0x400L
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]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);
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]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 +0100[diff] [blame]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
Alan Stokes7c459e82022-12-06 12:21:49 +0000[diff] [blame]53 field public static final int STOP_REASON_START_FAILED = 4; // 0x4
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]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 {
Alan Stokes9bffc3b2023-01-25 09:45:54 +0000[diff] [blame]59 method @Nullable public String getApkPath();
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000[diff] [blame]60 method public int getCpuTopology();
61 method public int getDebugLevel();
Alan Stokesff0005f2023-01-30 09:53:00 +0000[diff] [blame]62 method @IntRange(from=0) public long getEncryptedStorageBytes();
Alan Stokes9a411dc2023-01-30 17:54:07 +0000[diff] [blame]63 method @IntRange(from=0) public long getMemoryBytes();
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000[diff] [blame]64 method @Nullable public String getPayloadBinaryName();
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]65 method public boolean isCompatibleWith(@NonNull android.system.virtualmachine.VirtualMachineConfig);
Shikha Panwara2ff8c52022-11-30 19:25:46 +0000[diff] [blame]66 method public boolean isEncryptedStorageEnabled();
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]67 method public boolean isProtectedVm();
Inseob Kim8961f102022-12-22 15:29:55 +0900[diff] [blame]68 method public boolean isVmOutputCaptured();
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000[diff] [blame]69 field public static final int CPU_TOPOLOGY_MATCH_HOST = 1; // 0x1
70 field public static final int CPU_TOPOLOGY_ONE_CPU = 0; // 0x0
Seungjae Yoofa22bb02022-12-08 16:38:42 +0900[diff] [blame]71 field public static final int DEBUG_LEVEL_FULL = 1; // 0x1
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]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);
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000[diff] [blame]79 method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setCpuTopology(int);
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]80 method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setDebugLevel(int);
Alan Stokesff0005f2023-01-30 09:53:00 +0000[diff] [blame]81 method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setEncryptedStorageBytes(@IntRange(from=1) long);
Alan Stokes9a411dc2023-01-30 17:54:07 +0000[diff] [blame]82 method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setMemoryBytes(@IntRange(from=1) long);
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000[diff] [blame]83 method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setPayloadBinaryName(@NonNull String);
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]84 method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setProtectedVm(boolean);
Inseob Kim8961f102022-12-22 15:29:55 +0900[diff] [blame]85 method @NonNull public android.system.virtualmachine.VirtualMachineConfig.Builder setVmOutputCaptured(boolean);
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]86 }
87
Alan Stokesa270d692023-02-15 14:07:21 +0000[diff] [blame]88 public final class VirtualMachineDescriptor implements java.lang.AutoCloseable android.os.Parcelable {
89 method public void close();
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]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 {
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]96 }
97
98 public class VirtualMachineManager {
Alan Stokes3afd9f92023-01-04 17:28:59 +0000[diff] [blame]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;
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]102 method public int getCapabilities();
Alan Stokes3afd9f92023-01-04 17:28:59 +0000[diff] [blame]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;
Alan Stokesca0d27e2022-10-03 11:26:13 +0100[diff] [blame]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