Skip to content

Conversation

@alexmenkov
Copy link

@alexmenkov alexmenkov commented Oct 11, 2023

All test cases in getclfld007 had 1 (or 0) field in test classes/interfaces.
The change adds several fields in one of the test classes to verify order of the returned fields (as described by GetClassFields spec: "in the order they occur in the class file").
Field order in the class file is not guaranteed to be the same as in the source, so information about expected fields and expected order is extracted by ASM (it parses class file sequentially).
This allows to drop hardcoded field name/type in native part.

Additionally did some test cleanup:

  • dropped "printdump" stuff (the test always logs reported fields);
  • removed unused generic in native check() method, added deallocation of name and sig

Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8317635: Improve GetClassFields test to verify correctness of field order (Enhancement - P4)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/16131/head:pull/16131
$ git checkout pull/16131

Update a local copy of the PR:
$ git checkout pull/16131
$ git pull https://git.openjdk.org/jdk.git pull/16131/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 16131

View PR using the GUI difftool:
$ git pr show -t 16131

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/16131.diff

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Oct 11, 2023

👋 Welcome back amenkov! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot added the rfr Pull request is ready for review label Oct 11, 2023
@openjdk
Copy link

openjdk bot commented Oct 11, 2023

@alexmenkov The following label will be automatically applied to this pull request:

  • serviceability

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added the serviceability serviceability-dev@openjdk.org label Oct 11, 2023
@mlbridge
Copy link

mlbridge bot commented Oct 11, 2023

Webrevs

* fields.
* The test checks if the function returns the expected list of fields:
* - the list contains only directly declared (not inherited) fields;
* - fields are returned in the order they occur in the class file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the order of the fields in the class file guaranteed to be the same as the declaration order?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question.
Javac works this way, but looks like this is not a requirement.
Looks like the test should use some class file parser to get actual field order

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the test to get expected field order (as well as field name and type) from class file

Copy link
Contributor

@plummercj plummercj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@openjdk
Copy link

openjdk bot commented Oct 18, 2023

@alexmenkov This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8317635: Improve GetClassFields test to verify correctness of field order

Reviewed-by: cjplummer, sspitsyn

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 140 new commits pushed to the master branch:

  • 24bc5bd: 8318104: macOS 10.13 check in TabButtonAccessibility.m can be removed
  • e25a49a: 8318471: ProblemList compiler/sharedstubs/SharedTrampolineTest.java
  • ce8ebeb: 8317979: Use TZ database style abbreviations in the CLDR locale provider
  • ab13568: 8318029: Minor improvement to logging output in container at-requires
  • 278de7a: 8318458: Update javac and java manpages with restricted method options
  • 6fc3514: 8318363: Foreign benchmarks fail to build on some platforms
  • 31ef400: 8318183: C2: VM may crash after hitting node limit
  • 4e77b3c: 8315974: Make fields final in 'com.sun.crypto.provider' package
  • 8dd8096: 8317886: Add @sealedGraph to ByteBuffer
  • 9843c97: 8318365: Test runtime/cds/appcds/sharedStrings/InternSharedString.java fails after JDK-8311538
  • ... and 130 more: https://git.openjdk.org/jdk/compare/053f45695f9a914452f39029bd9ac7eb329e6883...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Oct 18, 2023
}
return explorer.fieldNameAndSig;
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I'd suggest to make get() an instance method. It will be a little bit simpler and more natural.
It wiill look as below:

    static void check(Class cls) throws Exception {
        FieldExplorer explorer = new FieldExplorer(cls);
        List<String> fields = explorer.get();
        check(cls, fields.toArray(new String[0]));
    }
    . . .
        List<String> get() throws Exception {
            System.out.println("Class " + cls.getName());
            try (InputStream classBytes = getClassBytes()) {
                ClassReader classReader = new ClassReader(classBytes);
                classReader.accept(this, 0);
            }
            return fieldNameAndSig;
        }

}

// helper class to get list of the class field
// in the order they appear in the class file
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: class field => class fields.

jvmti->Deallocate((unsigned char *)sig);
}
}
}
Copy link
Contributor

@sspitsyn sspitsyn Oct 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I'd suggest to refactor a little bit the content of loop at L111 as below:

    for (j = 0; j < fcount; j++) {
        if (fields[j] == NULL) {
            printf("(%d) fieldID = null\n", j);
            result = STATUS_FAILED;
            continue;   => /you can consider to return here
        }
        err = jvmti->GetFieldName(clazz, fields[j], &name, &sig, NULL);
        if (err != JVMTI_ERROR_NONE) {
            printf("(GetFieldName#%d) unexpected error: %s (%d)\n",
                   j, TranslateError(err), err);
            result = STATUS_FAILED;   => This result set is missed
            continue;   => you can consider to return here
        }
        printf(">>>   [%d]: %s, sig = \"%s\"\n", j, name, sig);
        if ((j < field_count) &&
            (name == NULL || sig == NULL ||
             !equals_str(env, name, fieldArr, j * 2) ||
             !equals_str(env, sig, fieldArr, j * 2 + 1))) {
            printf("(%d) wrong field: \"%s%s\"", j, name, sig);
            result = STATUS_FAILED;
        }
        jvmti->Deallocate((unsigned char *)name);
        jvmti->Deallocate((unsigned char *)sig);
     }

Copy link
Contributor

@sspitsyn sspitsyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The fix looks good to me, better then it was.
It is nice you get rid of the verbose option and print info by default.
I've posted a couple of nits.
Error is not set properly in one place of native agent.

Copy link
Contributor

@sspitsyn sspitsyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the update. Looks good.
Thanks,
Serguei

@alexmenkov
Copy link
Author

/integrate

@openjdk
Copy link

openjdk bot commented Oct 19, 2023

Going to push as commit 599560a.
Since your change was applied there have been 148 commits pushed to the master branch:

  • 9cf334f: 8318383: Remove duplicated checks in os::get_native_stack() in posix implementation
  • defc7e0: 8318454: TestLayoutPaths broken on Big Endian platforms after JDK-8317837
  • 3c70f2c: 8318418: hsdis build fails with system binutils on Ubuntu
  • 15acf4b: 8318324: Drop redundant default methods from FFM API
  • 1a09835: 8317358: G1: Make TestMaxNewSize use createTestJvm
  • 47bb1a1: 8318415: Adjust describing comment of os_getChildren after 8315026
  • 80bd22d: 8316144: Remove unused field jdk.internal.util.xml.impl.XMLStreamWriterImpl.Element._Depth
  • c0e154c: 8318089: Class space not marked as such with NMT when CDS is off
  • 24bc5bd: 8318104: macOS 10.13 check in TabButtonAccessibility.m can be removed
  • e25a49a: 8318471: ProblemList compiler/sharedstubs/SharedTrampolineTest.java
  • ... and 138 more: https://git.openjdk.org/jdk/compare/053f45695f9a914452f39029bd9ac7eb329e6883...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Oct 19, 2023
@openjdk openjdk bot closed this Oct 19, 2023
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Oct 19, 2023
@openjdk
Copy link

openjdk bot commented Oct 19, 2023

@alexmenkov Pushed as commit 599560a.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

@alexmenkov alexmenkov deleted the GetClassField_test branch October 19, 2023 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

integrated Pull request has been integrated serviceability serviceability-dev@openjdk.org

Development

Successfully merging this pull request may close these issues.

3 participants