XOCC (Xilinx OpenCL Compiler) Command Line Utility

The Xilinx® OpenCL™ Compiler (xocc) is a standalone command line utility for both compiling kernel accelerator functions and linking them with the SDAccel™ environment supported platforms. This section describes the xocc link and compile commands. All commands are provided in the following sections:

The first step in building any system is to select an acceleration platform supported by Xilinx or third-party providers and to compile a kernel accelerator function using the -c/--compile option. The default output name for the .xo file is a.xo; rename the file to reflect the kernel name.

The -c/--compile command syntax is as follows:

xocc -c --platform <platform_name> <kernel_source_file> -o <xo_kernel_name>.xo
TIP: OpenCL uses the kernel keyword within the OpenCL file to identify a kernel. For C/C++ kernels, you need to provide the kernel name by --kernel <kernel_name>.

The second step is to link one or more kernels into the platform to create the binary container xclbin file using the -l/--link option. The default output name for the xclbin file is a.xclbin; rename it as needed

The -l/--link command syntax is as follows: 

xocc -l --platform <platform_name> <xo_kernel1_name>.xo \ [<xo_kernel2_name>.xo ..] -o <xclbin_name>.xclbin

For a list of supported platforms, see the release notes for the product you are using:

IMPORTANT: All provided examples included in the SDAccel installation use the Makefile to compile OpenCL applications with xcpp and xocc commands that can be used as references for compiling user applications.

XOCC Common Options

IMPORTANT: Do not mix targets between compilation and linking. For instance do not compile with sw_emu and link with hw_emu.
Table 1. XOCC Common Options (For Compile and Link Modes)
Option Valid Values Description
--platform <arg> Name of supported acceleration platform by Xilinx or full path to .xpfm file that represents a platform. Required. The --platform option accepts either a platform name or alternatively an xpfm file name (using full or relative path) that represents the top level of a platform. This is needed when you use a platform that is not included by default in the SDAccel tool installation. Set the target Xilinx device. For example: 
--platform xilinx_vcu1525_dynamic_5_1

For a list of all supported platforms and devices, see the SDAccel Product Page.

When using a platform that is not included by default in the SDAccel tool installation, the .xpfm file that represents a platform should be provided using the full path.
--target <arg> [sw_emu | hw_emu | hw] Specifies a compile target. The compile target is specified with the --target <sw_emu....> option. The default compile target is hw_emu.
  • sw_emu: Software emulation
  • hw_emu: Hardware emulation
  • hw: Hardware

Default: hw
--output <arg> File name with .xo for compiling and .xclbin for linking, depending on xocc mode. Optional. Sets output file name. Default:
  • a.xo for compile mode
  • a.xclbin for link and build mode
--version N/A Prints the version and build information of XOCC.
--help N/A Prints help.
--kernel_frequency <arg> Frequency (MHz) of the kernel for single clock support. For multi-clock support, each clock ID and corresponding frequency must be entered.

For example, xocc --kernel_frequency 0:300|1:500.

 Sets a user-defined clock frequency (in MHz) for the kernel, overriding a default value from the hardware platform.

RTL kernels support multi-clock:

Syntax Example (overrides 1 clock)

  • xocc --kernel_frequency 300
  • xocc --kernel_frequency 0:300
  • DSA with one kernel clock: 300 MHz for KERNEL_CLK
  • DSA with two clocks: 300 MHz for DATA_CLK

Syntax Example 2 (overrides more than 1 kernel clock)

  • xocc --kernel_frequency 0:300|1:500

DSA with two clocks (+ RTL kernel with two clock ports):

  • 300 MHz for DATA_CLK and 500 MHz for KERNEL_CLK2
--profile_kernel <arg>

data:[ kernel_name | all ]:[ compute_unit_name | all ]:[ interface_name | all ](:[ counters | all ])

[ stall | exec ]:[ kernel_name | all ]:[ compute_unit_name | all ](:[ counters | all ])

Profiling DDR memory traffic for kernel and host.

The last field for trace value (counters or all) is optional. If not specified, the default value is all.

For [ stall | exec ], the interface_name field is not supported.

The stall option must be specified during xocc compile (-c) to direct HLS to enable stall signals before using this option during xocc link (-l).
--xp <arg> Refer to XP Parameters. Specifies detailed parameter and property settings in the Vivado® Design Suite used to implement the FPGA hardware. For example: 
--xp <kernel_name>:stream

