1 # -*- encoding: binary -*-
7 # TODO: remove redundant names
8 Unicorn.const_set(:HttpRequest, Unicorn::HttpParser)
9 class Unicorn::HttpParser
11 # default parameters we merge into the request env for Rack handlers
13 "rack.errors" => $stderr,
14 "rack.multiprocess" => true,
15 "rack.multithread" => false,
16 "rack.run_once" => false,
17 "rack.version" => [1, 2],
18 "rack.hijack?" => true,
21 # this is not in the Rack spec, but some apps may rely on it
22 "SERVER_SOFTWARE" => "Unicorn #{Unicorn::Const::UNICORN_VERSION}"
25 NULL_IO = StringIO.new("")
28 HTTP_RESPONSE_START = [ 'HTTP'.freeze, '/1.1 '.freeze ]
29 EMPTY_ARRAY = [].freeze
30 @@input_class = Unicorn::TeeInput
31 @@check_client_connection = false
32 @@tcpi_inspect_ok = nil
38 def self.input_class=(klass)
42 def self.check_client_connection
43 @@check_client_connection
46 def self.check_client_connection=(bool)
47 @@check_client_connection = bool
52 # Does the majority of the IO processing. It has been written in
53 # Ruby using about 8 different IO processing strategies.
55 # It is currently carefully constructed to make sure that it gets
56 # the best possible performance for the common case: GET requests
57 # that are fully complete after a single read(2)
59 # Anyone who thinks they can make it faster is more than welcome to
62 # returns an environment hash suitable for Rack if successful
63 # This does minimal exception trapping and it is up to the caller
64 # to handle any socket errors (e.g. user aborted upload).
69 # From http://www.ietf.org/rfc/rfc3875:
70 # "Script authors should be aware that the REMOTE_ADDR and
71 # REMOTE_HOST meta-variables (see sections 4.1.8 and 4.1.9)
72 # may not identify the ultimate source of the request. They
73 # identify the client for the immediate request to the server;
74 # that client may be a proxy, gateway, or other intermediary
75 # acting on behalf of the actual source client."
76 e['REMOTE_ADDR'] = socket.kgio_addr
78 # short circuit the common case with small GET requests first
79 socket.kgio_read!(16384, buf)
81 # Parser is not done, queue up more data to read and continue parsing
82 # an Exception thrown from the parser will throw us out of the loop
83 false until add_parse(socket.kgio_read!(16384))
86 check_client_connection(socket) if @@check_client_connection
88 e['rack.input'] = 0 == content_length ?
89 NULL_IO : @@input_class.new(socket, self)
91 # for Rack hijacking in Rack 1.5 and later
92 e['unicorn.socket'] = socket
93 e['rack.hijack'] = self
98 # for rack.hijack, we respond to this method so no extra allocation
101 env['rack.hijack_io'] = env['unicorn.socket']
105 env.include?('rack.hijack_io'.freeze)
108 if Raindrops.const_defined?(:TCP_Info)
109 TCPI = Raindrops::TCP_Info.allocate
111 def check_client_connection(socket) # :nodoc:
112 if Unicorn::TCPClient === socket
113 # Raindrops::TCP_Info#get!, #state (reads struct tcp_info#tcpi_state)
114 raise Errno::EPIPE, "client closed connection".freeze,
115 EMPTY_ARRAY if closed_state?(TCPI.get!(socket).state)
117 write_http_header(socket)
121 if Raindrops.const_defined?(:TCP)
122 # raindrops 0.18.0+ supports FreeBSD + Linux using the same names
123 # Evaluate these hash lookups at load time so we can
124 # generate an opt_case_dispatch instruction
126 def closed_state?(state) # :nodoc:
128 when #{Raindrops::TCP[:ESTABLISHED]}
130 when #{Raindrops::TCP.values_at(
131 :CLOSE_WAIT, :TIME_WAIT, :CLOSE, :LAST_ACK, :CLOSING).join(',')}
139 # raindrops before 0.18 only supported TCP_INFO under Linux
140 def closed_state?(state) # :nodoc:
144 when 8, 6, 7, 9, 11 # CLOSE_WAIT, TIME_WAIT, CLOSE, LAST_ACK, CLOSING
153 # Ruby 2.2+ can show struct tcp_info as a string Socket::Option#inspect.
154 # Not that efficient, but probably still better than doing unnecessary
155 # work after a client gives up.
156 def check_client_connection(socket) # :nodoc:
157 if Unicorn::TCPClient === socket && @@tcpi_inspect_ok != false
159 opt = socket.getsockopt(:IPPROTO_TCP, :TCP_INFO).inspect
161 @@tcpi_inspect_ok = true
163 socket.getsockopt(:IPPROTO_TCP, :TCP_INFO)
165 @@tcpi_inspect_ok = false
166 return write_http_header(socket)
170 if opt =~ /\bstate=(\S+)/
171 raise Errno::EPIPE, "client closed connection".freeze,
172 EMPTY_ARRAY if closed_state_str?($1)
174 @@tcpi_inspect_ok = false
175 write_http_header(socket)
179 write_http_header(socket)
183 def closed_state_str?(state)
187 # not a typo, ruby maps TCP_CLOSE (no 'D') to state=CLOSED (w/ 'D')
188 when 'CLOSE_WAIT', 'TIME_WAIT', 'CLOSED', 'LAST_ACK', 'CLOSING'
196 def write_http_header(socket) # :nodoc:
198 self.response_start_sent = true
199 HTTP_RESPONSE_START.each { |c| socket.write(c) }