• 沒有找到結果。

Lua 脚本功能是 Reids 2.6 版本的最大亮点,通过内嵌对 Lua 环境的支持,Redis 解决了长久 以来不能高效地处理 CAS (check-and-set)命令的缺点,并且可以通过组合使用多个命令,轻 松实现以前很难实现或者不能高效实现的模式。

本章先介绍 Lua 环境的初始化步骤,然后对 Lua 脚本的安全性问题、以及解决这些问题的方 法进行说明,最后对执行 Lua 脚本的两个命令——EVAL和 EVALSHA的实现原理进行介绍。

4.3.1 初始化 Lua 环境

在初始化 Redis 服务器时,对 Lua 环境的初始化也会一并进行。

为了让 Lua 环境符合 Redis 脚本功能的需求,Redis 对 Lua 环境进行了一系列的修改,包括添 加函数库、更换随机函数、保护全局变量,等等。

整个初始化 Lua 环境的步骤如下:

1. 调用lua_open 函数,创建一个新的 Lua 环境。

2. 载入指定的 Lua 函数库,包括:

• 基础库(base lib)。

• 表格库(table lib)。

• 字符串库(string lib)。

• 数学库(math lib)。

• 调试库(debug lib)。

• 用于处理 JSON 对象的 cjson 库。

• 在 Lua 值 和 C 结 构 (struct) 之 间 进 行 转 换 的 struct 库 (www.inf.puc-rio.br/ roberto/struct/)

• 处理 MessagePack 数据的 cmsgpack 库(github.com/antirez/lua-cmsgpack)。

3. 屏蔽一些可能对 Lua 环境产生安全问题的函数,比如loadfile 。

4. 创建一个 Redis 字典,保存 Lua 脚本,并在复制(replication)脚本时使用。字典的键为 SHA1 校验和,字典的值为 Lua 脚本。

5. 创建一个 redis 全局表格到 Lua 环境,表格中包含了各种对 Redis 进行操作的函数,包 括:

– redis.LOG_DEBUG – redis.LOG_VERBOSE – redis.LOG_NOTICE – redis.LOG_WARNING

• 用于计算 SHA1 校验和的 redis.sha1hex 函数。

• 用于返回错误信息的 redis.error_reply 函数和 redis.status_reply 函数。

6. 用 Redis 自 己 定 义 的 随 机 生 成 函 数, 替 换 math 表 原 有 的 math.random 函 数 和 math.randomseed 函数,新的函数具有这样的性质:每次执行 Lua 脚本时,除非显 式地调用 math.randomseed ,否则 math.random 生成的伪随机数序列总是相同的。

7. 创建一个对 Redis 多批量回复(multi bulk reply)进行排序的辅助函数。

8. 对 Lua 环境中的全局变量进行保护,以免被传入的脚本修改。

9. 因为 Redis 命令必须通过客户端来执行,所以需要在服务器状态中创建一个无网络连接 的伪客户端(fake client),专门用于执行 Lua 脚本中包含的 Redis 命令:当 Lua 脚本需 要执行 Redis 命令时,它通过伪客户端来向服务器发送命令请求,服务器在执行完命令 之后,将结果返回给伪客户端,而伪客户端又转而将命令结果返回给 Lua 脚本。

10. 将 Lua 环境的指针记录到 Redis 服务器的全局状态中,等候 Redis 的调用。

以上就是 Redis 初始化 Lua 环境的整个过程,当这些步骤都执行完之后,Redis 就可以使用 Lua 环境来处理脚本了。

严格来说,步骤 1 至 8 才是初始化 Lua 环境的操作,而步骤 9 和 10 则是将 Lua 环境关联到 服务器的操作,为了按顺序观察整个初始化过程,我们将两种操作放在了一起。

另外,步骤 6 用于创建无副作用的脚本,而步骤 7 则用于去除部分 Redis 命令中的不确定性

(non deterministic),关于这两点,请看下面一节关于脚本安全性的讨论。

4.3.2 脚本的安全性

当将 Lua 脚本复制到附属节点,或者将 Lua 脚本写入 AOF 文件时,Redis 需要解决这样一个 问题:如果一段 Lua 脚本带有随机性质或副作用,那么当这段脚本在附属节点运行时,或者从 AOF 文件载入重新运行时,它得到的结果可能和之前运行的结果完全不同。