Familiarity with the Vivado Design Suite is recommended to make the most use of these parameters.

For a complete description of the --xp option, see XP Parameters.
--debug N/A Generates code for debugging.
--message-rules <arg> Message rule file name Optional. Specifies a message rule file with message controlling rules. For more details, see Using the Message Rule File.
--save-temps N/A Saves intermediate files/directories created during the compilation and build process.
--report_dir <arg> Directory Specifies a report directory. If the --report option is specified, the default is to generate all reports in the current working directory (cwd).

If no report directory is specified, the tool saves the files to <cwd>/_x/reports.
--log_dir <arg> Directory Specifies a log directory. If the --log option is specified, the default is to generate the log file in the current working directory (cwd).

If no log directory is specified, the tool saves the files to <cwd>/_x/logs.
--temp_dir <arg> Directory Specifies a temp directory. If the --save-temps option is specified, the default is to create the temporary compilation and build files in the current working directory (cwd).

If no temp directory is specified, the tool saves the files to <cwd>/_x/reports.
--export_script N/A

Generates the Tcl script, <kernel_name>.tcl, used to execute Vivado HLS but halts before Vivado HLS starts. The expectation is for the script to be modified and used with the --custom_script option.

Not supported for –t sw_emu with OpenCL kernels.
--custom_script <arg> <kernel_name>:<path to kernel Tcl file> Intended for use with the <kernel_name>.tcl file generated with --export_script.

This option allows you to customize the Tcl file used to create the kernel and execute using the customize version of the script.

<input file> OpenCL or C/C++ kernel source file, or Xilinx object file (.xo). For Compile mode, the input file consist of OpenCL or C/C++ kernel source files. For Link mode, the input files consists of one or more Xilinx object files (a.xo).
--user_ip_repo_paths <arg> <directory> Specifies the directory location of the existing user IP repository. This value is prefixed to ip_repo_paths.

Using this switch, specify one or more IP repository paths to be given highest priority by placing these paths at the beginning of the overall IP_REPO_PATHS property for the underlying Vivado project. IP definitions from any of these specified paths are used ahead of IP repositories from the hardware platform (.dsa) or from the Xilinx catalog.

Multiple --user_ip_repo_paths can be specified.

The following lists show the priority order in which IP definitions are found during SDx™ compilation flows (High to Low). Note that all of these entries can possibly include multiple directories in them.

  • For HW flow:
    1. IP definitions from --user_ip_repo_paths switch
    2. Kernel IP definitions (vpl --iprepo switch value)
    3. IP definitions from DSA IP repo
    4. IP cache dir from Install area (for example, <SDxInstall>/SDx/2018.3/data/cache/)
    5. IP cache stored inside DSA
    6. SDx specific Xilinx IPs from install area (for example, <SDxInstall>/SDx/2018.3/data/ip/)
    7. General Xilinx IP catalog from install area (for example,<SDxInstall>/Vivado/2018.3/data/ip/)
  • For HW EMU flow:
    1. IP definitions from --user_ip_repo_paths switch
    2. User emulation ip repository (for example, $::env(SDX_EM_REPO))
    3. Kernel IP definitions (vpl --iprepo switch value)
    4. IP cache dir from Install area (for example,<SDxInstall>/SDx/2018.3/data/cache/)
    5. IP cache stored inside DSA
    6. $::env(XILINX_SDX)/data/emulation/hw_em/ip_repo
    7. $::env(XILINX_VIVADO)/data/emulation/hw_em/ip_repo
    8. SDx Specific Xilinx IPs from install area (for example, <SDxInstall>/SDx/2018.3/data/ip/)
    9. General Xilinx IP catalog from install area (for example, <SDxInstall>/Vivado/2018.3/data/ip/)
--remote_ip_cache <arg> <directory> Specifies remote IP cache directory for Vivado synthesis.
--no_ip_cache N/A Turns off IP cache for Vivado synthesis.
--report_level <arg> Valid report levels: 0, 1,2, estimate.

