方舟字节码基本原理

总体设计

概述

方舟字节码（Ark Bytecode）是由方舟编译器编译ArkTS/TS/JS生成的，提供给方舟运行时解释执行的二进制文件。方舟字节码中的主要内容是方舟字节码指令。
本文旨在介绍方舟字节码指令相关的设计，将在后续章节中对构成指令的重要概念和具体的指令格式及含义进行说明，帮助开发者了解方舟字节码指令，指导开发者进行指令相关的特性开发工作。
一条方舟字节码指令，由操作码（指令的名称）和指令入参列表组成。操作码包含无前缀的操作码和有前缀的操作码两种。寄存器、立即数以及string id/method id/literal id均可以作为指令的入参。除此之外，部分指令中使用累加器作为默认参数。
方舟字节码中，除寄存器和累加器之外，还存在全局变量、模块（module）命名空间和模块变量、词法环境和词法变量、补丁变量4种值存储方式。指令可以使用这4种储值位置中的值作为入参。

术语和约束

术语

本文涉及的术语清单：

约束

• 本文中所有采用代码形式描述的内容均遵循ArkTS语言规范。
• 本文仅适用于版本号为12.0.6.0的方舟字节码（版本号为方舟编译器内部保留字段，开发者无需关注）。

字节码构成

操作码与前缀

方舟字节码中的操作码通常被编码为一个8位的值，因此至多只能有256个操作码。随着方舟编译器运行时功能的演进，字节码的数量也在逐步增加，已经超过了256个。因此，方舟字节码引入了前缀（prefix），将操作码最大宽度从8位扩展到16位。8位操作码（无前缀的）用于表示频繁出现的指令，16位操作码（有前缀的）用于表示出现频率不高的指令。
带前缀的操作码为小端法存储的16位值，由8位操作码和8位前缀组成，编码规则为：操作码左移8位，再与前缀相或。

前缀操作码的助记符的形式为前缀助记符.操作码助记符，例如，wide.stlexvar。stlexvar指令的操作码是0x0d，前缀wide是0xfd，则此带前缀的指令（wide.stlexvar）的操作码是0x0dfd。

寄存器与累加器

方舟虚拟机模型基于寄存器，所有的寄存器均为虚拟寄存器。当寄存器中存放原始类型的值时，宽度是64位；当寄存器中存放对象类型的值时，宽度适应为足够宽，以存放对该对象的引用。
方舟字节码中，存在一个名为累加器（accumulator，也简称作acc）的不可见寄存器。acc是许多指令的默认目标寄存器，也是许多指令的默认参数。acc不占用编码宽度，有助于产生更为紧凑的字节码。

示例代码：

function foo0(): number {
  return 1;
}

.function any .foo(any a0, any a1, any a2) {
    ldai 0x1
    return
}

指令ldai 0x1：将整型字面量1加载到acc中；
指令return：返回acc中的值。

立即数

方舟字节码中部分指令采用常数形式来表示整型数值、双精度浮点型数值和跳转偏移量等数据。这类常数被称为立即数，可以是8位、16位、32位或64位。

方法索引、字符串索引、字面量索引

方舟字节码中存放着源文件中使用到的所有方法、字符串和字面量数组的偏移量。其中，字面量数组中存放着各种字面量数据，例如整型数字、字符串偏移量和方法偏移量。在方舟字节码指令中，这些方法、字符串以及字面量数组的索引都是16位的，分别被称作方法索引（method id）、字符串索引（string id）以及字面量索引（literal id）。这些索引被编码在指令中，以引用方法、字符串和字面量数组。

值存储方式

全局变量

在Script编译模式下，全局变量是一个存储在全局唯一的映射中的变量，其键值为全局变量的名称，值为全局变量的值。全局变量可通过全局（global）相关的指令进行访问。

示例代码：

let a = 1;
let b = 1;
function foo1(): void {
  a += 2;
  b = 5;
}

.function any .foo(any a0, any a1, any a2) {
    tryldglobalbyname 0x0, a
    sta v4
    ldai 0x2
    add2 0x1, v4
    trystglobalbyname 0x2, a
    ldai 0x5
    trystglobalbyname 0x3, b
    ...
}

