Class: Puma::Binder

Inherits:
Object
  • Object
show all
Includes:
Const
Defined in:
lib/puma/binder.rb

Constant Summary collapse

RACK_VERSION =
[1,6].freeze

Constants included from Const

Const::CGI_VER, Const::CHUNKED, Const::CHUNK_SIZE, Const::CLOSE, Const::CLOSE_CHUNKED, Const::CODE_NAME, Const::COLON, Const::CONNECTION_CLOSE, Const::CONNECTION_KEEP_ALIVE, Const::CONTENT_LENGTH, Const::CONTENT_LENGTH2, Const::CONTENT_LENGTH_S, Const::CONTINUE, Const::EARLY_HINTS, Const::ERROR_RESPONSE, Const::FAST_TRACK_KA_TIMEOUT, Const::FIRST_DATA_TIMEOUT, Const::GATEWAY_INTERFACE, Const::HALT_COMMAND, Const::HEAD, Const::HIJACK, Const::HIJACK_IO, Const::HIJACK_P, Const::HTTP, Const::HTTPS, Const::HTTPS_KEY, Const::HTTP_10_200, Const::HTTP_11, Const::HTTP_11_100, Const::HTTP_11_200, Const::HTTP_CONNECTION, Const::HTTP_EXPECT, Const::HTTP_HOST, Const::HTTP_INJECTION_REGEX, Const::HTTP_VERSION, Const::HTTP_X_FORWARDED_FOR, Const::HTTP_X_FORWARDED_PROTO, Const::HTTP_X_FORWARDED_SCHEME, Const::HTTP_X_FORWARDED_SSL, Const::KEEP_ALIVE, Const::LINE_END, Const::LOCALHOST, Const::LOCALHOST_IP, Const::MAX_BODY, Const::MAX_FAST_INLINE, Const::MAX_HEADER, Const::NEWLINE, Const::PATH_INFO, Const::PERSISTENT_TIMEOUT, Const::PORT_443, Const::PORT_80, Const::PUMA_CONFIG, Const::PUMA_PEERCERT, Const::PUMA_SERVER_STRING, Const::PUMA_SOCKET, Const::PUMA_TMP_BASE, Const::PUMA_VERSION, Const::QUERY_STRING, Const::RACK_AFTER_REPLY, Const::RACK_INPUT, Const::RACK_URL_SCHEME, Const::REMOTE_ADDR, Const::REQUEST_METHOD, Const::REQUEST_PATH, Const::REQUEST_URI, Const::RESTART_COMMAND, Const::SERVER_NAME, Const::SERVER_PORT, Const::SERVER_PROTOCOL, Const::SERVER_SOFTWARE, Const::STOP_COMMAND, Const::TRANSFER_ENCODING, Const::TRANSFER_ENCODING2, Const::TRANSFER_ENCODING_CHUNKED, Const::WORKER_CHECK_INTERVAL, Const::WRITE_TIMEOUT

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(events, conf = Configuration.new) ⇒ Binder

Returns a new instance of Binder.


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/puma/binder.rb', line 23

def initialize(events, conf = Configuration.new)
  @events = events
  @listeners = []
  @inherited_fds = {}
  @activated_sockets = {}
  @unix_paths = []

  @proto_env = {
    "rack.version".freeze => RACK_VERSION,
    "rack.errors".freeze => events.stderr,
    "rack.multithread".freeze => conf.options[:max_threads] > 1,
    "rack.multiprocess".freeze => conf.options[:workers] >= 1,
    "rack.run_once".freeze => false,
    "SCRIPT_NAME".freeze => ENV['SCRIPT_NAME'] || "",

    # I'd like to set a default CONTENT_TYPE here but some things
    # depend on their not being a default set and inferring
    # it from the content. And so if i set it here, it won't
    # infer properly.

    "QUERY_STRING".freeze => "",
    SERVER_PROTOCOL => HTTP_11,
    SERVER_SOFTWARE => PUMA_SERVER_STRING,
    GATEWAY_INTERFACE => CGI_VER
  }

  @envs = {}
  @ios = []
