acrn-config: generate launch script file and apply to the souce file

1. generate launch script file and apply to the source file usage: launch_cfg_gen.py [h]--board <board_info_file> --scenario <scenario_info_file> --launch <launch_info_file> --uosid <uosid id> board_info_file : file name of the board info scenario_info_file : file name of the scenario info launch_info_file : file name of the launch info uosid : the uos id which to launch:[0..max uos id] sample: $ python3 launch_cfg_gen.py --board ../xmls/board-xmls/apl-mrb.xml --scenario ../xmls/config-xmls/apl-mrb/sdc.xml --launch ../xmls/launch_config/mrb_launch.xml --uosid 0 v1-v2: 1). usage: '--vm' -> '--uosid' 2). add 'uuid' option for acrn-dm 3). support parse tag from 'rootfs' to 'rootfs_dev' 4). support parse tag from 'hard_rtos' to 'Preempt-Rt Linux' 5). support pasre tag from 'redirect_console' to 'console_type' 6). add 'nvme' passthrough option 7). modify uos_type to upper string in webUI 8). support to generate launch file by uosid, this map to scenario id Tracked-On: #3602 Signed-off-by: Wei Liu <weix.w.liu@intel.com> Acked-by: Terry Zou <terry.zou@intel.com>
2026-06-08 10:04:42 +00:00 · 2019-09-18 09:10:53 +08:00
parent 911be1d3b6
commit 86e73a4610
6 changed files with 1754 additions and 33 deletions
--- a/misc/acrn-config/library/launch_cfg_lib.py
+++ b/misc/acrn-config/library/launch_cfg_lib.py
@@ -0,0 +1,532 @@
+# Copyright (C) 2019 Intel Corporation. All rights reserved.
+#
+# SPDX-License-Identifier: BSD-3-Clause
+#
+
+import os
+import getopt
+import common
+
+SOURCE_ROOT_DIR = common.SOURCE_PATH
+BOARD_INFO_FILE = "board_info.txt"
+SCENARIO_INFO_FILE = ""
+LAUNCH_INFO_FILE = ""
+
+ERR_LIST = {}
+BOOT_TYPE = ['no', 'vsbl', 'ovmf']
+RTOS_TYPE = ['no', 'Soft RT', 'Hard RT']
+REDIRECT_CONSOLE = ['com1(ttyS0)', 'virtio-console(hvc0)']
+UOS_TYPES = ['CLEARLINUX', 'ANDROID', 'ALIOS', 'PREEMPT-RT LINUX', 'VXWORKS', 'WINDOWS', 'ZEPHYR', 'GENERIC LINUX']
+GVT_ARGS = ['64 448 8']
+
+RE_CONSOLE_MAP = {
+        "com1(ttyS0)":"virtio-console,@pty:pty_port",
+        "virtio-console(hvc0)":"virtio-console,@stdio:stdio_port"
+}
+
+PT_SUB_PCI = {}
+PT_SUB_PCI['usb_xdci'] = ['USB controller']
+PT_SUB_PCI['ipu'] = ['Multimedia controller']
+PT_SUB_PCI['ipu_i2c'] = ['Signal processing controller']
+PT_SUB_PCI['cse'] = ['Communication controller']
+PT_SUB_PCI['audio'] = ['Audio device', 'Multimedia audio controller']
+PT_SUB_PCI['audio_codec'] = ['Signal processing controller']
+PT_SUB_PCI['sd_card'] = ['SD Host controller']
+PT_SUB_PCI['wifi'] = ['Ethernet controller']
+PT_SUB_PCI['bluetooth'] = ['Signal processing controller']
+PT_SUB_PCI['ethernet'] = ['Ethernet controller']
+PT_SUB_PCI['sata'] = ['SATA controller']
+PT_SUB_PCI['nvme'] = ['Non-Volatile memory controller']
+
+# passthrough device of board and uos sepcify
+NUC_RT_PASSTHRU = ['ethernet', 'nvme', 'sata']
+NUC_WIN_PASSTHRU = ['audio', 'audio_codec']
+NUC_CLR_PASSTHRU = ['usb_xdci', 'ipu', 'ipu_i2c', 'cse', 'audio', 'audio_codec', 'sd_card', 'ethernet', 'bluetooth']
+UP2_CLR_PASSTHRU = ['usb_xdci', 'ipu', 'ipu_i2c', 'cse']
+UP2_ADR_PASSTHRU = ['usb_xdci', 'audio', 'audio_codec']
+MRB_CLR_PASSTHRU = ['usb_xdci', 'ipu', 'ipu_i2c', 'cse', 'sd_card']
+MRB_ADR_PASSTHRU = ['usb_xdci', 'audio', 'audio_codec', 'sd_card', 'wifi', 'bluetooth']
+GENERIC_PASSTHRU = ['usb_xdci', 'ipu', 'ipu_i2c', 'cse', 'audio', 'sata', 'nvme', 'audio_codec', 'sd_card', 'ethernet', 'wifi', 'bluetooth']
+
+PT_SLOT = {
+        "hostbridge":0,
+        "lpc":1,
+        "pci-gvt":2,
+        "virtio-blk":3,
+        "audio_codec":24
+    }
+
+
+POST_UUID_DIC = {}
+
+
+def prepare():
+    """ Check environment """
+    return common.check_env()
+
+
+def print_yel(msg, warn=False):
+    """
+    Print the message with color of yellow
+    :param msg: the stings which will be output to STDOUT
+    :param warn: the condition if needs to be output the color of yellow with 'Warning'
+    """
+    common.print_if_yel(msg, warn)
+
+
+def print_red(msg, err=False):
+    """
+    Print the message with color of red
+    :param msg: the stings which will be output to STDOUT
+    :param err: the condition if needs to be output the color of red with 'Error'
+    """
+    common.print_if_red(msg, err)
+
+
+def usage(file_name):
+    """ This is usage for how to use this tool """
+    print("usage= {} [h]".format(file_name), end="")
+    print("--board <board_info_file> --scenario <scenario_info_file> --launch <launch_info_file> --uosid <uosid id>")
+    print('board_info_file :  file name of the board info')
+    print('scenario_info_file :  file name of the scenario info')
+    print('launch_info_file :  file name of the launch info')
+    print('uosid :  the vm id which to launch:[0..max uosid id]')
+
+
+def get_param(args):
+    """
+    Get the script parameters from command line
+    :param args: this the command line of string for the script without script name
+    """
+    vm_th = '0'
+    err_dic = {}
+    board_info_file = False
+    scenario_info_file = False
+    launch_info_file = False
+
+    if '--board' not in args or '--scenario' not in args or '--launch' not in args or '--uosid' not in args:
+        usage(args[0])
+        err_dic['common error: get wrong parameter'] = "wrong usage"
+        return (err_dic, board_info_file, scenario_info_file, launch_info_file, int(vm_th))
+
+    args_list = args[1:]
+    (optlist, args_list) = getopt.getopt(args_list, '', ['board=', 'scenario=', 'launch=', 'uosid='])
+    for arg_k, arg_v in optlist:
+        if arg_k == '--board':
+            board_info_file = arg_v
+        if arg_k == '--scenario':
+            scenario_info_file = arg_v
+        if arg_k == '--launch':
+            launch_info_file = arg_v
+        if '--uosid' in args:
+            if arg_k == '--uosid':
+                vm_th = arg_v
+                if not vm_th.isnumeric():
+                    err_dic['common error: get wrong parameter'] = "--uosid should be a number"
+                    return (err_dic, board_info_file, scenario_info_file, launch_info_file, int(vm_th))
+
+    if not board_info_file or not scenario_info_file or not launch_info_file:
+        usage(args[0])
+        err_dic['common error: get wrong parameter'] = "wrong usage"
+        return (err_dic, board_info_file, scenario_info_file, launch_info_file, int(vm_th))
+
+    if not os.path.exists(board_info_file):
+        err_dic['common error: get wrong parameter'] = "{} is not exist!".format(board_info_file)
+        return (err_dic, board_info_file, scenario_info_file, launch_info_file, int(vm_th))
+
+    if not os.path.exists(scenario_info_file):
+        err_dic['common error: get wrong parameter'] = "{} is not exist!".format(scenario_info_file)
+        return (err_dic, board_info_file, scenario_info_file, launch_info_file, int(vm_th))
+
+    if not os.path.exists(launch_info_file):
+        err_dic['common error: get wrong parameter'] = "{} is not exist!".format(launch_info_file)
+        return (err_dic, board_info_file, scenario_info_file, launch_info_file, int(vm_th))
+
+    return (err_dic, board_info_file, scenario_info_file, launch_info_file, int(vm_th))
+
+
+def get_scenario_uuid():
+    # {id_num:uuid} (id_num:0~max)
+    scenario_uuid_dic = {}
+    scenario_uuid_dic = common.get_branch_tag_map(SCENARIO_INFO_FILE, 'uuid')
+    return scenario_uuid_dic
+
+
+def get_post_num_list():
+    """
+    Get board name from launch.xml at fist line
+    :param scenario_file: it is a file what contains scenario information for script to read from
+    """
+    post_num_list = common.get_post_num_list(LAUNCH_INFO_FILE)
+    # {launch_id:scenario_id}
+    return post_num_list
+
+
+def get_post_vm_cnt():
+    """
+    Get board name from launch.xml at fist line
+    :param scenario_file: it is a file what contains scenario information for script to read from
+    """
+    launch_vm_count = common.launch_vm_cnt(LAUNCH_INFO_FILE)
+    post_vm_count = common.post_vm_cnt(SCENARIO_INFO_FILE)
+    return (launch_vm_count, post_vm_count)
+
+
+def get_pci_info(board_info):
+    pci_bdf_vpid = {}
+    pci_vid_start = False
+    pci_vid_end = False
+    pci_desc = {}
+    pci_start = False
+    pci_end = False
+
+    with open(board_info, 'r') as f:
+        while True:
+            line = f.readline()
+            if not line:
+                break
+
+            s = " "
+            if s.join(line.split()[0:2]) == "<PCI_DEVICE>":
+                pci_start = True
+                pci_end = False
+                continue
+
+            if s.join(line.split()[0:2]) == "</PCI_DEVICE>":
+                pci_start = False
+                pci_end = True
+                continue
+
+            # all pci device wiht description
+            if pci_start and not pci_end:
+                if "Region" in line and "Memory at" in line:
+                    continue
+                bdf = line.split()[0]
+                pci_desc[bdf] = line
+
+            if s.join(line.split()[0:2]) == "<PCI_VID_PID>":
+                pci_vid_start = True
+                pci_vid_end = False
+                continue
+
+            if s.join(line.split()[0:2]) == "</PCI_VID_PID>":
+                pci_vid_start = False
+                pci_vid_end = True
+                continue
+
+            # all pci device with vid/pid and bdf
+            if pci_vid_start and not pci_vid_end:
+                bdf_str = line.split()[0]
+                vid_pid = line.split()[2]
+                pci_bdf_vpid[bdf_str] = vid_pid
+
+    return (pci_desc, pci_bdf_vpid)
+
+
+def get_avl_dev_info(bdf_desc_map, pci_sub_class):
+
+    tmp_pci_desc = []
+    for sub_class in pci_sub_class:
+        for pci_desc_value in bdf_desc_map.values():
+            pci_desc_sub_class = ' '.join(pci_desc_value.strip().split(':')[1].split()[1:])
+            if sub_class == pci_desc_sub_class:
+                tmp_pci_desc.append(pci_desc_value.strip())
+
+    return tmp_pci_desc
+
+
+def get_info(board_info, msg_s, msg_e):
+    """
+    Get information which specify by argument
+    :param board_info: it is a file what contains board information for script to read from
+    :param msg_s: it is a pattern of key stings what start to match from board information
+    :param msg_e: it is a pattern of key stings what end to match from board information
+    """
+    info_lines = common.get_board_info(board_info, msg_s, msg_e)
+    return info_lines
+
+
+def get_rootdev_info(board_info):
+    """
+    Get root devices from board info
+    :param board_info: it is a file what contains board information for script to read from
+    :return: root devices list
+    """
+    rootdev_list = []
+    rootdev_info = get_info(board_info, "<BLOCK_DEVICE_INFO>", "</BLOCK_DEVICE_INFO>")
+
+    if rootdev_info == None:
+        return rootdev_list
+
+    for rootdev_line in rootdev_info:
+        if not rootdev_line:
+            break
+
+        if not common.handle_root_dev(rootdev_line):
+            continue
+
+        root_dev = rootdev_line.strip().split(':')[0]
+        rootdev_list.append(root_dev)
+
+    return rootdev_list
+
+
+def get_scenario_name():
+    """
+    Get board name from scenario.xml at fist line
+    :param scenario_file: it is a file what contains scenario information for script to read from
+    """
+    (err_dic, scenario) = common.get_xml_attrib(SCENARIO_INFO_FILE, "scenario")
+
+    return (err_dic, scenario)
+
+
+def get_board_name():
+    """
+    Get board name from board.xml at fist line
+    :param board_info: it is a file what contains board information for script to read from
+    """
+    (err_dic, board) = common.get_xml_attrib(BOARD_INFO_FILE, "board")
+    return (err_dic, board)
+
+
+def is_config_file_match():
+
+    match = True
+    # check if the board config match scenario config
+    (err_dic, scenario_for_board) = common.get_xml_attrib(SCENARIO_INFO_FILE, "board")
+    (err_dic, board_name) = common.get_xml_attrib(BOARD_INFO_FILE, "board")
+    if scenario_for_board != board_name:
+        err_dic['scenario config: Not match'] = "The board xml and scenario xml should be matched!"
+        match = False
+
+    # check if the board config match launch config
+    (err_dic, launch_for_board) = common.get_xml_attrib(LAUNCH_INFO_FILE, "board")
+    if launch_for_board != board_name:
+        err_dic['launch config: Not match'] = "The board xml and launch xml should be matched!"
+        match = False
+
+    return (err_dic, match)
+
+
+def get_sos_vmid(config_file, tag_str):
+
+    load_list = common.get_branch_tag_val(config_file, tag_str)
+
+    sos_id = 0
+    for load_order in load_list:
+        if load_order == "SOS_VM":
+            break
+
+        sos_id += 1
+
+    return sos_id
+
+
+def get_sub_tree_tag(config_file, tag_str):
+    """
+     This is get tag value by tag_str from config file
+     :param config_file: it is a file what contains information for script to read from
+     :param tag_str: it is key of pattern to config file item
+     :return: value of tag_str item
+     """
+    arg = common.get_spec_branch_tag_val(config_file, tag_str)
+
+    return arg
+
+
+def get_bdf_from_tag(config_file, branch_tag, tag_str):
+    bdf_list = {}
+    bdf_list = common.get_spec_leaf_tag_val(config_file, branch_tag, tag_str)
+
+    # split b:d:f from pci description
+    for idx, bdf_v in bdf_list.items():
+        if bdf_v:
+            bdf_list[idx] = bdf_v.split()[0]
+
+    return bdf_list
+
+
+def get_vpid_from_bdf(bdf_vpid_map, bdf_list):
+    vpid_list = {}
+    post_vm_list = get_post_num_list()
+    for p_id in post_vm_list:
+        for bdf_k, vpid_v in bdf_vpid_map.items():
+            if bdf_k == bdf_list[p_id]:
+                #    print("k:{}, v{}".format(bdf_k, bdf_list[p_id]))
+                # convert "808x:0xxx" to "808x 0xxx"
+                tmp_vpid = " ".join(vpid_v.split(':'))
+                vpid_list[p_id] = tmp_vpid
+            elif not bdf_list[p_id]:
+                vpid_list[p_id] = ''
+
+    return vpid_list
+
+
+def gen_patch(srcs_list, launch_name):
+    """
+    Generate patch and apply to local source code
+    :param srcs_list: it is a list what contains source files
+    :param scenario_name: scenario name
+    """
+    err_dic = common.add_to_patch(srcs_list, launch_name)
+    return err_dic
+
+
+def get_uos_type():
+    """
+    Get uos name from launch.xml at fist line
+    """
+    uos_types = get_sub_tree_tag(LAUNCH_INFO_FILE, "uos_type")
+
+    return uos_types
+
+
+def is_bdf_format(bdf_str):
+    bdf_len = 7
+    status = True
+    if not bdf_str:
+        return status
+
+    bdf_str_len = len(bdf_str)
+    if ':' in bdf_str and '.' in bdf_str and bdf_len == bdf_str_len:
+        status = True
+    else:
+        status = False
+
+    return status
+
+
+def is_vpid_format(vpid_str):
+    status = True
+    if not vpid_str:
+        return status
+
+    vpid_len = 9
+    vpid_str_len = len(vpid_str)
+
+    if ' ' in vpid_str and vpid_len == vpid_str_len:
+        status = True
+    else:
+        status = False
+
+    return status
+
+
+def pt_devs_check(bdf_list, vpid_list, item):
+    i_cnt = 1
+
+    # check bdf
+    for bdf_str in bdf_list.values():
+        if is_bdf_format(bdf_str):
+            continue
+        else:
+            key = "uos,id={},passthrough_devices,{}".format(i_cnt, item)
+            ERR_LIST[key] = "Unkonw the BDF format of {} device".format(item)
+        i_cnt += 1
+
+    # check vpid
+    i_cnt = 1
+    for vpid_str in vpid_list.values():
+        if is_vpid_format(vpid_str):
+            continue
+        else:
+            key = "uos,id={},passthrough_devices,{}".format(i_cnt, item)
+            ERR_LIST[key] = "Unkonw the Vendor:Product ID format of {} device".format(item)
+
+        i_cnt += 1
+
+
+def args_aval_check(arg_list, item, avl_list):
+
+    # allow args of dm is empty in launch xml
+    return
+    err_dic = {}
+    i_cnt = 1
+    for arg_str in arg_list.values():
+        if arg_str == None or not arg_str:
+            key = "uos,id={},{}".format(i_cnt, item)
+            err_dic[key] = "The parameter should not be empty"
+
+        if arg_str not in avl_list:
+            key = "uos,id={},{}".format(i_cnt, item)
+            ERR_LIST[key] = "The {} is invalidate".format(item)
+            if err_dic:
+                ERR_LIST.update(err_dic)
+        i_cnt += 1
+
+
+def virtual_dev_slot(dev):
+    max_slot = 31
+    base_slot = 3
+
+    #slot_used_len = len(list(PT_SLOT.values()))
+
+    # get devices slot which already stored
+    if dev in list(PT_SLOT.keys()):
+        return PT_SLOT[dev]
+
+    # alloc a new slot for device
+    for slot_num in range(base_slot, max_slot):
+        if slot_num not in list(PT_SLOT.values()):
+
+            if (slot_num == 6 and 14 in list(PT_SLOT.values())) or (slot_num == 14 and 6 in list(PT_SLOT.values())):
+                continue
+            if (slot_num == 7 and 15 in list(PT_SLOT.values())) or (slot_num == 15 and 7 in list(PT_SLOT.values())):
+                continue
+
+            PT_SLOT[dev] = slot_num
+            break
+
+    return slot_num
+
+
+def get_slot(bdf_list, dev):
+
+    slot_list = {}
+    post_vm_list = get_post_num_list()
+    for p_id in post_vm_list:
+        if not bdf_list[p_id]:
+            slot_list[p_id] = ''
+        else:
+            slot = int(bdf_list[p_id][3:5], 16)
+            # re-allocate virtual slot while slot is 0
+            if slot == 0:
+                slot = virtual_dev_slot(dev)
+            slot_list[p_id] = slot
+            PT_SLOT[dev] = slot
+
+    return slot_list
+
+
+def get_board_pt_dev(names, vmid):
+
+    board_name = names['board_name']
+    uos_type = names['uos_types'][vmid]
+    cap_pt = []
+
+    if 'mrb' in board_name:
+        if uos_type == "CLEARLINUX":
+            cap_pt = MRB_CLR_PASSTHRU
+        if uos_type == "ANDROID":
+            cap_pt = MRB_ADR_PASSTHRU
+    elif 'up2' in board_name:
+        if uos_type == "CLEARLINUX":
+            cap_pt = UP2_CLR_PASSTHRU
+        if uos_type == "ANDROID":
+            cap_pt = UP2_ADR_PASSTHRU
+    elif 'nuc' in board_name:
+        if uos_type == "CLEARLINUX":
+            cap_pt = NUC_CLR_PASSTHRU
+        elif uos_type == "PREEMPT-RT LINUX":
+            cap_pt = NUC_RT_PASSTHRU
+        elif uos_type == "WINDOWS":
+            cap_pt = NUC_WIN_PASSTHRU
+        else:
+            # zephyr/vxworks have no passthroug device
+            cap_pt = []
+    else:
+        # new board passthrough the generic device
+        cap_pt = GENERIC_PASSTHRU
+
+    return cap_pt