ext: McPAT interface changes and fixes

This patch includes software engineering changes and some generic bug fixes
Joel Hestness and Yasuko Eckert made to McPAT 0.8. There are still known
issues/concernts we did not have a chance to address in this patch.

High-level changes in this patch include:
 1) Making XML parsing modular and hierarchical:
   - Shift parsing responsibility into the components
   - Read XML in a (mostly) context-free recursive manner so that McPAT input
     files can contain arbitrary component hierarchies
 2) Making power, energy, and area calculations a hierarchical and recursive
    process
   - Components track their subcomponents and recursively call compute
     functions in stages
   - Make C++ object hierarchy reflect inheritance of classes of components
     with similar structures
   - Simplify computeArea() and computeEnergy() functions to eliminate
     successive calls to calculate separate TDP vs. runtime energy
   - Remove Processor component (now unnecessary) and introduce a more abstract
     System component
 3) Standardizing McPAT output across all components
   - Use a single, common data structure for storing and printing McPAT output
   - Recursively call print functions through component hierarchy
 4) For caches, allow splitting data array and tag array reads and writes for
    better accuracy
 5) Improving the usability of CACTI by printing more helpful warning and error
    messages
 6) Minor: Impose more rigorous code style for clarity (more work still to be
    done)
Overall, these changes greatly reduce the amount of replicated code, and they
improve McPAT runtime and decrease memory footprint.

1 files changed, 18 insertions, 26 deletions

diff --git a/ext/mcpat/cacti/component.h b/ext/mcpat/cacti/component.h
index 75e2cb075..416e4e8e5 100644
--- a/ext/mcpat/cacti/component.h
+++ b/ext/mcpat/cacti/component.h
@@ -2,6 +2,7 @@
  *                                McPAT/CACTI
  *                      SOFTWARE LICENSE AGREEMENT
  *            Copyright 2012 Hewlett-Packard Development Company, L.P.
+ *            Copyright (c) 2010-2013 Advanced Micro Devices, Inc.
  *                          All Rights Reserved
  *
  * Redistribution and use in source and binary forms, with or without
@@ -25,7 +26,7 @@
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.”
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  ***************************************************************************/
 
@@ -42,41 +43,32 @@ using namespace std;
 class Crossbar;
 class Bank;
 
-class Component
-{
-  public:
+class Component {
+public:
     Component();
     ~Component();
 
     Area area;
-    powerDef power,rt_power;
+    // TODO: THERE IS LITTLE AGREEMENT THROUGHOUT THIS CODE ABOUT HOW THESE
+    // VARIABLES SHOULD BE USED. PART OF THE PROBLEM IS NAMING. SO THAT THIS
+    // MAKES MORE SENSE, ENERGY CALCULATIONS SHOULD BE SPLIT FROM POWER
+    // CALCULATIONS. THIS IS THE WORST DESIGN PROBLEM THAT STILL EXISTS
+    powerDef power, rt_power;
     double delay;
     double cycle_time;
 
-    double compute_gate_area(
-        int gate_type,
-        int num_inputs,
-        double w_pmos,
-        double w_nmos,
-        double h_gate);
-
-    double compute_tr_width_after_folding(double input_width, double threshold_folding_width);
+    double compute_gate_area(int gate_type, int num_inputs, double w_pmos,
+            double w_nmos, double h_gate);
+    double compute_tr_width_after_folding(double input_width,
+            double threshold_folding_width);
     double height_sense_amplifier(double pitch_sense_amp);
 
-  protected:
-    int logical_effort(
-        int    num_gates_min,
-        double g,
-        double F,
-        double * w_n,
-        double * w_p,
-        double C_load,
-        double p_to_n_sz_ratio,
-        bool   is_dram_,
-        bool   is_wl_tr_,
-        double max_w_nmos);
+protected:
+    int logical_effort(int num_gates_min, double g, double F, double * w_n,
+            double * w_p, double C_load, double p_to_n_sz_ratio,
+            bool is_dram_, bool is_wl_tr_, double max_w_nmos);
 
-  private:
+private:
     double compute_diffusion_width(int num_stacked_in, int num_folded_tr);
 };