wiki

本页面只读。您可以查看源文件，但不能更改它。如果您觉得这是系统错误，请联系管理员。
====== vc_apps_npi ======


===== - npi_find_signal_regex =====

其采用的正规表达式是与vim一致的那种，不是perl的那种，   比如 ''\(abc\|cde\)$''   表示匹配以abc或者cde结尾的信号

tcl语法：
<code tcl>
proc npi_find_signal_regex { root_scope sig_regex sig_hdl_list }
</code>

从root_scope层次开始往下查找，所以子层次的信号也会被匹配到。


其正则表达式不支持 ''\d \w \s''等等类似的简写方式，需要使用''[a-z] [0-9]''类似的方式。

支持''. * +''等方式。


===== - npi_find_inst_regex =====
<code tcl>
proc npi_find_inst_regex { root_scope inst_regex inst_hdl_list }

Parameters
root_scope
Specify the hierarchical name of a root scope. This procedure will search the target 
handle from the scope. The top module will be used if it is empty.
inst_regex
Specify the instance regular expression naming rule. Any instances should be 
collected if their names (not full names) match the specified naming rule.
inst_hdl_list 
Specify the output list name. Collect all resultant handles into this list.

Return Value
Return the total number of matched instances. If none is found, return 0.
</code>
===== - npi_nl_handle_by_name =====

<code tcl>
npi_nl_handle_by_name -name <name> [-type <type>]
Parameters
-name <name>
<name> is a string containing the full hierarchical name of an object.
-type <type> (optional)
<type> is a string representing the type of object for which to obtain the handle. If
-type is not specified, default value will be npiNlUndefined.
Return Value
A string representing the handle to an object.
</code>

用这个命令可以找到模块的port, 从而可以有办法知道port的方向。

<code tcl>
set hdl [npi_nl_handle_by_name -name "top.a.datain" -type npiNlPort]
set dir [ npi_nl_get_str -property npiNlDirection -object $hdl ]

</code>


===== - npi_trace_driver2 =====


