From db7eac5a237dd4db7cb71d8ff032909bb17adb73 Mon Sep 17 00:00:00 2001
From: wyin <wqyin@utexas.edu>
Date: Wed, 9 Mar 2022 12:28:52 -0600
Subject: [PATCH] add an option to exit sim when the first workload finishes
 (#131)

---
 src/general.param.def |  2 ++
 src/param_parser.c    | 23 +++++++++++++++++++++--
 src/param_parser.h    |  1 +
 src/sim.c             |  9 ++++++++-
 src/sim.h             |  2 ++
 5 files changed, 34 insertions(+), 3 deletions(-)

diff --git a/src/general.param.def b/src/general.param.def
index f385de36..7c03608a 100644
--- a/src/general.param.def
+++ b/src/general.param.def
@@ -96,3 +96,5 @@ DEF_PARAM( use_unsure_free_lists        , USE_UNSURE_FREE_LISTS     , Flag   , F
 
 DEF_PARAM( optimizer2_max_num_slaves    , OPTIMIZER2_MAX_NUM_SLAVES , uns    , uns       , 64       ,       )
 DEF_PARAM( optimizer2_perfect_memoryless, OPTIMIZER2_PERFECT_MEMORYLESS, Flag, Flag      , FALSE    ,       )
+
+DEF_PARAM( exit_cond                    , EXIT_COND                 , int    , exit_cond , 0        ,       )
\ No newline at end of file
diff --git a/src/param_parser.c b/src/param_parser.c
index b410f01c..66de90b9 100644
--- a/src/param_parser.c
+++ b/src/param_parser.c
@@ -76,9 +76,10 @@ the program.  This way, an exact duplicate run can be performed.
 /**************************************************************************************/
 /* Global Variables */
 
-const char* help_options[]   = {"-help", "-h", "--help",
+const char* help_options[]    = {"-help", "-h", "--help",
                               "--h"}; /* cmd-line help options strings */
-const char* sim_mode_names[] = {"uop", "full"};
+const char* sim_mode_names[]  = {"uop", "full"};
+const char* exit_cond_names[] = {"last_done", "first_done"};
 
 /**************************************************************************************/
 /* include all header files with enum declarations used as parameters */
@@ -278,6 +279,24 @@ void get_sim_mode_param(const char* name, Generic_Enum* variable) {
     FATAL_ERROR(0, "Parameter '%s' missing value --- Ignored.\n", name);
 }
 
+/**************************************************************************************/
+/* get_exit_cond: match input string to internal enum
+ */
+
+void get_exit_cond_param(const char* name, Generic_Enum* variable) {
+  if(optarg) {
+    uns ii;
+
+    for(ii = 0; ii < NUM_EXIT_CONDS; ii++)
+      if(strncmp(optarg, exit_cond_names[ii], MAX_STR_LENGTH) == 0) {
+        *variable = ii;
+        return;
+      }
+    FATAL_ERROR(0, "Invalid value ('%s') for parameter '%s' --- Ignored.\n",
+                optarg, name);
+  } else
+    FATAL_ERROR(0, "Parameter '%s' missing value --- Ignored.\n", name);
+}
 
 /**************************************************************************************/
 /* get_sim_model: Converts the optarg string to a number by looking it up in the
diff --git a/src/param_parser.h b/src/param_parser.h
index 53e47168..1dea2f0b 100644
--- a/src/param_parser.h
+++ b/src/param_parser.h
@@ -45,6 +45,7 @@ void   get_btb_mech_param(const char*, uns*);
 void   get_ibtb_mech_param(const char*, uns*);
 void   get_conf_mech_param(const char*, uns*);
 void   get_sim_mode_param(const char*, Generic_Enum*);
+void   get_exit_cond_param(const char*, Generic_Enum*);
 void   get_sim_model_param(const char*, uns*);
 void   get_frontend_param(const char*, uns*);
 // void get_dram_sched_param(const char *, uns *); // Ramulator_remove
diff --git a/src/sim.c b/src/sim.c
index ec07862a..d107a732 100644
--- a/src/sim.c
+++ b/src/sim.c
@@ -614,6 +614,7 @@ void uop_sim() {
 void full_sim() {
   uns8 proc_id;
   Flag all_sim_done = FALSE;
+  Flag any_sim_done = FALSE;
 
   /* perform initialization  */
   init_model(WARMUP_MODE);  // make sure this happens before init_op_pool
@@ -651,7 +652,11 @@ void full_sim() {
   clear_stats = trigger_create("CLEAR_STATS", CLEAR_STATS, TRIGGER_ONCE);
 
   /* main loop */
-  while(!trigger_fired(sim_limit) && !all_sim_done) {
+  while(!trigger_fired(sim_limit)) {
+    // sim control
+    if((EXIT_COND == LAST_DONE && all_sim_done) ||
+       (EXIT_COND == FIRST_DONE && any_sim_done))
+      break;
     freq_advance_time();
     sim_time = freq_time();
     model->cycle_func();
@@ -675,6 +680,7 @@ void full_sim() {
     }
 
     all_sim_done = TRUE;
+    any_sim_done = FALSE;
     for(proc_id = 0; proc_id < NUM_CORES; proc_id++) {
       Flag reachedInstLimit = (INST_LIMIT &&
                                inst_count[proc_id] >= inst_limit[proc_id]);
@@ -685,6 +691,7 @@ void full_sim() {
           model->per_core_done_func(proc_id);
         dump_stats(proc_id, TRUE, global_stat_array[proc_id], NUM_GLOBAL_STATS);
         sim_done[proc_id] = TRUE;
+        any_sim_done      = TRUE;
         check_heartbeat(proc_id, TRUE);
 
         if(retired_exit[proc_id] && FRONTEND == FE_TRACE) {
diff --git a/src/sim.h b/src/sim.h
index 64e408a5..5035fe35 100644
--- a/src/sim.h
+++ b/src/sim.h
@@ -39,6 +39,8 @@ enum operating_mode_enum {
   WARMUP_MODE /* not implemented yet */
 };
 
+enum exit_cond_enum { LAST_DONE, FIRST_DONE, NUM_EXIT_CONDS };
+
 /**************************************************************************************/
 /* External Variables */