YAML Coverage Data Format

The YAML coverage-data format is used to represent functional coverage data in a manner that is accurate and relatively easy for humans and tools to create and process.

Format Reference

Coverage Data

https://fvutils.github.io/pyucis/coverage.json
PyUCIS JSON Coverage Data
type	object
properties
coverage	type	object
	properties
	covergroups	List of covergroup types
		type	array
		items	Type Covergroup

Every coverage-data document has a coverage element as its root. Currently, the only sub-elements is a list of covergroup types.

Type Covergroup

Holds data about a single covergroup type
type	object
properties
name	Type name of the covergroup
	type	string
weight	Weight this covergroup is given against the others
	type	integer
instances	List of covergroup instances of this type
	type	array
	items	Inst Covergroup

A type covergroup provides data about a covergroup type. All instances of a covergroup type have the same coverpoints and crosses. All coverpoints in instances of a covergroup type have the same bins. Merged type coverage (the union of coverage achieved by all instances) is derived by PyUCIS from the instance coverage, and is not specified in the coverage file.

Inst Covergroup

Holds data about a single covergroup instance
type	object
properties
name	Instance name of this covergroup
	type	string
coverpoints	List of coverpoints
	type	array
	items	Coverpoint
crosses	List of crosses
	type	array
	items	Cross

An instance covergroup provides data about a covergroup instance.

Coverpoint

Holds data about a single instance coverpoint
type	object
properties
name	Name of the coverpoint
	type	string
atleast	Number of bin hits required for coverage (default=1)
	type	integer
bins	List of coverage bins
	type	array
	items	Coverage Bin
ignorebins	List of ignore bins
	type	array
	items	Coverage Bin
illegalbins	List of illegal bins
	type	array
	items	Coverage Bin

A coverpoint lists a set of bins that it is monitoring. Each coverpoint can specify an atleast count to specify that a bin must contain atleast hits in order to count as being covered. By default, atleast is 1.

Cross

type	object
properties
name	Cross name
	type	string
atleast	Number of bin hits required for coverage (default=1)
	type	integer
coverpoints	List of coverpoint members of this cross
	type	array
	items	type	string
bins	List of cross bins
	type	array
	items	Coverage Bin

A cross lists the set of coverpoints from which it is composed, and lists its cross bins. Each cross can specify an atleast count to specify that a bin must contain atleast hits in order to count as being covered. By default, atleast is 1.

Coverage Bin

type	object
properties
name	Bin name
	type	string
count	Hits in this bin
	type	integer

A coverbin associates a bin name with the number of hits in that bin.