ohai 15.8.0 → 16.2.1

data/lib/ohai/plugins/darwin/platform.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,11 +23,6 @@ Ohai.plugin(:Platform) do
     so = shell_out((Ohai.abs_path( "/usr/bin/sw_vers" )).to_s)
     so.stdout.lines do |line|
       case line
-      when /^ProductName:\s+(.+)$/
-        macname = $1
-        macname.downcase!
-        macname.tr!(" ", "_")
-        platform macname
       when /^ProductVersion:\s+(.+)$/
         platform_version $1
       when /^BuildVersion:\s+(.+)$/
@@ -35,6 +30,8 @@ Ohai.plugin(:Platform) do
       end
     end
 
+    # if we're on darwin assume we're on mac_os_x
+    platform "mac_os_x"
     platform_family "mac_os_x"
   end
 end

data/lib/ohai/plugins/docker.rb

@@ -24,7 +24,7 @@ Ohai.plugin(:Docker) do
   def docker_info_json
     so = shell_out("docker info --format '{{json .}}'")
     if so.exitstatus == 0
-      return JSON.parse(so.stdout)
+      JSON.parse(so.stdout)
     end
   rescue Ohai::Exceptions::Exec
     logger.trace('Plugin Docker: Could not shell_out "docker info --format \'{{json .}}\'". Skipping plugin')

data/lib/ohai/plugins/ec2.rb

@@ -86,7 +86,7 @@ Ohai.plugin(:EC2) do
       wmi = WmiLite::Wmi.new
       if wmi.first_of("Win32_ComputerSystemProduct")["identifyingnumber"] =~ /^ec2/
         logger.trace("Plugin EC2: has_ec2_identifying_number? == true")
-        return true
+        true
       end
     else
       logger.trace("Plugin EC2: has_ec2_identifying_number? == false")

data/lib/ohai/plugins/eucalyptus.rb

@@ -32,9 +32,9 @@ Ohai.plugin(:Eucalyptus) do
   def get_mac_address(addresses)
     detected_addresses = addresses.detect { |address, keypair| keypair == { "family" => "lladdr" } }
     if detected_addresses
-      return detected_addresses.first
+      detected_addresses.first
     else
-      return ""
+      ""
     end
   end
 

data/lib/ohai/plugins/filesystem.rb

@@ -6,7 +6,7 @@
 # Author:: Prabhu Das (<prabhu.das@clogeny.com>)
 # Author:: Isa Farnik (<isa@chef.io>)
 # Author:: James Gartrell (<jgartrel@gmail.com>)
-# Copyright:: Copyright (c) 2008-2017 Chef Software, Inc.
+# Copyright:: Copyright (c) 2008-2020 Chef Software, Inc.
 # Copyright:: Copyright (c) 2015 Facebook, Inc.
 # License:: Apache License, Version 2.0
 #
@@ -23,6 +23,8 @@
 # limitations under the License.
 #
 
+require "set"
+
 Ohai.plugin(:Filesystem) do
   provides "filesystem"
 
@@ -98,15 +100,6 @@ Ohai.plugin(:Filesystem) do
     view
   end
 
-  def generate_deprecated_view(fs)
-    view = generate_device_view(fs)
-    view.each do |device, entry|
-      view[device][:mount] = entry[:mounts].first
-      view[device].delete(:mounts)
-    end
-    view
-  end
-
   def generate_deprecated_windows_view(fs)
     view = generate_mountpoint_view(fs)
     view.each do |mp, entry|
@@ -115,22 +108,6 @@ Ohai.plugin(:Filesystem) do
     view
   end
 
-  def generate_deprecated_solaris_view(fs, old_zfs)
-    view = generate_deprecated_view(fs)
-    old_zfs.each do |fsname, attributes|
-      view[fsname] ||= Mash.new
-      view[fsname][:fs_type] = "zfs"
-      view[fsname][:mount] = attributes[:values][:mountpoint] if attributes[:values].key?("mountpoint")
-      view[fsname][:device] = fsname
-      view[fsname][:zfs_values] = attributes[:values]
-      view[fsname][:zfs_sources] = attributes[:sources]
-      # parents will already be here
-      # but we want to nuke "zfs_properties"
-      view[fsname].delete("zfs_properties")
-    end
-    view
-  end
-
   def parse_common_df(out)
     fs = {}
     out.each_line do |line|
@@ -496,9 +473,8 @@ Ohai.plugin(:Filesystem) do
     fs_data["by_mountpoint"] = by_mountpoint
     fs_data["by_pair"] = by_pair
 
