Implement addhist command

Author: jan-heck

sim/lex-riscv.c

@@ -71,6 +71,7 @@ TokenTab riscv_token_table [] =
 	{"DUMPHIST",	T_DUMPHIST},				/*+	Show the contents of a histogram register.:<histogram register>							*/
 	{"DUMPHISTPRETTY",	T_DUMPHISTPRETTY},				/*+	Show the contents of a histogram register, with ASCII-graph representation.:<histogram register>							*/
 	{"LDHISTRND",	T_LDHISTRND},				/*+	Fill a histogram register with random values.:<histogram register>							*/
+	{"ADDHIST",	T_ADDHIST},				/*+	Add two histograms. Write result to third histogram.:<histogram register addend 1> <histogram register addend 2> <histogram register result>							*/
 	{"DUMPSYSREGS",	T_DUMPSYSREGS},				/*+	Show the contents of the system registers.:none									*/
 	{"DUMPMEM",	T_DUMPMEM},				/*+	Show contents of memory.:<start mem address (hexadecimal)> <end mem address (hexadecimal)>			*/
 	{"DUMPPIPE",	T_DUMPPIPE},				/*+	Show the contents of the pipeline stages.:none									*/

sim/machine-riscv.c

@@ -202,6 +202,9 @@ riscvfatalaction(Engine *E, State *S)
 	return;
 }
 
+
+
+
 /*
  * Histograms
  */
