[Assorted-commits] SF.net SVN: assorted: [420] numa-bench/trunk/README

[<yan...@us...>]

Revision: 420
          http://assorted.svn.sourceforge.net/assorted/?rev=420&view=rev
Author:   yangzhang
Date:     2008-02-14 17:44:56 -0800 (Thu, 14 Feb 2008)

Log Message:
-----------
filled out readme

Modified Paths:
--------------
    numa-bench/trunk/README

Modified: numa-bench/trunk/README
===================================================================
--- numa-bench/trunk/README	2008-02-15 01:44:42 UTC (rev 419)
+++ numa-bench/trunk/README	2008-02-15 01:44:56 UTC (rev 420)
@@ -1,6 +1,54 @@
+% NUMA Benchmarks
+% Yang Zhang
+
+Overview
+--------
+
 This is an assortment of microbenchmarks for understanding the performance
-behavior of NUMA systems and for exploring the Linux NUMA API.
+behavior of NUMA systems and for exploring the [Linux NUMA API]. Currently, the
+only full-featured test is the memory performance test (called `malloc`). This
+program performs a variety of operations on a large piece of memory to explore
+the performance behavior of memory intensive programs.
 
-Revelant materials include the [libnuma whitepaper].
+Results
+-------
 
-[libnuma whitepaper]: http://www.novell.com/collateral/4621437/4621437.pdf
+Here are some [results].
+
+Requirements
+------------
+
+- [C++ Commons]
+- [boost] 1.34
+- [g++] 4.2
+- [libstdc++] 4.2
+
+Building
+--------
+
+C++ Commons is a utility library I maintain; you'll need to make it visible to
+numa-bench:
+
+  $ svn --quiet co https://assorted.svn.sourceforge.net/svnroot/assorted/cpp-commons/trunk cpp-commons
+  $ svn --quiet co https://assorted.svn.sourceforge.net/svnroot/assorted/numa-bench/trunk numa-bench
+  $ ln -s "$PWD/cpp-commons/src/commons" numa-bench/src/
+  $ cd numa-bench/src/
+  $ make
+  $ ./malloc.bash
+
+Supporting Tools
+----------------
+
+`PlotHist` processes stdout concatenated from multiple runs of the program.
+This will produce the averaged time measurement histograms across cores per
+experiment and across experiments varying the number of cores.  system.
+
+This tool depends on the [Scala Commons].
+
+[Linux NUMA API]: http://www.novell.com/collateral/4621437/4621437.pdf
+[C++ Commons]: http://assorted.sf.net/cpp-commons/
+[Scala Commons]: http://assorted.sf.net/scala-commons/
+[boost]: http://www.boost.org/
+[g++]: http://gcc.gnu.org/
+[libstdc++]: http://gcc.gnu.org/libstdc++/
+[results]: analysis.html


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.