Class: Puma::Server

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Const, Request
Defined in:
lib/puma/server.rb

Overview

The HTTP Server itself. Serves out a single Rack app.

This class is used by the ‘Puma::Single` and `Puma::Cluster` classes to generate one or more `Puma::Server` instances capable of handling requests. Each Puma process will contain one `Puma::Server` instance.

The ‘Puma::Server` instance pulls requests from the socket, adds them to a `Puma::Reactor` where they get eventually passed to a `Puma::ThreadPool`.

Each ‘Puma::Server` will have one reactor and one thread pool.

Constant Summary collapse

ThreadLocalKey = 
:puma_server
UNPACK_TCP_STATE_FROM_TCP_INFO = 
"C".freeze
STAT_METHODS =

List of methods invoked by #stats.

Version:

  • 5.0.0

[:backlog, :running, :pool_capacity, :max_threads, :requests_count].freeze

Constants included from Const

Const::BANNED_HEADER_KEY, 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::DQUOTE, 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_HEADER_DELIMITER, Const::HTTP_HOST, Const::HTTP_VERSION, Const::HTTP_X_FORWARDED_FOR, Const::HTTP_X_FORWARDED_PROTO, Const::HTTP_X_FORWARDED_SCHEME, Const::HTTP_X_FORWARDED_SSL, Const::ILLEGAL_HEADER_KEY_REGEX, Const::ILLEGAL_HEADER_VALUE_REGEX, 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

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Request

#default_server_port, #handle_request, #normalize_env

Constructor Details

#initialize(app, events = Events.stdio, options = {}) ⇒ Server

Note:

Several instance variables exist so they are available for testing, and have default values set via fetch. Normally the values are set via ‘::Puma::Configuration.puma_default_options`.

Create a server for the rack app app.

events is an object which will be called when certain error events occur to be handled. See Puma::Events for the list of current methods to implement.

Server#run returns a thread that you can join on to wait for the server to do its work.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/puma/server.rb', line 73

def initialize(app, events=Events.stdio, options={})
  @app = app
  @events = events

  @check, @notify = nil
  @status = :stop

  @auto_trim_time = 30
  @reaping_time = 1

  @thread = nil
  @thread_pool = nil

  @options = options

  @early_hints         = options.fetch :early_hints, nil
  @first_data_timeout  = options.fetch :first_data_timeout, FIRST_DATA_TIMEOUT
  @min_threads         = options.fetch :min_threads, 0
  @max_threads         = options.fetch :max_threads , (Puma.mri? ? 5 : 16)
  @persistent_timeout  = options.fetch :persistent_timeout, PERSISTENT_TIMEOUT
  @queue_requests      = options.fetch :queue_requests, true
  @max_fast_inline     = options.fetch :max_fast_inline, MAX_FAST_INLINE
  @io_selector_backend = options.fetch :io_selector_backend, :auto

  temp = !!(@options[:environment] =~ /\A(development|test)\z/)
  @leak_stack_on_error = @options[:environment] ? temp : true

  @binder = Binder.new(events)

  ENV['RACK_ENV'] ||= "development"

  @mode = :http

  @precheck_closing = true

  @requests_count = 0
end

Class Attribute Details

.current ⇒ Object (readonly) 



117
118
119
 
# File 'lib/puma/server.rb', line 117

def current
  Thread.current[ThreadLocalKey]
end

Instance Attribute Details

#app ⇒ Object

Returns the value of attribute app.



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

def app
  @app
end

#auto_trim_time ⇒ Object

TODO:

the following may be deprecated in the future



44
45
46
 
# File 'lib/puma/server.rb', line 44

def auto_trim_time
  @auto_trim_time
end

#backlog ⇒ Object (readonly) 



195
196
197
 
# File 'lib/puma/server.rb', line 195

def backlog
  @thread_pool and @thread_pool.backlog
end

#binder ⇒ Object

Returns the value of attribute binder.



54
55
56
 
# File 'lib/puma/server.rb', line 54

def binder
  @binder
