Module#prepend #2885

archseer · 2015-07-14T19:16:42Z

Hi, we requested Module#prepend, so about a year later we figured what the heck and went ahead and implemented it.

We've gone and ported over the original ruby commits by ko1 and nobu over to mruby, all tests currently pass. RClass struct size is now bigger, because we needed to add origin, but that seems unavoidable.

/cc @matz @cremno @zzak

Closes #2082.


        Implement Module#prepend.


        Rename classes because of conflicts


        Expose insert position, which should be at origin for include and kla…

…ss for prepend.


        origin must be initialized


        Comment in a refactor to match MRI, but that fails 320 tests.


        Additional patches to make this work


        Remove some remnant debug code


        Added changed check to the mrb_include_module


        Fixed Modules not being fully initialized before #initialize was called


        Ported a bit more of the MRI Module#prepend tests over

Currently kind_of fails miserably, still looking for the reason


        Removed some debug prints from the test


        Ported all MRI prepend tests

And of course, some of them fail miserably


        Include prepended methods in the instance_methods list.


        Enable visibility prepend tests again


        Added Module#method_removed hook


        Removed comment beside method_removed

Not sure if this apart of the ISO standard, so make sure its not misrepresented


        Bugfix, included_modules would include classes


        included_modules, origin fix

Prepended modules would include their origin ICLASS


        Space out test_prepend_super_in_alias assert

Also tried to fix it, however the problem lies with how aliased methods are done and their internal structure. mruby simply aliases methods by grabbing the RProc and giving it a new name, super then determines the original method to call by using the name so a method called m, aliased as m2, will call the m2 super method instead of m

archseer · 2015-07-13T16:01:26Z

Yeah, ruby doesn't support super in aliased methods. mruby#1457

let's implement it in a subsequent PR?

archseer · 2015-07-13T16:09:11Z

I did this change but ended up breaking more tests. There was also another commit in that bug worth checking out

IceDragon200 · 2015-07-13T16:30:07Z

@archseer Only the prepend tests failed for me, check the commit after this one, you probably forgot the origin check?

archseer · 2015-07-13T16:33:12Z

@IceDragon200 yeah, might be :) How many failures do we still have?

IceDragon200 · 2015-07-13T17:06:17Z

@archseer 3 failures, 2 asserts and prepend overall (because)

archseer · 2015-07-13T16:09:11Z

I did this change but ended up breaking more tests. There was also another commit in that bug worth checking out

IceDragon200 · 2015-07-13T16:30:07Z

@archseer Only the prepend tests failed for me, check the commit after this one, you probably forgot the origin check?

archseer · 2015-07-13T16:33:12Z

@IceDragon200 yeah, might be :) How many failures do we still have?

IceDragon200 · 2015-07-13T17:06:17Z

@archseer 3 failures, 2 asserts and prepend overall (because)


        Enable test_prepend_module_ancestors because it seems to pass.


        Set origin when doing kind_of? comparisons


        assert() cannot be nested


        Clean up tests


        Renamed parameters in include_module_at


        Applied gc patch to fix ORIGIN ICLASS method table leak

Based on the gc patch by ko1 ruby/ruby@5922c95


        Remove non-applicable "hack" comment

take-cheeze · 2015-07-15T01:19:05Z

include/mruby/class.h

-#define MRB_INSTANCE_TT(c) (enum mrb_vtype)(c->flags & 0xff)
+// TODO: figure out where to put user flags
+#define MRB_FLAG_IS_ORIGIN (1 << 20)
+#define MRB_FLAG_IS_INSTANCE (0xFF)


I think MRB_FLAG_IS_INSTANCE should be renamed to MRB_INSTANCE_TT_MASK since it's a mask for instance type tag.

@take-cheeze Ah, right, okay, I've changed it, can you review again?

@IceDragon200 LGTM


        Renamed MRB_FLAG_IS_INSTANCE to MRB_INSTANCE_TT_MASK

matz · 2015-07-16T12:53:42Z

Thank you for the implementation. I will merge this. But I need at least a few days to review the patch, sinch the change is huge.

