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
 131 def set_lxc_config(args):
 132     lxc_path = tools.config.defaults["lxc"] + "/waydroid"
 133     lxc_ver = get_lxc_version(args)
 134     if lxc_ver == 0:
 135         raise OSError("LXC is not installed")
 136     config_paths = tools.config.tools_src + "/data/configs/config_"
 137     seccomp_profile = tools.config.tools_src + "/data/configs/waydroid.seccomp"
 138
 139     config_snippets = [ config_paths + "base" ]
 140     # lxc v1 is a bit special because some options got renamed later
 141     if lxc_ver == 1:
 142         config_snippets.append(config_paths + "1")
 143     else:
 144         for ver in range(2, 5):
 145             snippet = config_paths + str(ver)
 146             if lxc_ver >= ver and os.path.exists(snippet):
 147                 config_snippets.append(snippet)
 148
 149     command = ["mkdir", "-p", lxc_path]
 150     tools.helpers.run.user(args, command)
 151     command = ["sh", "-c", "cat {} > \"{}\"".format(' '.join('"{0}"'.format(w) for w in config_snippets), lxc_path + "/config")]
 152     tools.helpers.run.user(args, command)
 153     command = ["sed", "-i", "s/LXCARCH/{}/".format(platform.machine()), lxc_path + "/config"]
 154     tools.helpers.run.user(args, command)
 155     command = ["cp", "-fpr", seccomp_profile, lxc_path + "/waydroid.seccomp"]
 156     tools.helpers.run.user(args, command)
 157
 158     nodes = generate_nodes_lxc_config(args)
 159     config_nodes_tmp_path = args.work + "/config_nodes"
 160     config_nodes = open(config_nodes_tmp_path, "w")
 161     for node in nodes:
 162         config_nodes.write(node + "\n")
 163     config_nodes.close()
 164     command = ["mv", config_nodes_tmp_path, lxc_path]
 165     tools.helpers.run.user(args, command)
 166
 167
 168 def make_base_props(args):
 169     def find_hal(hardware):
 170         hardware_props = [
 171             "ro.hardware." + hardware,
 172             "ro.hardware",
 173             "ro.product.board",
 174             "ro.arch",
 175             "ro.board.platform"]
 176         for p in hardware_props:
 177             prop = tools.helpers.props.host_get(args, p)
 178             if prop != "":
 179                 for lib in ["/odm/lib", "/odm/lib64", "/vendor/lib", "/vendor/lib64", "/system/lib", "/system/lib64"]:
 180                     hal_file = lib + "/hw/" + hardware + "." + prop + ".so"
 181                     if os.path.isfile(hal_file):
 182                         return prop
 183         return ""
 184
 185     def find_hidl(intf):
 186         if args.vendor_type == "MAINLINE":
 187             return False
 188
 189         try:
 190             sm = gbinder.ServiceManager("/dev/hwbinder")
 191             return intf in sm.list_sync()
 192         except:
 193             return False
 194
 195     props = []
 196
 197     if not os.path.exists("/dev/ashmem"):
 198         props.append("sys.use_memfd=true")
 199
 200     egl = tools.helpers.props.host_get(args, "ro.hardware.egl")
 201     dri = tools.helpers.gpu.getDriNode(args)
 202
 203     gralloc = find_hal("gralloc")
 204     if not gralloc:
 205         if find_hidl("android.hardware.graphics.allocator@4.0::IAllocator/default"):
 206             gralloc = "android"
 207     if not gralloc:
 208         if dri:
 209             gralloc = "gbm"
 210             egl = "mesa"
 211         else:
 212             gralloc = "default"
 213             egl = "swiftshader"
 214         props.append("debug.stagefright.ccodec=0")
 215     props.append("ro.hardware.gralloc=" + gralloc)
 216
 217     if egl != "":
 218         props.append("ro.hardware.egl=" + egl)
 219
 220     media_profiles = tools.helpers.props.host_get(args, "media.settings.xml")
 221     if media_profiles != "":
 222         media_profiles = media_profiles.replace("vendor/", "vendor_extra/")
 223         media_profiles = media_profiles.replace("odm/", "odm_extra/")
 224         props.append("media.settings.xml=" + media_profiles)
 225
 226     ccodec = tools.helpers.props.host_get(args, "debug.stagefright.ccodec")
 227     if ccodec != "":
 228         props.append("debug.stagefright.ccodec=" + ccodec)
 229
 230     ext_library = tools.helpers.props.host_get(args, "ro.vendor.extension_library")
 231     if ext_library != "":
 232         ext_library = ext_library.replace("vendor/", "vendor_extra/")
 233         ext_library = ext_library.replace("odm/", "odm_extra/")
 234         props.append("ro.vendor.extension_library=" + ext_library)
 235
 236     vulkan = find_hal("vulkan")
 237     if not vulkan and dri:
 238         vulkan = tools.helpers.gpu.getVulkanDriver(args, os.path.basename(dri))
 239     if vulkan:
 240         props.append("ro.hardware.vulkan=" + vulkan)
 241
 242     treble = tools.helpers.props.host_get(args, "ro.treble.enabled")
 243     if treble != "true":
 244         camera = find_hal("camera")
 245         if camera != "":
 246             props.append("ro.hardware.camera=" + camera)
 247         else:
 248             if args.vendor_type == "MAINLINE":
 249                 props.append("ro.hardware.camera=v4l2")
 250
 251     opengles = tools.helpers.props.host_get(args, "ro.opengles.version")
 252     if opengles == "":
 253         opengles = "196609"
 254     props.append("ro.opengles.version=" + opengles)
 255
 256     if args.images_path not in tools.config.defaults["preinstalled_images_paths"]:
 257         props.append("waydroid.system_ota=" + args.system_ota)
 258         props.append("waydroid.vendor_ota=" + args.vendor_ota)
 259     else:
 260         props.append("waydroid.updater.disabled=true")
 261
 262     props.append("waydroid.tools_version=" + tools.config.version)
 263
 264     if args.vendor_type == "MAINLINE":
 265         props.append("ro.vndk.lite=true")
 266
 267     for product in ["brand", "device", "manufacturer", "model", "name"]:
 268         prop_product = tools.helpers.props.host_get(
 269             args, "ro.product.vendor." + product)
 270         if prop_product != "":
 271             props.append("ro.product.waydroid." + product + "=" + prop_product)
 272         else:
 273             if os.path.isfile("/proc/device-tree/" + product):
 274                 with open("/proc/device-tree/" + product) as f:
 275                     f_value = f.read().strip().rstrip('\x00')
 276                     if f_value != "":
 277                         props.append("ro.product.waydroid." +
 278                                      product + "=" + f_value)
 279
 280     prop_fp = tools.helpers.props.host_get(args, "ro.vendor.build.fingerprint")
 281     if prop_fp != "":
 282         props.append("ro.build.fingerprint=" + prop_fp)
 283
 284     # now append/override with values in [properties] section of waydroid.cfg
 285     cfg = tools.config.load(args)
 286     for k, v in cfg["properties"].items():
 287         for idx, elem in enumerate(props):
 288             if (k+"=") in elem:
 289                 props.pop(idx)
 290         props.append(k+"="+v)
 291
 292     base_props = open(args.work + "/waydroid_base.prop", "w")
 293     for prop in props:
 294         base_props.write(prop + "\n")
 295     base_props.close()
 296
 297
 298 def setup_host_perms(args):
 299     if not os.path.exists(tools.config.defaults["host_perms"]):
 300         os.mkdir(tools.config.defaults["host_perms"])
 301
 302     treble = tools.helpers.props.host_get(args, "ro.treble.enabled")
 303     if treble != "true":
 304         return
 305
 306     sku = tools.helpers.props.host_get(args, "ro.boot.product.hardware.sku")
 307     copy_list = []
 308     copy_list.extend(
 309         glob.glob("/vendor/etc/permissions/android.hardware.nfc.*"))
 310     if os.path.exists("/vendor/etc/permissions/android.hardware.consumerir.xml"):
 311         copy_list.append("/vendor/etc/permissions/android.hardware.consumerir.xml")
 312     copy_list.extend(
 313         glob.glob("/odm/etc/permissions/android.hardware.nfc.*"))
 314     if os.path.exists("/odm/etc/permissions/android.hardware.consumerir.xml"):
 315         copy_list.append("/odm/etc/permissions/android.hardware.consumerir.xml")
 316     if sku != "":
 317         copy_list.extend(
 318             glob.glob("/odm/etc/permissions/sku_{}/android.hardware.nfc.*".format(sku)))
 319         if os.path.exists("/odm/etc/permissions/sku_{}/android.hardware.consumerir.xml".format(sku)):
 320             copy_list.append(
 321                 "/odm/etc/permissions/sku_{}/android.hardware.consumerir.xml".format(sku))
 322
 323     for filename in copy_list:
 324         shutil.copy(filename, tools.config.defaults["host_perms"])
 325
 326 def status(args):
 327     command = ["lxc-info", "-P", tools.config.defaults["lxc"], "-n", "waydroid", "-sH"]
 328     out = subprocess.run(command, stdout=subprocess.PIPE).stdout.decode('utf-8').strip()
 329     os.chmod(args.log, 0o666)
 330     return out
 331
 332 def start(args):
 333     command = ["lxc-start", "-P", tools.config.defaults["lxc"],
 334                "-F", "-n", "waydroid", "--", "/init"]
 335     tools.helpers.run.user(args, command, output="background")
 336
 337 def stop(args):
 338     command = ["lxc-stop", "-P",
 339                tools.config.defaults["lxc"], "-n", "waydroid", "-k"]
 340     tools.helpers.run.user(args, command)
 341
 342 def freeze(args):
 343     command = ["lxc-freeze", "-P", tools.config.defaults["lxc"], "-n", "waydroid"]
 344     tools.helpers.run.user(args, command)
 345
 346 def unfreeze(args):
 347     command = ["lxc-unfreeze", "-P",
 348                tools.config.defaults["lxc"], "-n", "waydroid"]
 349     tools.helpers.run.user(args, command)
 350
 351 def shell(args):
 352     if status(args) != "RUNNING":
 353         logging.error("WayDroid container is {}".format(status(args)))
 354         return
 355     command = ["lxc-attach", "-P", tools.config.defaults["lxc"],
 356                "-n", "waydroid", "--"]
 357     if args.COMMAND:
 358         command.append(args.COMMAND)
 359     else:
 360         command.append("/system/bin/sh")
 361     subprocess.run(command, env={"PATH": os.environ['PATH'] + ":/system/bin:/vendor/bin"})
 362
 363 def logcat(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", "--", "/system/bin/logcat"]
 369     subprocess.run(command)