com.xilinx.rapidwright.util

Class Params

Object

com.xilinx.rapidwright.util.Params

public class Params
extends Object

Aims to be a centralized helper class to manage global RapidWright settings.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	RW_DECOMPRESS_GZIPPED_EDIF_TO_DISK Flag to have RapidWright decompress gzipped EDIF files to disk prior to parsing.
static String	RW_DECOMPRESS_GZIPPED_EDIF_TO_DISK_NAME
static boolean	RW_DISABLE_WRITING_ADV_FLOW_DCPS Flag to disable RapidWright from writing any DCPs that target Vivado's Advanced Flow (starting in Vivado 2024.2).
static String	RW_DISABLE_WRITING_ADV_FLOW_DCPS_NAME
static boolean	RW_WRITE_DCP_2024_1 Flag to have RapidWright write out DCPs such that they will only be readable in Vivado 2024.1 and later.
static String	RW_WRITE_DCP_2024_1_NAME
static int	RW_ZSTD_COMPRESSION_LEVEL ZStandard compression effort level to use when compressing files.
static String	RW_ZSTD_COMPRESSION_LEVEL_NAME
static int	RW_ZSTD_DEFAULT_COMPRESSION_LEVEL

Constructor Summary

Constructors

Constructor and Description
Params()

Method Summary

Modifier and Type	Method and Description
static Integer	getParamIntValue(String key) Gets the integer value of the provided parameter name.
static int	getParamOrDefaultIntSetting(String key, int defaultValue) Checks the parameter value of the provided key.
static String	getParamValue(String key) Gets the string value of the provided parameter name.
static boolean	isParamSet(String key) Checks if the named RapidWright parameter is set via an environment variable or by a JVM parameter of the same name.
static boolean	isSet(String value) Checks if a parameter is set by examining the provided value.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RW_DECOMPRESS_GZIPPED_EDIF_TO_DISK_NAME

public static String RW_DECOMPRESS_GZIPPED_EDIF_TO_DISK_NAME

RW_ZSTD_COMPRESSION_LEVEL_NAME

public static String RW_ZSTD_COMPRESSION_LEVEL_NAME

RW_ZSTD_DEFAULT_COMPRESSION_LEVEL

public static int RW_ZSTD_DEFAULT_COMPRESSION_LEVEL

RW_WRITE_DCP_2024_1_NAME

public static String RW_WRITE_DCP_2024_1_NAME

RW_DISABLE_WRITING_ADV_FLOW_DCPS_NAME

public static String RW_DISABLE_WRITING_ADV_FLOW_DCPS_NAME

RW_DECOMPRESS_GZIPPED_EDIF_TO_DISK

public static boolean RW_DECOMPRESS_GZIPPED_EDIF_TO_DISK

Flag to have RapidWright decompress gzipped EDIF files to disk prior to parsing. This is a tradeoff where pre-decompression improves runtime over the default method which is to decompress in memory. The disadvantage is that this will temporarily consume ~18x more disk space than original gzipped EDIF file, but loading of the EDIF file will be ~2x faster.

RW_ZSTD_COMPRESSION_LEVEL

public static int RW_ZSTD_COMPRESSION_LEVEL

ZStandard compression effort level to use when compressing files. This can range from -7 to 22, with higher numbers producing a more compact result for more runtime.

RW_WRITE_DCP_2024_1

public static boolean RW_WRITE_DCP_2024_1

Flag to have RapidWright write out DCPs such that they will only be readable in Vivado 2024.1 and later. The advantage is that these DCPs will be read in faster and will provide better support for the largest devices.

RW_DISABLE_WRITING_ADV_FLOW_DCPS

public static boolean RW_DISABLE_WRITING_ADV_FLOW_DCPS

Flag to disable RapidWright from writing any DCPs that target Vivado's Advanced Flow (starting in Vivado 2024.2). By default, RapidWright writes DCPs targeting Versal devices with the Advanced Flow compatibility flag set to true.

Constructor Detail

Params

public Params()

Method Detail

isParamSet

public static boolean isParamSet(String key)

Checks if the named RapidWright parameter is set via an environment variable or by a JVM parameter of the same name.

Parameters:

key - Name of the global RapidWright parameter

Returns:

True if the parameter is set (as defined by Params.isSet(String)), false otherwise

isSet

public static boolean isSet(String value)

Checks if a parameter is set by examining the provided value.

Parameters:

value - An environment variable or JVM parameter value

Returns:

True if (1) value is not null, (2) is not an empty string, (3) is not 0 and (4) is not false (case-insensitive).

getParamIntValue

public static Integer getParamIntValue(String key)

Gets the integer value of the provided parameter name.

Parameters:

key - Name of the system parameter to get.

Returns:

The set integer value of the parameter, or null if none was set. If the property is set to a value that is not a parsable integer, a warning message is produced and returns null.

getParamValue

public static String getParamValue(String key)

Gets the string value of the provided parameter name.

Parameters:

key - Name of the system parameter to get.

Returns:

The set string value of the parameter, or null if none was set.

getParamOrDefaultIntSetting

public static int getParamOrDefaultIntSetting(String key,
                                              int defaultValue)

Checks the parameter value of the provided key. If it is set, it returns the set value. Otherwise it will return the default value.

Parameters:

key - Name of the system parameter to check.

defaultValue - The default value to return if the paramter is not set.

Returns:

The system parameter value if is set, otherwise it returns defaultValue.