<code tcl>
proc npi_trace_driver2 { sigHierName resListName { needPassThrough 1 }


proc npi_trace_driver2 { sigHierName resListName { needPassThrough 1 } {boundaryHdlList {} } { trcOptionsList “1 0 1 1” } }
# 后面两个参数一般都没有使用

</code>

  sigHierName
    Specify the hierarchical name of the target signal.

  resListName
    它是返回一个list, list里面有多个元素，每个元素也是一个list， sigHdlList表示一个具体的driver赋值结构右边所有信号的一个list集合。
    Specify the name of the list where the driver statement and signal handles will be collected.
    The structure of the list is as follows:
    resultList ::= { {srcHdl scopeHdl isPassThrough numSigUse useHdl sigHdlList}* }
      srcHdl : The tracing source handle of this use handle.
      scopeHdl: The scope handle of this use handle.   -- 如果load/driver是-v/-y的lib cell, scope为这个lib cell的full path, 如果是一般的赋值语句，则是赋值语句所处inst的fullname
      isPassThrough: Indicate this use handle is whether or not passed through.   --- 1, 表示端口信号驱动，不是=号赋值
      numSigUse: Indicate how many times of source handle be traced in this use handle.
              If this value is 0, it means this useHdl is traced by other statement (statement structure based trace).
      useHdl: Target use handle. The definition of use handle, refer to Use and Vh Use.   --- 一般是描述赋值语句类型的，可以用打印为string形式出来。
      sigHdlList: The driver signal handles of this use handle.   -- 如果load/driver是lib cell, 则信号名是与lib cell同级（即信号不会伸入到lib cell里面去），其它情况就是正常full path
    

  needPassThrough
    A Boolean value specifying whether or not to pass through the port of module and map element of vh component.
    0: the boundary of npiModule or npiVhComponent object will not be passed through when traversing the model
    1: the boundary of npiModule or npiVhComponent object will be will not be passed through when traversing the model
    default value: 1
  
  
==== - 使用举例 ====

<code tcl>

# --------------------------------------------------------------------
proc dump_res_list { resList targetFileHdl } {
    set size [ llength $resList ]
    for { set i 0 } { $i < $size } { incr i } {
        set dlStruct [lindex $resList $i]
        puts $targetFileHdl " $i source: [ npi_util_get_hdl_info [lindex $dlStruct 0] ]"
        puts $targetFileHdl " scope: [ npi_util_get_hdl_info [lindex $dlStruct 1] ]"
        puts $targetFileHdl " isPassThrought: [lindex $dlStruct 2] "
        puts $targetFileHdl " numSigUse: [lindex $dlStruct 3] "
        puts $targetFileHdl " useHdl: [ npi_util_get_hdl_info [lindex $dlStruct 4] ]"
        set sigList [lindex $dlStruct 5]
        set sigSize [llength $sigList]
        for { set l 0 } { $l < $sigSize } { incr l } {
            puts $targetFileHdl " [ npi_util_get_hdl_info [lindex $sigList $l] ]"
        }
    }
}
# --------------------------------------------------------------------
set resList {}
set sigHdl [ npi_handle_by_name -name {top.f[2:3]} -scope ""]
::npi_L1::npi_trace_driver_by_hdl2 $sigHdl "resList"
dump_res_list $resList stdout

</code>


''npi_util_get_hdl_info''输出是字符串，输出格式是：赋值类型，赋值语句，{文件:行号}


===== - npi_L1::npi_ut_get_hdl_info =====

<code tcl>
proc ::npi_L1::npi_ut_get_hdl_info { hdl { isComposeFullName 0} }
</code>

主要用来看assign结构左右两边表达式的内容（文本内容），用于脚本分析赋值结构。

-----
<color #ed1c24>
注：这个函数对常数的赋值没有把它的位宽给打印出来，会导致无法进行位宽分析，比如下面的情况

''assign a = {b[2:0], 5'b0};''

其hdl_info分析出来可能是  ''b[2:0], 'b0''。 即无法知道'b0的准确bit位宽。所以没有办法用上此工具。
</color>

------
相关例子， 来自到vc_apps_npi.pdf

<code verilog>
example.v
module top;
wire w1, w2, w3;
assign w1 = w2 & w3;
endmodule
</code>

<code tcl>

demo.tcl

source $env(NPIL1_PATH)/npi_L1.tcl
debImport -sv example.v
set hdlList {}
set instHdl [ npi_handle_by_name -name "top" -scope "" ]
set itr [ npi_iterate -type npiNet -refHandle $instHdl ]
while { [ set subHdl [ npi_scan -iterator $itr ]] != "" } {
lappend hdlList $subHdl
}
# get the hdl information and print it
set hdlInfo [ ::npi_L1:npi_ut_get_hdl_info $instHdl ]
puts "$hdlInfo"
# dump the handle information usin L1 API
::npi_L1::npi_ut_dump_hdl_info $instHdl "stdout"
# dump and release the handles in the hdl vector
::npi_L1::npi_ut_dump_hdl_vec_info "hdlList" "stdout" 1
debExit
</code>


<code>

Result
npiModule, top, {example.v : 1}
npiModule, top, {example.v : 1}
npiNet, top.w1, {example.v : 2}
npiNet, top.w2, {example.v : 2}
npiNet, top.w3, {example.v : 2}

</code>


===== - npi_mod_inst_get_instance =====
可以用来查找指定路径下所有实例化的模块，类似于dc里面的get_cells
<code tcl>
proc npi_mod_inst_get_instance { hier_inst_name inst_hdl_list }
</code>

<code>
Parameters
hier_inst_name
Specify the hierarchical name of the target module instance.
inst_hdl_list
Specify the reference to a list of type npiHandle. The iterated instance handle will be
put into the list.
Return Value
The total number of instances found is returned. 0 if it fails to find the corresponding
module instance.
</code>

Example:

<code tcl>
example.v
module MOD;
endmodule
module TOP;
MOD inst();
MOD inst2 [3:0] ();
endmodule
demo.tcl
source $env(NPIL1_PATH)/npi_L1.tcl
debImport -sv example.v
set hdlList {}
::npi_L1::npi_mod_inst_get_instance “TOP” “hdlList”
::npi_L1::npi_sv_ut_dump_hdl_vec_info “hdlList” “stdout”
debExit
</code>

Output:
<code>
npiModule, TOP.inst, {example.v : 5}
npiModule, TOP.inst2[3], {example.v : 6}
npiModule, TOP.inst2[2], {example.v : 6}
npiModule, TOP.inst2[1], {example.v : 6}
npiModule, TOP.inst2[0], {example.v : 6}
</code>

This code finds the module instance “TOP” in the loaded design, and collects the instance
handles of the instance into the vector “hdlList”.


===== - npi_mod_inst_get_port =====
使用方式跟npi_mod_inst_get_instance类似，用于获取一个模块下面的port列表。
<code tcl>
proc npi_mod_inst_get_port { hier_inst_name port_hdl_list }
</code>


===== - Properties =====

==== - npiCellInstance ====

module properties, 如果模块定义文件被-y， -v修辞或者是`celldefine 和`endcelldefine， 表示该module被定义为library， 所以其实例化的就是cell instance。

有时候需要知道一下这个属性，比如在trace driver的时候，追到cell的passthrough pin就停止了，此时应该把这个Passthrough当做是一个正常的driver，其它情况下的passthrough都直接被忽略掉了。   <color #ed1c24>-- 这个是停止上cell的instance那一层，就是net， driver log中不会显示cell的信息，所以无法定位到cell， 所以想对这个driver进行计数还得想其它的办法。</color>

-- 不确定是不是可以用下面表格里面提到的tcl command来进一步做尝试识别。

<code tcl>
set  bool_value [npi_get -property npiCellInstance -object $hdl]
</code>


==== - vc_app connection ====

^tcl command  ^说明  |
|npi_nl_sig_2_mod_inst_conn  | \\ Identify the connected module instances from a signal. \\ 只会在模块内部trace， 不会trace出模块，这样会比较方便。 \\  \\ 需要用stop at port/instport  |
|npi_nl_sig_2_mod_inst_conn_dump  | ::: |
|npi_nl_sig_hdl_2_mod_inst_conn  | ::: |
|npi_nl_sig_hdl_2_mod_inst_conn_dump  | ::: |
|npi_nl_sig_2_primitive_inst_conn  |Identify the connected primitive instances from a signal. \\ 原语级别的，不太好用，而且数目特别大，不好分析。还是上面到mod模块级别的更好用。  |
|npi_nl_sig_2_primitive_inst_conn_dump  | ::: |
|npi_nl_sig_hdl_2_primitive_inst_conn  | ::: |
|npi_nl_sig_hdl_2_primitive_inst_conn_dump  | ::: |

npi_nl_sig_2_mod_inst_conn, nl （netlist）相关的get_str,需要使用''npi_nl_get_str'' 命令，而不是''npi_get_str'' 命令。

疑问： low_conn和high_conn有什么区别。 VC_APPS_NPI.pdf page1444

<color #ed1c24>2. npiHighConn will indicate the hierarchically higher (closer to the top module) port
connection. \\ 
3. npiLowConn will indicate the lower (further from the top module) port connection.</color>

===== - 实例 =====

==== - trace driver ====

<code tcl [enable_line_numbers="true",highlight_lines_extra="28,29"]>
#source $env(NPIL1_PATH)/npi_L1.tcl

proc prepare_Netlist_setting {} {
    schSetPreference -detailRTL on -detailMux on -recogFSM off -expandGenBlock on -detailLevel 101 -InferenceLibCell on
}

proc dump_res_list { resList targetFileHdl } {
  set size [ llength $resList ]
  for { set i 0 } { $i < $size } { incr i } {
    set dlStruct [lindex $resList $i]
    puts $targetFileHdl " $i source: [ npi_util_get_hdl_info [lindex $dlStruct 0] 
]"
    puts $targetFileHdl "   scope: [ npi_util_get_hdl_info [lindex $dlStruct 1] ]"
    puts $targetFileHdl "   isPassThrought: [lindex $dlStruct 2] "
    puts $targetFileHdl "   numSigUse: [lindex $dlStruct 3] "
    puts $targetFileHdl "   useHdl: [ npi_util_get_hdl_info [lindex $dlStruct 4] 
]"
    set sigList [lindex $dlStruct 5]
    set sigSize [llength $sigList]
    for { set l 0 } { $l < $sigSize } { incr l } {
      puts $targetFileHdl "        [ npi_util_get_hdl_info [lindex $sigList $l] ]"
    }


    set hdl [lindex $dlStruct 4]
    set tmp [npi_get_str -property npiType -object $hdl]
    puts $targetFileHdl "t:$tmp"
    set tmpStr [ npi_util_decompile_t::decompile $hdl ]
    puts $targetFileHdl "tmpStr:$tmpStr";   #可用于获取赋值语句,这样有机会获取到取反信息等, assign a2 = ((~a1) & 'b1)
  }
}


