Lightweight Ruby

mruby 3.4.0 released

Sun, 20 Apr 2025 00:00:00 +0000

mruby 3.4.0

We are announcing the first stable release of mruby 3.4 series - mruby 3.4.0.

Describes the new features and changes in mruby 3.4.
The main changes in mruby 3.4 are also described in doc/mruby3.4.md.

User visible changes in `mruby3.4` from `mruby3.3`

“NOTE:” are changes to be aware of.

The language

mruby now supports private and protected visibitily (b0db0bd)
Maximum length of inlined symbols reduced from 5 to 4 characters to provide space for visibility flags (6442a01)
Many methods are made private according to CRuby visibility (4a0e806)
Generate OP_SSEND for self.method type calls (111fe4b)
initialize method will be always private (eb8b412)
Add new hooks method_removed, method_undefined (9c74f6e)
Add new hooks singleton_method_removed, singleton_method_undefined (0863c08)
Updated OP_DEF output from codedump (3a3e877)
Better handling of binary strings, e.g. String#b (b0127f0)
Hash to_s format has changed (baeeb5e)
Some encoding related method such as #force_encoding (e47b4ca), #b (b0127f0)
Constant folding for String#+ (6687bdd)
Remove Float bit-operation (db8368f)
use SWAR technique for strlen performance (cbb31e6)
use merge sort for Array#sort (5bd63d6)

Changes in C API