end

#early_hints ⇒ Object

TODO:

the following may be deprecated in the future



44
45
46
 
# File 'lib/puma/server.rb', line 44

def early_hints
  @early_hints
end

#events ⇒ Object (readonly)

Returns the value of attribute events.



39
40
41
 
# File 'lib/puma/server.rb', line 39

def events
  @events
end

#first_data_timeout ⇒ Object

TODO:

the following may be deprecated in the future



44
45
46
 
# File 'lib/puma/server.rb', line 44

def first_data_timeout
  @first_data_timeout
end

#leak_stack_on_error ⇒ Object

TODO:

the following may be deprecated in the future



44
45
46
 
# File 'lib/puma/server.rb', line 44

def leak_stack_on_error
  @leak_stack_on_error
end

#max_threads ⇒ Object

for #stats



40
41
42
 
# File 'lib/puma/server.rb', line 40

def max_threads
  @max_threads
end

#min_threads ⇒ Object

for #stats



40
41
42
 
# File 'lib/puma/server.rb', line 40

def min_threads
  @min_threads
end

#persistent_timeout ⇒ Object

TODO:

the following may be deprecated in the future



44
45
46
 
# File 'lib/puma/server.rb', line 44

def persistent_timeout
  @persistent_timeout
end

#pool_capacity ⇒ Object (readonly)

This number represents the number of requests that the server is capable of taking right now.

For example if the number is 5 then it means there are 5 threads sitting idle ready to take a request. If one request comes in, then the value would be 4 until it finishes processing.



213
214
215
 
# File 'lib/puma/server.rb', line 213

def pool_capacity
  @thread_pool and @thread_pool.pool_capacity
end

#reaping_time ⇒ Object

TODO:

the following may be deprecated in the future



44
45
46
 
# File 'lib/puma/server.rb', line 44

def reaping_time
  @reaping_time
end

#requests_count ⇒ Object (readonly)

Version:

  • 5.0.0



41
42
43
 
# File 'lib/puma/server.rb', line 41

def requests_count
  @requests_count
end

#running ⇒ Object (readonly) 



200
201
202
 
# File 'lib/puma/server.rb', line 200

def running
  @thread_pool and @thread_pool.spawned
end

#stats ⇒ Object (readonly)

Returns a hash of stats about the running server for reporting purposes.

Version:

  • 5.0.0



619
620
621
 
# File 'lib/puma/server.rb', line 619

def stats
  STAT_METHODS.map {|name| [name, send(name) || 0]}.to_h
end

#thread ⇒ Object (readonly)

Returns the value of attribute thread.



38
39
40
 
# File 'lib/puma/server.rb', line 38

def thread
  @thread
end

Class Method Details

.closed_socket_supported? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean)

Version:

  • 5.0.0



129
130
131
 
# File 'lib/puma/server.rb', line 129

def closed_socket_supported?
  Socket.const_defined?(:TCP_INFO) && Socket.const_defined?(:IPPROTO_TCP)
end

.tcp_cork_supported? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean)

Version:

  • 5.0.0



123
124
125
 
# File 'lib/puma/server.rb', line 123

def tcp_cork_supported?
  Socket.const_defined?(:TCP_CORK) && Socket.const_defined?(:IPPROTO_TCP)
end

Instance Method Details

#begin_restart(sync = false) ⇒ Object 



603
604
605
606
 
# File 'lib/puma/server.rb', line 603

def begin_restart(sync=false)
  notify_safely(RESTART_COMMAND)
  @thread.join if @thread && sync
end

#client_error(e, client) ⇒ Object

Handle various error types thrown by Client I/O operations.



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/puma/server.rb', line 506

def client_error(e, client)
  # Swallow, do not log
  return if [ConnectionError, EOFError].include?(e.class)

  lowlevel_error(e, client.env)
  case e
  when MiniSSL::SSLError
    @events.ssl_error e, client.io
  when HttpParserError
    client.write_error(400)
    @events.parse_error e, client
  else
    client.write_error(500)
    @events.unknown_error e, nil, "Read"
  end
