/* This file is part of TON Blockchain Library. TON Blockchain Library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version. TON Blockchain Library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with TON Blockchain Library. If not, see . Copyright 2017-2019 Telegram Systems LLP */ #pragma once #include "common/refcnt.hpp" #include "vm/cellslice.h" #include "vm/stack.hpp" #include "vm/vmstate.h" #include "vm/log.h" namespace vm { using td::Ref; class VmState; class Continuation; class DispatchTable; struct ControlRegs { static constexpr int creg_num = 4, dreg_num = 2, dreg_idx = 4; Ref c[creg_num]; // c0..c3 Ref d[dreg_num]; // c4..c5 Ref c7; // c7 Ref get_c(unsigned idx) const { return idx < creg_num ? c[idx] : Ref{}; } Ref get_d(unsigned idx) const { idx -= dreg_idx; return idx < dreg_num ? d[idx] : Ref{}; } Ref get_c7() const { return c7; } StackEntry get(unsigned idx) const; static bool valid_idx(unsigned idx) { return idx < creg_num || (idx >= dreg_idx && idx < dreg_idx + dreg_num) || idx == 7; } void set_c0(Ref cont) { c[0] = std::move(cont); } void set_c1(Ref cont) { c[1] = std::move(cont); } void set_c2(Ref cont) { c[2] = std::move(cont); } void set_c3(Ref cont) { c[3] = std::move(cont); } void set_c4(Ref cell) { d[0] = std::move(cell); } bool set_c(unsigned idx, Ref cont) { if (idx < creg_num) { c[idx] = std::move(cont); return true; } else { return false; } } bool set_d(unsigned idx, Ref cell) { idx -= dreg_idx; if (idx < dreg_num) { d[idx] = std::move(cell); return true; } else { return false; } } bool set_c7(Ref tuple) { c7 = std::move(tuple); return true; } bool set(unsigned idx, StackEntry value); void define_c0(Ref cont) { if (c[0].is_null()) { c[0] = std::move(cont); } } void define_c1(Ref cont) { if (c[1].is_null()) { c[1] = std::move(cont); } } void define_c2(Ref cont) { if (c[2].is_null()) { c[2] = std::move(cont); } } bool define_c(unsigned idx, Ref cont) { if (idx < creg_num && c[idx].is_null()) { c[idx] = std::move(cont); return true; } else { return false; } } bool define_d(unsigned idx, Ref cell) { idx -= dreg_idx; if (idx < dreg_num && d[idx].is_null()) { d[idx] = std::move(cell); return true; } else { return false; } } void define_c4(Ref cell) { if (d[0].is_null()) { d[0] = std::move(cell); } } bool define_c7(Ref tuple) { if (c7.is_null()) { c7 = std::move(tuple); } return true; } bool define(unsigned idx, StackEntry value); ControlRegs& operator&=(const ControlRegs& save); // clears all c[i]'s which are present in save ControlRegs& operator^=(const ControlRegs& save); // sets c[i]=save.c[i] for all save.c[i] != 0 ControlRegs& operator^=(ControlRegs&& save); }; struct ControlData { Ref stack; ControlRegs save; int nargs; int cp; ControlData() : nargs(-1), cp(-1) { } ControlData(int _cp) : nargs(-1), cp(_cp) { } ControlData(Ref _stack) : stack(std::move(_stack)), nargs(-1), cp(-1) { } ControlData(int _cp, Ref _stack, int _nargs = -1) : stack(std::move(_stack)), nargs(_nargs), cp(_cp) { } }; class Continuation : public td::CntObject { public: virtual int jump(VmState* st) const & = 0; virtual int jump_w(VmState* st) &; virtual ControlData* get_cdata() { return 0; } virtual const ControlData* get_cdata() const { return 0; } bool has_c0() const; Continuation() { } Continuation(const Continuation&) = default; Continuation(Continuation&&) { } Continuation& operator=(const Continuation&) { return *this; } Continuation& operator=(Continuation&&) { return *this; } ~Continuation() override = default; }; class QuitCont : public Continuation { int exit_code; public: QuitCont(int _code = 0) : exit_code(_code) { } ~QuitCont() override = default; int jump(VmState* st) const & override { return ~exit_code; } }; class ExcQuitCont : public Continuation { public: ExcQuitCont() = default; ~ExcQuitCont() override = default; int jump(VmState* st) const & override; }; class PushIntCont : public Continuation { int push_val; Ref next; public: PushIntCont(int val, Ref _next) : push_val(val), next(_next) { } ~PushIntCont() override = default; int jump(VmState* st) const & override; int jump_w(VmState* st) & override; }; class RepeatCont : public Continuation { Ref body, after; long long count; public: RepeatCont(Ref _body, Ref _after, long long _count) : body(std::move(_body)), after(std::move(_after)), count(_count) { } ~RepeatCont() override = default; int jump(VmState* st) const & override; int jump_w(VmState* st) & override; }; class AgainCont : public Continuation { Ref body; public: AgainCont(Ref _body) : body(std::move(_body)) { } ~AgainCont() override = default; int jump(VmState* st) const & override; int jump_w(VmState* st) & override; }; class UntilCont : public Continuation { Ref body, after; public: UntilCont(Ref _body, Ref _after) : body(std::move(_body)), after(std::move(_after)) { } ~UntilCont() override = default; int jump(VmState* st) const & override; int jump_w(VmState* st) & override; }; class WhileCont : public Continuation { Ref cond, body, after; bool chkcond; public: WhileCont(Ref _cond, Ref _body, Ref _after, bool _chk = true) : cond(std::move(_cond)), body(std::move(_body)), after(std::move(_after)), chkcond(_chk) { } ~WhileCont() override = default; int jump(VmState* st) const & override; int jump_w(VmState* st) & override; }; class ArgContExt : public Continuation { ControlData data; Ref ext; public: ArgContExt(Ref _ext) : data(), ext(_ext) { } ArgContExt(Ref _ext, Ref _stack) : data(_stack), ext(_ext) { } ArgContExt(const ArgContExt&) = default; ArgContExt(ArgContExt&&) = default; ~ArgContExt() override = default; int jump(VmState* st) const & override; int jump_w(VmState* st) & override; ControlData* get_cdata() override { return &data; } const ControlData* get_cdata() const override { return &data; } td::CntObject* make_copy() const override { return new ArgContExt{*this}; } }; class OrdCont : public Continuation { ControlData data; Ref code; friend class VmState; public: OrdCont() : data(), code() { } //OrdCont(Ref _code) : data(), code(std::move(_code)) {} OrdCont(Ref _code, int _cp) : data(_cp), code(std::move(_code)) { } //OrdCont(Ref _code, Ref _stack) : data(std::move(_stack)), code(std::move(_code)) {} OrdCont(Ref _code, int _cp, Ref _stack, int nargs = -1) : data(_cp, std::move(_stack), nargs), code(std::move(_code)) { } OrdCont(const OrdCont&) = default; OrdCont(OrdCont&&) = default; ~OrdCont() override = default; td::CntObject* make_copy() const override { return new OrdCont{*this}; } int jump(VmState* st) const & override; int jump_w(VmState* st) & override; ControlData* get_cdata() override { return &data; } const ControlData* get_cdata() const override { return &data; } Stack& get_stack() { return data.stack.write(); } const Stack& get_stack_const() const { return *(data.stack); } Ref get_stack_ref() const { return data.stack; } Ref copy_ord() const & { return Ref{true, *this}; } Ref copy_ord() && { return Ref{true, *this}; } }; struct GasLimits { static constexpr long long infty = (1ULL << 63) - 1; long long gas_max, gas_limit, gas_credit, gas_remaining, gas_base; GasLimits() : gas_max(infty), gas_limit(infty), gas_credit(0), gas_remaining(infty), gas_base(infty) { } GasLimits(long long _limit, long long _max = infty, long long _credit = 0) : gas_max(_max) , gas_limit(_limit) , gas_credit(_credit) , gas_remaining(_limit + _credit) , gas_base(gas_remaining) { } long long gas_consumed() const { return gas_base - gas_remaining; } void set_limits(long long _max, long long _limit, long long _credit = 0); void change_base(long long _base) { gas_remaining += _base - gas_base; gas_base = _base; } void change_limit(long long _limit); void consume(long long amount) { // LOG(DEBUG) << "consume " << amount << " gas (" << gas_remaining << " remaining)"; gas_remaining -= amount; } bool try_consume(long long amount) { // LOG(DEBUG) << "try consume " << amount << " gas (" << gas_remaining << " remaining)"; return (gas_remaining -= amount) >= 0; } void gas_exception() const; void gas_exception(bool cond) const { if (!cond) { gas_exception(); } } void consume_chk(long long amount) { gas_exception(try_consume(amount)); } void check() const { gas_exception(gas_remaining >= 0); } bool final_ok() const { return gas_remaining >= gas_credit; } }; class VmState final : public VmStateInterface { Ref code; Ref stack; ControlRegs cr; int cp; long long steps{0}; const DispatchTable* dispatch; Ref quit0, quit1; VmLog log; GasLimits gas; std::vector> libraries; int stack_trace{0}, debug_off{0}; public: static constexpr unsigned cell_load_gas_price = 100, cell_create_gas_price = 500, exception_gas_price = 50, tuple_entry_gas_price = 1; VmState(); VmState(Ref _code); VmState(Ref _code, Ref _stack, int flags = 0, Ref _data = {}, VmLog log = {}, std::vector> _libraries = {}, Ref init_c7 = {}); VmState(Ref _code, Ref _stack, const GasLimits& _gas, int flags = 0, Ref _data = {}, VmLog log = {}, std::vector> _libraries = {}, Ref init_c7 = {}); template VmState(Ref code_cell, Args&&... args) : VmState(convert_code_cell(std::move(code_cell)), std::forward(args)...) { } bool set_gas_limits(long long _max, long long _limit, long long _credit = 0); bool final_gas_ok() const { return gas.final_ok(); } long long gas_consumed() const { return gas.gas_consumed(); } void consume_gas(long long amount) { gas.consume(amount); } void consume_tuple_gas(unsigned tuple_len) { consume_gas(tuple_len * tuple_entry_gas_price); } void consume_tuple_gas(const Ref& tup) { if (tup.not_null()) { consume_tuple_gas((unsigned)tup->size()); } } GasLimits get_gas_limits() const { return gas; } void change_gas_limit(long long new_limit); template void check_underflow(Args... args) { stack->check_underflow(args...); } bool register_library_collection(Ref lib); Ref load_library( td::ConstBitPtr hash) override; // may throw a dictionary exception; returns nullptr if library is not found void register_cell_load() override; void register_cell_create() override; bool init_cp(int new_cp); bool set_cp(int new_cp); void force_cp(int new_cp); int get_cp() const { return cp; } int incr_stack_trace(int v) { return stack_trace += v; } long long get_steps_count() const { return steps; } td::BitArray<256> get_state_hash() const; td::BitArray<256> get_final_state_hash(int exit_code) const; int step(); int run(); Stack& get_stack() { return stack.write(); } const Stack& get_stack_const() const { return *stack; } Ref get_stack_ref() const { return stack; } Ref get_c0() const { return cr.c[0]; } Ref get_c1() const { return cr.c[1]; } Ref get_c2() const { return cr.c[2]; } Ref get_c3() const { return cr.c[3]; } Ref get_c4() const { return cr.d[0]; } Ref get_c7() const { return cr.c7; } Ref get_c(unsigned idx) const { return cr.get_c(idx); } Ref get_d(unsigned idx) const { return cr.get_d(idx); } StackEntry get(unsigned idx) const { return cr.get(idx); } const VmLog& get_log() const { return log; } void define_c0(Ref cont) { cr.define_c0(std::move(cont)); } void set_c0(Ref cont) { cr.set_c0(std::move(cont)); } void set_c1(Ref cont) { cr.set_c1(std::move(cont)); } void set_c2(Ref cont) { cr.set_c2(std::move(cont)); } bool set_c(unsigned idx, Ref val) { return cr.set_c(idx, std::move(val)); } bool set_d(unsigned idx, Ref val) { return cr.set_d(idx, std::move(val)); } void set_c4(Ref val) { cr.set_c4(std::move(val)); } bool set_c7(Ref val) { return cr.set_c7(std::move(val)); } bool set(unsigned idx, StackEntry val) { return cr.set(idx, std::move(val)); } void set_stack(Ref new_stk) { stack = std::move(new_stk); } Ref swap_stack(Ref new_stk) { stack.swap(new_stk); return new_stk; } void ensure_throw(bool cond) const { if (!cond) { fatal(); } } void set_code(Ref _code, int _cp) { code = std::move(_code); force_cp(_cp); } Ref get_code() const { return code; } void push_code() { get_stack().push_cellslice(get_code()); } void adjust_cr(const ControlRegs& save) { cr ^= save; } void adjust_cr(ControlRegs&& save) { cr ^= save; } void preclear_cr(const ControlRegs& save) { cr &= save; } int call(Ref cont); int call(Ref cont, int pass_args, int ret_args = -1); int jump(Ref cont); int jump(Ref cont, int pass_args); int ret(); int ret(int ret_args); int ret_alt(); int ret_alt(int ret_args); int repeat(Ref body, Ref after, long long count); int again(Ref body); int until(Ref body, Ref after); int loop_while(Ref cond, Ref body, Ref after); int throw_exception(int excno, StackEntry&& arg); int throw_exception(int excno); Ref extract_cc(int save_cr = 1, int stack_copy = -1, int cc_args = -1); void fatal(void) const { throw VmFatal{}; } int jump_to(Ref cont) { return cont->is_unique() ? cont.unique_write().jump_w(this) : cont->jump(this); } static Ref convert_code_cell(Ref code_cell); private: void init_cregs(bool same_c3 = false, bool push_0 = true); }; int run_vm_code(Ref _code, Ref& _stack, int flags = 0, Ref* data_ptr = 0, VmLog log = {}, long long* steps = nullptr, GasLimits* gas_limits = nullptr, std::vector> libraries = {}, Ref init_c7 = {}); int run_vm_code(Ref _code, Stack& _stack, int flags = 0, Ref* data_ptr = 0, VmLog log = {}, long long* steps = nullptr, GasLimits* gas_limits = nullptr, std::vector> libraries = {}, Ref init_c7 = {}); ControlData* force_cdata(Ref& cont); ControlRegs* force_cregs(Ref& cont); Ref lookup_library_in(td::ConstBitPtr key, Ref lib_root); } // namespace vm