ocaccel_workflow.py

#!/usr/bin/env python
#
# Copyright 2019 International Business Machines
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

import os
import sys
import qa
import random
from env_clean import env_clean
from env_check import env_check
from configure import Configuration
from make_model import make_model
from run_sim import SimSession
from make_image import make_image
from make_cloud_base import make_cloud_base
from make_cloud_action import make_cloud_action
from optparse import OptionParser
from ocaccel_utils import msg

usage = '''%prog <options>
The wrapper to guide through the whole OC-ACCEL workflow.

Example:
* Run the full flow from configuration to simulation:
`./ocaccel_workflow.py --ocse_root <path to ocse root> --simulator xcelium --testcase "ocaccel_example -a 6 -vv"`
* Skip the simulation model build:
`./ocaccel_workflow.py --no_make_model -o <path to ocse root> -s xcelium -t "ocaccel_example -a 6 -vv"`
* Run testcase in an pop-up xterm:
`./ocaccel_workflow.py --no_make_model -o <path to ocse root> -s xcelium -t terminal`
* Clean the environment before running:
`./ocaccel_workflow.py -c --no_make_model -o <path to ocse root> -s xcelium -t terminal`
* Run in interactive mode:
`./ocaccel_workflow.py -i --ocse_root <path to ocse root> --simulator xcelium --testcase "ocaccel_example -a 6 -vv"`
* Run in unit sim model:
`./ocaccel_workflow.py --unit_sim --simulator xcelium`
'''

parser = OptionParser(usage=usage)
parser.add_option("--no_env_check",
                  action="store_true", dest="no_env_check", default=False,
                  help="Don't check the environment settings, default: %default")
parser.add_option("--no_configure",
                  action="store_true", dest="no_configure", default=False,
                  help="Don't configure the actions, default: %default")
parser.add_option("--no_make_model",
                  action="store_true", dest="no_make_model", default=False,
                  help="Don't make simulation model, default: %default")
parser.add_option("--no_run_sim",
                  action="store_true", dest="no_run_sim", default=False,
                  help="Don't run simulation, default: %default")
parser.add_option("-m", "--make_image",
                  action="store_true", dest="make_image", default=False,
                  help="Generate the FPGA image, default: %default")
parser.add_option("--image_mode", dest="image_mode", default=None,
                  help="Mode in which the FPGA Image will be built, default: %default. Partial reconfiguration mode is the cloud mode. 'base' is the static code in Flash while 'action' is the dynamic code in FPGA.", metavar="<normal, cloud_base, cloud_action>")
parser.add_option("-c", "--clean",
                  action="store_true", dest="clean", default=False,
                  help="Clean the environment before running, default: %default")
parser.add_option("-v", "--verbose",
                  action="store_false", dest="verbose", default=False,
                  help="Print more message to the stdout")
parser.add_option("-i", "--interactive",
                  action="store_true", dest="interactive", default=False,
                  help="Don't use the interactive mode during the flow, default: %default")
parser.add_option("-o", "--ocse_root", dest="ocse_root", default=None,
                  help="Path to OCSE root. No default value.", metavar="DIRECTORY")
parser.add_option("-r", "--ocaccel_root", dest="ocaccel_root", default=os.path.abspath("."),
                  help="Path to ocaccel root, default: %default", metavar="DIRECTORY")
parser.add_option("-a", "--action_root", dest="action_root", default=None,
                  help="Path to ACTION root. No default value.", metavar="DIRECTORY")
parser.add_option("-s", "--simulator", dest="simulator", default=None,
                  help="Simulator used for simulation. No default value.", metavar="<nosim, xcelium, xsim>")
parser.add_option("-t", "--testcase", dest="testcase", default="terminal",
                  help="Testcase used for simulation, default: %default", metavar="STRING")
parser.add_option("--simulator_start_timeout", dest="sim_timeout", type="int", default=600,
                  help="How long we will wait for simulator to start (in seconds), default: %default")
parser.add_option("--make_timeout", dest="make_timeout", type="int", default=2592000,
                  help="How long we will wait for make model or make image to finish (in seconds), default: %default")
parser.add_option("--predefined_config", dest="predefined_config", default=None,
                  help="Predefined configurations used for configure phase. No default value.", metavar="check possible values in defconfig/")
parser.add_option("--unit_sim",
                  action="store_true", dest="unit_sim", default=False,
                  help="Run unit simulation for OC-ACCEL bridge test, no OCSE and software, only UVM based testbench included, default: %default")
parser.add_option("--odma",
                  action="store_true", dest="odma", default=False,
                  help="Use ODMA instead of TLX-AXI bridge. This flag only works in unit_sim mode, i.e., running odma in unit sim env. For general ODMA"
                  "enablement, please specify it in the configuration window. default: %default")
parser.add_option("--odma_mode", dest="odma_mode", default="mm_1024",
                  help="ODMA data path transfer type. default: %default.", metavar="<mm_1024, mm_512, st_1024, st_512>")
parser.add_option("--sv_seed", dest="sv_seed", default=str(random.randint(0, 0xffffffff)),
                  help="Seed used for system verilog, default: random", metavar="STRING")