Example: -R2

 These report levels have mappings kept in the optMap.xml file. You can override the installed optMap.xml to define custom report levels.
  • (Default) The -R0 specification turns off all intermediate DCP generation during Vivado implementation. Turns on post route timing report generation.
  • The -R1 specification turns on everything -R0 does, plus report_failfast pre-opt_design, report_failfast post-opt_design, and all intermediate DCP generation.
  • The -R2 specification turns on everything -R1 does, plus it adds report_failfast post-route_design.
  • The -Restimate specification forces the Vivado HLS tools to generate a design.xml datafile if it does not exist, to generate an estimate report. This option is useful for software emulation target, when design.xml is not generated by default.
--ini_file <arg> <path_to_file> Reads in XP switches from file in xocc.ini format. This might be used multiple times for multiple files. These take priority over xocc.ini files found in default locations, but explicit --xp command line switches still take priority over those found in the specified file.
--interactive <arg> [ synth | impl ] xocc configures necessary environment and launches the Vivado toolset with either synthesis or implementation project.

XOCC Options for Compile Mode

Table 2. XOCC Options for Compile Mode
Option Valid Values Description
--compile N/A Required, but mutually exclusive with --link.

Run xocc in compile mode,generate .xo file.
--kernel <arg> Kernel to be compiled from the input .cl or .c/.cpp kernel source code. Required for C/C++ kernels. Optional for OpenCL kernels.

Compile/build only the specified kernel from the input file. Only one -k option is allowed per command.

When an OpenCL kernel is compiled without the -k option, all the kernels in the input file are compiled.
--define <arg> Valid macro name and definition pair.

<name>=<definition>

 Pre-define name as a macro with definition. This option is passed to the xocc pre-processor.
--include <arg> Directory name that includes required header files. Adds the directory to the list of directories to be searched for header files. This option is passed to the SDAccel compiler preprocessor.
--max_memory_ports <arg> all | <kernel_name> Valid for OpenCL kernels.

Sets the maximum memory ports for all kernels or for a given <kernel name>.
--memory_port_data_width <arg> all | <kernel_name>:<number> Valid for OpenCL kernels.

Sets the memory port data width to the <number> for all kernels or for a given <kernel name>.
--export_hls_project  

Specify a directory where a HLS project set-up script is exported
--hls_export_mode Valid file types include:
  • xo
  • tcl

<file_type>:<file_path> Set an export mode from HLS with the path to an exported file.

XOCC Options for Link Mode

Table 3. XOCC Options for Link Mode
Option Valid Values Description
--optimize <arg> Valid optimization levels: 0, 1, 2, 3, s, quick.

example: --optimize2

This option ONLY applies to Vivado. The compile step runs the C code through HLS and has no bearing.

 These options control the default optimizations performed by the Vivado hardware synthesis engine.

Familiarity with the Vivado tool suite is recommended to make better use of these settings.

  • 0: Default optimization. Reduce compilation time and make debugging produce the expected results.
  • 1: Optimize to reduce power consumption. This takes more time to compile the design.
  • 2: Optimize to increase kernel speed. This option increases both compilation time and the performance of the generated code.
  • 3: This is the highest level of optimization. This option provides the highest level performance in the generated code, but compilation time might increase considerably.
  • s: Optimize for size. This reduces the logic resources for the kernel
  • quick: Quick compilation for fast run time. This might result in reduced hardware performance, and a greater use of resources in the hardware implementation.
user_board_repo_paths  

Specify existing user board repository for DIMM board files. This value will be appended to board_part_repo_paths
--clkid  

Select an index available from SoC platform. Each index has a different default. clock frequency
--board_connection  

<DIMM_connector:vbnv_of_DIMM_board> Specify a dual in-line memory module (DIMM) board file for each DIMM connector slot.
-l / --link N/A Required, but mutually exclusive with --compile.

Run xocc in link mode. Link .xo input files, generate .xclbin file.
--nk <arg>
For example: 
foo:2
<kernel_name:number(:compute_unit_name1.compute_ unit_name2...)>
For example:
foo:3:fooA.fooB.fooC
 This option instantiates the specified number of compute units for the given kernel in the <kernel_name:number>.xclbin file.

The compute unit (CU) name is optional. If the CU name is not specified, the instances of the kernel are simply numbered: kernel_name_1, kernel_name_2, and so forth.

<By default, the XOCC instantiates one compute unit for each kernel.

Optional in link mode. Not applicable in compile mode.
--jobs <arg> Number of parallel jobs. Optional. This option allows detailed control of the Vivado Design Suite used to implement the FPGA hardware.

