lib/unicorn/socket_helper.rb

   1 require 'socket'
   2
   3 module Unicorn
   4   module SocketHelper
   5     include Socket::Constants
   6
   7     # configure platform-specific options (only tested on Linux 2.6 so far)
   8     case RUBY_PLATFORM
   9     when /linux/
  10       # from /usr/include/linux/tcp.h
  11       TCP_DEFER_ACCEPT = 9 unless defined?(TCP_DEFER_ACCEPT)
  12       TCP_CORK = 3 unless defined?(TCP_CORK)
  13     when /freebsd(([1-4]\..{1,2})|5\.[0-4])/
  14       # Do nothing for httpready, just closing a bug when freebsd <= 5.4
  15       TCP_NOPUSH = 4 unless defined?(TCP_NOPUSH)
  16     when /freebsd/
  17       TCP_NOPUSH = 4 unless defined?(TCP_NOPUSH)
  18       # Use the HTTP accept filter if available.
  19       # The struct made by pack() is defined in /usr/include/sys/socket.h
  20       # as accept_filter_arg
  21       # We won't be seupportin the "dataready" filter unlike nginx
  22       # since we only support HTTP and no other protocols
  23       unless `/sbin/sysctl -nq net.inet.accf.http`.empty?
  24         HTTPREADY = ['httpready', nil].pack('a16a240').freeze
  25       end
  26     end
  27
  28     def set_tcp_sockopt(sock, opt)
  29
  30       # highly portable, but off by default because we don't do keepalive
  31       if defined?(TCP_NODELAY) && ! (val = opt[:tcp_nodelay]).nil?
  32         sock.setsockopt(IPPROTO_TCP, TCP_NODELAY, val ? 1 : 0) rescue nil
  33       end
  34
  35       unless (val = opt[:tcp_nopush]).nil?
  36         val = val ? 1 : 0
  37         if defined?(TCP_CORK) # Linux
  38           sock.setsockopt(IPPROTO_TCP, TCP_CORK, val) rescue nil
  39         elsif defined?(TCP_NOPUSH) # TCP_NOPUSH is untested (FreeBSD)
  40           sock.setsockopt(IPPROTO_TCP, TCP_NOPUSH, val) rescue nil
  41         end
  42       end
  43
  44       # No good reason to ever have deferred accepts off
  45       if defined?(TCP_DEFER_ACCEPT)
  46         sock.setsockopt(SOL_TCP, TCP_DEFER_ACCEPT, 1) rescue nil
  47       elsif defined?(SO_ACCEPTFILTER) && defined?(HTTPREADY)
  48         sock.setsockopt(SOL_SOCKET, SO_ACCEPTFILTER, HTTPREADY) rescue nil
  49       end
  50     end
  51
  52     def set_server_sockopt(sock, opt)
  53       opt ||= {}
  54
  55       TCPSocket === sock and set_tcp_sockopt(sock, opt)
  56
  57       if opt[:rcvbuf] || opt[:sndbuf]
  58         log_buffer_sizes(sock, "before: ")
  59         sock.setsockopt(SOL_SOCKET, SO_RCVBUF, opt[:rcvbuf]) if opt[:rcvbuf]
  60         sock.setsockopt(SOL_SOCKET, SO_SNDBUF, opt[:sndbuf]) if opt[:sndbuf]
  61         log_buffer_sizes(sock, " after: ")
  62       end
  63       sock.listen(opt[:backlog] || 1024)
  64     end
  65
  66     def log_buffer_sizes(sock, pfx = '')
  67       respond_to?(:logger) or return
  68       rcvbuf = sock.getsockopt(SOL_SOCKET, SO_RCVBUF).unpack('i')
  69       sndbuf = sock.getsockopt(SOL_SOCKET, SO_SNDBUF).unpack('i')
  70       logger.info "#{pfx}#{sock_name(sock)} rcvbuf=#{rcvbuf} sndbuf=#{sndbuf}"
  71     end
  72
  73     # creates a new server, socket. address may be a HOST:PORT or
  74     # an absolute path to a UNIX socket.  address can even be a Socket
  75     # object in which case it is immediately returned
  76     def bind_listen(address = '0.0.0.0:8080', opt = {})
  77       return address unless String === address
  78
  79       sock = if address[0..0] == "/"
  80         if File.exist?(address)
  81           if File.socket?(address)
  82             if self.respond_to?(:logger)
  83               logger.info "unlinking existing socket=#{address}"
  84             end
  85             File.unlink(address)
  86           else
  87             raise ArgumentError,
  88                   "socket=#{address} specified but it is not a socket!"
  89           end
  90         end
  91         old_umask = File.umask(0)
  92         begin
  93           UNIXServer.new(address)
  94         ensure
  95           File.umask(old_umask)
  96         end
  97       elsif address =~ /^(\d+\.\d+\.\d+\.\d+):(\d+)$/
  98         TCPServer.new($1, $2.to_i)
  99       else
 100         raise ArgumentError, "Don't know how to bind: #{address}"
 101       end
 102       set_server_sockopt(sock, opt)
 103       sock
 104     end
 105
 106     # Returns the configuration name of a socket as a string.  sock may
 107     # be a string value, in which case it is returned as-is
 108     # Warning: TCP sockets may not always return the name given to it.
 109     def sock_name(sock)
 110       case sock
 111       when String then sock
 112       when UNIXServer
 113         Socket.unpack_sockaddr_un(sock.getsockname)
 114       when TCPServer
 115         Socket.unpack_sockaddr_in(sock.getsockname).reverse!.join(':')
 116       when Socket
 117         begin
 118           Socket.unpack_sockaddr_in(sock.getsockname).reverse!.join(':')
 119         rescue ArgumentError
 120           Socket.unpack_sockaddr_un(sock.getsockname)
 121         end
 122       else
 123         raise ArgumentError, "Unhandled class #{sock.class}: #{sock.inspect}"
 124       end
 125     end
 126
 127     # casts a given Socket to be a TCPServer or UNIXServer
 128     def server_cast(sock)
 129       begin
 130         Socket.unpack_sockaddr_in(sock.getsockname)
 131         TCPServer.for_fd(sock.fileno)
 132       rescue ArgumentError
 133         UNIXServer.for_fd(sock.fileno)
 134       end
 135     end
 136
 137   end # module SocketHelper
 138 end # module Unicorn