parser.add_option("--unit_test", dest="unit_test", default="bfm_test_read_4k_write_4k",
                  help="Testcase used for unit_sim simulation, default: %default", metavar="STRING")
parser.add_option("--uvm_ver", dest="uvm_ver", default="UVM_LOW",
                  help="UVM_VERBOSITY for unit_sim simulation, default: %default", metavar="STRING")
parser.add_option("--no_wave",
                  action="store_true", dest="no_wave", default=False,
                  help="Don't dump waveform for simulation. default: %default")
(options, args) = parser.parse_args()

ocaccel_workflow_log = "./ocaccel_workflow.log"
ocaccel_workflow_make_model_log = "./ocaccel_workflow.make_model.log"
ocaccel_workflow_make_image_log = "./ocaccel_workflow.make_image.log"
ocaccel_workflow_make_cloud_base_image_log = "./ocaccel_workflow.make_cloud_base_image.log"
ocaccel_workflow_make_cloud_action_image_log = "./ocaccel_workflow.make_cloud_action_image.log"
if options.ocse_root is not None:
    options.ocse_root = os.path.abspath(options.ocse_root)
options.ocaccel_root = os.path.abspath(options.ocaccel_root)
if options.action_root is not None:
    options.action_root = os.path.abspath(options.action_root)
if options.image_mode is not None:
    options.image_mode = options.image_mode.lower()
    options.make_image = True 
if options.make_image is not None and options.image_mode is None:
    options.image_mode = "normal" 
if options.simulator is not None:
    options.simulator = options.simulator.lower()
if options.odma_mode is not None:
    options.odma_mode = options.odma_mode.lower()
# Unit sim has a dedicated config file, not configurable by user
if options.unit_sim == True:
    if options.odma == True:
        if options.odma_mode.lower() == "mm_1024":
            options.predefined_config = "hdl_unit_sim.odma.defconfig"
        elif options.odma_mode.lower() == "mm_512":
            options.predefined_config = "hdl_unit_sim.odma_mm_512.defconfig"
        elif options.odma_mode.lower() == "st_512":
            options.predefined_config = "hdl_unit_sim.odma_st_512.defconfig"
        elif options.odma_mode.lower() == "st_1024":
            options.predefined_config = "hdl_unit_sim.odma_st_1024.defconfig"
        else:
            options.predefined_config = "hdl_unit_sim.odma.defconfig"
    else:
        options.predefined_config = "hdl_unit_sim.bridge.defconfig"

if __name__ == '__main__':
    msg.ok_msg_blue("--------> WELCOME to IBM OpenCAPI Acceleration Framework")
    question_and_answer = qa.QuestionAndAnswer(options)

    question_and_answer.ask(qa.ask_clean_str)
    if options.clean:
        env_clean(ocaccel_workflow_log)

    cfg = Configuration(options)
    cfg.log = ocaccel_workflow_log
    question_and_answer.cfg = cfg
    question_and_answer.ask(qa.ask_configure_str)
    if not options.no_configure:
        cfg.configure()

    # In unit sim mode, all configurations are handled automatically, no need to update the cfg
    if not options.unit_sim:
        cfg.update_cfg()

    if not options.no_env_check:
        env_check(options)

    question_and_answer.ask(qa.ask_make_model_str)
    if not options.no_make_model and options.simulator.lower() != "nosim":
        make_model(ocaccel_workflow_make_model_log, options.make_timeout)
        # TODO: need to remove the following line if
        # 'make model` stops touching ocaccel_env.sh
        cfg.setup_ocaccel_env()

    question_and_answer.ask(qa.ask_run_sim_str)
    if not options.no_run_sim and options.simulator.lower() != "nosim":
        testcase_cmdline = options.testcase.split(" ")
        testcase_cmd = None
        testcase_args = None
        if len(testcase_cmdline) > 1:
            testcase_cmd = testcase_cmdline[0]
            testcase_args = " ".join(testcase_cmdline[1:])
        elif len(testcase_cmdline) == 1:
            testcase_cmd = testcase_cmdline[0]
            testcase_args = " "
        else:
            testcase_cmd = "terminal"
            testcase_args = " "

        sim = SimSession(simulator_name = options.simulator,\
                         testcase_cmd = testcase_cmd,\
                         testcase_args = testcase_args,\
                         ocse_root = options.ocse_root,\
                         ocaccel_root = options.ocaccel_root,\
                         sim_timeout = options.sim_timeout,\
                         unit_sim = options.unit_sim,\
                         sv_seed = options.sv_seed,\
                         unit_test = options.unit_test,\
                         uvm_ver = options.uvm_ver,\
                         wave = not options.no_wave
                        )
        import atexit
        atexit.register(sim.kill_process)

        sim.run()

    question_and_answer.ask(qa.ask_make_image_str)
    if options.make_image and options.image_mode.lower() == "normal":
        make_image(ocaccel_workflow_make_image_log, options)
    elif options.make_image and options.image_mode.lower() == "cloud_base":
        make_cloud_base(ocaccel_workflow_make_cloud_base_image_log, options)
    elif options.make_image and options.image_mode.lower() == "cloud_action":
        make_cloud_action(ocaccel_workflow_make_cloud_action_image_log, options)