Familiarity with the Vivado Design Suite is recommended to make the most use of this option.

Specifies the number of parallel jobs to be passed to the Vivado Design Suite for implementation. Increasing the number of jobs allows the hardware implementation step to spawn more parallel processes and complete faster.
--lsf <arg> bsub command line to pass to LSF cluster.

This argument is required for use with --lsf.

 Optional. Use IBM Platform Load Sharing Facility (LSF) for Vivado implementation and synthesis. For example: --lsf '{bsub -R "select[type=X86_64]" -N -q medium}'
--reuse_impl <Implemented DCP> Imports an implemented DCP and runs only the XCLBIN packaging.
--dk <arg> <[protocol|chipscope|list_ports]:<compute_unit_name>:<interface_name>>
Where:
  • <interface_name> is optional. If not specified, all ports are expected to be analyzed.
  • The chipscope option requires the explicit name of the compute unit to be provided for the <compute_unit_name> and <interface_name>.
  • The protocol option can accept a special keyword "all" for <compute_unit_name> and for <interface_name>. The chipscope option can not accept this keyword "all."
  • The list_ports option shows a list of valid compute units and port combinations in the current design.
 Enables debug IP core insertion. Allows you to specify which compute unit interfaces to monitor with chipscope. This is useful for hardware debugging.

The System ILA debug core provides transaction level visibility into an accelerated kernel or function running on hardware. AXI traffic of interest can also be captured and viewed using the System ILA core.

The --dk option allows you to attach System ILA cores at the interfaces to the kernels for debugging and performance monitoring purposes.
--slr <compute_unit_name>:<SLR_NUM>
Where:
  • <compute_unit_name> is the name of the compute unit as specified in the --nk option. Generally this will be <kernel_name> unless a different name was specified.
  • <SLR_NUM> is the SLR number to which the CU is assigned. For example, SLR0, SLR1.
  • The option must be repeated for each kernel or CU being assigned.

Use --slr to assign a Compute Unit (CU) to an SLR..

For example, to assign CU vadd_2 to SLR2, and CU fft_1 to SLR1, you would use the following: 

--slr vadd_2:SLR2 
--slr fft_1:SLR1
IMPORTANT: If you use --slr to assign the kernel placement, then you must also use --sp to assign memory access for the kernel.
--sp <arg>

Starting in release 2018.3, memory resource are specified using vector formatting with the resource item enclosed in square brackets (that is, [..] ). For example, the DDR memory resource names of a device with four (4) DDR banks are specified at DDR[0], DDR[1], DDR[2], and DR[3]. PLRAM is specified in a similar fashion. While release 2018.3 supports the legacy sptag names (that is, bank<n>) for platforms available in 2018.2.xdf and any associated updates in 2018.3, this support will be deprecated in subsequent releases. All new platforms in 2018.3, however, do not support legacy sptag names and require the vector syntax format.

 <compute_unit_name>.<kernel_interface_name>:<sptag[min:max]>
Where:
  • <compute_unit_name> is the name of the compute unit as specified in the --nk option. Generally this will be <kernel_name> unless a different name was specified.

  • <kernel_interface_name> is the name of the function argument for the kernel, or compute unit port.

  • <sptag> represents a memory resource name from the target platform. Valid <sptag> names include DDR, PLRAM, and HBM.
  • [min:max] enables the use of a range of memory, such as DDR[0:2]. A single index is also supported: DDR[2].
TIP: The supported <sptag> and range of memory resources for a target platform can be obtained using the platforminfo command. Refer to platforminfo Utility for more information.

