add picoruby-crc and use it in shell startup

Author: hasumikin

mrbgems/picoruby-bin-r2p2/tools/mrblib/app.rb

@@ -4,7 +4,7 @@
 
 begin
   IO.wait_terminal and IO.clear_screen
-  Shell.setup_system_files("#{Dir.pwd}/.r2p2", force: true)
+  Shell.setup_system_files("#{Dir.pwd}/.r2p2")
 
   Shell.bootstrap("../etc/init.d/r2p2")
 

mrbgems/picoruby-crc/mrbgem.rake

@@ -0,0 +1,5 @@
+MRuby::Gem::Specification.new('picoruby-crc') do |spec|
+  spec.license = 'MIT'
+  spec.author  = 'HASUMI Hitoshi'
+  spec.summary = 'PicoRuby CRC library'
+end

mrbgems/picoruby-crc/sig/crc.rbs

@@ -0,0 +1,3 @@
+module CRC
+  def self.crc32: (?String string, ?Integer crc) -> Integer
+end

mrbgems/picoruby-crc/src/crc.c

@@ -0,0 +1,30 @@
+#include <stdint.h>
+#include <stddef.h>
+
+static uint32_t
+generate_crc32(uint8_t *str, size_t len, uint32_t crc)
+{
+  uint32_t crc_value = ~crc;
+  for (size_t i = 0; i < len; i++) {
+    crc_value ^= str[i];
+    for (int j = 0; j < 8; j++) {
+      if (crc_value & 1) {
+        crc_value = (crc_value >> 1) ^ 0xEDB88320;
+      } else {
+        crc_value >>= 1;
+      }
+    }
+  }
+  return ~crc_value;
+}
+
+#if defined(PICORB_VM_MRUBY)
+
+#include "mruby/crc.c"
+
+#elif defined(PICORB_VM_MRUBYC)
+
+#include "mrubyc/crc.c"
+
+#endif
+

mrbgems/picoruby-crc/src/mruby/crc.c

@@ -0,0 +1,34 @@
+#include "mruby.h"
+#include "mruby/presym.h"
+#include "mruby/class.h"
+#include "mruby/string.h"
+
+/*
+ * CRC.crc32(string = nil, crc = nil) -> Integer
+ * when string is nil, returns the initial checksum value
+ */
+static mrb_value
+mrb_crc_s_crc32(mrb_state *mrb, mrb_value klass)
+{
+  mrb_value string = mrb_nil_value();
+  mrb_int crc = 0;
+  mrb_get_args(mrb, "|Si", &string, &crc);
+  if (mrb_nil_p(string)) {
+    return mrb_fixnum_value(0);
+  }
+  uint32_t crc_value = generate_crc32((uint8_t *)RSTRING_PTR(string), (size_t)RSTRING_LEN(string), (uint32_t)crc);
+  return mrb_int_value(mrb, crc_value);
+}
+
+void
+mrb_picoruby_crc_gem_init(mrb_state* mrb)
+{
+  struct RClass *module_CRC = mrb_define_module_id(mrb, MRB_SYM(CRC));
+
+  mrb_define_class_method_id(mrb, module_CRC, MRB_SYM(crc32), mrb_crc_s_crc32, MRB_ARGS_OPT(2));
+}
+
+void
+mrb_picoruby_crc_gem_final(mrb_state* mrb)
+{
+}

mrbgems/picoruby-crc/src/mrubyc/crc.c

@@ -0,0 +1,28 @@
+#include "mrubyc.h"
+
+/*
+ * CRC.crc32(string = nil, crc = nil) -> Integer
+ * when string is nil, returns the initial checksum value
+ */
+static void
+c_crc_crc32(mrbc_vm *vm, mrbc_value v[], int argc)
+{
+  mrbc_value string = GET_ARG(1);
+  mrbc_int_t crc = GET_INT_ARG(2);
+  if (string.tt == MRBC_TT_NIL) {
+    return mrb_fixnum_value(0);
+  } else if (string.tt != MRBC_TT_STRING) {
+    mrbc_raise(vm, MRBC_CLASS(TypeError), "string expected");
+    return;
+  }
+  uint32_t crc_value = generate_crc32((uint8_t *)string.string->data, string.string->len, crc);
+  SET_INT_RETURN(crc_value);
+}
+
+void
+mrbc_crc_init(mrbc_vm *vm)
+{
+  mrbc_class *module_CRC = mrbc_define_module(vm, "CRC");
+
+  mrbc_define_method(vm, module_CRC, "crc32", c_crc_crc32);
+}

mrbgems/picoruby-shell/mrbgem.rake

@@ -1,3 +1,6 @@
+require 'stringio'
+require 'zlib'
+
 MRuby::Gem::Specification.new('picoruby-shell') do |spec|
   spec.license = 'MIT'
   spec.author  = 'HASUMI Hitoshi'
@@ -9,6 +12,7 @@ MRuby::Gem::Specification.new('picoruby-shell') do |spec|
   spec.add_dependency 'picoruby-editor'
   spec.add_dependency 'picoruby-sandbox'
   spec.add_dependency 'picoruby-env'
+  spec.add_dependency 'picoruby-crc'
   if build.posix?
     if build.vm_mrubyc?
       spec.add_dependency('picoruby-dir')
