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, 221 insertions, 229 deletions

diff --git a/ext/mcpat/cacti/parameter.h b/ext/mcpat/cacti/parameter.h
index 9c827bbc8..573b726a6 100644
--- a/ext/mcpat/cacti/parameter.h
+++ b/ext/mcpat/cacti/parameter.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.
  *
  ***************************************************************************/
 
@@ -40,251 +41,242 @@
 #include "io.h"
 
 // parameters which are functions of certain device technology
-class TechnologyParameter
-{
- public:
-  class DeviceType
-  {
-   public:
-    double C_g_ideal;
-    double C_fringe;
-    double C_overlap;
-    double C_junc;  // C_junc_area
-    double C_junc_sidewall;
-    double l_phy;
-    double l_elec;
-    double R_nch_on;
-    double R_pch_on;
-    double Vdd;
-    double Vth;
-    double I_on_n;
-    double I_on_p;
-    double I_off_n;
-    double I_off_p;
-    double I_g_on_n;
-    double I_g_on_p;
-    double C_ox;
-    double t_ox;
-    double n_to_p_eff_curr_drv_ratio;
-    double long_channel_leakage_reduction;
-
-    DeviceType(): C_g_ideal(0), C_fringe(0), C_overlap(0), C_junc(0),
-                  C_junc_sidewall(0), l_phy(0), l_elec(0), R_nch_on(0), R_pch_on(0),
-                  Vdd(0), Vth(0),
-                  I_on_n(0), I_on_p(0), I_off_n(0), I_off_p(0),I_g_on_n(0),I_g_on_p(0),
-                  C_ox(0), t_ox(0), n_to_p_eff_curr_drv_ratio(0), long_channel_leakage_reduction(0) { };
-    void reset()
-    {
-      C_g_ideal = 0;
-      C_fringe  = 0;
-      C_overlap = 0;
-      C_junc    = 0;
-      l_phy     = 0;
-      l_elec    = 0;
-      R_nch_on  = 0;
-      R_pch_on  = 0;
-      Vdd       = 0;
-      Vth       = 0;
-      I_on_n    = 0;
-      I_on_p    = 0;
-      I_off_n   = 0;
-      I_off_p   = 0;
-      I_g_on_n   = 0;
-      I_g_on_p   = 0;
-      C_ox      = 0;
-      t_ox      = 0;
-      n_to_p_eff_curr_drv_ratio = 0;
-      long_channel_leakage_reduction = 0;
-    }
+class TechnologyParameter {
+public:
+    class DeviceType {
+    public:
+        double C_g_ideal;
+        double C_fringe;
+        double C_overlap;
+        double C_junc;  // C_junc_area
+        double C_junc_sidewall;
+        double l_phy;
+        double l_elec;
+        double R_nch_on;
+        double R_pch_on;
+        double Vdd;
+        double Vth;
+        double I_on_n;
+        double I_on_p;
+        double I_off_n;
+        double I_off_p;
+        double I_g_on_n;
+        double I_g_on_p;
+        double C_ox;
+        double t_ox;
+        double n_to_p_eff_curr_drv_ratio;
+        double long_channel_leakage_reduction;
+
+        DeviceType(): C_g_ideal(0), C_fringe(0), C_overlap(0), C_junc(0),
+                C_junc_sidewall(0), l_phy(0), l_elec(0), R_nch_on(0), R_pch_on(0),
+                Vdd(0), Vth(0),
+                I_on_n(0), I_on_p(0), I_off_n(0), I_off_p(0), I_g_on_n(0),
+                      I_g_on_p(0),
+                C_ox(0), t_ox(0), n_to_p_eff_curr_drv_ratio(0),
+                      long_channel_leakage_reduction(0) { };
+        void reset() {
+            C_g_ideal = 0;
+            C_fringe  = 0;
+            C_overlap = 0;
+            C_junc    = 0;
+            l_phy     = 0;
+            l_elec    = 0;
+            R_nch_on  = 0;
+            R_pch_on  = 0;
+            Vdd       = 0;
+            Vth       = 0;
+            I_on_n    = 0;
+            I_on_p    = 0;
+            I_off_n   = 0;
+            I_off_p   = 0;
+            I_g_on_n   = 0;
+            I_g_on_p   = 0;
+            C_ox      = 0;
+            t_ox      = 0;
+            n_to_p_eff_curr_drv_ratio = 0;
+            long_channel_leakage_reduction = 0;
+        }
+
+        void display(uint32_t indent = 0);
+    };
+    class InterconnectType {
+    public:
+        double pitch;
+        double R_per_um;
+        double C_per_um;
+        double horiz_dielectric_constant;
+        double vert_dielectric_constant;
+        double aspect_ratio;
+        double miller_value;
+        double ild_thickness;
+
+        InterconnectType(): pitch(0), R_per_um(0), C_per_um(0) { };
+
+        void reset() {
+            pitch = 0;
+            R_per_um = 0;
+            C_per_um = 0;
+            horiz_dielectric_constant = 0;
+            vert_dielectric_constant = 0;
+            aspect_ratio = 0;
+            miller_value = 0;
+            ild_thickness = 0;
+        }
+
+        void display(uint32_t indent = 0);
+    };
+    class MemoryType {
+    public:
+        double b_w;
+        double b_h;
+        double cell_a_w;
+        double cell_pmos_w;
+        double cell_nmos_w;
+        double Vbitpre;
+
+        void reset() {
+            b_w = 0;
+            b_h = 0;
+            cell_a_w = 0;
+            cell_pmos_w = 0;
+            cell_nmos_w = 0;
+            Vbitpre = 0;
+        }
+
+        void display(uint32_t indent = 0);
+    };
+
+    class ScalingFactor {
+    public:
+        double logic_scaling_co_eff;
+        double core_tx_density;
+        double long_channel_leakage_reduction;
+
+        ScalingFactor(): logic_scaling_co_eff(0), core_tx_density(0),
+                long_channel_leakage_reduction(0) { };
+
+        void reset() {
+            logic_scaling_co_eff = 0;
+            core_tx_density = 0;
+            long_channel_leakage_reduction = 0;
+        }
+
+        void display(uint32_t indent = 0);
+    };
+
+    double ram_wl_stitching_overhead_;
+    double min_w_nmos_;
+    double max_w_nmos_;
+    double max_w_nmos_dec;
+    double unit_len_wire_del;
+    double FO4;
+    double kinv;
+    double vpp;
+    double w_sense_en;
+    double w_sense_n;
+    double w_sense_p;
+    double sense_delay;
+    double sense_dy_power;
+    double w_iso;
+    double w_poly_contact;
+    double spacing_poly_to_poly;
+    double spacing_poly_to_contact;
+
+    double w_comp_inv_p1;
+    double w_comp_inv_p2;
+    double w_comp_inv_p3;
+    double w_comp_inv_n1;
+    double w_comp_inv_n2;
+    double w_comp_inv_n3;
+    double w_eval_inv_p;
+    double w_eval_inv_n;
+    double w_comp_n;
+    double w_comp_p;
+
+    double dram_cell_I_on;
+    double dram_cell_Vdd;
+    double dram_cell_I_off_worst_case_len_temp;
+    double dram_cell_C;
+    double gm_sense_amp_latch;
+
+    double w_nmos_b_mux;
+    double w_nmos_sa_mux;
+    double w_pmos_bl_precharge;
+    double w_pmos_bl_eq;
+    double MIN_GAP_BET_P_AND_N_DIFFS;
+    double MIN_GAP_BET_SAME_TYPE_DIFFS;
+    double HPOWERRAIL;
+    double cell_h_def;
+
+    double chip_layout_overhead;
+    double macro_layout_overhead;
+    double sckt_co_eff;
+
+    double fringe_cap;
+
+    uint64_t h_dec;
+
+    DeviceType sram_cell;   // SRAM cell transistor
+    DeviceType dram_acc;    // DRAM access transistor
+    DeviceType dram_wl;     // DRAM wordline transistor
+    DeviceType peri_global; // peripheral global
+    DeviceType cam_cell;   // SRAM cell transistor
+
+    InterconnectType wire_local;
+    InterconnectType wire_inside_mat;
+    InterconnectType wire_outside_mat;
+
+    ScalingFactor scaling_factor;
+
+    MemoryType sram;
+    MemoryType dram;
+    MemoryType cam;
 
     void display(uint32_t indent = 0);
-  };
-  class InterconnectType
-  {
-   public:
-    double pitch;
-    double R_per_um;
-    double C_per_um;
-    double horiz_dielectric_constant;
-    double vert_dielectric_constant;
-    double aspect_ratio;
-    double miller_value;
-    double ild_thickness;
-
-    InterconnectType(): pitch(0), R_per_um(0), C_per_um(0) { };
-
-    void reset()
-    {
-      pitch = 0;
-      R_per_um = 0;
-      C_per_um = 0;
-      horiz_dielectric_constant = 0;
-      vert_dielectric_constant = 0;
-      aspect_ratio = 0;
-      miller_value = 0;
-      ild_thickness = 0;
-    }
 
-    void display(uint32_t indent = 0);
-  };
-  class MemoryType
-  {
-   public:
-    double b_w;
-    double b_h;
-    double cell_a_w;
-    double cell_pmos_w;
-    double cell_nmos_w;
-    double Vbitpre;
-
-    void reset()
-    {
-      b_w = 0;
-      b_h = 0;
-      cell_a_w = 0;
-      cell_pmos_w = 0;
-      cell_nmos_w = 0;
-      Vbitpre = 0;
-    }
+    void reset() {
+        dram_cell_Vdd  = 0;
+        dram_cell_I_on = 0;
+        dram_cell_C    = 0;
+        vpp            = 0;
 
-    void display(uint32_t indent = 0);
-  };
-
-  class ScalingFactor
-  {
-   public:
-    double logic_scaling_co_eff;
-    double core_tx_density;
-    double long_channel_leakage_reduction;
-
-    ScalingFactor(): logic_scaling_co_eff(0), core_tx_density(0),
-    long_channel_leakage_reduction(0) { };
-
-    void reset()
-    {
-      logic_scaling_co_eff= 0;
-      core_tx_density = 0;
-      long_channel_leakage_reduction= 0;
-    }
-
-    void display(uint32_t indent = 0);
-  };
-
-  double ram_wl_stitching_overhead_;
-  double min_w_nmos_;
-  double max_w_nmos_;
-  double max_w_nmos_dec;
-  double unit_len_wire_del;
-  double FO4;
-  double kinv;
-  double vpp;
-  double w_sense_en;
-  double w_sense_n;
-  double w_sense_p;
-  double sense_delay;
-  double sense_dy_power;
-  double w_iso;
-  double w_poly_contact;
-  double spacing_poly_to_poly;
-  double spacing_poly_to_contact;
-
-  double w_comp_inv_p1;
-  double w_comp_inv_p2;
-  double w_comp_inv_p3;
-  double w_comp_inv_n1;
-  double w_comp_inv_n2;
-  double w_comp_inv_n3;
-  double w_eval_inv_p;
-  double w_eval_inv_n;
-  double w_comp_n;
-  double w_comp_p;
-
-  double dram_cell_I_on;
-  double dram_cell_Vdd;
-  double dram_cell_I_off_worst_case_len_temp;
-  double dram_cell_C;
-  double gm_sense_amp_latch;
-
-  double w_nmos_b_mux;
-  double w_nmos_sa_mux;
-  double w_pmos_bl_precharge;
-  double w_pmos_bl_eq;
-  double MIN_GAP_BET_P_AND_N_DIFFS;
-  double MIN_GAP_BET_SAME_TYPE_DIFFS;
-  double HPOWERRAIL;
-  double cell_h_def;
-
-  double chip_layout_overhead;
-  double macro_layout_overhead;
-  double sckt_co_eff;
-
-  double fringe_cap;
-
-  uint64_t h_dec;
-
-  DeviceType sram_cell;   // SRAM cell transistor
-  DeviceType dram_acc;    // DRAM access transistor
-  DeviceType dram_wl;     // DRAM wordline transistor
-  DeviceType peri_global; // peripheral global
-  DeviceType cam_cell;   // SRAM cell transistor
-
-  InterconnectType wire_local;
-  InterconnectType wire_inside_mat;
-  InterconnectType wire_outside_mat;
-
-  ScalingFactor scaling_factor;
-
-  MemoryType sram;
-  MemoryType dram;
-  MemoryType cam;
-
-  void display(uint32_t indent = 0);
-
-  void reset()
-  {
-    dram_cell_Vdd  = 0;
-    dram_cell_I_on = 0;
-    dram_cell_C    = 0;
-    vpp            = 0;
-
-    sense_delay               = 0;
-    sense_dy_power            = 0;
-    fringe_cap                = 0;
+        sense_delay               = 0;
+        sense_dy_power            = 0;
+        fringe_cap                = 0;
 //    horiz_dielectric_constant = 0;
 //    vert_dielectric_constant  = 0;
 //    aspect_ratio              = 0;
 //    miller_value              = 0;
 //    ild_thickness             = 0;
 
-    dram_cell_I_off_worst_case_len_temp = 0;
+        dram_cell_I_off_worst_case_len_temp = 0;
 
-    sram_cell.reset();
-    dram_acc.reset();
-    dram_wl.reset();
-    peri_global.reset();
-    cam_cell.reset();
+        sram_cell.reset();
+        dram_acc.reset();
+        dram_wl.reset();
+        peri_global.reset();
+        cam_cell.reset();
 
-    scaling_factor.reset();
+        scaling_factor.reset();
 
-    wire_local.reset();
-    wire_inside_mat.reset();
-    wire_outside_mat.reset();
+        wire_local.reset();
+        wire_inside_mat.reset();
+        wire_outside_mat.reset();
 
-    sram.reset();
-    dram.reset();
-    cam.reset();
+        sram.reset();
+        dram.reset();
+        cam.reset();
 
-    chip_layout_overhead  = 0;
-    macro_layout_overhead = 0;
-    sckt_co_eff           = 0;
-  }
+        chip_layout_overhead  = 0;
+        macro_layout_overhead = 0;
+        sckt_co_eff           = 0;
+    }
 };
 
 
 
-class DynamicParameter
-{
-  public:
+class DynamicParameter {
+public:
     bool is_tag;
     bool pure_ram;
     bool pure_cam;
@@ -313,8 +305,8 @@ class DynamicParameter
     int num_so_b_mat;
     int num_si_b_subbank;
     int num_so_b_subbank;
-        int num_si_b_bank_per_port;
-        int num_so_b_bank_per_port;
+    int num_si_b_bank_per_port;
+    int num_so_b_bank_per_port;
 
     int number_way_select_signals_mat;
     int num_act_mats_hor_dir;