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 # Linux got SO_REUSEPORT in 3.9, BSDs have had it for ages
46 unless defined?(SO_REUSEPORT)
47 if RUBY_PLATFORM =~ /(?:alpha|mips|parisc|sparc)/
48 SO_REUSEPORT = 0x0200 # untested
50 SO_REUSEPORT = 15 # only tested on x86_64 and i686
54 # do not send out partial frames (FreeBSD)
55 TCP_NOPUSH = 4 unless defined?(TCP_NOPUSH)
58 [ af_name, nil ].pack('a16a240')
59 end if defined?(SO_ACCEPTFILTER)
62 def set_tcp_sockopt(sock, opt)
63 # just in case, even LANs can break sometimes. Linux sysadmins
64 # can lower net.ipv4.tcp_keepalive_* sysctl knobs to very low values.
65 sock.setsockopt(SOL_SOCKET, SO_KEEPALIVE, 1) if defined?(SO_KEEPALIVE)
67 if defined?(TCP_NODELAY)
68 val = opt[:tcp_nodelay]
69 val = DEFAULTS[:tcp_nodelay] if nil == val
70 sock.setsockopt(IPPROTO_TCP, TCP_NODELAY, val ? 1 : 0)
73 val = opt[:tcp_nopush]
75 if defined?(TCP_CORK) # Linux
76 sock.setsockopt(IPPROTO_TCP, TCP_CORK, val)
77 elsif defined?(TCP_NOPUSH) # TCP_NOPUSH is lightly tested (FreeBSD)
78 sock.setsockopt(IPPROTO_TCP, TCP_NOPUSH, val)
82 # No good reason to ever have deferred accepts off
83 # (except maybe benchmarking)
84 if defined?(TCP_DEFER_ACCEPT)
85 # this differs from nginx, since nginx doesn't allow us to
86 # configure the the timeout...
87 seconds = opt[:tcp_defer_accept]
88 seconds = DEFAULTS[:tcp_defer_accept] if [true,nil].include?(seconds)
89 seconds = 0 unless seconds # nil/false means disable this
90 sock.setsockopt(SOL_TCP, TCP_DEFER_ACCEPT, seconds)
91 elsif respond_to?(:accf_arg)
92 name = opt[:accept_filter]
93 name = DEFAULTS[:accept_filter] if nil == name
95 sock.setsockopt(SOL_SOCKET, SO_ACCEPTFILTER, accf_arg(name))
97 logger.error("#{sock_name(sock)} " \
98 "failed to set accept_filter=#{name} (#{e.inspect})")
103 def set_server_sockopt(sock, opt)
104 opt = DEFAULTS.merge(opt || {})
106 TCPSocket === sock and set_tcp_sockopt(sock, opt)
108 if opt[:rcvbuf] || opt[:sndbuf]
109 log_buffer_sizes(sock, "before: ")
110 sock.setsockopt(SOL_SOCKET, SO_RCVBUF, opt[:rcvbuf]) if opt[:rcvbuf]
111 sock.setsockopt(SOL_SOCKET, SO_SNDBUF, opt[:sndbuf]) if opt[:sndbuf]
112 log_buffer_sizes(sock, " after: ")
114 sock.listen(opt[:backlog])
116 Unicorn.log_error(logger, "#{sock_name(sock)} #{opt.inspect}", e)
119 def log_buffer_sizes(sock, pfx = '')
120 rcvbuf = sock.getsockopt(SOL_SOCKET, SO_RCVBUF).unpack('i')
121 sndbuf = sock.getsockopt(SOL_SOCKET, SO_SNDBUF).unpack('i')
122 logger.info "#{pfx}#{sock_name(sock)} rcvbuf=#{rcvbuf} sndbuf=#{sndbuf}"
125 # creates a new server, socket. address may be a HOST:PORT or
126 # an absolute path to a UNIX socket. address can even be a Socket
127 # object in which case it is immediately returned
128 def bind_listen(address = '0.0.0.0:8080', opt = {})
129 return address unless String === address
131 sock = if address[0] == ?/
132 if File.exist?(address)
133 if File.socket?(address)
135 UNIXSocket.new(address).close
136 # fall through, try to bind(2) and fail with EADDRINUSE
137 # (or succeed from a small race condition we can't sanely avoid).
138 rescue Errno::ECONNREFUSED
139 logger.info "unlinking existing socket=#{address}"
144 "socket=#{address} specified but it is not a socket!"
147 old_umask = File.umask(opt[:umask] || 0)
149 Kgio::UNIXServer.new(address)
151 File.umask(old_umask)
153 elsif /\A\[([a-fA-F0-9:]+)\]:(\d+)\z/ =~ address
154 new_tcp_server($1, $2.to_i, opt.merge(:ipv6=>true))
155 elsif /\A(\d+\.\d+\.\d+\.\d+):(\d+)\z/ =~ address
156 new_tcp_server($1, $2.to_i, opt)
158 raise ArgumentError, "Don't know how to bind: #{address}"
160 set_server_sockopt(sock, opt)
164 def new_tcp_server(addr, port, opt)
165 # n.b. we set FD_CLOEXEC in the workers
166 sock = Socket.new(opt[:ipv6] ? AF_INET6 : AF_INET, SOCK_STREAM, 0)
167 if opt.key?(:ipv6only)
168 defined?(IPV6_V6ONLY) or
169 abort "Socket::IPV6_V6ONLY not defined, upgrade Ruby and/or your OS"
170 sock.setsockopt(IPPROTO_IPV6, IPV6_V6ONLY, opt[:ipv6only] ? 1 : 0)
172 sock.setsockopt(SOL_SOCKET, SO_REUSEADDR, 1)
173 if defined?(SO_REUSEPORT) && opt[:reuseport]
174 sock.setsockopt(SOL_SOCKET, SO_REUSEPORT, 1)
176 sock.bind(Socket.pack_sockaddr_in(port, addr))
178 Kgio::TCPServer.for_fd(sock.fileno)
181 # returns rfc2732-style (e.g. "[::1]:666") addresses for IPv6
183 port, addr = Socket.unpack_sockaddr_in(sock.getsockname)
184 /:/ =~ addr ? "[#{addr}]:#{port}" : "#{addr}:#{port}"
186 module_function :tcp_name
188 # Returns the configuration name of a socket as a string. sock may
189 # be a string value, in which case it is returned as-is
190 # Warning: TCP sockets may not always return the name given to it.
193 when String then sock
195 Socket.unpack_sockaddr_un(sock.getsockname)
202 Socket.unpack_sockaddr_un(sock.getsockname)
205 raise ArgumentError, "Unhandled class #{sock.class}: #{sock.inspect}"
209 module_function :sock_name
211 # casts a given Socket to be a TCPServer or UNIXServer
212 def server_cast(sock)
214 Socket.unpack_sockaddr_in(sock.getsockname)
215 Kgio::TCPServer.for_fd(sock.fileno)
217 Kgio::UNIXServer.for_fd(sock.fileno)
221 end # module SocketHelper