end

Instance Attribute Details

#activated_socketsObject (readonly)

Returns the value of attribute activated_sockets


53
54
55
# File 'lib/puma/binder.rb', line 53

def activated_sockets
  @activated_sockets
end

#envsObject (readonly)

Returns the value of attribute envs


53
54
55
# File 'lib/puma/binder.rb', line 53

def envs
  @envs
end

#inherited_fdsObject (readonly)

Returns the value of attribute inherited_fds


53
54
55
# File 'lib/puma/binder.rb', line 53

def inherited_fds
  @inherited_fds
end

#iosObject

Returns the value of attribute ios


53
54
55
# File 'lib/puma/binder.rb', line 53

def ios
  @ios
end

#listenersObject

Returns the value of attribute listeners


53
54
55
# File 'lib/puma/binder.rb', line 53

def listeners
  @listeners
end

#proto_envObject (readonly)

Returns the value of attribute proto_env


53
54
55
# File 'lib/puma/binder.rb', line 53

def proto_env
  @proto_env
end

#unix_pathsObject (readonly)

Returns the value of attribute unix_paths


53
54
55
# File 'lib/puma/binder.rb', line 53

def unix_paths
  @unix_paths
end

Instance Method Details

#add_ssl_listener(host, port, ctx, optimize_for_latency = true, backlog = 1024) ⇒ Object


255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'lib/puma/binder.rb', line 255

def add_ssl_listener(host, port, ctx,
                     optimize_for_latency=true, backlog=1024)

  raise "Puma compiled without SSL support" unless HAS_SSL

  if host == "localhost"
    loopback_addresses.each do |addr|
      add_ssl_listener addr, port, ctx, optimize_for_latency, backlog
    end
    return
  end

  host = host[1..-2] if host[0..0] == '['
  s = TCPServer.new(host, port)
  if optimize_for_latency
    s.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
  end
  s.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true)
  s.listen backlog

  ssl = MiniSSL::Server.new s, ctx
  env = @proto_env.dup
  env[HTTPS_KEY] = HTTPS
  @envs[ssl] = env

  @ios << ssl
  s
end

#add_tcp_listener(host, port, optimize_for_latency = true, backlog = 1024) ⇒ Object

Tell the server to listen on host host, port port. If optimize_for_latency is true (the default) then clients connecting will be optimized for latency over throughput.

backlog indicates how many unaccepted connections the kernel should allow to accumulate before returning connection refused.


224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
# File 'lib/puma/binder.rb', line 224

def add_tcp_listener(host, port, optimize_for_latency=true, backlog=1024)
  if host == "localhost"
    loopback_addresses.each do |addr|
      add_tcp_listener addr, port, optimize_for_latency, backlog
    end
    return
  end

  host = host[1..-2] if host and host[0..0] == '['
  tcp_server = TCPServer.new(host, port)
  if optimize_for_latency
    tcp_server.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
  end
  tcp_server.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true)
  tcp_server.listen backlog

  @ios << tcp_server
  tcp_server
end

#add_unix_listener(path, umask = nil, mode = nil, backlog = 1024) ⇒ Object

Tell the server to listen on path as a UNIX domain socket.


305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
# File 'lib/puma/binder.rb', line 305

def add_unix_listener(path, umask=nil, mode=nil, backlog=1024)
  @unix_paths << path unless File.exist? path

  # Let anyone connect by default
  umask ||= 0

  begin
    old_mask = File.umask(umask)

    if File.exist? path
      begin
        old = UNIXSocket.new path
      rescue SystemCallError, IOError
        File.unlink path
      else
        old.close
        raise "There is already a server bound to: #{path}"
      end
    end

    s = UNIXServer.new(path)
    s.listen backlog
    @ios << s
  ensure
    File.umask old_mask
  end

  if mode
    File.chmod mode, path
  end

  env = @proto_env.dup
  env[REMOTE_ADDR] = "127.0.0.1"
  @envs[s] = env

  s
end

#closeObject


60
61
62
# File 'lib/puma/binder.rb', line 60

