Merge pull request #214 from ArkScript-lang/refacto

Bumping to 3.0.15 + a few nice enhancements

Author: PierrePharel

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased changes
 ### Added
+
+### Changed
+
+### Removed
+
+## 3.0.15
+### Added
 - new submodule, plasma-umass/coz (a profiler)
 - macros for profiling, enabled only if `ARK_PROFILE` is defined
 - cmake flags using -D to turn on/off sys:exec and the coz profiler
@@ -20,8 +27,8 @@
 - replaced the thirdparty/ folder with a git submodule in thirdparties/
 - now checking that a scope doesn't have our symbol before doing a `mut` operation (in dichotomic mode it was automatically handled, but not in linear mode)
 - enhancing the cmake defines (`-DARK_XYZ`) and the code using them
-
-### Removed
+- lighter Frame (from 40B to 32B), moved some unrelated logic from the frame to the virtual machine
+- `(sys:exec)` now returns the stdout output of the given command
 
 ## 3.0.14
 ### Added

CMakeLists.txt

@@ -34,7 +34,7 @@ set(REPLXX_INCLUDE_DIR "${ark_SOURCE_DIR}/submodules/replxx/include")
 # VERSION
 set(ARK_VERSION_MAJOR  3)
 set(ARK_VERSION_MINOR  0)
-set(ARK_VERSION_PATCH 14)
+set(ARK_VERSION_PATCH 15)
 
 message(STATUS "ArkScript version ${ARK_VERSION_MAJOR}.${ARK_VERSION_MINOR}.${ARK_VERSION_PATCH}")
 if (ARK_PROFILER)

README.md