指令tryldglobalbyname 0x0, a：将名称为a的全局变量加载进acc，不存在名称为a的全局变量时，抛出异常；
指令trystglobalbyname 0x2, a：将acc中的值存放到名称为a的全局变量上，不存在名称为a的全局变量时，抛出异常；
指令trystglobalbyname 0x3, b：将acc中的值存放到名称为b的全局变量上，不存在名称为b的全局变量时，抛出异常。

注意：

上述指令中出现的0x0，0x2，0x3是方舟运行时内部使用的保留数字，开发者无需关注。

模块命名空间和模块变量

源文件中使用到的所有的模块命名空间（module namespace）都会被编译进一个数组中，指令中使用索引来引用一个模块命名空间。例如，指令getmodulenamespace 0x1引用了索引0x1处的模块命名空间。
源文件中使用到的所有模块变量（module variable）都会被编译进一个数组中，指令通过索引来引用这些模块变量。例如，指令stmodulevar 0x1引用了索引0x1处的模块变量。
在函数中，如果模块变量的声明与该函数位于同一源文件，则该变量称为局部模块变量；否则称为外部模块变量。例如，指令ldlocalmodulevar和ldexternalmodulevar分别用于加载局部模块变量和外部模块变量。
产生模块指令的相关场景，包括import和export，主要场景列举如下：

• import * as：module namespace
• import { }：module variable
• export：local export

注意：

模块相关的逻辑是编译器的内部实现，随着方舟编译器的后续演进，可能会出现新的涉及模块指令的场景；另一方面，现有的模块命名空间和模块变量指令的相关场景，也可能会随着需求演进和代码重构，不再涉及产生模块相关指令。

示例代码：

// ModuleFoo.ts
export let a: number = 1;
export let b: number = 2;

// ModuleBar.ts
export let c: number = 4;

// ModuleIndex.ts
import { a, b } from "./ModuleFoo";
import * as c from "./ModuleBar";

export let d: number = 3;

a + b + d;
c;

.function any .func_main_0(any a0, any a1, any a2) {
    getmodulenamespace 0x1
    ldai 0x3
    stmodulevar 0x0
    ldexternalmodulevar 0x0
    sta v0
    throw.undefinedifholewithname a
    ldexternalmodulevar 0x1
    sta v1
    throw.undefinedifholewithname b
    lda v1
    add2 0x0, v0
    sta v0
    ldlocalmodulevar 0x0
    sta v1
    throw.undefinedifholewithname d
    lda v1
    add2 0x1, v0
    stmodulevar 0x1
    returnundefined
    ...
}

指令getmodulenamespace 0x1：获取1号槽位上的模块命名空间（c），存放到acc中；
指令stmodulevar 0x0：将acc中的值存放到当前模块的0号槽位上；
指令ldexternalmodulevar 0x0：加载外部模块的0号槽位上的值（a），存放到acc中；
指令ldlocalmodulevar 0x0：加载当前局部模块的0号槽位上的值（d），存放到acc中。

词法环境和词法变量

方舟字节码中，词法环境（lexical environment）可以看作是一个具有多个槽位的数组，每个槽位对应一个词法变量（lexical variable），一个方法中可能会存在多个词法环境。指令中使用词法环境的相对层级编号和槽位索引，来表示一个词法变量。例如，指令ldlexvar 0x1, 0x2的含义是：将1个层次外的词法环境的2号槽位上的值存放到acc中。

|xxx|xxx|xxx|xxx|   <-- 当前词法环境外的第1个词法环境
         ^
         |------------ ldlexvar 0x1, 0x2

|xxx|xxx|xxx|xxx|   <-- 当前词法环境

注意：

lexical相关的逻辑是编译器的内部实现。随着方舟编译器的演进，可能会出现新的涉及lexical指令的场景。现有的lexical指令场景也可能会因需求演进和代码重构而不再涉及lexical的相关指令。

示例代码：

// Index.ts
function foo(): void {
  let a: number = 1;
  function bar(): number {
    return a;
  }
}

