Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ChiselDB: dynamically append hartid for table name and site name #45

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
+111 −38
Draft

ChiselDB: dynamically append hartid for table name and site name #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 55 additions & 30 deletions src/main/scala/utility/ChiselDB.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
package utility

import chisel3._
import chisel3.experimental.StringParam
import chisel3.experimental.{IntParam, StringParam}
import chisel3.util._

trait HasTableUtils {
Expand Down Expand Up @@ -79,45 +79,55 @@ trait HasTableUtils {
}
}

class Table[T <: Record](val envInFPGA: Boolean, val tableName: String, val hw: T) extends HasTableUtils {
class Table[T <: Record](val envInFPGA: Boolean, val tableName: String, val hw: T, val tablePerHart: Boolean) extends HasTableUtils {

val hartIdNum = if (tablePerHart) HartIdHelper.getHartNum else 0

def genCpp: (String, String) = {
val cols = get_columns(hw, "").map(_.field)
val names = if (tablePerHart) (0 until hartIdNum).map(i => s"${tableName}_${i}") else IndexedSeq(tableName)
def InitBody(name: String): String =
s"""|const char *sql_${name} = "CREATE TABLE $name(" \\
| "ID INTEGER PRIMARY KEY AUTOINCREMENT," \\
| ${cols.map(c => "\"" + c.toUpperCase + " INT NOT NULL,\" \\").mkString("", "\n ", "")}
| "STAMP INT NOT NULL," \\
| "SITE TEXT);";
| rc = sqlite3_exec(mem_db, sql_${name}, callback, 0, &zErrMsg);
| if(rc != SQLITE_OK) {
| printf("SQL error: %s\\n", zErrMsg);
| exit(0);
| } else {
| printf("%s table created successfully!\\n", "$name");
| }
|""".stripMargin
val init =
s"""
|void init_db_$tableName() {
| // create table
| if (!enable_dump_$tableName) return;
|
| const char *sql = "CREATE TABLE $tableName(" \\
| "ID INTEGER PRIMARY KEY AUTOINCREMENT," \\
| ${cols.map(c => "\"" + c.toUpperCase + " INT NOT NULL,\" \\").mkString("", "\n ", "")}
| "STAMP INT NOT NULL," \\
| "SITE TEXT);";
| rc = sqlite3_exec(mem_db, sql, callback, 0, &zErrMsg);
| if(rc != SQLITE_OK) {
| printf("SQL error: %s\\n", zErrMsg);
| exit(0);
| } else {
| printf("%s table created successfully!\\n", "$tableName");
| }
| ${names.map(InitBody).mkString("", " ", "")}
|}
|""".stripMargin
val insert =
s"""
|extern "C" void ${tableName}_write(
| ${cols.map(c => "uint64_t " + c).mkString("", ",\n ", ",")}
| uint64_t stamp,
| char *site
| char *site,
| uint64_t hartId,
| bool site_need_id
|) {
| if(!dump || !enable_dump_$tableName) return;
|
| const char *format = "INSERT INTO $tableName(${cols.map(_.toUpperCase).mkString(",")}, STAMP, SITE) " \\
| "VALUES(${cols.map(_ => "%ld").mkString(", ")}, %ld, '%s');";
| const char *format = "INSERT INTO ${tableName}${if (tablePerHart) "_%ld" else ""}(${cols.map(_.toUpperCase).mkString(",")}, STAMP, SITE) " \\
| "VALUES(${cols.map(_ => "%ld").mkString(", ")}, %ld, '%s%s');";
| char *sql = (char *)malloc(${cols.size + 1} * sizeof(uint64_t) + (strlen(format)+strlen(site)) * sizeof(char));
| char site_id[8];
| sprintf(site_id, "_%ld", hartId);
| sprintf(sql,
| format,
| ${cols.mkString(",")}, stamp, site
| format,${if (tablePerHart) " hartId," else ""}
| ${cols.mkString(",")}, stamp, site, site_need_id ? site_id : ""
| );
| rc = sqlite3_exec(mem_db, sql, callback, 0, &zErrMsg);
| free(sql);
Expand All @@ -136,15 +146,16 @@ class Table[T <: Record](val envInFPGA: Boolean, val tableName: String, val hw:
|extern "C" void ${tableName}_write(
| ${cols.map(c => "uint64_t " + c).mkString("", ",\n ", ",")}
| uint64_t stamp,
| char *site
| char *site,
| uint64_t hartId
|) {}
|""".stripMargin
if (envInFPGA) (init_dummy, insert_dummy) else (init, insert)
}

def log(data: T, en: Bool, site: String = "", clock: Clock, reset: Reset): Unit = {
def log(data: T, en: Bool, site: String = "", clock: Clock, reset: Reset, siteNeedId: Boolean = false): Unit = {
if(!envInFPGA){
val writer = Module(new TableWriteHelper[T](tableName, hw, site))
val writer = Module(new TableWriteHelper[T](tableName, hw, site, tablePerHart, siteNeedId))
val cnt = RegInit(0.U(64.W))
cnt := cnt + 1.U
writer.io.clock := clock
Expand All @@ -156,19 +167,28 @@ class Table[T <: Record](val envInFPGA: Boolean, val tableName: String, val hw:
}

def log(data: Valid[T], site: String, clock: Clock, reset: Reset): Unit = {
log(data.bits, data.valid, site, clock, reset)
log(data, site, clock, reset, false)
}

def log(data: Valid[T], site: String, clock: Clock, reset: Reset, siteNeedId: Boolean): Unit = {
log(data.bits, data.valid, site, clock, reset, siteNeedId)
}

def log(data: DecoupledIO[T], site: String, clock: Clock, reset: Reset): Unit = {
log(data.bits, data.fire, site, clock, reset)
log(data, site, clock, reset, false)
}

def log(data: DecoupledIO[T], site: String, clock: Clock, reset: Reset, siteNeedId: Boolean): Unit = {
log(data.bits, data.fire, site, clock, reset, siteNeedId)
}

}

private class TableWriteHelper[T <: Record](tableName: String, hw: T, site: String)
private class TableWriteHelper[T <: Record](tableName: String, hw: T, site: String, tablePerHart: Boolean, siteNeedId: Boolean)
extends BlackBox(
Map(
"site" -> StringParam(site)
"site" -> StringParam(site),
"site_need_id" -> IntParam(if (siteNeedId) 1 else 0)
)
)
with HasBlackBoxInline
Expand All @@ -195,7 +215,9 @@ private class TableWriteHelper[T <: Record](tableName: String, hw: T, site: Stri
|(
|${dpicInputs.map(x => "input longint " + x).mkString(" ", ",\n ", ",")}
| input longint stamp,
| input string site
| input string site,
| input longint hartId,
| input bit site_need_id
|);
|
|module $moduleName(
Expand All @@ -206,10 +228,13 @@ private class TableWriteHelper[T <: Record](tableName: String, hw: T, site: Stri
| input [63:0] stamp
|);
| parameter string site = "undefined";
| parameter site_need_id = 1'b0;
|
| wire [63:0] hartId = ${if (tablePerHart || siteNeedId) "_hartIdDeclareModule.hartId" else "64'h0"};
|
| always@(posedge clock) begin
| if(en && !reset) begin
| $dpicFunc(${table.map(_.vExpr).mkString("", ", ", ", stamp, site")});
| $dpicFunc(${table.map(_.vExpr).mkString("", ", ", ", stamp, site, hartId, site_need_id")});
| end
| end
|endmodule
Expand All @@ -231,10 +256,10 @@ object ChiselDB {
this.enable = enable
}

def createTable[T <: Record](tableName: String, hw: T, basicDB: Boolean = false): Table[T] = {
def createTable[T <: Record](tableName: String, hw: T, basicDB: Boolean = this.enable, tablePerHart: Boolean = false): Table[T] = {
getTable(tableName, hw)
.getOrElse({
val t = new Table[T](!(basicDB & this.enable), tableName, hw)
val t = new Table[T](!(basicDB & this.enable), tableName, hw, tablePerHart)
table_map += (tableName -> t)
t
})
Expand Down
48 changes: 48 additions & 0 deletions src/main/scala/utility/HartIdHelper.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/***************************************************************************************
* Copyright (c) 2020-2021 Institute of Computing Technology, Chinese Academy of Sciences
* Copyright (c) 2020-2021 Peng Cheng Laboratory
*
* XiangShan is licensed under Mulan PSL v2.
* You can use this software according to the terms and conditions of the Mulan PSL v2.
* You may obtain a copy of Mulan PSL v2 at:
* http://license.coscl.org.cn/MulanPSL2
*
* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
*
* See the Mulan PSL v2 for more details.
***************************************************************************************/

package utility

import chisel3._
import chisel3.util._

object HartIdHelper {
private var hartIdNum = 1
def setHartNum(num: Int): Unit = (hartIdNum = num)
def getHartNum: Int = hartIdNum
}

private class HartIdDeclare extends BlackBox with HasBlackBoxInline {
val io = IO(new Bundle {
val hartId = Input(UInt(64.W))
})

val verilog =
"""
|module HartIdDeclare(
| input [63:0] hartId
|);
|
|endmodule
|""".stripMargin
setInline("HartIdDeclare.v", verilog)
}

trait DeclareHartId {
private val _hartIdDeclareModule = Module(new HartIdDeclare)
val declaredHartId = Wire(UInt(64.W))
_hartIdDeclareModule.io.hartId := declaredHartId
}
16 changes: 8 additions & 8 deletions src/main/scala/utility/TLUtils/TLLogger.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ class TLLog extends Bundle with HasCLikeTypes {
val echo = uint64_t
}

class TLLogWriter(prefix: String) extends Module {
class TLLogWriter(prefix: String, siteNeedId: Boolean) extends Module {
val io = IO(Flipped(ValidIO(new TLLog)))
TLLogger.table.log(io, prefix, this.clock, this.reset)
TLLogger.table.log(io, prefix, this.clock, this.reset, siteNeedId)
}

class TLLogger(name: String)(implicit p: Parameters) extends LazyModule {
class TLLogger(name: String, val siteNeedId: Boolean)(implicit p: Parameters) extends LazyModule {
val node = TLAdapterNode()
lazy val module = new TLLoggerImp(this, name)
}
Expand All @@ -58,7 +58,7 @@ class TLLoggerImp(outer: TLLogger, name: String) extends LazyModuleImp(outer) {
val node = outer.node
for (((in, edgeIn), (out, edgeOut)) <- node.in.zip(node.out)) {
out <> in
TLLogger.track(in, edgeIn, this.clock, this.reset)(name)
TLLogger.track(in, edgeIn, this.clock, this.reset, outer.siteNeedId)(name)
}
}

Expand Down Expand Up @@ -127,15 +127,15 @@ object TLLogger {
log.data := d.data.asTypeOf(log.data)
}

def track(in: TLBundle, edge: TLEdgeIn, clock: Clock, reset: Reset)(name: String) = {
def track(in: TLBundle, edge: TLEdgeIn, clock: Clock, reset: Reset, siteNeedId: Boolean)(name: String) = {
val numClients = edge.client.endSourceId

// Acquire/Get -> Grant
val a_d_addrs = Reg(Vec(numClients, UInt(edge.bundle.addressBits.W)))
// Release -> ReleaseAck
val c_d_addrs = Reg(Vec(numClients, UInt(edge.bundle.addressBits.W)))
val a_log, b_log, c_log, d_log = WireInit(0.U.asTypeOf(new TLLog))
val a_writer, b_writer, c_writer, d_writer = Module(new TLLogWriter(name))
val a_writer, b_writer, c_writer, d_writer = Module(new TLLogWriter(name, siteNeedId))

def connect(writer: TLLogWriter, log: TLLog, wen: Bool) = {
writer.io.bits.channel := log.channel
Expand Down Expand Up @@ -178,9 +178,9 @@ object TLLogger {

}

def apply(name: String, enable: Boolean = true)(implicit p: Parameters) = {
def apply(name: String, enable: Boolean = true, needHartId: Boolean = false)(implicit p: Parameters) = {
if (enable) {
val logger = LazyModule(new TLLogger(name))
val logger = LazyModule(new TLLogger(name, needHartId))
logger.node
} else {
TLTempNode()
Expand Down