@@ -146,14 +146,12 @@ For performance reasons, some functions might be written in C++, in `include/Ark
     * Install a newer compiler using [Homebrew](https://docs.brew.sh/): `brew install gcc && brew link gcc`
     * Pass compiler path to `cmake` in the build step: `-DCMAKE_CXX_COMPILER=/usr/local/bin/g++-9`
 
-Libs already included:
-* [CLIPP](https://github.com/muellan/clipp), MIT licence
-* [termcolor](https://github.com/ikalnytskyi/termcolor), BSD (3-clause) licence
+Some libs already included un [thirdparties](https://github.com/ArkScript-lang/thirdparties).
 
 ## Building
 
 Different CMake switches are available to customize the build:
-* `-DARK_BUILD_EXE` to generate an executable, defaults to Off, building a shared library
+* `-DARK_BUILD_EXE` to generate an executable, defaults to Off, building a shared library only
 * `-DARK_ENABLE_SYSTEM` to enable `sys:exec` (execute shell commands without restrictions), defaults to On
 * `-DARK_PROFILER` to enable the [coz](https://github.com/plasma-umass/coz) profiler, defaults to Off
 * `-DARK_PROFILER_COUNT` to count every creation/copy/move of the internal value type, defaults to Off

include/Ark/VM/Closure.hpp

@@ -84,7 +84,7 @@ namespace Ark::internal
         friend inline bool operator==(const Closure& A, const Closure& B) noexcept;
         friend inline bool operator<(const Closure& A, const Closure& B) noexcept;
         friend std::ostream& operator<<(std::ostream& os, const Closure& C) noexcept;
-    
+
     private:
         Scope_t m_scope;
         // keep track of the code page number, in case we need it later

include/Ark/VM/Frame.hpp

@@ -49,9 +49,8 @@ namespace Ark::internal
          * 
          * @param caller_addr the address of the caller, to return to it afterward
          * @param caller_page_addr the page address of the caller
-         * @param new_pp the new page address where we're going
          */
-        Frame(uint16_t caller_addr, uint16_t caller_page_addr, uint16_t new_pp) noexcept;
+        Frame(uint16_t caller_addr, uint16_t caller_page_addr) noexcept;
 
         // stack related
 
@@ -99,50 +98,12 @@ namespace Ark::internal
          */
         inline uint16_t callerPageAddr() const noexcept;
 
-        /**
-         * @brief Get the current page address
-         * 
-         * @return uint16_t 
-         */
-        inline uint16_t currentPageAddr() const noexcept;
-
-        // related to scope deletion
-
-        /**
-         * @brief Increment the number of scopes linked to this frame
-         * 
-         * Needed for the primitive garbage collecting system.
-         * 
-         */
-        inline void incScopeCountToDelete() noexcept;
-
-        /**
-         * @brief Reset the number of scopes linked to this frame
-         * 
-         * Needed for the primitive garbage collecting system.
-         * 
-         */
-        inline void resetScopeCountToDelete() noexcept;
-
-        /**
-         * @brief Get the number of scopes linked to this frame
-         * 
-         * Needed for the primitive garbage collecting system.
-         * 
-         * @return uint8_t 
-         */
-        inline uint8_t scopeCountToDelete() const noexcept;
-
-        friend std::ostream& operator<<(std::ostream& os, const Frame& F) noexcept;
-
     private:
-        //              IP,          PP    EXC_PP
-        uint16_t m_addr, m_page_addr, m_new_pp;
-
-        std::vector<Value> m_stack;
+        uint16_t m_addr;        ///< Instruction pointer
+        uint16_t m_page_addr;   ///< Page pointer
         int16_t m_i;
 
-        uint8_t m_scope_to_delete;
+        std::vector<Value> m_stack;
     };
 
     #include "inline/Frame.inl"

include/Ark/VM/VM.hpp

@@ -128,6 +128,7 @@ namespace Ark
 
         // related to the execution
         std::vector<internal::Frame> m_frames;
+        std::vector<uint8_t> m_scope_count_to_delete;
         std::optional<internal::Scope_t> m_saved_scope;
         std::vector<internal::Scope_t> m_locals;
         std::vector<std::shared_ptr<internal::SharedLibrary>> m_shared_lib_objects;

include/Ark/VM/Value.hpp

@@ -287,8 +287,8 @@ namespace Ark::internal
         friend class Ark::internal::Frame;
 
     private:
-        Value_t m_value;
         uint8_t m_constType;  ///< First bit if for constness, right most bits are for type
+        Value_t m_value;
 
         // private getters only for the virtual machine
 

include/Ark/VM/inline/Frame.inl

@@ -40,26 +40,4 @@ inline uint16_t Frame::callerAddr() const noexcept
 inline uint16_t Frame::callerPageAddr() const noexcept
 {
     return m_page_addr;
-}
-
-inline uint16_t Frame::currentPageAddr() const noexcept
-{
-    return m_new_pp;
-}
-
-// related to scope deletion
-
-inline void Frame::incScopeCountToDelete() noexcept
-{
-    m_scope_to_delete++;
-}
-
-inline void Frame::resetScopeCountToDelete() noexcept
-{
-    m_scope_to_delete = 0;
-}
-
-inline uint8_t Frame::scopeCountToDelete() const noexcept
-{
-    return m_scope_to_delete;
 }

include/Ark/VM/inline/VM.inl

@@ -4,6 +4,7 @@
 
 #define createNewScope() m_locals.emplace_back(std::make_shared<internal::Scope>());
 #define resolveRef(valptr) (((valptr)->valueType() == ValueType::Reference) ? *((valptr)->reference()) : *(valptr))
+#define createNewFrame(ip, pp) m_frames.emplace_back(ip, pp); m_scope_count_to_delete.emplace_back(0)
 
 // profiler
 #include <Ark/Profiling.hpp>
@@ -94,7 +95,8 @@ inline void VM::returnFromFuncCall()
 
     // remove frame
     m_frames.pop_back();
-    uint8_t del_counter = m_frames.back().scopeCountToDelete();
+    m_scope_count_to_delete.pop_back();
+    uint8_t del_counter = m_scope_count_to_delete.back();
 
     // PERF high cpu cost because destroying variants cost
     m_locals.pop_back();
@@ -105,7 +107,7 @@ inline void VM::returnFromFuncCall()
         del_counter--;
     }
 
-    m_frames.back().resetScopeCountToDelete();
+    m_scope_count_to_delete.back() = 0;
 
     // stop the executing if we reach the wanted frame count
     if (m_frames.size() == m_until_frame_count)
@@ -164,7 +166,7 @@ inline void VM::call(int16_t argc_)
 
             // create dedicated frame
             createNewScope();
-            m_frames.emplace_back(m_ip, static_cast<uint16_t>(m_pp), new_page_pointer);
+            createNewFrame(m_ip, static_cast<uint16_t>(m_pp));
             // store "reference" to the function to speed the recursive functions
             if (m_last_sym_loaded < m_state->m_symbols.size())
                 m_locals.back()->push_back(m_last_sym_loaded, function);
@@ -187,8 +189,8 @@ inline void VM::call(int16_t argc_)
             m_locals.push_back(c.scope());
             // create dedicated frame
             createNewScope();
-            m_frames.back().incScopeCountToDelete();
-            m_frames.emplace_back(m_ip, static_cast<uint16_t>(m_pp), new_page_pointer);
+            ++m_scope_count_to_delete.back();
+            createNewFrame(m_ip, static_cast<uint16_t>(m_pp));
 
             m_pp = new_page_pointer;
             m_ip = -1;  // because we are doing a m_ip++ right after that

lib/std

@@ -33,7 +33,7 @@ namespace Ark::internal::Builtins::IO
         {
             if (n[0].valueType() != ValueType::String)
                 throw Ark::TypeError(IO_INPUT_TE);
-            std::printf(n[0].string().c_str());
+            std::printf("%s", n[0].string().c_str());
         }
 
         std::string line = "";

src/Builtins/IO.cpp

@@ -1,13 +1,19 @@
 #include <Ark/Builtins/Builtins.hpp>
 
+#include <stdio.h>
+#include <memory>
+#include <cstdlib>
 #include <thread>
 
+#ifdef _MSC_VER
+    #define popen _popen
+    #define pclose _pclose
+#endif
+
 #undef abs
 #include <chrono>
 
-#include <cstdlib>
 #include <Ark/Constants.hpp>
-
 #include <Ark/Builtins/BuiltinsErrors.inl>
 #include <Ark/VM/VM.hpp>
 
@@ -21,8 +27,14 @@ namespace Ark::internal::Builtins::System
             throw Ark::TypeError(SYS_SYS_TE0);
 
         #ifdef ARK_ENABLE_SYSTEM
-            int output = std::system(n[0].string().c_str());
-            return Value(output);
+            std::array<char, 128> buffer;
+            std::string result;
+            std::unique_ptr<FILE, decltype(&pclose)> pipe(popen(n[0].string().c_str(), "r"), pclose);
+            if (!pipe)
+                throw std::runtime_error("sys:exec: couldn't retrieve command output");
+            while (fgets(buffer.data(), buffer.size(), pipe.get()) != nullptr)
+                result += buffer.data();
+            return Value(result);
         #endif  // ARK_ENABLE_SYSTEM
 
         return nil;

src/Builtins/System.cpp

@@ -3,22 +3,16 @@
 namespace Ark::internal
 {
     Frame::Frame() noexcept :
-        m_addr(0), m_page_addr(0), m_new_pp(0),
+        m_addr(0), m_page_addr(0),
         // PERF costs a lot
         m_stack(4, Value(ValueType::Undefined)),
-        m_i(0), m_scope_to_delete(0)
+        m_i(0)
     {}
 
-    Frame::Frame(uint16_t caller_addr, uint16_t caller_page_addr, uint16_t new_pp) noexcept :
-        m_addr(caller_addr), m_page_addr(caller_page_addr), m_new_pp(new_pp),
+    Frame::Frame(uint16_t caller_addr, uint16_t caller_page_addr) noexcept :
+        m_addr(caller_addr), m_page_addr(caller_page_addr),
         // PERF costs a lot
         m_stack(4, Value(ValueType::Undefined)),
-        m_i(0), m_scope_to_delete(0)
+        m_i(0)
     {}
-
-    std::ostream& operator<<(std::ostream& os, const Frame& F) noexcept
-    {
-        os << "Frame";
-        return os;
-    }
 }

src/VM/Frame.cpp

@@ -44,13 +44,17 @@ namespace Ark
         {
             m_frames.clear();
             m_frames.emplace_back();
+
             m_shared_lib_objects.clear();
+            m_scope_count_to_delete.clear();
+            m_scope_count_to_delete.emplace_back(0);
         }
         else if (m_frames.size() == 0)
         {
             // if persistance is set but no frames are present, add one
             // it usually happens on the first run
             m_frames.emplace_back();
+            m_scope_count_to_delete.emplace_back(0);
         }
 
         m_saved_scope.reset();
@@ -512,7 +516,7 @@ namespace Ark
                             if (m_ip + 1 < m_state->m_pages[m_pp].size() && m_state->m_pages[m_pp][m_ip + 1] == Instruction::CALL)
                             {
                                 m_locals.push_back(var->closure_ref().scope());
-                                m_frames.back().incScopeCountToDelete();
+                                ++m_scope_count_to_delete.back();
                             }
 
                             push(*field);
@@ -964,11 +968,11 @@ namespace Ark
                 ++m_ip;
             }
         } catch (const std::exception& e) {
-            std::cerr << e.what() << "\n";
+            std::printf("%s\n", e.what());
             backtrace();
             return 1;
         } catch (...) {
-            std::cerr << "Unknown error" << std::endl;
+            std::printf("Unknown error\n");
             backtrace();
             return 1;
         }
@@ -1001,33 +1005,37 @@ namespace Ark
 
         if (m_frames.size() > 1)
         {
+            uint16_t curr_pp = m_pp;
+
             // display call stack trace
             for (auto&& it=m_frames.rbegin(), it_end=m_frames.rend(); it != it_end; ++it)
             {
                 std::cerr << "[" << termcolor::cyan << std::distance(it, m_frames.rend()) << termcolor::reset << "] ";
-                if (it->currentPageAddr() != 0)
+                if (curr_pp != 0)
                 {
                     uint16_t id = findNearestVariableIdWithValue(
-                        Value(static_cast<PageAddr_t>(it->currentPageAddr()))
+                        Value(static_cast<PageAddr_t>(curr_pp))
                     );
 
                     if (id < m_state->m_symbols.size())
                         std::cerr << "In function `" << termcolor::green << m_state->m_symbols[id] << termcolor::reset << "'\n";
                     else  // should never happen
                         std::cerr << "In function `" << termcolor::green << "???" << termcolor::reset << "'\n";
+
+                    curr_pp = it->callerPageAddr();
                 }
                 else
-                    std::cerr << "In global scope\n";
+                    std::printf("In global scope\n");
 
                 if (std::distance(m_frames.rbegin(), it) > 7)
                 {
-                    std::cerr << "...\n";
+                    std::printf("...\n");
                     break;
                 }
             }
 
             // display variables values in the current scope
-            std::cerr << "\nCurrent scope variables values:\n";
+            std::printf("\nCurrent scope variables values:\n");
             for (std::size_t i=0, size=m_locals.back()->size(); i < size; ++i)
                 std::cerr << termcolor::cyan << m_state->m_symbols[m_locals.back()->m_data[i].first] << termcolor::reset
                           << " = " << m_locals.back()->m_data[i].second << "\n";