.function any .foo(any a0, any a1, any a2) {
    newlexenv 0x1
    ...
    definefunc 0x0, .bar, 0x0
    sta v3
    ldai 0x1 
    ...
    stlexvar 0x0, 0x0
    ...
}    

.function any .bar(any a0, any a1, any a2) {
    ...
    ldlexvar 0x0, 0x0
    ...
}

指令newlexenv 0x1：创建一个槽位数为1的词法环境，将其存放到acc中，并进入该词法环境；
指令stlexvar 0x0, 0x0：将acc中的值存放到0个层次外的词法环境的0号槽位上；
指令ldlexvar 0x0, 0x0：将0个层次外的词法环境的0号槽位上的值存放到acc中。

共享词法环境

共享词法环境是一类特殊的词法环境。与一般词法环境的区别在于，共享词法环境中的每个词法变量都是sendable对象。方舟编译器通过共享词法环境实现词法变量在多线程中共享。

示例代码：

@Sendable
class A { }

@Sendable
class B {
  u: A = new A();
}

.function any .#~B=#B(any a0, any a1, any a2) {
label_1: 
label_0: 
    callruntime.ldsendablevar 0x0, 0x0
    sta v0
    throw.undefinedifholewithname A
    ...
label_2: 
}

.function any .func_main_0(any a0, any a1, any a2) {
label_1: 
label_0: 
    callruntime.newsendableenv 0x1
    ...
    callruntime.definesendableclass 0x0, .#~A=#A, _3, 0x0, v0
    callruntime.stsendablevar 0x0, 0x0
    ...
label_2: 
}

指令callruntime.newsendableenv 0x1：创建一个槽位数为1的共享词法环境，并进入该词法环境；
指令callruntime.stsendablevar 0x0, 0x0：将acc中的值存放到0个层次外的共享词法环境的0号槽位上；
指令callruntime.ldsendablevar 0x0, 0x0：将0个层次外的共享词法环境的0号槽位上的值存放到acc中。

补丁变量

方舟编译器支持补丁模式的编译，当源文件发生修改时，经过补丁模式编译，生成一个补丁字节码，配合原字节码，完成功能的更新。方舟编译器在补丁模式下编译时，产生的补丁变量会被存放在一个特殊的补丁词法环境中。方舟字节码中使用补丁词法环境上的槽位编号来引用补丁变量。例如，指令ldpatchvar 0x1加载的是槽位号为1的补丁变量。

示例代码：

function bar(): void {} // 新增语句，编译补丁

function foo2(): void {
  bar(); // 新增语句，编译补丁
}

.function any foo(...) {
    ...
    wide.ldpatchvar 0x0
    sta v4
    lda v4
    callarg0 0x0
    ...
}

.function any patch_main_0(...) {
    newlexenv 0x1
    definefunc 0x1, bar:(any,any,any), 0x0
    wide.stpatchvar 0x0
    ...
}

指令wide.stpatchvar 0x0：将函数bar存放到补丁词法环境的0号槽位；
指令wide.ldpatchvar 0x0：将补丁词法环境上0号槽位的值存放到acc中。

函数调用规范

对于一个包含了N个形参的方法，该方法所使用的寄存器中的最后N+3个会被用于传递参数。其中，前三个寄存器固定表示函数本身（FunctionObject）、new.target（NewTarget）和函数所在的词法环境中的this（this），后续的N个寄存器依次对应这N个形参。

示例代码：

function foo3(a: number, b: number): void {}

.function any .foo(any a0, any a1, any a2, any a3, any a4) {
    // a0: FunctionObject
    // a1: NewTarget
    // a2: this 
    // a3: a
    // a4: b
}

字节码格式说明

字节码汇总集合

下表中汇总了当前版本的所有方舟字节码，寄存器索引、立即数和id通过每四位宽度使用一个字符替代的形式来描述。
以指令defineclasswithbuffer RR, @AAAA, @BBBB, +CCCC, vDD为例：

• defineclasswithbuffer：指示操作的操作码助记符。
• RR：方舟运行时内部使用的8位保留数字，此处提及仅为完整展示指令格式，开发者无需关注。
• @AAAA，@BBBB：16位id。
• +CCCC：16位立即数。
• vDD：8位寄存器索引。