Skip to content
Newer
Older
100644 60 lines (38 sloc) 2.8 KB
9c841ab Updated README.
Antonio Cangiano authored Sep 2, 2009
1 The Ruby Benchmark Suite is a suite for measuring the performance of Ruby implementations, including micro-benchmarks that focus on core Ruby functionalities, as well as macro-benchmarks that represent a variety of real, common workloads. The project is aimed at providing a useful suite for comparing the performance of the available Ruby implementations and, as a positive side effect, to give VM implementers an additional tool to measure and identity performance related issues.
be1955e Added Brian Ford's refactoring and new drivers. See the README and
Monty Williams authored Mar 11, 2009
2
9987dc6 Added mission statement.
Antonio Cangiano authored Apr 11, 2009
3 GETTING THE SUITE
4 =================
5 To obtain the suite, simply run:
be1955e Added Brian Ford's refactoring and new drivers. See the README and
Monty Williams authored Mar 11, 2009
6
9987dc6 Added mission statement.
Antonio Cangiano authored Apr 11, 2009
7 git clone git://github.com/acangiano/ruby-benchmark-suite.git
be1955e Added Brian Ford's refactoring and new drivers. See the README and
Monty Williams authored Mar 11, 2009
8
9987dc6 Added mission statement.
Antonio Cangiano authored Apr 11, 2009
9 RUNNING THE SUITE
10 =================
60eb1a6 @rdp clarify readme's
rdp authored Apr 15, 2011
11 Benchmarks are run using rake (a copy for convenience is located at benchmarks/rails/dependencies/rake-0.8.7.gem).
12
13 Type "rake -T bench" to see options.
be1955e Added Brian Ford's refactoring and new drivers. See the README and
Monty Williams authored Mar 11, 2009
14
15 Examples:
9c841ab Updated README.
Antonio Cangiano authored Sep 2, 2009
16
be1955e Added Brian Ford's refactoring and new drivers. See the README and
Monty Williams authored Mar 11, 2009
17 rake bench
33ac74b Modified docs to reflect 'rbs' directory being renamed to 'benchmarks'
Monty Williams authored Sep 7, 2009
18 rake bench:file FILE=benchmarks/micro-benchmarks/bm_app_tak.rb
19 rake bench:dir DIR=benchmarks/micro-benchmarks
be1955e Added Brian Ford's refactoring and new drivers. See the README and
Monty Williams authored Mar 11, 2009
20 rake bench:to_csv
9c841ab Updated README.
Antonio Cangiano authored Sep 2, 2009
21
22 The results are generated within the results/ folder (automatically created for you). Running rake bench:to_csv creates a CSV spreadsheet out of them. This is quite handy for comparing your results over time.
23
731720b @rdp add in memory readings for windows--uses ruby-wmi gem
rdp authored Oct 10, 2009
24 The following example runs demonstrates all possible options -- '/bin/ruby_special' as the VM, 3 iterations instead of the default (i.e., 5), 5 second timeout (per script) instead of the default 300s, and outputs all messages instead of swallowing them (the default). METER_MEMORY defaults to yes, change it to anything else to disable it (it requires slightly extra processing).
9c841ab Updated README.
Antonio Cangiano authored Sep 2, 2009
25
731720b @rdp add in memory readings for windows--uses ruby-wmi gem
rdp authored Oct 11, 2009
26 rake VM=/bin/ruby_special ITERATIONS=3 TIMEOUT=5 VERBOSE=1 METER_MEMORY=yes
22c5326 @rdp add pattern matcher for running tests
rdp authored May 28, 2009
27
3b11ba8 @plashchynski add a note about stack limit and correct a name of rals benchmarks re…
plashchynski authored Oct 2, 2011
28 if you get "SystemStackError stack level too deep" error as results of some benchmarks, try to increase a stack size:
29
30 ulimit -s 16384
31
9987dc6 Added mission statement.
Antonio Cangiano authored Apr 11, 2009
32 DIRECTORY STRUCTURE
33 ===================
9c841ab Updated README.
Antonio Cangiano authored Sep 2, 2009
34 deprecated - contains the old, deprecated version of the suite and recently deprecated tests
35 benchmarks - contains the benchmarks themselves
9987dc6 Added mission statement.
Antonio Cangiano authored Apr 11, 2009
36 utils - contains the infrastructure necessary to run the benchmarks
37
9c841ab Updated README.
Antonio Cangiano authored Sep 2, 2009
38 See utils/README for more details.
844e76c Removed MagLev references in README
Monty Williams authored Mar 11, 2009
39
9c841ab Updated README.
Antonio Cangiano authored Sep 2, 2009
40 Additional output formatters are welcome. For example, a :to_wiki would be very convenient to place the results directly in Confluence or similar Wiki software.
9987dc6 Added mission statement.
Antonio Cangiano authored Apr 11, 2009
41
42 NOTES
43 =====
44 If you want to run a different implementation set the environment variable VM to point to a ruby executable or change this line in rakelib/bench.rake:
9c841ab Updated README.
Antonio Cangiano authored Sep 2, 2009
45
9987dc6 Added mission statement.
Antonio Cangiano authored Apr 11, 2009
46 VM = ENV['VM'] || "ruby"
47
1510a19 @rdp another vm note
rdp authored Apr 14, 2011
48 or pass in environment variable on the command line
49
50 rake VM=/path/to/ruby bench
51
51ffd30 @rdp note rails readme
rdp authored Apr 14, 2011
52 RAILS TESTS
53 ===========
54
3b11ba8 @plashchynski add a note about stack limit and correct a name of rals benchmarks re…
plashchynski authored Oct 2, 2011
55 There are a few rails 2.3.x tests located in the benchmarks/rails folder. You may need to install a binary dependency to run them, see benchmarks/rails/README_HOW_TO_RUN_THE_RAILS_TESTS file for instructions for your VM.
51ffd30 @rdp note rails readme
rdp authored Apr 14, 2011
56
9c841ab Updated README.
Antonio Cangiano authored Sep 2, 2009
57 HELP
138a535 clarify README, add link to google group
unknown authored Jun 1, 2009
58 =====
59 There is a mailing list at http://groups.google.com/group/ruby-benchmark-suite
Something went wrong with that request. Please try again.