一、简介

IFP 是 ByteDance 开源的集成电路设计流程平台，全称为 ic flow platform，主要用于超大规模数字集成电路设计的流程规范管理和数据流转控制。

需要声明：

* IFP 是开源工具，大家可以放心使用，按需修改。

* IFP 的安装、配置和使用，以及 bug fix 或者 function enhancement 等需求，都可以联系主要开发者获取强力技术支持，非常期待大家的联系。（主要开发者邮箱见安装包中 docs/IFP_user_manual.pdf 文档首页）

* 本文档不一定及时更新，但可以在安装包中获取最新的用户手册 docs/IFP_user_manual.pdf 。

1.1 IC 流程演化

1.2 IC 流程平台的主要作用

• 统一流程运行规范

• 数据集约化管理和展示

• 降低流程运行门槛

• 提升多模块运行效率

1.3 IFP 开发思路

• IFP 主要涵盖流程平台层，用来调度和管理用户任务。
• 自动化脚本仍然由每个 flow 的管理员自行维护和管理，并非 IFP 内嵌的一部分。
• EDA 设置由每个 flow 的管理员和相关用户自行维护和管理，并非 IFP 内嵌的一部分。
• 每个流程既可以采用流程平台运行，也可以采用脚本运行，只是流程规范和功能完备性上的区别。

1.4 IFP 基本概念和控制逻辑

1.4.1 任务拆解（从 Block 到 Task）

• Block，即集成电路模块。之所以把 Block 放到任务划分的顶层，是因为一般自顶向下的数字集成电路设计流程，大多按照 Block 来划分任务。
• Version，即 Block 不同设计阶段的版本信息。比如 PN85、PN95_v1 等。
• Flow，即集成电路设计的流程环节。比如 regression，DFT、synthesis、fv、sta 等，不同公司的划分和命名方式会有些许不同。
• Vendor，即运行某个流程所用到的哪家 EDA 厂商的工具。比如针对 synthesis 流程，常用的工具有 cadence 的 genus 和 synopsys 的 dc_shell，所以存在 cadence 和 synopsys 两个 Vendor 可选。（不同 vendor 会影响 checklist/summary 等脚本的选择）
• Branch，用于同一 Vendor 工具的不同模式区分。比如用 synopsys 的 dc_shell 来跑 synthsis 流程，也可能存在 dc 和 dcg 两种不同的运行模式。
• Task，每一个运行环节的最小的运行逻辑，即一个任务。比如 dc_shell 跑 synthesis，可以细分为 analyze/elaborate/initopt/advopt/finalopt 等不同的步骤，每个步骤都是一个 Task。

1.4.2 单个任务的行为（从 Task 到 Action）

1.4.3 单个行为的属性（从 Action 到 Atrribute）

1.4.4 IFP 控制逻辑

• Block/Version/Flow/Vendor/Branch/Task 信息，在用户配置文件（user config file）中定义。
• 每个任务（Task）的行为（Action）信息，可以在用户配置文件（user config file）中实现，也可以让流程管理员在默认配置文件（default config file）中预先定义。
• 每个行为（Action）的属性（Attribute）信息，可以在用户配置文件（user config file）中实现，也可以让流程管理员在默认配置文件（default config file）中预先定义。

二、环境依赖

2.1 操作系统依赖

2.2 python 版本依赖

2.3 集群管理系统

2.4 共享存储

三、工具安装及配置

3.1 工具下载

bytedance@C02FT5LHMD6R Downloads % git clone https://github.com/bytedance/ic_flow_platform.git Cloning into 'ic_flow_platform'... remote: Enumerating objects: 111, done. remote: Counting objects: 100% (111/111), done. remote: Compressing objects: 100% (101/101), done. remote: Total 111 (delta 1), reused 108 (delta 1), pack-reused 0 Receiving objects: 100% (111/111), 3.80 MiB | 1.17 MiB/s, done. Resolving deltas: 100% (1/1), done.

3.2 工具安装

