Table of Contents
Session
General settings that control execution of CHARON-VAX belong to an object callled "session". It is a preloaded object; therefore, only "set" commands apply.
Example:
set session <parameter>=<value> |
The following tables describe all available "session" parameters, their meaning and examples of usage:
hw_model
Parameter | hw_model | |
---|---|---|
Type | Text string | |
Value | Virtual VAX system hardware model to be emulated. Use a default configuration template for each particular model as a starting point for a custom configuration. This would ensure that the parameter is set correctly. Example:
The models are:
|
configuration_name
Parameter | configuration_name | ||
---|---|---|---|
Type | Text string | ||
Value | Name of CHARON-VAX instance (unique):
The value of this parameter is used as prefix to the event log file name when multiple log files are configured (see below). From the example above, the CHARON-VAX log file will have the following name:
xxxxxxxxx is an increasing decimal number starting from 000000000 to separate log files with the same time of creation (in case the log is being written faster than one log file per second). |
log
Parameter | log | ||||
---|---|---|---|---|---|
Type | Text string | ||||
Value | The log file or directory name is where the log file for each CHARON-VAX execution session is stored. Log specified as a file name It is possible to overwrite the existing log file or to extend it using the "log_method" parameter. The "log_method" parameter is effective only when a single log file is specified, not a directory. Example:
Log specified as a directory CHARON-VAX automatically creates individual log files for each CHARON-VAX execution session. If the log parameter is omitted, CHARON-VAX creates a log file for each CHARON-VAX execution session in the directory where the emulator was started. In these two cases, the log rotation mode is enabled, meaning a new log file is created each time the virtual machine is started and when the log file size exceeds the one specified (see log_file_size) and/or when the log file is older than a specified number of days (see log_rotation_period). A symbolic link located in the same directory will be created, pointing to the active log file. Its name is based on the hw_model parameter or the configuration_name parameter if specified. If the "configuration_name" parameter of the session is specified, the log file name is composed as follows:
If the "configuration_name" parameter is omitted, the log file name will have the following format:
where " Only existing directory can be specified. If the directory specified does not exist, this will be considered as a flat file. Example:
The execution of the virtual machine will create a log file, named |
log_method
Parameter | log_method | |
---|---|---|
Type | Text string | |
Value |
Determines if previous log information is maintained. This parameter must be specified only in addition to “log” parameter on the same line. This parameter is applicable only if the CHARON-VAX log is stored in a file that is specified explicitly with the "log" parameter. Example:
|
log_file_size
Parameter | log_file_size | ||
---|---|---|---|
Type | Text string | ||
Value | If log rotation is enabled, the log_file_size parameter determines the log file size threshold at which the log is automatically rotated.
Examples:
Minimum LOG File size is 64K, maximum is 1G. Setting size less then 64K effectively makes the LOG File unlimited. |
log_rotation_period
Parameter | log_rotation_period | ||
---|---|---|---|
Type | Text string | ||
Value |
If the rotation log mode is enabled this parameter controls switching to next log file based on period of time passed. If enabled the switching to next log file appears at midnight. Examples:
If enabled the switching to next log file appears at midnight |
license_key_id
Parameter | license_key_id | |
---|---|---|
Type | Text string | |
Value | A set of Sentinel Key IDs that specifies the license keys to be used by CHARON. It is also possibly to use a keyword "any" to force CHARON to look for suitable license in all available keys if the license is not found in the specified keys. Example:
Based on the presence of this parameter in the configuration file, CHARON behaves as follows:
If the keyword "any" is specified then if no valid license has been found in the keys with specified ID’s all other available keys are examined for valid license as well. The order in which keys are specified is very important. If a valid license was found in the key which ID was not the first one specified in configuration file, then available keys are periodically rescanned and if the key with the ID earlier in the list than the current one is found CHARON tries to find a valid license there and in case of success switches to that key. |
license_id
Parameter | license_id | |
---|---|---|
Type | Text string | |
Value | A set of license identifiers that specifies the licenses to be used by CHARON. This parameter is applicable only to licenses on which Stromasys placed restrictions on what products can be combined on a single license key. Please contact your Stromasys representative or VAR for more information. Example:
If this parameter is set, Charon considers for validation only the available licenses with license ID parameter set and equal to one of the license ID's specified in the configuration. This prioritized list corresponds to the "Product License Number" line in the Product section of the license. |
license_key_lookup_retry
Parameter | license_key_lookup_retry | |||||
---|---|---|---|---|---|---|
Type | Text String | |||||
Value | In case the CHARON-VAX license connection is not present at guest statup, this parameter specifies how many times CHARON-VAX will try to reestablish the connection and, optionally, a period of time between retries. Syntax:
where:
Example 1
If license key is not found during initial scan, do only one more attempt after 60 seconds. Example 2
Same as above but retry in 30 seconds. Example 3
If license key not found during initial scan, do 3 more attempts waiting 10 seconds between them. Example 4
If license key is not found during initial scan, do 5 more attempts waiting 60 seconds between them. |
affinity
Parameter | affinity | |
---|---|---|
Type | Text string | |
Value | Overrides any initial process affinity mask provided by the host operating system. Once specified it binds the running instance of the emulator to particular host CPUs.Can be used for soft partitioning host CPU resources and/or for isolating host CPUs for other applications.By default CHARON-VAX emulator instance allocates as many host CPUs as possible. The “affinity” parameter overrides that and allows explicit specification on which host CPU the instance must run. The "affinity" parameter defines the total number of host CPUs to be used both for emulated VAX CPUs and for CHARON-VAX / CHARON-PDP application itself (including the CPUs to be used for I/O - they are controlled by "n_of_io_cpus" parameter described below). Host CPUs are enumerated as a comma separated list of host system assigned CPU numbers:
|
n_of_io_cpus
Parameter | n_of_io_cpus | |
---|---|---|
Type | Numeric | |
Value | This parameter specifies how many host CPUs CHARON-VAX must use for I/O handling. Use of the “affinity” parameter may limit the number of CPUs available.By default the CHARON-VAX instance reserves one third of available host CPUs for I/O processing (round down, at least one). The “n_of_io_cpus” parameter overrides that by specifying the number of CHARON I/O CPUs explicitly. Example:
|
File inclusion
It is possible to include a configuration file into an existing one using the "include
" command. File extension is usually .icfg
.
Format:
include "file.icfg" |
Example:
include "/charon/commonpart.icfg" |