pool.c renamed to mempool.c (and mrb_pool to mrb_mempool) (49525fa)
mrb_pool_value renamed to mrb_irep_pool to reduce confusion (62ef5db)
rename BOXNIX_SET_VALUE to BOXNO_SET_VALUE (#6397)
MRB_FROZEN_P() is replaced by mrb_frozen_p() (c11d18e)
rename color to gc_color (0e79f6b, 1e36d76)
add obj->frozen instead of flags MRB_SET_FROZEN_FLAG/MRB_UNSET_FROZEN_FLAG (8276143)

Build & Configuration

New Build Target: test:run:serial, test:run:serial:lib, test:run:serial:bin (#6423)
New Platform: Playstation Portable (#6022)
New Platform: emscripten (#6487)
New Config: no-float (with MRB_NO_FLOAT) (32200f1)

Changes in mrbgems

mruby-print: removed; if you do not use mruby-io, mruby use #print etc. in the core (8c8bbd9)
mruby-enum-lazy: Add Enumerable::Lazy#grep_v to mruby-enum-lazy (#6171)
mruby-io: Add level argument to File.dirname (#6463)
mruby-io: File.absolute_path? (#6482)
mruby-io: File.absolute_path (96113a2)
mruby-toplevel-ext: top-level public/private/protected moved to the core (2a876d2)
mruby-metaprog: method list methods now works according to the visibility (9229da1)
mruby-metaprog: public_instance_methods, private_instance_methods, protected_instance_methods (9e3e7b2)
mruby-encoding: MRB_UTF8_STRING turned on automatically with this gem (74bdae9)

Fixed GitHub Issues

#6173 Fails to build with tcc(Tiny C Compiler)
#6156 ‘/LIBPATH’ issue
#6183 “.e”.to_f returns NAN
#6182 mrb_read_float() converts “0.3” with a small error compared to strtod()
#6210 Unary minus seems broken
#6255 Wrong number of characters in broken UTF-8 string
#4038 Heap buffer overflow in OP_ENTER
#6262 Unable to define == for objects when using Array#delete
#6267 When MRB_UTF8_STRING is enabled, giving byte characters for String#index and String#split gives wrong results
#6277 MSVC: can’t use malloc() in string.c with WIN32_LEAN_AND_MEAN
#6240 Differentiate between lib and lib64 in the build settings.
#6304 Calling method_missing with only Kwargs passes arguments incorrectly
#6317 mrb_gc_register() may cause GC and collect the object being protected
#6307 Planned change patch for mrb_vm_exec()
#6298 foo :bar {} is legal in mruby?
#6326 Detect “Use-after-free” with address sanitizer
#5358 static warning from getpwnam
#6339 mrb_ary_delete() may refer to an invalid address (use-after-free)
#6346 Block kwargs are passed as last positional arg when using yield
#6365 powl() not available when compiling for Dreamcast
#6369 100x Performance Regression from 3.1
#6270 NODE_ZSUPER from deeply nested blocks will result in a truncated digits for block index in OP_ARGARY
#6297 Assigning to a block variable changes the actual block (thus affecting block_given? and yield)
#6389 instance_exec named block args don’t work properly
#6388 Recent commit broke my windows build
#6411 Wrong function unwinding when using return in a block
#6439 OP_JMPUW does not call the ensure block when it jumps to the beginning of the begin block
#6441 break inside while loop will execute the ensure block outside of the while loop
#6453 Bigint: incorrect behavior of ^ operator
#6452 Bigint: weird mod behavior
#6451 Bigint: incorrect division behavior
#6456 bigint: bug with division of a small number by a bigint
#6466 mruby-bin-mruby using Kernel#p and Kernel#print in bintest fails test
#6467 Heap-Use-After-Free due to Recursive group_by Calls
#6471 Discrepancy in codegen for binary operations between master branch and 3.3.0
#6477 heap-buffer-overflow in mrb_vm_exec
#6485 Hash#rehash does not check if the hash is frozen
#6483 Hash#default_proc= accepts arbitrary objects that are not callable
#6491 Destroy existing string literals when composing string literals

Merged Pull Requests (User Visible Ones)

#6171 Add Enumerable::Lazy#grep_v to mruby-enum-lazy
#6174 Fix MRUBY_PACKAGE_DIR in mruby-config.bat
#6175 Corrected strange conditional in mrb_vm_run()
#6176 Stop assuming alias proc in CI_PROC_SET()
#6177 gha: add macOS 14 to the build
#6184 Remove the L_STOP label
#6185 Added mrb_callinfo::u.keep_context for clarity
#6186 Omit NULL check of e->cxt in OP_RETURN_BLK
#6191 Speed up symbol equality comparison
#6192 Fix OP_STOP with exception
#6193 Fix wrong assertion in OP_SENDB.
#6194 Simplify the calculation of the number of closures in MRB_TT_FIBER
#6197 Fix int_xor to call flo_xor.
#6201 tasks/doc.rake: standardize the rake doc error messages
#6202 Remove the .yardoc folder with rake doc:clean:api
#6204 Clean up the .editorconfig file
#6209 Minor .gitignore clean up
#6211 Minor .gitignore clean up; order entries
#6216 Shared empty iv_tbl of module
#6217 Strict declaration for mrb_istruct_size()
#6219 Avoid assigning a fixed value in the loop
#6220 Reorganize mrb_cache_entry and mrb_method_t types
#6221 Arranging each_backtrace()
#6222 Need to synchronize dbg->regs after VM call in mrdb
#6224 mrb_env_unshare() to break the link to fiber
#6225 Revert “Adjust environment when mrb_exec_irep happened.”
#6227 fix: Array#shuffle(!) result distribution
#6228 Revert “env referred from top-level callinfo should not be unshared; fix #4019”
#6230 Fix status of fiber after switched by exception raised
#6231 Add a way to let other gems handle closing of fds in mruby-io
#6232 Fold the code for freeing env
#6233 Free stack memory at end of fiber
#6235 fix Array#delete always firing the block when deleting nil
#6236 unify the code for filter methods (and speed up #reject!)
#6237 Stricter env objects to attach to ci
#6238 Minimize zero initialization of the stack
#6243 Fixed base64 decoding in mruby-pack
#6244 Revise scope of role of mrb_vm_run()
#6246 Fix typo in test/t/hash.rb
#6249 Fix grammar in src/vm.c; catched -> caught
#6250 Fix spelling
#6251 Clean up root move CODEOWNERS to .github directory
#6253 Allow recycling fibers by GC if not referenced directly
#6256 Update documentation for mrb_top_run()
#6257 fix some mrbconf.md typos
#6260 Remove exc_caught from mrb_vm_exec()
#6261 fix: to_a integer ranges with begin > end failing
#6263 fix: Array#delete mistakenly calling block even if not passed
#6264 Must pass keyword arguments for Kernel#to_enum
#6265 Fixes Dir.children and Dir.each_child
#6266 Passes the nonexistent key as a block argument in Array#delete
#6273 Improvements to mrb_protect_atexit()
#6275 Fixed Binding#eval that failed to assign to the same variable
#6276 Always run atexit on the top-level call frame
#6279 Include headers for malloc() explicitly; fix #6277
#6280 Remove MRB_ENV_CLOSED flag
#6281 Fixes local variables in mruby-binding.
#6283 Simplify uvenv()
#6288 Detach env of ci explicitly on atexit
#6289 Simplify OP_RETURN_BLK and OP_BREAK
#6290 Allow to change the output directory name of the libmruby file
#6293 Changed the instruction table in opcode.md
#6294 Optimise mrb_iv_get
#6302 Minor cleanup in mrb_str_init
#6303 mrb_str_aset_m() should return replace instead of str
#6305 Protect keyword arguments in prepare_missing()
#6308 Assume that MRB_CATCH() has mrb->exc set
#6310 Doubling the call stack when extending it
#6311 Added fast-path for positional arguments less than 15 in OP_SEND
#6312 Omit error checking at OP_RETURN, OP_RETURN_BLK and OP_BREAK
#6313 Fix wrong column number in opcode.md
#6314 Optimize even?/odd? for big integers
#6318 Shrink variables in mrb_vm_exec()
#6320 Shrinking the code in OP_BREAK and OP_RETURN_BLK
#6321 Avoid warnings in lib/**/*.rb
#6322 Fix mrb_ro_data_p on Intel Mac
#6324 Remove localjump_error()
#6327 fix ncurses linking issues
#6328 Fix use-after-free in obj_free() for env objects
#6329 Fix use-after-free in mrb_obj_alloc()
#6330 Add a precondition to call mrb_env_unshare().
#6331 Restore the GC arena with tests
#6332 Must not depend on the “host” build to generate mruby-compiler/core/y.tab.c
#6333 Reduce the number of branch instructions in the heap_p()
#6335 Add return_ci in CHECKPOINT_MAIN() of OP_RETURN
#6338 Need to place static proc objects into 8-byte alignments
#6340 Fix use-after-free for Array#<=>
#6341 Need to restore the GC arena after some function calls
#6344 prefer using mrb_yield to call block arguments
#6347 codegen.c,parse.y: remove flattening of yield arguments; fix #6346
#6348 Cancel the warning disablement
#6349 Perform GC before deleting directories
#6350 Fixed character encoding conversion function mismatch
#6351 Remove unnecessary mrb_gc_arena_restore()
#6353 Fix use-after-free in mrb_ary_delete()
#6356 Making splat argument objects invisible from Ruby side
#6373 Add build config for Milk-V Duo (RISC-V Linux) board
#6382 Make array objects invisible in mrb_gc_register()
#6385 Small improvements for mrb_gc_register()
#6386 Avoid calling mrb_gv_set() from mrb_gc_unregister()
#6387 Small improvements for mrb_gc_unregister()
#6390 Fix use-after-free by mrb_gc_unregistor()
#6391 Fixed argument forwarding in instance_exec
#6392 Fix argument forwarding in mrb_exec_irep()
#6393 Follow-up to #6391
#6395 Storing method-id inside Symbol#to_proc
#6396 Milk-V Build Config: update GPIO gem URL
#6397 boxing_no.h: rename BOXNIX_SET_VALUE -> BOXNO_SET_VALUE
#6399 Add macOS 15 to the build
#6405 io_read: use %i instead of %d in call to mrb_raisef
#6407 Allow to exclude specific files in rake install
#6408 Improve compliance with C++ standards
#6410 Put #include <stdlib.h> in parse.y
#6412 Distinguish the call frame of the generator with OP_RETURN_BLK
#6413 Add links to documentation in README.md
#6415 Fix numbered parameters when used as a singleton
#6416 Optimize the “new” method’s iseq
#6419 Follow Ruby’s behavior for numbered parameters in -> {}
#6420 Update labeler.yml: add label for the tools directory
#6422 Add annotations for function names defined in the preprocessor
#6423 Adding a serialized test task
#6427 Need to update ci variable after re-entry to VM
#6428 Change the limits of OP_ADDI and OP_SUBI from 0-127 to 0-255.
#6429 Fix numbered parameters when used as hash keys
#6432 Moving code in macro arguments out of macros
#6434 Added document “Layout of the mruby filesystem”
#6436 Make rake doc:update-index prettier friendly
#6437 Add more details to the pre-commit config
#6438 Remove unused MRuby::Build#list_install_excludes method
#6440 Fix redo keyword
#6442 Fixed wrong range condition in OP_JMPUW
#6443 Fix NODE_NEGATE for bigints
#6444 Add test cases for bigints
#6446 Omit the _WIN64 definition check
#6447 Fixed File.expand_path
#6448 Suppress presym in mruby/ext/io.h file
#6449 Using presym in the mruby-io/src/file_test.c file
#6450 Change MRB_WITH_IO_PREAD_PWRITE configuration name
#6454 mruby-bigint: handle rhs bigint in int_mod and int_divmod functions
#6455 mruby-bigint: fix rounding behavior in mpz_mdiv and mpz_mdivmod functions
#6457 bigint: fix bug with division of a small number by a bigint
#6459 FileTest is a module
#6461 To create a release package file in draft
#6462 Properly cast the return value of memchr()
#6463 Add level argument to File.dirname
#6465 Add initial playstation portable crossbuild support
#6468 Fixed missing changes to IB_FIND_BY_KEY() parameter names
#6469 Add more const qualifier for RProc
#6472 Moved tests for Integer#quo
#6473 Hide mpz_and() symbol
#6473 Hide mpz_and() symbol
#6474 Avoid array object creation with “unknown keyword” error
#6475 Don’t include deleted mruby-print
#6478 Fixed buffer overrun in function chars2bytes()
#6479 Reimplementation of File.expand_path method
#6482 Add File.absolute_path? method
#6487 Add Emscripten toolchain & build_config

We have done 1,188 commits to 354 files with 20,650 additions and 21,537 deletions since mruby 3.3.0. For more detail of the updates, see Commit Log.

Thanks to all the contributors who have worked on bug fixes and improvements in the release of mruby 3.4.0.

mruby 3.3.0 released

Wed, 14 Feb 2024 00:00:00 +0000

mruby 3.3.0

We are announcing the first stable release of mruby 3.3 series - mruby 3.3.0.

Describes the new features and changes in mruby 3.3.
The main changes in mruby 3.3 are also described in doc/mruby3.3.md.

User visible changes in `mruby3.3` from `mruby3.2`

“NOTE:” are changes to be aware of.

The language

aliases work properly with super (2ad3f0e)
callee method work differently with aliases in mruby (f2dc76e)
define Kernel#respond_to_missing? method (347586e)
_inspect method (inspect with recursive check) is removed (e2bbf75, 5cb0c74, 113565a, 0713f2a, 6ae6b63, fc9fffc)
__printstr__ method is removed; use print instead (acecee0, 192e6e3)
New method String#bytesplice (5274647, a2e2e83)
Allow return in blocks to cross C boundaries (#6125)

Configuration

mruby can be built using Docker now. Try docker-compose build for example. (#5961)
New Platform: DJGPP (MS-DOS) (#6022)
New Platform: Nintendo Wii (#6086)
Improved Platform: Android (#6013)
Improved Platform: Dreamcast (#6130)
Allow tests to be disabled for specific gems; warn about disabled tests (#6012)
Replace MRB_NO_DIRECT_THREADING with MRB_USE_VM_SWITCH_DISPATCH (#5902)

mruby memory API

mrb_default_allocf can be overridden by the application (34c5d96)
mrb_open_allocf will be deprecated (cfee5c2)

Changes in C API

add new error handling API functions (8c8bbd9)
Add mrb_vm_ci_env_clear() function with MRB_API (#5945)
a new function mrb_check_frozen_value() (ccdf75c)
avoid formatting in mrb_bug() (82a48bd)
NOTE: If you are using it, you must give a simple string or replace it with a call to mrb_raise() series.
stop using mrbc_ prefix for compiler context (c5e3cbe)
The same names are provided as before, but we recommend replacing them.
Allow Class#allocate to be prohibited (#5979, #6122, #6123)
To disable #allocate, use MRB_UNDEF_ALLOCATOR(). This is also automatically applied when the subclass is created, but to explicitly allow it, use MRB_DEFINE_ALLOCATOR().

Changes in mrbgems

default.gembox: Add mruby debugger mrdb (mruby-bin-debugger) (#5966)
mruby-bin-config: new options --cxx, --cxxflags, --as, --asflags, --objc, --objcflags (#6054)
mruby-binding: renamed from mruby-binding-core of mruby3.2 (11af5db)
NOTE: If using mruby-binding-core of mruby 3.2, replace it with mruby-binding.
mruby-binding: implemented Binding#initialize_copy method (#5517)
mruby-binding: Kernel#binding responds only to calls from Ruby (#5981)
mruby-compar-ext: Comparable#clamp to accept nil as arguments (836bebc)
mruby-compiler: add print name for identifier tokens (d7b2e3a)
mruby-data: allow empty Data (927a9df)
mruby-enumerator: remove internal attribute methods obj, args, kwd, meth, fib. (735fa24)
mruby-enumerator: add Enumerator#size (861f8bd)
mruby-eval: merged mruby-binding of mruby3.2 (501b22a, #5989)
NOTE: If using mruby-binding of mruby 3.2, replace it with mruby-eval.
mruby-fiber: Add a new mrb_fiber_new() with MRB_API (#6097)
mruby-fiber: Allows calling Fiber#resume from C (#6106)
mruby-fiber: Fiber#to_s format changed (#6105)
mruby-io: add File#atime and File#ctime (321cfe9)
mruby-io: Add “x” mode option for IO.open (#6081)
mruby-io: File.new should not take blocks (53de964)
mruby-method: Method#to_s format changed (f5bc82f, 02f189c)
mruby-numeric-ext: int.pow(n,m) to take bigint as exponential (d482eab)
mruby-pack: support new directives j, J, b, B, # (2a1e3a5, e7021f1, e17f325)
mruby-range-ext: new method Range#overlap? (384d0e2)
mruby-string-ext: Add String#valid_encoding? method (eabe2d9)
mruby-struct: allow empty Struct when a name is not given (c212ede)
mruby-time: should allow year before 1900 (e5de08b)
mruby-time: support bigint to time_t if necessary (7096d27)
mruby-time: need to handle negative time_t (b064d7e)

Changes in build system

Extended rake install task (#5928)
NOTE: Due to this impact, executable files in the mruby/bin/ directory by default are now symbolic links (batch files on Windows). If previously relied on those executables, should be replaced with direct references to the entity created under the build directory (e.g. mruby/build/host/bin/).
Encode and decode escape characters for presym (#6011)
Rakefile: remove default build target directories in deep_clean (#6032, 1e38569)

Other breaking changes

mrb_f_raise() is now an internal function (#5923, #6070)
mrb_make_exception() is now an internal function with different parameters (431f83e, 78137f3)
The File#path method no longer uses the #to_path method for implicit conversion (d86c4a7)
stop mrb isolation for each test file (a20fbe5)
RBreak remembers the CI location (#6103)

Bugs Fixed

#5724 Rational#** is missing
#5725 weird const_missing exceptions in mrblib code
#5789 No memory release of backtrace information due to stack error
#5932 How to create a block using the C API? mrb_yield keeps crashing!
#5943 TCPSocket#write is failed
#5944 Behavior of calling method with a hash variable
#5946 Don’t switch constant search path from modules to Object
#5949 Caller appears to report wrong line when block passed and brackets omitted
0906cd7 numeric.c: fix rounding function issues with big numbers
#5974 Invalid escape sequences in gem_init.c on windows
#5975 Equals comparison fails on extreme ends of 64-bit integers
#5985 Sign extension with OP_LOADI32 in get_int_operand()
#5986 Fix bugs in String#bytesplice
#5987 ~(-1 « 64) is incorrect
#5991 ‘gets’ method not working in mruby-3.2.0
#5994 fix typo in mrbgems/mruby-io/src/io.c
#5995 One seemingly unnecessary parameter is passed in the block parameters
#6008 Make “bintest” independent of directory
b47c8b7 gc.c (clear_all_old): fix a generational GC bug
#6029 mruby build fails under mrbgems directory
a264965 mruby-os-memsize/memsize.c: fix irep size calculation
3310e10 mruby-test/mrbgem.rake: fix mrb_state handling bug
#6041 GC Performance may have degraded
#6044 Generated presym/table.h contains invalid characters
#6051 Null pointer dereference in mrb_addrinfo_unix_path
#6052 Null pointer dereference while handling the Proc class
#6055 Fix libmruby name for VisualC++
#6060 SEGFAULT Issue Related to Fiber Usage in ngx_mruby Development
#6061 Performance issue in String#codepoints
#6064 MRUBY_PACKAGE_DIR does not always have a value.
#6065 Null pointer dereference while handling the Proc class
#6066 Null pointer dereference involving Struct.new()
#6067 Null pointer dereference in mrb_string_value_cstr
#6068 Stack overflow in mrb_vm_exec
#6076 Fixed unwinding block that could point to invalid PC
#6084 Incorrect symbolic sinks in binary built on Linux
#6087 ‘Remote branch HEAD not found in upstream origin’ error on build
#6089 binding.eval() handles def expressions differently from CRuby
#6098 Fails to call superclass of wrapped method
#6099 ensure section is not executed if the function exits via a return in a proc
#6108 VM crashes with break
#6118 Fixed IO#read with buf
#6120 Set EBADF if check_file_descriptor() fails
#6126 Fixed return value of OP_RETURN_BLK called directly under C function
#6134 String#unpack1 returns an array instead of a single string
#6136 Fixed when combined mrb_fiber_resume() and Fiber#transfer

Pull Requests (User Visible Ones)

#5517 Fixed local variables not separated between copied binding objects
#5902 Replace MRB_NO_DIRECT_THREADING with MRB_USE_VM_SWITCH_DISPATCH
#5923 Demotion mrb_f_raise() from MRB_API
#5928 Improved rake install
#5945 Avoid exposure for REnv objects
#5946 Don’t switch constant search path from modules to Object
#5966 Update default.gembox add mruby debugger mrdb
#5979 Allow Class#allocate to be prohibited
#5981 Kernel#binding responds only to calls from Ruby
#5989 Integrate mruby-binding-eval into mruby-eval
#5961 Add Docker to build and run all mruby tests. Run pre-commit and generate YARD docs with Docker
#5994 fix typo in mrbgems/mruby-io/src/io.c
#6008 Make “bintest” independent of directory
#6009 Avoid adding /bintest which does not exist
#6011 Encode and decode escape characters for presym
#6012 Allow tests to be disabled for specific gems; warn about disabled tests
#6013 Fix Android toolchain
#6022 Build configuration for MS-DOS and DJGPP
#6032 Rake: update task clean to remove bin and build folders
#6045 Fixes escape sequence bug and enhancements in Presym scanning
#6054 Extends bin/mruby-config
#6055 Fix libmruby name for VisualC++
#6070 Demotion mrb_f_raise() in kernel.c from MRB_API too
#6076 Fixed unwinding block that could point to invalid PC
#6081 Add “x” mode option for IO.open
#6086 Add build config for Nintendo Wii
#6097 Add a new mrb_fiber_new() with MRB_API
#6103 RBreak remembers the CI location
#6105 Implement Fiber#to_s method
#6106 Ease fiber limitations
#6118 Fixed IO#read with buf
#6120 Set EBADF if check_file_descriptor() fails
#6122 Prohibit Class#allocate in a different way
#6123 Inherit MRB_FL_UNDEF_ALLOCATE in subclasses
#6125 Allow OP_RETURN_BLK to cross C boundaries
#6126 Fixed return value of OP_RETURN_BLK called directly under C function
#6130 dreamcast_shelf build config: complete overhaul
#6136 Fixed when combined mrb_fiber_resume() and Fiber#transfer

We have done 763 commits to 232 files with 8,871 additions and 5,978 deletions since mruby 3.2.0. For more detail of the updates, see Commit Log.

Thanks to all the contributors who have worked on bug fixes and improvements in the release of mruby 3.3.0.

mruby, mruby/c Common I/O API Guidelines and Community-developed Libraries released

Tue, 19 Sep 2023 00:00:00 +0000

Common I/O API Guidelines for mruby and mruby/c

Common I/O API Guidelines for mruby and mruby/c have been established and released.

We have established the Common I/O API Guidelines(hereinafter referred to as “Guidelines”) for mruby and mruby/c. This initiative enhances the portability of programs across different microcontrollers (hereinafter referred to as “MCUs”) and improves the reusability of various sensors and I/O control libraries. When utilizing mruby and mruby/c in the future, we sincerely hope that you will refer to these Guidelines.

Additionally, we would like to introduce libraries developed by enthusiastic contributors for MCUs that have been made available. If there are MCU libraries not listed below and you have created your own, we encourage you to inform us through the inquiry so that we can include it in our introductions.

mruby, mruby/c Common I/O API Guidelines

https://github.com/mruby/microcontroller-peripheral-interface-guide

mruby 3.2.0 released

Fri, 24 Feb 2023 00:00:00 +0000

mruby 3.2.0

We are announcing the first stable release of mruby 3.2 series - mruby 3.2.0.

Describes the new features and changes in mruby 3.2.
The main changes in mruby 3.2 are also described in doc/mruby3.2.md.

The language

Now a::B = c should evaluate a then c.
Anonymous arguments *, **, & can be passed for forwarding.
Multi-precision integer is available now via mruby-bigint gem.

mruby VM and bytecode

OP_ARYDUP was renamed to OP_ARYSPLAT. The instruction name was changed but instruction number and basic behavior have not changed (except that ARYDUP nil makes []).

Tools

`mruby`

-b only specifies the script is the binary. The files loaded by -r are not affected by the option.
mruby now loads complied binary if the suffix is .mrb.

`mrbc`

Add --no-optimize option to disable optimization.

mrbgems

mruby-class-ext

Add Class#subclasses method.
Add Module#undefined_instance_methods method.

New bundled gems

mruby-errno from [https://github.com/iij/mruby-errno.git]
mruby-set from [https://github.com/yui-knk/mruby-set.git]
mruby-dir from [https://github.com/iij/mruby-dir.git]
mruby-data

Breaking Changes

`mrb_vm_run()` may detach top-level local variables referenced from blocks

When the mrb_vm_run() function (including mrb_top_run()) is called, the previous top-level local variables referenced from blocks is detached under either of the following conditions.

If the stack_keep parameter is given as 0.
If the number of variables in irep to be executed is less than the number of previous top-level local variables.

This change also affects API functions such as mrb_load_string() and mrb_load_file(). The conditions under which the previous top-level local variables referenced from blocks is detached in these functions are as follows:

If the function has no mrbc_context pointer parameter, or the mrbc_context pointer parameter is set to NULL.
If the number of variables held in the mrbc_context pointer is less than the number of previous top-level local variables.

Intentional reliance on previous behavior may cause compatibility problems in your application.

CVEs

Following CVEs are fixed.

We have done 1,243 commits to 270 files with 19,130 additions and 10,192 deletions since mruby 3.1.0. For more detail of the updates, see Commit Log.

Thanks to all the contributors who have worked on bug fixes and improvements in the release of mruby 3.2.0.

mruby 3.1.0 released

Sat, 12 Mar 2022 00:00:00 +0000

mruby 3.1.0

We are announcing the first stable release of mruby 3.1 series - mruby 3.1.0.

Describes the new features and changes in mruby 3.1.
The main changes in mruby 3.1 are also described in doc/mruby3.1.md.

New Features

Core Language Features

Keyword Arguments

CRuby3.0 compatible keyword arguments are introduced. Keyword arguments are basically separated from ordinal arguments.

Other Language Enhancement

Implement endless-def Ruby:Feature#16746
Replace R-assignment by single-line pattern matching Ruby:Feature#15921
Support squiggly heredocs. #5246
Hash value omission Ruby:Feature#14579

Configuration Options Changed

Some configuration macros are available:

MRB_WORDBOX_NO_FLOAT_TRUNCATE: by default, float values are packed in the word if possible, but define this macro to allocate float values in the heap.
MRB_USE_RO_DATA_P_ETEXT: define this macro if _etext is available on your platform.
MRB_NO_DEFAULT_RO_DATA_P: define this macro to avoid using predefined mrb_ro_data_p() function

Updated Features

New build configurations

We have added several new build configurations in the build_config directory.

cross-mingw-winetest.rb
cross-mingw.rb
nintendo_switch.rb
serenity.rb
minimal: minimal configuration
host-f32: compiles with mrb_float as 32 bit float
host-nofloat: compiles with no float configuration
android_arm64_v8a.rb: renamed from android_arm64-v8a.rb

Core Libraries

New Methods

Array#product
Array#repeated_combination
Array#repeated_permutation
Kernel#__ENCODING__
Random.bytes
Random#bytes
String#center

New Gem Enhancement

mrbgems/mruby-pack now supports M directive (Q encoding)
mrbgems/mruby-pack now supports X directive (back-up by bytes)
mrbgems/mruby-pack now supports @ directive (absolute position)
mrbgems/mruby-pack now supports w directive (BER compression)

Tools

mruby-config now supports --cc and --ld options.
Remove OP_ prefix from mruby -v code dump output.
Prohibit use of OP_EXT{1,2,3} by mrbc with --no-ext-ops option.

Features for mruby Developer

Add new specifier c to mrb_get_args() for receive Class/Module.

Breaking Changes

Incompatibly Changed Methods

Kernel#printf (mruby-sprintf) Format specifiers %a and %A are removed.
Kernel#puts (mruby-print) Now expand Array arguments.

mruby VM and bytecode

Due to improvements in the binary format, mruby binaries are no longer backward compatible. To run the mruby binaries on mruby 3.1, recompile with the mruby 3.1 mrbc.

Upgrade mruby VM version RITE_VM_VER to 0300 (means mruby 3.0 or after).
Upgrade mruby binary version RITE_BINARY_FORMAT_VER to 0300.

Reintroduced Instructions

mruby3.0 removed OP_EXT1, OP_EXT2, OP_EXT3 for operand extension. But the operand size limitations was too tight for real-world application. mruby3.1 reintroduces those extension instructions.

Removed Instructions

mruby3.1 removed following instructions.

OP_LOADL16
OP_LOADSYM16
OP_STRING16
OP_LAMBDA16
OP_BLOCK16
OP_METHOD16
OP_EXEC16

Those instructions are no longer needed by reintroduction of extension instructions.

OP_SENDV
OP_SENDVB

Those instructions for method calls with variable number of arguments are no longer needed. They are covered by OP_SEND instruction with n=15.

New Instructions

mruby3.1 introduces following new instructions.

OP_GETIDX: takes 1 operands R[a][a+1]
OP_SETIDX: takes 1 operands R[a][a+1]=R[a+2]
OP_SSEND: takes 3 operands a=self.b(c...); see OP_SEND
OP_SSENDB: takes 3 operands a=self.b(c...){...}; see OP_SEND
OP_SYMBOL: takes 2 operands R[a] = intern(Pool[b])

`OP_GETIDX` and `OP_SETIDX`

Execute obj[int] and obj[int] = value respectively, where obj is string|array|hash.

`OP_SSEND` and `OP_SSENDB`

They are similar to OP_SEND and OP_SENDB respectively. They initialize the R[a] by self first so that we can skip one OP_LOADSELF instruction for each call.

`OP_SYMBOL`

Extracts the character string placed in the pool as a symbol.

Changed Instructions

`OP_SEND` and `OP_SENDB`

Method calling instructions are unified. Now OP_SEND and OP_SENDB (method call with a block) can support both splat arguments and keyword arguments as well.

The brief description of the instructions:

`OP_SEND`	BBB	`R[a] = R[a].call(Syms[b],R[a+1..n],R[a+n+1],R[a+n+2]..nk) c=n\|nk<<4`
`OP_SENDB`	BBB	`R[a] = R[a].call(Syms[b],R[a+1..n],R[a+n+1..nk],R[a+n+2..nk],&R[a+n+2*nk+2]) c=n\|nk<<4`

Operand C specifies the number of arguments. Lower 4 bits (n) represents the number of ordinal arguments, and higher 4 bits (nk) represents the number of keyword arguments. When n == 15, the method takes arguments packed in an array. When nk == 15, the method takes keyword arguments are packed in a hash.

`OP_ARYPUSH`

Now takes 2 operands and pushes multiple entries to an array.

Boxing Updated

Word Boxing

MRB_WORD_BOXING now packs floating point numbers in the word, if the size of mrb_float is equal or smaller than the size of mrb_int by default. If the size of mrb_float and mrb_int are same, the last 2 bits in the mrb_float are trimmed and used as flags. If you need full precision, you need to define MRB_WORDBOX_NO_FLOAT_TRUNCATE as described above.

NaN Boxing

Previous NaN boxing packs values in NaN representation, but pointer retrievals are far more frequent than floating point number references. So we add constant offset to NaN representation to clear higher bits of pointer representation. This representation is called “Favor Pointer” NaN Boxing.

Also, previous NaN boxing limit the size of mrb_int to 4 bytes (32 bits) to fit in NaN values. Now we allocate integer values in the heap, if the value does not fit in the 32 bit range, just like we did in Word Boxing.

Constant Folding

The code generator was updated to reduce the number of instructions, e.g.

a = 2 * 5

will be interpreted as

a = 10

In addition, we have improved peephole optimizations, for example:

GETIV R4 :@foo
MOVE R1 R4

GETIV R1 :@foo

`String#hash` now use `FNV1a` algorithm

For better and faster hash values.

Major bug fixes

Fix infinite recursive call bugs in integer division 98799aa6
Fix to raise TypeError with super inside instance_eval / class_eval #5476
Fix to call method_added hooks on method definitions; #2339
Fix a potential buffer overflow in time_zonename 26340a88
Fix Module.instance_eval bug #5528
Fix fix M packing bug bfe2bd49
Fix a bug regarding attribute assignment with kargs de2b4bd0
Fix SIGSEGV with mrbgems/mruby-method #5580
Fix print error before cleanup in codegen_error() #5603
Fix a bug in unpacking BER #5611
Fix a bug with numbered parameters as arguments #5605
Fix mrb_ary_shift_m initialization bug 27d1e013
Fix keyword argument with super #5628
Fix a bug with numbered parameters on toplevel 7e7f1b2f
Fix keyword argument bug #5632
Fix multiple assignments in parameters #5647
Fix keyword parameters not passing through super #5660
Fix infinite loop from unclosed here-doc #5676
Fix negative integer division bug #5678

CVEs

Fixed CVEs

Following CVEs are fixed in this release.

CVE-2021-

Unaffected CVEs

Following CVEs do not cause problems in this release. They are fixed in the later release.

We have done 1,076 commits to 287 files with 17,188 additions and 15,549 deletions since mruby 3.0.0. For more detail of the updates, see Commit Log.

Thanks to all the contributors who have worked on bug fixes and improvements in the release of mruby 3.1.0.

mruby 3.0.0 released

Fri, 05 Mar 2021 00:00:00 +0000

mruby 3.0.0

We are announcing the first stable release of mruby 3.0 series - mruby 3.0.0.

With mruby 3.0, the memory used of the mruby VM has been significantly reduced, and we have succeeded in significantly saving memory. Previous versions required several hundred KB of RAM, but mruby 3.0 can launch an application with about 100 KB of RAM.

Describes the new features and changes in mruby 3.0.
The main changes in mruby 3.0 are also described in doc/mruby3.md.

New Features

Core Language Features

Implement endless-def. Ruby:Feature#16746
Replace R-assignment by single-line pattern matching. Ruby:Feature#15921
Support squiggly heredocs. #5246

Features for mruby Developer

Add new C APIs
- mrbc_cleanup_local_variables() - Clean up local variables on mrbc_context. #4931
- Add functions that take symbols as arguments.
  - mrb_define_singleton_method_id()
  - mrb_define_class_method_id()
  - mrb_define_module_function_id()
  - mrb_undef_method_id()
  - mrb_undef_class_method_id()
  - mrb_define_const_id()
  - mrb_funcall_id()
- Add functions for symbol checking that return mrb_sym value.
  - mrb_intern_check()
  - mrb_intern_check_cstr()
  - mrb_intern_check_str()
- mrb_fiber_resume() - Allow context switch from C module.

Update Features

Reduce memory usage

Preallocate Symbols
The mruby 3.0 can now significantly reduce RAM usage by allocating symbols to static memory area at compile time. See doc/guides/symbol.md for more information.
Reduce memory usage of Hash objects. f2d8db39
Reduce memory usage when calling methods. #5272

Updated build process

The old build configuration file build_config.rb has been reconfigured to a file in the build_config directory.
For example, the following typical build configuration is available.

default: the default configuration
host-gprof: compiles with gprof for performance tuning
host-m32: compiles in gcc 32bit mode on 64bit platforms
boxing: compiles all three boxing options
clang-asan: compiles with clang’s Address Sanitizer

You can specify the mruby build configuration by building mruby with the rake build, specifying the build configuration file in the environment variable MRUBY_CONFIG.

Core Libraries

Add new libraries.
- mruby-catch - Support Kernel.#catch and Kernel.#throw. 7eaaee54
- mruby-os-memsize - Support ObjectSpace.memsize_of and ObjectSpace.memsize_of_all. #5032 #5040 #5041
Add Array.new([]) initialization. (mruby-array)
Add Hash#except (mruby-hash-ext)
Update IO#popen to use keyword arguments. (mruby-io)
Make Module#include and Module#prepend behave like Ruby 3.0. 3972df57

Tools

Allow to mixed and specify *.rb and *.mrb in mruby interpreter. a045b6b8
Add irep C struct dump from mrbc with -S option.

Features for mruby Developer

Add new specifier c to mrb_get_args() for receive Class/Module.

Breaking Changes

mruby VM and bytecode

Due to improvements in the binary format, mruby binaries are no longer backward compatible. To run the mruby binaries on mruby 3.0, recompile with the mruby 3.0 mrbc.

Upgrade mruby VM version RITE_VM_VER to 0300 (means mruby 3.0).
Upgrade mruby binary version RITE_BINARY_FORMAT_VER to 0200.

Recognize Integer system

Integer has been changed to a specification similar to CRuby.

Integrate Fixnum and Integer.
Remove Integral.
int / int -> int
Add APIs for Integer. APIs for Fixnum (mrb_fixnum_xxx()) is also left for compatibility.
- mrb_fixnum() -> mrb_integer()
- mrb_fixnum_value() -> mrb_int_value()
- mrb_fixnum_p() -> mrb_integer_p()

Major bug fixes

Fix take over file scope variables with mruby and mirb command. #4933
Fix performing block_given? from inside an orphan block always returns false. #5039
Fix segmentation fault in Mruby interpreter making it crash #5046
Fix splat operator to frozen Array raises FrozenError. #5067
Fix wrong behavior of File.extname when the filename starts or ends with a period. (mruby-io) #5077
Fix #parameters mistakes keyword “splat” for a block parameter. #5066
Fix mruby-io doesn’t work in processes started as Windows service. #5114
Fix resuming fiber from C seems to loop infinitely. #5261
Fix invalid UTF-8 string length. #5269
Fix avoid syntax error when EXPR_MID appears in conditional operator. #5290
Fix symbols like numbered parameters in blocks get a syntax error. #5295
Avoid infinite loops when converting objects to strings. 01a8d849
Fix module order of #include. ruby-bug:7844

We have done 983 commits to 274 files with 16,929 additions and 11,685 deletions since mruby 2.1.2. For more detail of the updates, see Commit Log.

Thanks to all the contributors who have worked on bug fixes and improvements in the release of mruby 3.0.0.

mruby 2.1.2 released

Thu, 06 Aug 2020 00:00:00 +0000

mruby 2.1.2

We are announcing the stable release of mruby 2.1 series - mruby 2.1.2.

New Features

Core Language Features

Support for Argument Forwarding, which allows you to forward arguments in the form def foo(...).

mruby VM and bytecode

Add OP_LOADI16 instruction that loads a 16-bit integer into a register.
Remove endian information/flags from compiled binary format.
The version of the mruby binary has changed from 0006 to 0007.

for mruby Developer

Add new C APIs.
- mrb_float_to_cstr() - Convert Float to C String.
- mrb_singleton_class_ptr() - Get pointer of Singleton class. #4973
- mrb_utf8len() - Get size of UTF-8 string. #4712
- mrb_utf8_strlen() - Get length of UTF-8 string. #4712
- mrb_get_arg1() - Retrieve the first and only argument from mrb_state.

Update Features

Core Libraries

Add to the libraries included by default in the mruby VM.
- mruby-eval
- mruby-complex
- mruby-rational
Support MRB_DISABLE_STDIO for mruby-pack and mruby-sprintf. #4954
Support IO#pread and IO#pwrite on macOS.
Improve Kernel.#eval to call method with the same name as a variable name without any arguments.
IO#readchar supports UTF-8 characters.

Tools

Remove -e / -E options from mrbc.

for mruby Developer

Support width specifier with mrb_float_to_str().
Support integer and float combination in mrb_equal().

Improve mruby build

A mruby can be built without GNU Bison. (a3ec6ede)
Supports GitHub Actions. #4903
Execute CI of the following platforms updating the repository.
- Ubuntu 16.04
- Ubuntu 18.04 (gcc)
- Ubuntu 18.04 (clang)
- macOS
- Windows (MinGW)
- Windows (Cygwin)
- Windows (MSVC)

Breaking Changes

IO#readchar returns a UTF-8 character fragment instead of EOFError if EOF is reached in the middle of UTF-8 characters. (86271572)
This behavior is different from CRuby, but it is a mruby specification that supports either ASCII or UTF-8 exclusively.
Remove mrb_run() from C APIs.

Major bug fixes

Segmentation fault at mrb_io_s_select. #4966
Segmentation fault at mrb_vm_exec. #4973
Some Hash methods are inconsistent with values when hash has duplicate key. 181f7b97
Get local variable names from orphan block. #5014
Memory leaks in some places when out of memory. f1523d24
Heap buffer overflow in mruby interpreter. #5042
Type tag not used when calculating hash code. #5049

We have done 185 commits to 99 files with 14,883 additions and 1,653 deletions since mruby 2.1.1. For more detail of the updates, see Commit Log.

Thanks all the contributors who have worked on bug fix and improvements in the release of mruby 2.1.2.

mruby 2.1.1 released

Thu, 04 Jun 2020 00:00:00 +0000

mruby 2.1.1

We are announcing the stable release of mruby 2.1 series - mruby 2.1.1.

New Features

Core Language Features

Ruby 2.7 features

Numbered parameters as default block parameters are introduced. (72d57ad0)

Core Libraries

Ruby 2.7 features

Revert Implement Ruby2.7’s frozen strings from Symbol#to_s. (a367373f)

Update Features

Core Language Features

Always enable the rational and complex literals. (351c9c80)

Core Libraries

The #prepend_features and #module_function methods are not haves for class objects. (cc52fa66)
Remove location info from Exception#inspect. (d2f2f9db)
Allow true/false argument to Kernel#exit. (mrbgems/mruby-exit) (d81e4d71)
Improved the judgment of absolute path on Windows. #4950

Tools

Support short options concatenation to mruby command. (9de7130a)
Support -- (end of options) to mruby command. (f4b528e0)
Quit mruby -v immediately if no program is given for Ruby compatibility. (49653b81)

for mruby Developer

Add assertion to RVALUE size. (6cf99d12)

Compatibility

Core Libraries

Add File#size and File#truncate. (mrbgems/mruby-io) (6d9ac89f)
Add IO#pread and IO#pwrite. (mrbgems/mruby-io) (4c6d524c)
Support bit flags for IO.open. (mrbgems/mruby-io) (69619aee)

Changes

Build system

Abandon minirake. Use rake for compilation.
Currently, minirake is left for compatibility, but it will be removed in the future. (de17f63)

Breaking Changes

Remove MRB_INT16 configuration option. (ff57c027)

Major bug fixes

Parser rejects heredoc without following comma or closing bracket in array/hash literal. #4796
Segfault due to invalid read in str_init_shared. #4807
Invalid read in array_copy and mrb_ary_unshift_m. #4808
Parser segfault (invalid read) in local_add_f. #4810
Parser rejects some heredoc in hash literal. #4815
Rakefile in mruby build emits warnings with Windows paths. #4817
Coredump when use ensure in Kernel#eval script. #4833
Fix keyword arguments not be obtained with mrb_get_args(). #4855
Undefined method `Pathname’ for MRuby::Toolchain::Android. #4895
Cygwin compile error. #4904
String#to_f should not allow hexdecimal format. #4924
Heap use after free in hash_values_at in mrbgems/mruby-hash-ext/src/hash-ext.c:33. #4926
The method name becomes call in backtrace inside a block outside a method. #4936
Segmentation fault at mrbgems/mruby-metaprog/src/metaprog.c:142. #4955
Test mruby-io in tmpdir when AF_UNIX cannot be created on cwd. #4981
IO#readlines/IO#getc hangs while reading over TCPSocket #4982
p->locals may be NULL when error occurs before the point. oss-fuzz: Issue 19886
Fix buffer overflow in mrb_str_len_to_dbl. oss-fuzz: Issue 19902
Fix file/directory name parameter for git command.
Fix MRB_FIXNUM_SHIFT with MRB_WORD_BOXING, MRB_INT32 and MRB_64BIT.
Build when directories and files have spaces.
Fix argument specs of below methods.
- Exception
  Exception#exception.
- IO (mrbgems/mruby-io)
  IO._popen, IO.for_fd, IO.select, IO.sysopen, IO.new, IO#sysread and IO#sysseek.
- File (mrbgems/mruby-io)
  File.umask.
- Integer
  Integer#ceil, Integer#floor, Integer#round and Integer#truncate.
- Kernel
  BasicObject#instance_eval, Kernel#integer, Kernel#define_singleton_method, Kernel#send, Kernel#proc, Kernel#sprintf, Kernel#format and Kernel#respond_to?.
- Hash
  Hash.new and Hash#default.
- Fiber (mrbgems/mruby-fiber)
  Fiber.new.

We have done 321 commits to 134 files, 4,084 lines were added, 2,742 lines removed since mruby 2.1.0. For more detail of the updates, see Commit Log.

Stay Home and enjoy mruby 2.1.1.

mruby 2.1.0 released

Tue, 19 Nov 2019 00:00:00 +0000

mruby 2.1.0

We are proudly announcing the stable release of mruby 2.0 series - mruby 2.1.0.
The mruby 2.1.0 has been enhanced with compatibility with Ruby 2 series, and some new features of Ruby 2.7 have been added.

New Features

Core Language Features

Suffix support (Rational and Complex literals) (#4125)

Core Libraries

Ruby 2.7 features

Add Array#intersection method which returns a new array containing elements common to both arrays. (mrbgems/mruby-array-ext)
Add Enumerable#filter_map method which is a short hand for filter + map in a single call. (mrbgems/mruby-enum-ext)
Add Enumerable#tally method which group and count elements of the collection. (mrbgems/mruby-enum-ext)
Add Enumerator.produce method which creates an infinite enumerator from any block. (mrbgems/mruby-enumerator)
Add UnboundMethod#bind_call method which call a method that overridden without allocation of intermediate Method object. (mruby-method)
Module#name, true#to_s, false#to_s return a frozen string. The returned string is always the same object.

Ruby 2.6 features

Add Array#difference method:
Array#difference returns a new array that is a copy of the original array, removing any items that also appear in other_ary. (mrbgems/mruby-array-ext)

New Libraries

Add mrbgems/mruby-rational:
Rational class has been included into the core library, and rational numbers like 1/3 can be handled.
Add mrbgems/mruby-complex:
Complex class has been included into the core library to handle complex numbers.

New C APIs

Macros for checking object type

mrb_false_p(o)
mrb_true_p(o)
mrb_free_p(o)
mrb_object_p(o)
mrb_class_p(o)
mrb_module_p(o)
mrb_iclass_p(o)
mrb_sclass_p(o)
mrb_proc_p(o)
mrb_range_p(o)
mrb_file_p(o)
mrb_env_p(o)
mrb_data_p(o)
mrb_fiber_p(o)
mrb_istruct_p(o)
mrb_break_p(o)

mruby core (mruby.h)

MRB_API mrb_int mrb_cmp(mrb_state *mrb, mrb_value obj1, mrb_value obj2);

mruby binary (mruby/dump.h, mruby/irep.h)

MRB_API mrb_irep *mrb_read_irep_buf(mrb_state*, const void*, size_t);   // mruby/dump.h
MRB_API mrb_value mrb_load_irep_buf(mrb_state*, const void*, size_t);   // mruby/irep.h
MRB_API mrb_value mrb_load_irep_buf_cxt(mrb_state*, const void*, size_t, mrbc_context*);   // mruby/irep.h

Numeric class (mruby/numeric.h)

MRB_API mrb_value mrb_num_plus(mrb_state *mrb, mrb_value x, mrb_value y);
MRB_API mrb_value mrb_num_minus(mrb_state *mrb, mrb_value x, mrb_value y);
MRB_API mrb_value mrb_num_mul(mrb_state *mrb, mrb_value x, mrb_value y);
MRB_API mrb_value mrb_int_value(mrb_state *mrb, mrb_float f);

String class (mruby/string.h)

MRB_API void mrb_str_modify_keep_ascii(mrb_state *mrb, struct RString *s);
MRB_API const char *mrb_string_cstr(mrb_state *mrb, mrb_value str);

mruby/value.h

Add customized mrb_ro_data_p() (#4408)

Enumerable module and Hash class

Add filter aliases for Enumerable and Hash. (57a0132b)

Configuration

(Proof of Concept) mruby tuning profiles (#4446)

mrbtest

Test Features

Warn if assertion is missing inside assert (#4320)

New test method (mrbtest)

assert_match(pattern, str, msg=nil)
assert_not_match(pattern, str, msg=nil)
assert_raise_with_message(exc, exp_msg, msg = nil, &block
assert_raise_with_message_pattern(exc, exp_msg, msg = nil, &block)
assert_not_nil(target, msg)

Tools

Interactive mruby (mirb)

As with irb in Ruby, a local variable _ is added to store the last result.

Update Features

mruby core

Allow newlines and comments between method calls. (4296c77e)
Support &. at the beginning of the line (4124047c)

Build system

Support lock file
It is now possible to fix mruby and mrbgems versions in products that use mruby.
Rename MRB_USE_ETEXT_EDATA to MRB_USE_LINK_TIME_RO_DATA_P and support lld linked programs (#4716)

C APIs

mruby core

Keyword arguments can be obtained with mrb_get_args using the format string :.
mrb_parser_dump supports displaying NODE_DSYM, NODE_WORDS, NODE_SYMBOLS and NODE_LITERAL_DELIM.
Raise ArgumentError by aspec check. (30f37872)

src/error.c

Add new specifiers/modifiers to format string of mrb_vfromat() (#4608)

mrbtest

Nested assert for mrbtest (#4540)

Compatibility

mruby core

Pad leading zero to month and day in MRUBY_RELEASE_DATE (#4353)

Core Libraries

Add Class#new(*args, &block) method.
Add optional argument to Module#class_variables.
Add constants for floating point number. (RADIX, MANT_DIG, EPSILON, DIG, MIN_EXP, MIN, MIN_10_EXP, MAX_EXP, MAX, MAX_10_EXP)
Removed $1..$9 from Kernel#global_variables.
String#unpack/Array#pack does support base64 directive (m).
Add encoding argument to Integral#chr (#4593)
Fixed length for IO should be in bytes, not in characters (8c90b5fc)

Breaking Changes

There are three major breaking changes from mruby 2.0.1.

Changed methods

Move Array#append and Array#prepend from core to mrbgems/mruby-ary-ext.
Move Numeric#div from mrbgems/mruby-numeric-ext to the core.
Move Integral#zero?, Integral#nonzero?, Integral#positive? and Integral#negative)? to Numeric class.
Move Numeric#__coerce_step_counter to Integral class.
Move Kernel#instance_exec, Kernel#equal? and Kernel#instance_eval to BasicObject class.
Move NilClass#to_h to mrbgems/mruby-object-ext from mrbgems/mruby-enum-ext
Move String#getbyte, String#setbyte and String#byteslice to the core. (#4696)
Remove Kernel#global_variables from core. This method is defined in mrbgems/mruby-metaprog.
Integrate Integral#chr (Fixnum#chr) to mrbgems/mruby-string-ext.
Remove String#=~ and String#match that requires Regexp (fd37bc53)
Symbol#to_s return a frozen string. The returned string is always the same object. This feature will be reverted next mruby, because which reverted from Ruby 2.7.
Explicit .0 is removed from result of Float#to_s and Float#inspect. (9d08025b)

Change C APIs

Rename symbol-to-string functions. (#4684)
- mrb_sym2name() -> mrb_sym_name()
- mrb_sym2name_len() -> mrb_sym_name_len()
- mrb_sym2str() -> mrb_sym_str()

Remove C APIs

Functions to remove MRB_API from definitions (referenced from within libmruby):
mrb_instance_new(), mrb_vm_define_class(), mrb_vm_define_module()
struct RIstruct is renamed to struct RIStruct (e41f1574)
Remove mrb_fixnum_plus(), mrb_fixnum_minus(), mrb_fixnum_mul(), and mrb_num_div(). Use mrb_num_plus(), mrb_num_minus(), mrb_num_mul() instead.
Remove a member ary of struct RString. struct RStringEmbed is used for String embedding. (#4646)

mruby core

Remove global variable $/. The current Ruby policy do not encourage Perl-ish global variables.
Remove MRB_TT_HAS_BASIC macro. (#4728)
Remove members flags and mems of struct mrb_state. (0c5f26e0 and #4470)

Configuration

Remove MRB_METHOD_TABLE_INLINE and MRB_NO_INIT_ARRAY_START. (2256bb07 and #4716)
MRB_USE_ETEXT_EDATA is deprecated (warned and ignored). instead, use MRB_USE_LINK_TIME_RO_DATA_P. (#4716)

mruby binary (MRB)

Remove “LINE” section reader. (#4455)

Major bug fixes

SystemStackError is raised from String#=~. (#4363)
Null pointer dereference in ecall. (#4370)
mismatched shift functions. (#4380)
Compilation error with “MRB_ARY_EMBED_LEN_MAX” in “array.h”. (#4382)
Fixed a bug in recursive mrb_top_run calls; fix (#4384)
Unexpected error: Can't get cfunc env from non-cfunc proc. (#4389)
build error on master by MRB_WITHOUT_FLOAT. (#4478)
Null pointer dereference in mrb_str_cat_str. (#4504)
Some comments do not increment lineno on context. (#4513)
Null pointer dereference in mrb_check_frozen. (#4519)
Invalid read in mrb_class. (#4534)
Array#inspect recurses too much for self-referential arrays. (#4552)
Infinite loop in Integer#step when both args are INFINITY. (#4555)
Float#round hangs for large ndigits. (#4566)
Cannot call Fiber.yield in method. (#4567)
Reference to top-level variable in top-level block is broken. (#4581)
Bugs with mutually recursive Array and Hash. (#4582)
mrb_gc_unregister() may access freed memory. (#4618)
memcpy-param-overlap in str_replace_partial. (#4627)
Symbol#inspect does not handle Unicode characters. (#4678)
mrb_funcall returns odd value. (#4696)
behavior of alias is different from CRuby. (#4718)
compile error at master by clang 9. (#4786)

We have done 912 commits to 229 files, 12,006 lines were added, 5,382 lines removed since mruby 2.0.1. For more detail of the updates, see Commit Log.

Let’s try mruby 2.1.0.

mruby 2.0.1 released

Thu, 04 Apr 2019 00:00:00 +0000

mruby 2.0.1

We are proudly announcing the stable release of mruby 2.0 series - mruby 2.0.1.

New Features

Core Language Features

Support string literal concatenation.

Core Libraries

Ruby 2.6 Features

Add Enumerator::Chain, Enumerable#chain and Enumerator#+.
Add function composition operators << and >> to Proc and Method.

Compatibility

Recover methods removed in mruby 2.0.0. String#to_str, Integer#to_int, Float#to_int
Improve compatibility to CRuby for Float#to_s #4225

mruby-class-ext

Add methods.
Module#<, Module<=, Module>, Module>=, Module<=>

mruby-pack

Support Big-endian platform.

Tools

mruby debugger (mrdb)

Add info locals command.

New C APIs

mruby core

MRB_API mrb_value mrb_ary_splice(mrb_state *mrb, mrb_value self, mrb_int head, mrb_int len, mrb_value rpl);
MRB_API void mrb_notimplement(mrb_state*);
MRB_API mrb_value mrb_vformat(mrb_state *mrb, const char *format, va_list ap);

String class

MRB_API double mrb_cstr_to_dbl(mrb_state *mrb, const char *s, mrb_bool badcheck);
MRB_API mrb_value mrb_cstr_to_inum(mrb_state *mrb, const char *s, mrb_int base, mrb_bool badcheck);

Hash class

MRB_API void mrb_hash_foreach(mrb_state *mrb, struct RHash *hash, mrb_hash_foreach_func *func, void *p);
MRB_API mrb_int mrb_hash_size(mrb_state *mrb, mrb_value hash);

Object class

MRB_API void mrb_iv_foreach(mrb_state *mrb, mrb_value obj, mrb_iv_foreach_func *func, void *p);

Time class

MRB_API mrb_time_at(mrb_state *mrb, double sec, double usec, enum mrb_timezone zone);

Reducing Memory Consumption

Remove symbol hash table from mrb_state structure.
Use linear search instead. Number of symbols is usually small (<1K), so we don’t need performance boost from hash tables. In our benchmark measurement, hash tables consumes 790KB for build/full-debug/mrbtest.
Implement inline packed symbols.
Small symbols with all alphanumeric characters (<5) are packed in 32bit symbol integer a la base64.
This means those small symbols are not listed in Symbol.all_symbols.

Breaking Changes

There are three major breaking changes from mruby 2.0.0

Binary (MRB) format

Change compiled binary format version. (“0005” -> “0006”)

Add RRange API

Developers must use following APIs for accessing attributes of RRange because RRange structure depends on boxing setting.

mrb_range_beg
mrb_range_end
mrb_range_excl_p

Remove C API

Functions to be made static (MRB_API was not needed):
mrb_mod_module_function(), mrb_obj_hash(), mrb_str_len_to_inum(), sym2name_len()
Functions to remove MRB_API from definitions (referenced from within libmruby):
mrb_mod_cv_defined(), mrb_mod_cv_get(), mrb_f_send()

Small incompatible changes in function prototypes

mrb_parser_get_filename: return value changed to mrb_sym.
mrb_debug_get_filename: add mrb_state* as a first argument.
mrb_debug_get_line: ditto.

Remove methods

Remove Kernel#class_defined? which is not available in CRuby; #3829

Major bug fixes

Fixed a bug on platforms without BYTE_ORDER; fix #4190
Fix 0.0 and -0.0 handling.
Fix dump/load float literal evaluate to infinity.
Fix Symbol#size for multi-byte characters with MRB_UTF8_STRING.
Add OP_ENTER to blocks without parameters; fix #4175
Should not check non-node value to void_expr_error; fix #4203 #4192
Should not copy keys&values when a hash table is empty; fix #4270
Raise error on failed comparison in sort; ref #4307
Fix memory leak in time_update_datetime; fix #4308

We have done 371 commits to 163 files, 2,397 lines were added, 1,570 lines removed since mruby 2.0.0. For more detail of the updates, see Commit Log.

Evaluated mrbgems list (NPO mruby forum)

See the list.

Let’s try mruby 2.0.1.

mruby 2.0.0 released

Tue, 11 Dec 2018 00:00:00 +0000

mruby 2.0.0

We are proudly announcing the first stable release of mruby 2.0 series – mruby 2.0.0.

This release includes the improvement of Ruby2.x compatibility and memory consumption.

New Features

Core Language Features

Keyword Arguments Implemented (Ruby 2.0 Compatible)
Argument Deconstructing Implemented

Core Libraries

mruby-kernel-ext

Kernel#then was added as Kernel#yield_self (Ruby 2.6 Compatible)

mruby-array-ext

Array#to_h can be called with a block (Ruby 2.6 Compatible)
Array#union was added (Ruby 2.6 Compatible)

mruby-string-ext

String#lines can be called with a block
The following methods are added String#tr, String#tr!, String#tr_s, String#tr_s!, String#squeeze, String#squeeze!, String#count, String#delete, String#delete!

mruby-pack

String#unpack1 was added

mruby-metaprog

Meta-programming features are separated as a mrbgem. You need to link mruby-metaprog to use meta-programming. (See Breaking Changes for more detail)

mruby-sleep

matsumotory/mruby-sleep was bundled as a core library. You can use Kernel#sleep and Kernel#usleep methods.

Tools

mruby compiler (mrbc)

--remove-lv option was added By specifying --remove-lv, mrbc suppress the generation of local variable information to be used for debugging in the compiled binary. It reduces the size of compiled mruby binary and memory consumption when loaded.

mruby interpreter (mruby)

-d option was added By specifying -d, mruby execute the script in the debugging mode ($DEBUG=true).
-r option was added By specifying -r library, mruby loads the specified library before the execution.

interactive mruby (mirb)

-d option was added (Behaves as mruby -d)
-r option was added (Behaves as mruby -r)

Reducing Memory Consumption

Several improvements were done in mruby 2.0.0 to reduce memory consumption:

Instance variables are stored in segmented lists
Hash implementation replaced from khash
--remove-lv option was added to mruby compiler(mrbc)
And smaller improvements including VM stack and call frames.

Breaking Changes

There are two major breaking changes from mruby 1.4.1

1. Bytecode Overhauled

VM instruction format has been completely changed. The fixed width instruction until mruby 1.4.1 was abandoned. We chose variable length bytecode instructions in mruby 2.0. You need to recompile everything for mruby 2.0.

Binary Format Version: 0005
VM Version: 0002

2. Meta-programming features separated as mrbgem

From the assumption that meta-programming features are not frequently used in embedded system development, we separated meta-programming features as a mebgem (mruby-metaprog). The following methods have moved to mruby-metaprog gem.

Kernel module global_variables, local_variables, singleton_class, instance_variables, instance_variables_defined?, instance_variable_get, instance_variable_set, methods, private_methods, public_methods, protected_methods, singleton_methods, define_singleton_methods, send
Module class class_variables, class_variables_defined?, class_variable_get, class_variable_set, remove_class_variable, included_modules, instance_methods, remove_method, method_removed, constants
Module class (Singleton Methods)
constants, nesting

3. No implicit conversion by `to_int` and `to_str`.

The objects with methods `to_int` or `to_str` are no longer converted to Integers or Strings respectively. Those implicit conversions cause recursive VM calls and had been the source of many bugs.

We have done 378 commits to 156 files, 7,949 lines were added, 5,430 lines removed since mruby1.4.1. For more detail of the updates, see Commit Log.

Evaluated mrbgems list (NPO mruby forum)

See the list.

mruby 1.4.1 released

Fri, 27 Apr 2018 09:15:00 +0000

mruby 1.4.1 released

mruby 1.4.1 is released. Download mruby 1.4.1 now.

mruby 1.4.1 by the numbers

1,106 commits
289 issues fixed
104 pull requests merged
18 contributors
215 changed files
15,199 additions(+)
3,029 deletions(-)

See the full diff.

What’s new in mruby 1.4.1

* Debugger bug and lots of small bug fixes

* New mrbgems (merge from https://github.com/iij)

mruby-io
mruby-socket
mruby-pack

* Supports several Ruby 2.x methods

Comparable#clamp (Ruby 2.4)
Comparable#uniq (Ruby 2.4)
Hash#fetch_values (Ruby 2.3)
Hash#slice (Ruby 2.5)
Hash#to_proc (Ruby 2.3)
Kernel#itself (Ruby 2.2)
Kernel#yield_self (Ruby 2.5)
Numeric#finite? (Ruby 2.4)
Numeric#infinite? (Ruby 2.4)
Numeric#negative? (Ruby 2.3)
Numeric#positive? (Ruby 2.3)
String#delete_prefix (Ruby 2.5)
String#delete_prefix! (Ruby 2.5)
String#delete_suffix (Ruby 2.5)
String#delete_suffix! (Ruby 2.5)
String#casecmp? (Ruby 2.4)
Symbol#casecmp? (Ruby 2.4)

* Supports other methods

Array#combination
Array#permutation
Hash#compact
Hash#transform_keys
Hash#transform_keys!
Hash#trans_values
Hash#trans_values!
Method.nesting
main.define_method
#module_exec
#class_exec

* New Compile options

MRB_WITHOUT_FLOAT
MRB_METHOD_CACHE
MRB_METHOD_TABLE_INLINE

Evaluated mrbgems list (NPO mruby forum)

See the list.

mruby 1.3.0 released

Tue, 04 Jul 2017 09:15:00 +0000

mruby 1.3.0 released

mruby 1.3.0 is released. Download mruby 1.3.0 now.

mruby 1.3.0 by the numbers

1,175 commits
248 issues fixed
262 pull requests merged
14 contributors
221 changed files
12,760 additions(+)
3,734 deletions(-)

See the full diff.

What’s new in mruby 1.3.0

The safe navigation operator (`&.`)

mruby 1.3 now supports the safe navigation operator (&.) to help handle nil value returned from methods. This feature comes from Ruby 2.3.

By using the safe navigation operator, you can simply write

account&.owner&.address

Instead of writing

account && account.owner && account.owner.address

Or (with ActiveSupport)

account.try(:owner).try(:address)

`Array#dig`, `Hash#dig`

#dig is a method to retrieve a value from JSON-like nested Array/Hash structures.

This feature also comes from Ruby 2.3.

For example:

params.dig(:account, :owner, :address)

Instead of

account = params[:account]
owner = account[:owner]
owner[:address]

`Object#freeze`

You can now “freeze” an object by using Object#freeze.

Frozen objects cannot be modified.

`Kernel#caller`

You can retrieve call frame information by using Kernel#caller.

Remaining Bugs

After the code-freeze of 1.3 release, following issues are filed and fixed in the master branch.

The following issues are not yet fixed as of 2017-07-04.

mruby 1.2.0 released

Wed, 18 Nov 2015 12:13:55 +0000

mruby 1.2.0 released

mruby 1.2.0 is released. Download mruby 1.2.0 now.

mruby 1.2.0 by the numbers

778 commits
24 contributors
202 changed files
3,947 additions(+)
3,903 deletions(-)

See the full diff.

What’s new in MRuby 1.2.0

From here, you can see the outstanding changes that made this release.

Each entry is kept brief with a link to reference the associated ticket for more information.

Language changes

Module#prepend added
- #2885 by @archSeer
String#freeze added
- 1a45447b by @matz
Array#index now with block form
- fafe86d by @matz

Core classes changes

UTF-8 String support
- 798ec3a by @matz
- Windows support in #1822 by @mattn

Stdlib updates

Add mruby-error mrbgem for exception handling library
- #2845 by @take-cheeze
mrbtest binary extracted to mruby-test mrbgem
- #2924 by @zzak
- Use conf.enable_test in build_config.rb to run tests
Fiber.yield is now public under mruby-fiber mrbgem
- 28e735e by @matz
mrbc extracted as mruby-bin-mrbc mrbgem
- #2760 by @take-cheeze
- Includes mruby-compiler mrbgem extraction
Add Hash comparison methods
- #3010 by @nobu
- Moved to mruby-hash-ext mrbgem in fa86026 by @matz
Add String#prepend to mruby-string-ext mrbgem
- #2674 by @suzukaze
Add String#insert to mruby-string-ext mrbgem
- #2669 by @suzukaze
Add String#ljust to mruby-string-ext mrbgem
- #2700 by @takahashim
Add String#upto to mruby-string-ext mrbgem
- #2701 by @suzukaze
Add String#setbyte and String#byteslice to mruby-string-ext mrbgem
- 4fdf492 by @matz

C API updates

Rename DISABLE_STDIO -> MRB_DISABLE_STDIO
- Also renamed ENABLE_DEBUG -> MRB_ENABLE_DEBUG_HOOK
- #3014 by @cremno
Allow specify endian in big/little and native when dumping and loading mrbc
- bc9c47d by @matz

Build system updates

Add :mgem option for loading gems from mgem-list
- #2846 by @take-cheeze
Allow mrblib and test directories to have subdirs.
- #2943 by @zzak
Allow bintest to have subdirs
- #2927 by @hone
Able to source mrbgems using :path option
- #2907 by @hone
Add host_target and build_target param to MRuby::CrossBuild instance
- Useful for cross-compiling native extension
- #2857 by @hone
Allow customize bin install path using INSTALL_DIR environment variable
- #2949 by @tatsuhiro-t
Docs changed to yard-mruby and extracted to website
- #2984 by @sagmor
Distribute MRuby’s source as a Ruby gem
- #2937 by @sagmor

mruby 1.1.0 released

Wed, 19 Nov 2014 12:13:55 +0000

mruby 1.1.0 released

mruby 1.1.0 is released. Download mruby 1.1.0 now.

what’s new in mruby 1.1.0

CUI debugger gem (mruby-bin-debugger)
lot of small bug fixes

mruby 1.0.0 released

Sun, 09 Feb 2014 10:13:55 +0000

mruby 1.0.0 released

The first release of mruby is now available. Download mruby 1.0.0 now.

Lightweight Ruby

mruby 3.4.0 released

mruby 3.4.0

User visible changes in mruby3.4 from mruby3.3

The language

Changes in C API

Build & Configuration

Changes in mrbgems

Fixed GitHub Issues

Merged Pull Requests (User Visible Ones)

mruby 3.3.0 released

mruby 3.3.0

User visible changes in mruby3.3 from mruby3.2

The language

Configuration

mruby memory API

Changes in C API

Changes in mrbgems

Changes in build system

Other breaking changes

Bugs Fixed

Pull Requests (User Visible Ones)

mruby, mruby/c Common I/O API Guidelines and Community-developed Libraries released

Common I/O API Guidelines for mruby and mruby/c

mruby, mruby/c Common I/O API Guidelines

mruby 3.2.0 released

mruby 3.2.0

The language

mruby VM and bytecode

Tools

mruby

mrbc

mrbgems

mruby-class-ext

New bundled gems

Breaking Changes

mrb_vm_run() may detach top-level local variables referenced from blocks

CVEs

mruby 3.1.0 released

mruby 3.1.0

New Features

Core Language Features

Keyword Arguments

Other Language Enhancement

Configuration Options Changed

Updated Features

New build configurations

Core Libraries

New Methods

New Gem Enhancement

Tools

Features for mruby Developer

Breaking Changes

Incompatibly Changed Methods

mruby VM and bytecode

Reintroduced Instructions

Removed Instructions

New Instructions

OP_GETIDX and OP_SETIDX

OP_SSEND and OP_SSENDB

OP_SYMBOL

Changed Instructions

OP_SEND and OP_SENDB

OP_ARYPUSH

Boxing Updated

Word Boxing

NaN Boxing

Constant Folding

String#hash now use FNV1a algorithm

Major bug fixes

CVEs

Fixed CVEs

Following CVEs are fixed in this release.

Unaffected CVEs

mruby 3.0.0 released

mruby 3.0.0

New Features

Core Language Features

Features for mruby Developer

Update Features

User visible changes in `mruby3.4` from `mruby3.3`

User visible changes in `mruby3.3` from `mruby3.2`

`mruby`

`mrbc`

`mrb_vm_run()` may detach top-level local variables referenced from blocks

`OP_GETIDX` and `OP_SETIDX`

`OP_SSEND` and `OP_SSENDB`

`OP_SYMBOL`

`OP_SEND` and `OP_SENDB`

`OP_ARYPUSH`

`String#hash` now use `FNV1a` algorithm