puma 4.3.6 → 5.3.2

data/docs/systemd.md

@@ -8,14 +8,12 @@ useful features for running Puma in production.
 ## Service Configuration
 
 Below is a sample puma.service configuration file for systemd, which
-can be copied or symlinked to /etc/systemd/system/puma.service, or if
+can be copied or symlinked to `/etc/systemd/system/puma.service`, or if
 desired, using an application or instance specific name.
 
 Note that this uses the systemd preferred "simple" type where the
 start command remains running in the foreground (does not fork and
-exit). See also, the
-[Alternative Forking Configuration](#alternative-forking-configuration)
-below.
+exit).
 
 ~~~~ ini
 [Unit]
@@ -26,8 +24,15 @@ After=network.target
 # Requires=puma.socket
 
 [Service]
-# Foreground process (do not use --daemon in ExecStart or config.rb)
-Type=simple
+# Puma supports systemd's `Type=notify` and watchdog service
+# monitoring, if the [sd_notify](https://github.com/agis/ruby-sdnotify) gem is installed,
+# as of Puma 5.1 or later.
+# On earlier versions of Puma or JRuby, change this to `Type=simple` and remove
+# the `WatchdogSec` line.
+Type=notify
+
+# If your Puma process locks up, systemd's watchdog will restart it within seconds.
+WatchdogSec=10
 
 # Preferably configure a non-privileged user
 # User=
