21043080682

Committed 15 Jan 2026 07:07PM UTC coverage: 91.835% (-0.9%) from 92.743%

Build # 21043080682

Build Type

Pull #628

github

Committed by

web-flow

Commit Message

Merge 453e86f68 into ada0e0686

Pull Request Pull Request #628: Feat/debugger

Run Details

131 of 242 new or added lines in 10 files covered. (54.13%)

2 existing lines in 1 file now uncovered.

8571 of 9333 relevant lines covered (91.84%)

276580.72 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

80.86

/src/arkreactor/State.cpp

#include <Ark/State.hpp>

#include <Ark/Constants.hpp>
#include <Ark/Utils/Files.hpp>
#include <Ark/Compiler/Welder.hpp>

#ifdef _MSC_VER
#    pragma warning(push)
#    pragma warning(disable : 4996)
#endif

#include <Proxy/Picosha2.hpp>
#include <Ark/Compiler/BytecodeReader.hpp>
#include <fmt/core.h>
#include <fmt/color.h>

namespace Ark
{
    State::State(const std::vector<std::filesystem::path>& libenv) noexcept :
        m_debug_level(0),
        m_features(0),
        m_libenv(libenv),
        m_filename(ARK_NO_NAME_FILE),
        m_max_page_size(0)
    {
        // default value for builtin__sys:args is empty list
        const Value val(ValueType::List);
        m_bound[std::string(internal::Language::SysArgs)] = val;

        m_bound[std::string(internal::Language::SysProgramName)] = Value("");
    }

    bool State::feed(const std::string& bytecode_filename, const bool fail_with_exception)
    {
        if (!Utils::fileExists(bytecode_filename))
            return false;

        return feed(Utils::readFileAsBytes(bytecode_filename), fail_with_exception);
    }

    bool State::feed(const bytecode_t& bytecode, const bool fail_with_exception)
    {
        BytecodeReader bcr;
        bcr.feed(bytecode);
        if (!bcr.checkMagic())
            return false;

        m_bytecode = bytecode;

        try
        {
            configure(bcr);
            return true;
        }
        catch (const std::exception& e)
        {
            if (fail_with_exception)
                throw;

            fmt::println("{}", e.what());
            return false;
        }
    }

    bool State::compile(const std::string& file, const std::string& output) const
    {
        Welder welder(m_debug_level, m_libenv, m_features);
        for (const auto& key : m_bound | std::views::keys)
            welder.registerSymbol(key);

        if (!welder.computeASTFromFile(file))
            return false;
        if (!welder.generateBytecode())
            return false;

        const std::string destination = output.empty() ? (file.substr(0, file.find_last_of('.')) + ".arkc") : output;
        if (!welder.saveBytecodeToFile(destination))
            return false;

        return true;
    }

    bool State::doFile(const std::string& file_path, const uint16_t features)
    {
        m_features = features;

        if (!Utils::fileExists(file_path))
        {
            fmt::print(fmt::fg(fmt::color::red), "Can not find file '{}'\n", file_path);
            return false;
        }
        m_filename = file_path;
        m_bound[std::string(internal::Language::SysProgramName)] = Value(std::filesystem::path(m_filename).filename().string());

        const bytecode_t bytecode = Utils::readFileAsBytes(file_path);
        BytecodeReader bcr;
        bcr.feed(bytecode);
        if (!bcr.checkMagic())  // couldn't read magic number, it's a source file
        {
            // check if it's in the arkscript cache
            const std::string filename = std::filesystem::path(file_path).filename().replace_extension(".arkc").string();
            const std::filesystem::path cache_directory = std::filesystem::path(file_path).parent_path() / ARK_CACHE_DIRNAME;
            const std::string bytecode_path = (cache_directory / filename).string();

            if (!exists(cache_directory))
                create_directory(cache_directory);

            if (compile(file_path, bytecode_path) && feed(bytecode_path))
                return true;
        }
        else if (feed(bytecode))  // it's a bytecode file
            return true;
        return false;
    }

    bool State::doString(const std::string& code, const uint16_t features)
    {
        m_features = features;

        Welder welder(m_debug_level, m_libenv, m_features);
        for (const auto& p : m_bound)
            welder.registerSymbol(p.first);

        if (!welder.computeASTFromString(code))
            return false;
        if (!welder.generateBytecode())
            return false;
        return feed(welder.bytecode());
    }

    void State::loadFunction(const std::string& name, Procedure::CallbackType&& function) noexcept
    {
        m_bound[name] = Value(std::move(function));
    }

    void State::setArgs(const std::vector<std::string>& args) noexcept
    {
        Value val(ValueType::List);
        std::ranges::transform(args, std::back_inserter(val.list()), [](const std::string& arg) {
            return Value(arg);
        });

        m_bound[std::string(internal::Language::SysArgs)] = val;
    }