考虑以下一段代码,其中的 get_random_number() 带有随机性质,我们在服务器 SERVER 中 执行这段代码,并将随机数的结果保存到键 number 上:

# 虚构例子,不会真的出现在脚本环境中

redis> EVAL "return redis.call('set', KEYS[1], get_random_number())" 1 number OK

redis> GET number

"10086"

现在,假如 EVAL的代码被复制到了附属节点 SLAVE ,因为 get_random_number() 的随机 性质,它有很大可能会生成一个和 10086 完全不同的值,比如 65535 :

# 虚构例子,不会真的出现在脚本环境中

redis> EVAL "return redis.call('set', KEYS[1], get_random_number())" 1 number

100 Chapter 4. 功能的实现

Redis 设计与实现, 第一版

OK

redis> GET number

"65535"

可以看到,带有随机性的写入脚本产生了一个严重的问题:它破坏了服务器和附属节点数据之 间的一致性。

当从 AOF 文件中载入带有随机性质的写入脚本时,也会发生同样的问题。

Note: 只有在带有随机性的脚本进行写入时,随机性才是有害的。

如果一个脚本只是执行只读操作,那么随机性是无害的。

比 如 说, 如 果 脚 本 只 是 单 纯 地 执 行 RANDOMKEY 命 令, 那 么 它 是 无 害 的; 但 如 果 在 执 行 RANDOMKEY 之后,基于 RANDOMKEY 的结果进行写入操作,那么这个脚本就是有害的。

和随机性质类似,如果一个脚本的执行对任何副作用产生了依赖,那么这个脚本每次执行所产 生的结果都可能会不一样。

为了解决这个问题,Redis 对 Lua 环境所能执行的脚本做了一个严格的限制——所有脚本都必 须是无副作用的纯函数(pure function)。

为此,Redis 对 Lua 环境做了一些列相应的措施:

• 不提供访问系统状态状态的库(比如系统时间库)。

• 禁止使用 loadfile函数。

• 如果脚本在执行带有随机性质的命令(比如 RANDOMKEY ),或者带有副作用的命令

(比如 TIME )之后,试图执行一个写入命令(比如SET ),那么 Redis 将阻止这个脚本 继续运行,并返回一个错误。

• 如果脚本执行了带有随机性质的读命令(比如SMEMBERS ),那么在脚本的输出返回给 Redis 之前,会先被执行一个自动的字典序排序,从而确保输出结果是有序的。

• 用 Redis 自己定义的随机生成函数,替换 Lua 环境中 math 表原有的math.random 函数 和 math.randomseed函数,新的函数具有这样的性质:每次执行 Lua 脚本时,除非显式 地调用 math.randomseed ,否则 math.random 生成的伪随机数序列总是相同的。

经过这一系列的调整之后,Redis 可以保证被执行的脚本:

1. 无副作用。

2. 没有有害的随机性。

3. 对于同样的输入参数和数据集,总是产生相同的写入命令。

4.3.3 脚本的执行

在脚本环境的初始化工作完成以后,Redis 就可以通过EVAL命令或EVALSHA命令执行 Lua 脚本了。

其中,EVAL 直接对输入的脚本代码体(body)进行求值:

EVALSHA 则要求输入某个脚本的 SHA1 校验和,这个校验和所对应的脚本必须至少被 EVAL执行过一次:

redis> EVAL "return 'hello world'" 0

"hello world"

redis> EVALSHA 5332031c6b470dc5a0dd9b4bf2030dea6d65de91 0 // 上一个脚本的校验和

"hello world"

或者曾经使用 SCRIPT LOAD载入过这个脚本:

redis> SCRIPT LOAD "return 'dlrow olleh'"

"d569c48906b1f4fca0469ba4eee89149b5148092"

redis> EVALSHA d569c48906b1f4fca0469ba4eee89149b5148092 0

"dlrow olleh"

因为 EVALSHA 是基于 EVAL 构建的,所以下文先用一节讲解 EVAL 的实现,之后再讲解 EVALSHA的实现。

4.3.4 EVAL 命令的实现

EVAL命令的执行可以分为以下步骤:

