8363584: Sort share/utilities includes

fandreuz · David Holmes · commit e307b5cca870 · 2025-07-28T05:17:52.000Z
Reviewed-by: kbarrett, dholmes, shade
diff --git a/src/hotspot/share/utilities/align.hpp b/src/hotspot/share/utilities/align.hpp
@@ -30,6 +30,7 @@
 #include "utilities/debug.hpp"
 #include "utilities/globalDefinitions.hpp"
 #include "utilities/powerOfTwo.hpp"
+
 #include <type_traits>
 
 // Compute mask to use for aligning to or testing alignment.
diff --git a/src/hotspot/share/utilities/concurrentHashTableTasks.inline.hpp b/src/hotspot/share/utilities/concurrentHashTableTasks.inline.hpp
@@ -28,8 +28,8 @@
 // No concurrentHashTableTasks.hpp
 
 #include "runtime/atomic.hpp"
-#include "utilities/globalDefinitions.hpp"
 #include "utilities/concurrentHashTable.inline.hpp"
+#include "utilities/globalDefinitions.hpp"
 
 // This inline file contains BulkDeleteTask and GrowTasks which are both bucket
 // operations, which they are serialized with each other.
diff --git a/src/hotspot/share/utilities/copy.cpp b/src/hotspot/share/utilities/copy.cpp
@@ -22,7 +22,6 @@
  *
  */
 
-#include "utilities/copy.hpp"
 #include "runtime/sharedRuntime.hpp"
 #include "utilities/align.hpp"
 #include "utilities/byteswap.hpp"
diff --git a/src/hotspot/share/utilities/debug.cpp b/src/hotspot/share/utilities/debug.cpp
@@ -63,8 +63,8 @@
 #include "utilities/unsigned5.hpp"
 #include "utilities/vmError.hpp"
 
-#include <stdio.h>
 #include <stdarg.h>
+#include <stdio.h>
 
 // These functions needs to be exported on Windows only
 #define DEBUGEXPORT WINDOWS_ONLY(JNIEXPORT)
diff --git a/src/hotspot/share/utilities/elfFile.cpp b/src/hotspot/share/utilities/elfFile.cpp
@@ -36,10 +36,10 @@
 #include "utilities/elfSymbolTable.hpp"
 #include "utilities/ostream.hpp"
 
-#include <string.h>
-#include <stdio.h>
 #include <limits.h>
 #include <new>
+#include <stdio.h>
+#include <string.h>
 
 const char* ElfFile::USR_LIB_DEBUG_DIRECTORY = "/usr/lib/debug";
 
diff --git a/src/hotspot/share/utilities/elfFile.hpp b/src/hotspot/share/utilities/elfFile.hpp
@@ -67,8 +67,8 @@ typedef Elf32_Sym       Elf_Sym;
 #endif
 #endif
 
-#include "jvm_md.h"
 #include "globalDefinitions.hpp"
+#include "jvm_md.h"
 #include "memory/allocation.hpp"
 #include "utilities/checkedCast.hpp"
 #include "utilities/decoder.hpp"
diff --git a/src/hotspot/share/utilities/exceptions.cpp b/src/hotspot/share/utilities/exceptions.cpp
@@ -32,13 +32,13 @@
 #include "memory/resourceArea.hpp"
 #include "memory/universe.hpp"
 #include "oops/oop.inline.hpp"
+#include "runtime/atomic.hpp"
 #include "runtime/handles.inline.hpp"
 #include "runtime/init.hpp"
 #include "runtime/java.hpp"
 #include "runtime/javaCalls.hpp"
 #include "runtime/javaThread.hpp"
 #include "runtime/os.hpp"
-#include "runtime/atomic.hpp"
 #include "utilities/events.hpp"
 #include "utilities/exceptions.hpp"
 #include "utilities/utf8.hpp"
diff --git a/src/hotspot/share/utilities/fakeRttiSupport.hpp b/src/hotspot/share/utilities/fakeRttiSupport.hpp
@@ -25,8 +25,8 @@
 #ifndef SHARE_UTILITIES_FAKERTTISUPPORT_HPP
 #define SHARE_UTILITIES_FAKERTTISUPPORT_HPP
 
-#include "utilities/globalDefinitions.hpp"
 #include "utilities/debug.hpp"
+#include "utilities/globalDefinitions.hpp"
 
 // Provides support for checked downcasts in a hierarchy of classes.
 // The base class provides a member of this type, specialized on that
diff --git a/src/hotspot/share/utilities/globalDefinitions.hpp b/src/hotspot/share/utilities/globalDefinitions.hpp
@@ -25,14 +25,13 @@
 #ifndef SHARE_UTILITIES_GLOBALDEFINITIONS_HPP
 #define SHARE_UTILITIES_GLOBALDEFINITIONS_HPP
 
+// Get constants like JVM_T_CHAR and JVM_SIGNATURE_INT, before pulling in <jvm.h>.
+#include "classfile_constants.h"
 #include "utilities/compilerWarnings.hpp"
 #include "utilities/debug.hpp"
 #include "utilities/forbiddenFunctions.hpp"
 #include "utilities/macros.hpp"
 
