前言

在項(xiàng)目中，一個(gè)TB通常是很多人一起開(kāi)發(fā)的，大家或多或少都會(huì)往log中打印一些信息(message)，方便自己debug。但是如果log里信息太多，會(huì)造成自己感興趣的信息被淹沒(méi)了，只能通過(guò)關(guān)鍵字搜索的方式去查找。因此，本文推薦可以使用UVM提供的UVM_LOG功能，只需要增加少量的代碼，就可以根據(jù)ID或uvm_severity類(lèi)別，把自己感興趣的信息單獨(dú)提取到指定的文件。

UVM_LOG機(jī)制

為了使用UVM_LOG功能，需要在打印message之前打開(kāi)指定的文件，仿真結(jié)束時(shí)再關(guān)閉這個(gè)文件，并且需要把打開(kāi)文件的句柄傳遞給UVM的message管理系統(tǒng)?？梢詫⒋蜷_(kāi)的文件設(shè)置為默認(rèn)文件指向、或關(guān)聯(lián)到指定的uvm_severity或id，或兩者都關(guān)聯(lián)。

在uvm_report_object和uvm_component類(lèi)里提供了接口函數(shù)給用戶去配置UVM_LOG功能，注意uvm_report_object是uvm_component的父類(lèi)，因此大家只需要在uvm_component層次上調(diào)用這些接口函數(shù)就好了，而且可以控制UVM hierarchy上任何節(jié)點(diǎn)的消息打印行為。

具體的接口函數(shù)(API)分為兩類(lèi)。

第一類(lèi)是只適用于當(dāng)前uvm_component層次的，也就是這些接口函數(shù)的配置不會(huì)影響到UVM hierarchy的其它任何節(jié)點(diǎn)，有這些函數(shù)：

set_report_default_file(UVM_FILE file); //設(shè)置默認(rèn)輸出定向文件，如果id, severity都沒(méi)有關(guān)聯(lián)到輸出定
                                        //向文件的話，那么就默認(rèn)采用這里設(shè)置的文件。
set_report_id_file(string id, UVM_FILE file); //將id關(guān)聯(lián)到參數(shù)指定的輸出定向文件。
set_report_severity_file(uvm_severity severity, UVM_FILE file);  //將severity關(guān)聯(lián)到參數(shù)指定的輸出
                                                                 // 定向文件。
set_report_severity_id_file(uvm_severity severity, string id, UVM_FILE file);  // 將severity
                                                          // 和id一起關(guān)聯(lián)到參數(shù)指定的輸出定向文件。
get_report_file_handle(uvm_severity severity, string id); // 返回指定severity和id的輸出定向文件句柄

這些函數(shù)參數(shù)中傳遞的文件句柄必須是multi-channel描述符(mcd)或與$fdisplay兼容的文件id。UVM_FILE類(lèi)型其實(shí)就是int類(lèi)型。如果上述接口函數(shù)對(duì)id或severity重復(fù)指定輸出定向文件句柄，那么它們優(yōu)先級(jí)是set_report_severity_id_file() > set_report_id_file() > set_report_severity_file() > set_report_default_file()。

第二類(lèi)是除了適用于當(dāng)前uvm_component層次，它的子uvm_component也都全部適用，有這些函數(shù)：

set_report_default_file_hier(UVM_FILE file);
set_report_id_file_hier(string id, UVM_FILE file);
set_report_severity_file_hier(uvm_severity severity, UVM_FILE file);
set_report_severity_id_file_hier(uvm_severity severity, string id, UVM_FILE file);

可以看出，第二類(lèi)接口函數(shù)的命令是在第一類(lèi)接口函數(shù)命名后面加上”_hier”，對(duì)應(yīng)的功能是類(lèi)似，只是作用的uvm_component范圍不一樣。

例子

說(shuō)了這么多，來(lái)幾個(gè)例子。

第一個(gè)例子，在uvm_component子類(lèi)里加入以下代碼：

UVM_FILE log_fh = $fopen("cpu.log");  // 打印cpu.log的文件，并把句柄傳給log_fh
this.set_report_id_action("cpu", (UVM_DISPLAY | UVM_LOG)); // 將”cpu”的id加上UVM_LOG功能
this.set_report_id_file("cpu", log_fh); // 將“cpu”的id管理到log_fh文件句柄
`uvm_info("cpu", "The message will be logged in log file", UVM_LOW);
`uvm_info("cpu0", "The message will not be logged in log file", UVM_LOW);
$fclose(log_fh);  // 關(guān)閉log_fh文件句柄

上述代碼執(zhí)行完之后，將會(huì)在仿真目錄下生成1個(gè)名為cpu.log的文件，里面包含代碼里第一個(gè)uvm_info打印的消息” The message will be logged in log file”。代碼里第二個(gè)uvm_info的打印消息不會(huì)定向到cpu.log里，因?yàn)樗膇d是”cpu0”。

第二個(gè)例子，在uvm_component子類(lèi)里加入以下代碼：

UVM_FILE log_fh = $fopen("cpu.log");
UVM_FILE default_fh = $fopen("default.log");
this.set_report_id_action("cpu" , (UVM_DISPLAY | UVM_LOG));
this.set_report_id_action("cpu0", (UVM_DISPLAY | UVM_LOG));
this.set_report_id_file("cpu", log_fh);
this.set_report_default_file(default_fh);
`uvm_info("cpu", "The message will be logged in cpu.log file", UVM_LOW);
`uvm_info("cpu0", "The message will be logged in default.log file", UVM_LOW);
$fclose(log_fh);
$fclose(default_fh);

上述代碼執(zhí)行完之后，將會(huì)在仿真目錄下生成cpu.log和default.log兩個(gè)文件，第一個(gè)uvm_info的id為”cpu”，它只會(huì)定向到cpu.log，而不會(huì)定向到default.log，因?yàn)閟et_report_id_file()設(shè)置的文件句柄優(yōu)先級(jí)高于set_report_default_file()設(shè)置的。第二個(gè)uvm_info的id為”cpu0”，它會(huì)定向到defualt.log，因?yàn)闆](méi)有顯示關(guān)聯(lián)到它的文件句柄，UVM會(huì)使用默認(rèn)的文件句柄，也就是set_report_default_file()設(shè)置的defualt_fh(default.log)。

友情提示：

UVM_LOG功能需要用戶自己創(chuàng)建文件句柄并關(guān)聯(lián)到對(duì)應(yīng)的id或severity上，因此用戶需要維護(hù)文件句柄的打開(kāi)和關(guān)閉，建議可以在report_phase()里去統(tǒng)一關(guān)閉它們，如果提前關(guān)閉的話。

有趣的功能衍生

讀者可以考慮 將id與UVM的uvm_cmdline_processor或SV自帶的valueplusargs (user_string, variable)功能聯(lián)系起來(lái) ，這樣通過(guò)Command Line可以很方便地控制要將哪些id定向到特定的log文件里， 這個(gè)功能很有用，也不需要重復(fù)編譯就可以去定向提取各式各樣的ID ，大家可以自己先去試試，需要源代碼的話在微信公眾號(hào)聊天窗口里輸入”id代碼”，兩種版本的代碼都有提供。