[liyanqing.1987@n212-206-194 tools]$ cd ic_flow_platform/ 
[liyanqing.1987@n212-206-194 ic_flow_platform]$ ls 
action bin common config data docs install.py LICENSE.txt Notice.txt patch README requirements.txt third_part tools

[liyanqing.1987@n212-206-194 ic_flow_platform]$ which python3 
/ic/software/tools/python3/3.8.8/bin/python3

[root@ic-admin1 ic_flow_platform]# pip3 install -r requirements.txt Looking in indexes: https://bytedpypi.byted.org/simple/ Collecting matplotlib==3.6.3 
  Downloading https://bytedpypi.byted.org/packages/pypi/matplotlib/matplotlib-3.6.3-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl (9.4 MB) 
    ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.4/9.4 MB 174.4 MB/s eta 0:00:00 ... Installing collected packages: matplotlib   Attempting uninstall: matplotlib     Found existing installation: matplotlib 3.3.4     Uninstalling matplotlib-3.3.4:       Successfully uninstalled matplotlib-3.3.4 Successfully installed matplotlib-3.6.3

[liyanqing.1987@n212-206-194 ic_flow_platform]$ python3 install.py 
>>> Generate wrapper script "bin/ifp" ... 
>>> Generate wrapper script "action/check/scripts/gen_checklist_scripts" ... 
>>> Generate wrapper script "action/check/scripts/gen_checklist_summary" ... 
>>> Generate wrapper script "action/check/scripts/ic_check" ... 
>>> Generate wrapper script "action/check/scripts/view_checklist_report" ... 
>>> Generate config file "/ic/data/usr/liyanqing.1987/tools/ic_flow_platform/config/config.py". 
>>> Generate top sh environment file "/ic/data/usr/liyanqing.1987/tools/ic_flow_platform/config/env.sh" ... 
>>> Generate top csh environment file "/ic/data/usr/liyanqing.1987/tools/ic_flow_platform/config/env.csh" ... 
>>> Update EXPECTED_PYTHON/IFP_INSTALL_PATH settings for specified tools ... 
>>> Install tool "lsfMonitor" ... 

Install successfully!

3.3 工具配置

3.3.1 config/config.py

# Only default_yaml_administrators can edit default.yaml on ifp GUI directory. default_yaml_administrators = "" # send result command send_result_command = ""

# Only default_yaml_administrators can edit default.yaml on ifp GUI directory. default_yaml_administrators = "liyanqing.1987 jiexi jingfuyi" # send result command send_result_command = "/ic/software/cad_tools/bin/send_lark -c RESULT -r USER"

3.3.2 config/default.yaml

## Format ## # VAR: #     key: value # # TASK: #     flow:vendor:task: #         action: #             attribute: value # # ## Supported Variables (default) ## # CWD: <ifp start directory> # IFP_INSTALL_PATH: <ifp install path> # BLOCK: <block name> # VERSION: <version name> # FLOW: <flow name> # VENDOR: <vendor name> # BRANCH: <branch name> # TASK: <task name> # # ## Supported action ## # BUILD/RUN/CHECK/SUMMARY/POST_RUN/RELEASE # # ## Supportedd action attribute ## # PATH/COMMAND/RUN_METHOD/VIEWER/REPORT_FILE # # ## Example ## # VAR: #     BSUB_QUEUE: ai_syn #     DEFAULT_PATH: ${CWD}/${BLOCK}/<VERSION>/<FLOW>/<VENDOR>/<BRANCH> # # TASK: #     synthesis:synopsys:intopt: #         BUILD: #             PATH: $DEFAULT_PATH #             COMMAND: make build #         RUN: #             PATH: ${DEFAULT_PATH}/dc #             COMMAND: make run_initopt #             RUN_METHOD: bsub -q $BSUB_QUEUE -n 8 -R "rusage[mem=50000]" #         CHECK: #             PATH: ${DEFAULT_PATH}/dc #             COMMAND: ${IFP_INSTALL_PATH}/action/check/syn/synopsys/syn_synopsys.syn_dc.py -b ${BLOCK} #             VIEWER: ${IFP_INSTALL_PATH}/action/check/scripts/view_checklist_report.py -i #             REPORT_FILE: file_check/file_check.rpt #         SUMMARY: #             PATH: ${DEFAULT_PATH}/dc #             COMMAND: ${IFP_INSTALL_PATH}/action/summary/collect_syn_qor.py #             VIEWER: /bin/soffice # REPORT_FILE: syn_qor.xlsx #         POST_RUN: #             PATH: ${DEFAULT_PATH}/dc #             COMMAND: make post_run #             RUN_METHOD: bsub -q $BSUB_QUEUE -n 8 -R "rusage[mem=50000]" #         RELEASE: #             PATH: ${DEFAULT_PATH}/dc #             COMMAND: make release

