1 # -*- encoding: binary -*-
8 include Socket::Constants
10 # prevents IO objects in here from being GC-ed
13 # internal interface, only used by Rainbows!/Zbatery
15 # The semantics for TCP_DEFER_ACCEPT changed in Linux 2.6.32+
16 # with commit d1b99ba41d6c5aa1ed2fc634323449dd656899e9
17 # This change shouldn't affect Unicorn users behind nginx (a
18 # value of 1 remains an optimization), but Rainbows! users may
19 # want to use a higher value on Linux 2.6.32+ to protect against
20 # denial-of-service attacks
21 :tcp_defer_accept => 1,
23 # FreeBSD, we need to override this to 'dataready' if we
24 # eventually get HTTPS support
25 :accept_filter => 'httpready',
27 # same default value as Mongrel
30 # favor latency over bandwidth savings
36 # configure platform-specific options (only tested on Linux 2.6 so far)
39 # from /usr/include/linux/tcp.h
40 TCP_DEFER_ACCEPT = 9 unless defined?(TCP_DEFER_ACCEPT)
42 # do not send out partial frames (Linux)
43 TCP_CORK = 3 unless defined?(TCP_CORK)
45 # do not send out partial frames (FreeBSD)
46 TCP_NOPUSH = 4 unless defined?(TCP_NOPUSH)
49 [ af_name, nil ].pack('a16a240')
50 end if defined?(SO_ACCEPTFILTER)
53 def set_tcp_sockopt(sock, opt)
54 # just in case, even LANs can break sometimes. Linux sysadmins
55 # can lower net.ipv4.tcp_keepalive_* sysctl knobs to very low values.
56 sock.setsockopt(SOL_SOCKET, SO_KEEPALIVE, 1) if defined?(SO_KEEPALIVE)
58 if defined?(TCP_NODELAY)
59 val = opt[:tcp_nodelay]
60 val = DEFAULTS[:tcp_nodelay] if nil == val
61 sock.setsockopt(IPPROTO_TCP, TCP_NODELAY, val ? 1 : 0)
64 val = opt[:tcp_nopush]
65 val = DEFAULTS[:tcp_nopush] if nil == val
67 if defined?(TCP_CORK) # Linux
68 sock.setsockopt(IPPROTO_TCP, TCP_CORK, val)
69 elsif defined?(TCP_NOPUSH) # TCP_NOPUSH is untested (FreeBSD)
70 sock.setsockopt(IPPROTO_TCP, TCP_NOPUSH, val)
73 # No good reason to ever have deferred accepts off
74 # (except maybe benchmarking)
75 if defined?(TCP_DEFER_ACCEPT)
76 # this differs from nginx, since nginx doesn't allow us to
77 # configure the the timeout...
78 seconds = opt[:tcp_defer_accept]
79 seconds = DEFAULTS[:tcp_defer_accept] if [true,nil].include?(seconds)
80 seconds = 0 unless seconds # nil/false means disable this
81 sock.setsockopt(SOL_TCP, TCP_DEFER_ACCEPT, seconds)
82 elsif respond_to?(:accf_arg)
83 name = opt[:accept_filter]
84 name = DEFAULTS[:accept_filter] if nil == name
86 sock.setsockopt(SOL_SOCKET, SO_ACCEPTFILTER, accf_arg(name))
88 logger.error("#{sock_name(sock)} " \
89 "failed to set accept_filter=#{name} (#{e.inspect})")
94 def set_server_sockopt(sock, opt)
95 opt = DEFAULTS.merge(opt || {})
97 TCPSocket === sock and set_tcp_sockopt(sock, opt)
99 if opt[:rcvbuf] || opt[:sndbuf]
100 log_buffer_sizes(sock, "before: ")
101 sock.setsockopt(SOL_SOCKET, SO_RCVBUF, opt[:rcvbuf]) if opt[:rcvbuf]
102 sock.setsockopt(SOL_SOCKET, SO_SNDBUF, opt[:sndbuf]) if opt[:sndbuf]
103 log_buffer_sizes(sock, " after: ")
105 sock.listen(opt[:backlog])
107 Unicorn.log_error(logger, "#{sock_name(sock)} #{opt.inspect}", e)
110 def log_buffer_sizes(sock, pfx = '')
111 rcvbuf = sock.getsockopt(SOL_SOCKET, SO_RCVBUF).unpack('i')
112 sndbuf = sock.getsockopt(SOL_SOCKET, SO_SNDBUF).unpack('i')
113 logger.info "#{pfx}#{sock_name(sock)} rcvbuf=#{rcvbuf} sndbuf=#{sndbuf}"
116 # creates a new server, socket. address may be a HOST:PORT or
117 # an absolute path to a UNIX socket. address can even be a Socket
118 # object in which case it is immediately returned
119 def bind_listen(address = '0.0.0.0:8080', opt = {})
120 return address unless String === address
122 sock = if address[0] == ?/
123 if File.exist?(address)
124 if File.socket?(address)
126 UNIXSocket.new(address).close
127 # fall through, try to bind(2) and fail with EADDRINUSE
128 # (or succeed from a small race condition we can't sanely avoid).
129 rescue Errno::ECONNREFUSED
130 logger.info "unlinking existing socket=#{address}"
135 "socket=#{address} specified but it is not a socket!"
138 old_umask = File.umask(opt[:umask] || 0)
140 Kgio::UNIXServer.new(address)
142 File.umask(old_umask)
144 elsif /\A\[([a-fA-F0-9:]+)\]:(\d+)\z/ =~ address
145 new_ipv6_server($1, $2.to_i, opt)
146 elsif /\A(\d+\.\d+\.\d+\.\d+):(\d+)\z/ =~ address
147 Kgio::TCPServer.new($1, $2.to_i)
149 raise ArgumentError, "Don't know how to bind: #{address}"
151 set_server_sockopt(sock, opt)
155 def new_ipv6_server(addr, port, opt)
156 opt.key?(:ipv6only) or return Kgio::TCPServer.new(addr, port)
157 defined?(IPV6_V6ONLY) or
158 abort "Socket::IPV6_V6ONLY not defined, upgrade Ruby and/or your OS"
159 sock = Socket.new(AF_INET6, SOCK_STREAM, 0)
160 sock.setsockopt(IPPROTO_IPV6, IPV6_V6ONLY, opt[:ipv6only] ? 1 : 0)
161 sock.setsockopt(SOL_SOCKET, SO_REUSEADDR, 1)
162 sock.bind(Socket.pack_sockaddr_in(port, addr))
164 Kgio::TCPServer.for_fd(sock.fileno)
167 # returns rfc2732-style (e.g. "[::1]:666") addresses for IPv6
169 port, addr = Socket.unpack_sockaddr_in(sock.getsockname)
170 /:/ =~ addr ? "[#{addr}]:#{port}" : "#{addr}:#{port}"
172 module_function :tcp_name
174 # Returns the configuration name of a socket as a string. sock may
175 # be a string value, in which case it is returned as-is
176 # Warning: TCP sockets may not always return the name given to it.
179 when String then sock
181 Socket.unpack_sockaddr_un(sock.getsockname)
188 Socket.unpack_sockaddr_un(sock.getsockname)
191 raise ArgumentError, "Unhandled class #{sock.class}: #{sock.inspect}"
195 module_function :sock_name
197 # casts a given Socket to be a TCPServer or UNIXServer
198 def server_cast(sock)
200 Socket.unpack_sockaddr_in(sock.getsockname)
201 Kgio::TCPServer.for_fd(sock.fileno)
203 Kgio::UNIXServer.for_fd(sock.fileno)
207 end # module SocketHelper