iodine 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72136c13b8660b82247aa72226d0fc5ef37cdd75
-  data.tar.gz: cf96f47a2b9b0e99f833127ae0db4869ecd33761
+  metadata.gz: 6ad0af726b17fcc350121f1dbacbe34ae47724b9
+  data.tar.gz: 2d30bc235638f7a2e4aa203fb3f25dfa2d78fafe
 SHA512:
-  metadata.gz: 5fb48e67f652c4b01e1ef20ca578a1a0b23cc32a6b80bb681985d52ea00b509239e7e153eb1fae3b738be24b9505e3c3782a53fc9ea7826c28449e95a8113cc9
-  data.tar.gz: a828b6192aa581be423fb18ad6523a42db5edea8765f07f03705ffe56a4cfd0da24908fcb69d6296bfcb4d6333cb66da225c140fe25f0d0852602b296539fb0e
+  metadata.gz: 9f918ab4162ff89e65596bc3154d9bedaad2187a24fa4b2fe0707f06079afddad00e34e8879da340b47f3d5e4a900e83615effe8813db1cc5a99b9c83ff4d635
+  data.tar.gz: cddb06efa79664971a33714811d4c824dd7398d7c1b9573ac0081495b140c7163ebc2b635da466abf7a3465fe3d7c0c73899a855c91c329b923397e662213eb2

data/.gitignore

@@ -12,3 +12,5 @@
 *.so
 
 .ruby-version
+
+.DS_Store

data/CHANGELOG.md

@@ -6,6 +6,16 @@ Please notice that this change log contains changes for upcoming releases as wel
 
 ## Changes:
 
