tools: add parse_report.py to parse nsdk_cli ci run report logs

It will parse the run log for barebench and toolbench and generate
excel report for the benchmark result

Signed-off-by: Huaqi Fang <[email protected]>

tools/scripts/misc/parse_report.py

@@ -0,0 +1,142 @@
+import argparse
+import json
+import os
+import pyexcel as pe
+
+# TODO:
+# 1. Make the generated excel more readable and beautiful
+#    - Make column widths more suitable for the table header
+#    - Make excel content with more beautiful colors and fonts
+
+def parse_runresult(runresult_file, CAREVAR="bench", BENCHTYPE="barebench"):
+    runresult = dict()
+    # Load json result from runresult file runresult.json
+    with open(runresult_file) as f:
+        runresult = json.load(f)
+    parsed_bench = dict()
+    # parse the bench results from runresult json
+    for archcfg in runresult:
+        for benchtype in runresult[archcfg]:
+            # TODO only check barebench results now
+            if benchtype != BENCHTYPE:
+                continue
+            for subtype in runresult[archcfg][benchtype]:
+                # collect the results of barebench
+                # TODO ignore a lot meta data such as code size and compiler info
+                if subtype not in parsed_bench:
+                    parsed_bench[subtype] = dict()
+                if CAREVAR == "bench":
+                    # benchval is a dict like this
+                    # {"DMIPS/MHz": 1.426 } or {"CoreMark/MHz": 1.212} or {"MWIPS/MHz": 0.068}
+                    benchval = runresult[archcfg][benchtype][subtype]["value"]
+                    try:
+                        parsed_bench[subtype][archcfg] = list(benchval.values())[0]
+                    except:
+                        # No value get from value dict
+                        parsed_bench[subtype][archcfg] = ""
+                elif CAREVAR.startswith("size"):
+                    sizeval = runresult[archcfg][benchtype][subtype]["size"]
+                    whichsize = CAREVAR.lstrip("size").split("+")
+                    # by default return total size
+                    if len(whichsize) == 1 and whichsize[0] not in ("text", "data", "bss"):
+                        parsed_bench[subtype][archcfg] = sizeval["total"]
+                    else:
+                        # sum the key found in whichsize
+                        # eg. size:text+data will return the sum of text+data section
+                        sizesum = 0
+                        for szkey in whichsize:
+                            szkey = szkey.strip()
+                            if szkey in ("text", "data", "bss"):
+                                sizesum += sizeval[szkey]
+                        parsed_bench[subtype][archcfg] = sizesum
+    # return the parsed bench result
+    return parsed_bench
+
+def parse_genreport(rptdir, benchtype="barebench", CAREVAR="bench"):
+    # get the list of directory list in rptdir
+    rv32_bench = dict()
+    rv64_bench = dict()
+    for d in os.listdir(rptdir):
+        if d.startswith("."):
+            continue
+        # not a valid barebench directory
+        if os.path.isdir(os.path.join(rptdir, d, benchtype)) == False:
+            continue
+        runresult_json_file = os.path.join(rptdir, d, benchtype, "runresult.json")
+
+        if d.startswith("ux") or d.startswith("nx"):
+            rv64_bench[d] = parse_runresult(runresult_json_file, CAREVAR=CAREVAR)
+        else:
+            rv32_bench[d] = parse_runresult(runresult_json_file, CAREVAR=CAREVAR)
+    return rv32_bench, rv64_bench
+
+
+def shorten_bitname(bitname):
+    first_part = bitname.split("_config")[0]
+    last_part = bitname.split("_")[-1][4:-4]
+    shortname = ""
+    # if "_best" in first_part:
+    #     first_part = first_part.replace("_best", "_b")
+    # if "_dual" in first_part:
+    #     first_part = first_part.replace("_dual", "_DI")
+    if "single" in bitname:
+        shortname = "%s_SI-%s" % (first_part, last_part)
+    else:
+        shortname = "%s-%s" % (first_part, last_part)
+
+    return shortname
+
+def generate_excel_from_bench(rvbench, xlsname):
+    # generate excel using rvbench
+    rvsheets = dict()
+    for bitname in rvbench:
+        for subtype in rvbench[bitname]:
+            if subtype not in rvsheets:
+                rvsheets[subtype] = set()
+            rvsheets[subtype] = set(rvbench[bitname][subtype].keys()).union(rvsheets[subtype])
+    rvwbdict = dict()
+    for subtype in rvsheets:
+        rvsheets[subtype] = sorted(rvsheets[subtype])
+    parsed_configs = []
+    for bitname in rvbench:
+        shortbitname = shorten_bitname(bitname)
+        if shortbitname in parsed_configs:
+            continue
+        parsed_configs.append(shortbitname)
+        for subtype in rvbench[bitname]:
+            if subtype not in rvwbdict:
+                rvwbdict[subtype] = [["config"]]
+                for cfgname in rvsheets[subtype]:
+                    rvwbdict[subtype].append([cfgname])
+            rvwbdict[subtype][0].extend([shorten_bitname(bitname)])
+            cfgindex = 1
+            for cfgname in rvsheets[subtype]:
+                if cfgname in rvbench[bitname][subtype]:
+                    rvwbdict[subtype][cfgindex].extend([rvbench[bitname][subtype][cfgname]])
+                else:
+                    rvwbdict[subtype][cfgindex].extend([""])
+                cfgindex += 1
+    print("Save Excel as %s\n" % (xlsname))
+    # book = pe.isave_book_as(bookdict=rvwbdict, dest_file_name=xlsname)
+    book = pe.get_book(bookdict=rvwbdict)
+    print(book)
+    book.save_as(xlsname)
+    book.save_as(xlsname + ".html")
+
+    pass
+
+def generate_bench_excel(rptdir, benchtype="barebench", CAREVAR="bench"):
+    rv32_bench, rv64_bench = parse_genreport(rptdir, benchtype=benchtype, CAREVAR=CAREVAR)
+    # generate excel using rv32_bench
+    generate_excel_from_bench(rv32_bench, os.path.join(rptdir, "rv32_%s.xlsx" % (benchtype)))
+    generate_excel_from_bench(rv64_bench, os.path.join(rptdir, "rv64_%s.xlsx" % (benchtype)))
+    pass
+
+# 使用argpaser 解析参数，-d 表示待解析的目录
+parser = argparse.ArgumentParser(description='Parse the nsdk_cli run reports')
+parser.add_argument('-d', '--dir', help='directory to parse')
+
+args = parser.parse_args()
+
+for benchtype in ("barebench", "toolbench"):
+    generate_bench_excel(args.dir, benchtype)