代码生成(Code Generation)技术广泛应用于现代的数据系统中。代码生成是将用户输入的表达式、查询、存储过程等现场编译成二进制代码再执行,相比解释执行的方式,运行效率要高得多。尤其是对于计算密集型查询、或频繁重复使用的计算过程,运用代码生成技术能达到数十倍的性能提升。
很多大数据产品都将代码生成技术作为卖点,然而事实上他们往往谈论的不是一件事情。比如,之前就有人提问:Spark 1.x 就已经有代码生成技术,为什么 Spark 2.0 又把代码生成吹了一番?其中的原因在于,虽然都是代码生成,但是各个产品生成代码的粒度是不同的:
本文主要讲上面最简单的表达式编译。让我们通过一个简单的例子,初步了解代码生成的流程。
在讲代码生成之前,我们回顾一下解释执行。以上面图中的表达式 $X /times 5 + /log (10)$ 为例,计算过程是一个深度优先搜索(DFS)的过程:
+
的 visit()
函数:分别调用左、右子节点的 visit()
再相加; *
的 visit()
函数:分别调用左、右子节点的 visit()
再相乘; X
的 visit()
函数:从环境中读取 $X$ 的值以及类型。 (……略)最终,DFS 回到根节点,得到最终结果。
@Override public Object visitPlus(CalculatorParser.PlusContext ctx) { Object left = visit(ctx.plusOrMinus()); Object right = visit(ctx.multOrDiv()); if (left instanceof Long && right instanceof Long) { return (Long) left + (Long) right; } else if (left instanceof Long && right instanceof Double) { return (Long) left + (Double) right; } else if (left instanceof Double && right instanceof Long) { return (Double) left + (Long) right; } else if (left instanceof Double && right instanceof Double) { return (Double) left + (Double) right; } throw new IllegalArgumentException(); }
上述过程中有几个显而易见的性能问题:
visit()
函数; +
左边是 DECIMAL 类型,而右边是 DOUBLE,需要先把左边转换成 DOUBLE 再相加; 代码生成执行,顾名思义,最核心的部分是生成出我们需要的执行代码。
拜编译器所赐,我们并不需要写难懂的汇编或字节码。在 native 程序中,通常用 LLVM 的中间语言(IR)作为生成代码的语言。而 JVM 上更简单,因为 Java 编译本身很快,利用运行在 JVM 上的轻量级编译器 janino,我们可以直接生成 Java 代码。
无论是 LLVM IR 还是 Java 都是静态类型的语言,在生成的代码中再去判断类型显然不是个明智的选择。 通常的做法是在编译之前就确定所有值的类型 。幸运的是,表达式和 SQL 执行计划都可以事先做类型推导。
所以,综上所述,代码生成往往是个 2-pass 的过程: 先做类型推导,再做真正的代码生成 。第一步中,类型推导的同时其实也是在检查表达式是否合法,因此很多地方也称之为 验证(Validate) 。
在代码生成完成后,调用编译器,我们就编译出了所需的函数(类),直接调用即可得到计算结果。如果函数包含参数,例如上面例子中的 X
,每次计算可以传入不同的参数,编译一次、计算多次。
以下的代码实现都可以在 GitHub 项目 fuyufjh/calculator 找到。
为了尽可能简单,例子中仅涉及两种类型:Long 和 Double
这一步中,我们将合法的表达式 AST 转换成 Algebra Node,这是一个递归语法树的过程,下面是一个例子(由于 Plus 接收 Long/Double 的任意类型组合,所以此处没有做类型检查):
@Override public AlgebraNode visitPlus(CalculatorParser.PlusContext ctx) { return new PlusNode(visit(ctx.plusOrMinus()), visit(ctx.multOrDiv())); }
AlgebraNode 接口定义如下:
public interface AlgebraNode { DataType getType(); // Validate 和 CodeGen 都会用到 String generateCode(); // CodeGen 使用 List<AlgebraNode> getInputs(); }
实现类大致与 AST 的中的节点相对应,如下图。
对于加法,类型推导的过程很简单——如果两个操作数都是 Long 则结果为 Long,否则为 Double。
@Override public DataType getType() { if (dataType == null) { dataType = inferTypeFromInputs(); } return dataType; } private DataType inferTypeFromInputs() { for (AlgebraNode input : getInputs()) { if (input.getType() == DataType.DOUBLE) { return DataType.DOUBLE; } } return DataType.LONG; }
依旧以加法为例,利用上面实现的 getType()
,我们可以确定输入、输出的类型,生成出强类型的代码:
@Override public String generateCode() { if (getLeft().getType() == DataType.DOUBLE && getRight().getType() == DataType.DOUBLE) { return "(" + getLeft().generateCode() + " + " + getRight().generateCode() + ")"; } else if (getLeft().getType() == DataType.DOUBLE && getRight().getType() == DataType.LONG) { return "(" + getLeft().generateCode() + " + (double)" + getRight().generateCode() + ")"; } else if (getLeft().getType() == DataType.LONG && getRight().getType() == DataType.DOUBLE) { return "((double)" + getLeft().generateCode() + " + " + getRight().generateCode() + ")"; } else if (getLeft().getType() == DataType.LONG && getRight().getType() == DataType.LONG) { return "(" + getLeft().generateCode() + " + " + getRight().generateCode() + ")"; } throw new IllegalStateException(); }
注意,目前代码还是以 String 形式存在的,递归调用的过程中通过字符串拼接,一步步拼成完整的表达式函数。
以表达式 a + 2*3 - 2/x + log(x+1)
为例,最终生成的代码如下:
(((double)(a + (2 * 3)) - ((double)2 / x)) + java.lang.Math.log((x + (double)1)))
其中, a
、 x
都是未知数,但类型是已经确定的,分别是 Long 型和 Double 型。
Janino 是一个流行的轻量级 Java 编译器,与常用的 javac
相比它最大的优势是:可以在 JVM 上直接调用,直接在进程内存中运行编译,速度很快。
上述代码仅仅是一个表达式、并不是完整的 Java 代码,但 janino 提供了方便的 API 能直接编译表达式:
ExpressionEvaluator evaluator = new ExpressionEvaluator(); evaluator.setParameters(parameterNames, parameterTypes); // 输入参数名及类型 evaluator.setExpressionType(rootNode.getType() == DataType.DOUBLE ? double.class : long.class); // 输出类型 evaluator.cook(code); // 编译代码
实际上,你也可以手工拼接出如下的类代码,交给 janino 编译,效果是完全相同的:
class MyGeneratedClass { public double calculate(long a, double x) { return (((double)(a + (2 * 3)) - ((double)2 / x)) + java.lang.Math.log((x + (double)1))); } }
最后,依次输入所有参数即可调用刚刚编译的函数:
Object result = evaluator.evaluate(parameterValues);