proc main { output_log } {
    prepare_Netlist_setting
    set LOG [open $output_log "w"]

    puts $LOG "================================================================================"
    puts $LOG ""

    #npi_trace_driver_dump2 { sigHdl { fileHdl “” }  { needPassThrough 1 } { boundaryHdlList {} } { trcOptionsList “1 0 1 1” } }
    ::npi_L1::npi_trace_driver_dump2 "top.a2" $LOG
    puts $LOG ""
    puts $LOG ""
    puts $LOG ""


    set resList {}
    set sigHdl [ npi_handle_by_name -name {top.a2} -scope ""]
    ::npi_L1::npi_trace_driver_by_hdl2 $sigHdl "resList"
    dump_res_list $resList $LOG


    close $LOG
}
</code>

trace log如下：
<code>
================================================================================

npiNet, top.a2, {/home/user01/try_verdi/top.v : 53} /* results of trace driver */
Need pass through
<1> source: a2, scope: top
    <D> npiContAssign, assign a2 = ((~a1) & 'b1), {/home/user01/try_verdi/top.v : 70}
          npiConstant, 'b1, (null)
          npiNet, top.a1, {/home/user01/try_verdi/top.v : 52}



 0 source: npiNet, top.a2, {/home/user01/try_verdi/top.v : 53}
   scope: npiModule, top, {/home/user01/try_verdi/top.v : 20}
   isPassThrought: 0 
   numSigUse: 1 
   useHdl: npiContAssign, assign a2 = ((~a1) & 'b1), {/home/user01/try_verdi/top.v : 70}
        npiConstant, 'b1, (null)
        npiNet, top.a1, {/home/user01/try_verdi/top.v : 52}
t:npiContAssign
tmpStr:assign a2 = ((~a1) & 'b1)
</code>