Revert "[GR-46420] Reduce JDK dependencies of cgroup support."

zapster · zapster · commit a1f426ae10b1 · 2024-07-10T11:19:17.000+02:00
This reverts commit eaacc56, reversing changes made to b4e2248.
diff --git a/src/java.base/linux/classes/jdk/internal/platform/CgroupInfo.java b/src/java.base/linux/classes/jdk/internal/platform/CgroupInfo.java
@@ -107,7 +107,7 @@ public void setCgroupPath(String cgroupPath) {
      *
      */
     static CgroupInfo fromCgroupsLine(String line) {
-        String[] tokens = line.split("\t");
+        String[] tokens = line.split("\\s+");
         if (tokens.length != 4) {
             return null;
         }
diff --git a/src/java.base/linux/classes/jdk/internal/platform/CgroupSubsystemController.java b/src/java.base/linux/classes/jdk/internal/platform/CgroupSubsystemController.java
@@ -26,12 +26,15 @@
 package jdk.internal.platform;
 
 import java.io.IOException;
+import java.io.UncheckedIOException;
 import java.math.BigInteger;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 import java.util.function.Function;
+import java.util.stream.Stream;
 
 /**
  * Cgroup version agnostic controller logic
@@ -158,18 +161,16 @@ public static double getDoubleValue(CgroupSubsystemController controller, String
     public static long getLongEntry(CgroupSubsystemController controller, String param, String entryname, long defaultRetval) {
         if (controller == null) return defaultRetval;
 
-        try {
-            long result = defaultRetval;
-            for (String line : CgroupUtil.readAllLinesPrivileged(Paths.get(controller.path(), param))) {
-                String[] tokens = line.split(" ");
-                if (tokens.length == 2 && tokens[0].equals(entryname)) {
-                    result = Long.parseLong(tokens[1]);
-                    break;
-                }
-            }
+        try (Stream<String> lines = CgroupUtil.readFilePrivileged(Paths.get(controller.path(), param))) {
 
-            return result;
-        } catch (IOException e) {
+            Optional<String> result = lines.map(line -> line.split(" "))
+                                           .filter(line -> (line.length == 2 &&
+                                                   line[0].equals(entryname)))
+                                           .map(line -> line[1])
+                                           .findFirst();
+
+            return result.isPresent() ? Long.parseLong(result.get()) : defaultRetval;
+        } catch (UncheckedIOException | IOException e) {
             return defaultRetval;
         }
     }
diff --git a/src/java.base/linux/classes/jdk/internal/platform/CgroupSubsystemFactory.java b/src/java.base/linux/classes/jdk/internal/platform/CgroupSubsystemFactory.java
@@ -26,6 +26,7 @@
 package jdk.internal.platform;
 
 import java.io.IOException;
+import java.io.UncheckedIOException;
 import java.lang.System.Logger;
 import java.lang.System.Logger.Level;
 import java.nio.file.Path;
@@ -37,6 +38,9 @@
 import java.util.Optional;
 import java.util.Objects;
 import java.util.function.Consumer;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Stream;
 
 import jdk.internal.platform.cgroupv1.CgroupV1Subsystem;
 import jdk.internal.platform.cgroupv2.CgroupV2Subsystem;
@@ -50,11 +54,36 @@ public class CgroupSubsystemFactory {
     private static final String MEMORY_CTRL = "memory";
     private static final String PIDS_CTRL = "pids";
 
+    /*
+     * From https://www.kernel.org/doc/Documentation/filesystems/proc.txt
+     *
+     *  36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root rw,errors=continue
+     *  (1)(2)(3)   (4)   (5)      (6)      (7)   (8) (9)   (10)         (11)
+     *
+     *  (1) mount ID:  unique identifier of the mount (may be reused after umount)
+     *  (2) parent ID:  ID of parent (or of self for the top of the mount tree)
+     *  (3) major:minor:  value of st_dev for files on filesystem
+     *  (4) root:  root of the mount within the filesystem
+     *  (5) mount point:  mount point relative to the process's root
+     *  (6) mount options:  per mount options
+     *  (7) optional fields:  zero or more fields of the form "tag[:value]"
+     *  (8) separator:  marks the end of the optional fields
+     *  (9) filesystem type:  name of filesystem of the form "type[.subtype]"
+     *  (10) mount source:  filesystem specific information or "none"
+     *  (11) super options:  per super block options
+     */
+    private static final Pattern MOUNTINFO_PATTERN = Pattern.compile(
+        "^[^\\s]+\\s+[^\\s]+\\s+[^\\s]+\\s+" + // (1), (2), (3)
+        "([^\\s]+)\\s+([^\\s]+)\\s+" +         // (4), (5)     - group 1, 2: root, mount point
+        "[^-]+-\\s+" +                         // (6), (7), (8)
+        "([^\\s]+)\\s+" +                      // (9)          - group 3: filesystem type
+        ".*$");                                // (10), (11)
+
     static CgroupMetrics create() {
         Optional<CgroupTypeResult> optResult = null;
         try {
             optResult = determineType("/proc/self/mountinfo", "/proc/cgroups", "/proc/self/cgroup");
-        } catch (IOException e) {
+        } catch (IOException | UncheckedIOException e) {
             return null;
         }
         return create(optResult);
@@ -75,7 +104,8 @@ public static CgroupMetrics create(Optional<CgroupTypeResult> optResult) {
         // not ready to deal with that on a per-controller basis. Return no metrics
         // in that case
         if (result.isAnyCgroupV1Controllers() && result.isAnyCgroupV2Controllers()) {
-            warn("Mixed cgroupv1 and cgroupv2 not supported. Metrics disabled.");
+            Logger logger = System.getLogger("jdk.internal.platform");
+            logger.log(Level.DEBUG, "Mixed cgroupv1 and cgroupv2 not supported. Metrics disabled.");
             return null;
         }
 
@@ -91,11 +121,6 @@ public static CgroupMetrics create(Optional<CgroupTypeResult> optResult) {
         }
     }
 
-    private static void warn(String msg) {
-        Logger logger = System.getLogger("jdk.internal.platform");
-        logger.log(Level.DEBUG, msg);
-    }
-
     /*
      * Determine the type of the cgroup system (v1 - legacy or hybrid - or, v2 - unified)
      * based on three files:
@@ -171,15 +196,16 @@ public static Optional<CgroupTypeResult> determineType(String mountInfo,
         // See:
         //   setCgroupV1Path() for the action run for cgroups v1 systems
         //   setCgroupV2Path() for the action run for cgroups v2 systems
-        Consumer<String[]> action = (tokens -> setCgroupV1Path(infos, tokens));
-        if (isCgroupsV2) {
-            action = (tokens -> setCgroupV2Path(infos, tokens));
-        }
-        for (String line : CgroupUtil.readAllLinesPrivileged(Paths.get(selfCgroup))) {
+        try (Stream<String> selfCgroupLines =
+             CgroupUtil.readFilePrivileged(Paths.get(selfCgroup))) {
+            Consumer<String[]> action = (tokens -> setCgroupV1Path(infos, tokens));
+            if (isCgroupsV2) {
+                action = (tokens -> setCgroupV2Path(infos, tokens));
+            }
             // The limit value of 3 is because /proc/self/cgroup contains three
             // colon-separated tokens per line. The last token, cgroup path, might
             // contain a ':'.
-            action.accept(line.split(":", 3));
+            selfCgroupLines.map(line -> line.split(":", 3)).forEach(action);
         }
 
         CgroupTypeResult result = new CgroupTypeResult(isCgroupsV2,
@@ -255,8 +281,8 @@ private static void setCgroupV1Path(Map<String, CgroupInfo> infos,
     /**
      * Amends cgroup infos with mount path and mount root. The passed in
      * 'mntInfoLine' represents a single line in, for example,
-     * /proc/self/mountinfo. Each line is parsed with {@link MountInfo#parse},
-     * so as to extract the relevant tokens from the line.
+     * /proc/self/mountinfo. Each line is matched with MOUNTINFO_PATTERN
+     * (see above), so as to extract the relevant tokens from the line.
      *
      * Host example cgroups v1:
      *
@@ -277,13 +303,13 @@ private static void setCgroupV1Path(Map<String, CgroupInfo> infos,
     private static boolean amendCgroupInfos(String mntInfoLine,
                                             Map<String, CgroupInfo> infos,
                                             boolean isCgroupsV2) {
-        MountInfo mountInfo = MountInfo.parse(mntInfoLine);
+        Matcher lineMatcher = MOUNTINFO_PATTERN.matcher(mntInfoLine.trim());
         boolean cgroupv1ControllerFound = false;
         boolean cgroupv2ControllerFound = false;
-        if (mountInfo != null) {
-            String mountRoot = mountInfo.mountRoot;
-            String mountPath = mountInfo.mountPath;
-            String fsType = mountInfo.fsType;
+        if (lineMatcher.matches()) {
+            String mountRoot = lineMatcher.group(1);
+            String mountPath = lineMatcher.group(2);
+            String fsType = lineMatcher.group(3);
             if (fsType.equals("cgroup")) {
                 Path p = Paths.get(mountPath);
                 String[] controllerNames = p.getFileName().toString().split(",");
@@ -319,59 +345,6 @@ private static boolean amendCgroupInfos(String mntInfoLine,
         return cgroupv1ControllerFound || cgroupv2ControllerFound;
     }
 
-    private record MountInfo(String mountRoot, String mountPath, String fsType) {
-        /*
-         * From https://www.kernel.org/doc/Documentation/filesystems/proc.txt
-         *
-         *  36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root rw,errors=continue
-         *  (1)(2)(3)   (4)   (5)      (6)      (7)   (8) (9)   (10)         (11)
-         *
-         *  (1) mount ID:  unique identifier of the mount (may be reused after umount)
-         *  (2) parent ID:  ID of parent (or of self for the top of the mount tree)
-         *  (3) major:minor:  value of st_dev for files on filesystem
-         *  (4) root:  root of the mount within the filesystem
-         *  (5) mount point:  mount point relative to the process's root
-         *  (6) mount options:  per mount options
-         *  (7) optional fields:  zero or more fields of the form "tag[:value]"
-         *  (8) separator:  marks the end of the optional fields
-         *  (9) filesystem type:  name of filesystem of the form "type[.subtype]"
-         *  (10) mount source:  filesystem specific information or "none"
-         *  (11) super options:  per super block options
-         */
-        static MountInfo parse(String line) {
-            String mountRoot = null;
-            String mountPath = null;
-
-            int separatorOrdinal = -1;
-            // loop over space-separated tokens
-            for (int tOrdinal = 1, tStart = 0, tEnd = line.indexOf(' '); tEnd != -1; tOrdinal++, tStart = tEnd + 1, tEnd = line.indexOf(' ', tStart)) {
-                if (tStart == tEnd) {
-                    break; // unexpected empty token
-                }
-                switch (tOrdinal) {
-                    case 1, 2, 3, 6 -> {} // skip token
-                    case 4 -> mountRoot = line.substring(tStart, tEnd); // root token
-                    case 5 -> mountPath = line.substring(tStart, tEnd); // mount point token
-                    default -> {
-                        assert tOrdinal >= 7;
-                        if (separatorOrdinal == -1) {
-                            // check if we found a separator token
-                            if (tEnd - tStart == 1 && line.charAt(tStart) == '-') {
-                                separatorOrdinal = tOrdinal;
-                            }
-                            continue; // skip token
-                        }
-                        if (tOrdinal == separatorOrdinal + 1) { // filesystem type token
-                            String fsType = line.substring(tStart, tEnd);
-                            return new MountInfo(mountRoot, mountPath, fsType);
-                        }
-                    }
-                }
-            }
-            return null; // parsing failed
-        }
-    }
-
     private static void setMountPoints(CgroupInfo info, String mountPath, String mountRoot) {
         if (info.getMountPoint() != null) {
             // On some systems duplicate controllers get mounted in addition to
diff --git a/src/java.base/linux/classes/jdk/internal/platform/CgroupUtil.java b/src/java.base/linux/classes/jdk/internal/platform/CgroupUtil.java
@@ -26,19 +26,32 @@
 package jdk.internal.platform;
 
 import java.io.BufferedReader;
-import java.io.FileReader;
 import java.io.IOException;
-import java.nio.charset.StandardCharsets;
+import java.io.UncheckedIOException;
+import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.security.AccessController;
 import java.security.PrivilegedActionException;
 import java.security.PrivilegedExceptionAction;
-import java.util.ArrayList;
 import java.util.List;
+import java.util.stream.Stream;
 
 public final class CgroupUtil {
 
+    @SuppressWarnings("removal")
+    public static Stream<String> readFilePrivileged(Path path) throws IOException {
+        try {
+            PrivilegedExceptionAction<Stream<String>> pea = () -> Files.lines(path);
+            return AccessController.doPrivileged(pea);
+        } catch (PrivilegedActionException e) {
+            unwrapIOExceptionAndRethrow(e);
+            throw new InternalError(e.getCause());
+        } catch (UncheckedIOException e) {
+            throw e.getCause();
+        }
+    }
+
     static void unwrapIOExceptionAndRethrow(PrivilegedActionException pae) throws IOException {
         Throwable x = pae.getCause();
         if (x instanceof IOException)
@@ -51,34 +64,29 @@ static void unwrapIOExceptionAndRethrow(PrivilegedActionException pae) throws IO
 
     static String readStringValue(CgroupSubsystemController controller, String param) throws IOException {
         PrivilegedExceptionAction<BufferedReader> pea = () ->
-                new BufferedReader(new FileReader(Paths.get(controller.path(), param).toString(), StandardCharsets.UTF_8));
+                Files.newBufferedReader(Paths.get(controller.path(), param));
         try (@SuppressWarnings("removal") BufferedReader bufferedReader =
                      AccessController.doPrivileged(pea)) {
             String line = bufferedReader.readLine();
             return line;
         } catch (PrivilegedActionException e) {
             unwrapIOExceptionAndRethrow(e);
             throw new InternalError(e.getCause());
+        } catch (UncheckedIOException e) {
+            throw e.getCause();
         }
     }
 
     @SuppressWarnings("removal")
     public static List<String> readAllLinesPrivileged(Path path) throws IOException {
         try {
-            PrivilegedExceptionAction<List<String>> pea = () -> {
-                try (BufferedReader bufferedReader = new BufferedReader(new FileReader(path.toString(), StandardCharsets.UTF_8))) {
-                    String line;
-                    List<String> lines = new ArrayList<>();
-                    while ((line = bufferedReader.readLine()) != null) {
-                        lines.add(line);
-                    }
-                    return lines;
-                }
-            };
+            PrivilegedExceptionAction<List<String>> pea = () -> Files.readAllLines(path);
             return AccessController.doPrivileged(pea);
         } catch (PrivilegedActionException e) {
             unwrapIOExceptionAndRethrow(e);
             throw new InternalError(e.getCause());
+        } catch (UncheckedIOException e) {
+            throw e.getCause();
         }
     }
 }
diff --git a/src/java.base/linux/classes/jdk/internal/platform/cgroupv1/CgroupV1SubsystemController.java b/src/java.base/linux/classes/jdk/internal/platform/cgroupv1/CgroupV1SubsystemController.java
@@ -107,7 +107,7 @@ public static long getLongValueMatchingLine(CgroupSubsystemController controller
     }
 
     public static long convertHierachicalLimitLine(String line) {
-        String[] tokens = line.split(" ");
+        String[] tokens = line.split("\\s");
         if (tokens.length == 2) {
             String strVal = tokens[1];
             return CgroupV1SubsystemController.convertStringToLong(strVal);
diff --git a/src/java.base/linux/classes/jdk/internal/platform/cgroupv2/CgroupV2Subsystem.java b/src/java.base/linux/classes/jdk/internal/platform/cgroupv2/CgroupV2Subsystem.java
@@ -26,9 +26,11 @@
 package jdk.internal.platform.cgroupv2;
 
 import java.io.IOException;
+import java.io.UncheckedIOException;
 import java.nio.file.Paths;
 import java.util.concurrent.TimeUnit;
 import java.util.function.Function;
+import java.util.stream.Collectors;
 
 import jdk.internal.platform.CgroupInfo;
 import jdk.internal.platform.CgroupSubsystem;
@@ -141,7 +143,7 @@ private long getFromCpuMax(int tokenIdx) {
             return CgroupSubsystem.LONG_RETVAL_UNLIMITED;
         }
         // $MAX $PERIOD
-        String[] tokens = cpuMaxRaw.split(" ");
+        String[] tokens = cpuMaxRaw.split("\\s+");
         if (tokens.length != 2) {
             return CgroupSubsystem.LONG_RETVAL_UNLIMITED;
         }
@@ -327,12 +329,10 @@ public long getBlkIOServiced() {
 
     private long sumTokensIOStat(Function<String, Long> mapFunc) {
         try {
-            long sum = 0L;
-            for (String line : CgroupUtil.readAllLinesPrivileged(Paths.get(unified.path(), "io.stat"))) {
-                sum += mapFunc.apply(line);
-            }
-            return sum;
-        } catch (IOException e) {
+            return CgroupUtil.readFilePrivileged(Paths.get(unified.path(), "io.stat"))
+                                .map(mapFunc)
+                                .collect(Collectors.summingLong(e -> e));
+        } catch (UncheckedIOException | IOException e) {
             return CgroupSubsystem.LONG_RETVAL_UNLIMITED;
         }
     }
@@ -359,7 +359,7 @@ private static Long ioStatLineToLong(String line, String[] matchNames) {
         if (line == null || EMPTY_STR.equals(line)) {
             return Long.valueOf(0);
         }
-        String[] tokens = line.split(" ");
+        String[] tokens = line.split("\\s+");
         long retval = 0;
         for (String t: tokens) {
             String[] valKeys = t.split("=");
diff --git a/test/jdk/jdk/internal/platform/cgroup/TestCgroupSubsystemFactory.java b/test/jdk/jdk/internal/platform/cgroup/TestCgroupSubsystemFactory.java

Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ public void setCgroupPath(String cgroupPath) {`
`107`	`107`	`*`
`108`	`108`	`*/`
`109`	`109`	`static CgroupInfo fromCgroupsLine(String line) {`
`110`		`- String[] tokens = line.split("\t");`
	`110`	`+ String[] tokens = line.split("\\s+");`
`111`	`111`	`if (tokens.length != 4) {`
`112`	`112`	`return null;`
`113`	`113`	`}`
Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ public static long getLongValueMatchingLine(CgroupSubsystemController controller`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`public static long convertHierachicalLimitLine(String line) {`
`110`		`- String[] tokens = line.split(" ");`
	`110`	`+ String[] tokens = line.split("\\s");`
`111`	`111`	`if (tokens.length == 2) {`
`112`	`112`	`String strVal = tokens[1];`
`113`	`113`	`return CgroupV1SubsystemController.convertStringToLong(strVal);`