forked from rubinius/rubinius
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ROADMAP
558 lines (501 loc) · 16.1 KB
/
ROADMAP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
The contents of this repository are somewhat confusing, as there is
old stuff that is still needed for bootstrapping, current stuff, as
well as future stuff that is lying dormant for steps still to be
taken.
Here is a quick overview over the most important files.
* SHOULD_BE_REMOVED:
./bin/old.rubinius
./bin/obsolete.rcompile
This is the script for starting the compiler used during
bootstrapping. It uses MRI (Matz' Ruby Interpreter).
It is used to build runtime/*.rba (see below).
Because of GC related bugs in sydparse (see below), it disables GC at
the start.
It uses things under CURRENT below, as well as the following old stuff:
./lib/bytecode/r18.rb
./lib/bytecode/constructor.rb
./externals/syd-parser
This is a Ruby parser based on MRI. Somewhat buggy. There is little
incentive to fix sydparse, as the current version of rubinius uses its
own parser in grammar.y (see below, also derived from MRI).
* CURRENT:
./code-cache
This keeps cached bits of compiled Ruby, e.g. from the test suites.
This cache is the reason why running the tests again is so much faster
than running them the first time.
Stale compiled files (.rbc) in this directory can make testing the
compiler very confusing.
./include
./include/rubinius.h
./shotgun/lib
These are the directories where the C part of Rubinius lives, which
compile into:
./shotgun/rubinius
There are a lot of .d files (tracking dependencies) in ./shotgun/lib
which you can ignore (unless you have a problem with the Makefile
dependency mechanism).
[[ add commentary on the files below:
./shotgun/lib/archive.c
./shotgun/lib/archive.h
./shotgun/lib/array.c
./shotgun/lib/array.h
./shotgun/lib/auto.c
./shotgun/lib/auto.h
./shotgun/lib/auto_ins.h
./shotgun/lib/baker.c
./shotgun/lib/baker.h
./shotgun/lib/bignum.c
./shotgun/lib/bignum.h
./shotgun/lib/bootstrap.c
./shotgun/lib/bootstrap.h
./shotgun/lib/bytearray.c
./shotgun/lib/bytearray.h
./shotgun/lib/class.c
./shotgun/lib/class.h
./shotgun/lib/cpu.c
./shotgun/lib/cpu.h
./shotgun/lib/cpu_instructions.c -- shell; includes instructions.gen
./shotgun/lib/cpu_marshal.c
./shotgun/lib/cpu_primitives.c -- shell: includes system_primitives.gen
./shotgun/lib/cuby_primitives.rb
./shotgun/lib/float.c
./shotgun/lib/float.h
./shotgun/lib/genheader.rb
./shotgun/lib/grammar.c
./shotgun/lib/grammar.h
./shotgun/lib/grammar.y
./shotgun/lib/grammer_internal.h
./shotgun/lib/grammer_lex.c.tab
./shotgun/lib/grammer_node.h
./shotgun/lib/grammer_runtime.c
./shotgun/lib/grammer_runtime.h
./shotgun/lib/hash.c
./shotgun/lib/hash.h
./shotgun/lib/heap.c
./shotgun/lib/heap.h
./shotgun/lib/instruction_names.gen
./shotgun/lib/instructions.gen -- generated from instructions.rb
./shotgun/lib/instructions.rb -- source for the core bytecodes interpreter
./shotgun/lib/io.c
./shotgun/lib/io.h
./shotgun/lib/librubinius.a
./shotgun/lib/log.c
./shotgun/lib/log.h
./shotgun/lib/machine.c
./shotgun/lib/machine.h
./shotgun/lib/Makefile
./shotgun/lib/marksweep.c
./shotgun/lib/marksweep.h
./shotgun/lib/metaclass.c
./shotgun/lib/metaclass.h
./shotgun/lib/methctx.c
./shotgun/lib/methctx.h
./shotgun/lib/methtbl.c
./shotgun/lib/methtbl.h
./shotgun/lib/missing
./shotgun/lib/missing/backtrace.c
./shotgun/lib/missing/backtrace.h
./shotgun/lib/module.c
./shotgun/lib/module.h
./shotgun/lib/object.c
./shotgun/lib/object.h
./shotgun/lib/object_memory.c
./shotgun/lib/object_memory.h
./shotgun/lib/primitives
./shotgun/lib/primitives/fixnum.rb
./shotgun/lib/primitives/ltm.rb
./shotgun/lib/primitives.rb
./shotgun/lib/regexp.c
./shotgun/lib/regexp.h
./shotgun/lib/rubinius.c
./shotgun/lib/shotgun.h
./shotgun/lib/state.c
./shotgun/lib/state.h
./shotgun/lib/string.c
./shotgun/lib/string.h
./shotgun/lib/symbol.c
./shotgun/lib/symbol.h
./shotgun/lib/system_primitives.gen -- generated from primitives.rb
./shotgun/lib/tuple.c
./shotgun/lib/tuple.h
./shotgun/lib/var_table.c
./shotgun/lib/var_table.h
./shotgun/main.c
./shotgun/Makefile
./shotgun/test
./shotgun/test/test_instructions.c
./shotgun/test/test_state.c
]]
./shotgun/external_libs
The C part of Rubinius uses a number of external libraries that are
included in the repository for convenience:
./shotgun/external_libs/libedit
...
./shotgun/external_libs/libtommath
Bignum math.
./shotgun/external_libs/libzip
ZIP file format.
./shotgun/external_libs/onig
Onigurama, the magic regexp parser/interpreter.
./kernel
This is the Ruby language additions to the basic VM.
They are compiled into runtime/bootstrap.rba and runtime/core.rba (the
.rbc files in this directory are build-time intermediates).
In ./kernel/bootstrap, there are the files that need to be loaded first
(in alphabetical order; see .load_order.txt);
(Note that there is no relation between the name "bootstrap" and the
act of bootstrapping the VM alluded to above.)
./kernel/core contains the rest of the Ruby language library
(i.e. everything in MRI that is available without a 'require'), which
is loaded almost in alphabetical order (__loader.rb is actually loaded last).
[[ Add commentary on the files below
./kernel/.load_order.txt -- generated file
./kernel/hints -- generated file
./kernel/bootstrap/00auto_fields.rb -- generated file
./kernel/bootstrap/00io.rb
./kernel/bootstrap/00object.rb
./kernel/bootstrap/01class.rb
./kernel/bootstrap/02module.rb
./kernel/bootstrap/03hash.rb
./kernel/bootstrap/04kernel.rb
./kernel/bootstrap/array.rb
./kernel/bootstrap/bignum.rb
./kernel/bootstrap/class.rb
./kernel/bootstrap/compiled_method.rb
./kernel/bootstrap/context.rb
./kernel/bootstrap/core.rb
./kernel/bootstrap/exception.rb
./kernel/bootstrap/fixnum.rb
./kernel/bootstrap/float.rb
./kernel/bootstrap/gc.rb
./kernel/bootstrap/global.rb
./kernel/bootstrap/method_missing.rb
./kernel/bootstrap/method_table.rb
./kernel/bootstrap/module.rb
./kernel/bootstrap/nil.rb
./kernel/bootstrap/regexp.rb
./kernel/bootstrap/ruby.rb
./kernel/bootstrap/string.rb
./kernel/bootstrap/symbol.rb
./kernel/bootstrap/tuple.rb
./kernel/core/00io.rb
./kernel/core/01enumerable.rb
./kernel/core/02range.rb
./kernel/core/03comparable.rb
./kernel/core/04numeric.rb
./kernel/core/archive.rb
./kernel/core/array.rb
./kernel/core/compile.rb
./kernel/core/compression.rb
./kernel/core/continuation.rb
./kernel/core/file.rb
./kernel/core/object.rb
./kernel/core/process.rb
./kernel/core/readline.rb
./kernel/core/string.rb
./kernel/core/throw_catch.rb
./kernel/core/time.rb
./kernel/core/__loader.rb -- The command line parser/toplevel.
]]
./lib
This is where the Ruby part of Rubinius itself (everything Ruby except
./kernel) lives. You can pretty much ignore everything that is not
linked from ./native (see below).
./lib/.gdb_history -- (Junk)
./lib/bytecode
./lib/bytecode/compiler.rb -- translates sexps into assembly language
./lib/bytecode/assembler.rb -- assembler
./lib/bytecode/encoder.rb -- generates the actual bytecodes
./lib/bytecode/primitive_names.rb -- give fixnum indexes to primitives, which are C code
that implements parts of the Ruby core/stdlib
Note: DO NOT reorganize these names as you will
break binary compatibility
This is the compiler that translates Ruby (as parsed by grammar.y)
into Rubinius bytecodes. The same code is interpreted in MRI by
obsolete.rcompile and in Rubinius by shotgun/rubinius.
./lib/sexp
./lib/sexp/composite_processor.rb
./lib/sexp/exceptions.rb
./lib/sexp/processor.rb
./lib/sexp/sexp.rb
./lib/sexp/simple_processor.rb
./lib/translation
./lib/translation/case_convert.rb
./lib/translation/extractors.rb
./lib/translation/generate_header.rb
./lib/translation/infrastructure.rb
./lib/translation/local_scoping.rb
./lib/translation/normalize.rb
./lib/translation/rbs_translate.rb
./lib/translation/states.rb
./lib/translation/to_c.rb
./lib/translation/type.rb
./lib/translation/typer.rb
./lib/translation/types
./lib/translation/types/c
./lib/translation/types/c/fixnum.rb
./lib/translation/types/c/memory.rb
./lib/translation/types/c/robject.rb
./native
The build directory for the Ruby parts of Rubinius outside kernel.
Mostly links into ./lib; this is also the place where the associated
.rbc files are staged.
./native/bytecode
./native/bytecode/assembler.rb
./native/bytecode/assembler.rbc
./native/bytecode/compiler.rb
./native/bytecode/compiler.rbc
./native/bytecode/encoder.rb
./native/bytecode/encoder.rbc
./native/bytecode/primitive_names.rb
./native/bytecode/primitive_names.rbc
./native/bytecode/rubinius.rb
./native/bytecode/rubinius.rbc
./native/sexp
./native/sexp/composite_processor.rb
./native/sexp/composite_processor.rbc
./native/sexp/exceptions.rb
./native/sexp/exceptions.rbc
./native/sexp/simple_processor.rb
./native/sexp/simple_processor.rbc
./native/test
./native/test/unit.rb
./native/translation
./native/translation/local_scoping.rb
./native/translation/local_scoping.rbc
./native/translation/normalize.rb
./native/translation/normalize.rbc
./native/translation/states.rb
./native/translation/states.rbc
./spec
./test
These directories contain the tests for making sure Rubinius actually
implements Ruby. ./test is the old syntax to write a test, ./spec is the
new syntax.
RSpec is the machinery behind executing these specs. The intention is to both
1) have specs for Ruby as a language and set of standard librarie, and 2) to
TDD/BDD the development of Rubinius. Some spec directories below are
implementation agnostic and some are specific to Rubinius.
To allow the specs to be executed by different implementation, a host/target
configuration is used. The 'host' is the Ruby implementation that is
executing RSpec. The 'target' is the Ruby implementation that is executing
the content of the particular specs.
[[ Add commentary on the files below:
./spec/compatibility -- incomplete; intended to test compatibility of different
implementations
./spec/compatibility/compatibility_spec.rb
./spec/compatibility/expressions
./spec/compatibility/expressions/array
./spec/compatibility/expressions/misc
./spec/compatibility/expressions/primitives
./spec/compatibility/target_context_extension.rb
./spec/core -- specs for any Classes in the Ruby core library
./spec/core/array_spec.rb
./spec/core/bignum_spec.rb
./spec/core/class_spec.rb
./spec/core/comparable_spec.rb
./spec/core/enumerable_spec.rb
./spec/core/false_spec.rb
./spec/core/file_spec.rb
./spec/core/fixnum_spec.rb
./spec/core/float_spec.rb
./spec/core/hash_spec.rb
./spec/core/integer_spec.rb
./spec/core/module_spec.rb
./spec/core/nil_spec.rb
./spec/core/object_spec.rb
./spec/core/proc_spec.rb
./spec/core/range_spec.rb
./spec/core/regexp_spec.rb
./spec/core/string_spec.rb
./spec/core/symbol_spec.rb
./spec/core/time_spec.rb
./spec/core/true_spec.rb
./spec/defined_fixtures.rb
./spec/jruby_target.rb -- implements the 'target' side for running specs with JRuby
./spec/language -- specs that are implementation agnostic and are intended
to describe the "language" aspects like grammar and
syntax, including things like literals (e.g. "string",
{} for Hash, [] for Array, etc.)
./spec/language/exception_spec.rb
./spec/language/expression_spec.rb
./spec/language/keywords
./spec/language/keywords/defined_spec.rb
./spec/language/literals
./spec/language/literals/array_spec.rb
./spec/language/literals/block_spec.rb
./spec/language/literals/execution_spec.rb
./spec/language/literals/hash_spec.rb
./spec/language/literals/numbers_spec.rb
./spec/language/literals/regexp_spec.rb
./spec/language/literals/string_spec.rb
./spec/language/operators_spec.rb
./spec/language/variables_spec.rb
./spec/library -- specs for any classes in Ruby stdlib library
./spec/library/enumerator_spec.rb
./spec/library/time_spec.rb
./spec/mri_target.rb -- implements the 'target' side for running specs with MRI
./spec/parser -- specs to drive development of a new Ruby parser
./spec/parser/symbol_spec.rb
./spec/rubinius_target.rb -- implements the 'target' side for running specs with Rubinius
./spec/shotgun -- specs to drive development of the Rubinius VM written in C
./spec/shotgun/bignum_spec.rb
./spec/shotgun/compression_spec.rb
./spec/shotgun/fixnum_spec.rb
./spec/shotgun/sexp_spec.rb
./spec/shotgun/string_spec.rb
./spec/shotgun/tuple_spec.rb
./spec/spec_helper.rb
./spec/targets -- specs to drive development of the various 'targets'
./spec/targets/jruby_target.rb
./spec/targets/mri_spec.rb
./spec/targets/rubinius_spec.rb
./test/bytecode -- tests to drive development of the compiler tool chain
./test/bytecode/test_assembler.rb
./test/bytecode/test_compiler.rb
./test/bytecode/test_constructor.rb
./test/bytecode/test_encoder.rb
./test/cpu
./test/cpu/test_compiled_method.rb
./test/cpu/test_cpu.rb
./test/cpu/test_instructions.rb
./test/cpu/test_method_context.rb
./test/cpu/test_primitives.rb
./test/cpu/test_simple_marshal.rb
./test/cpu/test_types.rb
./test/gc
./test/gc/test_baker_gc.rb
./test/gc/test_cheney_heap.rb
./test/gc/test_heap.rb
./test/gc/test_mark_sweepgc.rb
./test/gc/test_memory_block.rb
./test/gc/test_traingc.rb
./test/notest_hybridgc.rb
./test/nullptr.rb
./test/tc_all.rb
./test/test_cuby.rb
./test/test_cuby_loader.rb
./test/test_helper.rb
./test/test_machine.rb
./test/test_memory.rb
./test/test_object.rb
./test/test_simple_processor.rb
./test/translation
./test/translation/test_case_convert.rb
./test/translation/test_extractors.rb
./test/translation/test_generate_header.rb
./test/translation/test_local_scoping.rb
./test/translation/test_normalize.rb
./test/translation/test_rbs_translate.rb
./test/translation/test_to_c.rb
./test/translation/test_typer.rb
]]
./shotgun-tests
There is also another directory of somewhat half-stale tests (add text).
./shotgun-tests/helper.rb
./shotgun-tests/test_core.rb
./shotgun-tests/test_file.rb
./shotgun-tests/test_primitives.rb
./shotgun-tests/test_sexp.rb
./shotgun-tests/test_string.rb
FUTURE:
Ruby stuff that is not currently used, but served as input for writing
the C parts of Rubinius.
./lib/cpu
./lib/cpu/bootstrap.rb
./lib/cpu/instructions.rb
./lib/cpu/primitives.rb
./lib/cpu/runtime.rb
./lib/cpu/simple_marshal.rb
./lib/cuby.rb
./lib/cuby_loader.rb
./lib/gc
./lib/gc/baker_gc.rb
./lib/gc/cheney_heap.rb
./lib/gc/gc.rb
./lib/gc/heap.rb
./lib/gc/hybridgc.rb
./lib/gc/mark_sweepgc.rb
./lib/gc/memory_block.rb
./lib/gc/stepgc.rb
./lib/gc/traingc.rb
./lib/log.rb
./lib/machine.rb
./lib/memory.rb
./lib/memrender.rb
./lib/object.rb
./lib/object_memory.rb
./lib/platform.rb
./lib/types
./lib/types/array.rb
./lib/types/bignum.rb
./lib/types/bytearray.rb
./lib/types/class.rb
./lib/types/compiled_method.rb
./lib/types/hash.rb
./lib/types/io.rb
./lib/types/metaclass.rb
./lib/types/method_context.rb
./lib/types/method_table.rb
./lib/types/module.rb
./lib/types/object.rb
./lib/types/regexp.rb
./lib/types/string.rb
./lib/types/symbol.rb
./lib/types/tuple.rb
./lib/types.rb
YOU TELL ME:
.
./apps
./apps/irb
./apps/irb/sirb.rb
./AUTHORS
./bfts
./bfts/History.txt
./bfts/Manifest.txt
./bfts/overlay
./bfts/overlay/foounit.rb
./bfts/overlay/rubicon_testcase.rb
./bfts/overlay/tc_all.rb
./bfts/overlay/test_stuff.rb
./bfts/Rakefile
./bfts/README.rubinius
./bfts/README.txt
./bfts/rubicon_testcase.rb
./bfts/test_array.rb
./bfts/test_comparable.rb
./bfts/test_exception.rb
./bfts/test_false_class.rb
./bfts/test_file_test.rb
./bfts/test_hash.rb
./bfts/test_nil_class.rb
./bfts/test_range.rb
./bfts/test_string.rb
./bfts/test_struct.rb
./bfts/test_time.rb
./bfts/test_true_class.rb
./bin
./bin/autotestng.rb
./bin/compare.rb
./bin/rcc
./doc
./doc/cond_mod.txt
./doc/exceptions.txt
./doc/methods.txt
./doc/TODO
./externals
./externals/gems
./externals/gems/emp-1.0.0.gem
./rake
./rake/group_coverage_report.rb
./rake/group_spec_task.rb
./rake/specific_group_spec_task.rb
./Rakefile
./README
./ROADMAP
./runtime
./runtime/compiler.rba
./runtime/kernel.rba
./shotgun
./shotgun/.gdb_history
./THANKS