def close
  @ios.each { |i| i.close }
end

#close_listenersObject


360
361
362
363
364
365
366
367
368
# File 'lib/puma/binder.rb', line 360

def close_listeners
  listeners.each do |l, io|
    io.close unless io.closed? # Ruby 2.2 issue
    uri = URI.parse(l)
    next unless uri.scheme == 'unix'
    unix_path = "#{uri.host}#{uri.path}"
    File.unlink unix_path if unix_paths.include? unix_path
  end
end

#connected_portsObject


64
65
66
# File 'lib/puma/binder.rb', line 64

def connected_ports
  ios.map { |io| io.addr[1] }.uniq
end

#create_activated_fds(env_hash) ⇒ Object

systemd socket activation. LISTEN_FDS = number of listening sockets. e.g. 2 means accept on 2 sockets w/descriptors 3 and 4. LISTEN_PID = PID of the service process, aka us see www.freedesktop.org/software/systemd/man/systemd-socket-activate.html


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/puma/binder.rb', line 79

def create_activated_fds(env_hash)
  return [] unless env_hash['LISTEN_FDS'] && env_hash['LISTEN_PID'].to_i == $$
  env_hash['LISTEN_FDS'].to_i.times do |index|
    sock = TCPServer.for_fd(socket_activation_fd(index))
    key = begin # Try to parse as a path
      [:unix, Socket.unpack_sockaddr_un(sock.getsockname)]
    rescue ArgumentError # Try to parse as a port/ip
      port, addr = Socket.unpack_sockaddr_in(sock.getsockname)
      addr = "[#{addr}]" if addr =~ /\:/
      [:tcp, addr, port]
    end
    @activated_sockets[key] = sock
    @events.debug "Registered #{key.join ':'} for activation from LISTEN_FDS"
  end
  ["LISTEN_FDS", "LISTEN_PID"] # Signal to remove these keys from ENV
end

#create_inherited_fds(env_hash) ⇒ Object


68
69
70
71
72
73
# File 'lib/puma/binder.rb', line 68

def create_inherited_fds(env_hash)
  env_hash.select {|k,v| k =~ /PUMA_INHERIT_\d+/}.each do |_k, v|
    fd, url = v.split(":", 2)
    @inherited_fds[url] = fd.to_i
  end.keys # pass keys back for removal
end

#env(sock) ⇒ Object


56
57
58
# File 'lib/puma/binder.rb', line 56

def env(sock)
  @envs.fetch(sock, @proto_env)
end

#inherit_ssl_listener(fd, ctx) ⇒ Object


284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/puma/binder.rb', line 284

def inherit_ssl_listener(fd, ctx)
  raise "Puma compiled without SSL support" unless HAS_SSL

  if fd.kind_of? TCPServer
    s = fd
  else
    s = TCPServer.for_fd(fd)
  end
  ssl = MiniSSL::Server.new(s, ctx)

  env = @proto_env.dup
  env[HTTPS_KEY] = HTTPS
  @envs[ssl] = env

  @ios << ssl

  s
end

#inherit_tcp_listener(host, port, fd) ⇒ Object


244
245
246
247
248
249
250
251
252
253
# File 'lib/puma/binder.rb', line 244

def inherit_tcp_listener(host, port, fd)
  if fd.kind_of? TCPServer
    s = fd
  else
    s = TCPServer.for_fd(fd)
  end

  @ios << s
  s
end

#inherit_unix_listener(path, fd) ⇒ Object


343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'lib/puma/binder.rb', line 343

def inherit_unix_listener(path, fd)
  @unix_paths << path unless File.exist? path

  if fd.kind_of? TCPServer
    s = fd
  else
    s = UNIXServer.for_fd fd
  end
  @ios << s

  env = @proto_env.dup
  env[REMOTE_ADDR] = "127.0.0.1"
  @envs[s] = env

  s
end

#parse(binds, logger, log_msg = 'Listening') ⇒ Object


96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/puma/binder.rb', line 96