... VAR: DEFAULT_PATH: ${CWD}/${BLOCK}/${BLOCK}_${VERSION}_${BRANCH} TASK:   gen_dir:common:build:     BUILD:       PATH: $CWD       COMMAND: /ic/flow/scripts/gen_block_run_dir.pl -c ${BLOCK}.block_flow.configure   syn:synopsys:lint:     RUN:       PATH: $DEFAULT_PATH       COMMAND: make lint run_local=1 RUN_METHOD: bsub -q comet -n 8 -R "rusage[mem=80000]" -Is ...

3.3.3 config/env.*

#### Default EDA tool settings #### # Set default TESSENT setting. # Set default DC setting. # Set default GENUS setting. # Set default FORMALITY setting. # Set default LEC setting. # Set default PT setting. # Set default TEMPUS setting. # Set default ICC2 setting. # Set default INNOVUS setting. ################################### 

# Set lsfMonitor path. 
export PATH=/ic/data/usr/liyanqing.1987/tools/ic_flow_platform/tools/lsfMonitor/monitor/bin:$PATH 

# Set default soffice path.

#### Default EDA tool settings #### # Set default TESSENT setting. # Set default DC setting. module load dc_shell/T-2022.03-SP3 # Set default GENUS setting. module load genus/21.14-s082_1 # Set default FORMALITY setting. # Set default LEC setting. # Set default PT setting. # Set default TEMPUS setting. # Set default ICC2 setting. # Set default INNOVUS setting. ################################### # Set lsfMonitor path. export PATH=/ic/data/usr/liyanqing.1987/tools/ic_flow_platform/tools/lsfMonitor/monitor/bin:$PATH # Set default soffice path.

四、工具使用

4.1 工具载入

[liyanqing.1987@n212-206-194 ic_flow_platform]$ alias ifp=/ic/data/usr/liyanqing.1987/tools/ic_flow_platform/bin/ifp 
[liyanqing.1987@n212-206-194 ic_flow_platform]$ which ifp 
alias ifp='/ic/data/usr/liyanqing.1987/tools/ic_flow_platform/bin/ifp'            /ic/data/usr/liyanqing.1987/tools/ic_flow_platform/bin/ifp

4.2 帮助信息

[liyanqing.1987@n212-206-194 ic_flow_platform]$ ifp -h 
usage: ifp.py [-h] [-config_file CONFIG_FILE] [-build] [-run] [-check] [-summary] [-post_run] [-release] [-d] 

optional arguments: 
  -h, --help          show this help message and exit   -config_file CONFIG_FILE, --config_file CONFIG_FILE                       Specify the configure file, default is "<CWD>/ifp.cfg.yaml". 
  -build, --build     Enable build function, create run directories/files.   -run, --run         Enable run function, run tasks/corners.   -check, --check Enable check function, check results of tasks/corners with specified checklist.   -summary, --summary Enable summary function, get summary report with specified information requirement.   -post_run, --post_run                       Enable post run function, execute user specified command. 
  -release, --release Enable release function, release current result to release directory.   -d, --debug         Enable debug mode, will print more useful messages.

