Class: Puma::Server

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

Overview

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

Constant Summary

Constants included from Const

Const::CGI_VER, 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::CONTENT_TYPE, Const::DATE, Const::ERROR_400_RESPONSE, Const::ERROR_404_RESPONSE, Const::ERROR_500_RESPONSE, Const::ERROR_503_RESPONSE, Const::ETAG, Const::ETAG_FORMAT, Const::FAST_TRACK_KA_TIMEOUT, Const::FIRST_DATA_TIMEOUT, Const::GATEWAY_INTERFACE, Const::GET, Const::HALT_COMMAND, Const::HEAD, Const::HIJACK, Const::HIJACK_IO, Const::HIJACK_P, Const::HOST, Const::HTTP, Const::HTTPS, Const::HTTPS_KEY, Const::HTTP_10, Const::HTTP_10_200, Const::HTTP_11, Const::HTTP_11_200, Const::HTTP_CONNECTION, Const::HTTP_HOST, Const::HTTP_IF_MODIFIED_SINCE, Const::HTTP_IF_NONE_MATCH, Const::HTTP_VERSION, Const::HTTP_X_FORWARDED_FOR, Const::KEEP_ALIVE, Const::LAST_MODIFIED, Const::LINE_END, Const::LOCALHOST, Const::MAX_BODY, Const::MAX_HEADER, Const::NEWLINE, Const::PATH_INFO, Const::PERSISTENT_TIMEOUT, Const::PORT_443, Const::PORT_80, Const::PUMA_CONFIG, Const::PUMA_SOCKET, Const::PUMA_TMP_BASE, Const::PUMA_VERSION, Const::RACK_AFTER_REPLY, Const::RACK_INPUT, Const::RACK_URL_SCHEME, Const::REDIRECT, Const::REMOTE_ADDR, Const::REQUEST_METHOD, Const::REQUEST_PATH, Const::REQUEST_URI, Const::RESTART_COMMAND, Const::SCRIPT_NAME, Const::SERVER_NAME, Const::SERVER_PORT, Const::SERVER_PROTOCOL, Const::SERVER_SOFTWARE, Const::SLASH, Const::STATUS_FORMAT, Const::STOP_COMMAND, Const::TRANSFER_ENCODING, Const::TRANSFER_ENCODING_CHUNKED

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Delegation

forward

Constructor Details

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

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 it’s work.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/puma/server.rb', line 51

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

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

  @status = :stop

  @min_threads = 0
  @max_threads = 16
  @auto_trim_time = 1

  @thread = nil
  @thread_pool = nil

  @persistent_timeout = PERSISTENT_TIMEOUT

  @binder = Binder.new(events)
  @own_binder = true

  @first_data_timeout = FIRST_DATA_TIMEOUT

  @leak_stack_on_error = true

  @options = options

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

  @mode = :http
end

Instance Attribute Details

#app ⇒ Object

Returns the value of attribute app.



36
37
38
 
# File 'lib/puma/server.rb', line 36

def app
  @app
end

#auto_trim_time ⇒ Object

Returns the value of attribute auto_trim_time.



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

def auto_trim_time
  @auto_trim_time
end

#binder ⇒ Object

Returns the value of attribute binder.



82
83
84
 
# File 'lib/puma/server.rb', line 82

def binder
  @binder
end

#events ⇒ Object (readonly)

Returns the value of attribute events.



35
36
37
 
# File 'lib/puma/server.rb', line 35

def events
  @events
end

#leak_stack_on_error ⇒ Object

Returns the value of attribute leak_stack_on_error.



82
83
84
 
# File 'lib/puma/server.rb', line 82

def leak_stack_on_error
  @leak_stack_on_error
end

#max_threads ⇒ Object

Returns the value of attribute max_threads.



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

def max_threads
  @max_threads
end

#min_threads ⇒ Object

Returns the value of attribute min_threads.



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

def min_threads
  @min_threads
end

#persistent_timeout ⇒ Object

Returns the value of attribute persistent_timeout.



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

def persistent_timeout
  @persistent_timeout
end

