Add network interface dropped packets and collisions (oshi#1101)

* Add network interface dropped packets and collisions

* Changelog, tests, resolve todos

Author: dbwiddis

CHANGELOG.md

@@ -2,6 +2,7 @@
 ================
 * [#1098](https://github.com/oshi/oshi/pull/1098): Option to limit FileStore list to local file systems. - [@Space2Man](https://github.com/Space2Man).
 * [#1100](https://github.com/oshi/oshi/pull/1100): Get FileStore options. - [@dbwiddis](https://github.com/dbwiddis).
+* [#1101](https://github.com/oshi/oshi/pull/1101): Add network interface dropped packets and collisions. - [@dbwiddis](https://github.com/dbwiddis).
 * Your contribution here.
 
 4.3.0 (1/2/2020), 4.3.1 (2/5/2020)

oshi-core/src/main/java/oshi/hardware/NetworkIF.java

@@ -63,6 +63,8 @@ public class NetworkIF {
     private long packetsSent;
     private long inErrors;
     private long outErrors;
+    private long inDrops;
+    private long collisions;
     private long speed;
     private long timeStamp;
 
@@ -156,10 +158,11 @@ public String getDisplayName() {
      * The interface Maximum Transmission Unit (MTU).
      * </p>
      *
-     * @return The MTU of the network interface. This value is set when the
-     *         {@link oshi.hardware.NetworkIF} is instantiated and may not be up to
-     *         date. To update this value, execute the
-     *         {@link #setNetworkInterface(NetworkInterface)} method
+     * @return The MTU of the network interface.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #setNetworkInterface(NetworkInterface)} method
      */
     public int getMTU() {
         return this.mtu;
@@ -170,10 +173,11 @@ public int getMTU() {
      * The Media Access Control (MAC) address.
      * </p>
      *
-     * @return The MAC Address. This value is set when the
-     *         {@link oshi.hardware.NetworkIF} is instantiated and may not be up to
-     *         date. To update this value, execute the
-     *         {@link #setNetworkInterface(NetworkInterface)} method
+     * @return The MAC Address.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #setNetworkInterface(NetworkInterface)} method
      */
     public String getMacaddr() {
         return this.mac;
@@ -184,10 +188,11 @@ public String getMacaddr() {
      * The Internet Protocol (IP) v4 address.
      * </p>
      *
-     * @return The IPv4 Addresses. This value is set when the
-     *         {@link oshi.hardware.NetworkIF} is instantiated and may not be up to
-     *         date. To update this value, execute the
-     *         {@link #setNetworkInterface(NetworkInterface)} method
+     * @return The IPv4 Addresses.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #setNetworkInterface(NetworkInterface)} method
      */
     public String[] getIPv4addr() {
         return Arrays.copyOf(this.ipv4, this.ipv4.length);
@@ -198,10 +203,11 @@ public String[] getIPv4addr() {
      * The Internet Protocol (IP) v4 subnet masks.
      * </p>
      *
-     * @return The IPv4 subnet mask length. Ranges between 0-32 This value is set
-     *         when the {@link oshi.hardware.NetworkIF} is instantiated and may not
-     *         be up to date. To update this value, execute the
-     *         {@link #setNetworkInterface(NetworkInterface)} method.
+     * @return The IPv4 subnet mask length. Ranges between 0-32.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #setNetworkInterface(NetworkInterface)} method.
      *
      */
     public Short[] getSubnetMasks() {
@@ -213,10 +219,11 @@ public Short[] getSubnetMasks() {
      * The Internet Protocol (IP) v6 address.
      * </p>
      *
-     * @return The IPv6 Addresses. This value is set when the
-     *         {@link oshi.hardware.NetworkIF} is instantiated and may not be up to
-     *         date. To update this value, execute the
-     *         {@link #setNetworkInterface(NetworkInterface)} method
+     * @return The IPv6 Addresses.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #setNetworkInterface(NetworkInterface)} method
      */
     public String[] getIPv6addr() {
         return Arrays.copyOf(this.ipv6, this.ipv6.length);
@@ -227,10 +234,11 @@ public String[] getIPv6addr() {
      * The Internet Protocol (IP) v6 address.
      * </p>
      *
-     * @return The IPv6 address prefix lengths. Ranges between 0-128. This value is
-     *         set when the {@link oshi.hardware.NetworkIF} is instantiated and may
-     *         not be up to date. To update this value, execute the
-     *         {@link #setNetworkInterface(NetworkInterface)} method
+     * @return The IPv6 address prefix lengths. Ranges between 0-128.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #setNetworkInterface(NetworkInterface)} method
      */
     public Short[] getPrefixLengths() {
         return Arrays.copyOf(this.prefixLengths, this.prefixLengths.length);
@@ -241,10 +249,11 @@ public Short[] getPrefixLengths() {
      * Getter for the field <code>bytesRecv</code>.
      * </p>
      *
-     * @return The Bytes Received. This value is set when the
-     *         {@link oshi.hardware.NetworkIF} is instantiated and may not be up to
-     *         date. To update this value, execute the {@link #updateAttributes()}
-     *         method
+     * @return The Bytes Received.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #updateAttributes()} method
      */
     public long getBytesRecv() {
         return this.bytesRecv;
@@ -267,10 +276,11 @@ public void setBytesRecv(long bytesRecv) {
      * Getter for the field <code>bytesSent</code>.
      * </p>
      *
-     * @return The Bytes Sent. This value is set when the
-     *         {@link oshi.hardware.NetworkIF} is instantiated and may not be up to
-     *         date. To update this value, execute the {@link #updateAttributes()}
-     *         method
+     * @return The Bytes Sent.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #updateAttributes()} method
      */
     public long getBytesSent() {
         return this.bytesSent;
@@ -293,10 +303,11 @@ public void setBytesSent(long bytesSent) {
      * Getter for the field <code>packetsRecv</code>.
      * </p>
      *
-     * @return The Packets Received. This value is set when the
-     *         {@link oshi.hardware.NetworkIF} is instantiated and may not be up to
-     *         date. To update this value, execute the {@link #updateAttributes()}
-     *         method
+     * @return The Packets Received.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #updateAttributes()} method
      */
     public long getPacketsRecv() {
         return this.packetsRecv;
@@ -319,10 +330,11 @@ public void setPacketsRecv(long packetsRecv) {
      * Getter for the field <code>packetsSent</code>.
      * </p>
      *
-     * @return The Packets Sent. This value is set when the
-     *         {@link oshi.hardware.NetworkIF} is instantiated and may not be up to
-     *         date. To update this value, execute the {@link #updateAttributes()}
-     *         method
+     * @return The Packets Sent.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #updateAttributes()} method
      */
     public long getPacketsSent() {
         return this.packetsSent;
@@ -345,10 +357,11 @@ public void setPacketsSent(long packetsSent) {
      * Getter for the field <code>inErrors</code>.
      * </p>
      *
-     * @return Input Errors. This value is set when the
-     *         {@link oshi.hardware.NetworkIF} is instantiated and may not be up to
-     *         date. To update this value, execute the {@link #updateAttributes()}
-     *         method
+     * @return Input Errors.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #updateAttributes()} method
      */
     public long getInErrors() {
         return this.inErrors;
@@ -371,10 +384,11 @@ public void setInErrors(long inErrors) {
      * Getter for the field <code>outErrors</code>.
      * </p>
      *
-     * @return The Output Errors. This value is set when the
-     *         {@link oshi.hardware.NetworkIF} is instantiated and may not be up to
-     *         date. To update this value, execute the {@link #updateAttributes()}
-     *         method
+     * @return The Output Errors.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #updateAttributes()} method
      */
     public long getOutErrors() {
         return this.outErrors;
@@ -392,15 +406,71 @@ public void setOutErrors(long outErrors) {
         this.outErrors = ParseUtil.unsignedLongToSignedLong(outErrors);
     }
 
+    /**
+     * <p>
+     * Getter for the field <code>inDrops</code>.
+     * </p>
+     *
+     * @return Incoming/Received dropped packets. On Windows, returns discarded
+     *         incoming packets.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #updateAttributes()} method
+     */
+    public long getInDrops() {
+        return inDrops;
+    }
+
+    /**
+     * <p>
+     * Setter for the field <code>inDrops</code>.
+     * </p>
+     *
+     * @param inDrops
+     *            The incoming (receive) dropped packets to set.
+     */
+    public void setInDrops(long inDrops) {
+        this.inDrops = inDrops;
+    }
+
+    /**
+     * <p>
+     * Getter for the field <code>collisions</code>.
+     * </p>
+     *
+     * @return Packet collisions. On Windows, returns discarded outgoing packets.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #updateAttributes()} method
+     */
+    public long getCollisions() {
+        return collisions;
+    }
+
+    /**
+     * <p>
+     * Setter for the field <code>collisions</code>.
+     * </p>
+     *
+     * @param collisions
+     *            The collisions to set.
+     */
+    public void setCollisions(long collisions) {
+        this.collisions = collisions;
+    }
+
     /**
      * <p>
      * Getter for the field <code>speed</code>.
      * </p>
      *
-     * @return The speed of the network interface in bits per second. This value is
-     *         set when the {@link oshi.hardware.NetworkIF} is instantiated and may
-     *         not be up to date. To update this value, execute the
-     *         {@link #updateAttributes()} method
+     * @return The speed of the network interface in bits per second.
+     *         <p>
+     *         This value is set when the {@link oshi.hardware.NetworkIF} is
+     *         instantiated and may not be up to date. To update this value, execute
+     *         the {@link #updateAttributes()} method
      */
     public long getSpeed() {
         return this.speed;
@@ -444,27 +514,24 @@ public void setTimeStamp(long timeStamp) {
     /**
      * Updates interface network statistics on this interface. Statistics include
      * packets and bytes sent and received, and interface speed.
+     *
+     * @return {@code true} if the update was successful, {@code false} otherwise.
      */
-    public void updateAttributes() {
+    public boolean updateAttributes() {
         switch (SystemInfo.getCurrentPlatformEnum()) {
         case WINDOWS:
-            WindowsNetworks.updateNetworkStats(this);
-            break;
+            return WindowsNetworks.updateNetworkStats(this);
         case LINUX:
-            LinuxNetworks.updateNetworkStats(this);
-            break;
+            return LinuxNetworks.updateNetworkStats(this);
         case MACOSX:
-            MacNetworks.updateNetworkStats(this);
-            break;
+            return MacNetworks.updateNetworkStats(this);
         case SOLARIS:
-            SolarisNetworks.updateNetworkStats(this);
-            break;
+            return SolarisNetworks.updateNetworkStats(this);
         case FREEBSD:
-            FreeBsdNetworks.updateNetworkStats(this);
-            break;
+            return FreeBsdNetworks.updateNetworkStats(this);
         default:
             LOG.error("Unsupported platform. No update performed.");
-            break;
+            return false;
         }
     }
 
@@ -479,9 +546,11 @@ public String toString() {
         sb.append("  IPv6: ").append(Arrays.toString(getIPv6addr())).append("\n");
         sb.append("  Prefix Lengths:  ").append(Arrays.toString(getPrefixLengths())).append("\n");
         sb.append("  Traffic: received ").append(getPacketsRecv()).append(" packets/")
-                .append(FormatUtil.formatBytes(getBytesRecv())).append(" (" + getInErrors() + " err);");
+                .append(FormatUtil.formatBytes(getBytesRecv())).append(" (" + getInErrors() + " err, ")
+                .append(getInDrops() + " drop);");
         sb.append(" transmitted ").append(getPacketsSent()).append(" packets/")
-                .append(FormatUtil.formatBytes(getBytesSent())).append(" (" + getOutErrors() + " err)");
+                .append(FormatUtil.formatBytes(getBytesSent())).append(" (" + getOutErrors() + " err, ")
+                .append(getCollisions() + " coll);");
         return sb.toString();
     }
 }

oshi-core/src/main/java/oshi/hardware/platform/linux/LinuxNetworks.java

@@ -23,6 +23,8 @@
  */
 package oshi.hardware.platform.linux;
 
+import java.io.File;
+
 import oshi.hardware.NetworkIF;
 import oshi.hardware.common.AbstractNetworks;
 import oshi.util.FileUtil;
@@ -40,13 +42,23 @@ public class LinuxNetworks extends AbstractNetworks {
      * @param netIF
      *            The interface on which to update statistics
      */
-    public static void updateNetworkStats(NetworkIF netIF) {
+    public static boolean updateNetworkStats(NetworkIF netIF) {
+        try {
+            File ifDir = new File(String.format("/sys/class/net/%s/statistics", netIF.getName()));
+            if (!ifDir.isDirectory()) {
+                return false;
+            }
+        } catch (SecurityException e) {
+            return false;
+        }
         String txBytesPath = String.format("/sys/class/net/%s/statistics/tx_bytes", netIF.getName());
         String rxBytesPath = String.format("/sys/class/net/%s/statistics/rx_bytes", netIF.getName());
         String txPacketsPath = String.format("/sys/class/net/%s/statistics/tx_packets", netIF.getName());
         String rxPacketsPath = String.format("/sys/class/net/%s/statistics/rx_packets", netIF.getName());
         String txErrorsPath = String.format("/sys/class/net/%s/statistics/tx_errors", netIF.getName());
         String rxErrorsPath = String.format("/sys/class/net/%s/statistics/rx_errors", netIF.getName());
+        String collisionsPath = String.format("/sys/class/net/%s/statistics/collisions", netIF.getName());
+        String rxDropsPath = String.format("/sys/class/net/%s/statistics/rx_dropped", netIF.getName());
         String speed = String.format("/sys/class/net/%s/speed", netIF.getName());
 
         netIF.setTimeStamp(System.currentTimeMillis());
@@ -56,7 +68,10 @@ public static void updateNetworkStats(NetworkIF netIF) {
         netIF.setPacketsRecv(FileUtil.getUnsignedLongFromFile(rxPacketsPath));
         netIF.setOutErrors(FileUtil.getUnsignedLongFromFile(txErrorsPath));
         netIF.setInErrors(FileUtil.getUnsignedLongFromFile(rxErrorsPath));
+        netIF.setCollisions(FileUtil.getUnsignedLongFromFile(collisionsPath));
+        netIF.setInDrops(FileUtil.getUnsignedLongFromFile(rxDropsPath));
         long netSpeed = FileUtil.getUnsignedLongFromFile(speed) * 1024 * 1024;
         netIF.setSpeed(netSpeed < 0 ? 0 : netSpeed);
+        return true;
     }
 }