lib/raindrops/linux.rb

   1 # -*- encoding: binary -*-
   2
   3 # For reporting TCP ListenStats, users of older \Linux kernels need to ensure
   4 # that the the "inet_diag" and "tcp_diag" kernel modules are loaded as they do
   5 # not autoload correctly.  The inet_diag facilities of \Raindrops is useful
   6 # for periodic snapshot reporting of listen queue sizes.
   7 #
   8 # Instead of snapshotting, Raindrops::Aggregate::LastDataRecv may be used
   9 # to aggregate statistics from +all+ accepted sockets as they arrive
  10 # based on the +last_data_recv+ field in Raindrops::TCP_Info
  11 module Raindrops::Linux
  12
  13   # The standard proc path for active UNIX domain sockets, feel free to call
  14   # String#replace on this if your /proc is mounted in a non-standard location
  15   # for whatever reason
  16   PROC_NET_UNIX_ARGS = %w(/proc/net/unix)
  17   defined?(::Encoding) and PROC_NET_UNIX_ARGS.push({ :encoding => "binary" })
  18
  19   # Get ListenStats from an array of +paths+
  20   #
  21   # Socket state mapping from integer => symbol, based on socket_state
  22   # enum from include/linux/net.h in the \Linux kernel:
  23   #     typedef enum {
  24   #             SS_FREE = 0,              /* not allocated                */
  25   #             SS_UNCONNECTED,           /* unconnected to any socket    */
  26   #             SS_CONNECTING,            /* in process of connecting     */
  27   #             SS_CONNECTED,             /* connected to socket          */
  28   #             SS_DISCONNECTING          /* in process of disconnecting  */
  29   #     } socket_state;
  30   # * SS_CONNECTING maps to ListenStats#active
  31   # * SS_CONNECTED maps to ListenStats#queued
  32   #
  33   # This method may be significantly slower than its tcp_listener_stats
  34   # counterpart due to the latter being able to use inet_diag via netlink.
  35   # This parses /proc/net/unix as there is no other (known) way
  36   # to expose Unix domain socket statistics over netlink.
  37   def unix_listener_stats(paths = nil)
  38     rv = Hash.new { |h,k| h[k.freeze] = Raindrops::ListenStats.new(0, 0) }
  39     if nil == paths
  40       paths = [ '[^\n]+' ]
  41     else
  42       paths = paths.map do |path|
  43         path = path.dup
  44         path.force_encoding(Encoding::BINARY) if defined?(Encoding)
  45         rv[path]
  46         Regexp.escape(path)
  47       end
  48     end
  49     paths = /^\w+: \d+ \d+ 00000000 \d+ (\d+)\s+\d+ (#{paths.join('|')})$/n
  50
  51     # no point in pread since we can't stat for size on this file
  52     File.read(*PROC_NET_UNIX_ARGS).scan(paths) do |s|
  53       path = s[-1]
  54       case s[0].to_i
  55       when 2 then rv[path].queued += 1
  56       when 3 then rv[path].active += 1
  57       end
  58     end
  59
  60     rv
  61   end
  62   module_function :unix_listener_stats
  63
  64 end # Raindrops::Linux