end

#closed_socket?(socket) ⇒ Boolean

Returns:

  • (Boolean) 


172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/puma/server.rb', line 172

def closed_socket?(socket)
  skt = socket.to_io
  return false unless skt.kind_of?(TCPSocket) && @precheck_closing

  begin
    tcp_info = skt.getsockopt(Socket::IPPROTO_TCP, Socket::TCP_INFO)
  rescue IOError, SystemCallError
    Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
    @precheck_closing = false
    false
  else
    state = tcp_info.unpack(UNPACK_TCP_STATE_FROM_TCP_INFO)[0]
    # TIME_WAIT: 6, CLOSE: 7, CLOSE_WAIT: 8, LAST_ACK: 9, CLOSING: 11
    (state >= 6 && state <= 9) || state == 11
  end
end

#cork_socket(socket) ⇒ Object

6 == Socket::IPPROTO_TCP 3 == TCP_CORK 1/0 == turn on/off



144
145
146
147
148
149
150
151
 
# File 'lib/puma/server.rb', line 144

def cork_socket(socket)
  skt = socket.to_io
  begin
    skt.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_CORK, 1) if skt.kind_of? TCPSocket
  rescue IOError, SystemCallError
    Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
  end
end

#graceful_shutdown ⇒ Object

Wait for all outstanding requests to finish.



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/puma/server.rb', line 546

def graceful_shutdown
  if @options[:shutdown_debug]
    threads = Thread.list
    total = threads.size

    pid = Process.pid

    $stdout.syswrite "#{pid}: === Begin thread backtrace dump ===\n"

    threads.each_with_index do |t,i|
      $stdout.syswrite "#{pid}: Thread #{i+1}/#{total}: #{t.inspect}\n"
      $stdout.syswrite "#{pid}: #{t.backtrace.join("\n#{pid}: ")}\n\n"
    end
    $stdout.syswrite "#{pid}: === End thread backtrace dump ===\n"
  end

  if @status != :restart
    @binder.close
  end

  if @thread_pool
    if timeout = @options[:force_shutdown_after]
      @thread_pool.shutdown timeout.to_f
    else
      @thread_pool.shutdown
    end
  end
end

#halt(sync = false) ⇒ Object 



598
599
600
601
 
# File 'lib/puma/server.rb', line 598

def halt(sync=false)
  notify_safely(HALT_COMMAND)
  @thread.join if @thread && sync
end

#handle_check ⇒ Object

:nodoc:



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/puma/server.rb', line 386

def handle_check
  cmd = @check.read(1)

  case cmd
  when STOP_COMMAND
    @status = :stop
    return true
  when HALT_COMMAND
    @status = :halt
    return true
  when RESTART_COMMAND
    @status = :restart
    return true
  end

  false
end

#handle_servers ⇒ Object 



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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/puma/server.rb', line 310

def handle_servers
  begin
    check = @check
    sockets = [check] + @binder.ios
    pool = @thread_pool
    queue_requests = @queue_requests
    drain = @options[:drain_on_shutdown] ? 0 : nil

    remote_addr_value = nil
    remote_addr_header = nil

    case @options[:remote_address]
    when :value
      remote_addr_value = @options[:remote_address_value]
    when :header
      remote_addr_header = @options[:remote_address_header]
    end

    while @status == :run || (drain && shutting_down?)
      begin
        ios = IO.select sockets, nil, nil, (shutting_down? ? 0 : nil)
        break unless ios
        ios.first.each do |sock|
          if sock == check
            break if handle_check
          else
            pool.wait_until_not_full
            pool.wait_for_less_busy_worker(@options[:wait_for_less_busy_worker])

            io = begin
              sock.accept_nonblock
            rescue IO::WaitReadable
              next
            end
            drain += 1 if shutting_down?
            client = Client.new io, @binder.env(sock)
            client.listener = sock
            if remote_addr_value
              client.peerip = remote_addr_value
            elsif remote_addr_header
              client.remote_addr_header = remote_addr_header
            end
            pool << client
          end
        end
      rescue Object => e
        @events.unknown_error e, nil, "Listen loop"
      end
    end

    @events.debug "Drained #{drain} additional connections." if drain
    @events.fire :state, @status

    if queue_requests
      @queue_requests = false
      @reactor.shutdown
    end
    graceful_shutdown if @status == :stop || @status == :restart
  rescue Exception => e
    @events.unknown_error e, nil, "Exception handling servers"
  ensure
    begin
      @check.close unless @check.closed?
    rescue Errno::EBADF, RuntimeError
      # RuntimeError is Ruby 2.2 issue, can't modify frozen IOError
      # Errno::EBADF is infrequently raised
    end
    @notify.close
    @notify = nil
    @check = nil
  end

  @events.fire :state, :done
