neomantra / redis-mod_luajit

Redis Module adding LuaJIT support

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

redis-mod_luajit

Redis Module adding LuaJIT support

This is very unstable! It also depends on experimental features of Redis!

Install

IMPORTANT: Currently, this module requires Redis to be statically linked with LuaJIT. I did that by copying the libluajit-5.1.a into the Redis tree and then relinking Redis. Hopefully this can be remedied...

Dependencies:

  • cmake
  • a C compiler
  • luajit-2.0
  • redis 4.0 beta
cd redis-mod_luajit
cmake .
make

# install files to system paths
sudo cp redismodule.lua /usr/local/share/lua/5.1/
sudo cp libredis-mod_luajit.so /usr/local/lib

Example

Here's an example of loading the module, and invoking a simple reply, and registering a new Redis command using LuaJIT FFI callbacks.

# must use Redis 4.0 redis-cli against Redis 4.0
$ redis-cli
172.0.0.1:6379> module load /usr/local/lib/libredis-mod_luajit.so
172.0.0.1:6379> luajit.eval "RM.EvalCtx():ReplyWithSimpleString('hello from LuaJIT')"
hello from LuaJIT
127.0.0.1:6379> luajit.eval "RM.EvalCtx():CreateCommand('hello.lua', function(ctx,argv,argc) print('hello world', argc) ; return ctx:ReplyWithLongLong(420) ; end,'',1,1,1) ; RM.EvalCtx():ReplyWithLongLong(2)"
(integer) 2
127.0.0.1:6379> hello.lua
(integer) 420
[and you should see 'hello world    1' in the redis.log]

TODO

  • fill out the implementation
  • add LUAJIT.EVALSHA and maybe some other SCRIPT-like methods
  • think of configuration
  • think of helpers (like Call wrappers? auto-reply)
  • more bulletproofing
  • more examples
  • change the name depending on what module naming conventions people come up with

Backstory

Several years ago, I spent some time exploring deeper integration of LuaJIT with Redis. My beef was that the existing Lua Scripting does so much marshalling and other work that might not be needed. As I dove in, I reallized what I was making was low-level wrappers around Redis internals. I gave up after a while because I knew it would never be merged.

But recently @antirez released a preview of the Redis Module API. It was basically what I wanted before, so I am starting to explore the ideas again.

License

BSD-license, just like Redis. See the file COPYING.

Copyright (c) 2016, Evan Wies.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    * Neither the name of Redis nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

About

Redis Module adding LuaJIT support

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:C 51.8%Language:Lua 47.5%Language:CMake 0.7%