archseer · 2015-07-16T13:02:31Z

@matz Alright, thank you! For reference, here's our fork PR where we discussed the implementation commit-by-commit, if it's of any help: polyfox#1

cremno · 2015-07-16T20:20:05Z

src/class.c

+}
+
+MRB_API void
+mrb_prepend_module(mrb_state *mrb, struct RClass *c, struct RClass *m)


static or declare it in a header: mruby.h like mrb_include_module() or maybe even mruby/class.h because it won't be used that often.

Ah, we missed that one, thanks!

cremno · 2015-07-16T20:22:42Z

src/class.c

+}
+
+MRB_API int
+include_module_at(mrb_state *mrb, struct RClass *c, struct RClass *ins_pos, struct RClass *m, int search_super)



        Make include_module_at static

Since I can't forsee any reason to use it directly inplace of using prepend/include


        Added mrb_prepend_module to mruby header

archseer · 2015-08-22T20:31:59Z

Hi @matz, sorry for the bother, any updates on this?

matz · 2015-09-03T06:55:20Z

Finally I took time to review this pull request. Sorry for being so late.

The PR seems fine except for on thing. You have added origin member to struct RClass but due to union RVALUE system in gc.c, adding an extra member to the struct would increase 1 word memory space for every mruby object. This is unacceptable for small footprint implementation.

If you are willing to address this issue, I'd love to wait. If you are not, I will take time to fix, but you may have to wait longer in this case.

archseer · 2015-09-03T15:20:13Z

Hi @matz, in the original pull request description we pointed out "RClass struct size is now bigger, because we needed to add origin, but that seems unavoidable."

I'd be happy to try and implement an alternative, however I have no idea how that would look like.

furunkel · 2015-09-03T16:08:46Z

A golden opportunity to remove RVALUE and introduce something like a segregated free list 😉 .

matz · 2015-09-04T16:52:33Z

@furunkel it's trade-off, RVALUE makes GC simpler and sweeping faster.

@archseer I think I can succeeded to remove origin by adding one bit flag. I will commit soon.


        remove `origin` member to implement prepend from struct RClass; ref #…

…2885 instead origin is saved in ICLASS with MRB_FLAG_IS_ORIGIN set.

archseer · 2015-09-04T17:13:56Z

🎉 🎈 🎉 thanks matz!

furunkel · 2015-09-04T17:22:39Z

@matz, sure, but segregating into a small number of object types, say, small, medium, large wouldn't be very complicated and allow to simplify a few other things while not really hurting sweeping performance.

Blaž Hrastnik and others added 19 commits Jul 9, 2015

Implement Module#prepend.

f962890

Rename classes because of conflicts

d046814

Expose insert position, which should be at origin for include and kla…

ad9f32c

…ss for prepend.

origin must be initialized

2e617e3

Comment in a refactor to match MRI, but that fails 320 tests.

97529c2

Additional patches to make this work

005cacf

Remove some remnant debug code

ce66727

Added changed check to the mrb_include_module

40f4803

Fixed Modules not being fully initialized before #initialize was called

d4b009b

Ported a bit more of the MRI Module#prepend tests over

99aff17

Currently kind_of fails miserably, still looking for the reason

Removed some debug prints from the test

319553f

Ported all MRI prepend tests

47264bf

And of course, some of them fail miserably

Include prepended methods in the instance_methods list.

a725cb9

Enable visibility prepend tests again

11dad71

Added Module#method_removed hook

6681530

Removed comment beside method_removed

1f678a4

Not sure if this apart of the ISO standard, so make sure its not misrepresented

Bugfix, included_modules would include classes

199a808

included_modules, origin fix

81a2b34

Prepended modules would include their origin ICLASS

Blaž Hrastnik and others added 7 commits Jul 13, 2015

Enable test_prepend_module_ancestors because it seems to pass.

b0fb9cc

Set origin when doing kind_of? comparisons

8c13e2b

assert() cannot be nested

8c4da7a

Clean up tests

78462c9

Renamed parameters in include_module_at

f0e920b

Applied gc patch to fix ORIGIN ICLASS method table leak

