Jump to content

Anbox: Difference between revisions

From postmarketOS Wiki
Ichernev (talk | contribs)
Nergzd723 (talk | contribs)
add porting guide
Line 2: Line 2:
{{note|Development on this feature can be done without running pmOS on a real device with [[QEMU]]. Please use the lts kernel for that as the virt kernel doesn't include the necessary modules.}}
{{note|Development on this feature can be done without running pmOS on a real device with [[QEMU]]. Please use the lts kernel for that as the virt kernel doesn't include the necessary modules.}}
{{note|Anbox is currently somewhat broken on armv7 because Anbox assumes 64 bits in some places, which breaks input (see https://github.com/anbox/anbox/issues/1214#issuecomment-524578664. Please manifest yourself if you can test and try that)}}
{{note|Anbox is currently somewhat broken on armv7 because Anbox assumes 64 bits in some places, which breaks input (see https://github.com/anbox/anbox/issues/1214#issuecomment-524578664. Please manifest yourself if you can test and try that)}}
{{note|Works only on kernels with DRI support, see [[Mainlining Guide]].}}


[[File:Anbox_app_manager.png|thumb|The anbox application manager with the default apps.]]
[[File:Anbox_app_manager.png|thumb|The anbox application manager with the default apps.]]
Line 16: Line 17:
== Porting ==
== Porting ==


If Anbox have never been working on you device, you may have to add kernel support for it. Use <code>pmbootstrap kconfig check --anbox</code> (from
=== Requirements ===
{{MR|1916}}) to check.


You need a few things to get started with porting Anbox support to your device:
* '''device with mainline postmarketOS kernel support'''
Since Anbox require DRI to function, you need mainline kernel to get it to work.
* '''Linux environment'''
pmbootstrap needs Linux environment to function, and porting process may also require rebuilding the kernel.
=== Checking defconfig ===
First, you need to know which kernel package does your device use to perform a kconfig check(replace wiki-example with your actual device codename):
<syntaxhighlight lang="shell-session">
$ cd $(pmbootstrap config aports)
$ cat device/testing/device-wiki-example/APKBUILD | grep linux
</syntaxhighlight>
The output of the last command will be like this: <code>depends="'''linux-postmarketos-wiki-example''' mesa-git-dri-gallium"</code>. Your mainline Linux package name will be similar to the highlighted sample one.
Then you need to verify the defconfig with pmbootstrap to make sure all the kernel modules Anbox require will be installed(replace linux-postmarketos-wiki-example with actual kernel package name).
<syntaxhighlight lang="shell-session">
$ pmbootstrap kconfig check --anbox linux-postmarketos-wiki-example
</syntaxhighlight>
If the check was successful, pmbootstrap will output <code>kconfig check succeeded!</code>. If the check is successful, you can install the postmarketos-anbox package and run <code>anbox-launch</code> to start Anbox.
If some checks failed, you need to rebuild the kernel package with updated defconfig. Update the defconfig so <code>pmbootstrap kconfig check --anbox</code> command will output <code>kconfig check succeeded!</code>.
=== Updating defconfig ===
First, you need to bump pkgrel of your kernel package:
<syntaxhighlight lang="shell-session">
$ pmbootstrap pkgrel_bump linux-postmarketos-wiki-example
</syntaxhighlight>
Then, use <code>pmbootstrap kconfig edit linux-postmarketos-wiki-example</code> to edit the defconfig. You can browse the options menu with arrow keys and select options with Space key. You can also search your needed kconfig option with "/" button.
Once done, close the menuconfig with exit button on bottom. pmbootstrap will update your kernel defconfig and you'll be able to build the kernel.
Try building the kernel with <code>pmbootstrap build linux-postmarketos-wiki-example</code>. If build succeeds, flash the kernel into your device <code>pmbootstrap install && pmbootstrap flasher flash_kernel</code>, and install Anbox.


== Troubleshooting ==
== Troubleshooting ==

Revision as of 15:39, 9 July 2020

Note Consider using native Linux programs instead, see FAQ.
Note Development on this feature can be done without running pmOS on a real device with QEMU. Please use the lts kernel for that as the virt kernel doesn't include the necessary modules.
Note Anbox is currently somewhat broken on armv7 because Anbox assumes 64 bits in some places, which breaks input (see https://github.com/anbox/anbox/issues/1214#issuecomment-524578664. Please manifest yourself if you can test and try that)
Note Works only on kernels with DRI support, see Mainlining Guide.
The anbox application manager with the default apps.

Anbox runs Android apps on Linux using a trimmed down version of Android in a container. Anbox allows one to use Android applications sandboxed, running alongside the native Linux programs. It can be very handy to help people switch from Android to an operating that respects their privacy.

See milestone#7 for current progress.

Installation

Install the postmarketos-anbox package. Launch using anbox-launch or the icon launcher.


Porting

Requirements

You need a few things to get started with porting Anbox support to your device:

  • device with mainline postmarketOS kernel support

Since Anbox require DRI to function, you need mainline kernel to get it to work.

  • Linux environment

pmbootstrap needs Linux environment to function, and porting process may also require rebuilding the kernel.

Checking defconfig

First, you need to know which kernel package does your device use to perform a kconfig check(replace wiki-example with your actual device codename):

$ cd $(pmbootstrap config aports)
$ cat device/testing/device-wiki-example/APKBUILD | grep linux

The output of the last command will be like this: depends="linux-postmarketos-wiki-example mesa-git-dri-gallium". Your mainline Linux package name will be similar to the highlighted sample one.

Then you need to verify the defconfig with pmbootstrap to make sure all the kernel modules Anbox require will be installed(replace linux-postmarketos-wiki-example with actual kernel package name).

$ pmbootstrap kconfig check --anbox linux-postmarketos-wiki-example

If the check was successful, pmbootstrap will output kconfig check succeeded!. If the check is successful, you can install the postmarketos-anbox package and run anbox-launch to start Anbox.

If some checks failed, you need to rebuild the kernel package with updated defconfig. Update the defconfig so pmbootstrap kconfig check --anbox command will output kconfig check succeeded!.

Updating defconfig

First, you need to bump pkgrel of your kernel package:

$ pmbootstrap pkgrel_bump linux-postmarketos-wiki-example

Then, use pmbootstrap kconfig edit linux-postmarketos-wiki-example to edit the defconfig. You can browse the options menu with arrow keys and select options with Space key. You can also search your needed kconfig option with "/" button.

Once done, close the menuconfig with exit button on bottom. pmbootstrap will update your kernel defconfig and you'll be able to build the kernel.

Try building the kernel with pmbootstrap build linux-postmarketos-wiki-example. If build succeeds, flash the kernel into your device pmbootstrap install && pmbootstrap flasher flash_kernel, and install Anbox.

Troubleshooting

I don't have access to the internet

Anbox require an anbox0 bridge interface to access the internet. ip link should report an anbox0 interface for the network to work. There seem to be some kind of kernel requirement too, see pmaports#480 (contains workaround) for the investigation about that.

When I start Anbox, it complains about DBus

[daemon.cpp:61@Run] Failed to request DBus service name means dbus isn't running, or that you launched it incorrectly (check environment variables are set with env). Ensure you start dbus with your session and that you are not starting Anbox with ssh.


Serious Debugging

If you never see the application manager, there can be plenty of problems. The first step to debug this is knowing roughly where it fails.

Check the openRC service

rc-service anbox-container-manager status will give you the state of the container manager. If it reports to be stopped despite your attempts to start it, then the container manager exited. Tell me that the container manager doesn't run in a bug report and include /var/lib/anbox/logs/container.log.

Check if the container is up

If the container manager runs, it doesn't necessarily means the container android runs in is started. To check if the container is up and running, you can try two things can give interesting clues:

using anbox session-manager
check what it answers when you run it. Failed to start container is a pretty obvious way to tell the container doesn't run; but sometimes the session manager will segfault instead. You usually can still tell if container is started.
using /var/lib/anbox/logs/container.log
the file will (hopefully) contain a non-empty log. Look for Received container state "ABORTING" instead of "RUNNING" or Set container state to "STOPPED".

In this case, tell me in a bug report that the container itself doesn't run and include /var/lib/anbox/logs/container.log.

Check if adb works

Install android-tools and run adb shell. If you do have a shell, that's great, Android at least started to start. If adb answers you that no devices/emulators are found and the container is running, then tell me in a bug report that adb couldn't find the device and include /var/lib/anbox/logs/console.log.

Check if adb install works

Download an apk, for example the F-Droid one and try to install it. For example, adb install Dowloads/FDroid.apk. If this doesn't work, then Zygote probably didn't start. If you can get a shell, but can't install an app with adb, tell me in a bug report that adb install doesn't work and include /var/lib/anbox/logs/console.log.

If adb install works, congratulations, we have only got Anbox to run that far once or twice so far. Please still open an issue if you don't get the anbox application manager to show up, including /var/lib/anbox/logs/console.log.