feature: enabled the FFI-based API for 'ngx.ctx' and 'ngx.status' in the stream subsystem.

Author: thibaultcha

lib/resty/core.lua

@@ -3,6 +3,7 @@
 local subsystem = ngx.config.subsystem
 
 
+require "resty.core.ctx"
 require "resty.core.regex"
 require "resty.core.shdict"
 require "resty.core.time"
@@ -15,7 +16,6 @@ require "resty.core.base64"
 
 if subsystem == 'http' then
     require "resty.core.var"
-    require "resty.core.ctx"
     require "resty.core.request"
     require "resty.core.response"
     require "resty.core.worker"

lib/resty/core/ctx.lua

@@ -1,28 +1,47 @@
 -- Copyright (C) Yichun Zhang (agentzh)
 
 
-local ffi = require 'ffi'
-local debug = require 'debug'
+local ffi = require "ffi"
+local debug = require "debug"
 local base = require "resty.core.base"
 local misc = require "resty.core.misc"
 
 
+local C = ffi.C
 local register_getter = misc.register_ngx_magic_key_getter
 local register_setter = misc.register_ngx_magic_key_setter
 local registry = debug.getregistry()
 local new_tab = base.new_tab
 local ref_in_table = base.ref_in_table
 local get_request = base.get_request
-local C = ffi.C
 local FFI_NO_REQ_CTX = base.FFI_NO_REQ_CTX
 local FFI_OK = base.FFI_OK
 local error = error