@@ -44,7 +48,7 @@ MRuby::Gem::Specification.new('picoruby-shell') do |spec|
         mrbc.run(f, t.prerequisites[0], "executable_#{t.name.pathmap("%n").gsub('-', '_')}", cdump: false)
       end
     end
-    executable_mrbfiles << mrbfile
+    executable_mrbfiles << { mrbfile: mrbfile, rbfile: rbfile }
     objfile = "#{build_dir}/shell_executables/#{rbfile.pathmap('%n')}.o"
     file objfile => mrbfile
     build.libmruby_objs << objfile
@@ -58,15 +62,22 @@ MRuby::Gem::Specification.new('picoruby-shell') do |spec|
     end
     open(t.name, 'w') do |f|
       executable_mrbfiles.each do |vm_code|
-        Rake::FileTask[vm_code].invoke
-        f.puts "#include \"#{vm_code}\""
+        Rake::FileTask[vm_code[:mrbfile]].invoke
+        f.puts "#include \"#{vm_code[:mrbfile]}\""
       end
       f.puts
       f.puts "static shell_executables executables[] = {"
       executable_mrbfiles.each do |vm_code|
-        basename = File.basename(vm_code, ".c")
+        sio = StringIO.new("hoge", 'w+')
+        sio.set_encoding('ASCII-8BIT')
+        mrbc.compile_options = "--remove-lv -o-"
+        mrbc.run(sio, vm_code[:rbfile], "", cdump: false)
+        sio.rewind
+        crc = Zlib.crc32(sio.read.chomp)
+        sio.close
+        basename = File.basename(vm_code[:mrbfile], ".c")
         dirname = pathmap.find { _1[:basename] == basename }[:dir]
-        line = "  {\"#{dirname}/#{basename}\", executable_#{basename.gsub('-', '_')}},"
+        line = "  {\"#{dirname}/#{basename}\", executable_#{basename.gsub('-', '_')}, #{crc}},"
         f.puts line
       end
       f.puts "  {NULL, NULL} /* sentinel */"

mrbgems/picoruby-shell/mrblib/shell.rb

@@ -32,6 +32,37 @@ def self.setup_root_volume(device, label: "PicoRuby")
     end
   end
 
+  def self.ensure_system_file(path, code, crc = nil)
+    10.times do
+      if File.file?(path)
+        puts "Checking: #{path}"
+        File.open(path, "r") do |f|
+          actual_len = f.size
+          actual_code = f.read if 0 < actual_len
+          sleep_ms 10
+          actual_crc = CRC.crc32(actual_code)
+          if (actual_len == code.length) && ( crc.nil? || (actual_crc == crc) )
+            puts "  OK (#{code.length} bytes)"
+            return
+          else
+            puts "  NG. Updating... (len: #{code.size}<=>#{actual_len} crc: #{crc}<=>#{actual_crc})"
+          end
+        end
+        File.unlink(path)
+        sleep_ms 100
+      else
+        File.open(path, "w") do |f|
+          puts "Creating: #{path}"
+          f.expand(code.length) if f.respond_to?(:expand)
+          f.write(code)
+        end
+        sleep_ms 10
+      end
+    end
+    File.unlink(path) if File.file?(path)
+    puts "Failed to save: #{path} (#{code.length} bytes)"
+  end
+
   def self.setup_system_files(root = nil, force: false)
     unless root.nil? || Dir.exist?(root)
       Dir.mkdir(root)
@@ -43,24 +74,14 @@ def self.setup_system_files(root = nil, force: false)
     Dir.chdir(root || "/") do
       %w(bin lib var home etc etc/init.d etc/network).each do |dir|
         Dir.mkdir(dir) unless Dir.exist?(dir)
-        sleep_ms 100
+        sleep_ms 10
       end
       while exe = Shell.next_executable
         path = "#{root}#{exe[:path]}"
-        if force || !File.file?(path)
-          f = File.open path, "w"
-          f.expand exe[:code].length if f.respond_to? :expand
-          f.write exe[:code]
-          f.close
-          sleep_ms 100
-        end
+        self.ensure_system_file(path, exe[:code], exe[:crc])
       end
       path = "#{root}/etc/machine-id"
-      unless File.file?(path)
-        f = File.open path, "w"
-        f.write Machine.unique_id
-        f.close
-      end
+      self.ensure_system_file(path, Machine.unique_id, nil)
     end
     Dir.chdir ENV['HOME']
   end

mrbgems/picoruby-shell/shell_executables/date.mrb

@@ -20,12 +20,13 @@ class Shell
   AUTHOR_COLOR: String
   @editor: Editor::Line
 
-  def self.next_executable: -> {code: String, path: String}
+  def self.next_executable: -> {code: String, path: String, crc: Integer}
   def self.setup_rtc: (rtc_t trc) -> void
   def self.setup_sdcard: (SPI spi) -> void
 
   def self.setup_root_volume: (Symbol drive, ?label: String) -> void
-  def self.setup_system_files: (?(String | nil) root, ?force: bool) -> void
+  def self.ensure_system_file: (String path, String code, Integer | nil crc) -> void
+  def self.setup_system_files: (?(String | nil) root) -> void
   def self.bootstrap: (String file) -> bool
 
   def initialize: (?clean: bool) -> void