4.3 图形界面介绍

[liyanqing.1987@n212-206-194 ifp_test]$ ifp 
>>> Generating empty configure file "/ic/data/usr/liyanqing.1987/ifp_test/ifp.cfg.yaml" ... 
QStandardPaths: XDG_RUNTIME_DIR not set, defaulting to '/tmp/runtime-liyanqing.1987'

4.3.1 菜单栏

4.3.2 功能区

4.3.3 工作区

4.4 配置文件

• 我想要跑什么任务。（Block/Version/Flow/Vendor/Branch/Task）
• 这些任务有哪些行为是可执行的。（Build/Run/Check/Summay/Post_run/Release）
• 任务行为如何执行。（比如 Run，那么需要在什么 PATH 下面，用什么 RUN_METHOD，执行什么 COMMAND。）

4.4.1 编辑用户配置

PROJECT: comet 
VAR: {} 
BLOCK: 
    <BLOCK>: 
        <VERSION>(RUN_ORDER=<FLOW1>,<FLOW2>|<FLOW3>): 
            <FLOW>: 
                <VENDOR>: 
                    <TASK>(RUN_TYPE=serial): 
                        <FUNCTION>: {} 
                        <FUNCTION>: {}

4.4.2 编辑 Task 行为和属性配置

4.4.3 降低配置工作量

• 由于每个流程的 Task 的行为和属性相对固定，可以配置到默认配置文件 config/default.yaml 中。
• 同一流程的用户运行模式往往一致，不同点在于运行模块（Block）有差异。

4.5 IFP 运行

• 进入运行目录。
• 配置用户配置文件。
• 在 ifp 图形界面上执行用户指定的行为。（比如 Build/Run/Check）
• 结果检查和数据核对。

[liyanqing.1987@n212-206-194 ~]$ cd /ic/data/usr/liyanqing.1987/ifp_test/ 
[liyanqing.1987@n212-206-194 ifp_test]$ ifp 
QStandardPaths: XDG_RUNTIME_DIR not set, defaulting to '/tmp/runtime-liyanqing.1987'

4.6 其它功能介绍

4.6.1 菜单栏功能介绍

• Save Status File

• Load Status File

• Zoom In

• Zoom Out

• Select Flows

• Select Tasks

• Ignore Fail

• Xterm Mode

• Send Result

4.6.2 主界面功能介绍

• Check ： 如果存在文本图标，可以查看 checklist 报告。
• Summary ： 如果存在文本图标，可以查看 summary 报告。
• Job ： 如果显示数字，可以得知采用 LSF 分布式并行运行的 Task 任务的 jobid，点击数字，可以使用自带的工具 lsfMonitor 查看任务信息。
• Runtime ： 如果 Task 是 LSF 任务并且已完成，此处可以看到其 runtime。
• Xterm : 点击黑色按钮，

4.6.3 辅助工具

五、范例

5.1 用户环境准备

5.1.1 EDA 配置文件

5.1.2 ifp 用户配置文件

[n212-206-218]: pre_ifp -d vdec_top >>> Generate ifp config file "/ic/proj/comet/jiexi/ifp_test/ifp.cfg.yaml"     /ic/software/cad_tools/flows/ic_flow_platform/tools/gen_yaml.py vdec_top.block_flow.configure

PROJECT: comet VAR: 
BLOCK:    vdec_top:     IFP_v1.0(RUN_ORDER=gen_dir,syn,fv|sta): 
      gen_dir: 
        common: 
          test: 
            build: 
      syn: 
        synopsys: 
          test(RUN_TYPE=serial): 
            syn_dcg: 
            dataout: 
        cadence: 
          test: 
            syn_genus: 
      fv: 
        synopsys: 
          test: 
            formal_dftrtl2syn: 
      sta: 
        synopsys: 
          test: 
            presta:

5.2 操作范例