+local subsystem = ngx.config.subsystem
+
+
+local ngx_lua_ffi_get_ctx_ref
+local ngx_lua_ffi_set_ctx_ref
 
 
-ffi.cdef[[
-int ngx_http_lua_ffi_get_ctx_ref(ngx_http_request_t *r);
-int ngx_http_lua_ffi_set_ctx_ref(ngx_http_request_t *r, int ref);
-]]
+if subsystem == "http" then
+    ffi.cdef[[
+    int ngx_http_lua_ffi_get_ctx_ref(ngx_http_request_t *r);
+    int ngx_http_lua_ffi_set_ctx_ref(ngx_http_request_t *r, int ref);
+    ]]
+
+    ngx_lua_ffi_get_ctx_ref = C.ngx_http_lua_ffi_get_ctx_ref
+    ngx_lua_ffi_set_ctx_ref = C.ngx_http_lua_ffi_set_ctx_ref
+
+elseif subsystem == "stream" then
+    ffi.cdef[[
+    int ngx_stream_lua_ffi_get_ctx_ref(ngx_stream_lua_request_t *r);
+    int ngx_stream_lua_ffi_set_ctx_ref(ngx_stream_lua_request_t *r, int ref);
+    ]]
+
+    ngx_lua_ffi_get_ctx_ref = C.ngx_stream_lua_ffi_get_ctx_ref
+    ngx_lua_ffi_set_ctx_ref = C.ngx_stream_lua_ffi_set_ctx_ref
+end
 
 
 local _M = {
@@ -37,7 +56,7 @@ local function get_ctx_table()
         error("no request found")
     end
 
-    local ctx_ref = C.ngx_http_lua_ffi_get_ctx_ref(r)
+    local ctx_ref = ngx_lua_ffi_get_ctx_ref(r)
     if ctx_ref == FFI_NO_REQ_CTX then
         error("no request ctx found")
     end
@@ -46,7 +65,7 @@ local function get_ctx_table()
     if ctx_ref < 0 then
         local ctx = new_tab(0, 4)
         ctx_ref = ref_in_table(ctxs, ctx)
-        if C.ngx_http_lua_ffi_set_ctx_ref(r, ctx_ref) ~= FFI_OK then
+        if ngx_lua_ffi_set_ctx_ref(r, ctx_ref) ~= FFI_OK then
             return nil
         end
         return ctx
@@ -63,15 +82,15 @@ local function set_ctx_table(ctx)
         error("no request found")
     end
 
-    local ctx_ref = C.ngx_http_lua_ffi_get_ctx_ref(r)
+    local ctx_ref = ngx_lua_ffi_get_ctx_ref(r)
     if ctx_ref == FFI_NO_REQ_CTX then
         error("no request ctx found")
     end
 
     local ctxs = registry.ngx_lua_ctx_tables
     if ctx_ref < 0 then
         ctx_ref = ref_in_table(ctxs, ctx)
-        C.ngx_http_lua_ffi_set_ctx_ref(r, ctx_ref)
+        ngx_lua_ffi_set_ctx_ref(r, ctx_ref)
         return
     end
     ctxs[ctx_ref] = ctx

lib/resty/core/misc.lua

@@ -6,107 +6,98 @@ local ffi = require "ffi"
 local os = require "os"
 
 
-local FFI_OK = base.FFI_OK
-local FFI_NO_REQ_CTX = base.FFI_NO_REQ_CTX
-local FFI_BAD_CONTEXT = base.FFI_BAD_CONTEXT
-local get_string_buf = base.get_string_buf
-local get_string_buf_size = base.get_string_buf_size
-local get_size_ptr = base.get_size_ptr
-local new_tab = base.new_tab
 local C = ffi.C
 local ffi_new = ffi.new
 local ffi_str = ffi.string
-local setmetatable = setmetatable
-local rawget = rawget
-local rawset = rawset
 local ngx = ngx
-local get_request = base.get_request
 local type = type
 local error = error
+local rawget = rawget
+local rawset = rawset
 local tonumber = tonumber
+local setmetatable = setmetatable
+local FFI_OK = base.FFI_OK
+local FFI_NO_REQ_CTX = base.FFI_NO_REQ_CTX
+local FFI_BAD_CONTEXT = base.FFI_BAD_CONTEXT
+local new_tab = base.new_tab
+local get_request = base.get_request
+local get_size_ptr = base.get_size_ptr
+local get_string_buf = base.get_string_buf
+local get_string_buf_size = base.get_string_buf_size
 local subsystem = ngx.config.subsystem
 
 
-local _M
+local ngx_lua_ffi_get_resp_status
 local ngx_lua_ffi_get_conf_env
+local ngx_magic_key_getters
+local ngx_magic_key_setters
 
 
-if subsystem == 'http' then
-    _M = new_tab(0, 3)
+local _M = new_tab(0, 3)
+local ngx_mt = new_tab(0, 2)
 
 
-    local ngx_magic_key_getters = new_tab(0, 4)
-    local ngx_magic_key_setters = new_tab(0, 2)
+if subsystem == "http" then
+    ngx_magic_key_getters = new_tab(0, 4)
+    ngx_magic_key_setters = new_tab(0, 2)
 
-
-    local function register_getter(key, func)
-        ngx_magic_key_getters[key] = func
-    end
-    _M.register_ngx_magic_key_getter = register_getter
+elseif subsystem == "stream" then
+    ngx_magic_key_getters = new_tab(0, 2)
+    ngx_magic_key_setters = new_tab(0, 1)
+end
 
 
-    local function register_setter(key, func)
-        ngx_magic_key_setters[key] = func
-    end
-    _M.register_ngx_magic_key_setter = register_setter
+local function register_getter(key, func)
+    ngx_magic_key_getters[key] = func
+end
+_M.register_ngx_magic_key_getter = register_getter
 
 
-    local mt = new_tab(0, 2)
+local function register_setter(key, func)
+    ngx_magic_key_setters[key] = func
+end
+_M.register_ngx_magic_key_setter = register_setter
 
 
-    mt.__index = function (tb, key)
-        local f = ngx_magic_key_getters[key]
-        if f then
-            return f()
-        end
-        return rawget(tb, key)
+ngx_mt.__index = function (tb, key)
+    local f = ngx_magic_key_getters[key]
+    if f then
+        return f()
     end
+    return rawget(tb, key)
+end
 
 
-    mt.__newindex = function (tb, key, ctx)
-        local f = ngx_magic_key_setters[key]
-        if f then
-            return f(ctx)
-        end
-        return rawset(tb, key, ctx)
+ngx_mt.__newindex = function (tb, key, ctx)
+    local f = ngx_magic_key_setters[key]
+    if f then
+        return f(ctx)
     end
+    return rawset(tb, key, ctx)
+end
 
 
-    setmetatable(ngx, mt)
+setmetatable(ngx, ngx_mt)
 
 
+if subsystem == "http" then
     ffi.cdef[[
-int ngx_http_lua_ffi_get_resp_status(ngx_http_request_t *r);
-int ngx_http_lua_ffi_set_resp_status(ngx_http_request_t *r, int r);
-int ngx_http_lua_ffi_is_subrequest(ngx_http_request_t *r);
-int ngx_http_lua_ffi_headers_sent(ngx_http_request_t *r);
-int ngx_http_lua_ffi_get_conf_env(const unsigned char *name,
-    unsigned char **env_buf, size_t *name_len);
+    int ngx_http_lua_ffi_get_resp_status(ngx_http_request_t *r);
+    int ngx_http_lua_ffi_set_resp_status(ngx_http_request_t *r, int r);
+    int ngx_http_lua_ffi_is_subrequest(ngx_http_request_t *r);
+    int ngx_http_lua_ffi_headers_sent(ngx_http_request_t *r);
+    int ngx_http_lua_ffi_get_conf_env(const unsigned char *name,
+                                      unsigned char **env_buf,
+                                      size_t *name_len);
     ]]
 
 
+    ngx_lua_ffi_get_resp_status = C.ngx_http_lua_ffi_get_resp_status
     ngx_lua_ffi_get_conf_env = C.ngx_http_lua_ffi_get_conf_env
 
 
     -- ngx.status
 
-    local function get_status()
-        local r = get_request()
-
-        if not r then
-            error("no request found")
-        end
-
-        local rc = C.ngx_http_lua_ffi_get_resp_status(r)
-
-        if rc == FFI_BAD_CONTEXT then
-            error("API disabled in the current context", 2)
-        end
-
-        return rc
-    end
-    register_getter("status", get_status)
-
 
     local function set_status(status)
         local r = get_request()
@@ -132,6 +123,7 @@ int ngx_http_lua_ffi_get_conf_env(const unsigned char *name,
 
     -- ngx.is_subrequest
 
+
     local function is_subreq()
         local r = get_request()
 
@@ -152,6 +144,7 @@ int ngx_http_lua_ffi_get_conf_env(const unsigned char *name,
 
     -- ngx.headers_sent
 
+
     local function headers_sent()
         local r = get_request()
 
@@ -173,20 +166,40 @@ int ngx_http_lua_ffi_get_conf_env(const unsigned char *name,
     end
     register_getter("headers_sent", headers_sent)
 
-elseif subsystem == 'stream' then
-    _M = new_tab(0, 1)
-
-
+elseif subsystem == "stream" then
     ffi.cdef[[
-int ngx_stream_lua_ffi_get_conf_env(const unsigned char *name,
-    unsigned char **env_buf, size_t *name_len);
+    int ngx_stream_lua_ffi_get_resp_status(ngx_stream_lua_request_t *r);
+    int ngx_stream_lua_ffi_get_conf_env(const unsigned char *name,
+                                        unsigned char **env_buf,
+                                        size_t *name_len);
     ]]
 
-
+    ngx_lua_ffi_get_resp_status = C.ngx_stream_lua_ffi_get_resp_status
     ngx_lua_ffi_get_conf_env = C.ngx_stream_lua_ffi_get_conf_env
 end
 
 
+-- ngx.status
+
+
+local function get_status()
+    local r = get_request()
+
+    if not r then
+        error("no request found")
+    end
+
+    local rc = ngx_lua_ffi_get_resp_status(r)
+
+    if rc == FFI_BAD_CONTEXT then
+        error("API disabled in the current context", 2)
+    end
+
+    return rc
+end
+register_getter("status", get_status)
+
+
 do
     local _getenv = os.getenv
     local env_ptr = ffi_new("unsigned char *[1]")