#thread ⇒ Object (readonly)

Returns the value of attribute thread.



34
35
36
 
# File 'lib/puma/server.rb', line 34

def thread
  @thread
end

Instance Method Details

#backlog ⇒ Object 



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

def backlog
  @thread_pool and @thread_pool.backlog
end

#begin_restart ⇒ Object 



764
765
766
767
768
769
770
 
# File 'lib/puma/server.rb', line 764

def begin_restart
  begin
    @notify << RESTART_COMMAND
  rescue IOError
    # The server, in another thread, is shutting down
  end
end

#cork_socket(socket) ⇒ Object

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



104
105
106
 
# File 'lib/puma/server.rb', line 104

def cork_socket(socket)
  socket.setsockopt(6, 3, 1) if socket.kind_of? TCPSocket
end

#default_server_port(env) ⇒ Object 



448
449
450
 
# File 'lib/puma/server.rb', line 448

def default_server_port(env)
  env['HTTP_X_FORWARDED_PROTO'] == 'https' ? PORT_443 : PORT_80
end

#graceful_shutdown ⇒ Object

Wait for all outstanding requests to finish.



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
 
# File 'lib/puma/server.rb', line 715

def graceful_shutdown
  if @options[:drain_on_shutdown]
    count = 0

    while true
      ios = IO.select @binder.ios, nil, nil, 0
      break unless ios

      ios.first.each do |sock|
        begin
          if io = sock.accept_nonblock
            count += 1
            c = Client.new io, @binder.env(sock)
            @thread_pool << c
          end
        rescue SystemCallError
        end
      end
    end

    @events.debug "Drained #{count} additional connections."
  end

  @thread_pool.shutdown if @thread_pool
end

#halt(sync = false) ⇒ Object 



754
755
756
757
758
759
760
761
762
 
# File 'lib/puma/server.rb', line 754

def halt(sync=false)
  begin
    @notify << HALT_COMMAND
  rescue IOError
    # The server, in another thread, is shutting down
  end

  @thread.join if @thread && sync
end

#handle_check ⇒ Object

:nodoc:



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/puma/server.rb', line 328

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

  return false
end

#handle_request(req, lines) ⇒ Object

Given the request env from client and a partial request body in body, finish reading the body if there is one and invoke the rack app. Then construct the response and write it back to client

cl is the previously fetched Content-Length header if there was one. This is an optimization to keep from having to look it up again.



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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
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
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/puma/server.rb', line 461

