README revision 10235
112966SMatteo.Andreozzi@arm.comregression.py
212966SMatteo.Andreozzi@arm.com
312966SMatteo.Andreozzi@arm.comCopyright (c) 2010-2014 Advanced Micro Devices, Inc.
412966SMatteo.Andreozzi@arm.comAll rights reserved.
512966SMatteo.Andreozzi@arm.com
612966SMatteo.Andreozzi@arm.comRedistribution and use in source and binary forms, with or without
712966SMatteo.Andreozzi@arm.commodification, are permitted provided that the following conditions are
812966SMatteo.Andreozzi@arm.commet: redistributions of source code must retain the above copyright
912966SMatteo.Andreozzi@arm.comnotice, this list of conditions and the following disclaimer;
1012966SMatteo.Andreozzi@arm.comredistributions in binary form must reproduce the above copyright
1112966SMatteo.Andreozzi@arm.comnotice, this list of conditions and the following disclaimer in the
1212966SMatteo.Andreozzi@arm.comdocumentation and/or other materials provided with the distribution;
1312966SMatteo.Andreozzi@arm.comneither the name of the copyright holders nor the names of its
1412966SMatteo.Andreozzi@arm.comcontributors may be used to endorse or promote products derived from
1512966SMatteo.Andreozzi@arm.comthis software without specific prior written permission.
1612966SMatteo.Andreozzi@arm.com
1712966SMatteo.Andreozzi@arm.comTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1812966SMatteo.Andreozzi@arm.com"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1912966SMatteo.Andreozzi@arm.comLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
2012966SMatteo.Andreozzi@arm.comA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
2112966SMatteo.Andreozzi@arm.comOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
2212966SMatteo.Andreozzi@arm.comSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
2312966SMatteo.Andreozzi@arm.comLIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2412966SMatteo.Andreozzi@arm.comDATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2512966SMatteo.Andreozzi@arm.comTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2612966SMatteo.Andreozzi@arm.com(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
2712966SMatteo.Andreozzi@arm.comOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2812966SMatteo.Andreozzi@arm.com
2912966SMatteo.Andreozzi@arm.comAuthors: Yasuko Eckert <yasuko.eckert@amd.com>
3012966SMatteo.Andreozzi@arm.com         Joel Hestness <hestness@cs.wisc.edu> (while interning at AMD)
3112966SMatteo.Andreozzi@arm.com
3212966SMatteo.Andreozzi@arm.com
3312966SMatteo.Andreozzi@arm.comIntroduction
3412966SMatteo.Andreozzi@arm.com============
3512966SMatteo.Andreozzi@arm.com
3612966SMatteo.Andreozzi@arm.comThis regression tester is for the McPAT power model.
3712966SMatteo.Andreozzi@arm.comThis tester can compile and runs McPAT on the input contained in the
3812966SMatteo.Andreozzi@arm.comspecified directory, and then compares the output to that of a golden run in
3912966SMatteo.Andreozzi@arm.comorder to ensure that specific power and area calculations do not change.
4012966SMatteo.Andreozzi@arm.com
4112967Smatteo.andreozzi@arm.comNine tests are included in the initial version of this tester in the directories:
4212966SMatteo.Andreozzi@arm.com    $GEM5/ext/mcpat/regression/test-*
4312966SMatteo.Andreozzi@arm.com
4412966SMatteo.Andreozzi@arm.comIn each directory, you will find a regression test input file
4512966SMatteo.Andreozzi@arm.com(power_region0.xml) and the golden-run output (region0.out.bak).
4612968Sgiacomo.travaglini@arm.comThe tester's output file is saved as region0.out, which is then checked against
4713023Sgiacomo.travaglini@arm.comregion0.out.bak.
4812968Sgiacomo.travaglini@arm.com
4912966SMatteo.Andreozzi@arm.com
5012966SMatteo.Andreozzi@arm.comOptions
5112967Smatteo.andreozzi@arm.com=======
52--help, -h      Show a help message and exit
53--build, -b     Build McPAT before running tests
54--cleanup, -c   Clean up the specified regression directory
55--force, -f     Force run regression even if directory isn't set up
56--maketest, -m  Set up the specified test directory
57--verbose, -v   Print verbose output
58
59
60How to Use
61==========
62
63The regression tester must be invoked from the McPAT directory.
64
65% cd $GEM5/ext/mcpat
66
67
68To run all regression tests:
69% ./regression/regression.py ./regression/
70
71
72To run a particular regression test, specify its directory to the tester:
73% ./regression/regression.py ./regression/test-0
74
75Specify the "-v" option to see a diff of the regression output.
76