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 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 def add_node_entry(nodes, src, dist, mnt_type, options, check):
  24     if check and not os.path.exists(src):
  25         return False
  26     entry = "lxc.mount.entry = "
  27     entry += src + " "
  28     if dist is None:
  29         dist = src[1:]
  30     entry += dist + " "
  31     entry += mnt_type + " "
  32     entry += options
  33     nodes.append(entry)
  34     return True
  35
  36 def generate_nodes_lxc_config(args):
  37     nodes = []
  38     def make_entry(src, dist=None, mnt_type="none", options="bind,create=file,optional 0 0", check=True):
  39         return add_node_entry(nodes, src, dist, mnt_type, options, check)
  40
  41     # Necessary dev nodes
  42     make_entry("tmpfs", "dev", "tmpfs", "nosuid 0 0", False)
  43     make_entry("/dev/zero")
  44     make_entry("/dev/null")
  45     make_entry("/dev/full")
  46     make_entry("/dev/ashmem")
  47     make_entry("/dev/fuse")
  48     make_entry("/dev/ion")
  49     make_entry("/dev/tty")
  50     make_entry("/dev/char", options="bind,create=dir,optional 0 0")
  51
  52     # Graphic dev nodes
  53     make_entry("/dev/kgsl-3d0")
  54     make_entry("/dev/mali0")
  55     make_entry("/dev/pvr_sync")
  56     make_entry("/dev/pmsg0")
  57     make_entry("/dev/dxg")
  58     render, _ = tools.helpers.gpu.getDriNode(args)
  59     make_entry(render, "dev/dri/renderD128")
  60
  61     for n in glob.glob("/dev/fb*"):
  62         make_entry(n)
  63     for n in glob.glob("/dev/graphics/fb*"):
  64         make_entry(n)
  65     for n in glob.glob("/dev/video*"):
  66         make_entry(n)
  67
  68     # Binder dev nodes
  69     make_entry("/dev/" + args.BINDER_DRIVER, "dev/binder", check=False)
  70     make_entry("/dev/" + args.VNDBINDER_DRIVER, "dev/vndbinder", check=False)
  71     make_entry("/dev/" + args.HWBINDER_DRIVER, "dev/hwbinder", check=False)
  72
  73     if args.vendor_type != "MAINLINE":
  74         if not make_entry("/dev/hwbinder", "dev/host_hwbinder"):
  75             raise OSError('Binder node "hwbinder" of host not found')
  76         make_entry("/vendor", "vendor_extra", options="rbind,optional 0 0")
  77
  78     # Necessary device nodes for adb
  79     make_entry("none", "dev/pts", "devpts", "defaults,mode=644,ptmxmode=666,create=dir 0 0", False)
  80     make_entry("/dev/uhid")
  81
  82     # TUN/TAP device node for VPN
  83     make_entry("/dev/net/tun", "dev/tun")
  84
  85     # Low memory killer sys node
  86     make_entry("/sys/module/lowmemorykiller", options="bind,create=dir,optional 0 0")
  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     # Necessary sw_sync node for HWC
  93     make_entry("/dev/sw_sync")
  94     make_entry("/sys/kernel/debug", options="rbind,create=dir,optional 0 0")
  95
  96     # Vibrator
  97     make_entry("/sys/class/leds/vibrator",
  98                options="bind,create=dir,optional 0 0")
  99     make_entry("/sys/devices/virtual/timed_output/vibrator",
 100                options="bind,create=dir,optional 0 0")
 101
 102     # Media dev nodes (for Mediatek)
 103     make_entry("/dev/Vcodec")
 104     make_entry("/dev/MTK_SMI")
 105     make_entry("/dev/mdp_sync")
 106     make_entry("/dev/mtk_cmdq")
 107
 108     # WSLg
 109     make_entry("tmpfs", "mnt_extra", "tmpfs", "nodev 0 0", False)
 110     make_entry("/mnt/wslg", "mnt_extra/wslg",
 111                options="rbind,create=dir,optional 0 0")
 112
 113     # Make a tmpfs at every possible rootfs mountpoint
 114     make_entry("tmpfs", "tmp", "tmpfs", "nodev 0 0", False)
 115     make_entry("tmpfs", "var", "tmpfs", "nodev 0 0", False)
 116     make_entry("tmpfs", "run", "tmpfs", "nodev 0 0", False)
 117
 118     # NFC config
 119     make_entry("/system/etc/libnfc-nci.conf", options="bind,optional 0 0")
 120
 121     return nodes
 122
 123 LXC_APPARMOR_PROFILE = "lxc-waydroid"
 124 def get_apparmor_status(args):
 125     enabled = False
 126     if shutil.which("aa-enabled"):
 127         enabled = (tools.helpers.run.user(args, ["aa-enabled", "--quiet"], check=False) == 0)
 128     if not enabled and shutil.which("systemctl"):
 129         enabled = (tools.helpers.run.user(args, ["systemctl", "is-active", "-q", "apparmor"], check=False) == 0)
 130     try:
 131         with open("/sys/kernel/security/apparmor/profiles", "r") as f:
 132             enabled &= (LXC_APPARMOR_PROFILE in f.read())
 133     except:
 134         enabled = False
 135     return enabled
 136
 137 def set_lxc_config(args):
 138     lxc_path = tools.config.defaults["lxc"] + "/waydroid"
 139     lxc_ver = get_lxc_version(args)
 140     if lxc_ver == 0:
 141         raise OSError("LXC is not installed")
 142     config_paths = tools.config.tools_src + "/data/configs/config_"
 143     seccomp_profile = tools.config.tools_src + "/data/configs/waydroid.seccomp"
 144
 145     config_snippets = [ config_paths + "base" ]
 146     # lxc v1 and v2 are bit special because some options got renamed later
 147     if lxc_ver <= 2:
 148         config_snippets.append(config_paths + "1")
 149     else:
 150         for ver in range(3, 5):
 151             snippet = config_paths + str(ver)
 152             if lxc_ver >= ver and os.path.exists(snippet):
 153                 config_snippets.append(snippet)
 154
 155     command = ["mkdir", "-p", lxc_path]
 156     tools.helpers.run.user(args, command)
 157     command = ["sh", "-c", "cat {} > \"{}\"".format(' '.join('"{0}"'.format(w) for w in config_snippets), lxc_path + "/config")]
 158     tools.helpers.run.user(args, command)
 159     command = ["sed", "-i", "s/LXCARCH/{}/".format(platform.machine()), lxc_path + "/config"]
 160     tools.helpers.run.user(args, command)
 161     command = ["cp", "-fpr", seccomp_profile, lxc_path + "/waydroid.seccomp"]
 162     tools.helpers.run.user(args, command)
 163     if get_apparmor_status(args):
 164         command = ["sed", "-i", "-E", "/lxc.aa_profile|lxc.apparmor.profile/ s/unconfined/{}/g".format(LXC_APPARMOR_PROFILE), lxc_path + "/config"]
 165         tools.helpers.run.user(args, command)
 166
 167     nodes = generate_nodes_lxc_config(args)
 168     config_nodes_tmp_path = args.work + "/config_nodes"
 169     config_nodes = open(config_nodes_tmp_path, "w")
 170     for node in nodes:
 171         config_nodes.write(node + "\n")
 172     config_nodes.close()
 173     command = ["mv", config_nodes_tmp_path, lxc_path]
 174     tools.helpers.run.user(args, command)
 175
 176     # Create empty file
 177     open(os.path.join(lxc_path, "config_session"), mode="w").close()
 178
 179 def generate_session_lxc_config(args, session):
 180     nodes = []
 181     def make_entry(src, dist=None, mnt_type="none", options="rbind,create=file 0 0"):
 182         if any(x in src for x in ["\n", "\r"]):
 183             logging.warning("User-provided mount path contains illegal character: " + src)
 184             return False
 185         if dist is None and (not os.path.exists(src) or
 186                              str(os.stat(src).st_uid) != session["user_id"]):
 187             logging.warning("User-provided mount path is not owned by user: " + src)
 188             return False
 189         return add_node_entry(nodes, src, dist, mnt_type, options, check=False)
 190
 191     # Make sure XDG_RUNTIME_DIR exists
 192     if not make_entry("tmpfs", tools.config.defaults["container_xdg_runtime_dir"], options="create=dir 0 0"):
 193         raise OSError("Failed to create XDG_RUNTIME_DIR mount point")
 194
 195     wayland_host_socket = os.path.realpath(os.path.join(session["xdg_runtime_dir"], session["wayland_display"]))
 196     wayland_container_socket = os.path.realpath(os.path.join(tools.config.defaults["container_xdg_runtime_dir"], tools.config.defaults["container_wayland_display"]))
 197     if not make_entry(wayland_host_socket, wayland_container_socket[1:]):
 198         raise OSError("Failed to bind Wayland socket")
 199
 200     # Make sure PULSE_RUNTIME_DIR exists
 201     pulse_host_socket = os.path.join(session["pulse_runtime_path"], "native")
 202     pulse_container_socket = os.path.join(tools.config.defaults["container_pulse_runtime_path"], "native")
 203     make_entry(pulse_host_socket, pulse_container_socket[1:])
 204
 205     if not make_entry(session["waydroid_data"], "data", options="rbind 0 0"):
 206         raise OSError("Failed to bind userdata")
 207
 208     lxc_path = tools.config.defaults["lxc"] + "/waydroid"
 209     config_nodes_tmp_path = args.work + "/config_session"
 210     config_nodes = open(config_nodes_tmp_path, "w")
 211     for node in nodes:
 212         config_nodes.write(node + "\n")
 213     config_nodes.close()
 214     command = ["mv", config_nodes_tmp_path, lxc_path]
 215     tools.helpers.run.user(args, command)
 216
 217 def make_base_props(args):
 218     def find_hal(hardware):
 219         hardware_props = [
 220             "ro.hardware." + hardware,
 221             "ro.hardware",
 222             "ro.product.board",
 223             "ro.arch",
 224             "ro.board.platform"]
 225         for p in hardware_props:
 226             prop = tools.helpers.props.host_get(args, p)
 227             if prop != "":
 228                 for lib in ["/odm/lib", "/odm/lib64", "/vendor/lib", "/vendor/lib64", "/system/lib", "/system/lib64"]:
 229                     hal_file = lib + "/hw/" + hardware + "." + prop + ".so"
 230                     if os.path.isfile(hal_file):
 231                         return prop
 232         return ""
 233
 234     def find_hidl(intf):
 235         if args.vendor_type == "MAINLINE":
 236             return False
 237
 238         try:
 239             sm = gbinder.ServiceManager("/dev/hwbinder")
 240             return intf in sm.list_sync()
 241         except:
 242             return False
 243
 244     props = []
 245
 246     if not os.path.exists("/dev/ashmem"):
 247         props.append("sys.use_memfd=true")
 248
 249     egl = tools.helpers.props.host_get(args, "ro.hardware.egl")
 250     dri, _ = tools.helpers.gpu.getDriNode(args)
 251
 252     gralloc = find_hal("gralloc")
 253     if not gralloc:
 254         if find_hidl("android.hardware.graphics.allocator@4.0::IAllocator/default"):
 255             gralloc = "android"
 256     if not gralloc:
 257         if dri:
 258             gralloc = "gbm"
 259             egl = "mesa"
 260         else:
 261             gralloc = "default"
 262             egl = "swiftshader"
 263         props.append("debug.stagefright.ccodec=0")
 264     props.append("ro.hardware.gralloc=" + gralloc)
 265
 266     if egl != "":
 267         props.append("ro.hardware.egl=" + egl)
 268
 269     media_profiles = tools.helpers.props.host_get(args, "media.settings.xml")
 270     if media_profiles != "":
 271         media_profiles = media_profiles.replace("vendor/", "vendor_extra/")
 272         media_profiles = media_profiles.replace("odm/", "odm_extra/")
 273         props.append("media.settings.xml=" + media_profiles)
 274
 275     ccodec = tools.helpers.props.host_get(args, "debug.stagefright.ccodec")
 276     if ccodec != "":
 277         props.append("debug.stagefright.ccodec=" + ccodec)
 278
 279     ext_library = tools.helpers.props.host_get(args, "ro.vendor.extension_library")
 280     if ext_library != "":
 281         ext_library = ext_library.replace("vendor/", "vendor_extra/")
 282         ext_library = ext_library.replace("odm/", "odm_extra/")
 283         props.append("ro.vendor.extension_library=" + ext_library)
 284
 285     vulkan = find_hal("vulkan")
 286     if not vulkan and dri:
 287         vulkan = tools.helpers.gpu.getVulkanDriver(args, os.path.basename(dri))
 288     if vulkan:
 289         props.append("ro.hardware.vulkan=" + vulkan)
 290
 291     treble = tools.helpers.props.host_get(args, "ro.treble.enabled")
 292     if treble != "true":
 293         camera = find_hal("camera")
 294         if camera != "":
 295             props.append("ro.hardware.camera=" + camera)
 296         else:
 297             if args.vendor_type == "MAINLINE":
 298                 props.append("ro.hardware.camera=v4l2")
 299
 300     opengles = tools.helpers.props.host_get(args, "ro.opengles.version")
 301     if opengles == "":
 302         opengles = "196609"
 303     props.append("ro.opengles.version=" + opengles)
 304
 305     if args.images_path not in tools.config.defaults["preinstalled_images_paths"]:
 306         props.append("waydroid.system_ota=" + args.system_ota)
 307         props.append("waydroid.vendor_ota=" + args.vendor_ota)
 308     else:
 309         props.append("waydroid.updater.disabled=true")
 310
 311     props.append("waydroid.tools_version=" + tools.config.version)
 312
 313     if args.vendor_type == "MAINLINE":
 314         props.append("ro.vndk.lite=true")
 315
 316     for product in ["brand", "device", "manufacturer", "model", "name"]:
 317         prop_product = tools.helpers.props.host_get(
 318             args, "ro.product.vendor." + product)
 319         if prop_product != "":
 320             props.append("ro.product.waydroid." + product + "=" + prop_product)
 321         else:
 322             if os.path.isfile("/proc/device-tree/" + product):
 323                 with open("/proc/device-tree/" + product) as f:
 324                     f_value = f.read().strip().rstrip('\x00')
 325                     if f_value != "":
 326                         props.append("ro.product.waydroid." +
 327                                      product + "=" + f_value)
 328
 329     prop_fp = tools.helpers.props.host_get(args, "ro.vendor.build.fingerprint")
 330     if prop_fp != "":
 331         props.append("ro.build.fingerprint=" + prop_fp)
 332
 333     # now append/override with values in [properties] section of waydroid.cfg
 334     cfg = tools.config.load(args)
 335     for k, v in cfg["properties"].items():
 336         for idx, elem in enumerate(props):
 337             if (k+"=") in elem:
 338                 props.pop(idx)
 339         props.append(k+"="+v)
 340
 341     base_props = open(args.work + "/waydroid_base.prop", "w")
 342     for prop in props:
 343         base_props.write(prop + "\n")
 344     base_props.close()
 345
 346
 347 def setup_host_perms(args):
 348     if not os.path.exists(tools.config.defaults["host_perms"]):
 349         os.mkdir(tools.config.defaults["host_perms"])
 350
 351     treble = tools.helpers.props.host_get(args, "ro.treble.enabled")
 352     if treble != "true":
 353         return
 354
 355     sku = tools.helpers.props.host_get(args, "ro.boot.product.hardware.sku")
 356     copy_list = []
 357     copy_list.extend(
 358         glob.glob("/vendor/etc/permissions/android.hardware.nfc.*"))
 359     if os.path.exists("/vendor/etc/permissions/android.hardware.consumerir.xml"):
 360         copy_list.append("/vendor/etc/permissions/android.hardware.consumerir.xml")
 361     copy_list.extend(
 362         glob.glob("/odm/etc/permissions/android.hardware.nfc.*"))
 363     if os.path.exists("/odm/etc/permissions/android.hardware.consumerir.xml"):
 364         copy_list.append("/odm/etc/permissions/android.hardware.consumerir.xml")
 365     if sku != "":
 366         copy_list.extend(
 367             glob.glob("/odm/etc/permissions/sku_{}/android.hardware.nfc.*".format(sku)))
 368         if os.path.exists("/odm/etc/permissions/sku_{}/android.hardware.consumerir.xml".format(sku)):
 369             copy_list.append(
 370                 "/odm/etc/permissions/sku_{}/android.hardware.consumerir.xml".format(sku))
 371
 372     for filename in copy_list:
 373         shutil.copy(filename, tools.config.defaults["host_perms"])
 374
 375 def status(args):
 376     command = ["lxc-info", "-P", tools.config.defaults["lxc"], "-n", "waydroid", "-sH"]
 377     try:
 378         return tools.helpers.run.user(args, command, output_return=True).strip()
 379     except:
 380         logging.info("Couldn't get LXC status. Assuming STOPPED.")
 381         return "STOPPED"
 382
 383 def wait_for_running(args):
 384     lxc_status = status(args)
 385     timeout = 10
 386     while lxc_status != "RUNNING" and timeout > 0:
 387         lxc_status = status(args)
 388         logging.info(
 389             "waiting {} seconds for container to start...".format(timeout))
 390         timeout = timeout - 1
 391         time.sleep(1)
 392     if lxc_status != "RUNNING":
 393         raise OSError("container failed to start")
 394
 395 def start(args):
 396     command = ["lxc-start", "-P", tools.config.defaults["lxc"],
 397                "-F", "-n", "waydroid", "--", "/init"]
 398     tools.helpers.run.user(args, command, output="background")
 399     wait_for_running(args)
 400     # Workaround lxc-start changing stdout/stderr permissions to 700
 401     os.chmod(args.log, 0o666)
 402
 403 def stop(args):
 404     command = ["lxc-stop", "-P",
 405                tools.config.defaults["lxc"], "-n", "waydroid", "-k"]
 406     tools.helpers.run.user(args, command)
 407
 408 def freeze(args):
 409     command = ["lxc-freeze", "-P", tools.config.defaults["lxc"], "-n", "waydroid"]
 410     tools.helpers.run.user(args, command)
 411
 412 def unfreeze(args):
 413     command = ["lxc-unfreeze", "-P",
 414                tools.config.defaults["lxc"], "-n", "waydroid"]
 415     tools.helpers.run.user(args, command)
 416
 417 ANDROID_ENV = {
 418     "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",
 419     "ANDROID_ROOT": "/system",
 420     "ANDROID_DATA": "/data",
 421     "ANDROID_STORAGE": "/storage",
 422     "ANDROID_ART_ROOT": "/apex/com.android.art",
 423     "ANDROID_I18N_ROOT": "/apex/com.android.i18n",
 424     "ANDROID_TZDATA_ROOT": "/apex/com.android.tzdata",
 425     "ANDROID_RUNTIME_ROOT": "/apex/com.android.runtime",
 426     "BOOTCLASSPATH": "/apex/com.android.art/javalib/core-oj.jar:/apex/com.android.art/javalib/core-libart.jar:/apex/com.android.art/javalib/core-icu4j.jar:/apex/com.android.art/javalib/okhttp.jar:/apex/com.android.art/javalib/bouncycastle.jar:/apex/com.android.art/javalib/apache-xml.jar:/system/framework/framework.jar:/system/framework/ext.jar:/system/framework/telephony-common.jar:/system/framework/voip-common.jar:/system/framework/ims-common.jar:/system/framework/framework-atb-backward-compatibility.jar:/apex/com.android.conscrypt/javalib/conscrypt.jar:/apex/com.android.media/javalib/updatable-media.jar:/apex/com.android.mediaprovider/javalib/framework-mediaprovider.jar:/apex/com.android.os.statsd/javalib/framework-statsd.jar:/apex/com.android.permission/javalib/framework-permission.jar:/apex/com.android.sdkext/javalib/framework-sdkextensions.jar:/apex/com.android.wifi/javalib/framework-wifi.jar:/apex/com.android.tethering/javalib/framework-tethering.jar"
 427 }
 428
 429 def android_env_attach_options():
 430     env = [k + "=" + v for k, v in ANDROID_ENV.items()]
 431     return [x for var in env for x in ("--set-var", var)]
 432
 433 def shell(args):
 434     state = status(args)
 435     if state == "FROZEN":
 436         unfreeze(args)
 437     elif state != "RUNNING":
 438         logging.error("WayDroid container is {}".format(state))
 439         return
 440     command = ["lxc-attach", "-P", tools.config.defaults["lxc"],
 441                "-n", "waydroid", "--clear-env"]
 442     command.extend(android_env_attach_options())
 443     if args.uid!=None:
 444         command.append("--uid="+str(args.uid))
 445     if args.gid!=None:
 446         command.append("--gid="+str(args.gid))
 447     elif args.uid!=None:
 448         command.append("--gid="+str(args.uid))
 449     if args.nolsm or args.allcaps or args.nocgroup:
 450         elevatedprivs = "--elevated-privileges="
 451         addpipe = False
 452         if args.nolsm:
 453             if addpipe:
 454                 elevatedprivs+="|"
 455             elevatedprivs+="LSM"
 456             addpipe = True
 457         if args.allcaps:
 458             if addpipe:
 459                 elevatedprivs+="|"
 460             elevatedprivs+="CAP"
 461             addpipe = True
 462         if args.nocgroup:
 463             if addpipe:
 464                 elevatedprivs+="|"
 465             elevatedprivs+="CGROUP"
 466             addpipe = True
 467         command.append(elevatedprivs)
 468     if args.context!=None and not args.nolsm:
 469         command.append("--context="+args.context)
 470     command.append("--")
 471     if args.COMMAND:
 472         command.extend(args.COMMAND)
 473     else:
 474         command.append("/system/bin/sh")
 475
 476     try:
 477         subprocess.run(command)
 478     except KeyboardInterrupt:
 479         pass
 480
 481     if state == "FROZEN":
 482         freeze(args)
 483
 484 def logcat(args):
 485     args.COMMAND = ["/system/bin/logcat"]
 486     args.uid = None
 487     args.gid = None
 488     args.nolsm = None
 489     args.allcaps = None
 490     args.nocgroup = None
 491     args.context = None
 492     shell(args)