Use the system port option (--sp to connect a kernel interface, or CU, to a specific type and range of memory resources.

Multiple --sp options can be specified to map each of a kernel's interfaces to a particular memory resource.

In absence of --sp option, the XOCC linker will attempt to connect the kernel interfaces to a memory resource in the same SLR

The following example maps the input arguments (A and B) for the specified CU of the VADD kernel to DDR[0:3], and writes the output argument (C) to PLRAM[2]:
--sp vadd_1.A:DDR[0:3]
--sp vadd_1.B:DDR[0:3]
--sp vadd_1.C:PLRAM[2]
--sys_config <arg> Valid value is ocl Specifies a system configuration setting for SoC platforms. Valid value is ocl.

In platform spfm file, the configuration section should contain sdx:runtimes = "ocl."

XP Parameters

When compiling or linking, fine grain control over the hardware generated by the SDAccel tools and the hardware emulation process can be specified by using the --xp switch.

The –-xp switch is paired with parameters to configure the Vivado tools. For instance, the switch --xp can configure optimization, placement and timing, or set up emulation and compile options. Specific examples of these parameters include setting the clock margin, specifying the depth of FIFOs used in the kernel dataflow region, and specifying the number of outstanding writes and reads to buffer on the kernel AXI interface.

IMPORTANT: Familiarity with the Vivado Design Suite is required to make the most use of these parameters. See Vivado Design Suite User Guide: High-Level Synthesis (UG902) and Vivado Design Suite User Guide: Implementation (UG904) for more information.

Parameters are specified as parm:<param_name>=<value>. For example:

xocc -–xp param:compiler.enableDSAIntegrityCheck=true 
–xp param:prop:kernel.foo.kernel_flags="-std=c++0x"

You can specify the -–xp command option multiple times in a single xocc invocation or specify the value(s) in an xocc.ini file with each option specified on a separate line without --xp switch.

param:prop:solution.device_repo_paths=../dsa
param:compiler.preserveHlsOutput=1

Upon invocation, xocc first looks for an xocc.ini file in the $HOME/.Xilinx/sdx directory. If the file does not exist, then xocc looks for it in the current working directory. If the same --xp parameter value is specified in both the command line and xocc.ini file, the command line value is used.

The following table lists a sample of the -–xp parameters and their values.

Table 4. XP Parameter Options
Parameter Name Valid Values Description
param:compiler.acceleratorBinaryContent Type: String

Default Value: <empty>

 Content to insert in xclbin. Valid options are bitstream and dcp.
param:compiler.​errorOnHoldViolation Type: Boolean

Default Value: TRUE

 Error out if there is hold violation.
param:compiler.​maxComputeUnits Type: Int

Default Value: -1

 Maximum compute units allowed in the system. Any positive value will overwrite the numComputeUnits setting in the hardware platform (.dsa). The default value of -1 preserves the setting in the DSA.
param:hw_em.​compiledLibs Type: String

Default Value: <empty>

 Uses mentioned clibs for the specified simulator.
param:hw_em.platformPath <absolute_path_of_custom_platform_directory> Type: String

Default Value: <empty>

 Specifies the path to the custom platform directory. The <platformPath> directory should meet the following requirements to be used in platform creation:
  • The directory should contain a subdirectory called ip_repo.
  • The directory should contain a subdirectory called scripts and this scripts directory should contain a hw_em_util.tcl file. The hw_em_util.tcl file should have following two procedures defined in it:
    • hw_em_util::add_base_platform
    • hw_em_util::generate_simulation_scripts_and_compile
param:hw_em.​enableProtocolChecker Type: Boolean

Default Value: FALSE

 Enables the lightweight AXI protocol checker (lapc) during HW emulation. This is used to confirm the accuracy of any AXI interfaces in the design.
param:compiler.​xclDataflowFifoDepth Type: Int

Default Value: -1

 Specifies the depth of FIFOs used in kernel data flow region.
param:compiler.​interfaceWrOutstanding Type: Int Range

Default Value: 0

 Specifies how many outstanding writes to buffer are on the kernel AXI interface. Values are 1 through 256.
param:compiler.​interfaceRdOutstanding Type: Int Range

Default Value: 0

 Specifies how many outstanding reads to buffer are on the kernel AXI interface. Values are 1 through 256.
param:compiler.​interfaceWrBurstLen Type: Int Range

Default Value: 0

 Specifies the expected length of AXI write bursts on the kernel AXI interface. This is used with option compiler.interfaceWrOutstanding to determine the hardware buffer sizes. Values are 1 through 256.
param:compiler.​interfaceRdBurstLen Type: Int Range

Default Value: 0

 Specifies the expected length of AXI read bursts on the kernel AXI interface. This is used with option compiler.interfaceRdOutstanding to determine the hardware buffer sizes. Values are 1 through 256.
misc:map_connect=<type>.​kernel.<kernel_name>.​ <kernel_AXI_interface>.​core.​ OCL_REGION_0.<dest_port> Type: String

Default Value: <empty>

 Used to map AXI interfaces from a kernel to DDR memory banks.
  • <type> is add or remove.
  • <kernel_name> is the name of the kernel.
  • <dest_port> is a DDR memory bank M00_AXI, M01_AXI, M02_AXI, or M03_AXI.

This option is available only for DSA 4.x and earlier and deprecated for DSA 5.x and later. Use system ports using the --sp option documented in XOCC Options for Link Mode.
prop:kernel.<kernel_name>.​kernel_flags Type: String

Default Value: <empty>

 Sets specific compile flags on the kernel <kernel_name>.
prop:solution.​device_repo_path Type: String

Default Value: <empty>

 Specifies the path to a repository of hardware platforms. The --platform option with full path to the .xpfm platform file should be used instead.
prop:solution.​hls_pre_tcl Type: String

Default Value: <empty>

 Specifies the path to a Vivado HLS Tcl file, which is executed before the C code is synthesized. This allows Vivado HLS configuration settings to be applied prior to synthesis.
prop:solution.​hls_post_tcl Type: String

Default Value: <empty>

 Specifies the path to a Vivado HLS Tcl file, which is executed after the C code is synthesized.
prop:solution.​kernel_compiler_margin Type: Float

Default Value: 12.5% of the kernel clock period.

 The clock margin (in ns) for the kernel. This value is subtracted from the kernel clock period prior to synthesis to provide some margin for P&R delays.
vivado_prop:<object_type>. ​<object_name>.<prop_name> Type: Various

Default Value: Various

 This allows you to specify any property used in the Vivado hardware compilation flow.

<object_type> is run|fileset|file|project.

The <object_name> and <prop_name> values are described in Vivado Design Suite Properties Reference Guide (UG912).

Examples:
vivado_prop:run.impl_1.
{STEPS.PLACE_DESIGN.ARGS.MORE 
OPTIONS}={-fanout_opt}
vivado_prop:fileset.
current.top=foo

If <object_type> is set to file, current is not supported.

If <object type> is set to run, the special value of __KERNEL__ can be used to specify run optimization settings for ALL kernels, instead of the need to specify them one by one.

Using the Message Rule File

XOCC executes various Xilinx tools during kernel compilation. These tools generate many messages that provide compilation status to you. These messages might or might not be relevant to you depending on your focus and design phases. A Message Rule file can be used to better manage these messages. It provides commands to promote important messages to the terminal or suppress unimportant ones. This helps you better understand the kernel compilation result and explore methods to optimize the kernel.

The Message Rule file (.mrf) is a text file consisting of comments and supported commands. Only one command is allowed on each line.

Comment

Any line with “#” as the first non-white space character is a comment.

Supported Commands

By default, xocc recursively scans the entire working directory and promotes all error messages to the xocc output. The promote and suppress commands below provide more control on the xocc output.

  • promote: This command indicates that matching messages should be promoted to the xocc output.
  • suppress: This command indicates that matching messages should be suppressed or filtered from the xocc output. Note that errors cannot be suppressed.

Command Options

The Message Rule file can have multiple promote and suppress commands. Each command can have one and only one of the options below. The options are case-sensitive.

  • -id [<message_id>]: All messages matching the specified message ID are promoted or suppressed. The message ID is in format of nnn-mmm. As an example, the following is a warning message from HLS. The message ID in this case is 204-68.
    WARNING: [XOCC 204-68] Unable to enforce a carried dependence constraint (II = 1, distance = 1, offset = 1) 
between bus request on port 'gmem' 
(/matrix_multiply_cl_kernel/mmult1.cl:57) and bus request on port 'gmem'-severity [severity_level]

    For example, to suppress messages with message ID 204-68, specify the following: suppress -id 204-68.

  • -severity [<severity_level>]: The following are valid values for the severity level. All messages matching the specified severity level will be promoted or suppressed.
    • info
    • warning
    • critical_warning

      For example, to promote messages with severity of 'critical-warning', specify the following: promote -serverity critical_warning.

Precedence of Message Rules

The suppress rules take precedence over promote rules. If the same message ID or severity level is passed to both promote and suppress commands in the Message Rule file, the matching messages are suppressed and not displayed.

Example of Message Rule File

The following is an example of a valid Message Rule file:

# promote all warning, critical warning
promote -severity warning
promote -severity critical_warning
# suppress the critical warning message with id 19-2342
suppress -id 19-2342