def handle_request(req, lines)
  env = req.env
  client = req.io

  normalize_env env, client

  env[PUMA_SOCKET] = client

  env[HIJACK_P] = true
  env[HIJACK] = req

  body = req.body

  head = env[REQUEST_METHOD] == HEAD

  env[RACK_INPUT] = body
  env[RACK_URL_SCHEME] =  env[HTTPS_KEY] ? HTTPS : HTTP

  # A rack extension. If the app writes #call'ables to this
  # array, we will invoke them when the request is done.
  #
  after_reply = env[RACK_AFTER_REPLY] = []

  begin
    begin
      status, headers, res_body = @app.call(env)

      return :async if req.hijacked

      status = status.to_i

      if status == -1
        unless headers.empty? and res_body == []
          raise "async response must have empty headers and body"
        end

        return :async
      end
    rescue StandardError => e
      @events.unknown_error self, e, "Rack app"

      status, headers, res_body = lowlevel_error(e)
    end

    content_length = nil
    no_body = head

    if res_body.kind_of? Array and res_body.size == 1
      content_length = res_body[0].bytesize
    end

    cork_socket client

    line_ending = LINE_END
    colon = COLON

    if env[HTTP_VERSION] == HTTP_11
      allow_chunked = true
      keep_alive = env[HTTP_CONNECTION] != CLOSE
      include_keepalive_header = false

      # An optimization. The most common response is 200, so we can
      # reply with the proper 200 status without having to compute
      # the response header.
      #
      if status == 200
        lines << HTTP_11_200
      else
        lines.append "HTTP/1.1 ", status.to_s, " ",
                     fetch_status_code(status), line_ending

        no_body ||= status < 200 || STATUS_WITH_NO_ENTITY_BODY[status]
      end
    else
      allow_chunked = false
      keep_alive = env[HTTP_CONNECTION] == KEEP_ALIVE
      include_keepalive_header = keep_alive

      # Same optimization as above for HTTP/1.1
      #
      if status == 200
        lines << HTTP_10_200
      else
        lines.append "HTTP/1.0 ", status.to_s, " ",
                     fetch_status_code(status), line_ending

        no_body ||= status < 200 || STATUS_WITH_NO_ENTITY_BODY[status]
      end
    end

    response_hijack = nil

    headers.each do |k, vs|
      case k
      when CONTENT_LENGTH2
        content_length = vs
        next
      when TRANSFER_ENCODING
        allow_chunked = false
        content_length = nil
      when HIJACK
        response_hijack = vs
        next
      end

      if vs.respond_to?(:to_s)
        vs.to_s.split(NEWLINE).each do |v|
          lines.append k, colon, v, line_ending
        end
      else
        lines.append k, colon, line_ending
      end
    end

    if no_body
      if content_length and status != 204
        lines.append CONTENT_LENGTH_S, content_length.to_s, line_ending
      end

      lines << line_ending
      fast_write client, lines.to_s
      return keep_alive
    end

    if include_keepalive_header
      lines << CONNECTION_KEEP_ALIVE
    elsif !keep_alive
      lines << CONNECTION_CLOSE
    end

    unless response_hijack
      if content_length
        lines.append CONTENT_LENGTH_S, content_length.to_s, line_ending
        chunked = false
      elsif allow_chunked
        lines << TRANSFER_ENCODING_CHUNKED
        chunked = true
      end
    end

    lines << line_ending

    fast_write client, lines.to_s

    if response_hijack
      response_hijack.call client
      return :async
    end

    begin
      res_body.each do |part|
        if chunked
          client.syswrite part.bytesize.to_s(16)
          client.syswrite line_ending
          fast_write client, part
          client.syswrite line_ending
        else
          fast_write client, part
        end

        client.flush
      end

      if chunked
        client.syswrite CLOSE_CHUNKED
        client.flush
      end
    rescue SystemCallError, IOError
      raise ConnectionError, "Connection error detected during write"
    end

  ensure
    uncork_socket client

    body.close
    res_body.close if res_body.respond_to? :close

    after_reply.each { |o| o.call }
  end

  return keep_alive
end

#handle_servers ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/puma/server.rb', line 276

def handle_servers
  begin
    check = @check
    sockets = [check] + @binder.ios
    pool = @thread_pool

    while @status == :run
      begin
        ios = IO.select sockets
        ios.first.each do |sock|
          if sock == check
            break if handle_check
          else
            begin
              if io = sock.accept_nonblock
                c = Client.new io, @binder.env(sock)
                pool << c
              end
            rescue SystemCallError
            end
          end
        end
      rescue Errno::ECONNABORTED
        # client closed the socket even before accept
        client.close rescue nil
      rescue Object => e
        @events.unknown_error self, e, "Listen loop"
      end
    end

    @events.fire :state, @status

    graceful_shutdown if @status == :stop || @status == :restart
    @reactor.clear! if @status == :restart

    @reactor.shutdown
  rescue Exception => e
    STDERR.puts "Exception handling servers: #{e.message} (#{e.class})"
    STDERR.puts e.backtrace
  ensure
    @check.close
    @notify.close

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

  @events.fire :state, :done
end

#handle_servers_lopez_mode ⇒ Object 



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
216
 
# File 'lib/puma/server.rb', line 169