-// Get constants like JVM_T_CHAR and JVM_SIGNATURE_INT, before pulling in <jvm.h>.
-#include "classfile_constants.h"
-
 #include COMPILER_HEADER(utilities/globalDefinitions)
 
 #include <cstddef>
diff --git a/src/hotspot/share/utilities/globalDefinitions_gcc.hpp b/src/hotspot/share/utilities/globalDefinitions_gcc.hpp
@@ -33,8 +33,13 @@
 
 #include <alloca.h>
 #include <ctype.h>
+#include <dlfcn.h>
+#include <errno.h>
+#include <fcntl.h>
 #include <inttypes.h>
-#include <string.h>
+#include <limits.h>
+#include <math.h>
+#include <pthread.h>
 #include <stdarg.h>
 #include <stddef.h>
 #include <stdint.h>
@@ -48,16 +53,9 @@
   #undef malloc
   extern void *malloc(size_t) asm("vec_malloc");
 #endif
-#include <wchar.h>
-
-#include <math.h>
+#include <string.h>
 #include <time.h>
-#include <fcntl.h>
-#include <dlfcn.h>
-#include <pthread.h>
-
-#include <limits.h>
-#include <errno.h>
+#include <wchar.h>
 
 #if defined(LINUX) || defined(_ALLBSD_SOURCE) || defined(_AIX)
 #include <signal.h>
diff --git a/src/hotspot/share/utilities/globalDefinitions_visCPP.hpp b/src/hotspot/share/utilities/globalDefinitions_visCPP.hpp
@@ -31,23 +31,24 @@
 // globally used constants & types, class (forward)
 // declarations and a few frequently used utility functions.
 
+// Need this on windows to get the math constants (e.g., M_PI).
+#define _USE_MATH_DEFINES
+
 # include <ctype.h>
-# include <string.h>
+# include <fcntl.h>
+# include <float.h> // for _isnan
+# include <inttypes.h>
+# include <io.h>    // for stream.cpp
+# include <limits.h>
+# include <math.h>
 # include <stdarg.h>
-# include <stdlib.h>
-# include <stdint.h>
 # include <stddef.h>// for offsetof
+# include <stdint.h>
+# include <stdio.h>
+# include <stdlib.h>
+# include <string.h>
 # include <sys/stat.h>
-# include <io.h>    // for stream.cpp
-# include <float.h> // for _isnan
-# include <stdio.h> // for va_list
 # include <time.h>
-# include <fcntl.h>
-# include <limits.h>
-# include <inttypes.h>
-// Need this on windows to get the math constants (e.g., M_PI).
-#define _USE_MATH_DEFINES
-# include <math.h>
 
 // Only 64-bit Windows is supported
 #ifndef _LP64
diff --git a/src/hotspot/share/utilities/intpow.hpp b/src/hotspot/share/utilities/intpow.hpp
@@ -26,6 +26,7 @@
 #define SHARE_UTILITIES_INTPOW_HPP
 
 #include "metaprogramming/enableIf.hpp"
+
 #include <limits>
 #include <type_traits>
 
diff --git a/src/hotspot/share/utilities/json.cpp b/src/hotspot/share/utilities/json.cpp
@@ -33,6 +33,7 @@
 
 #include "utilities/json.hpp"
 #include "utilities/ostream.hpp"
