agoo 2.0.5 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69a2baa46cde1aaa305d41b6396ce5e78ffc207d0225b910faf280e2beb18749
-  data.tar.gz: b8ff1ffd30767c254ba0849d3e90593a0ccd687fe15db9b211c21fe4b8d5f98b
+  metadata.gz: 729ca7dab10faf0c9196e1297f814dc06471f5de2948a04e4a3d074067f042d6
+  data.tar.gz: 65f231b27c3eb5db90db659e920090fc075ffece27f65753d9769c32157f540d
 SHA512:
-  metadata.gz: 6d120ee1e1008a9d0fb0382b4f56af522b8eb3e553258632089596d5e506eab7d7d03f221b7275a9f1268e132d4281e0bf0210dd35e69da105d5f12ab1cf7c75
-  data.tar.gz: 2f90130a772f81b444c27ff5d3d4e148de5d8bf971a01d30b93edb9405ca6dc8a0fd57ef7ad4d4cccd3b7501049985dfd4a9945350556e7be1b66d9eb4592cb5
+  metadata.gz: 8135b9c196acc16c80a81aa532d55f8452c1008f4ab22cd285a3f327655cf66f2f4b4f6177c9e7d3781f05964dde9ffb2d238f0808acd5c0150f95bd58eeec24
+  data.tar.gz: 7943dc936c2cb113054f04f2780185bbe80d9c62ab94e7a601874219ece58ee2c2ba5f3e8f71e4b23bb8ba24f3a31526bd944ea3351fd62a452c45bf06c0f187

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+### 2.1.0 - 2018-05-10
+
+- This is a minor release even though the API has changed. The changed API is the one for Rack based WebSocket and SSE connection upgrades. The PR for the spec addition is currently stalled but some suggestions for a stateless API are implemented in this release. The proposed Rack SPEC is [here](misc/SPEC). The PR is [here](https://github.com/rack/rack/pull/1272)
+
+- Publish and subscribe to WebSocket and SSE connections now available. An example in the push subdirectory demonstrates how it works.
+
+- Slight performance boost.
+
 ### 2.0.5 - 2018-05-06
 
 - Changed to putting all the path on the `REQUEST_PATH` variable instead of the `SCRIPT_NAME` to accomodate Rails which only uses the `REQUEST_PATH`.

data/README.md

@@ -22,7 +22,10 @@ end
 handler = MyHandler.new
 Agoo::Server.handle(:GET, "/hello", handler)
 Agoo::Server.start()
-# To run this example type the following then go to a browser and enter a URL of localhost:6464/hello.
+
+# To run this example type the following then go to a browser and enter a URL
+# of localhost:6464/hello.
+#
 # ruby hello.rb
 ```
 
@@ -45,7 +48,7 @@ href="https://github.com/ohler55/perfer">Perfer</a> to hit the Agoo
 limits. Ruby benchmarks driver could not push Agoo hard enough.
 
 Agoo supports the [Ruby rack API](https://rack.github.io) which allows for the
-use of rack compatible gems. Agoo also supports WebSockets and SSE.
+use of rack compatible gems such as Hanami and Rails. Agoo also supports WebSockets and SSE.
 
 ## Releases
 

data/ext/agoo/agoo.c

@@ -8,11 +8,11 @@
 #include "debug.h"
 #include "error_stream.h"
 #include "log.h"
+#include "pub.h"
 #include "rack_logger.h"
 #include "request.h"
 #include "response.h"
 #include "server.h"
-#include "subscription.h"
 #include "upgraded.h"
 
 void
@@ -34,6 +34,38 @@ ragoo_shutdown(VALUE self) {
     return Qnil;
 }
 
+/* Document-method: publish
+ *
+ * call-seq: publish(subject, message)
+ *
+ * Publish a message on the given subject.
+ */
+VALUE
+ragoo_publish(VALUE self, VALUE subject, VALUE message) {
+    rb_check_type(subject, T_STRING);
+    rb_check_type(message, T_STRING);
+
+    queue_push(&the_server.pub_queue, pub_publish(StringValuePtr(subject), (int)RSTRING_LEN(subject),
+						  StringValuePtr(message), (int)RSTRING_LEN(message)));
+
+    return Qnil;
+}
+
+/* Document-method: unsubscribe
+ *
+ * call-seq: unsubscribe(subject)
+ *
+ * Unsubscribes on client listeners on the specified subject.
+ */
+static VALUE
+ragoo_unsubscribe(VALUE self, VALUE subject) {
+    rb_check_type(subject, T_STRING);
+
+    queue_push(&the_server.pub_queue, pub_unsubscribe(NULL, StringValuePtr(subject), (int)RSTRING_LEN(subject)));
+
+    return Qnil;
+}
+
 static void
 sig_handler(int sig) {
     agoo_shutdown();
@@ -60,10 +92,11 @@ Init_agoo() {
     request_init(mod);
     response_init(mod);
     server_init(mod);
-    subscription_init(mod);
     upgraded_init(mod);
 
     rb_define_module_function(mod, "shutdown", ragoo_shutdown, 0);
+    rb_define_module_function(mod, "publish", ragoo_publish, 2);
+    rb_define_module_function(mod, "unsubscribe", ragoo_unsubscribe, 1);
 
     signal(SIGINT, sig_handler);
     signal(SIGTERM, sig_handler);

data/ext/agoo/con.c

@@ -12,19 +12,19 @@
 #include "res.h"
 #include "server.h"
 #include "sse.h"
+#include "subject.h"
+#include "upgraded.h"
 #include "websocket.h"
 
-#define MAX_SOCK	4096
-#define CON_TIMEOUT	5.0
+#define CON_TIMEOUT		5.0
+#define INITIAL_POLL_SIZE	1024
+
+extern void	agoo_shutdown();
 
 Con
 con_create(Err err, int sock, uint64_t id) {
     Con	c;
 
-    if (MAX_SOCK <= sock) {
-	err_set(err, ERR_TOO_MANY, "Too many connections.");
-	return NULL;
-    }
     if (NULL == (c = (Con)malloc(sizeof(struct _Con)))) {
 	err_set(err, ERR_MEMORY, "Failed to allocate memory for a connection.");
     } else {
@@ -50,9 +50,9 @@ con_destroy(Con c) {
     if (NULL != c->req) {
 	request_destroy(c->req);
     }
-    if (NULL != c->slot) {
-	cc_remove_con(&the_server.con_cache, c->id);
-	c->slot = NULL;
+    if (NULL != c->up) {
+	upgraded_release_con(c->up);
+	c->up = NULL;
     }
     DEBUG_FREE(mem_con, c)
     free(c);
@@ -94,7 +94,7 @@ bad_request(Con c, int status, int line) {
     Res		res;
     const char *msg = http_code_message(status);
     
-    if (NULL == (res = res_create())) {
+    if (NULL == (res = res_create(c))) {
 	log_cat(&error_cat, "memory allocation of response failed on connection %llu @ %d.", c->id, line);
     } else {
 	char	buf[256];
@@ -254,7 +254,7 @@ con_header_read(Con c) {
 		}
 		return bad_request(c, 404, __LINE__);
 	    }
-    	    if (NULL == (res = res_create())) {
+    	    if (NULL == (res = res_create(c))) {
 		return bad_request(c, 500, __LINE__);
 	    }
 	    if (NULL == c->res_tail) {
@@ -266,6 +266,9 @@ con_header_read(Con c) {
 
 	    b = strstr(c->buf, "\r\n");
 	    res->close = should_close(b, (int)(hend - b));
+	    if (res->close) {
+		c->closing = true;
+	    }
 	    res_set_message(res, p->resp);
 
 	    return -mlen;
@@ -287,7 +290,7 @@ HOOKED:
     c->req->msg[mlen] = '\0';
     c->req->method = method;
     c->req->upgrade = UP_NONE;
-    c->req->cid = c->id;
+    c->req->up = NULL;
     c->req->path.start = c->req->msg + (path - c->buf);
     c->req->path.len = (int)(pend - path);
     c->req->query.start = c->req->msg + (query - c->buf);
@@ -339,7 +342,10 @@ check_upgrade(Con c) {
 static bool
 con_http_read(Con c) {
     ssize_t	cnt;
-    
+
+    if (c->dead || 0 == c->sock || c->closing) {
+	return true;
+    }
     if (NULL != c->req) {
 	cnt = recv(c->sock, c->req->msg + c->bcnt, c->req->mlen - c->bcnt, 0);
     } else {
@@ -390,7 +396,7 @@ con_http_read(Con c) {
 		if (debug_cat.on && NULL != c->req && NULL != c->req->body.start) {
 		    log_cat(&debug_cat, "request on %llu: %s", c->id, c->req->body.start);
 		}
-		if (NULL == (res = res_create())) {
+		if (NULL == (res = res_create(c))) {
 		    c->req = NULL;
 		    log_cat(&error_cat, "memory allocation of response failed on connection %llu.", c->id);
 		    return bad_request(c, 500, __LINE__);
@@ -402,6 +408,9 @@ con_http_read(Con c) {
 		    }
 		    c->res_tail = res;
 		    res->close = should_close(c->req->header.start, c->req->header.len);
+		    if (res->close) {
+			c->closing = true;
+		    }
 		}
 		c->req->res = res;
 		mlen = c->req->mlen;
@@ -493,6 +502,7 @@ con_ws_read(Con c) {
 		    }
 		}
 	    }
+	    upgraded_ref(c->up);
 	    queue_push(&the_server.eval_queue, (void*)c->req);
 	    if (mlen < (long)c->bcnt) {
 		memmove(c->buf, c->buf + mlen, c->bcnt - mlen);
@@ -657,14 +667,15 @@ con_ws_write(Con c) {
 	}
 	c->wcnt = 0;
 	res_destroy(res);
-	if (1 == (pending = atomic_fetch_sub(&c->slot->pending, 1))) {
-	    if (NULL != c->slot && Qnil != c->slot->handler && c->slot->on_empty) {
+	if (1 == (pending = atomic_fetch_sub(&c->up->pending, 1))) {
+	    if (NULL != c->up && Qnil != c->up->handler && c->up->on_empty) {
 		Req	req = request_create(0);
 	    
-		req->cid = c->id;
+		req->up = c->up;
 		req->method = ON_EMPTY;
 		req->handler_type = PUSH_HOOK;
-		req->handler = c->slot->handler;
+		req->handler = c->up->handler;
+		upgraded_ref(c->up);
 		queue_push(&the_server.eval_queue, (void*)req);
 	    }
 	}
@@ -718,14 +729,15 @@ con_sse_write(Con c) {
 	}
 	c->wcnt = 0;
 	res_destroy(res);
-	if (1 == (pending = atomic_fetch_sub(&c->slot->pending, 1))) {
-	    if (NULL != c->slot && Qnil != c->slot->handler && c->slot->on_empty) {
+	if (1 == (pending = atomic_fetch_sub(&c->up->pending, 1))) {
+	    if (NULL != c->up && Qnil != c->up->handler && c->up->on_empty) {
 		Req	req = request_create(0);
 	    
-		req->cid = c->id;
+		req->up = c->up;
 		req->method = ON_EMPTY;
 		req->handler_type = PUSH_HOOK;
-		req->handler = c->slot->handler;
+		req->handler = c->up->handler;
+		upgraded_ref(c->up);
 		queue_push(&the_server.eval_queue, (void*)req);
 	    }
 	}
@@ -754,66 +766,103 @@ con_write(Con c) {
     }
     if (kind != c->kind) {
 	c->kind = kind;
+	/*
 	if (CON_HTTP != kind && !remove) {
-	    c->slot = cc_set_con(&the_server.con_cache, c);
+	    // TBD add to up_list now or later?
+	    //c->slot = cc_set_con(&the_server.con_cache, c);
 	}
+	*/
     }
     return remove;
 }
 
+static void
+publish_pub(Pub pub) {
+    Upgraded	up;
+    const char	*sub = pub->subject->pattern;
+
+    for (up = the_server.up_list; NULL != up; up = up->next) {
+	if (NULL != up->con && upgraded_match(up, sub)) {
+	    Res	res = res_create(up->con);
+
+	    if (NULL != res) {
+		if (NULL == up->con->res_tail) {
+		    up->con->res_head = res;
+		} else {
+		    up->con->res_tail->next = res;
+		}
+		up->con->res_tail = res;
+		res->con_kind = up->con->kind;
+		res_set_message(res, text_dup(pub->msg));
+	    }
+	}
+    }
+}
+
+static void
+unsubscribe_pub(Pub pub) {
+    if (NULL == pub->up) {
+	Upgraded	up;
+
+	for (up = the_server.up_list; NULL != up; up = up->next) {
+	    upgraded_del_subject(up, pub->subject);
+	}
+    } else {
+	upgraded_del_subject(pub->up, pub->subject);
+    }
+}
+
 static void
 process_pub_con(Pub pub) {
-    CSlot	slot;
+    Upgraded	up = pub->up;
 
     switch (pub->kind) {
     case PUB_CLOSE:
-	if (NULL == (slot = cc_get_slot(&the_server.con_cache, pub->cid)) || NULL == slot->con) {
-	    log_cat(&warn_cat, "Socket %llu already closed.", pub->cid);
-	    pub_destroy(pub);	
-	    return;
-	} else {
-	    Res	res = res_create();;
+	// An close after already closed is used to decrement the reference
+	// count on the upgraded so it can be destroyed in the con loop
+	// threads.
+	if (NULL != up->con) {
+	    Res	res = res_create(up->con);
 
 	    if (NULL != res) {
-		if (NULL == slot->con->res_tail) {
-		    slot->con->res_head = res;
+		if (NULL == up->con->res_tail) {
+		    up->con->res_head = res;
 		} else {
-		    slot->con->res_tail->next = res;
+		    up->con->res_tail->next = res;
 		}
-		slot->con->res_tail = res;
-		res->con_kind = slot->con->kind;
+		up->con->res_tail = res;
+		res->con_kind = up->con->kind;
 		res->close = true;
 	    }
 	}
 	break;
     case PUB_WRITE: {
-	if (NULL == (slot = cc_get_slot(&the_server.con_cache, pub->cid)) || NULL == slot->con) {
-	    log_cat(&warn_cat, "Socket %llu already closed. WebSocket write failed.", pub->cid);
-	    pub_destroy(pub);	
-	    return;
+	if (NULL == up->con) {
+	    log_cat(&warn_cat, "Connection already closed. WebSocket write failed.");
 	} else {
-	    Res	res = res_create();
+	    Res	res = res_create(up->con);
 
 	    if (NULL != res) {
-		if (NULL == slot->con->res_tail) {
-		    slot->con->res_head = res;
+		if (NULL == up->con->res_tail) {
+		    up->con->res_head = res;
 		} else {
-		    slot->con->res_tail->next = res;
+		    up->con->res_tail->next = res;
 		}
-		slot->con->res_tail = res;
-		res->con_kind = slot->con->kind;
+		up->con->res_tail = res;
+		res->con_kind = up->con->kind;
 		res_set_message(res, pub->msg);
 	    }
 	}
 	break;
     case PUB_SUB:
-	// TBD handle a subscribe when implementing pub/sub 
+	upgraded_add_subject(pub->up, pub->subject);
+	pub->subject = NULL;
 	break;
     case PUB_UN:
-	// TBD handle a subscribe when implementing pub/sub 
+	unsubscribe_pub(pub);
 	break;
     case PUB_MSG:
-	// TBD handle a subscribe when implementing pub/sub 
+	publish_pub(pub);
 	break;
     }
     default:
@@ -823,12 +872,7 @@ process_pub_con(Pub pub) {
 }
 
 static struct pollfd*
-poll_setup(Con *ca, int ccnt, struct pollfd *pp) {
-    Con		*cp;
-    Con		*end = ca + MAX_SOCK;
-    Con		c;
-    int		i;
-
+poll_setup(Con c, struct pollfd *pp) {
     // The first two pollfd are for the con_queue and the pub_queue in that
     // order.
     pp->fd = queue_listen(&the_server.con_queue);
@@ -839,11 +883,10 @@ poll_setup(Con *ca, int ccnt, struct pollfd *pp) {
     pp->events = POLLIN;
     pp->revents = 0;
     pp++;
-    for (i = ccnt, cp = ca; 0 < i && cp < end; cp++) {
-	if (NULL == *cp) {
+    for (; NULL != c; c = c->next) {
+	if (c->dead) {
 	    continue;
 	}
-	c = *cp;
 	c->pp = pp;
 	pp->fd = c->sock;
 	pp->events = 0;
@@ -851,14 +894,14 @@ poll_setup(Con *ca, int ccnt, struct pollfd *pp) {
 	case CON_HTTP:
 	    if (NULL != c->res_head && NULL != res_message(c->res_head)) {
 		pp->events = POLLIN | POLLOUT;
-	    } else {
+	    } else if (!c->closing) {
 		pp->events = POLLIN;
 	    }
 	    break;
 	case CON_WS:
 	    if (NULL != c->res_head && (c->res_head->close || c->res_head->ping || NULL != res_message(c->res_head))) {
 		pp->events = POLLIN | POLLOUT;
-	    } else {
+	    } else if (!c->closing) {
 		pp->events = POLLIN;
 	    }
 	    break;
@@ -872,39 +915,67 @@ poll_setup(Con *ca, int ccnt, struct pollfd *pp) {
 	    break;
 	}
 	pp->revents = 0;
-	i--;
 	pp++;
     }
     return pp;
 }
 
+static bool
+remove_dead_res(Con c) {
+    Res	res;
+
+    while (NULL != (res = c->res_head)) {
+	if (NULL == res_message(c->res_head) && !c->res_head->close && !c->res_head->ping) {
+	    break;
+	}
+	c->res_head = res->next;
+	if (res == c->res_tail) {
+	    c->res_tail = NULL;
+	}
+	res_destroy(res);
+    }
+    return NULL == c->res_head;
+}
+
 void*
 con_loop(void *x) {
     Con			c;
-    Con			ca[MAX_SOCK + 2];
-    struct pollfd	pa[MAX_SOCK + 2];
+    Con			prev;
+    Con			next;
+    Con			cons = NULL;
+    size_t		size = sizeof(struct pollfd) * INITIAL_POLL_SIZE;
+    struct pollfd	*pa = (struct pollfd*)malloc(size);
+    struct pollfd	*pend = pa + INITIAL_POLL_SIZE;
     struct pollfd	*pp;
-    Con			*end = ca + MAX_SOCK;
-    Con			*cp;
     int			ccnt = 0;
     int			i;
-    long		mcnt = 0;
     double		now;
     Pub			pub;
     
     atomic_fetch_add(&the_server.running, 1);
-    memset(ca, 0, sizeof(ca));
-    memset(pa, 0, sizeof(pa));
+    memset(pa, 0, size);
     while (the_server.active) {
 	while (NULL != (c = (Con)queue_pop(&the_server.con_queue, 0.0))) {
-	    mcnt++;
-	    ca[c->sock] = c;
+	    c->next = cons;
+	    cons = c;
 	    ccnt++;
+	    if (pend - pa < ccnt + 2) {
+		size_t	cnt = (pend - pa) * 2;
+
+		size = sizeof(struct pollfd) * cnt;
+		if (NULL == (pa = (struct pollfd*)malloc(size))) {
+		    log_cat(&error_cat, "Out of memory.");
+		    agoo_shutdown();
+		    return NULL;
+		}
+		pend = pa + cnt;
+	    }
 	}
 	while (NULL != (pub = (Pub)queue_pop(&the_server.pub_queue, 0.0))) {
 	    process_pub_con(pub);
 	}
-	pp = poll_setup(ca, ccnt, pa);
+	
+	pp = poll_setup(cons, pa);
 	if (0 > (i = poll(pa, (nfds_t)(pp - pa), 100))) {
 	    if (EAGAIN == errno) {
 		continue;
@@ -920,9 +991,20 @@ con_loop(void *x) {
 	    if (0 != (pa->revents & POLLIN)) {
 		queue_release(&the_server.con_queue);
 		while (NULL != (c = (Con)queue_pop(&the_server.con_queue, 0.0))) {
-		    mcnt++;
-		    ca[c->sock] = c;
+		    c->next = cons;
+		    cons = c;
 		    ccnt++;
+		    if (pend - pa < ccnt + 2) {
+			size_t	cnt = (pend - pa) * 2;
+
+			size = sizeof(struct pollfd) * cnt;
+			if (NULL == (pa = (struct pollfd*)malloc(size))) {
+			    log_cat(&error_cat, "Out of memory.");
+			    agoo_shutdown();
+			    return NULL;
+			}
+			pend = pa + cnt;
+		    }
 		}
 	    }
 	    // Check pub_queue if an event is waiting.
@@ -933,21 +1015,23 @@ con_loop(void *x) {
 		}
 	    }
 	}
-	for (i = ccnt, cp = ca; 0 < i && cp < end; cp++) {
-	    if (NULL == *cp || 0 == (*cp)->sock || NULL == (*cp)->pp) {
+	prev = NULL;
+	for (c = cons; NULL != c; c = next) {
+	    next = c->next;
+	    if (0 == c->sock || NULL == c->pp) {
 		continue;
 	    }
-	    c = *cp;
-	    i--;
 	    pp = c->pp;
 	    if (0 != (pp->revents & POLLIN)) {
 		if (con_read(c)) {
-		    goto CON_RM;
+		    c->dead = true;
+		    goto CON_CHECK;
 		}
 	    }
 	    if (0 != (pp->revents & POLLOUT)) {
 		if (con_write(c)) {
-		    goto CON_RM;
+		    c->dead = true;
+		    goto CON_CHECK;
 		}
 	    }
 	    if (0 != (pp->revents & (POLLERR | POLLHUP | POLLNVAL))) {
@@ -958,12 +1042,21 @@ con_loop(void *x) {
 			log_cat(&error_cat, "Socket %llu error. %s", c->id, strerror(errno));
 		    }
 		}
-		goto CON_RM;
+		c->dead = true;
+		goto CON_CHECK;
 	    }
-	    if (0.0 == c->timeout || now < c->timeout) { 
+	CON_CHECK:
+	    if (c->dead) {
+		if (remove_dead_res(c)) {
+		    goto CON_RM;
+		}
+	    } else if (0.0 == c->timeout || now < c->timeout) {
+		prev = c;
 		continue;
 	    } else if (c->closing) {
-		goto CON_RM;
+		if (remove_dead_res(c)) {
+		    goto CON_RM;
+		}
 	    } else if (CON_WS == c->kind || CON_SSE == c->kind) {
 		c->timeout = dtime() + CON_TIMEOUT;
 		ws_ping(c);
@@ -972,20 +1065,25 @@ con_loop(void *x) {
 		c->closing = true;
 		c->timeout = now + 0.5;
 		//wush_text_set(&c->resp, (char*)close_resp, sizeof(close_resp) - 1, false);
+		prev = c;
 		continue;
 	    }
+	    prev = c;
 	    continue;
 	CON_RM:
-	    ca[c->sock] = NULL;
+	    if (NULL == prev) {
+		cons = next;
+	    } else {
+		prev->next = next;
+	    }
 	    ccnt--;
 	    log_cat(&con_cat, "Connection %llu closed.", c->id);
 	    con_destroy(c);
 	}
     }
-    for (i = ccnt, cp = ca; 0 < i && cp < end; cp++) {
-	if (NULL != *cp) {
-	    con_destroy(*cp);
-	}
+    while (NULL != (c = cons)) {
+	cons = c->next;
+	con_destroy(c);
     }
     atomic_fetch_sub(&the_server.running, 1);