def handle_servers_lopez_mode
  begin
    check = @check
    sockets = [check] + @binder.ios
    pool = @thread_pool

    while @status == :run
      begin
        ios = IO.select sockets
        ios.first.each do |sock|
          if sock == check
            break if handle_check
          else
            begin
              if io = sock.accept_nonblock
                c = Client.new io, nil
                pool << c
              end
            rescue SystemCallError
            end
          end
        end
      rescue Errno::ECONNABORTED
        # client closed the socket even before accept
        client.close rescue nil
      rescue Object => e
        @events.unknown_error self, e, "Listen loop"
      end
    end

    @events.fire :state, @status

    graceful_shutdown if @status == :stop || @status == :restart

  rescue Exception => e
    STDERR.puts "Exception handling servers: #{e.message} (#{e.class})"
    STDERR.puts e.backtrace
  ensure
    @check.close
    @notify.close

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

  @events.fire :state, :done
end

#inherit_binder(bind) ⇒ Object 



88
89
90
91
 
# File 'lib/puma/server.rb', line 88

def inherit_binder(bind)
  @binder = bind
  @own_binder = false
end

#lowlevel_error(e) ⇒ Object

A fallback rack response if @app raises as exception.



705
706
707
708
709
710
711
 
# File 'lib/puma/server.rb', line 705

def lowlevel_error(e)
  if @leak_stack_on_error
    [500, {}, ["Puma caught this error: #{e.message} (#{e.class})\n#{e.backtrace.join("\n")}"]]
  else
    [500, {}, ["A really lowlevel plumbing error occured. Please contact your local Maytag(tm) repair man.\n"]]
  end
end

#normalize_env(env, client) ⇒ Object

Given a Hash env for the request read from client, add and fixup keys to comply with Rack’s env guidelines.



407
408
409
410
411
412
413
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
 
# File 'lib/puma/server.rb', line 407

def normalize_env(env, client)
  if host = env[HTTP_HOST]
    if colon = host.index(":")
      env[SERVER_NAME] = host[0, colon]
      env[SERVER_PORT] = host[colon+1, host.bytesize]
    else
      env[SERVER_NAME] = host
      env[SERVER_PORT] = default_server_port(env)
    end
  else
    env[SERVER_NAME] = LOCALHOST
    env[SERVER_PORT] = default_server_port(env)
  end

  unless env[REQUEST_PATH]
    # it might be a dumbass full host request header
    uri = URI.parse(env[REQUEST_URI])
    env[REQUEST_PATH] = uri.path

    raise "No REQUEST PATH" unless env[REQUEST_PATH]
  end

  env[PATH_INFO] = env[REQUEST_PATH]

  # From http://www.ietf.org/rfc/rfc3875 :
  # "Script authors should be aware that the REMOTE_ADDR and
  # REMOTE_HOST meta-variables (see sections 4.1.8 and 4.1.9)
  # may not identify the ultimate source of the request.
  # They identify the client for the immediate request to the
  # server; that client may be a proxy, gateway, or other
  # intermediary acting on behalf of the actual source client."
  #

  addr = client.peeraddr.last

  # Set unix socket addrs to localhost
  addr = "127.0.0.1" if addr.empty?

  env[REMOTE_ADDR] = addr
end

#process_client(client, buffer) ⇒ Object

Given a connection on client, handle the incoming requests.

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



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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/puma/server.rb', line 352

def process_client(client, buffer)
  begin
    close_socket = true

    while true
      case handle_request(client, buffer)
      when false
        return
      when :async
        close_socket = false
        return
      when true
        buffer.reset

        unless client.reset(@status == :run)
          close_socket = false
          client.set_timeout @persistent_timeout
          @reactor.add client
          return
        end
      end
    end

  # The client disconnected while we were reading data
  rescue ConnectionError
    # Swallow them. The ensure tries to close +client+ down

  # The client doesn't know HTTP well
  rescue HttpParserError => e
    client.write_400

    @events.parse_error self, client.env, e

  # Server error
  rescue StandardError => e
    client.write_500

    @events.unknown_error self, e, "Read"

  ensure
    buffer.reset

    begin
      client.close if close_socket
    rescue IOError, SystemCallError
      # Already closed
    rescue StandardError => e
      @events.unknown_error self, e, "Client"
    end
  end
end

#read_body(env, client, body, cl) ⇒ Object

Given the requset env from client and the partial body body plus a potential Content-Length value cl, finish reading the body and return it.

