feature: added support for ARM64 (Aarch64).

now we require OpenResty's LuaJIT branch to work properly on ARM64 since
we make use of the thread.exdata Lua API.

On architectures other than ARM64, the thread.exdata API also saves the
per-request global env table and closure objects for each light thread,
which gives a nice ~10% speedup for the simplest Lua handler location
loaded by wrk over HTTP 1.1.

We now use proper userdata instead of lightuserdata for the
ngx.shared.DICT Lua objects.

we also mask off the bits higher than 47-bit of lightuserdata keys based
on C static variable addresses.

We also implemented the pure C API for the ndk.* API (to be used in
lua-resty-core).

Thanks Dejiang Zhu and Zexuan Luo for the development work of this patch.

Thanks Cloudflare for sponsoring this work.

Signed-off-by: Yichun Zhang (agentzh) <[email protected]>

Author: doujiang24

.travis.yml

@@ -72,7 +72,7 @@ install:
   - git clone https://github.com/openresty/no-pool-nginx.git ../no-pool-nginx
   - git clone https://github.com/openresty/openresty-devel-utils.git
   - git clone https://github.com/openresty/mockeagain.git
-  - git clone https://github.com/openresty/lua-cjson.git
+  - git clone https://github.com/openresty/lua-cjson.git lua-cjson
   - git clone https://github.com/openresty/lua-upstream-nginx-module.git ../lua-upstream-nginx-module
   - git clone https://github.com/openresty/echo-nginx-module.git ../echo-nginx-module
   - git clone https://github.com/openresty/nginx-eval-module.git ../nginx-eval-module
@@ -89,7 +89,7 @@ install:
   - git clone https://github.com/openresty/lua-resty-lrucache.git ../lua-resty-lrucache
   - git clone https://github.com/openresty/lua-resty-mysql.git ../lua-resty-mysql
   - git clone https://github.com/openresty/stream-lua-nginx-module.git ../stream-lua-nginx-module
-  - git clone -b v2.1-agentzh https://github.com/openresty/luajit2.git
+  - git clone -b v2.1-agentzh https://github.com/openresty/luajit2.git luajit2
 
 before_script:
   - mysql -uroot -e 'create database ngx_test; grant all on ngx_test.* to "ngx_test"@"%" identified by "ngx_test"; flush privileges;'

src/ngx_http_lua_accessby.c

@@ -261,9 +261,11 @@ ngx_http_lua_access_by_chunk(lua_State *L, ngx_http_request_t *r)
     /*  move code closure to new coroutine */
     lua_xmove(L, co, 1);
 
+#ifndef OPENRESTY_LUAJIT
     /*  set closure's env table to new coroutine's globals table */
     ngx_http_lua_get_globals_table(co);
     lua_setfenv(co, -2);
+#endif
 
     /*  save nginx request in coroutine globals table */
     ngx_http_lua_set_req(co, r);

src/ngx_http_lua_balancer.c

@@ -362,6 +362,8 @@ ngx_http_lua_balancer_by_chunk(lua_State *L, ngx_http_request_t *r)
 
     /* init nginx context in Lua VM */
     ngx_http_lua_set_req(L, r);
+
+#ifndef OPENRESTY_LUAJIT
     ngx_http_lua_create_new_globals_table(L, 0 /* narr */, 1 /* nrec */);
 
     /*  {{{ make new env inheriting main thread's globals table */
@@ -372,6 +374,7 @@ ngx_http_lua_balancer_by_chunk(lua_State *L, ngx_http_request_t *r)
     /*  }}} */
 
     lua_setfenv(L, -2);    /*  set new running env for the code closure */
+#endif /* OPENRESTY_LUAJIT */
 
     lua_pushcfunction(L, ngx_http_lua_traceback);
     lua_insert(L, 1);  /* put it under chunk and args */

src/ngx_http_lua_bodyfilterby.c

