optimize: cached iterator object and reused it, will free it when we … (#20)

* optimize: cached iterator object and reused it, will free it when we need to destroy radixtree object.

Author: membphis

README.md

@@ -151,30 +151,42 @@ make dev
 Benchmark
 =========
 
-This is a test example and the result, on my laptop, a single core CPU can match 1 million times in 1.4 seconds (based on 100,000 routes).
+We wrote some simple benchmark scripts.
+Machine environment: Macbook pro 2015 15-inch i7 2.8G CPU.
 
 ```shell
-$ cat test.lua
-local radix = require("resty.radixtree")
-
-local routes = {}
-for i = 1, 1000 * 100 do
-    routes[i] = {paths = {"/" .. ngx.md5(i) .. "/*"}, metadata = i}
-end
-
-local rx = radix.new(routes)
-
-local res
-local uri = "/" .. ngx.md5(300) .. "/a"
-for _ = 1, 1000 * 1000 do
-    res = rx:match(uri)
-end
-
-ngx.say(res)
-
-$ time resty test.lua
-800
-resty test.lua  1.31s user 0.07s system 100% cpu 1.378 total
+$ make
+cc -O2 -g -Wall -fpic -std=c99 -Wno-pointer-to-int-cast -Wno-int-to-pointer-cast -DBUILDING_SO -c src/rax.c -o src/rax.o
+cc -O2 -g -Wall -fpic -std=c99 -Wno-pointer-to-int-cast -Wno-int-to-pointer-cast -DBUILDING_SO -c src/easy_rax.c -o src/easy_rax.o
+cc -shared -fvisibility=hidden src/rax.o src/easy_rax.o -o librestyradixtree.so
+
+$ resty -I./lib benchmark/match-static.lua
+matched res: 500
+route count: 100000
+match times: 1000000
+time used  : 0.089999914169312 sec
+QPS        : 11111121
+
+$ resty -I./lib benchmark/match-static.lua
+matched res: 500
+route count: 100000
+match times: 1000000
+time used  : 0.094000101089478 sec
+QPS        : 10638286
+
+$ resty -I./lib benchmark/match-prefix.lua
+matched res: 500
+route count: 100000
+match times: 1000000
+time used  : 0.85500001907349 sec
+QPS        : 1169590
+
+$ resty -I./lib benchmark/match-prefix.lua
+matched res: 500
+route count: 100000
+match times: 1000000
+time used  : 0.83500003814697 sec
+QPS        : 1197604
 ```
 
 [Back to TOC](#table-of-contents)

benchmark/match-prefix.lua

@@ -0,0 +1,27 @@
+local radix = require("resty.radixtree")
+local route_count = 1000 * 100
+local match_times = 1000 * 1000
+
+local routes = {}
+for i = 1, route_count do
+    routes[i] = {paths = {"/" .. ngx.md5(i) .. "/*"}, metadata = i}
+end
+
+local rx = radix.new(routes)
+
+ngx.update_time()
+local start_time = ngx.now()
+
+local res
+local uri = "/" .. ngx.md5(500) .. "/a"
+for _ = 1, match_times do
+    res = rx:match(uri)
+end
+
+ngx.update_time()
+local used_time = ngx.now() - start_time
+ngx.say("matched res: ", res)
+ngx.say("route count: ", route_count)
+ngx.say("match times: ", match_times)
+ngx.say("time used  : ", used_time, " sec")
+ngx.say("QPS        : ", math.floor(match_times / used_time))

benchmark/match-static.lua

@@ -0,0 +1,27 @@
+local radix = require("resty.radixtree")
+local route_count = 1000 * 100
+local match_times = 1000 * 1000
+
+local routes = {}
+for i = 1, route_count do
+    routes[i] = {paths = {"/" .. ngx.md5(i)}, metadata = i}
+end
+
+local rx = radix.new(routes)
+
+ngx.update_time()
+local start_time = ngx.now()
+
+local res
+local uri = "/" .. ngx.md5(500)
+for _ = 1, match_times do
+    res = rx:match(uri)
+end
+
+ngx.update_time()
+local used_time = ngx.now() - start_time
+ngx.say("matched res: ", res)
+ngx.say("route count: ", route_count)
+ngx.say("match times: ", match_times)
+ngx.say("time used  : ", used_time, " sec")
+ngx.say("QPS        : ", math.floor(match_times / used_time))

lib/resty/radixtree.lua

@@ -78,7 +78,7 @@ ffi_cdef[[
     int radix_tree_pcre(void *it, const unsigned char *buf, size_t len);
     int radix_tree_stop(void *it);
 
-    void *radix_tree_new_it();
+    void *radix_tree_new_it(void *t);
 ]]
 
 
@@ -290,8 +290,15 @@ function _M.new(routes)
 
     local route_n = #routes
 
+    local tree = radix.radix_tree_new()
+    local tree_it = radix.radix_tree_new_it(tree)
+    if tree_it == nil then
+        error("failed to new radixtree iterator")
+    end
+
     local self = setmt__gc({
-            tree = radix.radix_tree_new(),
+            tree = tree,
+            tree_it = tree_it,
             match_data_index = 0,
             match_data = new_tab(#routes, 0),
             hash_path = new_tab(0, #routes),
@@ -318,12 +325,18 @@ end -- do
 
 
 function _M.free(self)
-    if not self.tree then
-        return
+    local it = self.tree_it
+    if it then
+        radix.radix_tree_stop(it)
+        ffi.C.free(it)
+        self.tree_it = nil
+    end
+
+    if self.tree then
+        radix.radix_tree_destroy(self.tree)
+        self.tree = nil
     end
 
-    radix.radix_tree_destroy(self.tree)
-    self.tree = nil
     return
 end
 
@@ -481,13 +494,6 @@ local function match_route_opts(route, opts)
     return true
 end
 
-    local radix_it = radix.radix_tree_new_it()
-    if radix_it == nil then
-        error("failed to new radixtree it")
-    end
-    -- use gc to free
-    ffi.gc(radix_it, ffi.C.free)
-
 local function _match_from_routes(routes, path, opts)
     for _, route in ipairs(routes) do
         if route.path_op == "=" then
@@ -516,7 +522,7 @@ local function match_route(self, path, opts)
         end
     end
 
-    local it = radix.radix_tree_search(self.tree, radix_it, path, #path)
+    local it = radix.radix_tree_search(self.tree, self.tree_it, path, #path)
     if not it then
         return nil, "failed to match"
     end
@@ -531,13 +537,11 @@ local function match_route(self, path, opts)
         if routes then
             local route = _match_from_routes(routes, path, opts)
             if route then
-                radix.radix_tree_stop(it)
                 return route
             end
         end
     end
 
-    radix.radix_tree_stop(it)
     return nil
 end
 

src/easy_rax.c

@@ -57,13 +57,14 @@ radix_tree_find(void *t, const unsigned char *buf, size_t len)
 
 
 void *
-radix_tree_new_it()
+radix_tree_new_it(void *t)
 {
     raxIterator *it = malloc(sizeof(raxIterator));
     if (it == NULL) {
         return NULL;
     }
 
+    raxStart(it, (rax *)t);
     return (void *)it;
 }
 
@@ -76,7 +77,6 @@ radix_tree_search(void *t, void *it, const unsigned char *buf, size_t len)
         return NULL;
     }
 
-    raxStart(iter, t);
     raxSeek(iter, "<=", (unsigned char *)buf, len);
     return (void *)iter;
 }

src/easy_rax.h

@@ -39,7 +39,7 @@ int radix_tree_pcre(void *it, const unsigned char *buf, size_t len);
 int radix_tree_next(void *it, const unsigned char *buf, size_t len);
 int radix_tree_stop(void *it);
 
-void *radix_tree_new_it();
+void *radix_tree_new_it(void *t);
 
 #ifdef __cplusplus
 }