    void State::setDebug(const unsigned level) noexcept
    {
        m_debug_level = level;
    }

    void State::setLibDirs(const std::vector<std::filesystem::path>& libenv) noexcept
    {
        m_libenv = libenv;
    }

    void State::configure(const BytecodeReader& bcr)
    {
        using namespace internal;

        const auto [major, minor, patch] = bcr.version();
        if (major != ARK_VERSION_MAJOR)
        {
            const std::string str_version = fmt::format("{}.{}.{}", major, minor, patch);
            throwStateError(fmt::format("Compiler and VM versions don't match: got {} while running {}", str_version, ARK_VERSION));
        }

        const auto bytecode_hash = bcr.sha256();

        std::vector<unsigned char> hash(picosha2::k_digest_size);
        picosha2::hash256(m_bytecode.begin() + bytecode::HeaderSize + picosha2::k_digest_size, m_bytecode.end(), hash);
        // checking integrity
        for (std::size_t j = 0; j < picosha2::k_digest_size; ++j)
        {
#ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
            if (hash[j] != bytecode_hash[j])
                throwStateError("Integrity check failed");
#endif
        }

        const auto syms = bcr.symbols();
        const auto vals = bcr.values(syms);
        const auto files = bcr.filenames(vals);
        const auto inst_locs = bcr.instLocations(files);
        const auto [pages, _] = bcr.code(inst_locs);

        m_symbols = syms.symbols;
        m_constants = vals.values;
        m_filenames = files.filenames;
        m_inst_locations = inst_locs.locations;
        m_pages = pages;
        m_max_page_size = maxPageSize(m_pages);

        // Make m_code as a big contiguous chunk of instructions,
        // aligned on the biggest page size.
        // This might have a downside when we have a single big page and
        // a bunch of smaller ones, though I couldn't measure it while testing.
        m_code.resize(m_max_page_size * pages.size(), Instruction::NOP);
        addPagesToContiguousBytecode(pages, /* start= */ 0);
    }

    void State::reset() noexcept
    {
        m_symbols.clear();
        m_constants.clear();
        m_filenames.clear();
        m_inst_locations.clear();
        m_max_page_size = 0;
        m_code.clear();
        m_bound.clear();

        // default value for builtin__sys:args is empty list
        const Value val(ValueType::List);
        m_bound[std::string(internal::Language::SysArgs)] = val;

        m_bound[std::string(internal::Language::SysProgramName)] = Value("");
    }

    void State::addPagesToContiguousBytecode(const std::vector<bytecode_t>& pages, const std::size_t start)
    {
        for (std::size_t i = 0, end = pages.size(); i < end; ++i)
        {
            for (std::size_t j = 0, end_j = pages[i].size(); j < end_j; ++j)
                m_code[(start + i) * m_max_page_size + j] = pages[i][j];
        }
    }

    std::size_t State::maxPageSize(const std::vector<bytecode_t>& pages)
    {
        return std::ranges::max(pages, {}, &bytecode_t::size).size();
    }

    void State::extendBytecode(const std::vector<bytecode_t>& pages, const std::vector<std::string>& symbols, const std::vector<Value>& constants)
    {
        m_symbols = symbols;
        m_constants = constants;

        // do not modify m_pages so that we can start over
        m_max_page_size = std::max(m_max_page_size, maxPageSize(pages));

        m_code.resize(m_max_page_size * (m_pages.size() + pages.size()), internal::Instruction::NOP);
        addPagesToContiguousBytecode(m_pages, /* start= */ 0);
        addPagesToContiguousBytecode(pages, /* start= */ m_pages.size());
    }
}

#ifdef _MSC_VER
#    pragma warning(pop)
#endif

