Move PICO to EISOP #1013

Ao-senXiong · 2024-12-09T22:41:15Z

Original code repo: https://github.com/opprop/immutability
Some of commits are presented in: https://github.com/Ao-senXiong/immutability/tree/pico-cf-only
Merge with: eisop/jdk#106
As discussed before, I will try to move PICO here gradually. Hopefully adding test cases and Javadoc with more discussion as well.

Co-authored-by: Werner Dietl <wdietl@gmail.com> Co-authored-by: Haifeng Shi <shihaifeng1998@gmail.com> Co-authored-by: Weitian Xing <xingweitian@gmail.com> Co-authored-by: Jeff Luo <j36luo@uwaterloo.ca> Co-authored-by: Mier Ta <m2ta@uwaterloo.ca>

wmdietl

A quick round of initial comments.

checker/src/test/java/org/checkerframework/checker/test/junit/PICOImmutabilityTest.java

checker-qual/src/main/java/org/checkerframework/checker/pico/qual/Bottom.java

checker-qual/src/main/java/org/checkerframework/checker/pico/qual/Lost.java

.../src/main/java/org/checkerframework/checker/pico/PICOInitializationAnnotatedTypeFactory.java

checker/src/main/java/org/checkerframework/checker/pico/PICONoInitAnnotatedTypeFactory.java

checker/src/main/java/org/checkerframework/checker/pico/jdk.astub

Co-authored-by: Werner Dietl <wdietl@gmail.com>

Ao-senXiong · 2024-12-27T02:20:31Z

checker/src/main/java/org/checkerframework/checker/pico/PICONoInitVisitor.java

+        PICOViewpointAdapter vpa = atypeFactory.getViewpointAdapter();
+        AnnotationMirror adapted = vpa.combineAnnotationWithAnnotation(lhs, rhs);
+        return atypeFactory.getQualifierHierarchy().isSubtypeQualifiersOnly(adapted, lhs);
+    }


After #1032, this method and the override of isValidUse( AnnotatedDeclaredType declarationType, AnnotatedDeclaredType useType, Tree tree) can be removed.

…alization`

Ao-senXiong · 2024-12-31T01:34:08Z

~~Ah, looks like it can not find the branch again.~~
Fixed

Ao-senXiong · 2024-12-31T01:44:55Z

~~Looks like the CI issue not only happens for this PR, also for #1034. It did not fail because it does not have other related PR and fallback to master branches works fine.~~
Fixed

Ao-senXiong · 2024-12-31T03:13:11Z

~~I notice the problem is CI_org is set to eisop and echo About to run git-find-fork eisop eisop jdk. So the branch is not found.~~

In github action, we should use the following:
GITHUB_ACTOR=Ao-senXiong
Fixed.

Ao-senXiong · 2024-12-31T20:55:09Z

I think we have to bear the windows failure as the script does not support windows

++ /d/a/checker-framework/checker-framework/checker/bin-devel/.git-scripts/git-find-fork Ao-senXiong eisop jdk
+ '[' 3 -ne 3 ']'
+ ORG=Ao-senXiong
+ UPSTREAM_ORG=eisop
+ REPONAME=jdk
+ export 'GITEXISTS=wget -q --spider'
+ GITEXISTS='wget -q --spider'
+ wget -q --spider https://github.com/Ao-senXiong/jdk.git
/d/a/checker-framework/checker-framework/checker/bin-devel/.git-scripts/git-find-fork: line 29: wget: command not found
+ OWNER=eisop
+ echo https://github.com/eisop/jdk.git
+ REPO_URL=https://github.com/eisop/jdk.git
+ '[' -n 1 ']'
git-find-fork Ao-senXiong eisop jdk => https://github.com/eisop/jdk.git
+ echo 'git-find-fork Ao-senXiong eisop jdk => https://github.com/eisop/jdk.git'
+ '[' -n 1 ']'
+ echo 'About to run git-find-branch' https://github.com/eisop/jdk.git pico-move
About to run git-find-branch https://github.com/eisop/jdk.git pico-move
++ /d/a/checker-framework/checker-framework/checker/bin-devel/.git-scripts/git-find-branch https://github.com/eisop/jdk.git pico-move
+ REPO_URL=https://github.com/eisop/jdk.git
+ shift
+ for BRANCH in "$@"
+ git ls-remote --quiet --exit-code --heads https://github.com/eisop/jdk.git pico-move
+ git ls-remote --symref https://github.com/eisop/jdk.git HEAD
+ awk '/^ref:/ {sub(/refs\/heads\//, "", $2); print $2}'
+ REPO_BRANCH=master
+ '[' -n 1 ']'
+ echo 'git-find-branch https://github.com/eisop/jdk.git pico-move => master'
+ '[' https://github.com/eisop/jdk.git '!=' https://github.com/eisop/jdk.git ']'
git-find-branch https://github.com/eisop/jdk.git pico-move => master
+ echo 'About to run: git clone -b master -q --single-branch --depth 1 https://github.com/eisop/jdk.git ../jdk'
+ timeout 60 git clone --depth 1 -b master -q --single-branch --depth 1 https://github.com/eisop/jdk.git ../jdk
About to run: git clone -b master -q --single-branch --depth 1 https://github.com/eisop/jdk.git ../jdk```

Ao-senXiong · 2025-01-10T20:35:32Z

checker/tests/pico-immutability/ClassAnnotation.java

+
+    // TODO Make the superclass's bound implicit works
+    // :: error: (declaration.inconsistent.with.extends.clause) :: error: (super.invocation.invalid)
+    class ImmutableChildClassBad1 extends @Mutable MutableClass {}


Forbid annotation before extends/implements clause.

Co-authored-by: Werner Dietl <wdietl@gmail.com>

Ao-senXiong · 2025-01-11T22:29:49Z

Looks like this hack override of checkoverride I removed in 38a547a also indicates a bug in the framework StructuralEqualityComparer. Upstream has similar 6867.

I am using a different branch for doing case study on guava based on the hack.

Ao-senXiong · 2025-01-16T23:53:39Z

checker/src/main/java/org/checkerframework/checker/pico/PICONoInitVisitor.java

+    protected boolean isTypeCastSafe(AnnotatedTypeMirror castType, AnnotatedTypeMirror exprType) {
+        QualifierHierarchy qualifierHierarchy = atypeFactory.getQualifierHierarchy();
+
+        final TypeKind castTypeKind = castType.getKind();
+        if (castTypeKind == TypeKind.DECLARED) {
+            // Don't issue an error if the mutability annotations are equivalent to the qualifier
+            // upper bound of the type.
+            // BaseTypeVisitor#isTypeCastSafe is not used, to be consistent with inference which
+            // only have mutability qualifiers if inference is supporting FBC in the future, this
+            // overridden method can be removed.
+            AnnotatedDeclaredType castDeclared = (AnnotatedDeclaredType) castType;
+            AnnotationMirror bound =
+                    qualifierHierarchy.findAnnotationInHierarchy(
+                            atypeFactory.getTypeDeclarationBounds(castDeclared.getUnderlyingType()),
+                            atypeFactory.READONLY);
+            assert bound != null;
+
+            if (AnnotationUtils.areSame(
+                    castDeclared.getAnnotationInHierarchy(atypeFactory.READONLY), bound)) {
+                return true;
+            }
+        }
+
+        return super.isTypeCastSafe(castType, exprType);


This should be nicer after #1049

Starting move PICO to EISOP

32a297b

Co-authored-by: Werner Dietl <wdietl@gmail.com> Co-authored-by: Haifeng Shi <shihaifeng1998@gmail.com> Co-authored-by: Weitian Xing <xingweitian@gmail.com> Co-authored-by: Jeff Luo <j36luo@uwaterloo.ca> Co-authored-by: Mier Ta <m2ta@uwaterloo.ca>

Ao-senXiong force-pushed the pico-move branch from 33dfd50 to 32a297b Compare December 14, 2024 19:35

Ao-senXiong self-assigned this Dec 17, 2024

Ao-senXiong added 10 commits December 18, 2024 14:20

Remove static import and holder class

9cc1911

Clear star import and static import again

514a607

Lots of Javadoc and remove some unused method

2a48ae3

Remove dangling Javadoc

4260bd3

Add Javadoc

2e4fffd

A few more Javadoc

7341fad

Add PICO's annotation for format

7a4d4a3

Fix a few errors and add the very first test cases

cac7afa

Format poly and forbid RDM on static class

6d911e4

Yet another test case

61601da

Ao-senXiong mentioned this pull request Dec 19, 2024

Add Javadoc to qualifers for viewpoint test checker #1021

Merged

Add object creation test

646b5cb

wmdietl requested changes Dec 20, 2024

View reviewed changes

Ao-senXiong and others added 8 commits December 19, 2024 20:52

Use PolyMutable for iterator

911355b

Co-authored-by: Werner Dietl <wdietl@gmail.com>

Rename qualifier to PICO...

d7cdc75

Remove hack

cb648fe

Fixes misc-21 error

63bd81e

Also test validity of annotation on interface and abstract class

b09a116

Remove wrong todo and add JML readonly aliasing

fa1fdd7

Apply spotless

cf0cc18

Add assignability annotation test and improve the error message

2e82b65

Ao-senXiong commented Dec 27, 2024

View reviewed changes

Ao-senXiong added 5 commits December 26, 2024 18:43

Add RDM class test and initialization test

96c92a9

Merge branch 'master' into pico-move

ebae3a8

Add implicit mutable test

108a938

Add Definite Assignment test

8bb7327

Delete Definite Assignment test as it is already tested in `PICOIniti…

c02a0b2

…alization`

Test with CI Debug

ef3c155

Ao-senXiong mentioned this pull request Dec 31, 2024

Use GITHUB_ACTOR as CI_ORGANIZATION for GitHub Actions eisop-plume-lib/plume-scripts#9

Merged

Ao-senXiong added 2 commits December 31, 2024 10:26

Merge branch 'master' into pico-move

592bbc1

Fix errors for JDK 11

a9851d4

Ao-senXiong added 12 commits January 2, 2025 20:02

Merge branch 'master' into pico-move

71685bb

Merge branch 'master' into pico-move

736e78c

Remove unused override

6a7fb65

Correct the test cases

44a70e6

Merge branch 'master' into pico-move

3735fbe

Undo debug

861d5c8

Test array as field in class

17c11e6

Delete jdk.astub

b0ed675

Correct code and refine example

5cc6842

Partially fixed override rule

38a547a

Merge branch 'master' into pico-move

aa42c42

Remove hack for adding annotation for toString and other methods

3b97db2

Ao-senXiong commented Jan 10, 2025

View reviewed changes

Ao-senXiong and others added 4 commits January 10, 2025 14:09

Apply suggestions from code review

4f6236a

Co-authored-by: Werner Dietl <wdietl@gmail.com>

Remove super clause annotator

e347eb2

Remove used code

999750a

Apply spotless

e97245d

Ao-senXiong added 3 commits January 12, 2025 02:05

Fixes PolyMutable factory pattern

e2827d9

Compute Varargs before calling setParameterTypes

3fccd21

Merge branch 'master' into pico-move

da92fa8

Ao-senXiong commented Jan 16, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move PICO to EISOP #1013

Move PICO to EISOP #1013

Ao-senXiong commented Dec 9, 2024 •

edited

Loading

wmdietl left a comment

Ao-senXiong Dec 27, 2024

Ao-senXiong commented Dec 31, 2024 •

edited

Loading

Ao-senXiong commented Dec 31, 2024 •

edited

Loading

Ao-senXiong commented Dec 31, 2024 •

edited

Loading

Ao-senXiong commented Dec 31, 2024

Ao-senXiong Jan 10, 2025

Ao-senXiong commented Jan 11, 2025 •

edited

Loading

Ao-senXiong Jan 16, 2025

Move PICO to EISOP #1013

Are you sure you want to change the base?

Move PICO to EISOP #1013

Conversation

Ao-senXiong commented Dec 9, 2024 • edited Loading

wmdietl left a comment

Choose a reason for hiding this comment

Ao-senXiong Dec 27, 2024

Choose a reason for hiding this comment

Ao-senXiong commented Dec 31, 2024 • edited Loading

Ao-senXiong commented Dec 31, 2024 • edited Loading

Ao-senXiong commented Dec 31, 2024 • edited Loading

Ao-senXiong commented Dec 31, 2024

Ao-senXiong Jan 10, 2025

Choose a reason for hiding this comment

Ao-senXiong commented Jan 11, 2025 • edited Loading

Ao-senXiong Jan 16, 2025

Choose a reason for hiding this comment

Ao-senXiong commented Dec 9, 2024 •

edited

Loading

Ao-senXiong commented Dec 31, 2024 •

edited

Loading

Ao-senXiong commented Dec 31, 2024 •

edited

Loading

Ao-senXiong commented Dec 31, 2024 •

edited

Loading

Ao-senXiong commented Jan 11, 2025 •

edited

Loading