end

#inherit_binder(bind) ⇒ Object 



111
112
113
 
# File 'lib/puma/server.rb', line 111

def inherit_binder(bind)
  @binder = bind
end

#lowlevel_error(e, env, status = 500) ⇒ Object

A fallback rack response if @app raises as exception.



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/puma/server.rb', line 525

def lowlevel_error(e, env, status=500)
  if handler = @options[:lowlevel_error_handler]
    if handler.arity == 1
      return handler.call(e)
    elsif handler.arity == 2
      return handler.call(e, env)
    else
      return handler.call(e, env, status)
    end
  end

  if @leak_stack_on_error
    backtrace = e.backtrace.nil? ? '<no backtrace available>' : e.backtrace.join("\n")
    [status, {}, ["Puma caught this error: #{e.message} (#{e.class})\n#{backtrace}"]]
  else
    [status, {}, ["An unhandled lowlevel error occurred. The application logs may have details.\n"]]
  end
end

#process_client(client, buffer) ⇒ Object

Given a connection on client, handle the incoming requests, or queue the connection in the Reactor if no request is available.

This method is called from a ThreadPool worker thread.

This method supports HTTP Keep-Alive so it may, depending on if the client indicates that it supports keep alive, wait for another request before returning.

Return true if one or more requests were processed.



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/puma/server.rb', line 414

def process_client(client, buffer)
  # Advertise this server into the thread
  Thread.current[ThreadLocalKey] = self

  clean_thread_locals = @options[:clean_thread_locals]
  close_socket = true

  requests = 0

  begin
    if @queue_requests &&
      !client.eagerly_finish

      client.set_timeout(@first_data_timeout)
      if @reactor.add client
        close_socket = false
        return false
      end
    end

    with_force_shutdown(client) do
      client.finish(@first_data_timeout)
    end

    while true
      @requests_count += 1
      case handle_request(client, buffer, requests + 1)
      when false
        break
      when :async
        close_socket = false
        break
      when true
        buffer.reset

        ThreadPool.clean_thread_locals if clean_thread_locals

        requests += 1

        # As an optimization, try to read the next request from the
        # socket for a short time before returning to the reactor.
        fast_check = @status == :run

        # Always pass the client back to the reactor after a reasonable
        # number of inline requests if there are other requests pending.
        fast_check = false if requests >= @max_fast_inline &&
          @thread_pool.backlog > 0

        next_request_ready = with_force_shutdown(client) do
          client.reset(fast_check)
        end

        unless next_request_ready
          break unless @queue_requests
          client.set_timeout @persistent_timeout
          if @reactor.add client
            close_socket = false
            break
          end
        end
      end
    end
    true
  rescue StandardError => e
    client_error(e, client)
    # The ensure tries to close +client+ down
    requests > 0
  ensure
    buffer.reset

    begin
      client.close if close_socket
    rescue IOError, SystemCallError
      Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
      # Already closed
    rescue StandardError => e
      @events.unknown_error e, nil, "Client"
    end
  end
end

#reactor_wakeup(client) ⇒ Object

This method is called from the Reactor thread when a queued Client receives data, times out, or when the Reactor is shutting down.

