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 tools.config
  11 import tools.helpers.run
  12
  13
  14 def get_lxc_version(args):
  15     if shutil.which("lxc-info") is not None:
  16         command = ["lxc-info", "--version"]
  17         version_str = tools.helpers.run.user(args, command, output_return=True)
  18         return int(version_str[0])
  19     else:
  20         return 0
  21
  22
  23 def generate_nodes_lxc_config(args):
  24     def make_entry(src, dist=None, mnt_type="none", options="bind,create=file,optional 0 0", check=True):
  25         if check and not os.path.exists(src):
  26             return False
  27         entry = "lxc.mount.entry = "
  28         entry += src + " "
  29         if dist is None:
  30             dist = src[1:]
  31         entry += dist + " "
  32         entry += mnt_type + " "
  33         entry += options
  34         nodes.append(entry)
  35         return True
  36
  37     nodes = []
  38     # Necessary dev nodes
  39     make_entry("tmpfs", "dev", "tmpfs", "nosuid 0 0", False)
  40     make_entry("/dev/zero")
  41     make_entry("/dev/null")
  42     make_entry("/dev/full")
  43     make_entry("/dev/ashmem", check=False)
  44     make_entry("/dev/fuse")
  45     make_entry("/dev/ion")
  46     make_entry("/dev/char", options="bind,create=dir,optional 0 0")
  47
  48     # Graphic dev nodes
  49     make_entry("/dev/kgsl-3d0")
  50     make_entry("/dev/mali0")
  51     make_entry("/dev/pvr_sync")
  52     make_entry("/dev/pmsg0")
  53     make_entry("/dev/dxg")
  54     make_entry("/dev/dri", options="bind,create=dir,optional 0 0")
  55
  56     for n in glob.glob("/dev/fb*"):
  57         make_entry(n)
  58     for n in glob.glob("/dev/graphics/fb*"):
  59         make_entry(n)
  60     for n in glob.glob("/dev/video*"):
  61         make_entry(n)
  62
  63     # Binder dev nodes
  64     make_entry("/dev/" + args.BINDER_DRIVER, "dev/binder", check=False)
  65     make_entry("/dev/" + args.VNDBINDER_DRIVER, "dev/vndbinder", check=False)
  66     make_entry("/dev/" + args.HWBINDER_DRIVER, "dev/hwbinder", check=False)
  67
  68     if args.vendor_type != "MAINLINE":
  69         if not make_entry("/dev/hwbinder", "dev/host_hwbinder"):
  70             raise OSError('Binder node "hwbinder" of host not found')
  71         make_entry("/vendor", "vendor_extra", options="bind,optional 0 0")
  72
  73     # Necessary device nodes for adb
  74     make_entry("none", "dev/pts", "devpts", "defaults,mode=644,ptmxmode=666,create=dir 0 0", False)
  75     make_entry("/dev/uhid")
  76
  77     # Low memory killer sys node
  78     make_entry("/sys/module/lowmemorykiller", options="bind,create=dir,optional 0 0")
  79
  80     # Mount /data
  81     make_entry("tmpfs", "mnt", "tmpfs", "mode=0755,uid=0,gid=1000", False)
  82     make_entry(tools.config.defaults["data"], "data", options="bind 0 0", check=False)
  83
  84     # Mount host permissions
  85     make_entry(tools.config.defaults["host_perms"],
  86                "vendor/etc/host-permissions", options="bind,optional 0 0")
  87
  88     # Recursive mount /run to provide necessary host sockets
  89     make_entry("/run", options="rbind,create=dir 0 0")
  90
  91     # Necessary sw_sync node for HWC
  92     make_entry("/dev/sw_sync")
  93     make_entry("/sys/kernel/debug", options="rbind,create=dir,optional 0 0")
  94
  95     # Media dev nodes (for Mediatek)
  96     make_entry("/dev/Vcodec")
  97     make_entry("/dev/MTK_SMI")
  98     make_entry("/dev/mdp_sync")
  99     make_entry("/dev/mtk_cmdq")
 100
 101     # WSLg
 102     make_entry("tmpfs", "mnt_extra", "tmpfs", "nodev 0 0", False)
 103     make_entry("/mnt/wslg", "mnt_extra/wslg",
 104                options="rbind,create=dir,optional 0 0")
 105
 106     # var
 107     make_entry("tmpfs", "var", "tmpfs", "nodev 0 0", False)
 108     make_entry("/var/run", options="rbind,create=dir,optional 0 0")
 109
 110     # tmp
 111     make_entry("tmpfs", "tmp", "tmpfs", "nodev 0 0", False)
 112     for n in glob.glob("/tmp/run-*"):
 113         make_entry(n, options="rbind,create=dir,optional 0 0")
 114
 115     return nodes
 116
 117
 118 def set_lxc_config(args):
 119     lxc_path = tools.config.defaults["lxc"] + "/waydroid"
 120     config_file = "config_2"
 121     lxc_ver = get_lxc_version(args)
 122     if lxc_ver == 0:
 123         raise OSError("LXC is not installed")
 124     elif lxc_ver <= 2:
 125         config_file = "config_1"
 126     config_path = tools.config.tools_src + "/data/configs/" + config_file
 127
 128     command = ["mkdir", "-p", lxc_path]
 129     tools.helpers.run.user(args, command)
 130     command = ["cp", "-fpr", config_path, lxc_path + "/config"]
 131     tools.helpers.run.user(args, command)
 132     command = ["sed", "-i", "s/LXCARCH/{}/".format(platform.machine()), lxc_path + "/config"]
 133     tools.helpers.run.user(args, command)
 134
 135     nodes = generate_nodes_lxc_config(args)
 136     config_nodes_tmp_path = args.work + "/config_nodes"
 137     config_nodes = open(config_nodes_tmp_path, "w")
 138     for node in nodes:
 139         config_nodes.write(node + "\n")
 140     config_nodes.close()
 141     command = ["mv", config_nodes_tmp_path, lxc_path]
 142     tools.helpers.run.user(args, command)
 143
 144
 145 def make_base_props(args):
 146     def find_hal(hardware):
 147         hardware_props = [
 148             "ro.hardware." + hardware,
 149             "ro.hardware",
 150             "ro.product.board",
 151             "ro.arch",
 152             "ro.board.platform"]
 153         for p in hardware_props:
 154             prop = tools.helpers.props.host_get(args, p)
 155             if prop != "":
 156                 for lib in ["/odm/lib", "/odm/lib64", "/vendor/lib", "/vendor/lib64", "/system/lib", "/system/lib64"]:
 157                     hal_file = lib + "/hw/" + hardware + "." + prop + ".so"
 158                     if os.path.isfile(hal_file):
 159                         return prop
 160         return ""
 161
 162     props = []
 163     egl = tools.helpers.props.host_get(args, "ro.hardware.egl")
 164
 165     gralloc = find_hal("gralloc")
 166     if gralloc == "":
 167         if os.path.exists("/dev/dri"):
 168             gralloc = "gbm"
 169             egl = "mesa"
 170         else:
 171             gralloc = "default"
 172             egl = "swiftshader"
 173         props.append("debug.stagefright.ccodec=0")
 174     props.append("ro.hardware.gralloc=" + gralloc)
 175
 176     if egl != "":
 177         props.append("ro.hardware.egl=" + egl)
 178
 179     media_profiles = tools.helpers.props.host_get(args, "media.settings.xml")
 180     if media_profiles != "":
 181         media_profiles = media_profiles.replace("vendor/", "vendor_extra/")
 182         media_profiles = media_profiles.replace("odm/", "odm_extra/")
 183         props.append("media.settings.xml=" + media_profiles)
 184
 185     ccodec = tools.helpers.props.host_get(args, "debug.stagefright.ccodec")
 186     if ccodec != "":
 187         props.append("debug.stagefright.ccodec=" + ccodec)
 188
 189     ext_library = tools.helpers.props.host_get(args, "ro.vendor.extension_library")
 190     if ext_library != "":
 191         ext_library = ext_library.replace("vendor/", "vendor_extra/")
 192         ext_library = ext_library.replace("odm/", "odm_extra/")
 193         props.append("ro.vendor.extension_library=" + ext_library)
 194
 195     vulkan = find_hal("vulkan")
 196     if vulkan != "":
 197         props.append("ro.hardware.vulkan=" + vulkan)
 198
 199     treble = tools.helpers.props.host_get(args, "ro.treble.enabled")
 200     if treble != "true":
 201         camera = find_hal("camera")
 202         if camera != "":
 203             props.append("ro.hardware.camera=" + camera)
 204         else:
 205             if args.vendor_type == "MAINLINE":
 206                 props.append("ro.hardware.camera=v4l2")
 207
 208     opengles = tools.helpers.props.host_get(args, "ro.opengles.version")
 209     if opengles == "":
 210         opengles = "196608"
 211     props.append("ro.opengles.version=" + opengles)
 212
 213     props.append("waydroid.system_ota=" + args.system_ota)
 214     props.append("waydroid.vendor_ota=" + args.vendor_ota)
 215     props.append("waydroid.tools_version=" + tools.config.version)
 216
 217     if args.vendor_type == "MAINLINE":
 218         props.append("ro.vndk.lite=true")
 219
 220     base_props = open(args.work + "/waydroid_base.prop", "w")
 221     for prop in props:
 222         base_props.write(prop + "\n")
 223     base_props.close()
 224
 225
 226 def setup_host_perms(args):
 227     if not os.path.exists(tools.config.defaults["host_perms"]):
 228         os.mkdir(tools.config.defaults["host_perms"])
 229
 230     treble = tools.helpers.props.host_get(args, "ro.treble.enabled")
 231     if treble != "true":
 232         return
 233
 234     sku = tools.helpers.props.host_get(args, "ro.boot.product.hardware.sku")
 235     copy_list = []
 236     copy_list.extend(
 237         glob.glob("/vendor/etc/permissions/android.hardware.nfc.*"))
 238     if os.path.exists("/vendor/etc/permissions/android.hardware.consumerir.xml"):
 239         copy_list.append("/vendor/etc/permissions/android.hardware.consumerir.xml")
 240     copy_list.extend(
 241         glob.glob("/odm/etc/permissions/android.hardware.nfc.*"))
 242     if os.path.exists("/odm/etc/permissions/android.hardware.consumerir.xml"):
 243         copy_list.append("/odm/etc/permissions/android.hardware.consumerir.xml")
 244     if sku != "":
 245         copy_list.extend(
 246             glob.glob("/odm/etc/permissions/sku_{}/android.hardware.nfc.*".format(sku)))
 247         if os.path.exists("/odm/etc/permissions/sku_{}/android.hardware.consumerir.xml".format(sku)):
 248             copy_list.append(
 249                 "/odm/etc/permissions/sku_{}/android.hardware.consumerir.xml".format(sku))
 250
 251     for filename in copy_list:
 252         shutil.copy(filename, tools.config.defaults["host_perms"])
 253
 254 def status(args):
 255     command = ["lxc-info", "-P", tools.config.defaults["lxc"], "-n", "waydroid", "-sH"]
 256     out = subprocess.run(command, stdout=subprocess.PIPE).stdout.decode('utf-8').strip()
 257     os.chmod(args.log, 0o666)
 258     return out
 259
 260 def start(args):
 261     command = ["lxc-start", "-P", tools.config.defaults["lxc"],
 262                "-F", "-n", "waydroid", "--", "/init"]
 263     tools.helpers.run.user(args, command, output="background")
 264
 265 def stop(args):
 266     command = ["lxc-stop", "-P",
 267                tools.config.defaults["lxc"], "-n", "waydroid", "-k"]
 268     tools.helpers.run.user(args, command)
 269
 270 def freeze(args):
 271     command = ["lxc-freeze", "-P", tools.config.defaults["lxc"], "-n", "waydroid"]
 272     tools.helpers.run.user(args, command)
 273
 274 def unfreeze(args):
 275     command = ["lxc-unfreeze", "-P",
 276                tools.config.defaults["lxc"], "-n", "waydroid"]
 277     tools.helpers.run.user(args, command)
 278
 279 def shell(args):
 280     if status(args) != "RUNNING":
 281         logging.error("WayDroid container is {}".format(status(args)))
 282         return
 283     command = ["lxc-attach", "-P", tools.config.defaults["lxc"],
 284                "-n", "waydroid", "--"]
 285     if args.COMMAND:
 286         command.append(args.COMMAND)
 287     else:
 288         command.append("/system/bin/sh")
 289     subprocess.run(command, env={"PATH": os.environ['PATH'] + ":/system/bin:/vendor/bin"})
 290
 291 def logcat(args):
 292     if status(args) != "RUNNING":
 293         logging.error("WayDroid container is {}".format(status(args)))
 294         return
 295     command = ["lxc-attach", "-P", tools.config.defaults["lxc"],
 296                "-n", "waydroid", "--", "/system/bin/logcat"]
 297     subprocess.run(command)