1 # -*- encoding: binary -*-
7 include Socket::Constants
10 # internal interface, only used by Rainbows!/Zbatery
12 # The semantics for TCP_DEFER_ACCEPT changed in Linux 2.6.32+
13 # with commit d1b99ba41d6c5aa1ed2fc634323449dd656899e9
14 # This change shouldn't affect Unicorn users behind nginx (a
15 # value of 1 remains an optimization), but Rainbows! users may
16 # want to use a higher value on Linux 2.6.32+ to protect against
17 # denial-of-service attacks
18 :tcp_defer_accept => 1,
20 # FreeBSD, we need to override this to 'dataready' when we
21 # eventually get HTTPS support
22 :accept_filter => 'httpready',
24 # same default value as Mongrel
27 # since we don't do keepalive, we'll always flush-on-close and
28 # this saves packets for everyone.
33 # configure platform-specific options (only tested on Linux 2.6 so far)
36 # from /usr/include/linux/tcp.h
37 TCP_DEFER_ACCEPT = 9 unless defined?(TCP_DEFER_ACCEPT)
39 # do not send out partial frames (Linux)
40 TCP_CORK = 3 unless defined?(TCP_CORK)
42 # do not send out partial frames (FreeBSD)
43 TCP_NOPUSH = 4 unless defined?(TCP_NOPUSH)
46 [ af_name, nil ].pack('a16a240')
47 end if defined?(SO_ACCEPTFILTER)
50 def set_tcp_sockopt(sock, opt)
51 # highly portable, but off by default because we don't do keepalive
52 if defined?(TCP_NODELAY)
53 val = opt[:tcp_nodelay]
54 val = DEFAULTS[:tcp_nodelay] if nil == val
55 sock.setsockopt(IPPROTO_TCP, TCP_NODELAY, val ? 1 : 0)
58 val = opt[:tcp_nopush]
59 val = DEFAULTS[:tcp_nopush] if nil == val
61 if defined?(TCP_CORK) # Linux
62 sock.setsockopt(IPPROTO_TCP, TCP_CORK, val)
63 elsif defined?(TCP_NOPUSH) # TCP_NOPUSH is untested (FreeBSD)
64 sock.setsockopt(IPPROTO_TCP, TCP_NOPUSH, val)
67 # No good reason to ever have deferred accepts off
68 # (except maybe benchmarking)
69 if defined?(TCP_DEFER_ACCEPT)
70 # this differs from nginx, since nginx doesn't allow us to
71 # configure the the timeout...
72 seconds = opt[:tcp_defer_accept]
73 seconds = DEFAULTS[:tcp_defer_accept] if [true,nil].include?(seconds)
74 seconds = 0 unless seconds # nil/false means disable this
75 sock.setsockopt(SOL_TCP, TCP_DEFER_ACCEPT, seconds)
76 elsif respond_to?(:accf_arg)
77 name = opt[:accept_filter]
78 name = DEFAULTS[:accept_filter] if nil == name
80 sock.setsockopt(SOL_SOCKET, SO_ACCEPTFILTER, accf_arg(name))
82 logger.error("#{sock_name(sock)} " \
83 "failed to set accept_filter=#{name} (#{e.inspect})")
88 def set_server_sockopt(sock, opt)
89 opt = DEFAULTS.merge(opt || {})
91 TCPSocket === sock and set_tcp_sockopt(sock, opt)
93 if opt[:rcvbuf] || opt[:sndbuf]
94 log_buffer_sizes(sock, "before: ")
95 sock.setsockopt(SOL_SOCKET, SO_RCVBUF, opt[:rcvbuf]) if opt[:rcvbuf]
96 sock.setsockopt(SOL_SOCKET, SO_SNDBUF, opt[:sndbuf]) if opt[:sndbuf]
97 log_buffer_sizes(sock, " after: ")
99 sock.listen(opt[:backlog])
101 logger.error "error setting socket options: #{e.inspect}"
102 logger.error e.backtrace.join("\n")
105 def log_buffer_sizes(sock, pfx = '')
106 rcvbuf = sock.getsockopt(SOL_SOCKET, SO_RCVBUF).unpack('i')
107 sndbuf = sock.getsockopt(SOL_SOCKET, SO_SNDBUF).unpack('i')
108 logger.info "#{pfx}#{sock_name(sock)} rcvbuf=#{rcvbuf} sndbuf=#{sndbuf}"
111 # creates a new server, socket. address may be a HOST:PORT or
112 # an absolute path to a UNIX socket. address can even be a Socket
113 # object in which case it is immediately returned
114 def bind_listen(address = '0.0.0.0:8080', opt = {})
115 return address unless String === address
117 sock = if address[0] == ?/
118 if File.exist?(address)
119 if File.socket?(address)
121 UNIXSocket.new(address).close
122 # fall through, try to bind(2) and fail with EADDRINUSE
123 # (or succeed from a small race condition we can't sanely avoid).
124 rescue Errno::ECONNREFUSED
125 logger.info "unlinking existing socket=#{address}"
130 "socket=#{address} specified but it is not a socket!"
133 old_umask = File.umask(opt[:umask] || 0)
135 Kgio::UNIXServer.new(address)
137 File.umask(old_umask)
139 elsif address =~ /^(\d+\.\d+\.\d+\.\d+):(\d+)$/
140 Kgio::TCPServer.new($1, $2.to_i)
142 raise ArgumentError, "Don't know how to bind: #{address}"
144 set_server_sockopt(sock, opt)
148 # Returns the configuration name of a socket as a string. sock may
149 # be a string value, in which case it is returned as-is
150 # Warning: TCP sockets may not always return the name given to it.
153 when String then sock
155 Socket.unpack_sockaddr_un(sock.getsockname)
157 Socket.unpack_sockaddr_in(sock.getsockname).reverse!.join(':')
160 Socket.unpack_sockaddr_in(sock.getsockname).reverse!.join(':')
162 Socket.unpack_sockaddr_un(sock.getsockname)
165 raise ArgumentError, "Unhandled class #{sock.class}: #{sock.inspect}"
169 module_function :sock_name
171 # casts a given Socket to be a TCPServer or UNIXServer
172 def server_cast(sock)
174 Socket.unpack_sockaddr_in(sock.getsockname)
175 Kgio::TCPServer.for_fd(sock.fileno)
177 Kgio::UNIXServer.for_fd(sock.fileno)
181 end # module SocketHelper