错误也有来路

# 错误也有来路

11 月 10 日那篇龙芯文章之后，上游又攒了 14 笔提交。11 月 12 日这一批里有一条线：运行时错误开始带调用点 traceback，`fun/lib/runtime.fun` 落地，logging 和 `fun test` 顺手接上。先看结果。

```fun
fun inner(n)
  result = 100 / n;
end fun;

fun middle(n)
  result = inner(n);
end fun;

fun outer(n)
  result = middle(n);
end fun;

fun main()
  result = outer(0);
end fun;

?. 'start';
main();
?. 'done';
```

运行，第二行就炸了：

```
start
/home/jcode/funlang/fun/demo/chain.fun:2: Floating point division by zero
  in inner() (/home/jcode/funlang/fun/demo/chain.fun:6)
  in middle() (/home/jcode/funlang/fun/demo/chain.fun:10)
  in outer() (/home/jcode/funlang/fun/demo/chain.fun:14)
  in main() (/home/jcode/funlang/fun/demo/chain.fun:18)
```

以前只有第一行。知道死在 `inner` 的第 2 行，不知道谁把 0 递进来的。现在每一行都是一个调用点：`inner` 是在 `middle` 的第 6 行被叫的，`middle` 是在 `outer` 的第 10 行，`outer` 是在 `main` 的第 14 行，`main` 是在第 18 行。注意报的是调用发生的那一行，不是函数定义的第一行，查参数是谁传错的时候，这个比一串函数名有用。

（吐槽：以前的 Fun 报错，像一封只有落款没有正文的信。）

## 一、热路径只写两个指针

实现没把函数名和文件名塞进每一帧。`CCallFrame` 就两个字段：`callee` 指向被调函数，`site` 指向调用点那个语法节点。进入函数写一次，退出时清一次，就这么多。

名字和行号都是延迟解析的。真要打 traceback，或者脚本里问 `runtime.stack()`，才从 `site` 往上找所属模块拿文件名，从节点拿 `row`。平时这些字符串一个都不生成。

调用环固定 32 槽，`MaxCallFrames = 32`，`callsTop` 记绝对深度，槽位用 `callsTop and 31` 直接算，push/pop 各是一次下标写。深度超过 32 就把最外面的几帧盖掉，报出来的是最近 32 层。`try/finally` 里顺手做两件事：没正常走完就冻结当前环，然后把 `callsTop` 减一。冻结只在最里面那层做一次，外层 `finally` 不会把栈覆盖掉。

（吐槽：所谓零开销，其实是把开销挪到出错那一瞬间。平时省下来的，正是出事时愿意付的。）

## 二、关掉之后

`FUN_TRACEBACK=0` 可以把整套记账关掉，编译时不带 `-dFunTraceback`。这台机器上，开着 731,328 字节，关掉 718,672 字节，省 12,656 字节，约 1.7%。

速度呢。拿 `fib(30)` 递归跑，总共约 270 万次调用，两边各五轮：开着 1.25 到 1.33 秒，关掉 1.33 到 1.36 秒。差异落在噪声里，开着甚至略快，大概是代码对齐的运气。

（吐槽：测性能最怕这种结果，说不好是优化生效，还是编译器今天心情好。）

## 三、脚本里也能问

`runtime.fun` 提供四个入口：

- `runtime.source(depth)`：给 file、path、line、function、className，当前调用点。
- `runtime.stack(max)`：从内往外，每帧给调用点与调用方、被调方。
- `runtime.lastError()`：最近一次被 `except` 接住的错误，带 message、出错点、stack；`lastError(true)` 清掉。
- `runtime.root(path)`：短路径的根，默认取启动目录。

捕获以后能拿到什么，跑一段：

```fun
try
  main();
except
  runtime.root('/home/jcode/funlang/fun');
  var e = runtime.lastError();
  ?. 'message  : ' & e['message'];
  ?. 'place    : ' & e['path'] & ':' & e['line'];
  ?. 'function : ' & e['className'] & '.' & e['function'];
  ?. 'stack    : ' & e['stack'].@count();
end try;
```

输出：

```
message  : Floating point division by zero
place    : demo/final.fun:5
function : Repo.load
stack    : 3
```

`path` 是相对 `root` 的短路径，`file` 是绝对路径。`function` 和 `className` 指出错点所在的函数与类，`stack` 里的 `callee` 从内到外排，`load <- handle <- main`。

`source()` 单独用也成。在 `audit()` 里问一句，返回的 `function` 是 `audit`，`line` 是 `runtime.source()` 自己那一行，不是 `audit` 被调用的那一行。

（吐槽：四个入口里最难起名的是 `root`，本来想叫 `cwd`，可它并不是进程的当前目录。）

## 四、logging 与 fun test 顺手接上

logging 的每条记录现在自带 source，默认文本格式里排在 level 和 name 后面，显示短路径，`sourcePath` 可选 short、full、base。只有启用的级别才会去取位置，`logger.debug` 被级别挡住时不付这个钱。

`fun test` 的断言失败会指出用户测试文件的行号：

```
not ok one plus one
  math is broken
  expected 3, got 2
  at /home/jcode/funlang/fun/demo/failtest.fun:4
```

第 4 行正是 `assert.equal` 那一行，不是 `test.fun` 里抛错的第 216 行。做法是在注册测试时记住 `runtime.source(1)` 的文件与行，失败时拿 `lastError()` 的出错点比一比，对得上就用自己的，对不上再从 stack 里找同文件的帧。

## 五、一天里改了两次名字

11 月 12 日下午先做的是 `'runtime'.frame()` 和 `'runtime'.lastError()`。Fun 里用字符串当接收者，只是为了把调用路由到内建函数表，不必新加全局名字，跟 `'host'.arg()`、`'kernel32'.getapi()` 一个路子。问题是接收者的值没人看，`'anything'.frame()` 也能调通，等于白挂一个命名空间。

晚上 20:24 先补了校验，非 `'runtime'` 直接报错。六分钟后又推倒：与其校验一个假命名空间，不如让接收者真的有语义。现在是 `'frame'.reflect(i, mode)`、`'depth'.reflect()`、`'lastError'.reflect(clear)`，一个内建 `reflect`，接收者选目标，未知目标明确报错。公开的 `runtime.fun` 接口没变。

（吐槽：一天里同一段代码写了两遍，第二遍才想明白，接口设计里最难的不是加什么，是删什么。）

## 六、还剩什么

默认构建开 traceback，`FUN_TRACEBACK=0` 可关，win64 的 CI 作业也打开了。32 帧的上限对递归深的程序会截断，报的是最近 32 层，这是有意的。

写例子时踩到一个边角：把刚构造出来的对象直接当实参传进去，比如 `handle(Repo(), 7)`，中间那一帧的调用行会指到类里面去；先 `var r = Repo();` 再 `handle(r, 7)` 就正常。还没修，先记在这里。

（吐槽：错误信息这东西，平时没人注意，真出事的时候，一行行号能省半小时。）

二十多年前在 DOS 的 `debug` 里，程序跑飞了只能靠手算偏移。现在跑飞了，至少留下一串脚印：文件、行号、函数名，三十二层。脚印不一定指向凶手，但总比什么都没有强。