-    # Set the filesystem data - BSD didn't do the conversion when everyone else
-    # did, so 15 will have both be the new API and 16 will drop the old API
-    filesystem generate_deprecated_view(fs)
+    # @todo in Chef 17 the filesystem2 part of this goes away
+    filesystem fs_data
     filesystem2 fs_data
   end
 
@@ -595,7 +571,6 @@ Ohai.plugin(:Filesystem) do
 
     # Grab any zfs data from "zfs get"
     zfs = Mash.new
-    old_zfs = Mash.new
     zfs_get = "zfs get -p -H all"
     run_with_check("zfs") do
       so = shell_out(zfs_get)
@@ -612,13 +587,6 @@ Ohai.plugin(:Filesystem) do
           value: value,
           source: source,
         }
-        # needed for old v1 view
-        old_zfs[filesystem] ||= Mash.new
-        old_zfs[filesystem][:values] ||= Mash.new
-        old_zfs[filesystem][:sources] ||= Mash.new
-        old_zfs[filesystem][:values][property] = value
-        old_zfs[filesystem][:values][property] = value
-        old_zfs[filesystem][:sources][property] = source
       end
     end
 
@@ -652,9 +620,8 @@ Ohai.plugin(:Filesystem) do
     fs_data["by_mountpoint"] = by_mountpoint
     fs_data["by_pair"] = by_pair
 
-    # Set the filesystem data - Solaris didn't do the conversion when everyone
-    # else did, so 15 will have both be the new API and 16 will drop the old API
-    filesystem generate_deprecated_solaris_view(fs, old_zfs)
+    # @todo in Chef 17 the filesystem2 plugin goes away
+    filesystem fs_data
     filesystem2 fs_data
   end
 
@@ -745,9 +712,8 @@ Ohai.plugin(:Filesystem) do
     fs_data["by_mountpoint"] = by_mountpoint
     fs_data["by_pair"] = by_pair
 
-    # Set the filesystem data - AIX didn't do the conversion when everyone
-    # else did, so 15 will have both be the new API and 16 will drop the old API
-    filesystem generate_deprecated_view(fs)
+    # @todo in Chef 17 the filesystem2 plugin goes away here
+    filesystem fs_data
     filesystem2 fs_data
   end
 

data/lib/ohai/plugins/{linux/fips.rb → fips.rb}

@@ -25,7 +25,7 @@
 Ohai.plugin(:Fips) do
   provides "fips"
 
-  collect_data(:linux) do
+  collect_data(:linux, :windows) do
     fips Mash.new
 
     require "openssl" unless defined?(OpenSSL)

data/lib/ohai/plugins/gce.rb

@@ -54,7 +54,7 @@ Ohai.plugin(:GCE) do
       computer_system = wmi.first_of("Win32_ComputerSystem")
       if computer_system["Manufacturer"] =~ /^Google/ && computer_system["Model"] =~ /^Google/
         logger.trace("Plugin GCE: has_gce_system_info? == true")
-        return true
+        true
       end
     else
       logger.trace("Plugin GCE: has_gce_system_info? == false")

data/lib/ohai/plugins/kernel.rb

@@ -4,7 +4,7 @@
 # Author:: Bryan McLellan (<btm@loftninjas.org>)
 # Author:: Claire McQuin (<claire@chef.io>)
 # Author:: James Gartrell (<jgartrel@gmail.com>)
-# Copyright:: Copyright (c) 2008-2018 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software, Inc.
 # Copyright:: Copyright (c) 2009 Bryan McLellan
 # License:: Apache License, Version 2.0
 #
@@ -137,11 +137,12 @@ Ohai.plugin(:Kernel) do
     end
   end
 
-  # see if a WMI name is blacklisted so we can avoid writing out
-  # useless data to ohai
+  # see if a WMI name is in the blocked list so we can avoid writing
+  # out useless data to ohai
+  #
   # @param [String] name the wmi name to check
