6. Code Docs

6.1. Normalizer-Module

riscv_isac.cgf_normalize.alternate(var, size, signed=True, fltr_func=None, scale_func=None)

This function converts an abstract alternate function into individual coverpoints that can be used by ISAC. The unrolling of the function accounts of the size, sign-bit, filters and scales. The unrolled coverpoints will contain a pattern of alternating 1s and 0s. The final coverpoints can vary depending on the filtering and scaling functions

Parameters

• var (str) – input variable that needs to be assigned the coverpoints

• size (int) – size of the bit-vector to generate walking-1s

• signed (bool) – when true indicates that the unrolled points be treated as signed integers.

• fltr_func (function) – a lambda function which defines a filtering routine to keep only a certain values from the unrolled coverpoints

• scale_func (function) – a lambda function which defines the scaling that should be applied to the unrolled coverpoints that have been generated.

Result

dictionary of unrolled filtered and scaled coverpoints

riscv_isac.cgf_normalize.expand_cgf(cgf, xlen)

This function will replace all the abstract functions with their unrolled coverpoints

Parameters

• cgf (dict) – input cgf yaml

• xlen (int) – XLEN of the riscv-trace

riscv_isac.cgf_normalize.twos(val, bits)

Finds the twos complement of the number :param val: input to be complemented :param bits: size of the input

Result

two’s complement version of the input

riscv_isac.cgf_normalize.walking_ones(var, size, signed=True, fltr_func=None, scale_func=None)

This function converts an abstract walking-ones function into individual coverpoints that can be used by ISAC. The unrolling of the function accounts of the size, sign-bit, filters and scales. The unrolled coverpoints will contain a pattern a single one trickling down from LSB to MSB. The final coverpoints can vary depending on the filtering and scaling functions

Parameters

• var (str) – input variable that needs to be assigned the coverpoints

• size (int) – size of the bit-vector to generate walking-1s

• signed (bool) – when true indicates that the unrolled points be treated as signed integers.

• fltr_func (function) – a lambda function which defines a filtering routine to keep only a certain values from the unrolled coverpoints

• scale_func (function) – a lambda function which defines the scaling that should be applied to the unrolled coverpoints that have been generated.

Result

dictionary of unrolled filtered and scaled coverpoints

riscv_isac.cgf_normalize.walking_zeros(var, size, signed=True, fltr_func=None, scale_func=None)

This function converts an abstract walking-zeros function into individual coverpoints that can be used by ISAC. The unrolling of the function accounts of the size, sign-bit, filters and scales. The unrolled coverpoints will contain a pattern a single zero trickling down from LSB to MSB. The final coverpoints can vary depending on the filtering and scaling functions

Parameters

• var (str) – input variable that needs to be assigned the coverpoints

• size (int) – size of the bit-vector to generate walking-1s

• signed (bool) – when true indicates that the unrolled points be treated as signed integers.

• fltr_func (function) – a lambda function which defines a filtering routine to keep only a certain values from the unrolled coverpoints

• scale_func (function) – a lambda function which defines the scaling that should be applied to the unrolled coverpoints that have been generated.

Result

dictionary of unrolled filtered and scaled coverpoints

6.2. Coverage-Module

6.3. Parser-Module

Parser for the execution trace file

riscv_isac.parsers.C_OPCODES = {0: <function quad0>, 1: <function quad1>, 2: <function quad2>}

Instruction OP-CODES dict for 16-bit instructions

riscv_isac.parsers.OPCODES = {3: <function load_ops>, 7: <function flw_fld>, 15: <function fence_ops>, 19: <function arithi_ops>, 23: <function auipc>, 27: <function rv64i_arithi_ops>, 35: <function store_ops>, 39: <function fsw_fsd>, 47: <function rv64_rv32_atomic_ops>, 51: <function arith_ops>, 55: <function lui>, 59: <function rv64i_arith_ops>, 67: <function fmadd>, 71: <function fmsub>, 75: <function fnmsub>, 79: <function fnmadd>, 83: <function rv32_rv64_float_ops>, 99: <function branch_ops>, 103: <function jalr>, 111: <function jal>, 115: <function control_ops>}

Instruction Op-Codes dict for 32-bit instructions

riscv_isac.parsers.extractAddress(line, mode='standard')

Function to extract the address from the line Check for the mode - spike or standard

riscv_isac.parsers.extractInstruction(line, mode='standard')

Function to extract the instruction code from the line Check for the mode - spike or standard

riscv_isac.parsers.extractOpcode(instr)

Function to extract the opcode from the instruction hex

riscv_isac.parsers.extractRegisterCommitVal(line, mode)

Function to extract the register commit value Only works for spike mode

riscv_isac.parsers.instr_pattern_c_sail_regt_reg_val = re.compile('(?P<regt>[xf])(?P<reg>[\\d]+)\\s<-\\s(?P<val>[0-9xABCDEF]+)')

Regex pattern and functions for extracting instruction and address

class riscv_isac.parsers.instructionObject(instr_name, instr_addr, rd=None, rs1=None, rs2=None, rs3=None, imm=None, csr=None, shamt=None)

Instruction object class

__init__(instr_name, instr_addr, rd=None, rs1=None, rs2=None, rs3=None, imm=None, csr=None, shamt=None)

Constructor.

Parameters

• instr_name – name of instruction as accepted by a standard RISC-V assembler

• instr_addr – pc value of the instruction

• rd – tuple containing the register index and registerfile (x or f) that will be updated by this instruction

• rs1 – typle containing the register index and registerfilr ( x or f) that will be used as the first source operand.

• rs2 – typle containing the register index and registerfilr ( x or f) that will be used as the second source operand.

• rs3 – typle containing the register index and registerfilr ( x or f) that will be used as the third source operand.

• imm – immediate value, if any, used by the instruction

• csr – csr index, if any, used by the instruction

• shamt – shift amount, if any, used by the instruction

__str__()

Return str(self).

__weakref__

list of weak references to the object (if defined)

riscv_isac.parsers.parseCompressedInstruction(input_line, mode, arch)

Parse a compressed instruction Args: input_line - Line from the log file Returns: (instr_obj)

riscv_isac.parsers.parseInstruction(input_line, mode, arch='rv32')

Check if we are parsing compressed or normal instructions

riscv_isac.parsers.parseStandardInstruction(input_line, mode, arch)

Parse an input line and decode the instruction Args: input_line - Line from the log file Returns: (instr_name, rd, rs1, rs2, imm)

riscv_isac.parsers.quad0(instr, addr, arch)

Parse instructions from Quad0 of the Compressed extension in the RISCV-ISA-Standard

riscv_isac.parsers.quad1(instr, addr, arch)

Parse instructions from Quad1 of the Compressed extension in the RISCV-ISA-Standard

riscv_isac.parsers.quad2(instr, addr, arch)

Parse instructions from Quad2 of the Compressed extension in the RISCV-ISA-Standard