tools/helpers/lxc.py

   1 # Copyright 2021 Erfan Abdi
   2 # SPDX-License-Identifier: GPL-3.0-or-later
   3 import subprocess
   4 import os
   5 import re
   6 import logging
   7 import glob
   8 import shutil
   9 import time
  10 import platform
  11 import gbinder
  12 import tools.config
  13 import tools.helpers.run
  14
  15
  16 def get_lxc_version(args):
  17     if shutil.which("lxc-info") is not None:
  18         command = ["lxc-info", "--version"]
  19         version_str = tools.helpers.run.user(args, command, output_return=True)
  20         return int(version_str[0])
  21     else:
  22         return 0
  23
  24
  25 def generate_nodes_lxc_config(args):
  26     def make_entry(src, dist=None, mnt_type="none", options="bind,create=file,optional 0 0", check=True):
  27         if check and not os.path.exists(src):
  28             return False
  29         entry = "lxc.mount.entry = "
  30         entry += src + " "
  31         if dist is None:
  32             dist = src[1:]
  33         entry += dist + " "
  34         entry += mnt_type + " "
  35         entry += options
  36         nodes.append(entry)
  37         return True
  38
  39     nodes = []
  40     # Necessary dev nodes
  41     make_entry("tmpfs", "dev", "tmpfs", "nosuid 0 0", False)
  42     make_entry("/dev/zero")
  43     make_entry("/dev/null")
  44     make_entry("/dev/full")
  45     make_entry("/dev/ashmem")
  46     make_entry("/dev/fuse")
  47     make_entry("/dev/ion")
  48     make_entry("/dev/char", options="bind,create=dir,optional 0 0")
  49
  50     # Graphic dev nodes
  51     make_entry("/dev/kgsl-3d0")
  52     make_entry("/dev/mali0")
  53     make_entry("/dev/pvr_sync")
  54     make_entry("/dev/pmsg0")
  55     make_entry("/dev/dxg")
  56     render, card = tools.helpers.gpu.getDriNode(args)
  57     make_entry(render, "dev/dri/renderD128")
  58     make_entry(card, "dev/dri/card0")
  59
  60     for n in glob.glob("/dev/fb*"):
  61         make_entry(n)
  62     for n in glob.glob("/dev/graphics/fb*"):
  63         make_entry(n)
  64     for n in glob.glob("/dev/video*"):
  65         make_entry(n)
  66
  67     # Binder dev nodes
  68     make_entry("/dev/" + args.BINDER_DRIVER, "dev/binder", check=False)
  69     make_entry("/dev/" + args.VNDBINDER_DRIVER, "dev/vndbinder", check=False)
  70     make_entry("/dev/" + args.HWBINDER_DRIVER, "dev/hwbinder", check=False)
  71
  72     if args.vendor_type != "MAINLINE":
  73         if not make_entry("/dev/hwbinder", "dev/host_hwbinder"):
  74             raise OSError('Binder node "hwbinder" of host not found')
  75         make_entry("/vendor", "vendor_extra", options="bind,optional 0 0")
  76
  77     # Necessary device nodes for adb
  78     make_entry("none", "dev/pts", "devpts", "defaults,mode=644,ptmxmode=666,create=dir 0 0", False)
  79     make_entry("/dev/uhid")
  80
  81     # TUN/TAP device node for VPN
  82     make_entry("/dev/net/tun", "dev/tun")
  83
  84     # Low memory killer sys node
  85     make_entry("/sys/module/lowmemorykiller", options="bind,create=dir,optional 0 0")
  86
  87     # Mount /data
  88     make_entry("tmpfs", "mnt", "tmpfs", "mode=0755,uid=0,gid=1000", False)
  89     make_entry(tools.config.defaults["data"], "data", options="bind 0 0", check=False)
  90
  91     # Mount host permissions
  92     make_entry(tools.config.defaults["host_perms"],
  93                "vendor/etc/host-permissions", options="bind,optional 0 0")
  94
  95     # Recursive mount /run to provide necessary host sockets
  96     make_entry("/run", options="rbind,create=dir 0 0")
  97     # And /dev/shm
  98     make_entry("/dev/shm", options="rbind,create=dir,optional 0 0")
  99
 100     # Necessary sw_sync node for HWC
 101     make_entry("/dev/sw_sync")
 102     make_entry("/sys/kernel/debug", options="rbind,create=dir,optional 0 0")
 103
 104     # Vibrator
 105     make_entry("/sys/class/leds/vibrator",
 106                options="bind,create=dir,optional 0 0")
 107     make_entry("/sys/devices/virtual/timed_output/vibrator",
 108                options="bind,create=dir,optional 0 0")
 109
 110     # Media dev nodes (for Mediatek)
 111     make_entry("/dev/Vcodec")
 112     make_entry("/dev/MTK_SMI")
 113     make_entry("/dev/mdp_sync")
 114     make_entry("/dev/mtk_cmdq")
 115
 116     # WSLg
 117     make_entry("tmpfs", "mnt_extra", "tmpfs", "nodev 0 0", False)
 118     make_entry("/mnt/wslg", "mnt_extra/wslg",
 119                options="rbind,create=dir,optional 0 0")
 120
 121     # var
 122     make_entry("tmpfs", "var", "tmpfs", "nodev 0 0", False)
 123     make_entry("/var/run", options="rbind,create=dir,optional 0 0")
 124
 125     # tmp
 126     make_entry("tmpfs", "tmp", "tmpfs", "nodev 0 0", False)
 127     for n in glob.glob("/tmp/run-*"):
 128         make_entry(n, options="rbind,create=dir,optional 0 0")
 129
 130     # NFC config
 131     make_entry("/system/etc/libnfc-nci.conf", options="bind,optional 0 0")
 132
 133     return nodes
 134
 135 LXC_APPARMOR_PROFILE = "lxc-waydroid"
 136 def get_apparmor_status(args):
 137     enabled = False
 138     if shutil.which("aa-enabled"):
 139         enabled = (tools.helpers.run.user(args, ["aa-enabled", "--quiet"], check=False) == 0)
 140     if not enabled and shutil.which("systemctl"):
 141         enabled = (tools.helpers.run.user(args, ["systemctl", "is-active", "-q", "apparmor"], check=False) == 0)
 142     try:
 143         with open("/sys/kernel/security/apparmor/profiles", "r") as f:
 144             enabled &= (LXC_APPARMOR_PROFILE in f.read())
 145     except:
 146         enabled = False
 147     return enabled
 148
 149 def set_lxc_config(args):
 150     lxc_path = tools.config.defaults["lxc"] + "/waydroid"
 151     lxc_ver = get_lxc_version(args)
 152     if lxc_ver == 0:
 153         raise OSError("LXC is not installed")
 154     config_paths = tools.config.tools_src + "/data/configs/config_"
 155     seccomp_profile = tools.config.tools_src + "/data/configs/waydroid.seccomp"
 156
 157     config_snippets = [ config_paths + "base" ]
 158     # lxc v1 and v2 are bit special because some options got renamed later
 159     if lxc_ver <= 2:
 160         config_snippets.append(config_paths + "1")
 161     else:
 162         for ver in range(3, 5):
 163             snippet = config_paths + str(ver)
 164             if lxc_ver >= ver and os.path.exists(snippet):
 165                 config_snippets.append(snippet)
 166
 167     command = ["mkdir", "-p", lxc_path]
 168     tools.helpers.run.user(args, command)
 169     command = ["sh", "-c", "cat {} > \"{}\"".format(' '.join('"{0}"'.format(w) for w in config_snippets), lxc_path + "/config")]
 170     tools.helpers.run.user(args, command)
 171     command = ["sed", "-i", "s/LXCARCH/{}/".format(platform.machine()), lxc_path + "/config"]
 172     tools.helpers.run.user(args, command)
 173     command = ["cp", "-fpr", seccomp_profile, lxc_path + "/waydroid.seccomp"]
 174     tools.helpers.run.user(args, command)
 175     if get_apparmor_status(args):
 176         command = ["sed", "-i", "-E", "/lxc.aa_profile|lxc.apparmor.profile/ s/unconfined/{}/g".format(LXC_APPARMOR_PROFILE), lxc_path + "/config"]
 177         tools.helpers.run.user(args, command)
 178
 179     nodes = generate_nodes_lxc_config(args)
 180     config_nodes_tmp_path = args.work + "/config_nodes"
 181     config_nodes = open(config_nodes_tmp_path, "w")
 182     for node in nodes:
 183         config_nodes.write(node + "\n")
 184     config_nodes.close()
 185     command = ["mv", config_nodes_tmp_path, lxc_path]
 186     tools.helpers.run.user(args, command)
 187
 188
 189 def make_base_props(args):
 190     def find_hal(hardware):
 191         hardware_props = [
 192             "ro.hardware." + hardware,
 193             "ro.hardware",
 194             "ro.product.board",
 195             "ro.arch",
 196             "ro.board.platform"]
 197         for p in hardware_props:
 198             prop = tools.helpers.props.host_get(args, p)
 199             if prop != "":
 200                 for lib in ["/odm/lib", "/odm/lib64", "/vendor/lib", "/vendor/lib64", "/system/lib", "/system/lib64"]:
 201                     hal_file = lib + "/hw/" + hardware + "." + prop + ".so"
 202                     if os.path.isfile(hal_file):
 203                         return prop
 204         return ""
 205
 206     def find_hidl(intf):
 207         if args.vendor_type == "MAINLINE":
 208             return False
 209
 210         try:
 211             sm = gbinder.ServiceManager("/dev/hwbinder")
 212             return intf in sm.list_sync()
 213         except:
 214             return False
 215
 216     props = []
 217
 218     if not os.path.exists("/dev/ashmem"):
 219         props.append("sys.use_memfd=true")
 220
 221     egl = tools.helpers.props.host_get(args, "ro.hardware.egl")
 222     dri, _ = tools.helpers.gpu.getDriNode(args)
 223
 224     gralloc = find_hal("gralloc")
 225     if not gralloc:
 226         if find_hidl("android.hardware.graphics.allocator@4.0::IAllocator/default"):
 227             gralloc = "android"
 228     if not gralloc:
 229         if dri:
 230             gralloc = "gbm"
 231             egl = "mesa"
 232         else:
 233             gralloc = "default"
 234             egl = "swiftshader"
 235         props.append("debug.stagefright.ccodec=0")
 236     props.append("ro.hardware.gralloc=" + gralloc)
 237
 238     if egl != "":
 239         props.append("ro.hardware.egl=" + egl)
 240
 241     media_profiles = tools.helpers.props.host_get(args, "media.settings.xml")
 242     if media_profiles != "":
 243         media_profiles = media_profiles.replace("vendor/", "vendor_extra/")
 244         media_profiles = media_profiles.replace("odm/", "odm_extra/")
 245         props.append("media.settings.xml=" + media_profiles)
 246
 247     ccodec = tools.helpers.props.host_get(args, "debug.stagefright.ccodec")
 248     if ccodec != "":
 249         props.append("debug.stagefright.ccodec=" + ccodec)
 250
 251     ext_library = tools.helpers.props.host_get(args, "ro.vendor.extension_library")
 252     if ext_library != "":
 253         ext_library = ext_library.replace("vendor/", "vendor_extra/")
 254         ext_library = ext_library.replace("odm/", "odm_extra/")
 255         props.append("ro.vendor.extension_library=" + ext_library)
 256
 257     vulkan = find_hal("vulkan")
 258     if not vulkan and dri:
 259         vulkan = tools.helpers.gpu.getVulkanDriver(args, os.path.basename(dri))
 260     if vulkan:
 261         props.append("ro.hardware.vulkan=" + vulkan)
 262
 263     treble = tools.helpers.props.host_get(args, "ro.treble.enabled")
 264     if treble != "true":
 265         camera = find_hal("camera")
 266         if camera != "":
 267             props.append("ro.hardware.camera=" + camera)
 268         else:
 269             if args.vendor_type == "MAINLINE":
 270                 props.append("ro.hardware.camera=v4l2")
 271
 272     opengles = tools.helpers.props.host_get(args, "ro.opengles.version")
 273     if opengles == "":
 274         opengles = "196609"
 275     props.append("ro.opengles.version=" + opengles)
 276
 277     if args.images_path not in tools.config.defaults["preinstalled_images_paths"]:
 278         props.append("waydroid.system_ota=" + args.system_ota)
 279         props.append("waydroid.vendor_ota=" + args.vendor_ota)
 280     else:
 281         props.append("waydroid.updater.disabled=true")
 282
 283     props.append("waydroid.tools_version=" + tools.config.version)
 284
 285     if args.vendor_type == "MAINLINE":
 286         props.append("ro.vndk.lite=true")
 287
 288     for product in ["brand", "device", "manufacturer", "model", "name"]:
 289         prop_product = tools.helpers.props.host_get(
 290             args, "ro.product.vendor." + product)
 291         if prop_product != "":
 292             props.append("ro.product.waydroid." + product + "=" + prop_product)
 293         else:
 294             if os.path.isfile("/proc/device-tree/" + product):
 295                 with open("/proc/device-tree/" + product) as f:
 296                     f_value = f.read().strip().rstrip('\x00')
 297                     if f_value != "":
 298                         props.append("ro.product.waydroid." +
 299                                      product + "=" + f_value)
 300
 301     prop_fp = tools.helpers.props.host_get(args, "ro.vendor.build.fingerprint")
 302     if prop_fp != "":
 303         props.append("ro.build.fingerprint=" + prop_fp)
 304
 305     # now append/override with values in [properties] section of waydroid.cfg
 306     cfg = tools.config.load(args)
 307     for k, v in cfg["properties"].items():
 308         for idx, elem in enumerate(props):
 309             if (k+"=") in elem:
 310                 props.pop(idx)
 311         props.append(k+"="+v)
 312
 313     base_props = open(args.work + "/waydroid_base.prop", "w")
 314     for prop in props:
 315         base_props.write(prop + "\n")
 316     base_props.close()
 317
 318
 319 def setup_host_perms(args):
 320     if not os.path.exists(tools.config.defaults["host_perms"]):
 321         os.mkdir(tools.config.defaults["host_perms"])
 322
 323     treble = tools.helpers.props.host_get(args, "ro.treble.enabled")
 324     if treble != "true":
 325         return
 326
 327     sku = tools.helpers.props.host_get(args, "ro.boot.product.hardware.sku")
 328     copy_list = []
 329     copy_list.extend(
 330         glob.glob("/vendor/etc/permissions/android.hardware.nfc.*"))
 331     if os.path.exists("/vendor/etc/permissions/android.hardware.consumerir.xml"):
 332         copy_list.append("/vendor/etc/permissions/android.hardware.consumerir.xml")
 333     copy_list.extend(
 334         glob.glob("/odm/etc/permissions/android.hardware.nfc.*"))
 335     if os.path.exists("/odm/etc/permissions/android.hardware.consumerir.xml"):
 336         copy_list.append("/odm/etc/permissions/android.hardware.consumerir.xml")
 337     if sku != "":
 338         copy_list.extend(
 339             glob.glob("/odm/etc/permissions/sku_{}/android.hardware.nfc.*".format(sku)))
 340         if os.path.exists("/odm/etc/permissions/sku_{}/android.hardware.consumerir.xml".format(sku)):
 341             copy_list.append(
 342                 "/odm/etc/permissions/sku_{}/android.hardware.consumerir.xml".format(sku))
 343
 344     for filename in copy_list:
 345         shutil.copy(filename, tools.config.defaults["host_perms"])
 346
 347 def status(args):
 348     command = ["lxc-info", "-P", tools.config.defaults["lxc"], "-n", "waydroid", "-sH"]
 349     out = subprocess.run(command, stdout=subprocess.PIPE).stdout.decode('utf-8').strip()
 350     return out
 351
 352 def wait_for_running(args):
 353     lxc_status = status(args)
 354     timeout = 10
 355     while lxc_status != "RUNNING" and timeout > 0:
 356         lxc_status = status(args)
 357         logging.info(
 358             "waiting {} seconds for container to start...".format(timeout))
 359         timeout = timeout - 1
 360         time.sleep(1)
 361     if lxc_status != "RUNNING":
 362         raise OSError("container failed to start")
 363
 364 def start(args):
 365     command = ["lxc-start", "-P", tools.config.defaults["lxc"],
 366                "-F", "-n", "waydroid", "--", "/init"]
 367     tools.helpers.run.user(args, command, output="background")
 368     wait_for_running(args)
 369     # Workaround lxc-start changing stdout/stderr permissions to 700
 370     os.chmod(args.log, 0o666)
 371
 372 def stop(args):
 373     command = ["lxc-stop", "-P",
 374                tools.config.defaults["lxc"], "-n", "waydroid", "-k"]
 375     tools.helpers.run.user(args, command)
 376
 377 def freeze(args):
 378     command = ["lxc-freeze", "-P", tools.config.defaults["lxc"], "-n", "waydroid"]
 379     tools.helpers.run.user(args, command)
 380
 381 def unfreeze(args):
 382     command = ["lxc-unfreeze", "-P",
 383                tools.config.defaults["lxc"], "-n", "waydroid"]
 384     tools.helpers.run.user(args, command)
 385
 386 ANDROID_ENV = {
 387     "PATH": "/product/bin:/apex/com.android.runtime/bin:/apex/com.android.art/bin:/system_ext/bin:/system/bin:/system/xbin:/odm/bin:/vendor/bin:/vendor/xbin",
 388     "ANDROID_ROOT": "/system",
 389     "ANDROID_DATA": "/data",
 390     "ANDROID_STORAGE": "/storage",
 391     "ANDROID_ART_ROOT": "/apex/com.android.art",
 392     "ANDROID_I18N_ROOT": "/apex/com.android.i18n",
 393     "ANDROID_TZDATA_ROOT": "/apex/com.android.tzdata",
 394     "ANDROID_RUNTIME_ROOT": "/apex/com.android.runtime",
 395 }
 396
 397 def android_env_attach_options():
 398     env = [k + "=" + v for k, v in ANDROID_ENV.items()]
 399     return [x for var in env for x in ("--set-var", var)]
 400
 401 def shell(args):
 402     state = status(args)
 403     if state == "FROZEN":
 404         unfreeze(args)
 405     elif state != "RUNNING":
 406         logging.error("WayDroid container is {}".format(state))
 407         return
 408     command = ["lxc-attach", "-P", tools.config.defaults["lxc"],
 409                "-n", "waydroid", "--clear-env"]
 410     command.extend(android_env_attach_options())
 411     command.append("--")
 412     if args.COMMAND:
 413         command.extend(args.COMMAND)
 414     else:
 415         command.append("/system/bin/sh")
 416     subprocess.run(command)
 417     if state == "FROZEN":
 418         freeze(args)
 419
 420 def logcat(args):
 421     args.COMMAND = ["/system/bin/logcat"]
 422     shell(args)