Find least common super-type #1025

SupunS · 2021-06-21T06:45:26Z

Work towards #61

Description

This PR introduces a utility method to find the "least common supertype", given a list of types.

Approach:

Each type is represented using a bitmask (Type tag).

e.g:

Int -->      0  0  0  0  0  1
Int8 -->     0  0  0  0  1  0
Int16 -->    0  0  0  1  0  0

Integer -->  0  1  1  1  1  1   (i.e: Int | Int8 | Int16 | ...)

Each 'leaf-type' (types that are not a super type of anyone) has a unique bit, and each super-type has a unique bit-pattern within the bitmask.

'Join of types' and the 'type inclusions' can be found through bitwise operations.

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

codecov-commenter · 2021-06-21T06:53:04Z

Codecov Report

Merging #1025 (1086a93) into master (4348c5d) will increase coverage by 0.07%.
The diff coverage is 94.27%.

@@            Coverage Diff             @@
##           master    #1025      +/-   ##
==========================================
+ Coverage   77.46%   77.53%   +0.07%     
==========================================
  Files         273      274       +1     
  Lines       34764    35085     +321     
==========================================
+ Hits        26929    27204     +275     
- Misses       6760     6801      +41     
- Partials     1075     1080       +5

Flag	Coverage Δ
unittests	`77.53% <94.27%> (+0.07%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
runtime/sema/block.go	`100.00% <ø> (ø)`
runtime/sema/deployed_contract.go	`71.42% <ø> (ø)`
runtime/sema/meta_type.go	`100.00% <ø> (ø)`
runtime/sema/path_type.go	`100.00% <ø> (ø)`
runtime/sema/string_type.go	`100.00% <ø> (ø)`
runtime/sema/type.go	`87.86% <80.95%> (-0.07%)`	⬇️
runtime/sema/type_tags.go	`95.41% <95.41%> (ø)`
runtime/sema/simple_type.go	`92.85% <100.00%> (+0.26%)`	⬆️
runtime/convertTypes.go	`76.54% <0.00%> (-2.61%)`	⬇️
encoding/json/decode.go	`71.12% <0.00%> (-2.07%)`	⬇️
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4348c5d...1086a93. Read the comment docs.

runtime/sema/type_tags.go

…/common-supertype-3

dsainati1

This is really awesome, the bitmask approach is a really cool idea. I wonder though whether it produces some less precise results, since it doesn't take into account the variance of derived types when computing supertypes; it seems based on the test cases that the least common supertype of [String] and [Bool] is AnyStruct, for example, when it could be [AnyStruct].

I couldn't say whether adding this additional precision is valuable or not, but given that arrays, dictionaries and other structures in cadence are all covariant, it seems like we could take advantage of this to produce some more specific results: when the kind of the "container" derived type is the same in a list of types, we should produce a type for their least common supertype that has the same kind for its derived "container".

runtime/sema/type.go

runtime/sema/type_tags.go

runtime/sema/type_test.go

SupunS · 2021-11-08T20:38:13Z

Thank you @dsainati1 for the review!

Regarding the containers, as I mentioned in the comment, we would need to do some extra bit of work to get it working (e.g.: Need a Cadence type to represent all keyable types, etc.), so currently we infer AnyStruct as more of a 'safe' and a simple solution. This PR introduces the base for us to implement complex scenarios like the one you suggested, and we could definitely do it in another iteration/as an improvement. Created an issue #1225 for tracking.

dsainati1

Looks good to me; thanks for opening the issue to follow up on the recursive strategy!

turbolent

Great work! This is going to be very useful 👏

runtime/sema/simple_type.go

runtime/sema/type_tags.go

github-actions · 2021-11-10T16:29:30Z

Cadence Benchstat comparison

This branch with compared with the base branch onflow:master commit 4348c5d
The command go test ./... -run=XXX -bench=. -shuffle=on -count N was used.
Bench tests were run a total of 7 times on each branch.

Results

	old.txt	new.txt
	time/op		delta
RuntimeStorageWriteCached-2	120µs ± 1%	124µs ± 5%	+3.70%	(p=0.017 n=7+7)
ContractInterfaceFungibleToken-2	39.2µs ± 1%	39.8µs ± 2%	+1.58%	(p=0.005 n=6+7)
ParseDeploy/decode_hex-2	1.19ms ± 0%	1.20ms ± 1%	+0.67%	(p=0.011 n=7+7)
RuntimeResourceDictionaryValues-2	14.7ms ± 1%	14.3ms ± 9%	~	(p=0.209 n=7+7)
RuntimeFungibleTokenTransfer-2	1.04ms ± 2%	1.06ms ± 4%	~	(p=0.209 n=7+7)
ParseInfix-2	21.3µs ± 3%	21.2µs ± 1%	~	(p=0.710 n=7+7)
ParseArray-2	19.6ms ± 1%	19.8ms ± 2%	~	(p=0.101 n=6+7)
CheckContractInterfaceFungibleTokenConformance-2	133µs ± 2%	134µs ± 7%	~	(p=0.902 n=7+7)
NewInterpreter/new_interpreter-2	991ns ± 3%	990ns ± 3%	~	(p=0.836 n=7+6)
NewInterpreter/new_sub-interpreter-2	1.79µs ± 1%	1.78µs ± 1%	~	(p=0.435 n=7+7)
InterpretRecursionFib-2	2.42ms ± 1%	2.40ms ± 1%	~	(p=0.065 n=6+6)
ParseFungibleToken-2	402µs ± 2%	398µs ± 1%	−0.90%	(p=0.038 n=7+7)
ParseDeploy/byte_array-2	29.9ms ± 2%	29.4ms ± 1%	−1.51%	(p=0.026 n=7+7)
QualifiedIdentifierCreation/Three_levels-2	142ns ± 1%	139ns ± 1%	−2.36%	(p=0.002 n=7+7)
QualifiedIdentifierCreation/One_level-2	2.68ns ± 0%	2.35ns ± 0%	−12.52%	(p=0.001 n=7+7)

	alloc/op		delta
RuntimeResourceDictionaryValues-2	4.33MB ± 0%	4.33MB ± 0%	~	(p=0.051 n=6+7)
RuntimeFungibleTokenTransfer-2	225kB ± 0%	225kB ± 0%	~	(p=0.434 n=7+7)
RuntimeStorageWriteCached-2	83.7kB ± 0%	83.7kB ± 0%	~	(p=0.098 n=6+7)
QualifiedIdentifierCreation/One_level-2	0.00B	0.00B	~	(all equal)
QualifiedIdentifierCreation/Three_levels-2	64.0B ± 0%	64.0B ± 0%	~	(all equal)
ContractInterfaceFungibleToken-2	26.7kB ± 0%	26.7kB ± 0%	~	(all equal)
CheckContractInterfaceFungibleTokenConformance-2	66.4kB ± 0%	66.4kB ± 0%	~	(all equal)
NewInterpreter/new_interpreter-2	680B ± 0%	680B ± 0%	~	(all equal)
NewInterpreter/new_sub-interpreter-2	1.02kB ± 0%	1.02kB ± 0%	~	(all equal)
InterpretRecursionFib-2	1.21MB ± 0%	1.21MB ± 0%	~	(p=0.385 n=6+7)

	allocs/op		delta
RuntimeResourceDictionaryValues-2	108k ± 0%	108k ± 0%	~	(p=0.272 n=6+7)
RuntimeFungibleTokenTransfer-2	4.38k ± 0%	4.38k ± 0%	~	(all equal)
RuntimeStorageWriteCached-2	1.42k ± 0%	1.42k ± 0%	~	(all equal)
QualifiedIdentifierCreation/One_level-2	0.00	0.00	~	(all equal)
QualifiedIdentifierCreation/Three_levels-2	2.00 ± 0%	2.00 ± 0%	~	(all equal)
ContractInterfaceFungibleToken-2	458 ± 0%	458 ± 0%	~	(all equal)
CheckContractInterfaceFungibleTokenConformance-2	1.07k ± 0%	1.07k ± 0%	~	(all equal)
NewInterpreter/new_interpreter-2	11.0 ± 0%	11.0 ± 0%	~	(all equal)
NewInterpreter/new_sub-interpreter-2	30.0 ± 0%	30.0 ± 0%	~	(all equal)
InterpretRecursionFib-2	25.0k ± 0%	25.0k ± 0%	~	(all equal)

turbolent

Great work! 👏 👍

turbolent · 2021-11-10T22:20:22Z

@SupunS Sorry it took so long to get this in!

SupunS requested a review from turbolent June 21, 2021 06:45

SupunS self-assigned this Jun 21, 2021

SupunS changed the title ~~Supun/common supertype 3~~ Find least common super-type Jun 21, 2021

SupunS force-pushed the supun/common-supertype-3 branch from cf611de to 032de07 Compare June 21, 2021 07:06

SupunS added the Feature label Jun 21, 2021

SupunS force-pushed the supun/common-supertype-3 branch from 032de07 to 7713243 Compare June 21, 2021 07:28

SupunS added 13 commits June 21, 2021 13:02

Add type tags. Get least-common-supertype for simple types

6eaf637

Add 'Tag()' method to sema Type

01c93d9

Add array supertype calculation

165c2ae

Add dictionary supertype calculation

b9befc9

Use 128 bits to represent types

305cac8

Rename type-tags. Add word and float type tags.

82696e6

Use an iota for flag

fe2b9d3

Refactor

e77d6bf

Use type mask constants for switching

00b9f51

Improve supertype tests

b3fe676

Add support for struct supertype calculation

28e905a

Improve numeric supertype calculation

dee6d0a

Refactor & cleanup

b502418

SupunS force-pushed the supun/common-supertype-3 branch 3 times, most recently from 9a8b04f to b0d42b2 Compare June 21, 2021 11:32

Add supertype calculation for remaining types

5ca55cb

SupunS force-pushed the supun/common-supertype-3 branch from b0d42b2 to 5ca55cb Compare June 21, 2021 11:33

SupunS added 4 commits June 21, 2021 21:58

Add path supertypes calculation

b6b2ba5

Replace supertype check with a switch-case

1f1d4ef

Add typetags for block type and deployed contract type

03496eb

Find common interface for composite types

b6c5c9b

SupunS force-pushed the supun/common-supertype-3 branch from 1033722 to b6c5c9b Compare June 24, 2021 05:53

SupunS mentioned this pull request Jul 5, 2021

Infer static type from the value itself for imported arrays/dictionaries #1049

Merged

6 tasks

SupunS commented Oct 15, 2021

View reviewed changes

runtime/sema/type_tags.go Outdated Show resolved Hide resolved

SupunS mentioned this pull request Nov 4, 2021

Check possibility of using type tags for subtyping for better performance #1218

Closed

SupunS added 2 commits November 5, 2021 14:32

Merge branch 'master' of https://github.com/onflow/cadence into supun…

2c594e8

…/common-supertype-3

Reserve type-tags for future fixed point types

9709f1a

SupunS force-pushed the supun/common-supertype-3 branch from cab37bd to 351fdf6 Compare November 5, 2021 22:49

Add missing type inclusions

56f6e53

SupunS force-pushed the supun/common-supertype-3 branch from 351fdf6 to 56f6e53 Compare November 5, 2021 22:52

Refactor tests

2646929

SupunS requested a review from dsainati1 November 6, 2021 01:52

Fix restricted type

efb2bb5

dsainati1 reviewed Nov 8, 2021

View reviewed changes

SupunS added 3 commits November 8, 2021 09:08

Add restricted type tests

0660d23

Fix typo

cce16d9

Add testcase for fixe vs variable sized arrays

7055e5a

SupunS force-pushed the supun/common-supertype-3 branch from 063795b to 7055e5a Compare November 8, 2021 18:25

SupunS added 2 commits November 8, 2021 11:01

Add separate tags for constant and variable sized arrays

31abd0a

Fix commposite types with common interface

ff5c137

Add more tests

c862949

dsainati1 approved these changes Nov 9, 2021

View reviewed changes

turbolent reviewed Nov 9, 2021

View reviewed changes

runtime/sema/simple_type.go Show resolved Hide resolved

runtime/sema/type_tags.go Outdated Show resolved Hide resolved

runtime/sema/type_tags.go Show resolved Hide resolved

runtime/sema/type_tags.go Show resolved Hide resolved

runtime/sema/type_tags.go Outdated Show resolved Hide resolved

Cache redundant calculations

26cf9ab

turbolent approved these changes Nov 10, 2021

View reviewed changes

Add detail comments on type tags

1086a93

SupunS merged commit c4c1392 into master Nov 11, 2021

SupunS deleted the supun/common-supertype-3 branch November 11, 2021 00:18

turbolent mentioned this pull request Nov 11, 2021

Auto Cadence Update: Find least common super-type onflow/flow-go#1614

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Find least common super-type #1025

Find least common super-type #1025

SupunS commented Jun 21, 2021 •

edited

Loading

codecov-commenter commented Jun 21, 2021 •

edited

Loading

dsainati1 left a comment

SupunS commented Nov 8, 2021

dsainati1 left a comment

turbolent left a comment

github-actions bot commented Nov 10, 2021 •

edited

Loading

turbolent left a comment

turbolent commented Nov 10, 2021

Find least common super-type #1025

Find least common super-type #1025

Conversation

SupunS commented Jun 21, 2021 • edited Loading

Description

Approach:

codecov-commenter commented Jun 21, 2021 • edited Loading

Codecov Report

dsainati1 left a comment

Choose a reason for hiding this comment

SupunS commented Nov 8, 2021

dsainati1 left a comment

Choose a reason for hiding this comment

turbolent left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 10, 2021 • edited Loading

Cadence Benchstat comparison

Results

turbolent left a comment

Choose a reason for hiding this comment

turbolent commented Nov 10, 2021

SupunS commented Jun 21, 2021 •

edited

Loading

codecov-commenter commented Jun 21, 2021 •

edited

Loading

github-actions bot commented Nov 10, 2021 •

edited

Loading