@@ -32,10 +32,6 @@ static void ngx_http_lua_body_filter_by_lua_env(lua_State *L,
 static ngx_http_output_body_filter_pt ngx_http_next_body_filter;
 
 
-/* key for the ngx_chain_t *in pointer in the Lua thread */
-#define ngx_http_lua_chain_key  "__ngx_cl"
-
-
 /**
  * Set environment table for the given code closure.
  *
@@ -51,12 +47,14 @@ static void
 ngx_http_lua_body_filter_by_lua_env(lua_State *L, ngx_http_request_t *r,
     ngx_chain_t *in)
 {
-    /*  set nginx request pointer to current lua thread's globals table */
+    ngx_http_lua_main_conf_t    *lmcf;
+
     ngx_http_lua_set_req(L, r);
 
-    lua_pushlightuserdata(L, in);
-    lua_setglobal(L, ngx_http_lua_chain_key);
+    lmcf = ngx_http_get_module_main_conf(r, ngx_http_lua_module);
+    lmcf->body_filter_chain = in;
 
+#ifndef OPENRESTY_LUAJIT
     /**
      * we want to create empty environment for current script
      *
@@ -79,6 +77,7 @@ ngx_http_lua_body_filter_by_lua_env(lua_State *L, ngx_http_request_t *r,
     /*  }}} */
 
     lua_setfenv(L, -2);    /*  set new running env for the code closure */
+#endif /* OPENRESTY_LUAJIT */
 }
 
 
@@ -236,8 +235,8 @@ ngx_http_lua_body_filter(ngx_http_request_t *r, ngx_chain_t *in)
     ngx_int_t                    rc;
     uint16_t                     old_context;
     ngx_http_cleanup_t          *cln;
-    lua_State                   *L;
     ngx_chain_t                 *out;
+    ngx_http_lua_main_conf_t    *lmcf;
 
     ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
                    "lua body filter for user lua code, uri \"%V\"", &r->uri);
@@ -299,11 +298,8 @@ ngx_http_lua_body_filter(ngx_http_request_t *r, ngx_chain_t *in)
         return NGX_ERROR;
     }
 
