libcxlmi-testing/parse_docs.py at main · anisa-su993/libcxlmi-testing · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
import re
import os

def print_opcode_map(opcode_map):
    with open('./output/opcode_map.txt', 'w') as f:
        for opcode, info in opcode_map.items():
            f.write(f"Opcode: {opcode}\n")
            for key, value in info.items():
                f.write(f"  {key}: {value}\n")
            f.write("\n")

def generate_default_opcode_map():
    # Default paths
    print("Generating opcode map using default paths...")
    paths = ["../../docs/Generic-Component-Commands.md",
             "../../docs/Memory-Device-Commands.md",
             "../../docs/FM-API.md"]
    opcode_map = {}

    for path in paths:
        opcode_map.update(parse_markdown_for_opcode_map(path))

    return opcode_map

def parse_markdown_for_opcode_map(file_path):

    with open(file_path, 'r') as f:
        md_content = f.read()

    opcode_map = {}
    current_opcode = None
    current_function = None
    current_req = None
    current_rsp = None

    # Normalize newlines
    lines = md_content.splitlines()
    for i, line in enumerate(lines):
        # Match headers like ## Identify (0001h)
        m = re.match(r'## .+\((\w{4})h\)', line)
        if m:
            current_opcode = m.group(1).lower()
            current_function = None
            current_req = None
            current_rsp = None
            continue

        # Match C function signature and extract function name and param types
        if line.strip().startswith("int cxlmi_cmd"):
            func_line = line.strip().strip('`').strip(';')
            func_match = re.match(r'int (\w+)\s*\(.*', func_line)
            if func_match:
                current_function = func_match.group(1)

                # Check next few lines for *in or *ret to determine req/rsp
                for offset in range(0, 10):
                    if i + offset >= len(lines):
                        break
                    l = lines[i + offset]
                    struct_match = re.search(r'struct\s+(\w+)\s*\*\s*(in|ret)', l)
                    if struct_match:
                        struct_name = struct_match.group(1)
                        direction = struct_match.group(2)
                        if direction == 'in':
                            current_req = f'struct {struct_name}'
                        elif direction == 'ret':
                            current_rsp = f'struct {struct_name}'

                suite = ""
                match os.path.basename(file_path):
                    case "Generic-Component-Commands.md":
                        suite = "GENERIC"
                    case "FM-API.md":
                        suite = 'FMAPI'
                    case "Memory-Device-Commands.md":
                        suite = "MEMDEV"
                    case "Vendor-Specific-Commands.md":
                        suite = "VENDOR"
                    case _:
                        suite = "UNKNOWN"
                if current_opcode:
                    opcode_map[current_opcode] = {
                        'function': current_function,
                        'req': current_req,
                        'rsp': current_rsp,
                        'suite': suite
                    }

    return opcode_map