[n212-206-218]: /ic/proj/comet/jiexi/ifp_test/ls mctf_register.block_flow.configure vdec_top.block_flow.configure flow gen_block_run_dir.pl [n212-206-218]: /ic/proj/comet/jiexi/ifp_test/ifp QStandardPaths: XDG_RUNTIME_DIR not set, defaulting to '/tmp/runtime-jiexi'

5.2.1 Build

[n212-206-218]: /ic/proj/comet/jiexi/ifp_test/ls */*/ mctf_register/mctf_register_IFP_v1.0_test/: 
clp conformal_eco datain dataout eco formal gen_etm lec Makefile ptc setup spyglass sta syn_dc syn_genus vclp v

dec_top/vdec_top_IFP_v1.0_test/: 
clp conformal_eco datain dataout eco formal gen_etm lec Makefile ptc setup spyglass sta syn_dc syn_genus vclp

5.2.2 Run

5.2.3 Kill

5.2.4 Check

5.2.5 Summary

5.2.6 Release

附录

附一、变更历史

附二、ifp 的配置文件

PROJECT: <$project> VAR: <$环境变量> BLOCK: 
  -<design1>: 
    <version>: 
      <flow>: 
        <vendor>: 
          <branch>: 
            <task>: {} 
  -<design2>: 
    <version>: 
      <flow>: 
        <vendor>: 
          <branch>: 
            <task>: {}

PROJECT: comet ⟹ 项目名称 VAR: {} ⟹ 设置环境变量 BLOCK:   vdec_top: ⟹ design_name     IFP_v1.0(RUN_ORDER=gen_dir,syn,fv|sta): ⟹ version信息       gen_dir: ⟹ flow信息         common: test(RUN_TYPE=serial): ⟹ branch信息           build: {} ⟹ task信息       syn: ⟹ flow信息         synopsys:           test(RUN_TYPE=serial): ⟹ branch信息             syn_dcg: {} ⟹ task信息             dataout: {} ⟹ task信息         cadence:           test(RUN_TYPE=serial): ⟹ branch信息             syn_genus: {} ⟹ task信息       fv: ⟹ flow信息         synopsys:           test(RUN_TYPE=serial): ⟹ branch信息             formal_dftrtl2syn: {} ⟹ task信息       sta: ⟹ flow信息         synopsys: ⟹ vendor信息           test(RUN_TYPE=serial):             presta: {} ⟹ task信息   mctf_register: ⟹ design_name     IFP_v1.0(RUN_ORDER=gen_dir,syn,fv|sta): ⟹ version信息       gen_dir: ⟹ flow信息         common: test(RUN_TYPE=serial):           build: {} ⟹ task信息       syn: ⟹ flow信息         synopsys: ⟹ vendor信息           test(RUN_TYPE=serial): ⟹ branch信息             syn_dcg: {} ⟹ task信息             dataout: {} ⟹ task信息         cadence: ⟹ vendor信息           test(RUN_TYPE=serial): ⟹ branch信息             syn_genus: {} ⟹ task信息       fv: ⟹ flow信息         synopsys: ⟹ vendor信息           test(RUN_TYPE=serial): ⟹ branch信息             formal_dftrtl2syn: {} ⟹ task信息       sta: ⟹ flow信息         synopsys: ⟹ vendor信息           test(RUN_TYPE=serial): ⟹ branch信息             presta: {} ⟹ task信息

Project ⟺ proj_name Block ⟺ DESIGN Version ⟺ RTL_VERSION Branch ⟺ SYN_VERSION

• Task 右键编辑

• 若新增 task 项在 default config file 预先有定义且用户不修改 task 属性时，界面显 灰色背景；
• 若新增 task 项在 default config file 预先有定义但用户修改 task 属性时，界面显 蓝色背景；
• 若新增 task 项未在 default config file 预先有定义，界面显 红色背景，且 task 对应的 flow setting 均为空，需要用户自行定义；

• Branch 右键编辑

• Vendor 右键编辑

• Flow 右键编辑

• Version 右键编辑

• Block 右键编辑