lua-resty-core

New FFI-based Lua API for the ngx_lua module

Account

Valdanitooooo

Repo

https://github.com/Valdanitooooo/lua-resty-core/tree/dev

$ opm get Valdanitooooo/lua-resty-core

Name

lua-resty-core - New FFI-based Lua API for ngx_http_lua_module and/or ngx_stream_lua_module

Status

This library is production ready.

Synopsis

This library is automatically loaded by default since OpenResty 1.15.8.1. This behavior can be disabled via the lua_load_resty_core directive, but note that the use of this library is vividly recommended, as its FFI implementation is both faster, safer, and more complete than the Lua C API of the ngx_lua module.

If you are using an older version of OpenResty, you must load this library like so:

        # nginx.conf
    
        http {
            # you do NOT need to configure the following line when you
            # are using the OpenResty bundle 1.4.3.9+.
            lua_package_path "/path/to/lua-resty-core/lib/?.lua;;";
    
            init_by_lua_block {
                require "resty.core"
                collectgarbage("collect")  -- just to collect any garbage
            }
    
            ...
        }

Description

This pure Lua library reimplements part of the ngx_lua module's Nginx API for Lua with LuaJIT FFI and installs the new FFI-based Lua API into the ngx. and ndk. namespaces used by the ngx_lua module.

In addition, this Lua library implements any significant new Lua APIs of the ngx_lua module as proper Lua modules, like ngx.semaphore and ngx.balancer.

The FFI-based Lua API can work with LuaJIT's JIT compiler. ngx_lua's default API is based on the standard Lua C API, which will never be JIT compiled and the user Lua code is always interpreted (slowly).

Support for the new ngx_stream_lua_module has also begun.

This library is shipped with the OpenResty bundle by default. So you do not really need to worry about the dependencies and requirements.

Prerequisites

WARNING This library is included with every OpenResty release. You should use the bundled version of this library in the particular OpenResty release you are using. Otherwise you may run into serious compatibility issues.

LuaJIT 2.1 (for now, it is the v2.1 git branch in the official luajit-2.0 git repository: http://luajit.org/download.html )
ngx_http_lua_module v0.10.25.
ngx_stream_lua_module v0.0.13.
lua-resty-lrucache

Installation

By default, LuaJIT will search Lua files in /usr/local/share/lua/5.1/. But make install will install this module to /usr/local/lib/lua. So you may find the error like this:

    nginx: [alert] failed to load the 'resty.core' module

You can install this module with the following command to resolve the above problem.

    cd lua-resty-core
    sudo make install LUA_LIB_DIR=/usr/local/share/lua/5.1

You can also change the installation directory to any other directory you like with the LUA_LIB_DIR argument.

    cd lua-resty-core
    sudo make install LUA_LIB_DIR=/opt/nginx/lualib

After that, you need to add the above directory to the LuaJIT search direcotries with lua_package_path nginx directive in the http context and stream context.

    lua_package_path "/opt/nginx/lualib/?.lua;;";

API Implemented

resty.core.hash

resty.core.base64

resty.core.uri

resty.core.regex

resty.core.exit

ngx.exit

resty.core.shdict

resty.core.var

ngx.var.VARIABLE

resty.core.ctx

ngx.ctx

get_ctx_table

syntax: ctx = resty.core.ctx.get_ctx_table(ctx?)

Similar to ngx.ctx but it accepts an optional ctx argument. It will use the ctx from caller instead of creating a new table when the ctx table does not exist.

Notice: the ctx table will be used in the current request's whole life cycle. Please be very careful when you try to reuse the ctx table. You need to make sure there is no Lua code using or going to use the ctx table in the current request before you reusing the ctx table in some other place.

resty.core.request

resty.core.response

ngx.header.HEADER

resty.core.misc

resty.core.time

resty.core.worker

resty.core.phase

ngx.get_phase

resty.core.ndk

ndk.set_var

resty.core.socket

resty.core.param

ngx.arg (getter only)

ngx.semaphore

This Lua module implements a semaphore API for efficient "light thread" synchronization, which can work across different requests (but not across nginx worker processes).