If the body is larger than MAX_BODY, a Tempfile object is used for the body, otherwise a StringIO is used.



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/puma/server.rb', line 656

def read_body(env, client, body, cl)
  content_length = cl.to_i

  remain = content_length - body.bytesize

  return StringIO.new(body) if remain <= 0

  # Use a Tempfile if there is a lot of data left
  if remain > MAX_BODY
    stream = Tempfile.new(Const::PUMA_TMP_BASE)
    stream.binmode
  else
    # The body[0,0] trick is to get an empty string in the same
    # encoding as body.
    stream = StringIO.new body[0,0]
  end

  stream.write body

  # Read an odd sized chunk so we can read even sized ones
  # after this
  chunk = client.readpartial(remain % CHUNK_SIZE)

  # No chunk means a closed socket
  unless chunk
    stream.close
    return nil
  end

  remain -= stream.write(chunk)

  # Raed the rest of the chunks
  while remain > 0
    chunk = client.readpartial(CHUNK_SIZE)
    unless chunk
      stream.close
      return nil
    end

    remain -= stream.write(chunk)
  end

  stream.rewind

  return stream
end

#run(background = true) ⇒ 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
268
269
270
271
272
273
274
 
# File 'lib/puma/server.rb', line 223

def run(background=true)
  BasicSocket.do_not_reverse_lookup = true

  @events.fire :state, :booting

  @status = :run

  if @mode == :tcp
    return run_lopez_mode(background)
  end

  @thread_pool = ThreadPool.new(@min_threads,
                                @max_threads,
                                IOBuffer) do |client, buffer|
    process_now = false

    begin
      process_now = client.eagerly_finish
    rescue HttpParserError => e
      client.write_400
      client.close

      @events.parse_error self, client.env, e
    rescue ConnectionError
      client.close
    else
      if process_now
        process_client client, buffer
      else
        client.set_timeout @first_data_timeout
        @reactor.add client
      end
    end
  end

  @reactor = Reactor.new self, @thread_pool

  @reactor.run_in_thread

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

  @events.fire :state, :running

  if background
    @thread = Thread.new { handle_servers }
    return @thread
  else
    handle_servers
  end
end

#run_lopez_mode(background = true) ⇒ Object

Lopez Mode == raw tcp apps



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
 
# File 'lib/puma/server.rb', line 132

def run_lopez_mode(background=true)
  @thread_pool = ThreadPool.new(@min_threads,
                                @max_threads,
                                Hash) do |client, tl|

    io = client.to_io
    addr = io.peeraddr.last

    if addr.empty?
      # Set unix socket addrs to localhost
      addr = "127.0.0.1:0"
    else
      addr = "#{addr}:#{io.peeraddr[1]}"
    end

    env = { 'thread' => tl, REMOTE_ADDR => addr }

    begin
      @app.call env, client.to_io
    rescue Object => e
      STDERR.puts "! Detected exception at toplevel: #{e.message} (#{e.class})"
      STDERR.puts e.backtrace
    end

    client.close unless env['detach']
  end

  @events.fire :state, :running

  if background
    @thread = Thread.new { handle_servers_lopez_mode }
    return @thread
  else
    handle_servers_lopez_mode
  end
end

#running ⇒ Object 



126
127
128
 
# File 'lib/puma/server.rb', line 126

def running
  @thread_pool and @thread_pool.spawned
end

#stop(sync = false) ⇒ Object

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



744
745
746
747
748
749
750
751
752
 
# File 'lib/puma/server.rb', line 744

def stop(sync=false)
  begin
    @notify << STOP_COMMAND
  rescue IOError
    # The server, in another thread, is shutting down
  end

  @thread.join if @thread && sync
end

#tcp_mode! ⇒ Object 



93
94
95
 
# File 'lib/puma/server.rb', line 93

def tcp_mode!
  @mode = :tcp
end

#uncork_socket(socket) ⇒ Object 



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

def uncork_socket(socket)
  begin
    socket.setsockopt(6, 3, 0) if socket.kind_of? TCPSocket
  rescue IOError
  end
end