def parse(binds, logger, log_msg = 'Listening')
  binds.each do |str|
    uri = URI.parse str
    case uri.scheme
    when "tcp"
      if fd = @inherited_fds.delete(str)
        io = inherit_tcp_listener uri.host, uri.port, fd
        logger.log "* Inherited #{str}"
      elsif sock = @activated_sockets.delete([ :tcp, uri.host, uri.port ])
        io = inherit_tcp_listener uri.host, uri.port, sock
        logger.log "* Activated #{str}"
      else
        params = Util.parse_query uri.query

        opt = params.key?('low_latency')
        bak = params.fetch('backlog', 1024).to_i

        io = add_tcp_listener uri.host, uri.port, opt, bak

        @ios.each do |i|
          next unless TCPServer === i
          addr = if i.local_address.ipv6?
            "[#{i.local_address.ip_unpack[0]}]:#{i.local_address.ip_unpack[1]}"
          else
            i.local_address.ip_unpack.join(':')
          end

          logger.log "* #{log_msg} on http://#{addr}"
        end
      end

      @listeners << [str, io] if io
    when "unix"
      path = "#{uri.host}#{uri.path}".gsub("%20", " ")

      if fd = @inherited_fds.delete(str)
        io = inherit_unix_listener path, fd
        logger.log "* Inherited #{str}"
      elsif sock = @activated_sockets.delete([ :unix, path ])
        io = inherit_unix_listener path, sock
        logger.log "* Activated #{str}"
      else
        umask = nil
        mode = nil
        backlog = 1024

        if uri.query
          params = Util.parse_query uri.query
          if u = params['umask']
            # Use Integer() to respect the 0 prefix as octal
            umask = Integer(u)
          end

          if u = params['mode']
            mode = Integer('0'+u)
          end

          if u = params['backlog']
            backlog = Integer(u)
          end
        end

        io = add_unix_listener path, umask, mode, backlog
        logger.log "* #{log_msg} on #{str}"
      end

      @listeners << [str, io]
    when "ssl"

      raise "Puma compiled without SSL support" unless HAS_SSL

      params = Util.parse_query uri.query
      ctx = MiniSSL::ContextBuilder.new(params, @events).context

      if fd = @inherited_fds.delete(str)
        logger.log "* Inherited #{str}"
        io = inherit_ssl_listener fd, ctx
      elsif sock = @activated_sockets.delete([ :tcp, uri.host, uri.port ])
        io = inherit_ssl_listener sock, ctx
        logger.log "* Activated #{str}"
      else
        io = add_ssl_listener uri.host, uri.port, ctx
        logger.log "* Listening on #{str}"
      end

      @listeners << [str, io] if io
    else
      logger.error "Invalid URI: #{str}"
    end
  end

  # If we inherited fds but didn't use them (because of a
  # configuration change), then be sure to close them.
  @inherited_fds.each do |str, fd|
    logger.log "* Closing unused inherited connection: #{str}"

    begin
      IO.for_fd(fd).close
    rescue SystemCallError
    end

    # We have to unlink a unix socket path that's not being used
    uri = URI.parse str
    if uri.scheme == "unix"
      path = "#{uri.host}#{uri.path}"
      File.unlink path
    end
  end

  # Also close any unused activated sockets
  @activated_sockets.each do |key, sock|
    logger.log "* Closing unused activated socket: #{key.join ':'}"
    begin
      sock.close
    rescue SystemCallError
    end
    # We have to unlink a unix socket path that's not being used
    File.unlink key[1] if key[0] == :unix
  end
end

#redirects_for_restartObject


370
371
372
373
374
# File 'lib/puma/binder.rb', line 370

def redirects_for_restart
  redirects = listeners.map { |a| [a[1].to_i, a[1].to_i] }.to_h
  redirects[:close_others] = true
  redirects
end

#redirects_for_restart_envObject


376
377
378
379
380
# File 'lib/puma/binder.rb', line 376

def redirects_for_restart_env
  listeners.each_with_object({}).with_index do |(listen, memo), i|
    memo["PUMA_INHERIT_#{i}"] = "#{listen[1].to_i}:#{listen[0]}"
  end
end