-  # @return [Boolean] is the wmi name blacklisted
-  def blacklisted_wmi_name?(name)
+  # @return [Boolean] is the wmi name in the blocked list
+  def blocked_wmi_name?(name)
     [
      "creation_class_name", # this is just the wmi name
      "cs_creation_class_name", # this is just the wmi name
@@ -262,7 +263,7 @@ Ohai.plugin(:Kernel) do
     host = wmi.first_of("Win32_OperatingSystem")
     kernel[:os_info] = Mash.new
     host.wmi_ole_object.properties_.each do |p|
-      next if blacklisted_wmi_name?(p.name.wmi_underscore)
+      next if blocked_wmi_name?(p.name.wmi_underscore)
 
       kernel[:os_info][p.name.wmi_underscore.to_sym] = host[p.name.downcase]
     end
@@ -277,7 +278,7 @@ Ohai.plugin(:Kernel) do
     kernel[:cs_info] = Mash.new
     host = wmi.first_of("Win32_ComputerSystem")
     host.wmi_ole_object.properties_.each do |p|
-      next if blacklisted_wmi_name?(p.name.wmi_underscore)
+      next if blocked_wmi_name?(p.name.wmi_underscore)
 
       kernel[:cs_info][p.name.wmi_underscore.to_sym] = host[p.name.downcase]
     end

data/lib/ohai/plugins/linux/interrupts.rb

@@ -0,0 +1,83 @@
+#
+# Author:: Davide Cavalca <dcavalca@fb.com>
+# Copyright:: Copyright (c) 2020 Facebook
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+Ohai.plugin(:Interrupts) do
+  depends "cpu"
+  provides "interrupts", "interrupts/irq", "interrupts/smp_affinity_by_cpu"
+  optional true
+
+  # Documentation: https://www.kernel.org/doc/Documentation/IRQ-affinity.txt
+  # format: comma-separate list of 32bit bitmask in hex
+  # each bit is a CPU, right to left ordering (i.e. CPU0 is rightmost)
+  def parse_smp_affinity(path, cpus)
+    masks = File.read(path).strip
+    bit_masks = []
+    masks.split(",").each do |mask|
+      bit_masks << mask.rjust(8, "0").to_i(16).to_s(2)
+    end
+    affinity_mask = bit_masks.join
+    affinity_by_cpu = affinity_mask.split("").reverse
+    smp_affinity_by_cpu = Mash.new
+    (0..cpus - 1).each do |cpu|
+      smp_affinity_by_cpu[cpu] = affinity_by_cpu[cpu].to_i == 1
+    end
+    smp_affinity_by_cpu
+  end
+
+  collect_data(:linux) do
+    interrupts Mash.new
+
+    cpus = cpu["total"]
+    interrupts[:smp_affinity_by_cpu] =
+      parse_smp_affinity("/proc/irq/default_smp_affinity", cpus)
+
+    interrupts[:irq] = Mash.new
+    File.open("/proc/interrupts").each do |line|
+      # Documentation: https://www.kernel.org/doc/Documentation/filesystems/proc.txt
+      # format is "{irqn}: {CPUn...} [type] [vector] [device]"
+      irqn, fields = line.split(":", 2)
+      # skip the header
+      next if fields.nil?
+
+      irqn.strip!
+      Ohai::Log.debug("irq: processing #{irqn}")
+
+      interrupts[:irq][irqn] = Mash.new
+      interrupts[:irq][irqn][:events_by_cpu] = Mash.new
+
+      fields = fields.split(nil, cpus + 1)
+      (0..cpus - 1).each do |cpu|
+        interrupts[:irq][irqn][:events_by_cpu][cpu] = fields[cpu].to_i
+      end
+      # Only regular IRQs have extra fields and affinity settings
+      if /^\d+$/.match(irqn)
+        interrupts[:irq][irqn][:type],
+        interrupts[:irq][irqn][:vector],
+        interrupts[:irq][irqn][:device] =
+          fields[cpus].split
+        if File.exist?("/proc/irq/#{irqn}/smp_affinity")
+          interrupts[:irq][irqn][:smp_affinity_by_cpu] =
+            parse_smp_affinity("/proc/irq/#{irqn}/smp_affinity", cpus)
+        end
+      # ERR and MIS do not have any extra fields
+      elsif fields[cpus]
+        interrupts[:irq][irqn][:type] = fields[cpus].strip
+      end
+    end
+  end
+end

data/lib/ohai/plugins/linux/ipc.rb

@@ -0,0 +1,51 @@
+#
+# Author:: Jay Vana <jsvana@fb.com>
+# Author:: Davide Cavalca <dcavalca@fb.com>
+# Copyright:: Copyright (c) 2016-2020 Facebook, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+Ohai.plugin(:IPC) do
+  provides "ipc"
+  optional true
+
+  collect_data(:linux) do
+    ipcs_path = which("ipcs")
+    if ipcs_path
+      # NOTE: currently only supports shared memory
+      cmd = "#{ipcs_path} -m"
+      ipcs = shell_out(cmd)
+
+      ipc Mash.new unless ipc
+      ipc["shm"] = Mash.new unless ipc["shm"]
+
+      ipcs.stdout.split("\n").each do |line|
+        next unless line.start_with?("0x")
+
+        parts = line.split
+        segment = {
+          "key" => parts[0],
+          "owner" => parts[2],
+          "perms" => parts[3],
+          "bytes" => parts[4].to_i,
+          "nattch" => parts[5].to_i,
+          "status" => parts[6] ? parts[6] : "",
+        }
+
+        ipc["shm"][parts[1].to_i] = segment
+      end
+    end
+  end
+end

data/lib/ohai/plugins/linux/network.rb

@@ -207,6 +207,93 @@ Ohai.plugin(:Network) do
     iface
   end
 
+  # determine channel parameters for the interface using ethtool
+  def ethernet_channel_parameters(iface)
+    return iface unless ethtool_binary_path
+
+    iface.each_key do |tmp_int|
+      next unless iface[tmp_int][:encapsulation] == "Ethernet"
+
+      so = shell_out("#{ethtool_binary_path} -l #{tmp_int}")
+      logger.trace("Plugin Network: Parsing ethtool output: #{so.stdout}")
+      type = nil
+      iface[tmp_int]["channel_params"] = {}
+      so.stdout.lines.each do |line|
+        next if line.start_with?("Channel parameters for")
+        next if line.strip.nil?
+
+        if line =~ /Pre-set maximums/
+          type = "max"
+          next
+        end
+        if line =~ /Current hardware settings/
+          type = "current"
+          next
+        end
+        key, val = line.split(/:\s+/)
+        if type && val
+          channel_key = "#{type}_#{key.downcase.tr(" ", "_")}"
+          iface[tmp_int]["channel_params"][channel_key] = val.to_i
+        end
+      end
+    end
+    iface
+  end
+
+  # determine coalesce parameters for the interface using ethtool
+  def ethernet_coalesce_parameters(iface)
+    return iface unless ethtool_binary_path
+
+    iface.each_key do |tmp_int|
+      next unless iface[tmp_int][:encapsulation] == "Ethernet"
+
+      so = shell_out("#{ethtool_binary_path} -c #{tmp_int}")
+      logger.trace("Plugin Network: Parsing ethtool output: #{so.stdout}")
+      iface[tmp_int]["coalesce_params"] = {}
+      so.stdout.lines.each do |line|
+        next if line.start_with?("Coalesce parameters for")
+        next if line.strip.nil?
+
+        if line.start_with?("Adaptive")
+          _, adaptive_rx, _, adaptive_tx = line.split(/:\s+|\s+TX|\n/)
+          iface[tmp_int]["coalesce_params"]["adaptive_rx"] = adaptive_rx
+          iface[tmp_int]["coalesce_params"]["adaptive_tx"] = adaptive_tx
+          next
+        end
+        key, val = line.split(/:\s+/)
+        if val
+          coalesce_key = "#{key.downcase.tr(" ", "_")}"
+          iface[tmp_int]["coalesce_params"][coalesce_key] = val.to_i
+        end
+      end
+    end
+    iface
+  end
+
+  # determine driver info for the interface using ethtool
+  def ethernet_driver_info(iface)
+    return iface unless ethtool_binary_path
+
+    iface.each_key do |tmp_int|
+      next unless iface[tmp_int][:encapsulation] == "Ethernet"
+
+      so = shell_out("#{ethtool_binary_path} -i #{tmp_int}")
+      logger.trace("Plugin Network: Parsing ethtool output: #{so.stdout}")
+      iface[tmp_int]["driver_info"] = {}
+      so.stdout.lines.each do |line|
+        next if line.strip.nil?
+
+        key, val = line.split(/:\s+/)
+        if val.nil?
+          val = ""
+        end
+        driver_key = "#{key.downcase.tr(" ", "_")}"
+        iface[tmp_int]["driver_info"][driver_key] = val.chomp
+      end
+    end
+    iface
+  end
+
   # determine link stats, vlans, queue length, and state for an interface using ip
   def link_statistics(iface, net_counters)
     so = shell_out("ip -d -s link")
@@ -669,6 +756,9 @@ Ohai.plugin(:Network) do
 
     iface = ethernet_layer_one(iface)
     iface = ethernet_ring_parameters(iface)
+    iface = ethernet_channel_parameters(iface)
+    iface = ethernet_coalesce_parameters(iface)
+    iface = ethernet_driver_info(iface)
     counters[:network][:interfaces] = net_counters
     network["interfaces"] = iface
   end