@@ -222,18 +225,38 @@ riscvdumphist(Engine *E, State *S, int histogram_id){
 // Print histogram with extra stats and ASCII graphics
 void
 riscvdumphistpretty(Engine *E, State *S, int histogram_id){
+	mprint(E, S, nodeinfo, "Printing information for register %u\n", histogram_id);
 	Histogram_PrettyPrint(E, S, &S->riscv->histograms[histogram_id]);
 
 	return;
 }
 
+// Load histogram with bin values randomly filled
 void
 riscvldhistrandom(Engine *E, State *S, int histogram_id){
 	Histogram_LDRandom(&S->riscv->histograms[histogram_id]);
 
 	return;
 }
 
+// Add two histograms
+void
+riscvaddhist(Engine *E, State *S, int histogram_id0, int histogram_id1, int histogram_id_dest){
+	Histogram_AddDist(
+			&S->riscv->histograms[histogram_id0],
+			&S->riscv->histograms[histogram_id1],
+			&S->riscv->histograms[histogram_id_dest]
+			);
+
+	return;
+}
+
+
+
+
+
+
+
 static UncertainState *
 uncertainnewstate(Engine *E, char *ID)
 {
@@ -282,6 +305,7 @@ riscvnewstate(Engine *E, double xloc, double yloc, double zloc, char *trajfilena
 	S->dumphist = riscvdumphist;
 	S->dumphistpretty = riscvdumphistpretty;
 	S->ldhistrandom = riscvldhistrandom;
+	S->addhist = riscvaddhist;
 
 	S->fatalaction = riscvfatalaction;
 	S->endian = Little;

sim/main.h

@@ -723,6 +723,7 @@ struct State
 	void 		(*dumphist)(Engine *, State *S, int histogram_id);
 	void 		(*dumphistpretty)(Engine *, State *S, int histogram_id);
 	void 		(*ldhistrandom)(Engine *, State *S, int histogram_id);
+	void 		(*addhist)(Engine *, State *S, int histogram_id0, int histogram_id1, int histogram_id2);
 
 	/*	Memory mapped device register read/write functions	*/
 	uchar		(*devreadbyte)(Engine *, State *S, ulong addr);

sim/regaccess-riscv.c

@@ -117,7 +117,8 @@ void freg_set_riscv(Engine *E, State *S, uint8_t n, uint64_t data)
 
 
 
-Histogram Histogram_AddDist(Histogram hist1, Histogram hist2, Histogram histDest){
+void
+Histogram_AddDist(Histogram *hist1, Histogram *hist2, Histogram *histDest){
 	/*
 	 * Add two distributions, considering overflow
 	 */
@@ -132,33 +133,53 @@ Histogram Histogram_AddDist(Histogram hist1, Histogram hist2, Histogram histDest
 	// TODO Alexa wrote "just in case" -- why?
 	//      Presumably this is to say it is our responsibility to initialise
 	for (int k = 0; k < kNBINS; k++){
-		histDest.bins[k] = 0;
+		histDest->bins[k] = 0;
 	}
 
 	// Iterate, adding with overflow
 	for (int j = 0; j < kNBINS; j++){
 		for (int i = 0; i < kNBINS; i++){
 			overflow_wid = i+j;
+			/*printf("overflow_wid = %u\n", overflow_wid);*/
 
 			if (overflow_wid < kNBINS){
-				overflow_hi = histDest.bins[i+j] + (uint32_t)((uint32_t)hist1.bins[i] * hist2.bins[j]);
+				overflow_hi = histDest->bins[i+j] + (uint32_t)((uint32_t)hist1->bins[i] * hist2->bins[j]);
+				/*printf("histdestbinsij = %u\n", histDest->bins[i+j]);*/
+				/*printf("hist1i = %u\n", hist1->bins[i]);*/
+				/*printf("hist2j = %u\n", hist2->bins[j]);*/
+				/*printf("overflow_hi = %u\n", overflow_hi);*/
 
 				if (overflow_hi < 65536){
-					histDest.bins[i+j] += hist1.bins[i] * hist2.bins[j];
+					/*printf("overflow_hi<65536\n");*/
+					histDest->bins[i+j] += hist1->bins[i] * hist2->bins[j];
 				}
 				else{
 					// Bin overflow error
-					// TODO implement (also missing from original implementation)
+					// TODO implement (also missing from original implementation -- how to handle?)
+					printf("UNIMPLEMENTED bin overflow error\n");
 				}
 			}
 			else{
 				// Value overflow error
-				// TODO implement (also missing from original implementation)
+				// TODO implement (also missing from original implementation -- how to handle?)
+					printf("UNIMPLEMENTED value overflow error\n");
 			}
 		}
 	}
 
-	return histDest;
+	// TODO Idea: normalise to same mean frequency?
+	/*double meanFreq = Histogram_MeanFrequency(histDest);*/
+	/*for (int i = 0; i < kNBINS; i++){*/
+		/*histDest->bins[i] /= (meanFreq);*/
+	/*}*/
+
+	// TODO Idea: normalise to same full scale (say, 255?)
+	/*for (int i = 0; i < kNBINS; i++){*/
+		/*histDest->bins[i] /= ;*/
+	/*}*/
+	
+	
+	return;
 }
 
 void Histogram_LDDist(Histogram *histogram, HistogramBinDatatype *bins){
@@ -235,7 +256,6 @@ void Histogram_PrettyPrint(Engine *E, State *S, Histogram *histogram){
 		normalised[i] = histogram->bins[i] / FULLSCALE;
 	}
 
-	mprint(E, S, nodeinfo, "Printing information for register __TODO__\n");
 	mprint(E, S, nodeinfo, "Histogram mean frequency (mean bin occupation): %.3f\n", meanFreq);
 	mprint(E, S, nodeinfo, "bin | val | graphical representation (scaled rel. to mean freq)\n");
 	mprint(E, S, nodeinfo, "----+-----+----------------------------------------------------\n");

sim/regs-riscv.h

@@ -290,7 +290,7 @@ typedef struct
 
 
 // Add two distributions, considering overflow
-Histogram Histogram_AddDist(Histogram hist1, Histogram hist2, Histogram histDest);
+void Histogram_AddDist(Histogram *hist1, Histogram *hist2, Histogram *histDest);
 
 // Load distribution
 void Histogram_LDDist(Histogram *histogram, HistogramBinDatatype bins[kNBINS]);
@@ -303,3 +303,6 @@ double Histogram_Mean(Histogram *histogram);
 
 // Pretty-print histogram distribution
 void Histogram_PrettyPrint(Engine *E, State *S, Histogram *histogram);
+
+// Return the mean frequency of a histogram, i.e. the average bin value (not weighted by index)
+double Histogram_MeanFrequency(Histogram *histogram);

sim/sf-riscv.y

@@ -107,6 +107,7 @@
 %token	T_DUMPHIST
 %token	T_DUMPHISTPRETTY
 %token	T_LDHISTRND
+%token	T_ADDHIST
 %token	T_DUMPSYSREGS
 %token	T_DUMPTIME
 %token	T_DUMPTLB
@@ -1231,6 +1232,13 @@ sf_cmd		: T_QUIT '\n'
 				yyengine->cp->ldhistrandom(yyengine, yyengine->cp, $2);
 			}
 		}
+		| T_ADDHIST uimm uimm uimm '\n'
+		{
+			if (!yyengine->scanning)
+			{
+				yyengine->cp->addhist(yyengine, yyengine->cp, $2, $3, $4);
+			}
+		}
 		| T_DUMPSYSREGS '\n'
 		{
 			if (!yyengine->scanning)