It is responsible for ensuring that a request has been completely received before it starts to be processed by the ThreadPool. This may be known as read buffering. If read buffering is not done, and no other read buffering is performed (such as by an application server such as nginx) then the application would be subject to a slow client attack.

For a graphical representation of how the request buffer works see [architecture.md](github.com/puma/puma/blob/master/docs/architecture.md#connection-pipeline).

The method checks to see if it has the full header and body with the ‘Puma::Client#try_to_finish` method. If the full request has been sent, then the request is passed to the ThreadPool (`@thread_pool << client`) so that a “worker thread” can pick up the request and begin to execute application logic. The Client is then removed from the reactor (return `true`).

If a client object times out, a 408 response is written, its connection is closed, and the object is removed from the reactor (return ‘true`).

If the Reactor is shutting down, all Clients are either timed out or passed to the ThreadPool, depending on their current state (#can_close?).

Otherwise, if the full request is not ready then the client will remain in the reactor (return ‘false`). When the client sends more data to the socket the `Puma::Client` object will wake up and again be checked to see if it’s ready to be passed to the thread pool.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/puma/server.rb', line 294

def reactor_wakeup(client)
  shutdown = !@queue_requests
  if client.try_to_finish || (shutdown && !client.can_close?)
    @thread_pool << client
  elsif shutdown || client.timeout == 0
    client.timeout!
  else
    client.set_timeout(@first_data_timeout)
    false
  end
rescue StandardError => e
  client_error(e, client)
  client.close
  true
end

#run(background = true, thread_name: 'server') ⇒ Object

Runs the server.

If background is true (the default) then a thread is spun up in the background to handle requests. Otherwise requests are handled synchronously.



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/puma/server.rb', line 223

def run(background=true, thread_name: 'server')
  BasicSocket.do_not_reverse_lookup = true

  @events.fire :state, :booting

  @status = :run

  @thread_pool = ThreadPool.new(
    thread_name,
    @min_threads,
    @max_threads,
    ::Puma::IOBuffer,
    &method(:process_client)
  )

  @thread_pool.out_of_band_hook = @options[:out_of_band]
  @thread_pool.clean_thread_locals = @options[:clean_thread_locals]

  if @queue_requests
    @reactor = Reactor.new(@io_selector_backend, &method(:reactor_wakeup))
    @reactor.run
  end

  if @reaping_time
    @thread_pool.auto_reap!(@reaping_time)
  end

  if @auto_trim_time
    @thread_pool.auto_trim!(@auto_trim_time)
  end

  @check, @notify = Puma::Util.pipe unless @notify

  @events.fire :state, :running

  if background
    @thread = Thread.new do
      Puma.set_thread_name thread_name
      handle_servers
    end
    return @thread
  else
    handle_servers
  end
end

#shutting_down? ⇒ Boolean

Returns:

  • (Boolean) 


608
609
610
 
# File 'lib/puma/server.rb', line 608

def shutting_down?
  @status == :stop || @status == :restart
end

#stop(sync = false) ⇒ Object

Stops the acceptor thread and then causes the worker threads to finish off the request queue before finally exiting.



593
594
595
596
 
# File 'lib/puma/server.rb', line 593

def stop(sync=false)
  notify_safely(STOP_COMMAND)
  @thread.join if @thread && sync
end

#uncork_socket(socket) ⇒ Object 



153
154
155
156
157
158
159
160
 
# File 'lib/puma/server.rb', line 153

def uncork_socket(socket)
  skt = socket.to_io
  begin
    skt.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_CORK, 0) if skt.kind_of? TCPSocket
  rescue IOError, SystemCallError
    Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
  end
end

#with_force_shutdown(client, &block) ⇒ Object

Triggers a client timeout if the thread-pool shuts down during execution of the provided block.



497
498
499
500
501
 
# File 'lib/puma/server.rb', line 497

def with_force_shutdown(client, &block)
  @thread_pool.with_force_shutdown(&block)
rescue ThreadPool::ForceShutdown
  client.timeout!
end