+
 #include <math.h>
 
 static const char* strchrnul_(const char *s, int c) {
diff --git a/src/hotspot/share/utilities/ostream.cpp b/src/hotspot/share/utilities/ostream.cpp
@@ -1077,11 +1077,11 @@ bufferedStream::~bufferedStream() {
 #ifndef PRODUCT
 
 #if defined(LINUX) || defined(AIX) || defined(_ALLBSD_SOURCE)
-#include <sys/types.h>
-#include <sys/socket.h>
-#include <netinet/in.h>
-#include <netdb.h>
 #include <arpa/inet.h>
+#include <netdb.h>
+#include <netinet/in.h>
+#include <sys/socket.h>
+#include <sys/types.h>
 #elif defined(_WINDOWS)
 #include <Ws2tcpip.h>
 #endif
diff --git a/src/hotspot/share/utilities/packedTable.cpp b/src/hotspot/share/utilities/packedTable.cpp
@@ -21,12 +21,12 @@
  * questions.
  *
  */
-#include <cstring>
-
 #include "utilities/align.hpp"
 #include "utilities/count_leading_zeros.hpp"
 #include "utilities/packedTable.hpp"
 
+#include <cstring>
+
 // The thresholds are inclusive, and in practice the limits are rounded
 // to the nearest power-of-two - 1.
 // Based on the max_key and max_value we figure out the number of bits required to store
diff --git a/src/hotspot/share/utilities/powerOfTwo.hpp b/src/hotspot/share/utilities/powerOfTwo.hpp
@@ -30,6 +30,7 @@
 #include "utilities/count_trailing_zeros.hpp"
 #include "utilities/debug.hpp"
 #include "utilities/globalDefinitions.hpp"
+
 #include <limits>
 #include <type_traits>
 
diff --git a/src/hotspot/share/utilities/rbTree.hpp b/src/hotspot/share/utilities/rbTree.hpp
@@ -29,6 +29,7 @@
 #include "nmt/memTag.hpp"
 #include "runtime/os.hpp"
 #include "utilities/globalDefinitions.hpp"
+
 #include <type_traits>
 
 // An intrusive red-black tree is constructed with two template parameters:
diff --git a/src/hotspot/share/utilities/rbTree.inline.hpp b/src/hotspot/share/utilities/rbTree.inline.hpp
@@ -25,12 +25,13 @@
 #ifndef SHARE_UTILITIES_RBTREE_INLINE_HPP
 #define SHARE_UTILITIES_RBTREE_INLINE_HPP
 
+#include "utilities/rbTree.hpp"
+
 #include "metaprogramming/enableIf.hpp"
 #include "utilities/debug.hpp"
 #include "utilities/globalDefinitions.hpp"
 #include "utilities/ostream.hpp"
 #include "utilities/powerOfTwo.hpp"
-#include "utilities/rbTree.hpp"
 
 inline void IntrusiveRBNode::replace_child(IntrusiveRBNode* old_child, IntrusiveRBNode* new_child) {
   if (_left == old_child) {
diff --git a/src/hotspot/share/utilities/singleWriterSynchronizer.cpp b/src/hotspot/share/utilities/singleWriterSynchronizer.cpp
@@ -26,8 +26,8 @@
 #include "runtime/orderAccess.hpp"
 #include "runtime/os.hpp"
 #include "utilities/debug.hpp"
-#include "utilities/singleWriterSynchronizer.hpp"
 #include "utilities/macros.hpp"
+#include "utilities/singleWriterSynchronizer.hpp"
 
 SingleWriterSynchronizer::SingleWriterSynchronizer() :
   _enter(0),
diff --git a/src/hotspot/share/utilities/utf8.cpp b/src/hotspot/share/utilities/utf8.cpp
@@ -23,11 +23,11 @@
  */
 
 #include "memory/allocation.hpp"
+#include "runtime/os.hpp"
 #include "utilities/checkedCast.hpp"
 #include "utilities/debug.hpp"
 #include "utilities/globalDefinitions.hpp"
 #include "utilities/utf8.hpp"
-#include "runtime/os.hpp"
 
 // Assume the utf8 string is in legal form and has been
 // checked in the class file parser/format checker.
diff --git a/src/hotspot/share/utilities/vmError.cpp b/src/hotspot/share/utilities/vmError.cpp
@@ -57,9 +57,9 @@
 #include "runtime/threads.hpp"
 #include "runtime/threadSMR.hpp"
 #include "runtime/trimNativeHeap.hpp"
+#include "runtime/vm_version.hpp"
 #include "runtime/vmOperations.hpp"
 #include "runtime/vmThread.hpp"
-#include "runtime/vm_version.hpp"
 #include "sanitizers/ub.hpp"
 #include "utilities/debug.hpp"
 #include "utilities/decoder.hpp"
diff --git a/src/hotspot/share/utilities/waitBarrier_generic.cpp b/src/hotspot/share/utilities/waitBarrier_generic.cpp
@@ -26,8 +26,8 @@
 #include "runtime/atomic.hpp"
 #include "runtime/orderAccess.hpp"
 #include "runtime/os.hpp"
-#include "utilities/waitBarrier_generic.hpp"
 #include "utilities/spinYield.hpp"
+#include "utilities/waitBarrier_generic.hpp"
 
 // Implements the striped semaphore wait barrier.
 //
diff --git a/src/hotspot/share/utilities/xmlstream.cpp b/src/hotspot/share/utilities/xmlstream.cpp
@@ -26,8 +26,8 @@
 #include "memory/allocation.hpp"
 #include "memory/allocation.inline.hpp"
 #include "memory/resourceArea.hpp"
-#include "oops/methodData.hpp"
 #include "oops/method.inline.hpp"
+#include "oops/methodData.hpp"
 #include "oops/oop.inline.hpp"
 #include "runtime/deoptimization.hpp"
 #include "runtime/handles.inline.hpp"
diff --git a/test/hotspot/jtreg/sources/TestIncludesAreSorted.java b/test/hotspot/jtreg/sources/TestIncludesAreSorted.java
@@ -48,7 +48,8 @@ public class TestIncludesAreSorted {
                     "share/compiler",
                     "share/jvmci",
                     "share/oops",
-                    "share/opto"
+                    "share/opto",
+                    "share/utilities"
     };
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@`
`22`	`22`	`*`
`23`	`23`	`*/`
`24`	`24`
`25`		`-#include "utilities/copy.hpp"`
`26`	`25`	`#include "runtime/sharedRuntime.hpp"`
`27`	`26`	`#include "utilities/align.hpp"`
`28`	`27`	`#include "utilities/byteswap.hpp"`