-    L = ngx_http_lua_get_lua_vm(r, ctx);
-
-    lua_getglobal(L, ngx_http_lua_chain_key);
-    out = lua_touserdata(L, -1);
-    lua_pop(L, 1);
+    lmcf = ngx_http_get_module_main_conf(r, ngx_http_lua_module);
+    out = lmcf->body_filter_chain;
 
     if (in == out) {
         return ngx_http_next_body_filter(r, in);
@@ -345,7 +341,7 @@ ngx_http_lua_body_filter_init(void)
 
 
 int
-ngx_http_lua_body_filter_param_get(lua_State *L)
+ngx_http_lua_body_filter_param_get(lua_State *L, ngx_http_request_t *r)
 {
     u_char              *data, *p;
     size_t               size;
@@ -354,6 +350,8 @@ ngx_http_lua_body_filter_param_get(lua_State *L)
     int                  idx;
     ngx_chain_t         *in;
 
+    ngx_http_lua_main_conf_t    *lmcf;
+
     idx = luaL_checkint(L, 2);
 
     dd("index: %d", idx);
@@ -363,8 +361,8 @@ ngx_http_lua_body_filter_param_get(lua_State *L)
         return 1;
     }
 
-    lua_getglobal(L, ngx_http_lua_chain_key);
-    in = lua_touserdata(L, -1);
+    lmcf = ngx_http_get_module_main_conf(r, ngx_http_lua_module);
+    in = lmcf->body_filter_chain;
 
     if (idx == 2) {
         /* asking for the eof argument */
@@ -442,6 +440,8 @@ ngx_http_lua_body_filter_param_set(lua_State *L, ngx_http_request_t *r,
     ngx_chain_t             *cl;
     ngx_chain_t             *in;
 
+    ngx_http_lua_main_conf_t    *lmcf;
+
     idx = luaL_checkint(L, 2);
 
     dd("index: %d", idx);
@@ -450,13 +450,13 @@ ngx_http_lua_body_filter_param_set(lua_State *L, ngx_http_request_t *r,
         return luaL_error(L, "bad index: %d", idx);
     }
 
+    lmcf = ngx_http_get_module_main_conf(r, ngx_http_lua_module);
+
     if (idx == 2) {
         /* overwriting the eof flag */
         last = lua_toboolean(L, 3);
 
-        lua_getglobal(L, ngx_http_lua_chain_key);
-        in = lua_touserdata(L, -1);
-        lua_pop(L, 1);
+        in = lmcf->body_filter_chain;
 
         if (last) {
             ctx->seen_last_in_filter = 1;
@@ -521,9 +521,7 @@ ngx_http_lua_body_filter_param_set(lua_State *L, ngx_http_request_t *r,
     case LUA_TNIL:
         /* discard the buffers */
 
-        lua_getglobal(L, ngx_http_lua_chain_key); /* key val */
-        in = lua_touserdata(L, -1);
-        lua_pop(L, 1);
+        in = lmcf->body_filter_chain;
 
         last = 0;
 
@@ -557,9 +555,7 @@ ngx_http_lua_body_filter_param_set(lua_State *L, ngx_http_request_t *r,
                           lua_typename(L, type));
     }
 
-    lua_getglobal(L, ngx_http_lua_chain_key);
-    in = lua_touserdata(L, -1);
-    lua_pop(L, 1);
+    in = lmcf->body_filter_chain;
 
     last = 0;
 
@@ -625,8 +621,8 @@ ngx_http_lua_body_filter_param_set(lua_State *L, ngx_http_request_t *r,
         }
     }
 
-    lua_pushlightuserdata(L, cl);
-    lua_setglobal(L, ngx_http_lua_chain_key);
+    lmcf->body_filter_chain = cl;
+
     return 0;
 }
 

src/ngx_http_lua_bodyfilterby.h

@@ -21,7 +21,7 @@ ngx_int_t ngx_http_lua_body_filter_inline(ngx_http_request_t *r,
     ngx_chain_t *in);
 ngx_int_t ngx_http_lua_body_filter_file(ngx_http_request_t *r,
     ngx_chain_t *in);
-int ngx_http_lua_body_filter_param_get(lua_State *L);
+int ngx_http_lua_body_filter_param_get(lua_State *L, ngx_http_request_t *r);
 int ngx_http_lua_body_filter_param_set(lua_State *L, ngx_http_request_t *r,
     ngx_http_lua_ctx_t *ctx);
 

src/ngx_http_lua_cache.c

@@ -35,11 +35,14 @@ static ngx_int_t
 ngx_http_lua_cache_load_code(ngx_log_t *log, lua_State *L,
     const char *key)
 {
+#ifndef OPENRESTY_LUAJIT
     int          rc;
     u_char      *err;
+#endif
 
     /*  get code cache table */
-    lua_pushlightuserdata(L, &ngx_http_lua_code_cache_key);
+    lua_pushlightuserdata(L, ngx_http_lua_lightudata_mask(
+                          code_cache_key));
     lua_rawget(L, LUA_REGISTRYINDEX);    /*  sp++ */
 
     dd("Code cache table to load: %p", lua_topointer(L, -1));
@@ -52,6 +55,10 @@ ngx_http_lua_cache_load_code(ngx_log_t *log, lua_State *L,
     lua_getfield(L, -1, key);    /*  sp++ */
 
     if (lua_isfunction(L, -1)) {
+#ifdef OPENRESTY_LUAJIT
+        lua_remove(L, -2);   /*  sp-- */
+        return NGX_OK;
+#else
         /*  call closure factory to gen new closure */
         rc = lua_pcall(L, 0, 1, 0);
         if (rc == 0) {
@@ -73,6 +80,7 @@ ngx_http_lua_cache_load_code(ngx_log_t *log, lua_State *L,
                       key, err);
         lua_pop(L, 2);
         return NGX_ERROR;
+#endif /* OPENRESTY_LUAJIT */
     }
 
     dd("Value associated with given key in code cache table is not code "
@@ -102,10 +110,13 @@ ngx_http_lua_cache_load_code(ngx_log_t *log, lua_State *L,
 static ngx_int_t
 ngx_http_lua_cache_store_code(lua_State *L, const char *key)
 {
+#ifndef OPENRESTY_LUAJIT
     int rc;
+#endif
 
     /*  get code cache table */
-    lua_pushlightuserdata(L, &ngx_http_lua_code_cache_key);
+    lua_pushlightuserdata(L, ngx_http_lua_lightudata_mask(
+                          code_cache_key));
     lua_rawget(L, LUA_REGISTRYINDEX);
 
     dd("Code cache table to store: %p", lua_topointer(L, -1));
@@ -121,12 +132,14 @@ ngx_http_lua_cache_store_code(lua_State *L, const char *key)
     /*  remove cache table, leave closure factory at top of stack */
     lua_pop(L, 1); /* closure */
 
+#ifndef OPENRESTY_LUAJIT
     /*  call closure factory to generate new closure */
     rc = lua_pcall(L, 0, 1, 0);
     if (rc != 0) {
         dd("Error: failed to call closure factory!!");
         return NGX_ERROR;
     }
+#endif
 
     return NGX_OK;
 }