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