Home | History | Annotate | Download | only in libmicro
      1 #
      2 # CDDL HEADER START
      3 #
      4 # The contents of this file are subject to the terms
      5 # of the Common Development and Distribution License
      6 # (the "License").  You may not use this file except
      7 # in compliance with the License.
      8 #
      9 # You can obtain a copy of the license at
     10 # src/OPENSOLARIS.LICENSE
     11 # or http://www.opensolaris.org/os/licensing.
     12 # See the License for the specific language governing
     13 # permissions and limitations under the License.
     14 #
     15 # When distributing Covered Code, include this CDDL
     16 # HEADER in each file and include the License file at
     17 # usr/src/OPENSOLARIS.LICENSE.  If applicable,
     18 # add the following below this CDDL HEADER, with the
     19 # fields enclosed by brackets "[]" replaced with your
     20 # own identifying information: Portions Copyright [yyyy]
     21 # [name of copyright owner]
     22 #
     23 # CDDL HEADER END
     24 #
     25 
     26 #
     27 # Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
     28 # Use is subject to license terms.
     29 #
     30 
     31 Building the tarball
     32 --------------------
     33 As long as cc is in your path, (gcc on Linux),
     34 
     35 % tar xf libMicro.tar
     36 % make
     37 
     38 will build the benchmark suite.
     39 
     40 Running the benchmarks
     41 -----------------------
     42 
     43 A set of generic scripts to invoke each micro benchmark
     44 are created in the bin directory; these may be invoked
     45 directly.  Note that the actual binaries are created in
     46 OS-specific directories; this allows one to build for
     47 all varients (x86/sparc/Solaris/Linux) in one place.
     48 
     49 To collect a complete set of benchmarks, use the bench
     50 script and redirect its output to a file.
     51 
     52 % ./bench > output
     53 
     54 To compare the output of two or more runs, use multiview in the src
     55 directory:
     56 
     57 % ./multiview reference compare1 compare2 compare2 > compare.html
     58 %
     59 
     60 where the reference and compare files contain the output of different
     61 libmicro runs.
     62 
     63 The compare.html file will allow quick comparisons to be drawn,
     64 allowing a variety of experiments to be quickly analyzed.
     65 
     66 All benchmarks support the following options:
     67 
     68        [-1] (single process; overrides -P > 1)
     69        [-A] (align with clock)
     70        [-B batch-size (default 10)]
     71        [-C minimum number of samples (default 0)]
     72        [-D duration in msecs (default 10s)]
     73        [-E (echo name to stderr)]
     74        [-H] (suppress headers)
     75        [-I] specify approx. time per op in nsecs
     76        [-L] (print argument line)
     77        [-M] (reports mean rather than median)
     78        [-N test-name ]
     79        [-P processes (default 1)]
     80        [-S] (print detailed stats)
     81        [-T threads (default 1)]
     82        [-V] (print the libMicro version and exit)
     83        [-W] (flag possible benchmark problems)
     84 
     85 
     86