From ee9ed5f58ca1390617595b3b22eb574fdd67a788 Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
Date: Sun, 6 Sep 2009 14:29:54 -0700
Subject: http: verbose assertions

This makes it easier for bug reporters to tell us what's
wrong in case line numbers change.
---
 ext/unicorn_http/c_util.h                    |  2 +-
 ext/unicorn_http/common_field_optimization.h |  3 ++-
 ext/unicorn_http/unicorn_http.rl             | 21 +++++++++++----------
 3 files changed, 14 insertions(+), 12 deletions(-)

(limited to 'ext')

diff --git a/ext/unicorn_http/c_util.h b/ext/unicorn_http/c_util.h
index 04fd05d..0ab9b31 100644
--- a/ext/unicorn_http/c_util.h
+++ b/ext/unicorn_http/c_util.h
@@ -56,7 +56,7 @@ static int hexchar2int(int xdigit)
     return xdigit - 'a' + 10;
 
   /* Ragel already does runtime range checking for us in Unicorn: */
-  assert(xdigit >= '0' && xdigit <= '9');
+  assert(xdigit >= '0' && xdigit <= '9' && "invalid digit character");
 
   return xdigit - '0';
 }
diff --git a/ext/unicorn_http/common_field_optimization.h b/ext/unicorn_http/common_field_optimization.h
index a714368..850fb90 100644
--- a/ext/unicorn_http/common_field_optimization.h
+++ b/ext/unicorn_http/common_field_optimization.h
@@ -103,7 +103,8 @@ static VALUE uncommon_field(const char *field, size_t flen)
   VALUE f = rb_str_new(NULL, HTTP_PREFIX_LEN + flen);
   memcpy(RSTRING_PTR(f), HTTP_PREFIX, HTTP_PREFIX_LEN);
   memcpy(RSTRING_PTR(f) + HTTP_PREFIX_LEN, field, flen);
-  assert(*(RSTRING_PTR(f) + RSTRING_LEN(f)) == '\0'); /* paranoia */
+  assert(*(RSTRING_PTR(f) + RSTRING_LEN(f)) == '\0' &&
+         "string didn't end with \\0"); /* paranoia */
   return rb_obj_freeze(f);
 }
 
diff --git a/ext/unicorn_http/unicorn_http.rl b/ext/unicorn_http/unicorn_http.rl
index 1f22dfb..0ab8d78 100644
--- a/ext/unicorn_http/unicorn_http.rl
+++ b/ext/unicorn_http/unicorn_http.rl
@@ -142,7 +142,7 @@ static void write_cont_value(struct http_parser *hp,
   if (!hp->cont)
     rb_raise(eHttpParserError, "invalid continuation line");
 
-  assert(hp->mark > 0);
+  assert(hp->mark > 0 && "impossible continuation line offset");
 
   if (LEN(mark, p) == 0)
     return;
@@ -153,7 +153,7 @@ static void write_cont_value(struct http_parser *hp,
   vptr = (char *)PTR_TO(mark);
 
   if (RSTRING_LEN(hp->cont) > 0) {
-    assert(' ' == *vptr || '\t' == *vptr);
+    assert((' ' == *vptr || '\t' == *vptr) && "invalid leading white space");
     *vptr = ' ';
   }
   rb_str_buf_cat(hp->cont, vptr, LEN(mark, p));
@@ -280,7 +280,7 @@ static void write_value(VALUE req, struct http_parser *hp,
       if (HP_FL_TEST(hp, CHUNKED))
         cs = http_parser_en_ChunkedBody;
     } else {
-      assert(!HP_FL_TEST(hp, CHUNKED));
+      assert(!HP_FL_TEST(hp, CHUNKED) && "chunked encoding without body!");
     }
     /*
      * go back to Ruby so we can call the Rack application, we'll reenter
@@ -313,7 +313,7 @@ static void write_value(VALUE req, struct http_parser *hp,
     hp->s.dest_offset += nr;
     hp->len.chunk -= nr;
     p += nr;
-    assert(hp->len.chunk >= 0);
+    assert(hp->len.chunk >= 0 && "negative chunk length");
     if (hp->len.chunk > REMAINING) {
       HP_FL_SET(hp, INCHUNK);
       goto post_exec;
@@ -374,7 +374,7 @@ static struct http_parser *data_get(VALUE self)
   struct http_parser *hp;
 
   Data_Get_Struct(self, struct http_parser, hp);
-  assert(hp);
+  assert(hp && "failed to extract http_parser struct");
   return hp;
 }
 
@@ -473,7 +473,7 @@ static void advance_str(VALUE str, off_t nr)
 
   rb_str_modify(str);
 
-  assert(nr <= len);
+  assert(nr <= len && "trying to advance past end of buffer");
   len -= nr;
   if (len > 0) /* unlikely, len is usually 0 */
     memmove(RSTRING_PTR(str), RSTRING_PTR(str) + nr, len);
@@ -626,19 +626,20 @@ static VALUE HttpParser_filter_body(VALUE self, VALUE buf, VALUE data)
       if (hp->cs == http_parser_error)
         rb_raise(eHttpParserError, "Invalid HTTP format, parsing fails.");
 
-      assert(hp->s.dest_offset <= hp->start.offset);
+      assert(hp->s.dest_offset <= hp->start.offset &&
+             "destination buffer overflow");
       advance_str(data, hp->start.offset);
       rb_str_set_len(buf, hp->s.dest_offset);
 
       if (RSTRING_LEN(buf) == 0 && chunked_eof(hp)) {
-        assert(hp->len.chunk == 0);
+        assert(hp->len.chunk == 0 && "chunk at EOF but more to parse");
       } else {
         data = Qnil;
       }
     }
   } else {
     /* no need to enter the Ragel machine for unchunked transfers */
-    assert(hp->len.content >= 0);
+    assert(hp->len.content >= 0 && "negative Content-Length");
     if (hp->len.content > 0) {
       long nr = MIN(dlen, hp->len.content);
 
@@ -657,7 +658,7 @@ static VALUE HttpParser_filter_body(VALUE self, VALUE buf, VALUE data)
 
 #define SET_GLOBAL(var,str) do { \
   var = find_common_field(str, sizeof(str) - 1); \
-  assert(var != Qnil); \
+  assert(var != Qnil && "missed global field"); \
 } while (0)
 
 void Init_unicorn_http(void)
-- 
cgit v1.2.3-24-ge0c7