raindrops 0.13.0 → 0.19.2

data/ext/raindrops/raindrops.c

@@ -38,7 +38,7 @@ struct raindrops {
 };
 
 /* called by GC */
-static void gcfree(void *ptr)
+static void rd_free(void *ptr)
 {
 	struct raindrops *r = ptr;
 
@@ -51,11 +51,24 @@ static void gcfree(void *ptr)
 	xfree(ptr);
 }
 
+static size_t rd_memsize(const void *ptr)
+{
+	const struct raindrops *r = ptr;
+
+	return r->drops == MAP_FAILED ? 0 : raindrop_size * r->capa;
+}
+
+static const rb_data_type_t rd_type = {
+	"raindrops",
+	{ NULL, rd_free, rd_memsize, /* reserved */ },
+	/* parent, data, [ flags ] */
+};
+
 /* automatically called at creation (before initialize) */
 static VALUE alloc(VALUE klass)
 {
 	struct raindrops *r;
-	VALUE rv = Data_Make_Struct(klass, struct raindrops, NULL, gcfree, r);
+	VALUE rv = TypedData_Make_Struct(klass, struct raindrops, &rd_type, r);
 
 	r->drops = MAP_FAILED;
 	return rv;
@@ -65,7 +78,7 @@ static struct raindrops *get(VALUE self)
 {
 	struct raindrops *r;
 
-	Data_Get_Struct(self, struct raindrops, r);
+	TypedData_Get_Struct(self, struct raindrops, &rd_type, r);
 
 	if (r->drops == MAP_FAILED)
 		rb_raise(rb_eStandardError, "invalid or freed Raindrops");
@@ -104,7 +117,9 @@ retry:
 	r->drops = mmap(NULL, tmp,
 	                PROT_READ|PROT_WRITE, MAP_ANON|MAP_SHARED, -1, 0);
 	if (r->drops == MAP_FAILED) {
-		if ((errno == EAGAIN || errno == ENOMEM) && tries-- > 0) {
+		int err = errno;
+
+		if ((err == EAGAIN || err == ENOMEM) && tries-- > 0) {
 			rb_gc();
 			goto retry;
 		}
@@ -140,7 +155,9 @@ static void resize(struct raindrops *r, size_t new_rd_size)
 
 	rv = mremap(old_address, old_size, new_size, MREMAP_MAYMOVE);
 	if (rv == MAP_FAILED) {
-		if (errno == EAGAIN || errno == ENOMEM) {
+		int err = errno;
+
+		if (err == EAGAIN || err == ENOMEM) {
 			rb_gc();
 			rv = mremap(old_address, old_size, new_size, 0);
 		}
@@ -323,7 +340,9 @@ static VALUE aref(VALUE self, VALUE index)
 
 #ifdef __linux__
 void Init_raindrops_linux_inet_diag(void);
-void Init_raindrops_linux_tcp_info(void);
+#endif
+#ifdef HAVE_TYPE_STRUCT_TCP_INFO
+void Init_raindrops_tcp_info(void);
 #endif
 
 #ifndef _SC_NPROCESSORS_CONF
@@ -428,6 +447,8 @@ void Init_raindrops_ext(void)
 
 #ifdef __linux__
 	Init_raindrops_linux_inet_diag();
-	Init_raindrops_linux_tcp_info();
+#endif
+#ifdef HAVE_TYPE_STRUCT_TCP_INFO
+	Init_raindrops_tcp_info();
 #endif
 }

data/ext/raindrops/tcp_info.c

@@ -0,0 +1,245 @@
+#include <ruby.h>
+#include <sys/socket.h>
+#include <netinet/in.h>
+#if defined(HAVE_LINUX_TCP_H)
+#  include <linux/tcp.h>
+#else
+#  if defined(HAVE_NETINET_TCP_H)
+#    include <netinet/tcp.h>
+#  endif
+#  if defined(HAVE_NETINET_TCP_FSM_H)
+#    include <netinet/tcp_fsm.h>
+#  endif
+#endif
+
+#ifdef HAVE_TYPE_STRUCT_TCP_INFO
+#include "my_fileno.h"
+
+CFUNC_tcp_info_tcpi_state
+CFUNC_tcp_info_tcpi_ca_state
+CFUNC_tcp_info_tcpi_retransmits
+CFUNC_tcp_info_tcpi_probes
+CFUNC_tcp_info_tcpi_backoff
+CFUNC_tcp_info_tcpi_options
+CFUNC_tcp_info_tcpi_snd_wscale
+CFUNC_tcp_info_tcpi_rcv_wscale
+CFUNC_tcp_info_tcpi_rto
+CFUNC_tcp_info_tcpi_ato
+CFUNC_tcp_info_tcpi_snd_mss
+CFUNC_tcp_info_tcpi_rcv_mss
+CFUNC_tcp_info_tcpi_unacked
+CFUNC_tcp_info_tcpi_sacked
+CFUNC_tcp_info_tcpi_lost
+CFUNC_tcp_info_tcpi_retrans
+CFUNC_tcp_info_tcpi_fackets
+CFUNC_tcp_info_tcpi_last_data_sent
+CFUNC_tcp_info_tcpi_last_ack_sent
+CFUNC_tcp_info_tcpi_last_data_recv
+CFUNC_tcp_info_tcpi_last_ack_recv
+CFUNC_tcp_info_tcpi_pmtu
+CFUNC_tcp_info_tcpi_rcv_ssthresh
+CFUNC_tcp_info_tcpi_rtt
+CFUNC_tcp_info_tcpi_rttvar
+CFUNC_tcp_info_tcpi_snd_ssthresh
+CFUNC_tcp_info_tcpi_snd_cwnd
+CFUNC_tcp_info_tcpi_advmss
+CFUNC_tcp_info_tcpi_reordering
+CFUNC_tcp_info_tcpi_rcv_rtt
+CFUNC_tcp_info_tcpi_rcv_space
+CFUNC_tcp_info_tcpi_total_retrans
+
+static size_t tcpi_memsize(const void *ptr)
+{
+	return sizeof(struct tcp_info);
+}
+
+static const rb_data_type_t tcpi_type = {
+	"tcp_info",
+	{ NULL, RUBY_TYPED_DEFAULT_FREE, tcpi_memsize, /* reserved */ },
+	/* parent, data, [ flags ] */
+};
+
+static VALUE alloc(VALUE klass)
+{
+	struct tcp_info *info;
+
+	return TypedData_Make_Struct(klass, struct tcp_info, &tcpi_type, info);
+}
+
+/*
+ * call-seq:
+ *
+ *	Raindrops::TCP_Info.new(tcp_socket)	-> TCP_Info object
+ *
+ * Reads a TCP_Info object from any given +tcp_socket+.  See the tcp(7)
+ * manpage and /usr/include/linux/tcp.h for more details.
+ */
+static VALUE init(VALUE self, VALUE io)
+{
+	int fd = my_fileno(io);
+	struct tcp_info *info = DATA_PTR(self);
+	socklen_t len = (socklen_t)sizeof(struct tcp_info);
+	int rc = getsockopt(fd, IPPROTO_TCP, TCP_INFO, info, &len);
+
+	if (rc != 0)
+		rb_sys_fail("getsockopt");
+
+	return self;
+}
+
+void Init_raindrops_tcp_info(void)
+{
+	VALUE cRaindrops = rb_define_class("Raindrops", rb_cObject);
+	VALUE cTCP_Info;
+
+	/*
+	 * Document-class: Raindrops::TCP_Info
+	 *
+	 * This is used to wrap "struct tcp_info" as described in tcp(7)
+	 * and /usr/include/linux/tcp.h.  The following readers methods
+	 * are defined corresponding to the "tcpi_" fields in the
+	 * tcp_info struct.
+	 *
+	 * As of raindrops 0.18.0+, this is supported on FreeBSD and OpenBSD
+	 * systems as well as Linux, although not all fields exist or
+	 * match the documentation, below.
+	 *
+	 * In particular, the +last_data_recv+ field is useful for measuring
+	 * the amount of time a client spent in the listen queue before
+	 * +accept()+, but only if +TCP_DEFER_ACCEPT+ is used with the
+	 * listen socket (it is on by default in Unicorn).
+	 *
+	 * - state
+	 * - ca_state
+	 * - retransmits
+	 * - probes
+	 * - backoff
+	 * - options
+	 * - snd_wscale
+	 * - rcv_wscale
+	 * - rto
+	 * - ato
+	 * - snd_mss
+	 * - rcv_mss
+	 * - unacked
+	 * - sacked
+	 * - lost
+	 * - retrans
+	 * - fackets
+	 * - last_data_sent
+	 * - last_ack_sent
+	 * - last_data_recv
+	 * - last_ack_recv
+	 * - pmtu
+	 * - rcv_ssthresh
+	 * - rtt
+	 * - rttvar
+	 * - snd_ssthresh
+	 * - snd_cwnd
+	 * - advmss
+	 * - reordering
+	 * - rcv_rtt
+	 * - rcv_space
+	 * - total_retrans
+	 *
+	 * https://kernel.org/doc/man-pages/online/pages/man7/tcp.7.html
+	 */
+	cTCP_Info = rb_define_class_under(cRaindrops, "TCP_Info", rb_cObject);
+	rb_define_alloc_func(cTCP_Info, alloc);
+	rb_define_private_method(cTCP_Info, "initialize", init, 1);
+
+	/*
+	 * Document-method: Raindrops::TCP_Info#get!
+	 *
+	 * call-seq:
+	 *
+	 *	info = Raindrops::TCP_Info.new(tcp_socket)
+	 *	info.get!(tcp_socket)
+	 *
+	 * Update an existing TCP_Info objects with the latest stats
+	 * from the given socket.  This even allows sharing TCP_Info
+	 * objects between different sockets to avoid garbage.
+	 */
+	rb_define_method(cTCP_Info, "get!", init, 1);
+
+	DEFINE_METHOD_tcp_info_tcpi_state;
+	DEFINE_METHOD_tcp_info_tcpi_ca_state;
+	DEFINE_METHOD_tcp_info_tcpi_retransmits;
+	DEFINE_METHOD_tcp_info_tcpi_probes;
+	DEFINE_METHOD_tcp_info_tcpi_backoff;
+	DEFINE_METHOD_tcp_info_tcpi_options;
+	DEFINE_METHOD_tcp_info_tcpi_snd_wscale;
+	DEFINE_METHOD_tcp_info_tcpi_rcv_wscale;
+	DEFINE_METHOD_tcp_info_tcpi_rto;
+	DEFINE_METHOD_tcp_info_tcpi_ato;
+	DEFINE_METHOD_tcp_info_tcpi_snd_mss;
+	DEFINE_METHOD_tcp_info_tcpi_rcv_mss;
+	DEFINE_METHOD_tcp_info_tcpi_unacked;
+	DEFINE_METHOD_tcp_info_tcpi_sacked;
+	DEFINE_METHOD_tcp_info_tcpi_lost;
+	DEFINE_METHOD_tcp_info_tcpi_retrans;
+	DEFINE_METHOD_tcp_info_tcpi_fackets;
+	DEFINE_METHOD_tcp_info_tcpi_last_data_sent;
+	DEFINE_METHOD_tcp_info_tcpi_last_ack_sent;
+	DEFINE_METHOD_tcp_info_tcpi_last_data_recv;
+	DEFINE_METHOD_tcp_info_tcpi_last_ack_recv;
+	DEFINE_METHOD_tcp_info_tcpi_pmtu;
+	DEFINE_METHOD_tcp_info_tcpi_rcv_ssthresh;
+	DEFINE_METHOD_tcp_info_tcpi_rtt;
+	DEFINE_METHOD_tcp_info_tcpi_rttvar;
+	DEFINE_METHOD_tcp_info_tcpi_snd_ssthresh;
+	DEFINE_METHOD_tcp_info_tcpi_snd_cwnd;
+	DEFINE_METHOD_tcp_info_tcpi_advmss;
+	DEFINE_METHOD_tcp_info_tcpi_reordering;
+	DEFINE_METHOD_tcp_info_tcpi_rcv_rtt;
+	DEFINE_METHOD_tcp_info_tcpi_rcv_space;
+	DEFINE_METHOD_tcp_info_tcpi_total_retrans;
+
+#ifdef RAINDROPS_TCP_STATES_ALL_KNOWN
+
+	/*
+	 * Document-const: Raindrops::TCP
+         *
+         * This is a frozen hash storing the numeric values
+         * maps platform-independent symbol keys to
+         * platform-dependent numeric values. These states
+         * are all valid values for the Raindrops::TCP_Info#state field.
+         *
+         * The platform-independent names of the keys in this hash are:
+         *
+         *  - :ESTABLISHED
+         *  - :SYN_SENT
+         *  - :SYN_RECV
+         *  - :FIN_WAIT1
+         *  - :FIN_WAIT2
+         *  - :TIME_WAIT
+         *  - :CLOSE
+         *  - :CLOSE_WAIT
+         *  - :LAST_ACK
+         *  - :LISTEN
+         *  - :CLOSING
+         *
+         * This is only supported on platforms where TCP_Info is supported,
+         * currently FreeBSD, OpenBSD, and Linux-based systems.
+         */
+	{
+#define TCPSET(n,v) rb_hash_aset(tcp, ID2SYM(rb_intern(#n)), INT2NUM(v))
+		VALUE tcp = rb_hash_new();
+		TCPSET(ESTABLISHED, RAINDROPS_TCP_ESTABLISHED);
+		TCPSET(SYN_SENT, RAINDROPS_TCP_SYN_SENT);
+		TCPSET(SYN_RECV, RAINDROPS_TCP_SYN_RECV);
+		TCPSET(FIN_WAIT1, RAINDROPS_TCP_FIN_WAIT1);
+		TCPSET(FIN_WAIT2, RAINDROPS_TCP_FIN_WAIT2);
+		TCPSET(TIME_WAIT, RAINDROPS_TCP_TIME_WAIT);
+		TCPSET(CLOSE, RAINDROPS_TCP_CLOSE);
+		TCPSET(CLOSE_WAIT, RAINDROPS_TCP_CLOSE_WAIT);
+		TCPSET(LAST_ACK, RAINDROPS_TCP_LAST_ACK);
+		TCPSET(LISTEN, RAINDROPS_TCP_LISTEN);
+		TCPSET(CLOSING, RAINDROPS_TCP_CLOSING);
+#undef TCPSET
+		OBJ_FREEZE(tcp);
+		rb_define_const(cRaindrops, "TCP", tcp);
+	}
+#endif
+}
+#endif /* HAVE_STRUCT_TCP_INFO */

data/lib/raindrops.rb

@@ -12,7 +12,7 @@
 # Unlike many classes in this package, the core Raindrops class is
 # intended to be portable to all reasonably modern *nix systems
 # supporting mmap().  Please let us know if you have portability
-# issues, patches or pull requests at mailto:raindrops@librelist.org
+# issues, patches or pull requests at mailto:raindrops-public@yhbt.net
 class Raindrops
 
   # Used to represent the number of +active+ and +queued+ sockets for

data/lib/raindrops/aggregate.rb

@@ -1,6 +1,6 @@
 # -*- encoding: binary -*-
 #
-# raindrops may use the {aggregate}[http://github.com/josephruscio/aggregate]
+# raindrops may use the {aggregate}[https://github.com/josephruscio/aggregate]
 # RubyGem to aggregate statistics from TCP_Info lookups.
 module Raindrops::Aggregate
   autoload :PMQ, "raindrops/aggregate/pmq"

data/lib/raindrops/aggregate/last_data_recv.rb

@@ -13,10 +13,6 @@
 # - Kgio::TCPServer#kgio_accept
 # - Kgio::TCPServer#kgio_tryaccept
 module Raindrops::Aggregate::LastDataRecv
-  # :stopdoc:
-  TCP_Info = Raindrops::TCP_Info
-  # :startdoc:
-
   # The integer value of +last_data_recv+ is sent to this object.
   # This is usually a duck type compatible with the \Aggregate class,
   # but can be *anything* that accepts the *<<* method.
@@ -78,7 +74,7 @@ def accept_nonblock
   # +last_data_recv+ to be accurate
   def count!(io)
     if io
-      x = TCP_Info.new(io)
+      x = Raindrops::TCP_Info.new(io)
       @raindrops_aggregate << x.last_data_recv
     end
     io

data/lib/raindrops/aggregate/pmq.rb

@@ -3,10 +3,10 @@
 require "aggregate"
 require "posix_mq"
 require "fcntl"
-require "io/extra"
 require "thread"
+require "stringio"
 
-# \Aggregate + POSIX message queues support for Ruby 1.9 and \Linux
+# \Aggregate + POSIX message queues support for Ruby 1.9+ and \Linux
 #
 # This class is duck-type compatible with \Aggregate and allows us to
 # aggregate and share statistics from multiple processes/threads aided
@@ -14,12 +14,11 @@
 # Raindrops::LastDataRecv Rack application, but can be used independently
 # on compatible Runtimes.
 #
-# Unlike the core of raindrops, this is only supported on Ruby 1.9 and
-# Linux 2.6.  Using this class requires the following additional RubyGems
+# Unlike the core of raindrops, this is only supported on Ruby 1.9+ and
+# Linux 2.6+.  Using this class requires the following additional RubyGems
 # or libraries:
 #
 # * aggregate (tested with 0.2.2)
-# * io-extra  (tested with 1.2.3)
 # * posix_mq  (tested with 1.0.0)
 #
 # == Design
@@ -39,9 +38,9 @@ class Raindrops::Aggregate::PMQ
   # :stopdoc:
   # These constants are for Linux.  This is designed for aggregating
   # TCP_INFO.
-  RDLOCK = [ Fcntl::F_RDLCK ].pack("s @256")
-  WRLOCK = [ Fcntl::F_WRLCK ].pack("s @256")
-  UNLOCK = [ Fcntl::F_UNLCK ].pack("s @256")
+  RDLOCK = [ Fcntl::F_RDLCK ].pack("s @256".freeze).freeze
+  WRLOCK = [ Fcntl::F_WRLCK ].pack("s @256".freeze).freeze
+  UNLOCK = [ Fcntl::F_UNLCK ].pack("s @256".freeze).freeze
   # :startdoc:
 
   # returns the number of dropped messages sent to a POSIX message
@@ -84,6 +83,7 @@ def initialize(params = {})
       @wr = File.open(t.path, "wb")
       @rd = File.open(t.path, "rb")
     end
+    @wr.sync = true
     @cached_aggregate = @aggregate
     flush_master
     @mq_send = if opts[:lossy]
@@ -142,8 +142,8 @@ def master_loop
       warn "Unhandled exception in #{__FILE__}:#{__LINE__}: #{e}"
       break
     end while true
-    ensure
-      flush_master
+  ensure
+    flush_master
   end
 
   # Loads the last shared \Aggregate from the master thread/process
@@ -151,7 +151,10 @@ def aggregate
     @cached_aggregate ||= begin
       flush
       Marshal.load(synchronize(@rd, RDLOCK) do |rd|
-        IO.pread rd.fileno, rd.stat.size, 0
+        dst = StringIO.new
+        dst.binmode
+        IO.copy_stream(rd, dst, rd.size, 0)
+        dst.string
       end)
     end
   end
@@ -163,7 +166,8 @@ def flush_master
     dump = Marshal.dump @aggregate
     synchronize(@wr, WRLOCK) do |wr|
       wr.truncate 0
-      IO.pwrite wr.fileno, dump, 0
+      wr.rewind
+      wr.write(dump)
     end
   end
 
@@ -171,24 +175,26 @@ def flush_master
   # worker thread or process
   def stop_master_loop
     sleep 0.1 until mq_send(false)
-    rescue Errno::EINTR
-      retry
+  rescue Errno::EINTR
+    retry
   end
 
   def lock! io, type # :nodoc:
     io.fcntl Fcntl::F_SETLKW, type
-    rescue Errno::EINTR
-      retry
+  rescue Errno::EINTR
+    retry
   end
 
   # we use both a mutex for thread-safety and fcntl lock for process-safety
   def synchronize io, type # :nodoc:
     @mutex.synchronize do
       begin
+        type = type.dup
         lock! io, type
         yield io
       ensure
-        lock! io, UNLOCK
+        lock! io, type.replace(UNLOCK)
+        type.clear
       end
     end
   end