General Settings

Owned by Copy Page Tree
Last updated: Mar 18, 2024 by W.ErberVersion comment
6 min read

Table of Contents

Session

General settings that control execution of CHARON-VAX belong to an object called "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

Parameterhw_model
TypeText 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:

set session hw_model="VAX_6610"

The models are:

  • MicroVAX_3100_Model_96

  • MicroVAX_3100_Model_98

  • MicroVAX_3600

  • MicroVAX_3900

  • MicroVAX_II

  • VAXserver_3600

  • VAXserver_3600

  • VAXserver_3600_128

  • VAXserver_3600_512

  • VAXserver_3900

  • VAXserver_3900_128

  • VAXserver_3900_512

  • VAX_4000_Model_106

  • VAX_4000_Model_108

  • VAX_4000_Model_700

  • VAX_4000_Model_705

  • VAX_6000_Model_310

  • VAXstation_4000_Model_90

  • VAX_6610

  • VAX_6620

  • VAX_6630

  • VAX_6640

  • VAX_6650

  • VAX_6660

configuration_name

Parameterconfiguration_name
TypeText string
Value

Name of CHARON-VAX instance (unique):

set session configuration_name="MSCDV1"

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:

MSCDV1-YYYY-MM-DD-hh-mm-ss-xxxxxxxxx.log

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

Parameterlog
TypeText 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 "General Settings#log_method" parameter.

(info) The "log_method" parameter is effective only when a single log file is specified, not a directory.

Example:

set session log="/charon/vax4106prod.log"

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 General Settings#log_file_size) and/or when the log file is older than a specified number of days (see General Settings#log_rotation_period).

(info) 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:

<configuration_name>-YYYY-MM-DD-hh-mm-ss-xxxxxxxxx.log

If the "configuration_name" parameter is omitted, the log file name will have the following format:

<hw_model>-YYYY-MM-DD-hh-mm-ss-xxxxxxxxx.log

where "xxxxxxxxx" is an increasing decimal integer, starting from 000000000 to separate log files with the same time of creation (in case the log is being created faster than one log file per second).

(warning) Only existing directory can be specified. If the directory specified does not exist, this will be considered as a flat file.

Example:

set session configuration_name="vax4106prod"

set session log="/charon/logs"

The execution of the virtual machine will create a log file, named /charon/logs/vax4106prod-2016-10-13-10-00-00-000000000.log (for example) and a symbolic link named /charon/logs/vax4106prod.log pointing to this file. The link will be updated when the log rotation will occur.

(info) Starting with version 4.11 build 204-11, log file numbering is implemented when log rotating is used: when starting the Charon emulator the first log file name will be like <configuration_name>-YYYY-MM-DD-hh-mm-ss-xxxxxxxxx.log where xxxxxxxxx will be 000000000, this number will increase with each log rotation to make it easier to find a log file set (1st log file at start + all its rotated files)n


log_method

Parameterlog_method
TypeText string
Value
  • "overwrite" (default)
  • "append"

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:

set session log="log.txt" log_method="append"

log_file_size

Parameterlog_file_size
TypeText string
ValueIf log rotation is enabled, the log_file_size parameter determines the log file size threshold at which the log is automatically rotated. Rotating log file size is multiple of 64K
  • "unlimited" or "0" (default) - the feature is disabled
  • "default" - default size is used (4Mb)
  • <size>[KMG] - size of the current log file in bytes with additional multipliers:
    • K - Kilobyte - multiply by 1024
    • M - Megabyte - multiply by 1024*1024
    • G - Gigabyte - multiply by 1024*1024*1024

Example 1:

set session log_file_size="default"

Example 2:

set session log_file_size=10M

(info) Minimum LOG File size is 64K, maximum is 1G. Setting size less than 64K effectively makes the LOG File unlimited.


log_rotation_period

Parameterlog_rotation_period
TypeText string
Value
  • "default" - default value, 7 days. This values is used even if the "log_rotation_period" is not specified.
  • "daily" or "1"
  • "weekly" or "7"
  • "never"
  • <N> - in N days where N is greater than 0

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.

Example 1:

set session log_rotation_period="weekly"

Example 2:

set session log_rotation_period=14

(info) If enabled the switching to next log file appears at midnight

log_flush_period

Parameterlog_flush_period
TypeNumeric
Value
  • <period-in-seconds>

Defines a period of flushing log to disk.

Default period is 60 seconds (it means that every minute log file is flushed to disk)

Examples:

set session log_flush_period=30


license_key_id

Parameter

license_key_id

TypeText 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 for a HASP license:

set session license_key_id = "1877752571,354850588,any"

Based on the presence of this parameter in the configuration file, CHARON behaves as follows:
 

  1. No keys are specified (the parameter is absent)
    CHARON performs an unqualified search for any suitable key in unspecified order. If no key is found, CHARON exits.

  2. One or many keys are specified
    CHARON performs a qualified search for a regular license key in the specified order. If it is not found, CHARON exits (if the keyword "any" is not set).

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.

Please note: 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.

Example for a VE license:

set session license_key_id = "VE://10.1.1.1:8083/1111-2222-3333-4444"

To configure a backup license server, add the backup license server information to the same line after the primary license server information:

set session license_key_id = "VE://<primary-licserv-IP-Address>[:<port>]/<passphrase>/, VE://<backup-licserv-IP-Address>[:<port>]/<passphrase>/"

license_id

Parameter

license_id

TypeText 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:

set session license_id = "2718281828,314159265"

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

Parameterlicense_key_lookup_retry
TypeText 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:

set session license_key_lookup_retry = "N [, T]"

where:

  • N - Number of retries looking for license key (or keys)
  • T - Time between retries in seconds. If not specified 60 seconds is used

Example 1:

set session license_key_lookup_retry = 1

If license key is not found during initial scan, do only one more attempt after 60 seconds.

Example 2:

set session license_key_lookup_retry = "1,30"

Same as above but retry in 30 seconds.

Example 3:

set session license_key_lookup_retry = "3,10"

If license key not found during initial scan, do 3 more attempts waiting 10 seconds between them.

Example 4:

set session license_key_lookup_retry = "5"

If license key is not found during initial scan, do 5 more attempts waiting 60 seconds between them.


affinity

Parameteraffinity
TypeText 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:

set session affinity="0, 2, 4, 6"

n_of_io_cpus

Parametern_of_io_cpus
TypeNumeric
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:

set session n_of_io_cpus=2

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"

<Go to top>


© Stromasys, 1999-2024  - All the information is provided on the best effort basis, and might be changed anytime without notice. Information provided does not mean Stromasys commitment to any features described.