http2: support upload_limit_rate directive

Author: fdintino

ngx_http_upload_module.c

@@ -935,34 +935,44 @@ ngx_http_upload_read_event_handler(ngx_http_request_t *r)
     ngx_http_request_body_t    *rb;
     ngx_int_t                   rc;
     ngx_chain_t                *in;
+    ssize_t                     n, limit, buf_read_size, next_buf_size, remaining;
+    ngx_msec_t                  delay;
+    ngx_event_t                *rev;
 
     if (ngx_exiting || ngx_terminate) {
         ngx_http_finalize_request(r, NGX_HTTP_CLOSE);
         return;
     }
 
+    rev = r->connection->read;
     rb = r->request_body;
 
     if (rb == NULL) {
         ngx_http_finalize_request(r, NGX_HTTP_INTERNAL_SERVER_ERROR);
         return;
     }
 
+    r->read_event_handler = ngx_http_upload_read_event_handler;
+
     u = ngx_http_get_module_ctx(r, ngx_http_upload_module);
 
-    rc = NGX_OK;
+    for ( ;; ) {
+        buf_read_size = 0;
 
-    in = rb->bufs;
+        for (in = rb->bufs ; in; in = in->next) {
+            n = in->buf->last - in->buf->pos;
+
+            rc = u->data_handler(u, in->buf->pos, in->buf->pos + n);
+
+            in->buf->pos += n;
+            u->received += n;
+            buf_read_size += n;
 
-    for ( ;; ) {
-        while (in) {
-            rc = u->data_handler(u, in->buf->pos, in->buf->last);
             if (rc != NGX_OK) {
                 goto err;
             }
-            in->buf->pos = in->buf->last;
-            in = in->next;
         }
+        rb->bufs = NULL;
 
         // We're done reading the request body, break out of loop
         if (!r->reading_body) {
@@ -974,19 +984,43 @@ ngx_http_upload_read_event_handler(ngx_http_request_t *r)
             }
         }
 
+        // Check whether we have exceeded limit_rate and should delay the next
+        // buffer read
+        if (u->limit_rate) {
+            remaining = ((ssize_t) r->headers_in.content_length_n) - u->received;
+            next_buf_size = (buf_read_size > remaining) ? remaining : buf_read_size;
+            limit = u->limit_rate * (ngx_time() - r->start_sec + 1) - (u->received + next_buf_size);
+            if (limit < 0) {
+                rev->delayed = 1;
+                ngx_add_timer(rev, (ngx_msec_t) ((limit * -1000 / u->limit_rate) + 1));
+                return;
+            }
+        }
+
         rc = ngx_http_read_unbuffered_request_body(r);
 
         if (rc >= NGX_HTTP_SPECIAL_RESPONSE) {
             goto err;
         }
 
-        in = rb->bufs;
-        rb->bufs = NULL;
-
-        if (in == NULL) {
-            r->read_event_handler = ngx_http_upload_read_event_handler;
+        if (rb->bufs == NULL) {
             return;
         }
+
+        // Check whether we should delay processing the latest request body
+        // buffers to stay within limit_rate
+        if (u->limit_rate) {
+            buf_read_size = 0;
+            for (in = rb->bufs ; in; in = in->next) {
+                buf_read_size += (in->buf->last - in->buf->pos);
+            }
+            delay = (ngx_msec_t) (buf_read_size * 1000 / u->limit_rate + 1);
+            if (delay > 0) {
+                rev->delayed = 1;
+                ngx_add_timer(rev, delay);
+                return;
+            }
+        }
     }
 
     // Finally, send the response

t/http2.t

@@ -5,7 +5,7 @@ use File::Basename qw(dirname);
 use lib dirname(__FILE__) . "/lib";
 use Cwd qw(abs_path);
 
-use Test::Nginx::Socket tests => 11;
+use Test::Nginx::Socket tests => 20;
 use Test::Nginx::UploadModule;
 
 $ENV{TEST_DIR} = abs_path(dirname(__FILE__));
@@ -127,3 +127,42 @@ upload_tmp_path = ${ENV{TEST_NGINX_UPLOAD_PATH}}/store/3/0000000003
 }]
 --- upload_file_like eval
 qr/^(??{'x' x 262144})$/
+
+=== Test 4: http2 upload_limit_rate
+--- skip_nginx
+9: < 1.10.0
+--- http2
+--- config
+location = /upload/ {
+    upload_pass @upstream;
+    upload_resumable on;
+    upload_set_form_field "upload_tmp_path" "$upload_tmp_path";
+    upload_limit_rate 32768;
+}
+--- timeout: 5
+--- more_headers eval
+[qq{X-Content-Range: bytes 0-131071/262144
+Session-ID: 0000000004
+Content-Type: text/plain
+Content-Disposition: form-data; name="file"; filename="test.txt"},
+qq{X-Content-Range: bytes 131072-262143/262144
+Session-ID: 0000000004
+Content-Type: text/plain
+Content-Disposition: form-data; name="file"; filename="test.txt"}]
+--- request eval
+[["POST /upload/\r\n",
+"@" . $ENV{TEST_NGINX_UPLOAD_FILE}],
+["POST /upload/\r\n",
+"@" . $ENV{TEST_NGINX_UPLOAD_FILE}]]
+--- error_code eval
+[201, 200]
+--- response_body eval
+["0-131071/262144", qq{upload_tmp_path = ${ENV{TEST_NGINX_UPLOAD_PATH}}/store/4/0000000004
+}]
+--- upload_file_like eval
+qr/^(??{'x' x 262144})$/
+--- access_log eval
+# should have taken 4 seconds, with 1 second possible error
+# (Test::Nginx::UploadModule::http_config adds request time to the end of
+# the access log)
+[qr/[34]\.\d\d\d$/, qr/[34]\.\d\d\d$/]