Runtime

• Introduction
• Directory Structure
• Usage Guidelines
• Repositories Involved

Introduction

As a common module of ARK runtime, Runtime consists of some basic language-irrelevant runtime libraries, including ARK File, Tooling, and ARK Base. ARK File provides bytecodes and information required for executing bytecodes. Tooling supports Debugger. ARK Base is responsible for implementing system calls.

Directory Structure

/ark/runtime_core
├── assembler             # Assembler that converts an ARK bytecode file (*.pa) in text format into a bytecode file (*.abc) in binary format. For details about the format, see docs/assembly_format.md and docs/file_format.md.
├── cmake                 # cmake script that contains the toolchain files and common cmake functions used to define the build and test targets.
├── CMakeLists.txt        # cmake main entry file.
├── disassembler          # Disassembler that converts an ARK bytecode file (*.abc) in binary format into an ARK bytecode file (*.pa) in text format.
├── docs                  # Language frontend, ARK file format, and runtime design documents.
├── dprof                 # Data used to collect the profiling data for ARK runtime.
├── gn                    # GN templates and configuration files.
├── isa                   # Bytecode ISA description file YAML, and Ruby scripts and templates.
├── ldscripts             # Linker scripts used to place ELF sections larger than 4 GB in a non-PIE executable file.
├── libpandabase          # Basic ARK runtime library, including logs, synchronization primitives, and common data structure.
├── libpandafile          # Source code repository of ARK bytecode files (*.abc) in binary format.
├── libziparchive         # provides APIs for reading and using zip files implemented by miniz.
├── panda                 # CLI tool used to execute ARK bytecode files (*.abc).
├── pandastdlib           # Standard libraries wrote by the ARK assembler.
├── resources             # CI jobs description files.
├── runtime               # ARK runtime command module.
├── scripts               # CI scripts.
├── templates             # Ruby templates and scripts used to process command line options, loggers, error messages, and events.
├── tests                 # UT test cases.
└── verification          # Bytecode verifier. See docs/bc_verification.

Usage Guidelines

Assembler ark_asm

The ark_asm assembler converts a text ARK bytecode file into a bytecode file in binary format.

Command:

ark_asm [Option] Input file Output file

Option	Description
--dump-scopes	Saves the result to a JSON file to support the debug mode in Visual Studio Code.
--help	Displays help information.
--log-file	Specifies the log file output path after log printing is enabled.
--optimize	Enables compilation optimization.
--size-stat	Collects statistics on and prints ARK bytecode information after conversion.
--verbose	Enables log printing.

Input file: ARK bytecodes in text format

Output file: ARK bytecodes in binary format

Disassembler ark_dissam

The ark_dissam disassembler converts a bytecode file in binary format into a text ARK bytecode file.

Command:

ark_dissam [Option] Input file Output file

Option	Description
--debug	Enables the function for printing debug information.
--debug-file	Specifies the path of the debug information output file. The default value is std::cout.
--help	Displays help information.
--verbose	Outputs the comments of the output file.

Input file: ARK bytecodes in binary format

Output file: ARK bytecodes in text format

Repositories Involved

ARK Runtime Subsystem

ark/runtime_core

ark/js_runtime

ark/ts2abc