@@ -78,7 +83,7 @@ pass the `--keep-file-descriptors` flag. `bundle exec` can be avoided by using a
 `puma` executable generated by `bundle binstubs puma`. This is tracked in
 [#1499].
 
-**Note:** Socket activation doesn't currently work on jruby. This is
+**Note:** Socket activation doesn't currently work on JRuby. This is
 tracked in [#1367].
 
 To use socket activation, configure one or more `ListenStream` sockets
@@ -124,6 +129,21 @@ Puma will detect the release path socket as different than the one provided by
 systemd and attempt to bind it again, resulting in the exception
  `There is already a server bound to:`.
 
+### Binding
+
+By default you need to configure puma to have binds matching with all
+ListenStream statements. Any mismatched systemd ListenStreams will be closed by
+puma.
+
+To automatically bind to all activated sockets, the option
+`--bind-to-activated-sockets` can be used. This matches the config DSL
+`bind_to_activated_sockets` statement. This will cause puma to create a bind
+automatically for any activated socket. When systemd socket activation is not
+enabled, this option does nothing.
+
+This also accepts an optional argument `only` (DSL: `'only'`) to discard any
+binds that's not socket activated.
+
 ## Usage
 
 Without socket activation, use `systemctl` as root (e.g. via `sudo`) as
@@ -209,66 +229,6 @@ Apr 07 08:40:19 hx puma[28320]: * Activated ssl://0.0.0.0:9234?key=key.pem&cert=
 Apr 07 08:40:19 hx puma[28320]: Use Ctrl-C to stop
 ~~~~
 
-## Alternative Forking Configuration
-
-Other systems/tools might expect or need puma to be run as a
-"traditional" forking server, for example so that the `pumactl`
-command can be used directly and outside of systemd for
-stop/start/restart. This use case is incompatible with systemd socket
-activation, so it should not be configured. Below is an alternative
-puma.service config sample, using `Type=forking` and the `--daemon`
-flag in `ExecStart`. Here systemd is playing a role more equivalent to
-SysV init.d, where it is responsible for starting Puma on boot
-(multi-user.target) and stopping it on shutdown, but is not performing
-continuous restarts. Therefore running Puma in cluster mode, where the
-master can restart workers, is highly recommended. See the systemd
-[Restart] directive for details.
-
-~~~~ ini
-[Unit]
-Description=Puma HTTP Forking Server
-After=network.target
-
-[Service]
-# Background process configuration (use with --daemon in ExecStart)
-Type=forking
-
-# Preferably configure a non-privileged user
-# User=
-
-# The path to the puma application root
-# Also replace the "<WD>" place holders below with this path.
-WorkingDirectory=
-
-# The command to start Puma
-# (replace "<WD>" below)
-ExecStart=bundle exec puma -C <WD>/shared/puma.rb --daemon
-
-# The command to stop Puma
-# (replace "<WD>" below)
-ExecStop=bundle exec pumactl -S <WD>/shared/tmp/pids/puma.state stop
-
-# Path to PID file so that systemd knows which is the master process
-PIDFile=<WD>/shared/tmp/pids/puma.pid
-
-# Should systemd restart puma?
-# Use "no" (the default) to ensure no interference when using
-# stop/start/restart via `pumactl`.  The "on-failure" setting might
-# work better for this purpose, but you must test it.
-# Use "always" if only `systemctl` is used for start/stop/restart, and
-# reconsider if you actually need the forking config.
-Restart=no
-
-# `puma_ctl restart` wouldn't work without this. It's because `pumactl`
-# changes PID on restart and systemd stops the service afterwards
-# because of the PID change. This option prevents stopping after PID
-# change.
-RemainAfterExit=yes
-
-[Install]
-WantedBy=multi-user.target
-~~~~
-
 ### capistrano3-puma
 
 By default,

data/ext/puma_http11/PumaHttp11Service.java

@@ -1,18 +1,16 @@
 package puma;
 
 import java.io.IOException;
-        
+
 import org.jruby.Ruby;
 import org.jruby.runtime.load.BasicLibraryService;
 
 import org.jruby.puma.Http11;
-import org.jruby.puma.IOBuffer;
 import org.jruby.puma.MiniSSL;
 
-public class PumaHttp11Service implements BasicLibraryService { 
+public class PumaHttp11Service implements BasicLibraryService {
     public boolean basicLoad(final Ruby runtime) throws IOException {
         Http11.createHttp11(runtime);
-        IOBuffer.createIOBuffer(runtime);
         MiniSSL.createMiniSSL(runtime);
         return true;
     }

data/ext/puma_http11/ext_help.h

@@ -2,7 +2,7 @@
 #define ext_help_h
 
 #define RAISE_NOT_NULL(T) if(T == NULL) rb_raise(rb_eArgError, "%s", "NULL found for " # T " when shouldn't be.");
-#define DATA_GET(from,type,name) Data_Get_Struct(from,type,name); RAISE_NOT_NULL(name);
+#define DATA_GET(from,type,data_type,name) TypedData_Get_Struct(from,type,data_type,name); RAISE_NOT_NULL(name);
 #define REQUIRE_TYPE(V, T) if(TYPE(V) != T) rb_raise(rb_eTypeError, "%s", "Wrong argument type for " # V " required " # T);
 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
 

data/ext/puma_http11/extconf.rb

@@ -1,9 +1,10 @@
 require 'mkmf'
 
 dir_config("puma_http11")
-if RUBY_PLATFORM[/mingw32/]
-  append_cflags '-D_FORTIFY_SOURCE=2'
-  append_ldflags '-fstack-protector'
+
+if $mingw && RUBY_VERSION >= '2.4'
+  append_cflags  '-fstack-protector-strong -D_FORTIFY_SOURCE=2'
+  append_ldflags '-fstack-protector-strong -l:libssp.a'
   have_library 'ssp'
 end
 
@@ -16,12 +17,25 @@ unless ENV["DISABLE_SSL"]
     have_header "openssl/bio.h"
 
     # below is  yes for 1.0.2 & later
-    have_func  "DTLS_method"                  , "openssl/ssl.h"
+    have_func  "DTLS_method"                           , "openssl/ssl.h"
+
+    # below are yes for 1.1.0 & later
+    have_func  "TLS_server_method"                     , "openssl/ssl.h"
+    have_func  "SSL_CTX_set_min_proto_version(NULL, 0)", "openssl/ssl.h"
+
+    have_func  "X509_STORE_up_ref"
+    have_func("SSL_CTX_set_ecdh_auto(NULL, 0)", "openssl/ssl.h")
+  end
+end
 
-    # below are yes for 1.1.0 & later, may need to check func rather than macro
-    # with versions after 1.1.1
-    have_func  "TLS_server_method"            , "openssl/ssl.h"
-    have_macro "SSL_CTX_set_min_proto_version", "openssl/ssl.h"
+if ENV["MAKE_WARNINGS_INTO_ERRORS"]
+  # Make all warnings into errors
+  # Except `implicit-fallthrough` since most failures comes from ragel state machine generated code
+  if respond_to? :append_cflags
+    append_cflags config_string 'WERRORFLAG'
+    append_cflags '-Wno-implicit-fallthrough'
+  else
+    $CFLAGS += ' ' << (config_string 'WERRORFLAG') << ' -Wno-implicit-fallthrough'
   end
 end
 

data/ext/puma_http11/http11_parser.c

@@ -33,20 +33,18 @@ static void snake_upcase_char(char *c)
 /** Machine **/
 
 
-#line 79 "ext/puma_http11/http11_parser.rl"
+#line 81 "ext/puma_http11/http11_parser.rl"
 
 
 /** Data **/
 
-#line 40 "ext/puma_http11/http11_parser.c"
+#line 42 "ext/puma_http11/http11_parser.c"
 static const int puma_parser_start = 1;
 static const int puma_parser_first_final = 46;
 static const int puma_parser_error = 0;
 
-static const int puma_parser_en_main = 1;
 
-
-#line 83 "ext/puma_http11/http11_parser.rl"
+#line 85 "ext/puma_http11/http11_parser.rl"
 
 int puma_parser_init(puma_parser *parser)  {
   int cs = 0;
@@ -56,7 +54,7 @@ int puma_parser_init(puma_parser *parser)  {
 	cs = puma_parser_start;
 	}
 
-#line 87 "ext/puma_http11/http11_parser.rl"
+#line 89 "ext/puma_http11/http11_parser.rl"
   parser->cs = cs;
   parser->body_start = 0;
   parser->content_len = 0;
@@ -109,7 +107,7 @@ st0:
 cs = 0;
 	goto _out;
 tr0:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st2;
 st2:
@@ -132,7 +130,7 @@ case 2:
 		goto st27;
 	goto st0;
 tr2:
-#line 48 "ext/puma_http11/http11_parser.rl"
+#line 50 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_method(parser, PTR_TO(mark), LEN(mark, p));
   }
@@ -158,7 +156,7 @@ case 3:
 		goto tr5;
 	goto st0;
 tr4:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st4;
 st4:
@@ -172,53 +170,53 @@ case 4:
 	}
 	goto st0;
 tr8:
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st5;
 tr31:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
-#line 54 "ext/puma_http11/http11_parser.rl"
+#line 56 "ext/puma_http11/http11_parser.rl"
 	{
     parser->fragment(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st5;
 tr33:
-#line 54 "ext/puma_http11/http11_parser.rl"
+#line 56 "ext/puma_http11/http11_parser.rl"
 	{
     parser->fragment(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st5;
 tr37:
-#line 67 "ext/puma_http11/http11_parser.rl"
+#line 69 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_path(parser, PTR_TO(mark), LEN(mark,p));
   }
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st5;
 tr41:
-#line 58 "ext/puma_http11/http11_parser.rl"
+#line 60 "ext/puma_http11/http11_parser.rl"
 	{ MARK(query_start, p); }
-#line 59 "ext/puma_http11/http11_parser.rl"
+#line 61 "ext/puma_http11/http11_parser.rl"
 	{
     parser->query_string(parser, PTR_TO(query_start), LEN(query_start, p));
   }
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st5;
 tr44:
-#line 59 "ext/puma_http11/http11_parser.rl"
+#line 61 "ext/puma_http11/http11_parser.rl"
 	{
     parser->query_string(parser, PTR_TO(query_start), LEN(query_start, p));
   }
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
@@ -232,7 +230,7 @@ case 5:
 		goto tr10;
 	goto st0;
 tr10:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st6;
 st6:
@@ -297,21 +295,21 @@ case 13:
 		goto st13;
 	goto st0;
 tr18:
-#line 63 "ext/puma_http11/http11_parser.rl"
+#line 65 "ext/puma_http11/http11_parser.rl"
 	{
     parser->http_version(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st14;
 tr26:
-#line 44 "ext/puma_http11/http11_parser.rl"
+#line 46 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
-#line 45 "ext/puma_http11/http11_parser.rl"
+#line 47 "ext/puma_http11/http11_parser.rl"
 	{
     parser->http_field(parser, PTR_TO(field_start), parser->field_len, PTR_TO(mark), LEN(mark, p));
   }
 	goto st14;
 tr29:
-#line 45 "ext/puma_http11/http11_parser.rl"
+#line 47 "ext/puma_http11/http11_parser.rl"
 	{
     parser->http_field(parser, PTR_TO(field_start), parser->field_len, PTR_TO(mark), LEN(mark, p));
   }
@@ -360,7 +358,7 @@ case 16:
 		goto tr22;
 	goto st0;
 tr22:
-#line 71 "ext/puma_http11/http11_parser.rl"
+#line 73 "ext/puma_http11/http11_parser.rl"
 	{
     parser->body_start = p - buffer + 1;
     parser->header_done(parser, p + 1, pe - p - 1);
@@ -374,13 +372,13 @@ case 46:
 #line 373 "ext/puma_http11/http11_parser.c"
 	goto st0;
 tr21:
-#line 38 "ext/puma_http11/http11_parser.rl"
+#line 40 "ext/puma_http11/http11_parser.rl"
 	{ MARK(field_start, p); }
-#line 39 "ext/puma_http11/http11_parser.rl"
+#line 41 "ext/puma_http11/http11_parser.rl"
 	{ snake_upcase_char((char *)p); }
 	goto st17;
 tr23:
-#line 39 "ext/puma_http11/http11_parser.rl"
+#line 41 "ext/puma_http11/http11_parser.rl"
 	{ snake_upcase_char((char *)p); }
 	goto st17;
 st17:
@@ -413,13 +411,13 @@ case 17:
 		goto tr23;
 	goto st0;
 tr24:
-#line 40 "ext/puma_http11/http11_parser.rl"
+#line 42 "ext/puma_http11/http11_parser.rl"
 	{
     parser->field_len = LEN(field_start, p);
   }
 	goto st18;
 tr27:
-#line 44 "ext/puma_http11/http11_parser.rl"
+#line 46 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st18;
 st18:
@@ -433,7 +431,7 @@ case 18:
 	}
 	goto tr25;
 tr25:
-#line 44 "ext/puma_http11/http11_parser.rl"
+#line 46 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st19;
 st19:
@@ -445,39 +443,39 @@ case 19:
 		goto tr29;
 	goto st19;
 tr9:
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st20;
 tr38:
-#line 67 "ext/puma_http11/http11_parser.rl"
+#line 69 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_path(parser, PTR_TO(mark), LEN(mark,p));
   }
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st20;
 tr42:
-#line 58 "ext/puma_http11/http11_parser.rl"
+#line 60 "ext/puma_http11/http11_parser.rl"
 	{ MARK(query_start, p); }
-#line 59 "ext/puma_http11/http11_parser.rl"
+#line 61 "ext/puma_http11/http11_parser.rl"
 	{
     parser->query_string(parser, PTR_TO(query_start), LEN(query_start, p));
   }
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st20;
 tr45:
-#line 59 "ext/puma_http11/http11_parser.rl"
+#line 61 "ext/puma_http11/http11_parser.rl"
 	{
     parser->query_string(parser, PTR_TO(query_start), LEN(query_start, p));
   }
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
@@ -500,7 +498,7 @@ case 20:
 		goto st0;
 	goto tr30;
 tr30:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st21;
 st21:
@@ -521,7 +519,7 @@ case 21:
 		goto st0;
 	goto st21;
 tr5:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st22;
 st22:
@@ -546,7 +544,7 @@ case 22:
 		goto st22;
 	goto st0;
 tr7:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st23;
 st23:
@@ -566,7 +564,7 @@ case 23:
 		goto st0;
 	goto st23;
 tr6:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st24;
 st24:
@@ -587,7 +585,7 @@ case 24:
 		goto st0;
 	goto st24;
 tr39:
-#line 67 "ext/puma_http11/http11_parser.rl"
+#line 69 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_path(parser, PTR_TO(mark), LEN(mark,p));
   }
@@ -609,7 +607,7 @@ case 25:
 		goto st0;
 	goto tr40;
 tr40:
-#line 58 "ext/puma_http11/http11_parser.rl"
+#line 60 "ext/puma_http11/http11_parser.rl"
 	{ MARK(query_start, p); }
 	goto st26;
 st26:
@@ -1010,7 +1008,7 @@ case 45:
 	_out: {}
 	}
 
-#line 115 "ext/puma_http11/http11_parser.rl"
+#line 117 "ext/puma_http11/http11_parser.rl"
 
   if (!puma_parser_has_error(parser))
     parser->cs = cs;