New src/share/demo/java2d/J2DBench/README

   1 -----------------------------------------------------------------------
   2 Introduction
   3 -----------------------------------------------------------------------
   4 
   5 J2DBench is a  suite of benchmarks with a GUI front  end that lets you
   6 analyze the  performance of many Java2D graphical  operations. You can
   7 easily modify  the test  options, and save  them for later  runs using
   8 GUI, or  load them in batch  mode to allow quick  testing on different
   9 builds.   It  also  provides  logging  of  the  result,  to  make  the
  10 comparison of the collected data easier.
  11 
  12 J2DAnalyzer  is  J2DBench  a  results  analyzer/comparator  which  can
  13 compare the results generated by the J2DBench runs.
  14 
  15 XMLHTMLReporter is an additional tool  which can create an html report
  16 from the results files generated by the J2DBench runs.
  17 
  18 -----------------------------------------------------------------------
  19 Minimum requirements
  20 -----------------------------------------------------------------------
  21 
  22 The benchmark requires at least jdk1.5 to compile and run.
  23 
  24 -----------------------------------------------------------------------
  25 How To Compile
  26 -----------------------------------------------------------------------
  27 
  28 #> cd J2DBench
  29 
  30 The benchmark can be compiled by using either ant:
  31 
  32 #> ant
  33 
  34 or gnumake (assuming there's 'javac' in the path):
  35 
  36 #> gnumake
  37 
  38 The jar files will be generated into J2DBench/dist directory.
  39 
  40 Note that the workspace also contains Netbeans 4.0 project file:
  41   J2DBench/nbproject/project.xml
  42 allowing it to be easily imported into Netbeans.
  43 
  44 -----------------------------------------------------------------------
  45 How To Run J2DBench, J2DAnalyzer, XMLHTMLReporter
  46 -----------------------------------------------------------------------
  47 
  48 #> ant run
  49   or
  50 #> java -jar dist/J2DBench.jar
  51 
  52 To get help page for each of the tools, run:
  53 #> java -jar dist/J2DBench.jar -help
  54 #> java -jar dist/J2DAnalyzer.jar -help
  55 #> java -cp dist/J2DAnalyzer.jar j2dbench.report.XMLHTMLReporter -help
  56 
  57 -----------------------------------------------------------------------
  58 Using J2DBench GUI to Create Options File
  59 -----------------------------------------------------------------------
  60 
  61 There are global  options, options specific to a  group of benchmarks,
  62 and benchmark-specific options.
  63 
  64 Global  options affect all  groups of  benchmarks, group  options only
  65 affect benchmarks in particular group, and benchmark-specific ones are
  66 relevant to a single benchmark.
  67 
  68 Examples of important global options:
  69   Calibration: 
  70     if the "Fixed Number of reps" is set to 0, J2DBench will calibrate
  71     each individual benchmark, meaning that it will determine how many
  72     repetitions each benchmark can perform in "Target Test Time", and
  73     use this number of repetitions for each Test Run.
  74 
  75     If "Fixed Number of reps" is non-0, each benchmark will be run for
  76     specified number  of repetitions.  The use of  Calibration mode is
  77     preferable because  the time per  operation can vary  widely among
  78     the various tests.
  79 
  80   Output Destinations: 
  81     where the benchmarks will render to.
  82     All selected  benchmarks will be repeated for each selected
  83     destination.
  84 
  85 Example of benchmark group options:
  86 TextBenchmarks/TextOptions/Graphics
  87   Text AntiAlias: 
  88     whether to use text antialiasing for text benchmarks
  89 
  90 Example of a benchmark option:
  91 Graphics Benchmarks/Imaging Benchmarks:
  92   Image Rendering Sources (for Imaging Benchmarks only): 
  93     the source image types used for testing
  94 
  95 Example of a benchmark:
  96 Graphics Benchmarks/Imaging Benchmarks/Image Rendering Tests:
  97   drawImage(img, tx, obs): 
  98     test the Graphics2D's
  99       drawImage(Image image, AffineTransform tx, ImageObserver obs)
 100     operation. 
 101 
 102 General note: you can chose multiple options in some cases by holding
 103 Shift or Ctrl key.
 104 
 105 -----------------------------------------------------------------------
 106 Use Scenario
 107 -----------------------------------------------------------------------
 108 
 109 Suppose you want to compare rendering performance of the default
 110 and opengl pipelines.
 111 
 112 Start J2DBench (assuming the current dir is J2DBench's top dir)
 113 #> java -jar dist/J2DBench.jar
 114 
 115 You can  either create and save  the option file  by selecting desired
 116 tests and their attributes, or use one of the provided option files in
 117 options/ directory (for example, default.opt, which is used below).
 118 
 119 Note that it's very easy to  create an option file which would take an
 120 extremely  long time  to  execute the  tests,  so be  be careful  when
 121 choosing the options and benchmarks to run.
 122 
 123 After the options file is created, start J2DBench in batch mode to run
 124 the benchmarks for the default pipeline:
 125 #> java -jar dist/J2DBench.jar -batch -loadopts options/default.opt \
 126      -saveres default.res -title "Rendering - Default ppl" \
 127      -desc "Rendering tests with the default pipeline"
 128 
 129 This command  will run  the benchmarks defined  in options/default.opt
 130 file and save the result in default.res file.
 131 
 132 (You can also run selected tests directly from the GUI mode by hitting
 133 "Run Tests" in the J2DBench dialog)
 134 
 135 Now run the benchmark with opengl pipeline:
 136 #> java -Dsun.java2d.opengl=True -jar dist/J2DBench.jar -batch \
 137      -loadopts options/default.opt \
 138      -saveres opengl.res -title "Rendering - OpenGL" \
 139      -desc "Rendering tests with OpenGL pipeline"
 140 
 141 Now let's analyze the results using J2DAnalyzer:
 142 #> java -jar dist/J2DAnalyzer.jar default.res opengl.res
 143 
 144 Note that you can compare more than two sets of results, see
 145 J2DAnalyzer's help page.
 146 
 147 You can also generate html pages from the results files using
 148 j2dbench.report.XMLHTMLReporter class in J2DAnalyzer.jar.  Suppose
 149 generated pages are to be stored in html_results directory.
 150 
 151 First, make sure html_results/testcases directory exists:
 152 #> mkdir -p html_results/testcases
 153 
 154 Then generate the report:
 155 #> java -cp J2DAnalyzer.jar j2dbench.report.XMLHTMLReporter \
 156      -r html_results -b default.res -t opengl.res
 157 
 158 The html report will be generated in html_results/ directory.
 159 The index page:
 160   html_results/Summary_Report.html