Class: UdbGen::IsaExplorer::TableBuilder

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/udb-gen/generators/isa_explorer/table_builder.rb

Instance Method Summary collapse

Constructor Details

#initialize(arch, skip) ⇒ TableBuilder

Returns a new instance of TableBuilder.



16
17
18
19
 
# File 'lib/udb-gen/generators/isa_explorer/table_builder.rb', line 16

def initialize(arch, skip)
  @arch = arch
  @skip = skip
end

Instance Method Details

#csr_table ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/udb-gen/generators/isa_explorer/table_builder.rb', line 158

def csr_table
  sorted_releases = sorted_profile_releases

  table = {
    # Array of hashes
    "columns" => [
      { name: "CSR Name", formatter: "link", sorter: "alphanum", headerFilter: true, frozen: true, formatterParams:
        {
        labelField: "CSR Name",
        urlPrefix: "https://riscv.github.io/riscv-unified-db/manual/html/isa/isa_20240411/csrs/"
        }
      },
      { name: "Address", formatter: "textarea", sorter: "number", headerFilter: true },
      { name: "Description", formatter: "textarea", sorter: "alphanum", headerFilter: true },
      sorted_releases.map do |pr|
        { name: "#{pr.name}", formatter: "textarea", sorter: "alphanum", headerFilter: true }
      end
    ].flatten,

    # Will eventually be an array containing arrays.
    "rows" => []
    }

  csrs = @arch.csrs.sort_by!(&:name)
  progressbar = TTY::ProgressBar.new("CSR Table [:bar]", total: csrs.size, output: $stdout)

  csrs.each_with_index do |csr, idx|
    progressbar.advance

    if @skip != 0
      next unless (idx % @skip) == 0
    end

    raise "Indirect CSRs not yet supported for CSR #{csr.name}" if csr.address.nil?

    row = [
      csr.name,
      csr.address,
      csr.long_name,
    ]

    sorted_releases.each do |pr|
      row.append(presence2char(pr.csr_presence(csr.name)))
    end

    table["rows"].append(row)
  end

  table
end

#ext_table ⇒ Object 



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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/udb-gen/generators/isa_explorer/table_builder.rb', line 23

def ext_table
  sorted_releases = sorted_profile_releases

  table = {
    # Array of hashes
    "columns" => [
      { name: "Extension Name", formatter: "link", sorter: "alphanum", headerFilter: true, frozen: true, formatterParams:
        {
        labelField: "Extension Name",
        urlPrefix: "https://riscv.github.io/riscv-unified-db/manual/html/isa/isa_20240411/exts/"
        }
      },
      { name: "Description", formatter: "textarea", sorter: "alphanum", headerFilter: true },
      { name: "IC", formatter: "textarea", sorter: "alphanum", headerFilter: true },
      { name: "Requires\n(Exts)", formatter: "textarea", sorter: "alphanum" },
      { name: "Transitive Requires\n(Ext)", formatter: "textarea", sorter: "alphanum" },
      { name: "Incompatible\n(Ext Reqs)", formatter: "textarea", sorter: "alphanum" },
      { name: "Ratified", formatter: "textarea", sorter: "boolean", headerFilter: true },
      { name: "Ratification\nDate", formatter: "textarea", sorter: "alphanum", headerFilter: true },
      sorted_releases.map do |pr|
        { name: "#{pr.name}", formatter: "textarea", sorter: "alphanum", headerFilter: true }
      end
    ].flatten,

    # Will eventually be an array containing arrays.
    "rows" => []
    }

  pb = Udb.create_progressbar(
    "Analyzing extensions [:bar] :current/:total",
    total: @arch.extensions.size,
    clear: true
  )

  @arch.extensions.sort_by!(&:name).each_with_index do |ext, idx|
    pb.advance

    if @skip != 0
      next unless (idx % @skip) == 0
    end

    row = [
      ext.name,           # Name
      ext.long_name,      # Description
      ext.compact_priv_type,  # IC
      ext.max_version.ext_requirements(expand: false).map do |cond_ext_req|
        if cond_ext_req.cond.empty?
          cond_ext_req.ext_req.name
        else
          "#{cond_ext_req.ext_req.name} if #{cond_ext_req.cond}"
        end
      end.uniq,  # Requires
      ext.max_version.ext_requirements(expand: true).map do |cond_ext_req|
        if cond_ext_req.cond.empty?
          cond_ext_req.ext_req.name
        else
          "#{cond_ext_req.ext_req.name} if #{cond_ext_req.cond}"
        end
      end.uniq,  # Transitive Requires
      ext.conflicting_extensions.map(&:name),
      ext.ratified,
      if ext.ratified
        rat_date = T.must(ext.min_ratified_version).ratification_date
        if rat_date.nil? || rat_date.empty?
          "UDB MISSING"
        else
          rat_date
        end
      else
        ""
      end
    ]

    sorted_releases.each do |pr|
      row.append(presence2char(pr.extension_presence(ext.name)))
    end

    table["rows"].append(row)
  end

  table
end

#inst_table ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/udb-gen/generators/isa_explorer/table_builder.rb', line 108

def inst_table
  sorted_releases = sorted_profile_releases

  table = {
    # Array of hashes
    "columns" => [
      { name: "Instruction Name", formatter: "link", sorter: "alphanum", headerFilter: true, frozen: true, formatterParams:
        {
        labelField: "Instruction Name",
        urlPrefix: "https://riscv.github.io/riscv-unified-db/manual/html/isa/isa_20240411/insts/"
        }
      },
      { name: "Description", formatter: "textarea", sorter: "alphanum", headerFilter: true },
      { name: "Assembly", formatter: "textarea", sorter: "alphanum", headerFilter: true },
      sorted_releases.map do |pr|
        { name: "#{pr.name}", formatter: "textarea", sorter: "alphanum", headerFilter: true }
      end
    ].flatten,

    # Will eventually be an array containing arrays.
    "rows" => []
    }

  insts = @arch.instructions.sort_by!(&:name)
  progressbar = TTY::ProgressBar.new("Instruction Table [:bar] :current/:total", total: insts.size, output: $stdout)

  insts.each_with_index do |inst, idx|
    progressbar.advance
    if @skip != 0
      next unless (idx % @skip) == 0
    end

    row = [
      inst.name,
      inst.long_name,
      inst.name + " " + inst.assembly.gsub("x", "r")
    ]

    sorted_releases.each do |pr|
      row.append(presence2char(pr.instruction_presence(inst.name)))
    end

    table["rows"].append(row)
  end

  table
end