1. 为输入脚本定义一个 Lua 函数。

2. 执行这个 Lua 函数。

以下两个小节分别介绍这两个步骤。

定义 Lua 函数

所有被 Redis 执行的 Lua 脚本,在 Lua 环境中都会有一个和该脚本相对应的无参数函数:当 调用EVAL 命令执行脚本时,程序第一步要完成的工作就是为传入的脚本创建一个相应的 Lua 函数。

举个例子,当执行命令 EVAL "return 'hello world'" 0 时,Lua 会为脚本 "return 'hello world'" 创建以下函数:

function f_5332031c6b470dc5a0dd9b4bf2030dea6d65de91() return 'hello world'

end

其中,函数名以 f_ 为前缀,后跟脚本的 SHA1 校验和(一个 40 个字符长的字符串)拼接而 成。而函数体(body)则是用户输入的脚本。

以函数为单位保存 Lua 脚本有以下好处:

• 执行脚本的步骤非常简单,只要调用和脚本相对应的函数即可。

• Lua 环境可以保持清洁,已有的脚本和新加入的脚本不会互相干扰,也可以将重置 Lua 环境和调用 Lua GC 的次数降到最低。

• 如果某个脚本所对应的函数在 Lua 环境中被定义过至少一次,那么只要记得这个脚本的 SHA1 校验和,就可以直接执行该脚本——这是实现 EVALSHA 命令的基础,稍后在介 绍 EVALSHA的时候就会说到这一点。

102 Chapter 4. 功能的实现

Redis 设计与实现, 第一版

在为脚本创建函数前,程序会先用函数名检查 Lua 环境,只有在函数定义未存在时,程序才创 建函数。重复定义函数一般并没有什么副作用,这算是一个小优化。

另外,如果定义的函数在编译过程中出错(比如,脚本的代码语法有错),那么程序向用户返回 一个脚本错误,不再执行后面的步骤。

执行 Lua 函数

在定义好 Lua 函数之后,程序就可以通过运行这个函数来达到运行输入脚本的目的了。

不过,在此之前,为了确保脚本的正确和安全执行,还需要执行一些设置钩子、传入参数之类 的操作,整个执行函数的过程如下:

1. 将 EVAL命令中输入的 KEYS 参数和 ARGV 参数以全局数组的方式传入到 Lua 环境中。

2. 设 置 伪 客 户 端 的 目 标 数 据 库 为 调 用 者 客 户 端 的 目 标 数 据 库: fake_client->db = caller_client->db ,确保脚本中执行的 Redis 命令访问的是正确的数据库。

3. 为 Lua 环境装载超时钩子,保证在脚本执行出现超时时可以杀死脚本,或者停止 Redis 服务器。

4. 执行脚本对应的 Lua 函数。

5. 如果被执行的 Lua 脚本中带有 SELECT 命令,那么在脚本执行完毕之后,伪客户端 中的 数据 库可能 已 经 有所改变, 所以 需要对 调用者客户端的目标数据库进行更新:

caller_client->db = fake_client->db 。

6. 执行清理操作:清除钩子;清除指向调用者客户端的指针;等等。

7. 将 Lua 函数执行所得的结果转换成 Redis 回复,然后传给调用者客户端。

8. 对 Lua 环境进行一次单步的渐进式 GC 。

以下是执行 EVAL "return 'hello world'" 0 的过程中,调用者客户端(caller)、Redis 服务 器和 Lua 环境之间的数据流表示图:

发送命令请求

EVAL "return 'hello world'" 0

Caller ---> Redis 为脚本 "return 'hello world'"

创建 Lua 函数

Redis ---> Lua 绑定超时处理钩子

Redis ---> Lua 执行脚本函数

Redis ---> Lua 返回函数执行结果(一个 Lua 值)

Redis <--- Lua 将 Lua 值转换为 Redis 回复

并将结果返回给客户端

上面这个图可以作为所有 Lua 脚本的基本执行流程图,不过它展示的 Lua 脚本中不带有 Redis 命令调用:当 Lua 脚本里本身有调用 Redis 命令时(执行 redis.call 或者 redis.pcall ),

Redis 和 Lua 脚本之间的数据交互会更复杂一些。

Redis 和 Lua 脚本之间的数据交互会更复杂一些。