From 259282dfa17249bc5ba6f6ea926ac8708b97442f Mon Sep 17 00:00:00 2001
From: Eduardo Bart <edub4rt@gmail.com>
Date: Thu, 5 Oct 2023 14:53:20 -0300
Subject: [PATCH] feat!: introduce machine init and entrypoint config and
 options

---
 lib/grpc-interfaces        |   2 +-
 src/cartesi-machine.lua    | 166 +++++++++++++++++++++++++++++++++----
 src/clua-machine-util.cpp  |   8 ++
 src/dtb.cpp                |   2 +
 src/fdt-builder.h          |   5 ++
 src/json-util.cpp          |   4 +
 src/jsonrpc-discover.json  |   6 ++
 src/machine-c-api.cpp      |   6 ++
 src/machine-c-api.h        |   2 +
 src/machine-config.h       |   2 +
 src/protobuf-util.cpp      |   4 +
 src/test-machine-c-api.cpp |   7 +-
 src/tests/machine-bind.lua |   2 +
 13 files changed, 199 insertions(+), 17 deletions(-)

diff --git a/lib/grpc-interfaces b/lib/grpc-interfaces
index 4ec6e6620..de85ec68a 160000
--- a/lib/grpc-interfaces
+++ b/lib/grpc-interfaces
@@ -1 +1 @@
-Subproject commit 4ec6e6620abce44048b9a8493124683ef15e0731
+Subproject commit de85ec68a10fded1da7dfa215351603764ad3f76
diff --git a/src/cartesi-machine.lua b/src/cartesi-machine.lua
index 210d300f8..d70d76e3e 100755
--- a/src/cartesi-machine.lua
+++ b/src/cartesi-machine.lua
@@ -97,6 +97,8 @@ where options are:
         start:<number>
         length:<number>
         shared
+        mount:<string>
+        user:<string>
 
         label (mandatory)
         identifies the flash drive. init attempts to mount it as /mnt/<label>.
@@ -119,6 +121,17 @@ where options are:
         target modifications to flash drive modify image file as well.
         by default, image files are not modified and changes are lost.
 
+        mount (optional)
+        whether the flash drive should be mounted automatically in init.
+        by default, the drive is mounted if there is an image file backing it,
+        you can use "mount:false" to disables auto mounting,
+        you can also use "mount:<path>" to choose a custom mount point.
+
+        user (optional)
+        changes the user ownership of the mounted directory when mount is true,
+        otherwise changes the user ownership of the respective /dev/pmemX device,
+        this option is useful to allow dapp's user access the flash drive.
+
     (an option "--flash-drive=label:root,filename:rootfs.ext2" is implicit)
 
   --replace-flash-drive=<key>:<value>[,<key>:<value>[,...]...]
@@ -341,6 +354,25 @@ where options are:
     suppress cartesi-machine.lua output.
     exceptions: --initial-hash, --final-hash and text emitted from the target.
 
+  --no-init-splash
+    don't show cartesi machine splash on boot.
+
+  --append-init=<string>
+    append a command to machine's init script to be executed with root privilege,
+    the command is executed on boot after mounting flash drives and before running the entrypoint,
+    you can pass this option multiple times.
+
+  --append-init-script=<filename>
+    like --append-init, but use contents from a script file.
+
+  --append-entrypoint=<string>
+    append a command to machine's entrypoint script to be executed with dapp privilege,
+    the command is executed after the machine is initialized and before the final entrypoint command,
+    you can pass this option multiple times.
+
+  --append-entrypoint-script=<filename>
+    like --append-entrypoint, but use contents from a script file.
+
   --gdb[=<address>]
     listen at <address> and wait for a GDB connection to debug the machine.
     If <address> is omitted, '127.0.0.1:1234' is used by default.
@@ -395,6 +427,8 @@ local images_path = adjust_images_path(os.getenv("CARTESI_IMAGES_PATH"))
 local flash_image_filename = { root = images_path .. "rootfs.ext2" }
 local flash_label_order = { "root" }
 local flash_shared = {}
