[Subtyping Generator] Generate subtype check for runtime static-types

[SupunS]

Work towards #3691

Description

Includes only the changes to related to the subtype-check "generation". This doesn't integrate the generated function to the runtime. I have opened a separate PR #4322 to integrate the generated function.

---

• Targeted PR against master branch
• Linked to Github issue with discussion and accepted design OR link to spec that describes this work
• Code follows the standards mentioned here
• Updated relevant documentation
• Re-reviewed Files changed in the Github PR explorer
• Added appropriate labels

[github-actions]

Benchstat comparison

• Base branch: onflow:feature/subtype-gen
• Base commit: 3a91a73

Results

	old.txt	new.txt
	time/op		delta
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ContractFunctionInvocation-4	411µs ± 0%	409µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
Emit-4	4.19ms ± 0%	4.09ms ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ExportType/composite_type-4	277ns ± 0%	261ns ± 0%	~	(p=1.000 n=1+1)
ExportType/simple_type-4	77.8ns ± 0%	79.0ns ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ImperativeFib-4	21.1µs ± 0%	21.1µs ± 0%	~	(p=1.000 n=1+1)
InterpretRecursionFib-4	2.30ms ± 0%	2.33ms ± 0%	~	(p=1.000 n=1+1)
NewInterpreter/new_interpreter-4	1.03µs ± 0%	1.03µs ± 0%	~	(p=1.000 n=1+1)
NewInterpreter/new_sub-interpreter-4	319ns ± 0%	316ns ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
QualifiedIdentifierCreation/One_level-4	2.19ns ± 0%	2.21ns ± 0%	~	(p=1.000 n=1+1)
QualifiedIdentifierCreation/Three_levels-4	82.6ns ± 0%	86.0ns ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
RuntimeFungibleTokenTransferInterpreter-4	586µs ± 0%	589µs ± 0%	~	(p=1.000 n=1+1)
RuntimeFungibleTokenTransferVM-4	629µs ± 0%	645µs ± 0%	~	(p=1.000 n=1+1)
RuntimeResourceDictionaryValues-4	2.71ms ± 0%	2.65ms ± 0%	~	(p=1.000 n=1+1)
RuntimeResourceTracking-4	12.9ms ± 0%	12.1ms ± 0%	~	(p=1.000 n=1+1)
RuntimeScriptNoop-4	14.9µs ± 0%	14.9µs ± 0%	~	(p=1.000 n=1+1)
RuntimeVMInvokeContractImperativeFib-4	27.7µs ± 0%	27.9µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
SuperTypeInference/arrays-4	218ns ± 0%	218ns ± 0%	~	(all equal)
SuperTypeInference/composites-4	90.2ns ± 0%	90.1ns ± 0%	~	(p=1.000 n=1+1)
SuperTypeInference/integers-4	303ns ± 0%	304ns ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ValueIsSubtypeOfSemaType-4	66.5ns ± 0%	69.9ns ± 0%	~	(p=1.000 n=1+1)
	alloc/op		delta
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ContractFunctionInvocation-4	153kB ± 0%	153kB ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
Emit-4	1.48MB ± 0%	1.48MB ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ExportType/composite_type-4	120B ± 0%	120B ± 0%	~	(all equal)
ExportType/simple_type-4	0.00B	0.00B	~	(all equal)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ImperativeFib-4	8.30kB ± 0%	8.30kB ± 0%	~	(all equal)
InterpretRecursionFib-4	1.19MB ± 0%	1.19MB ± 0%	~	(all equal)
NewInterpreter/new_interpreter-4	976B ± 0%	976B ± 0%	~	(all equal)
NewInterpreter/new_sub-interpreter-4	232B ± 0%	232B ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
QualifiedIdentifierCreation/One_level-4	0.00B	0.00B	~	(all equal)
QualifiedIdentifierCreation/Three_levels-4	64.0B ± 0%	64.0B ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
RuntimeFungibleTokenTransferInterpreter-4	159kB ± 0%	159kB ± 0%	~	(p=1.000 n=1+1)
RuntimeFungibleTokenTransferVM-4	173kB ± 0%	173kB ± 0%	~	(p=1.000 n=1+1)
RuntimeResourceDictionaryValues-4	1.76MB ± 0%	1.76MB ± 0%	~	(p=1.000 n=1+1)
RuntimeResourceTracking-4	9.28MB ± 0%	9.27MB ± 0%	~	(p=1.000 n=1+1)
RuntimeScriptNoop-4	8.04kB ± 0%	8.04kB ± 0%	~	(p=1.000 n=1+1)
RuntimeVMInvokeContractImperativeFib-4	9.80kB ± 0%	9.80kB ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
SuperTypeInference/arrays-4	96.0B ± 0%	96.0B ± 0%	~	(all equal)
SuperTypeInference/composites-4	0.00B	0.00B	~	(all equal)
SuperTypeInference/integers-4	0.00B	0.00B	~	(all equal)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ValueIsSubtypeOfSemaType-4	48.0B ± 0%	48.0B ± 0%	~	(all equal)
	allocs/op		delta
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ContractFunctionInvocation-4	2.46k ± 0%	2.46k ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
Emit-4	39.0k ± 0%	39.0k ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ExportType/composite_type-4	3.00 ± 0%	3.00 ± 0%	~	(all equal)
ExportType/simple_type-4	0.00	0.00	~	(all equal)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ImperativeFib-4	176 ± 0%	176 ± 0%	~	(all equal)
InterpretRecursionFib-4	17.7k ± 0%	17.7k ± 0%	~	(all equal)
NewInterpreter/new_interpreter-4	15.0 ± 0%	15.0 ± 0%	~	(all equal)
NewInterpreter/new_sub-interpreter-4	4.00 ± 0%	4.00 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
QualifiedIdentifierCreation/One_level-4	0.00	0.00	~	(all equal)
QualifiedIdentifierCreation/Three_levels-4	2.00 ± 0%	2.00 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
RuntimeFungibleTokenTransferInterpreter-4	2.98k ± 0%	2.98k ± 0%	~	(all equal)
RuntimeFungibleTokenTransferVM-4	3.00k ± 0%	3.00k ± 0%	~	(all equal)
RuntimeResourceDictionaryValues-4	36.7k ± 0%	36.7k ± 0%	~	(all equal)
RuntimeResourceTracking-4	159k ± 0%	159k ± 0%	~	(p=1.000 n=1+1)
RuntimeScriptNoop-4	113 ± 0%	113 ± 0%	~	(all equal)
RuntimeVMInvokeContractImperativeFib-4	197 ± 0%	197 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
SuperTypeInference/arrays-4	3.00 ± 0%	3.00 ± 0%	~	(all equal)
SuperTypeInference/composites-4	0.00	0.00	~	(all equal)
SuperTypeInference/integers-4	0.00	0.00	~	(all equal)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ValueIsSubtypeOfSemaType-4	1.00 ± 0%	1.00 ± 0%	~	(all equal)

[codecov]

Codecov Report

❌ Patch coverage is 0.34188% with 583 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
interpreter/subtype_check.gen.go	0.00%	260 Missing ⚠️
interpreter/type_check_gen/customizer.go	0.00%	164 Missing ⚠️
interpreter/subtype_check.go	0.00%	64 Missing ⚠️
interpreter/type_check_gen/main.go	0.00%	47 Missing ⚠️
interpreter/statictype.go	0.00%	31 Missing ⚠️
bbq/vm/context.go	0.00%	13 Missing ⚠️
interpreter/interface.go	0.00%	2 Missing ⚠️
interpreter/interpreter.go	0.00%	2 Missing ⚠️

📢 Thoughts on this report? Let us know!

[turbolent]

Great work! 👏

Just to clarify the currently generated code falls back to converting to sema types when necessary (e.g. to determine if a type is resource-typed, which isn't known at the static type level), right?

[SupunS]

Just to clarify the currently generated code falls back to converting to sema types when necessary (e.g. to determine if a type is resource-typed, which isn't known at the static type level), right?

@turbolent Yes, that's correct.