eb172c2

Based on the gc patch by ko1 ruby/ruby@5922c95

Remove non-applicable "hack" comment

Loading status checks…

dbbf2e2

take-cheeze reviewed Jul 15, 2015
View changes

Renamed MRB_FLAG_IS_INSTANCE to MRB_INSTANCE_TT_MASK

Loading status checks…

667f778

cremno reviewed Jul 16, 2015
View changes

src/class.c Outdated

}

MRB_API int

include_module_at(mrb_state *mrb, struct RClass *c, struct RClass *ins_pos, struct RClass *m, int search_super)

This comment has been minimized.

Sign in to view

Copy link

cremno Jul 16, 2015
Contributor

static?

IceDragon200 added 2 commits Jul 16, 2015

Make include_module_at static

ae1ece7

Since I can't forsee any reason to use it directly inplace of using prepend/include

Added mrb_prepend_module to mruby header

Loading status checks…

26bee4a

matz merged commit 26bee4a into mruby:master Sep 4, 2015
1 check passed

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

matz added a commit that referenced this pull request Sep 4, 2015

remove `origin` member to implement prepend from struct RClass; ref #…

2550edd

…2885 instead origin is saved in ICLASS with MRB_FLAG_IS_ORIGIN set.

mruby / mruby

Module#prepend #2885

Module#prepend #2885

archseer commented Jul 14, 2015

This comment has been minimized.

archseer commented on `11cb417` Jul 13, 2015

This comment has been minimized.

archseer commented on `199a808` Jul 13, 2015

This comment has been minimized.

IceDragon200 replied Jul 13, 2015

This comment has been minimized.

archseer replied Jul 13, 2015

This comment has been minimized.

IceDragon200 replied Jul 13, 2015

This comment has been minimized.

archseer commented on `199a808` Jul 13, 2015

This comment has been minimized.

IceDragon200 replied Jul 13, 2015

This comment has been minimized.

archseer replied Jul 13, 2015

This comment has been minimized.

IceDragon200 replied Jul 13, 2015

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

matz commented Jul 16, 2015

archseer commented Jul 16, 2015

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

archseer commented Aug 22, 2015

matz commented Sep 3, 2015

archseer commented Sep 3, 2015

furunkel commented Sep 3, 2015

matz commented Sep 4, 2015

archseer commented Sep 4, 2015

furunkel commented Sep 4, 2015

mruby / mruby

Join GitHub today

Module#prepend #2885

Module#prepend #2885

Conversation

archseer commented Jul 14, 2015

This comment has been minimized.

archseer commented on 11cb417 Jul 13, 2015

This comment has been minimized.

archseer commented on 199a808 Jul 13, 2015

This comment has been minimized.

IceDragon200 replied Jul 13, 2015

This comment has been minimized.

archseer replied Jul 13, 2015

This comment has been minimized.

IceDragon200 replied Jul 13, 2015

This comment has been minimized.

archseer commented on 199a808 Jul 13, 2015

This comment has been minimized.

IceDragon200 replied Jul 13, 2015

This comment has been minimized.

archseer replied Jul 13, 2015

This comment has been minimized.

IceDragon200 replied Jul 13, 2015

This comment has been minimized.

take-cheeze Jul 15, 2015

This comment has been minimized.

IceDragon200 Jul 15, 2015

This comment has been minimized.

take-cheeze Jul 15, 2015

matz commented Jul 16, 2015

archseer commented Jul 16, 2015

This comment has been minimized.

cremno Jul 16, 2015

This comment has been minimized.

IceDragon200 Jul 16, 2015

This comment has been minimized.

cremno Jul 16, 2015

archseer commented Aug 22, 2015

matz commented Sep 3, 2015

archseer commented Sep 3, 2015

furunkel commented Sep 3, 2015

matz commented Sep 4, 2015

archseer commented Sep 4, 2015

furunkel commented Sep 4, 2015

archseer commented on `11cb417` Jul 13, 2015

archseer commented on `199a808` Jul 13, 2015

archseer commented on `199a808` Jul 13, 2015