View Javadoc
1   // ******************************************************************************
2   //
3   // Title:       Force Field X.
4   // Description: Force Field X - Software for Molecular Biophysics.
5   // Copyright:   Copyright (c) Michael J. Schnieders 2001-2024.
6   //
7   // This file is part of Force Field X.
8   //
9   // Force Field X is free software; you can redistribute it and/or modify it
10  // under the terms of the GNU General Public License version 3 as published by
11  // the Free Software Foundation.
12  //
13  // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16  // details.
17  //
18  // You should have received a copy of the GNU General Public License along with
19  // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20  // Place, Suite 330, Boston, MA 02111-1307 USA
21  //
22  // Linking this library statically or dynamically with other modules is making a
23  // combined work based on this library. Thus, the terms and conditions of the
24  // GNU General Public License cover the whole combination.
25  //
26  // As a special exception, the copyright holders of this library give you
27  // permission to link this library with independent modules to produce an
28  // executable, regardless of the license terms of these independent modules, and
29  // to copy and distribute the resulting executable under terms of your choice,
30  // provided that you also meet, for each linked independent module, the terms
31  // and conditions of the license of that module. An independent module is a
32  // module which is not derived from or based on this library. If you modify this
33  // library, you may extend this exception to your version of the library, but
34  // you are not obligated to do so. If you do not wish to do so, delete this
35  // exception statement from your version.
36  //
37  // ******************************************************************************
38  package ffx.utilities;
39  
40  import static java.lang.Runtime.getRuntime;
41  import static java.lang.String.format;
42  import static java.lang.management.ManagementFactory.getOperatingSystemMXBean;
43  
44  import com.sun.management.UnixOperatingSystemMXBean;
45  import java.lang.management.OperatingSystemMXBean;
46  import java.util.logging.Level;
47  import java.util.logging.Logger;
48  
49  /**
50   * Log resources.
51   *
52   * @author Michael J. Schnieders
53   * @since 1.0
54   */
55  public class Resources {
56  
57    private static final Logger logger = Logger.getLogger(Resources.class.getName());
58  
59    /**
60     * Private constructor to prevent instantiation.
61     */
62    private Resources() {
63      // Empty constructor.
64    }
65  
66    /**
67     * Log resources.
68     */
69    public static void logResources() {
70      if (logger.isLoggable(Level.INFO)) {
71        StringBuilder sb = new StringBuilder("\n System Resources\n");
72  
73        Runtime runtime = getRuntime();
74        runtime.gc();
75  
76        long MB = 1024 * 1024;
77        OperatingSystemMXBean operatingSystemMXBean = getOperatingSystemMXBean();
78  
79        if (operatingSystemMXBean instanceof UnixOperatingSystemMXBean unixOS) {
80          // CPU Time and Average System Load.
81          long time = unixOS.getProcessCpuTime();
82          sb.append(format("  Total CPU time:         %6.2f (sec)\n", time * 1.0e-9));
83          double systemLoadAve = unixOS.getSystemLoadAverage();
84          if (systemLoadAve >= 0) {
85            sb.append(format("  System load average:    %6.2f\n", systemLoadAve));
86          }
87          // File handle use.
88          long open = unixOS.getOpenFileDescriptorCount();
89          long allowed = unixOS.getMaxFileDescriptorCount();
90          sb.append(format("  Open file handles:      %6d of %6d allowed\n", open, allowed));
91  
92          // System Memory.
93          long freePhysical = unixOS.getFreeMemorySize() / MB;
94          long totalPhysical = unixOS.getTotalMemorySize() / MB;
95          long freeSwap = unixOS.getFreeSwapSpaceSize() / MB;
96          long totalSwap = unixOS.getTotalSwapSpaceSize() / MB;
97          sb.append(format("  System memory:          %6d MB free out of %6d MB\n", freePhysical,
98              totalPhysical));
99          sb.append(
100             format("  System swap space:      %6d MB free out of %6d MB\n", freeSwap, totalSwap));
101       }
102 
103       // JVM Memory.
104       sb.append(
105           format("  JVM memory:             %6d MB free out of %6d MB", runtime.freeMemory() / MB,
106               runtime.totalMemory() / MB));
107 
108       logger.info(sb.toString());
109     }
110   }
111 }