建站视频教程网,杭州seo营销公司,在线教育网站设计,精美企业模板#[function(length(varchar) - int4)]
pub fn char_length(s: str) - i32 {s.chars().count() as i32
}这是 RisingWave 中一个 SQL 函数的实现。只需短短几行代码#xff0c;通过在 Rust 函数上加一行过程宏#xff0c;我们就把它包装成了一个 SQL…#[function(length(varchar) - int4)]
pub fn char_length(s: str) - i32 {s.chars().count() as i32
}这是 RisingWave 中一个 SQL 函数的实现。只需短短几行代码通过在 Rust 函数上加一行过程宏我们就把它包装成了一个 SQL 函数。
dev select length(Rising Wave);length br/--------11
(1 row)类似的除了标量函数Scalar Function表函数Table Function和聚合函数Aggregate Function也可以用这样的方法定义。我们甚至可以利用泛型来同时定义多种类型的重载函数
#[function(generate_series(int4, int4) - setof int4)]
#[function(generate_series(int8, int8) - setof int8)]
fn generate_seriesT: Step(start: T, stop: T) - impl IteratorItem T {start..stop
}#[aggregate(max(int2) - int2, state ref)]
#[aggregate(max(int4) - int4, state ref)]
#[aggregate(max(int8) - int8, state ref)]
fn maxT: Ord(state: T, input: T) - T {state.max(input)
}dev select generate_series(1, 3);generate_series
-----------------123
(3 rows)dev select max(x) from generate_series(1, 3) t(x);max
-----3
(1 row)利用 Rust 过程宏我们将函数实现背后的琐碎细节隐藏起来向开发者暴露一个干净简洁的接口。这样我们便能够专注于函数本身逻辑的实现从而大幅提高开发和维护的效率。
而当一个接口足够简单简单到连 ChatGPT 都可以理解时让 AI 帮我们写代码就不再是天方夜谭了。警告AI 会自信地写出 Bug使用前需要人工 review 向 GPT 展示一个 SQL 函数实现的例子然后给出一个新函数的文档让他生成完整的 Rust 实现代码。
在本文中我们将深度解析 RisingWave 中 #[function] 过程宏的设计目标和工作原理。通过回答以下几个问题揭开过程宏的魔法面纱
函数执行的过程是怎样的为什么选择使用过程宏实现这个宏是如何展开的生成了怎样的代码利用过程宏还能实现哪些高级需求
1. 向量化计算模型
RisingWave 是一个支持 SQL 语言的流处理引擎。在内部处理数据时它使用基于列式内存存储的向量化计算模型。在这种模型下一个表Table的数据按列分割每一列的数据连续存储在一个数组Array中。为了便于理解本文中我们采用列式内存的行业标准 Apache Arrow 格式作为示例。下图是其中一批数据RecordBatch的内存结构RisingWave 的列存结构与之大同小异。 列式内存存储的数据结构 在函数求值时我们首先把每个输入参数对应的数据列合并成一个 RecordBatch然后依次读取每一行的数据作为参数调用函数最后将函数返回值压缩成一个数组作为最终返回结果。这种一次处理一批数据的方式就是向量化计算。 函数的向量化求值 之所以要这么折腾一圈做列式存储、向量化求值本质上还是因为批处理能够均摊掉控制逻辑的开销并充分利用现代 CPU 中的缓存局部性和 SIMD 指令等特性实现更高的访存和计算性能。
我们将上述函数求值过程抽象成一个 Rust trait大概长这样
pub trait ScalarFunction {/// Call the function on each row and return results as an array.fn eval(self, input: RecordBatch) - ResultArrayRef;
}在实际查询中多个函数嵌套组合成一个表达式。例如表达式 a b - c等价于 sub(add(a, b), c)。对表达式求值就相当于递归地对多个函数进行求值。这个表达式本身也可以看作一个函数同样适用上面的 trait。因此本文中我们不区分表达式和标量函数。
2. 表达式执行的黑白魔法类型体操 vs 代码生成
接下来我们讨论在 Rust 语言中如何具体实现表达式向量化求值。
2.1 我们要实现什么
回顾上一节中提到的求值过程写成代码的整体结构是这样的
// 首先定义好对每行数据的求值函数
fn add(a: i32, b: i32) - i32 {a b
}// 对于每一种函数我们需要定义一个 struct
struct Add;// 并为之实现 ScalarFunction trait
impl ScalarFunction for Add {// 在此方法中实现向量化批处理fn eval(self, input: RecordBatch) - ResultArrayRef {// 我们拿到一个 RecordBatch里面包含了若干列每一列对应一个输入参数// 此时我们拿到的列是 Arcdyn Array也就是一个**类型擦除**的数组let a0: Arcdyn Array input.columns(0);let a1: Arcdyn Array input.columns(1);// 我们可以获取每一列的数据类型并验证它符合函数的要求ensure!(a0.data_type() DataType::Int32);ensure!(a1.data_type() DataType::Int32);// 然后将它们 downcast 到具体的数组类型let a0: Int32Array a0.as_any().downcast_ref().context(type mismatch)?;let a1: Int32Array a1.as_any().downcast_ref().context(type mismatch)?;// 在求值前我们还需要准备好一个 array builder 存储返回值let mut builder Int32Builder::with_capacity(input.num_rows());// 此时我们就可以通过 .iter() 来遍历具体的元素了for (v0, v1) in a0.iter().zip(a1.iter()) {// 这里我们拿到的 v0 和 v1 是 Optioni32 类型// 对于 add 函数来说let res match (v0, v1) {// 只有当所有输入都非空时函数才会被计算(Some(v0), Some(v1)) Some(add(v0, v1)),// 而任何一个输入为空会导致输出也为空_ None,};// 最后将结果存入 array builderbuilder.append_option(res);}// 返回结果 arrayOk(Arc::new(builder.finish()))}
}我们发现这个函数本体的逻辑只需要短短一个 fn 就可以描述
fn add(a: i32, b: i32) - i32 {a b
}然而为了支持在列存上进行向量化计算还需要实现后面这一大段样板代码来处理琐碎逻辑。有什么办法能自动生成这坨代码呢
2.2 类型体操
著名数据库专家迟先生曾在博文「数据库表达式执行的黑魔法用 Rust 做类型体操」中讨论了各种可能的解决方法包括
基于 trait 的泛型声明宏过程宏外部代码生成器
并且系统性地阐述了它们的关系和工程实现中的利弊 从方法论的角度来讲一旦开发者在某个需要使用泛型的地方使用了宏展开调用它的代码就不可能再通过 trait-based generics 使用这段代码。从这个角度来说越是“大道至简”的生成代码越难维护。但反过来说如果要完全实现 trait-based generics往往要和编译器斗智斗勇就算是通过编译也需要花掉大量的时间。 我们首先来看基于 trait 泛型的解决方案。在 arrow-rs 中有一个名为 binary 的 kernel 就是做这个的给定一个二元标量函数将其应用于两个 array 进行向量化计算并生成一个新的 array。它的函数签名如下
pub fn binaryA, B, F, O(a: PrimitiveArrayA,b: PrimitiveArrayB,op: F
) - ResultPrimitiveArrayO, ArrowError
whereA: ArrowPrimitiveType,B: ArrowPrimitiveType,O: ArrowPrimitiveType,F: Fn(A as ArrowPrimitiveType::Native, B as ArrowPrimitiveType::Native) - O as ArrowPrimitiveType::Native,相信你已经开始感受到「类型体操」的味道了。尽管如此它依然有以下这些局限
支持的类型仅限于 PrimitiveArray 也就是 int, float, decimal 等基础类型。对于复杂类型如 bytes, string, list, struct因为没有统一到一个 trait 下所以每种都需要一个新的函数。仅适用于两个参数的函数。对于一个或更多参数每一种都需要这样一个函数。arrow-rs 中也只内置了 unary 和 binary 两种 kernel。仅适用于一种标量函数签名即不出错的、不接受空值的函数。考虑其它各种可能的情况下需要有不同的 F 定义
fn add(i32, i32) - i32;
fn checked_add(i32, i32) - Resulti32;
fn optional_add(i32, Optioni32) - Optioni32;
如果考虑以上三种因素的结合那么可能的组合无穷尽也不可能覆盖所有的函数类型。
2.3 类型体操 声明宏
在文章《类型体操》及 RisingWave 的初版实现中作者使用 泛型 声明宏 的方法部分解决了以上问题 首先设计一套精妙的类型系统将全部类型统一到一个 trait 下解决了第一个问题。然后使用声明宏来生成多种类型的 kernel 函数。覆盖常见的 1、2、3 个参数以及 T 和 Option 的输入输出组合。生成了常用的 unarybinaryternaryunary_nullableunary_bytes 等 kernel部分解决了第二三个问题。具体实现参见 RisingWave 早期代码 当然这里理论上也可以继续使用类型体操。例如引入 trait 统一 (A,) (A, B) (A, B, C) 用 Into, AsRef trait 统一 T, OptionT, ResultT等。只不过大概率迎接我们的是 rustc 带来的一点小小的类型震撼最后这些 kernel 没有解决类型动态 downcast 的问题。为此作者又利用声明宏设计了一套精妙的宏套宏机制来实现动态派发。
macro_rules! for_all_cmp_combinations {($macro:tt $(, $x:tt)*) {$macro! {[$($x),*],// comparison across integer types{ int16, int32, int32 },{ int32, int16, int32 },{ int16, int64, int64 },// ...
尽管解决了一些问题但这套方案依然有它的痛点
基于 trait 做类型体操使我们不可避免地陷入到与 Rust 编译器斗智斗勇之中。依然没有全面覆盖所有可能情况。有相当一部分函数仍然需要开发者手写向量化实现。性能。当我们需要引入 SIMD 对部分函数进行优化时需要重新实现一套 kernel 函数。没有对开发者隐藏全部细节。函数开发者依然需要先熟悉类型体操和声明宏的工作原理才能比较流畅地添加函数。
究其原因我认为是函数的变体形式过于复杂而 Rust 的 trait 和声明宏系统的灵活性不足导致的。本质上是一种元编程能力不够强大的表现。
2.4 元编程
让我们来看看其他语言和框架是怎么解决这个问题的。
首先是 Python一种灵活的动态类型语言。这是 Flink 中的 Python UDF 接口其它大数据系统的接口也大同小异
udf(result_typeBIGINT)
def add(i, j):return i j我们发现它是用 udf 这个装饰器标记了函数的签名信息然后在运行时对不同类型进行相应的处理。当然由于它本身是动态类型因此 Rust 中的很多问题在 Python 中根本不存在代价则是性能损失。
接下来是 Java它是一种静态类型语言但通过虚拟机 JIT 运行。这是 Flink 中的 Java UDF 接口
public static class SubstringFunction extends ScalarFunction {public String eval(String s, Integer begin, Integer end) {return s.substring(begin, end);}
}可以看到同样也很短。这次甚至不需要额外标记类型了因为静态类型系统本身就包含了类型信息。我们可以通过运行时反射拿到类型信息并通过 JIT 机制在运行时生成高效的强类型代码兼具灵活与性能。
最后是 Zig一种新时代的 C 语言。它最大的特色是任何代码都可以加上 comptime 关键字在编译时运行因此具备非常强的元编程能力。tygg 在博文「Zig lang 初体验 -- 『大道至简』的 comptime」中演示了用 Zig 实现迟先生类型体操的方法通过 编译期反射 和 过程式的代码生成 来代替开发者完成类型体操。
用一张表总结一下 可以发现Zig 语言强大的元编程能力提供了相对最好的解决方案。
2.5 过程宏
那么 Rust 里面有没有类似 Zig 的特性呢。其实是有的那就是过程宏Procedural Macros。它可以在编译期动态执行任何 Rust 代码来修改 Rust 程序本身。只不过它的编译时和运行时代码是物理分开的相比 Zig 的体验没有那么统一但是效果几乎一样。
参考 Python UDF 的接口设计我们便得到了 ”大道至简“ 的 Rust 函数接口
#[function(add(int, int) - int)]
fn add(a: i32, b: i32) - i32 {a b
}从用户的角度看他只需要在自己熟悉的 Rust 函数上面标一个函数签名。其它的类型体操和代码生成操作都被隐藏在过程宏之后完全无需关心。
此时我们已经拿到了一个函数所必须的全部信息接下来我们将看到过程宏如何生成向量化执行所需的样板代码。
3. 展开 #[function]
3.1 解析函数签名
首先我们要实现类型反射也就是分别解析 SQL 函数和 Rust 函数的签名以此决定后面如何生成代码。在过程宏入口处我们会拿到两个 TokenStream分别包含了标注信息和函数本体
#[proc_macro_attribute]
pub fn function(attr: TokenStream, item: TokenStream) - TokenStream {// attr: add(int, int) - int// item: fn add(a: i32, b: i32) - i32 { a b }...
}我们使用 syn 库将 TokenStream 转为 AST然后
解析 SQL 函数签名字符串获取函数名、输入输出类型等信息。解析 Rust 函数签名获取函数名、每个参数和返回值的类型模式、是否 async 等信息。
具体地
对于参数类型我们确定它是 T 或者 OptionT。对于返回值类型我们将其识别为TOptionTResultT ResultOptionT 四种类型之一。
这将决定我们后面如何调用函数以及处理错误。
3.2 定义类型表
作为 trait 类型体操的代替方案我们在过程宏中定义了这样一张类型表来描述类型系统之间的对应关系并且提供了相应的查询函数。
// name primitive array prefix data type
const TYPE_MATRIX: str void _ Null Nullboolean _ Boolean Booleansmallint y Int16 Int16int y Int32 Int32bigint y Int64 Int64real y Float32 Float32float y Float64 Float64...varchar _ String Utf8bytea _ Binary Binaryarray _ List Liststruct _ Struct Struct
;比如当我们拿到用户的函数签名后
#[function(length(varchar) - int)]查表即可得知
第一个参数 varchar 对应的 array 类型为 StringArray返回值 int 对应的数据类型为 DataType::Int32对应的 Builder 类型为 Int32Builder并非所有输入输出均为 primitive 类型因此无法进行 SIMD 优化
在下面的代码生成中这些类型将被填入到对应的位置。
3.3 生成求值代码
在代码生成阶段我们主要使用 quote 库来生成并组合代码片段。最终生成的代码整体结构如下
quote! {struct #struct_name;impl ScalarFunction for #struct_name {fn eval(self, input: RecordBatch) - ResultArrayRef {#downcast_arrayslet mut builder #builder;#evalOk(Arc::new(builder.finish()))}}
}下面我们来逐个填写代码片段首先是 downcast 输入 array
let children_indices (0..self.args.len());
let arrays children_indices.map(|i| format_ident!(a{i}));
let arg_arrays children_indices.map(|i| format_ident!({}, types::array_type(self.args[*i])));let downcast_arrays quote! {#(let #arrays: #arg_arrays input.column(#children_indices).as_any().downcast_ref().ok_or_else(|| ArrowError::CastError(...))?;)*
};builder
let builder_type format_ident!({}, types::array_builder_type(ty));
let builder quote! { #builder_type::with_capacity(input.num_rows()) };接下来是最关键的执行部分我们先写出函数调用的那一行
let inputs children_indices.map(|i| format_ident!(i{i}));
let output quote! { #user_fn_name(#(#inputs,)*) };
// example: add(i0, i1)然后考虑这个表达式返回了什么类型呢这需要根据 Rust 函数签名决定它可能包含 Option也可能包含 Result。我们进行错误处理然后将其归一化到 OptionT 类型
let output match user_fn.return_type_kind {T quote! { Some(#output) },Option quote! { #output },Result quote! { Some(#output?) },ResultOption quote! { #output? },
};
// example: Some(add(i0, i1))下面考虑这个函数接收什么样的类型作为输入这同样需要根据 Rust 函数签名决定每个参数可能是或不是 Option。如果函数不接受 Option 输入但实际输入的却是 null那么我们默认它的返回值就是 null此时无需调用函数。因此我们使用 match 语句来对输入参数做预处理
let some_inputs inputs.iter().zip(user_fn.arg_is_option.iter()).map(|(input, opt)| {if *opt {quote! { #input }} else {quote! { Some(#input) }}});
let output quote! {// 这里的 inputs 是从 array 中拿出来的 OptionTmatch (#(#inputs,)*) {// 我们将部分参数 unwrap 后再喂给函数(#(#some_inputs,)*) #output,// 如有 unwrap 失败则直接返回 null_ None,}
};
// example:
// match (i0, i1) {
// (Some(i0), Some(i1)) Some(add(i0, i1)),
// _ None,
// }此时我们已经拿到了一行的返回值可以将它 append 到 builder 中
let append_output quote! { builder.append_option(#output); };最后在外面套一层循环对输入逐行操作
let eval quote! {for (i, (#(#inputs,)*)) in multizip((#(#arrays.iter(),)*)).enumerate() {#append_output}
};如果一切顺利的话过程宏展开生成的代码将如 2.1 节中所示的那样。
3.4 函数注册
到此为止我们已经完成了最核心、最困难的部分即生成向量化求值代码。但是用户该怎么使用生成的代码呢
注意到一开始我们生成了一个 struct。因此我们可以允许用户指定这个 struct 的名称或者定义一套规范自动生成唯一的名称。这样用户就能在这个 struct 上调用函数了。
// 指定生成名为 Add 的 struct
#[function(add(int, int) - int, output Add)]
fn add(a: i32, b: i32) - i32 {a b
}// 调用生成的向量化求值函数
let input: RecordBatch ...;
let output: RecordBatch Add.eval(input).unwrap();不过在实际场景中很少有这种使用特定函数的需求。更多是在项目中定义很多函数然后在解析 SQL 查询时动态地查找匹配的函数。为此我们需要一种全局的函数注册和查找机制。
问题来了Rust 本身没有反射机制如何在运行时获取所有由 #[function] 静态定义的函数呢
答案是利用程序的链接时link time特性将函数指针等元信息放入特定的 section 中。程序链接时链接器linker会自动收集分布在各处的符号symbol集中在一起。程序运行时即可扫描这个 section 获取全部函数了。
Rust 社区的 dtolnay 大佬为此需求做了两个开箱即用的库linkme 和 inventory。其中前者是直接利用上述机制后者是利用 C 标准的 constructor 初始化函数但背后的原理没有本质区别。下面我们以 linkme 为例来演示如何实现注册机制。
首先我们需要在公共库而不是 proc-macro中定义函数签名的结构
pub struct FunctionSignature {pub name: String,pub arg_types: VecDataType,pub return_type: DataType,pub function: Boxdyn ScalarFunction,
}然后定义一个全局变量 REGISTRY 作为注册中心。它会在第一次被访问时利用 linkme 将所有 #[function] 定义的函数收集到一个 HashMap 中
/// A collection of distributed #[function] signatures.
#[linkme::distributed_slice]
pub static SIGNATURES: [fn() - FunctionSignature];lazy_static::lazy_static! {/// Global function registry.pub static ref REGISTRY: FunctionRegistry {let mut signatures HashMap::String, VecFunctionSignature::new();for sig in SIGNATURES {let sig sig();signatures.entry(sig.name.clone()).or_default().push(sig);}FunctionRegistry { signatures }};
}最后在 #[function] 过程宏中我们为每个函数生成如下代码
#[linkme::distributed_slice(SIGNATURES)]
fn #sig_name() - FunctionSignature {FunctionSignature {name: #name.into(),arg_types: vec![#(#args),*],return_type: #ret,// 这里 #struct_name 就是我们之前生成的函数结构体function: Box::new(#struct_name),}
}如此一来用户就可以通过 FunctionRegistry 提供的方法动态查找函数并进行求值了
let gcd REGISTRY.get(gcd, [Int32, Int32], Int32);
let output: RecordBatch gcd.function.eval(input).unwrap();3.5 小结
以上我们完整阐述了 #[function] 过程宏的工作原理和实现过程
使用 syn 库解析函数签名使用 quote 库生成定制化的向量化求值代码使用 linkme 库实现函数的全局注册和动态查找
其中
SQL 签名决定了如何从 input array 中读取数据如何生成 output arrayRust 签名决定了如何调用用户的 Rust 函数如何处理空值和错误类型查找表决定了 SQL 类型和 Rust 类型的映射关系
相比 trait 声明宏的解决方案过程宏中的 “过程式” 风格为我们提供了极大的灵活性一揽子解决了之前提到的全部问题。在下一章中我们将会在这个框架的基础上继续扩展解决更多实际场景下的复杂需求。
44. 高级功能
抽象的问题是简单的但现实的需求是复杂的。上面的原型看似解决了所有问题但在 RisingWave 的实际工程开发中我们遇到了各种稀奇古怪的需求都无法用最原始的 #[function] 宏实现。下面我们来逐一介绍这些问题并利用过程宏的灵活性见招拆招。
4.1 支持多类型重载
有些函数支持大量不同类型的重载例如 运算对几乎支持所有数字类型。此时我们一般会复用同一个泛型函数然后用不同的类型去实例化它。
#[function(add(*int, *int) - auto)]
#[function(add(*float, *float) - auto)]
#[function(add(decimal, decimal) - decimal)]
#[function(add(interval, interval) - interval)]
fn addT1, T2, T3(l: T1, r: T2) - ResultT3
whereT1: IntoT3 Debug,T2: IntoT3 Debug,T3: CheckedAddOutput T3,
{a.into().checked_add(b.into()).ok_or(ExprError::NumericOutOfRange)
}因此我们支持在同一个函数上同时标记多个#[function] 宏。此外我们还支持使用类型通配符将一个#[function] 自动展开成多个并使用 auto 自动推断返回类型。例如 *int 通配符表示全部整数类型 int2, int4, int8那么 add(*int, *int) 将展开为 3 x 3 9 种整数的组合返回值自动推断为两种类型中最大的一个
#[function(add(int2, int2) - int2)]
#[function(add(int2, int4) - int4)]
#[function(add(int2, int8) - int8)]
#[function(add(int4, int4) - int4)]
...而如果泛型不能满足一些特殊类型的要求你也完全可以定义新函数进行特化specialization
#[function(add(interval, timestamp) - timestamp)]
fn interval_timestamp_add(l: Interval, r: Timestamp) - ResultTimestamp {r.checked_add(l).ok_or(ExprError::NumericOutOfRange)
}这一特性帮助我们快速实现函数重载同时避免了冗余代码。
4.2 自动 SIMD 优化
作为零开销抽象语言Rust 从不向性能妥协#[function] 宏也是如此。对于很多简单函数理论上可以利用 CPU 内置的 SIMD 指令实现上百倍的性能提升。然而编译器往往只能对简单的循环结构实现自动 SIMD 向量化。一旦循环中出现分支跳转等复杂结构自动向量化就会失效。
// 简单循环支持自动向量化
assert_eq!(a.len(), n);
assert_eq!(b.len(), n);
assert_eq!(c.len(), n);
for i in 0..n {c[i] a[i] b[i];
}// 一旦出现分支结构如错误处理、越界检查等自动向量化就会失效
for i in 0..n {c.push(a[i].checked_add(b[i])?);
}不幸的是我们前文中生成的代码结构并不利于编译器进行自动向量化因为循环中的 builder.append_option() 操作本身就自带条件分支。
为了支持自动向量化我们需要对代码生成逻辑进一步特化
首先根据函数签名判断这个函数能否实现 SIMD 优化。这需要满足以下两个主要条件 所有输入输出类型均为基础类型即 boolean, int, float, decimalRust 函数的输入类型均不含 Option输出不含 Option 和 Result #[function(equal(int, int) - boolean)]
fn equal(a: i32, b: i32) - bool {a b
} 一旦上述条件满足我们会对 #eval 代码段进行特化将其替换为这样的代码调用 arrow-rs 内置的 unary 和 binary kernel 实现自动向量化
// SIMD optimization for primitive types
match self.args.len() {0 quote! {let c #ret_array_type::from_iter_values(std::iter::repeat_with(|| #user_fn_name()).take(input.num_rows()));let array Arc::new(c);},1 quote! {let c: #ret_array_type arrow_arith::arity::unary(a0, #user_fn_name);let array Arc::new(c);},2 quote! {let c: #ret_array_type arrow_arith::arity::binary(a0, a1, #user_fn_name)?;let array Arc::new(c);},n todo!(SIMD optimization for {n} arguments),
} 需要注意如果用户函数本身包含分支结构那么自动向量化也是无效的。我们只是尽力为编译器创造了实现优化的条件。另一方面这一优化也不是完全安全的它会使得原本为 null 的输入强制执行。例如整数除法 a / b如果 b 为 null原本不会执行现在却会执行 a / 0导致除零异常而崩溃。这种情况下我们只能修改函数签名避免生成特化代码。
整体而言实现这一功能后用户编写代码不需要有任何变化但是部分函数的性能得到了大幅提高。这对于高性能数据处理系统而言是必须的。
4.3 返回字符串直接写入 buffer
很多函数会返回字符串。但是朴素地返回 String 会导致大量动态内存分配降低性能。
#[function(concat(varchar, varchar) - varchar)]
fn concat(left: str, right: str) - String {format!({left}{right})
}注意到列式内存存储中StringArray 实际上是把多个字符串存放在一段连续的内存上构建这个数组的 StringBuilder 实际上也只是将字符串追加写入同一个 buffer 里。因此函数返回 String 是没有必要的它可以直接将字符串写入 StringBuilder 的 buffer 中。
于是我们支持对返回字符串的函数添加一个 mut Write 类型的 writer 参数。内部可以直接用 write! 方法向 writer 写入返回值。
#[function(concat(varchar, varchar) - varchar)]
fn concat(left: str, right: str, writer: mut impl std::fmt::Write) {writer.write_str(left).unwrap();writer.write_str(right).unwrap();
}在过程宏的实现中我们主要修改了函数调用部分
let writer user_fn.write.then(|| quote! { mut builder, });
let output quote! { #user_fn_name(#(#inputs,)* #writer) };以及特化 append_output 的逻辑
let append_output if user_fn.write {quote! {{if #output.is_some() { // 返回值直接在这行写入 builderbuilder.append_value();} else {builder.append_null();}}}
} else {quote! { builder.append_option(#output); }
};经过测试这一功能也可以大幅提升字符串处理函数的性能。
4.4 常量预处理优化
有些函数的某个参数往往是一个常量并且这个常量需要经过一个开销较大的预处理过程。这类函数的典型代表是正则表达式匹配
// regexp_like(source, pattern)
#[function(regexp_like(varchar, varchar) - boolean)]
fn regexp_like(text: str, pattern: str) - Resultbool {let regex regex::Regex::new(pattern)?; // 预处理编译正则表达式Ok(regex.is_match(text))
}对于一次向量化求值来说如果输入的 pattern 是常数very likely那么其实只需要编译一次然后用编译后的数据结构对每一行文本进行匹配即可。但如果不是常数unlikely但是合法行为则需要对每一行 pattern 编译一次再执行。
为了支持这一需求我们修改用户接口将特定参数的预处理过程提取到过程宏中然后把预处理后的类型作为参数
#[function(regexp_like(varchar, varchar) - boolean,prebuild Regex::new($1)? // $1 表示第一个参数下标从0开始
)]
fn regexp_like(text: str, regex: Regex) - bool {regex.is_match(text)
}这样过程宏可以对这个函数生成两个版本的代码
如果指定参数为常量那么在构造函数中执行 prebuild 代码并将生成的 Regex 中间值存放在 struct 当中在求值阶段直接传入函数。如果不是常量那么在求值阶段将 prebuild 代码嵌入到函数参数的位置上。
至于具体的代码生成逻辑由于细节相当复杂这里就不再展开介绍了。
总之这一优化保证了此类函数各种输入下都具有最优性能并且极大简化了手工实现的复杂性。
4.5 表函数
最后我们来看表函数Table FunctionPostgres 中也称 Set-returning Funcion返回集合的函数。这类函数的返回值不再是一行而是多行。如果同时返回多列那么就相当于返回一个表。
select * from generate_series(1, 3);generate_series
-----------------123对应到常见的编程语言中实际是一个生成器函数Generator。以 Python 为例可以写成这样
def generate_series(start, end):for i in range(start, end 1):yield iRust 语言目前在 nightly 版本支持生成器但这一特性尚未 stable。不过如果不用 yield 语法的话我们可以利用 RPIT 特性实现返回迭代器的函数以达到同样的效果
#[function(generate_series(int, int) - setof int)]
fn generate_series(start: i32, stop: i32) - impl IteratorItem i32 {start..stop
}我们支持在 #[function] 签名中使用 - setof 以声明一个表函数。它修饰的 Rust 函数必须返回一个 impl Iterator其中的 Item 需要匹配返回类型。当然Iterator 的内外都可以包含 Option 或 Result。
在对表函数进行向量化求值时我们会对每一行输入调用生成器函数然后将每一行返回的多行结果串联起来最后按照固定的 chunk size 进行切割依次返回多个 RecordBatch。因此表函数的向量化接口长这个样子
pub trait TableFunction {fn eval(self, input: RecordBatch, chunk_size: usize) - ResultBoxdyn IteratorItem ResultRecordBatch;
}我们给出一组 generate_series 的输入输出样例假设 chunk size 2
input output
------------- ----------------------
| start | stop | | row | generate_series |
------------- ----------------------
| 0 | 0 |----| 0 | 0 |
| | | -| 2 | 0 |
| 0 | 2 |-- ----------------------
------------- | 2 | 1 || 2 | 2 |----------------------由于表函数的输入输出不再具有一对一的关系我们在 output 中会额外生成一列 row 来表示每一行输出对应 input 中的哪一行输入。这一关系信息会在某些 SQL 查询中被使用到。
回到 #[function] 宏的实现它为表函数生成的代码实际上也是一个生成器。我们在内部使用了 futures_async_stream 提供的 #[try_stream] 宏实现 async generator它依赖 nightly 的 generator 特性在 stable 版本中则使用 genawaiter 代替。之所以要使用生成器则是因为一个表函数可能会生成非常长的结果例如 generate_series(0, 1000000000)中途必须把控制权交还调用者才能保证系统不被卡死。感兴趣的读者可以思考一下如果没有 generator 机制高效的向量化表函数求值能否实现如何实现
说到这里多扯两句。genawaiter 也是个很有意思的库它使用 async-await 机制来在 stable Rust 中实现 generator。我们知道 async-await 本质上也是一种 generator它们都依赖编译器的 CPS 变换实现状态机。不过出于对异步编程的强烈需求async-await 很早就被稳定化而 generator 却迟迟没有稳定。由于背后的原理相通它们可以互相实现。 此外目前 Rust 社区正在积极推动 async generator 的进展原生的 [async gen](https://github.com/rust-lang/rust/pull/118420) 和 [for await](https://github.com/rust-lang/rust/pull/118847) 语法刚刚在上个月进入 nightly。不过由于没有和 futures 生态对接整体依然处于不可用状态。RisingWave 的流处理引擎就深度依赖 async generator 机制实现流算子以简化异步 IO 下的流状态管理。不过这又是一个庞大的话题之后有机会再来介绍这方面的应用吧。 5. 总结
由于篇幅所限我们只能展开这么多了。如你所见一个简单的函数求值背后隐藏着非常多的设计和实现细节
为了高性能我们选择列式内存存储和向量化求值。存储数据的容器通常是类型擦除的结构。但 Rust 是一门静态类型语言用户定义的函数是强类型的签名。这意味着我们需要在编译期确定每一个容器的具体类型做类型体操来处理不同类型之间的转换准确地把数据从容器中取出来喂给函数最后高效地将函数吐出来的结果打包回数据容器中。为了将上述过程隐藏起来我们设计了 #[function] 过程宏在编译期做类型反射和代码生成最终暴露给用户一个尽可能简单直观的接口。但是实际工程中存在各种复杂需求以及对性能的要求我们必须持续在接口上打洞并对代码生成逻辑进行特化。幸好过程宏具有非常强的灵活性使得我们可以敏捷地应对变化的需求。
#[function] 宏最初是为 RisingWave 内部函数实现的一套框架。最近我们将它从 RisingWave 项目中独立出来基于 Apache Arrow 标准化成一套通用的用户定义函数接口 arrow-udf。如果你的项目也在使用 arrow-rs 进行数据处理现在可以直接使用这套 #[function] 宏定义自己的函数。如果你在使用 RisingWave那么从这个月底发布的 1.7 版本起你可以使用这个库来定义 Rust UDF。它可以编译成 WebAssembly 模块插入到 RisingWave 中运行。感兴趣的读者也可以阅读这个项目的源码了解更多实现细节。
事实上RisingWave 基于 Apache Arrow 构建了一整套用户定义函数接口。此前我们已经实现了服务器模式的 Python 和 Java UDF。最近我们又基于 WebAssembly 实现了 Rust UDF基于 QuickJS 实现了 JavaScript UDF。它们都可以嵌入到 RisingWave 中运行以实现更好的性能和用户体验。在下一篇文章中我们将系统介绍 RisingWave UDF 的设计与实现。敬请期待 RisingWave 是一款基于 Apache 2.0 协议开源的分布式流数据库致力于为用户提供极致简单、高效的流数据处理与管理能力。RisingWave 采用存算分离架构实现了高效的复杂查询、瞬时动态扩缩容以及快速故障恢复并助力用户极大地简化流计算架构轻松搭建稳定且高效的流计算应用。RisingWave 始终聆听来自社区的声音并积极回应用户的反馈。目前RisingWave 已汇聚了近 150 名开源贡献者和近 3000 名社区成员。全球范围内已有上百个 RisingWave 集群在生产环境中部署。
了解更多
官网 risingwave.com
教程risingwavetutorial.com
GitHubrisingwave.com/github
微信公众号RisingWave中文开源社区
社区用户交流群risingwave_assistant