+***
+
+Change log v.0.2.2
+
+**Update** The static file service now supports `ETag` caching, sending a 304 (not changed) response for valid ETags.
+
+**Update**: A performance warning now shows if the CPUs are significantly under-utilized (less than half are used) of if too many are utilized (more than double the amount of CPUs), warning against under-utilization or excessive context switching (respectively).
+
+***
+
 Change log v.0.2.1
 
 **Notice**: The [Rack Websocket Draft](https://github.com/rack/rack/pull/1107) does not support the `each` and `defer` methods. Although I tried to maintain these as part of the draft, the community preferred to leave the implementation of these to the client (rather then the server). If collisions occur, these methods might be removed in the future.

data/README.md

@@ -1,10 +1,12 @@
-# Iodine - a C kqueue/epoll EventMachine alternative (pre-release)
+# Iodine - HTTP / Websocket Server & EventMachine alternative: C kqueue/epoll extension
+[![Logo](https://github.com/boazsegev/iodine/raw/master/logo.png)](https://github.com/boazsegev/iodine)
+
 [![Build Status](https://travis-ci.org/boazsegev/iodine.svg?branch=master)](https://travis-ci.org/boazsegev/iodine)
 [![Gem Version](https://badge.fury.io/rb/iodine.svg)](https://badge.fury.io/rb/iodine)
 [![Inline docs](http://inch-ci.org/github/boazsegev/iodine.svg?branch=master)](http://www.rubydoc.info/github/boazsegev/iodine/master/frames)
 [![GitHub](https://img.shields.io/badge/GitHub-Open%20Source-blue.svg)](https://github.com/boazsegev/iodine)
 
-Iodine 0.2.0 (pre-release) makes writing Object Oriented **Network Services** easy to write.
+Iodine makes writing Object Oriented **Network Services** easy to write.
 
 Iodine is an **evented** framework with a simple API that builds off a low level [C code library](https://github.com/boazsegev/c-server-tools) with support for **epoll** and **kqueue** - this means that:
 
@@ -45,6 +47,8 @@ Puma's model of 16 threads and 4 processes is easily adopted and proved to provi
 bundler exec iodine -p $PORT -t 16 -w 4
 ```
 
+It should be noted that Websocket support means that no automatic process scaling is provided... It is important to use `iodine` with the `-w` option and set the number of desired processes (ideally equal to the number of CPU cores).
+
 ### Static file serving support
 
 Iodine supports static file serving that allows the server to serve static files directly, with no Ruby layer (all from C-land).

data/ext/iodine/http_response.c

@@ -1,4 +1,6 @@
 #include "http.h"
+#include "siphash.h"
+#include "base64.h"
 #include "http_response_http1.h"
 #include <netinet/in.h>
 #include <netinet/ip.h>
@@ -203,6 +205,7 @@ int http_response_sendfile2(http_response_s *response, http_request_s *request,
                             const char *file_path_unsafe,
                             size_t path_unsafe_len, uint8_t log) {
   static char *HEAD = "HEAD";
+  char buffer[64]; /* we'll need this a few times along the way */
   if (request == NULL || (file_path_safe == NULL && file_path_unsafe == NULL))
     return -1;
   http_response_s tmp_response;
@@ -265,10 +268,6 @@ int http_response_sendfile2(http_response_s *response, http_request_s *request,
       http_response_log_start(response);
   }
 
-  if (*((uint32_t *)request->method) == *((uint32_t *)HEAD)) {
-    forward_func(response, response_finish, response);
-  }
-
   // we have a file, time to handle response details.
   int file = open(fname, O_RDONLY);
   if (file == -1) {
@@ -286,12 +285,31 @@ int http_response_sendfile2(http_response_s *response, http_request_s *request,
                                  .name_length = 12, .value = mime);
     }
   }
+  /* add ETag */
+  uint64_t sip = file_data.st_size;
+  sip ^= file_data.st_mtime;
+  sip = siphash24(&sip, sizeof(uint64_t), SIPHASH_DEFAULT_KEY);
+  bscrypt_base64_encode(buffer, (void *)&sip, 8);
+  http_response_write_header(response, .name = "ETag", .name_length = 4,
+                             .value = buffer, .value_length = 12);
 
   response->last_modified = file_data.st_mtime;
   http_response_write_header(response, .name = "Cache-Control",
                              .name_length = 13, .value = "public, max-age=3600",
                              .value_length = 20);
 
+  /* check etag */
+  if ((ext = http_request_find_header(request, "if-none-match", 13)) &&
+      memcmp(ext, buffer, 12) == 0) {
+    /* send back 304 */
+    response->status = 304;
+    close(file);
+    perform_func(response, response_finish, response);
+    if (log)
+      http_response_log_finish(response);
+    return 0;
+  }
+
   // Range handling
   if ((ext = http_request_find_header(request, "range", 5)) &&
       (ext[0] | 32) == 'b' && (ext[1] | 32) == 'y' && (ext[2] | 32) == 't' &&
@@ -320,7 +338,6 @@ int http_response_sendfile2(http_response_s *response, http_request_s *request,
     // going to the EOF (big chunk or EOL requested) - send as file
     if (finish >= file_data.st_size)
       finish = file_data.st_size;
-    char buffer[64];
     char *pos = buffer + 6;
     memcpy(buffer, "bytes ", 6);
     pos += http_ul2a(pos, start);
@@ -336,6 +353,15 @@ int http_response_sendfile2(http_response_s *response, http_request_s *request,
                                .name_length = 13, .value = "bytes",
                                .value_length = 5);
 
+    if (*((uint32_t *)request->method) == *((uint32_t *)HEAD)) {
+      response->content_length = 0;
+      close(file);
+      perform_func(response, response_finish, response);
+      if (log)
+        http_response_log_finish(response);
+      return 0;
+    }
+
     http_response_sendfile(response, file, start, finish - start + 1);
     if (log)
       http_response_log_finish(response);
@@ -347,6 +373,15 @@ invalid_range:
                              .name_length = 13, .value = "none",
                              .value_length = 4);
 
+  if (*((uint32_t *)request->method) == *((uint32_t *)HEAD)) {
+    response->content_length = 0;
+    close(file);
+    perform_func(response, response_finish, response);
+    if (log)
+      http_response_log_finish(response);
+    return 0;
+  }
+
   http_response_sendfile(response, file, 0, file_data.st_size);
   if (log)
     http_response_log_finish(response);

data/ext/iodine/iodine_core.c

@@ -550,10 +550,27 @@ Running the server
 */
 
 static void *srv_start_no_gvl(void *_) {
+  // collect requested settings
   VALUE rb_th_i = rb_iv_get(Iodine, "@threads");
   VALUE rb_pr_i = rb_iv_get(Iodine, "@processes");
   size_t threads = (TYPE(rb_th_i) == T_FIXNUM) ? FIX2ULONG(rb_th_i) : 0;
   size_t processes = (TYPE(rb_pr_i) == T_FIXNUM) ? FIX2ULONG(rb_pr_i) : 0;
+// print a warnning if settings are sub optimal
+#ifdef _SC_NPROCESSORS_ONLN
+  size_t cpu_count = sysconf(_SC_NPROCESSORS_ONLN);
+  if ((processes << 1) < cpu_count || processes > (cpu_count << 1))
+    fprintf(
+        stderr, "* Performance warnning:\n"
+                "  - This computer has %lu CPUs available and you'll be "
+                "utilizing %lu processes.\n  - %s\n"
+                "  - Use the command line option: `-w %lu`\n"
+                "  - Or, within Ruby: `Iodine.processes = %lu`\n",
+        cpu_count, processes,
+        (processes < cpu_count
+             ? "Some CPUs won't be utilized, inhibiting performance."
+             : "This causes excessive context switches, wasting resources."),
+        cpu_count, cpu_count);
+#endif
   server_run(.threads = threads, .processes = processes);
   return NULL;
 }

data/lib/iodine.rb

@@ -30,6 +30,14 @@ module Iodine
   @threads = (ARGV.index('-t') && ARGV[ARGV.index('-t') + 1]) || ENV['MAX_THREADS']
   @processes = (ARGV.index('-w') && ARGV[ARGV.index('-w') + 1]) || ENV['MAX_WORKERS']
   @threads = @threads.to_i if @threads
+  if @processes == 'auto'
+    begin
+      require 'etc'
+      @processes = Etc.nprocessors
+    rescue Exception
+      warn "This version of Ruby doesn't support automatic CPU core detection."
+    end
+  end
   @processes = @processes.to_i if @processes
 
   # Get/Set the number of threads used in the thread pool (a static thread pool). Can be 1 (single working thread, the main thread will sleep) and can be 0 (the main thread will be used as the only active thread).

data/lib/iodine/version.rb

@@ -1,3 +1,3 @@
 module Iodine
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iodine
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-29 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -172,6 +172,7 @@ files:
 - lib/iodine/protocol.rb
 - lib/iodine/version.rb
 - lib/rack/handler/iodine.rb
+- logo.png
 homepage: https://github.com/boazsegev/iodine
 licenses:
 - MIT