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
29 # configure platform-specific options (only tested on Linux 2.6 so far)
32 # from /usr/include/linux/tcp.h
33 TCP_DEFER_ACCEPT = 9 unless defined?(TCP_DEFER_ACCEPT)
35 # do not send out partial frames (Linux)
36 TCP_CORK = 3 unless defined?(TCP_CORK)
38 # do not send out partial frames (FreeBSD)
39 TCP_NOPUSH = 4 unless defined?(TCP_NOPUSH)
42 [ af_name, nil ].pack('a16a240')
43 end if defined?(SO_ACCEPTFILTER)
46 def set_tcp_sockopt(sock, opt)
47 # highly portable, but off by default because we don't do keepalive
48 if defined?(TCP_NODELAY) && ! (val = opt[:tcp_nodelay]).nil?
49 sock.setsockopt(IPPROTO_TCP, TCP_NODELAY, val ? 1 : 0)
52 unless (val = opt[:tcp_nopush]).nil?
54 if defined?(TCP_CORK) # Linux
55 sock.setsockopt(IPPROTO_TCP, TCP_CORK, val)
56 elsif defined?(TCP_NOPUSH) # TCP_NOPUSH is untested (FreeBSD)
57 sock.setsockopt(IPPROTO_TCP, TCP_NOPUSH, val)
61 # No good reason to ever have deferred accepts off
62 # (except maybe benchmarking)
63 if defined?(TCP_DEFER_ACCEPT)
64 # this differs from nginx, since nginx doesn't allow us to
65 # configure the the timeout...
66 seconds = opt[:tcp_defer_accept]
67 seconds = DEFAULTS[:tcp_defer_accept] if seconds == true
68 seconds = 0 unless seconds # nil/false means disable this
69 sock.setsockopt(SOL_TCP, TCP_DEFER_ACCEPT, seconds)
70 elsif respond_to?(:accf_arg)
71 if name = opt[:accept_filter]
73 sock.setsockopt(SOL_SOCKET, SO_ACCEPTFILTER, accf_arg(name))
75 logger.error("#{sock_name(sock)} " \
76 "failed to set accept_filter=#{name} (#{e.inspect})")
82 def set_server_sockopt(sock, opt)
83 opt = DEFAULTS.merge(opt || {})
85 TCPSocket === sock and set_tcp_sockopt(sock, opt)
87 if opt[:rcvbuf] || opt[:sndbuf]
88 log_buffer_sizes(sock, "before: ")
89 sock.setsockopt(SOL_SOCKET, SO_RCVBUF, opt[:rcvbuf]) if opt[:rcvbuf]
90 sock.setsockopt(SOL_SOCKET, SO_SNDBUF, opt[:sndbuf]) if opt[:sndbuf]
91 log_buffer_sizes(sock, " after: ")
93 sock.listen(opt[:backlog])
95 logger.error "error setting socket options: #{e.inspect}"
96 logger.error e.backtrace.join("\n")
99 def log_buffer_sizes(sock, pfx = '')
100 rcvbuf = sock.getsockopt(SOL_SOCKET, SO_RCVBUF).unpack('i')
101 sndbuf = sock.getsockopt(SOL_SOCKET, SO_SNDBUF).unpack('i')
102 logger.info "#{pfx}#{sock_name(sock)} rcvbuf=#{rcvbuf} sndbuf=#{sndbuf}"
105 # creates a new server, socket. address may be a HOST:PORT or
106 # an absolute path to a UNIX socket. address can even be a Socket
107 # object in which case it is immediately returned
108 def bind_listen(address = '0.0.0.0:8080', opt = {})
109 return address unless String === address
111 sock = if address[0] == ?/
112 if File.exist?(address)
113 if File.socket?(address)
115 UNIXSocket.new(address).close
116 # fall through, try to bind(2) and fail with EADDRINUSE
117 # (or succeed from a small race condition we can't sanely avoid).
118 rescue Errno::ECONNREFUSED
119 logger.info "unlinking existing socket=#{address}"
124 "socket=#{address} specified but it is not a socket!"
127 old_umask = File.umask(opt[:umask] || 0)
129 Kgio::UNIXServer.new(address)
131 File.umask(old_umask)
133 elsif address =~ /^(\d+\.\d+\.\d+\.\d+):(\d+)$/
134 Kgio::TCPServer.new($1, $2.to_i)
136 raise ArgumentError, "Don't know how to bind: #{address}"
138 set_server_sockopt(sock, opt)
142 # Returns the configuration name of a socket as a string. sock may
143 # be a string value, in which case it is returned as-is
144 # Warning: TCP sockets may not always return the name given to it.
147 when String then sock
149 Socket.unpack_sockaddr_un(sock.getsockname)
151 Socket.unpack_sockaddr_in(sock.getsockname).reverse!.join(':')
154 Socket.unpack_sockaddr_in(sock.getsockname).reverse!.join(':')
156 Socket.unpack_sockaddr_un(sock.getsockname)
159 raise ArgumentError, "Unhandled class #{sock.class}: #{sock.inspect}"
163 module_function :sock_name
165 # casts a given Socket to be a TCPServer or UNIXServer
166 def server_cast(sock)
168 Socket.unpack_sockaddr_in(sock.getsockname)
169 Kgio::TCPServer.for_fd(sock.fileno)
171 Kgio::UNIXServer.for_fd(sock.fileno)
175 end # module SocketHelper