+local flash_mount = {}
+local flash_user = {}
 local flash_start = {}
 local flash_length = {}
 local memory_range_replace = {}
@@ -403,6 +437,9 @@ local ram_length = 64 << 20
 local dtb_image_filename = nil
 local dtb_bootargs = "console=hvc0 rootfstype=ext2 root=/dev/pmem0 rw quiet \z
                       swiotlb=noforce init=/opt/cartesi/bin/init"
+local init_splash = true
+local append_init = ""
+local append_entrypoint = ""
 local rollup
 local uarch
 local rollup_advance
@@ -434,7 +471,6 @@ local store_config = false
 local load_config = false
 local gdb_address
 local exec_arguments = {}
-local quiet = false
 local assert_rolling_template = false
 
 local function parse_memory_range(opts, what, all)
@@ -645,6 +681,8 @@ local options = {
                 label = true,
                 filename = true,
                 shared = true,
+                mount = true,
+                user = true,
                 length = true,
                 start = true,
             })
@@ -653,6 +691,18 @@ local options = {
             f.filename = nil
             if f.image_filename == true then f.image_filename = "" end
             assert(not f.shared or f.shared == true, "invalid flash drive shared value in " .. all)
+            if f.mount == nil then
+                -- mount only if there is a file backing
+                if f.image_filename and f.image_filename ~= "" then
+                    f.mount = "/mnt/" .. f.label
+                else
+                    f.mount = false
+                end
+            elseif f.mount == "true" then
+                f.mount = "/mnt/" .. f.label
+            elseif f.mount == "false" then
+                f.mount = false
+            end
             if f.start then f.start = assert(util.parse_number(f.start), "invalid flash drive start in " .. all) end
             if f.length then f.length = assert(util.parse_number(f.length), "invalid flash drive length in " .. all) end
             local d = f.label
@@ -664,6 +714,8 @@ local options = {
             flash_start[d] = f.start or flash_start[d]
             flash_length[d] = f.length or flash_length[d]
             flash_shared[d] = f.shared or flash_shared[d]
+            flash_mount[d] = f.mount or flash_mount[d]
+            flash_user[d] = f.user or flash_user[d]
             return true
         end,
     },
@@ -849,7 +901,6 @@ local options = {
         function(all)
             if not all then return false end
             stderr = function() end
-            quiet = true
             return true
         end,
     },
@@ -1056,6 +1107,52 @@ local options = {
             return true
         end,
     },
+    {
+        "^%-%-no%-init%-splash$",
+        function(all)
+            if not all then return false end
+            init_splash = false
+            return true
+        end,
+    },
+    {
+        "^%-%-append%-init%=(.*)$",
+        function(o)
+            if not o or #o < 1 then return false end
+            append_init = append_init .. o .. "\n"
+            return true
+        end,
+    },
+    {
+        "^%-%-append%-init%-script%=(.*)$",
+        function(o)
+            if not o or #o < 1 then return false end
+            local f <close> = assert(io.open(o, "rb"))
+            local contents = assert(f:read("*a"))
+            if not contents:find("\n$") then contents = contents .. "\n" end
+            append_init = append_init .. contents
+            return true
+        end,
+    },
+    {
+        "^%-%-append%-entrypoint%=(.*)$",
+        function(o)
+            if not o or #o < 1 then return false end
+            append_entrypoint = append_entrypoint .. o .. "\n"
+            return true
+        end,
+    },
+    {
+        "^%-%-append%-entrypoint%-script%=(.*)$",
+        function(o)
+            if not o or #o < 1 then return false end
+            local f <close> = assert(io.open(o, "rb"))
+            local contents = assert(f:read("*a"))
+            if not contents:find("\n$") then contents = contents .. "\n" end
+            append_entrypoint = append_entrypoint .. contents
+            return true
+        end,
+    },
     {
         "^%-%-gdb(%=?)(.*)$",
         function(o, address)
@@ -1168,6 +1265,10 @@ local function store_machine_config(config, output)
     comment_default(dtb.image_filename, def.dtb.image_filename)
     output("    bootargs = %q,", dtb.bootargs or def.dtb.bootargs)
     comment_default(dtb.bootargs, def.dtb.bootargs)
+    output("    init = %q,", dtb.init or def.dtb.init)
+    comment_default(dtb.init, def.dtb.init)
+    output("    entrypoint = %q,", dtb.entrypoint or def.dtb.entrypoint)
+    comment_default(dtb.entrypoint, def.dtb.entrypoint)
     output("  },\n")
     local tlb = config.tlb or {}
     output("  tlb = {\n")
@@ -1277,14 +1378,6 @@ local function dump_value_proofs(machine, desired_proofs, has_htif_console_getch
     end
 end
 
-local function append(a, b)
-    a = a or ""
-    b = b or ""
-    if a == "" then return b end
-    if b == "" then return a end
-    return a .. " " .. b
-end
-
 local function create_machine(config_or_dir, runtime)
     if remote then return remote.machine(config_or_dir, runtime) end
     return cartesi.machine(config_or_dir, runtime)
@@ -1344,6 +1437,8 @@ else
         dtb = {
             image_filename = dtb_image_filename,
             bootargs = dtb_bootargs,
+            init = "",
+            entrypoint = "",
         },
         ram = {
             image_filename = ram_image_filename,
@@ -1358,20 +1453,61 @@ else
         uarch = uarch,
         flash_drive = {},
     }
+
+    -- show splash on init
+    if init_splash then
+        config.dtb.init = config.dtb.init
+            .. ([[
+echo "
+         .
+        / \
+      /    \
+\---/---\  /----\
+ \       X       \
+  \----/  \---/---\
+       \    / CARTESI
+        \ /   MACHINE
+         '
+"
+]]):gsub("\\", "\\\\")
+    end
+
     for _, label in ipairs(flash_label_order) do
+        local devname = "pmem" .. #config.flash_drive
         config.flash_drive[#config.flash_drive + 1] = {
             image_filename = flash_image_filename[label],
             shared = flash_shared[label],
             start = flash_start[label],
             length = flash_length[label] or -1,
         }
+        -- auto mount
+        local mount = flash_mount[label]
+        local chownpath = "/dev/" .. devname
+        if label ~= "root" and mount then
+            local cmd = ([[busybox mkdir -p "MOUNT" && busybox mount /dev/DEVNAME "MOUNT"]])
+                :gsub("MOUNT", mount)
+                :gsub("DEVNAME", devname)
+            config.dtb.init = config.dtb.init .. cmd .. "\n"
+            chownpath = mount
+        end
+        -- change permission
+        local user = flash_user[label]
+        if label ~= "root" and user then
+            local cmd = ("busybox chown USER: PATH"):gsub("USER", user or ""):gsub("PATH", chownpath)
+            config.dtb.init = config.dtb.init .. cmd .. "\n"
+        end
+        do -- create a map of the label in /run/drive-label for flashdrive tool
+            local cmd = ([[busybox mkdir -p /run/drive-label && echo "LABEL" > /run/drive-label/DEVNAME]])
+                :gsub("LABEL", label)
+                :gsub("DEVNAME", devname)
+            config.dtb.init = config.dtb.init .. cmd .. "\n"
+        end
     end
 
-    config.dtb.bootargs = append(append(config.dtb.bootargs, append_dtb_bootargs), quiet and " splash=no" or "")
-
-    if #exec_arguments > 0 then
-        config.dtb.bootargs = append(config.dtb.bootargs, "-- " .. table.concat(exec_arguments, " "))
-    end
+    if #append_dtb_bootargs > 0 then config.dtb.bootargs = config.dtb.bootargs .. " " .. append_dtb_bootargs end
+    if #append_init > 0 then config.dtb.init = config.dtb.init .. append_init end
+    if #append_entrypoint > 0 then config.dtb.entrypoint = config.dtb.entrypoint .. append_entrypoint end
+    if #exec_arguments > 0 then config.dtb.entrypoint = config.dtb.entrypoint .. table.concat(exec_arguments, " ") end
 
     if load_config then
         local env = {}
diff --git a/src/clua-machine-util.cpp b/src/clua-machine-util.cpp
index 76c3ff26e..3a50c1ed0 100644
--- a/src/clua-machine-util.cpp
+++ b/src/clua-machine-util.cpp
@@ -778,6 +778,12 @@ static void push_cm_dtb_config(lua_State *L, const cm_dtb_config *r) {
     if (r->bootargs != nullptr) {
         clua_setstringfield(L, r->bootargs, "bootargs", -1);
     }
+    if (r->init != nullptr) {
+        clua_setstringfield(L, r->init, "init", -1);
+    }
+    if (r->entrypoint != nullptr) {
+        clua_setstringfield(L, r->entrypoint, "entrypoint", -1);
+    }
     if (r->image_filename != nullptr) {
         clua_setstringfield(L, r->image_filename, "image_filename", -1);
     }
@@ -952,6 +958,8 @@ static void check_cm_dtb_config(lua_State *L, int tabidx, cm_dtb_config *r) {
     }
     r->image_filename = opt_copy_string_field(L, -1, "image_filename");
     r->bootargs = opt_copy_string_field(L, -1, "bootargs");
+    r->init = opt_copy_string_field(L, -1, "init");
+    r->entrypoint = opt_copy_string_field(L, -1, "entrypoint");
     lua_pop(L, 1);
 }
 
diff --git a/src/dtb.cpp b/src/dtb.cpp
index 2d422e1e1..4d1ef758e 100644
--- a/src/dtb.cpp
+++ b/src/dtb.cpp
@@ -76,6 +76,8 @@ void dtb_init(const machine_config &c, unsigned char *dtb_start, uint64_t dtb_le
         { // cartesi-machine
             fdt.begin_node("cartesi-machine");
             fdt.prop_string("version", CM_VERSION);
+            fdt.prop_string_data("init", c.dtb.init);
+            fdt.prop_string_data("entrypoint", c.dtb.entrypoint);
             fdt.end_node();
         }
 
diff --git a/src/fdt-builder.h b/src/fdt-builder.h
index 46f274ead..4f8a2d164 100644
--- a/src/fdt-builder.h
+++ b/src/fdt-builder.h
@@ -158,6 +158,11 @@ class FDTBuilder {
         prop(name, reinterpret_cast<const uint8_t *>(v.c_str()), v.length() + 1);
     }
 
+    void prop_string_data(const std::string &name, const std::string &v) {
+        // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
+        prop(name, reinterpret_cast<const uint8_t *>(v.c_str()), v.length());
+    }
+
     template <uint32_t N>
     void prop_u32_list(const std::string &name, const std::array<uint32_t, N> &vs) {
         put_u32(FDT_PROP);
diff --git a/src/json-util.cpp b/src/json-util.cpp
index e4ebd1215..9e83720e4 100644
--- a/src/json-util.cpp
+++ b/src/json-util.cpp
@@ -787,6 +787,8 @@ void ju_get_opt_field(const nlohmann::json &j, const K &key, dtb_config &value,
     const auto &jconfig = j[key];
     const auto new_path = path + to_string(key) + "/";
     ju_get_opt_field(jconfig, "bootargs"s, value.bootargs, new_path);
+    ju_get_opt_field(jconfig, "init"s, value.init, new_path);
+    ju_get_opt_field(jconfig, "entrypoint"s, value.entrypoint, new_path);
     ju_get_opt_field(jconfig, "image_filename"s, value.image_filename, new_path);
 }
 
@@ -1129,6 +1131,8 @@ void to_json(nlohmann::json &j, const ram_config &config) {
 void to_json(nlohmann::json &j, const dtb_config &config) {
     j = nlohmann::json{
         {"bootargs", config.bootargs},
+        {"init", config.init},
+        {"entrypoint", config.entrypoint},
         {"image_filename", config.image_filename},
     };
 }
diff --git a/src/jsonrpc-discover.json b/src/jsonrpc-discover.json
index d13236f2b..155b0104c 100644
--- a/src/jsonrpc-discover.json
+++ b/src/jsonrpc-discover.json
@@ -1458,6 +1458,12 @@
           "bootargs": {
             "type": "string"
           },
+          "init": {
+            "type": "string"
+          },
+          "entrypoint": {
+            "type": "string"
+          },
           "image_filename": {
             "type": "string"
           }
diff --git a/src/machine-c-api.cpp b/src/machine-c-api.cpp
index 0808d5b7b..37306f2a4 100644
--- a/src/machine-c-api.cpp
+++ b/src/machine-c-api.cpp
@@ -190,6 +190,8 @@ static cm_ram_config convert_to_c(const cartesi::ram_config &cpp_config) {
 static cartesi::dtb_config convert_from_c(const cm_dtb_config *c_config) {
     cartesi::dtb_config new_cpp_dtb_config{};
     new_cpp_dtb_config.bootargs = null_to_empty(c_config->bootargs);
+    new_cpp_dtb_config.init = null_to_empty(c_config->init);
+    new_cpp_dtb_config.entrypoint = null_to_empty(c_config->entrypoint);
     new_cpp_dtb_config.image_filename = null_to_empty(c_config->image_filename);
     return new_cpp_dtb_config;
 }
@@ -197,6 +199,8 @@ static cartesi::dtb_config convert_from_c(const cm_dtb_config *c_config) {
 static cm_dtb_config convert_to_c(const cartesi::dtb_config &cpp_config) {
     cm_dtb_config new_c_dtb_config{};
     new_c_dtb_config.bootargs = convert_to_c(cpp_config.bootargs);
+    new_c_dtb_config.init = convert_to_c(cpp_config.init);
+    new_c_dtb_config.entrypoint = convert_to_c(cpp_config.entrypoint);
     new_c_dtb_config.image_filename = convert_to_c(cpp_config.image_filename);
     return new_c_dtb_config;
 }
@@ -704,6 +708,8 @@ void cm_delete_machine_config(const cm_machine_config *config) {
     delete[] config->flash_drive.entry;
     delete[] config->dtb.image_filename;
     delete[] config->dtb.bootargs;
+    delete[] config->dtb.init;
+    delete[] config->dtb.entrypoint;
     delete[] config->ram.image_filename;
     delete[] config->tlb.image_filename;
     delete[] config->rollup.rx_buffer.image_filename;
diff --git a/src/machine-c-api.h b/src/machine-c-api.h
index 7c411e89f..a115c31d7 100644
--- a/src/machine-c-api.h
+++ b/src/machine-c-api.h
@@ -194,6 +194,8 @@ typedef struct {                // NOLINT(modernize-use-using)
 /// \brief DTB state configuration
 typedef struct {                // NOLINT(modernize-use-using)
     const char *bootargs;       ///< Bootargs to pass to kernel
+    const char *init;           ///< Initialization commands to be executed as root on boot
+    const char *entrypoint;     ///< Commands to execute the main application
     const char *image_filename; ///< ROM image file
 } cm_dtb_config;
 
diff --git a/src/machine-config.h b/src/machine-config.h
index c05986fcd..370364758 100644
--- a/src/machine-config.h
+++ b/src/machine-config.h
@@ -76,6 +76,8 @@ struct ram_config final {         // NOLINT(bugprone-exception-escape)
 /// \brief DTB state configuration
 struct dtb_config final {
     std::string bootargs{};       ///< Bootargs to pass to kernel
+    std::string init{};           ///< Initialization commands to be executed as root on boot
+    std::string entrypoint{};     ///< Commands to execute the main application
     std::string image_filename{}; ///< DTB image file
 };
 
diff --git a/src/protobuf-util.cpp b/src/protobuf-util.cpp
index ba22f7818..1c59ea30a 100644
--- a/src/protobuf-util.cpp
+++ b/src/protobuf-util.cpp
@@ -47,6 +47,8 @@ void set_proto_machine_config(const machine_config &c, CartesiMachine::MachineCo
     auto *proto_dtb = proto_c->mutable_dtb();
     proto_dtb->set_bootargs(c.dtb.bootargs);
     proto_dtb->set_image_filename(c.dtb.image_filename);
+    proto_dtb->set_init(c.dtb.init);
+    proto_dtb->set_entrypoint(c.dtb.entrypoint);
     auto *proto_ram = proto_c->mutable_ram();
     proto_ram->set_length(c.ram.length);
     proto_ram->set_image_filename(c.ram.image_filename);
@@ -815,6 +817,8 @@ machine_config get_proto_machine_config(const CartesiMachine::MachineConfig &pro
     }
     if (proto_c.has_dtb()) {
         c.dtb.bootargs = proto_c.dtb().bootargs();
+        c.dtb.init = proto_c.dtb().init();
+        c.dtb.entrypoint = proto_c.dtb().entrypoint();
         c.dtb.image_filename = proto_c.dtb().image_filename();
     }
     if (proto_c.has_ram()) {
diff --git a/src/test-machine-c-api.cpp b/src/test-machine-c-api.cpp
index 2ff68aaf5..82ada254a 100644
--- a/src/test-machine-c-api.cpp
+++ b/src/test-machine-c-api.cpp
@@ -216,6 +216,8 @@ class incomplete_machine_fixture : public default_machine_fixture {
         target->ram.image_filename = new_cstr(source->ram.image_filename);
 
         target->dtb.bootargs = new_cstr(source->dtb.bootargs);
+        target->dtb.init = new_cstr(source->dtb.init);
+        target->dtb.entrypoint = new_cstr(source->dtb.entrypoint);
         target->dtb.image_filename = new_cstr(source->dtb.image_filename);
 
         target->flash_drive.count = source->flash_drive.count;
@@ -243,6 +245,8 @@ class incomplete_machine_fixture : public default_machine_fixture {
         delete[] config->flash_drive.entry;
         delete[] config->dtb.image_filename;
         delete[] config->dtb.bootargs;
+        delete[] config->dtb.init;
+        delete[] config->dtb.entrypoint;
         delete[] config->ram.image_filename;
         delete[] config->uarch.ram.image_filename;
     }
@@ -419,7 +423,8 @@ bool operator==(const cm_ram_config &lhs, const cm_ram_config &rhs) {
 }
 
 bool operator==(const cm_dtb_config &lhs, const cm_dtb_config &rhs) {
-    return ((strcmp(lhs.bootargs, rhs.bootargs) == 0) && (strcmp(lhs.image_filename, rhs.image_filename) == 0));
+    return ((strcmp(lhs.bootargs, rhs.bootargs) == 0) && (strcmp(lhs.init, rhs.init) == 0) &&
+        (strcmp(lhs.entrypoint, rhs.entrypoint) == 0) && (strcmp(lhs.image_filename, rhs.image_filename) == 0));
 }
 
 bool operator==(const cm_tlb_config &lhs, const cm_tlb_config &rhs) {
diff --git a/src/tests/machine-bind.lua b/src/tests/machine-bind.lua
index 65bb2bbe5..8e7832314 100755
--- a/src/tests/machine-bind.lua
+++ b/src/tests/machine-bind.lua
@@ -452,6 +452,8 @@ local function test_config(config)
     local dtb = config.dtb
     assert(dtb.image_filename == nil or type(dtb.image_filename) == "string", "invalid dtb.image_filename")
     assert(dtb.bootargs == nil or type(dtb.bootargs) == "string", "invalid dtb.bootargs")
+    assert(dtb.init == nil or type(dtb.init) == "string", "invalid dtb.init")
+    assert(dtb.entrypoint == nil or type(dtb.entrypoint) == "string", "invalid dtb.entrypoint")
     local tlb = config.tlb
     assert(tlb.image_filename == nil or type(tlb.image_filename) == "string", "invalid tlb.image_filename")
     for _, f in ipairs(config.flash_drive) do