From 21217bbf0868cd7d2019de87de54ae23a77590b4 Mon Sep 17 00:00:00 2001 From: Chris Povirk Date: Thu, 12 Nov 2026 11:56:31 -0500 Subject: [PATCH] Expand and improve `java.nio.*Buffer` stubs: - Add JSpecify annotations to the template used to generate those files during builds. - This includes adding `@Nullable` to the `CharSequence` parameter in each relevant `CharBuffer.append` overload. - Make our hard-coded `ByteBuffer.java` match the actual generated output. - Add hard-coded copies of the other `*Buffer.java` classes. - Add a test that ensures that we update those copies for new changes. This should all have no practical impact on users of checkers that are lenient with unannotated code, but it could help users of strict checkers that call `equals` or `append` on `*Buffer` classes (besides `ByteBuffer.equals`, which we already had covered). --- .../modules/java.base/gensrc/GensrcBuffer.gmk | 26 + .../share/classes/java/nio/ByteBuffer.java | 2534 ++++++++++++++--- .../share/classes/java/nio/CharBuffer.java | 2425 ++++++++++++++++ .../share/classes/java/nio/DoubleBuffer.java | 2425 ++++++++++++++++ .../share/classes/java/nio/FloatBuffer.java | 2425 ++++++++++++++++ .../share/classes/java/nio/IntBuffer.java | 2425 ++++++++++++++++ .../share/classes/java/nio/LongBuffer.java | 2425 ++++++++++++++++ .../share/classes/java/nio/ShortBuffer.java | 2425 ++++++++++++++++ .../classes/java/nio/X-Buffer.java.template | 10 +- 9 files changed, 16677 insertions(+), 443 deletions(-) create mode 100644 src/java.base/share/classes/java/nio/CharBuffer.java create mode 100644 src/java.base/share/classes/java/nio/DoubleBuffer.java create mode 100644 src/java.base/share/classes/java/nio/FloatBuffer.java create mode 100644 src/java.base/share/classes/java/nio/IntBuffer.java create mode 100644 src/java.base/share/classes/java/nio/LongBuffer.java create mode 100644 src/java.base/share/classes/java/nio/ShortBuffer.java diff --git a/make/modules/java.base/gensrc/GensrcBuffer.gmk b/make/modules/java.base/gensrc/GensrcBuffer.gmk index edefd60b6d4..dbcabe37385 100644 --- a/make/modules/java.base/gensrc/GensrcBuffer.gmk +++ b/make/modules/java.base/gensrc/GensrcBuffer.gmk @@ -245,6 +245,32 @@ endef $(eval $(call SetupGenerateBuffersWithRO,false,)) $(eval $(call SetupGenerateBuffersWithRO,true,R)) +################################################################################ +# Verify that the checked-in public Buffer classes match the generated files + +PUBLIC_BUFFER_FILES := $(foreach t, $(NUMBER_TYPES), $(call titlecase, $(t))Buffer.java) +PUBLIC_BUFFER_CHECK_MARKER := $(BUFFER_OUTPUT_DIR)/_check_public_buffers.marker + +$(PUBLIC_BUFFER_CHECK_MARKER): \ + $(addprefix $(BUFFER_OUTPUT_DIR)/, $(PUBLIC_BUFFER_FILES)) \ + $(addprefix $(BUFFER_INPUT_DIR)/, $(PUBLIC_BUFFER_FILES)) + $(call LogInfo, Verifying checked-in public buffer classes match generated files) + failed=0; \ + for f in $(PUBLIC_BUFFER_FILES); do \ + if ! $(DIFF) -u $(BUFFER_INPUT_DIR)/$$f $(BUFFER_OUTPUT_DIR)/$$f; then \ + failed=1; \ + fi; \ + done; \ + if [ $$failed -ne 0 ]; then \ + $(ECHO) "ERROR: Checked-in java.nio.*Buffer.java files are out of sync with generated files."; \ + $(ECHO) "To update them, run:"; \ + $(ECHO) " cp $(addprefix $(BUFFER_OUTPUT_DIR)/, $(PUBLIC_BUFFER_FILES)) $(BUFFER_INPUT_DIR)/"; \ + exit 1; \ + fi + $(TOUCH) $@ + +TARGETS += $(PUBLIC_BUFFER_CHECK_MARKER) + ################################################################################ endif # include guard diff --git a/src/java.base/share/classes/java/nio/ByteBuffer.java b/src/java.base/share/classes/java/nio/ByteBuffer.java index 29b220db38c..5e6ea684686 100644 --- a/src/java.base/share/classes/java/nio/ByteBuffer.java +++ b/src/java.base/share/classes/java/nio/ByteBuffer.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2000, 2018, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2000, 2025, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -23,17 +23,35 @@ * questions. */ -package java.nio; +// -- This file was mechanically generated: Do not edit! -- // -import jdk.internal.util.ArraysSupport; +package java.nio; import org.jspecify.annotations.NullMarked; import org.jspecify.annotations.Nullable; + + + +import java.lang.ref.Reference; + + + + + + +import jdk.internal.foreign.AbstractMemorySegmentImpl; +import jdk.internal.foreign.MemorySessionImpl; +import jdk.internal.foreign.SegmentFactories; +import jdk.internal.vm.annotation.ForceInline; +import java.lang.foreign.MemorySegment; +import java.util.Objects; +import jdk.internal.util.ArraysSupport; + /** * A byte buffer. * - *

This class defines {#if[byte]?six:four} categories of operations upon + *

This class defines six categories of operations upon * byte buffers: * *