1	#include <Ark/State.hpp>
2
3	#include <Ark/Constants.hpp>
4	#include <Ark/Utils/Files.hpp>
5	#include <Ark/Compiler/Welder.hpp>
6
7	#ifdef _MSC_VER
8	# pragma warning(push)
9	# pragma warning(disable : 4996)
10	#endif
11
12	#include <Proxy/Picosha2.hpp>
13	#include <Ark/Compiler/BytecodeReader.hpp>
14	#include <fmt/core.h>
15	#include <fmt/color.h>
16
17	namespace Ark
18	{
19	State::State(const std::vector<std::filesystem::path>& libenv) noexcept :	1,005✔
20	m_debug_level(0),	335✔
21	m_features(0),	335✔
22	m_libenv(libenv),	335✔
23	m_filename(ARK_NO_NAME_FILE),	335✔
24	m_max_page_size(0)	335✔
25	{	335✔
26	// default value for builtin__sys:args is empty list
27	const Value val(ValueType::List);	335✔
28	m_bound[std::string(internal::Language::SysArgs)] = val;	335✔
29
30	m_bound[std::string(internal::Language::SysProgramName)] = Value("");	335✔
31	}	335✔
32
33	bool State::feed(const std::string& bytecode_filename, const bool fail_with_exception)	201✔
34	{	201✔
35	if (!Utils::fileExists(bytecode_filename))	201✔
36	return false;	×
37
38	return feed(Utils::readFileAsBytes(bytecode_filename), fail_with_exception);	201✔
39	}	201✔
40
41	bool State::feed(const bytecode_t& bytecode, const bool fail_with_exception)	217✔
42	{	217✔
43	BytecodeReader bcr;	217✔
44	bcr.feed(bytecode);	217✔
45	if (!bcr.checkMagic())	217✔
46	return false;	×
47
48	m_bytecode = bytecode;	217✔
49
50	try
51	{
52	configure(bcr);	217✔
53	return true;	215✔
54	}	2✔
55	catch (const std::exception& e)
56	{
57	if (fail_with_exception)	2✔
58	throw;	2✔
59
60	fmt::println("{}", e.what());	×
61	return false;	×
62	}	2✔
63	}	221✔
64
65	bool State::compile(const std::string& file, const std::string& output) const	312✔
66	{	312✔
67	Welder welder(m_debug_level, m_libenv, m_features);	312✔
68	for (const auto& key : m_bound \| std::views::keys)	936✔
69	welder.registerSymbol(key);	624✔
70
71	if (!welder.computeASTFromFile(file))	312✔
72	return false;	×
73	if (!welder.generateBytecode())	238✔
74	return false;	×
75
76	const std::string destination = output.empty() ? (file.substr(0, file.find_last_of('.')) + ".arkc") : output;	201✔
77	if (!welder.saveBytecodeToFile(destination))	201✔
78	return false;	×
79
80	return true;	201✔
81	}	312✔
82
83	bool State::doFile(const std::string& file_path, const uint16_t features)	312✔
84	{	312✔
85	m_features = features;	312✔
86
87	if (!Utils::fileExists(file_path))	312✔
88	{
89	fmt::print(fmt::fg(fmt::color::red), "Can not find file '{}'\n", file_path);	×
90	return false;	×
91	}
92	m_filename = file_path;	312✔
93	m_bound[std::string(internal::Language::SysProgramName)] = Value(std::filesystem::path(m_filename).filename().string());	423✔
94
95	const bytecode_t bytecode = Utils::readFileAsBytes(file_path);	312✔
96	BytecodeReader bcr;	312✔
97	bcr.feed(bytecode);	312✔
98	if (!bcr.checkMagic()) // couldn't read magic number, it's a source file	312✔
99	{
100	// check if it's in the arkscript cache
101	const std::string filename = std::filesystem::path(file_path).filename().replace_extension(".arkc").string();	312✔
102	const std::filesystem::path cache_directory = std::filesystem::path(file_path).parent_path() / ARK_CACHE_DIRNAME;	312✔
103	const std::string bytecode_path = (cache_directory / filename).string();	312✔
104
105	if (!exists(cache_directory))	312✔
106	create_directory(cache_directory);	17✔
107
108	if (compile(file_path, bytecode_path) && feed(bytecode_path))	312✔
109	return true;	201✔
110	}	312✔
111	else if (feed(bytecode)) // it's a bytecode file	×
112	return true;	×
113	return false;	×
114	}	423✔
115
116	bool State::doString(const std::string& code, const uint16_t features)	12✔
117	{	12✔
118	m_features = features;	12✔
119
120	Welder welder(m_debug_level, m_libenv, m_features);	12✔
121	for (const auto& p : m_bound)	44✔
122	welder.registerSymbol(p.first);	32✔
123
124	if (!welder.computeASTFromString(code))	12✔
125	return false;	×
126	if (!welder.generateBytecode())	12✔
127	return false;	×
128	return feed(welder.bytecode());	12✔
129	}	12✔
130
131	void State::loadFunction(const std::string& name, Procedure::CallbackType&& function) noexcept	8✔
132	{	8✔
133	m_bound[name] = Value(std::move(function));	8✔
134	}	8✔
135
136	void State::setArgs(const std::vector<std::string>& args) noexcept	10✔
137	{	10✔
138	Value val(ValueType::List);	10✔
139	std::ranges::transform(args, std::back_inserter(val.list()), [](const std::string& arg) {	13✔
140	return Value(arg);	3✔
141	});
142
143	m_bound[std::string(internal::Language::SysArgs)] = val;	10✔
144	}	10✔
145
146	void State::setDebug(const unsigned level) noexcept	1✔
147	{	1✔
148	m_debug_level = level;	1✔
149	}	1✔
150
151	void State::setLibDirs(const std::vector<std::filesystem::path>& libenv) noexcept	×
152	{	×
153	m_libenv = libenv;	×
154	}	×
155
156	void State::configure(const BytecodeReader& bcr)	217✔
157	{	217✔
158	using namespace internal;
159
160	const auto [major, minor, patch] = bcr.version();	217✔
161	if (major != ARK_VERSION_MAJOR)	217✔
162	{
163	const std::string str_version = fmt::format("{}.{}.{}", major, minor, patch);	2✔
164	throwStateError(fmt::format("Compiler and VM versions don't match: got {} while running {}", str_version, ARK_VERSION));	1✔
165	}	1✔
166
167	const auto bytecode_hash = bcr.sha256();	216✔
168
169	std::vector<unsigned char> hash(picosha2::k_digest_size);	216✔
170	picosha2::hash256(m_bytecode.begin() + bytecode::HeaderSize + picosha2::k_digest_size, m_bytecode.end(), hash);	216✔
171	// checking integrity
172	for (std::size_t j = 0; j < picosha2::k_digest_size; ++j)	7,099✔
173	{
174	#ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
175	if (hash[j] != bytecode_hash[j])	6,883✔
176	throwStateError("Integrity check failed");	1✔
177	#endif
178	}	6,882✔
179
180	const auto syms = bcr.symbols();	215✔
181	const auto vals = bcr.values(syms);	215✔
182	const auto files = bcr.filenames(vals);	215✔
183	const auto inst_locs = bcr.instLocations(files);	215✔
184	const auto [pages, _] = bcr.code(inst_locs);	645✔
185
186	m_symbols = syms.symbols;	215✔
187	m_constants = vals.values;	215✔
188	m_filenames = files.filenames;	215✔
189	m_inst_locations = inst_locs.locations;	215✔
190	m_pages = pages;	215✔
191	m_max_page_size = maxPageSize(m_pages);	215✔
192
193	// Make m_code as a big contiguous chunk of instructions,
194	// aligned on the biggest page size.
195	// This might have a downside when we have a single big page and
196	// a bunch of smaller ones, though I couldn't measure it while testing.
197	m_code.resize(m_max_page_size * pages.size(), Instruction::NOP);	215✔
198	addPagesToContiguousBytecode(pages, /* start= */ 0);	215✔
199	}	219✔
200
201	void State::reset() noexcept	×
202	{	×
203	m_symbols.clear();	×
204	m_constants.clear();	×
205	m_filenames.clear();	×
206	m_inst_locations.clear();	×
207	m_max_page_size = 0;	×
208	m_code.clear();	×
NEW 209	m_bound.clear();	×
210
211	// default value for builtin__sys:args is empty list
212	const Value val(ValueType::List);	×
NEW 213	m_bound[std::string(internal::Language::SysArgs)] = val;	×
214
NEW 215	m_bound[std::string(internal::Language::SysProgramName)] = Value("");	×
NEW 216	}	×
217
218	void State::addPagesToContiguousBytecode(const std::vector<bytecode_t>& pages, const std::size_t start)	217✔
219	{	217✔
220	for (std::size_t i = 0, end = pages.size(); i < end; ++i)	4,171✔
221	{
222	for (std::size_t j = 0, end_j = pages[i].size(); j < end_j; ++j)	374,622✔
223	m_code[(start + i) * m_max_page_size + j] = pages[i][j];	370,668✔
224	}	3,954✔
225	}	217✔
226
227	std::size_t State::maxPageSize(const std::vector<bytecode_t>& pages)	216✔
228	{	216✔
229	return std::ranges::max(pages, {}, &bytecode_t::size).size();	216✔
230	}
231
232	void State::extendBytecode(const std::vector<bytecode_t>& pages, const std::vector<std::string>& symbols, const std::vector<Value>& constants)	1✔
233	{	1✔
234	m_symbols = symbols;	1✔
235	m_constants = constants;	1✔
236
237	// do not modify m_pages so that we can start over
238	m_max_page_size = std::max(m_max_page_size, maxPageSize(pages));	1✔
239
240	m_code.resize(m_max_page_size * (m_pages.size() + pages.size()), internal::Instruction::NOP);	1✔
241	addPagesToContiguousBytecode(m_pages, /* start= */ 0);	1✔
242	addPagesToContiguousBytecode(pages, /* start= */ m_pages.size());	1✔
243	}	1✔
244	}
245
246	#ifdef _MSC_VER
247	# pragma warning(pop)
248	#endif

ArkScript-lang / Ark / 21043080682

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous