General Settings

Owned by Copy Page Tree
Last updated: Feb 13, 2024 by W.ErberVersion comment

Table of Contents

Session

General settings that control the execution of Charon-VAX / Charon-PDP belong to an object called the "session". It is a preloaded object; therefore, only "set" commands are necessary. 

Example:

set session <parameter>=<value>


The following table describes all available "session" parameters, their meaning and examples of their usage:


hw_model

Parameter

hw_model

Type

Text string, case sensitive

Value

Virtual VAX/PDP11 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"

Available models are:

  • PDP_1193

  • PDP_1194
  • 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

Parameter

configuration_name

Type

Text string

Value

Name of the Charon-VAX / Charon-PDP instance (it must be unique):

set session configuration_name="MSCDV1"

(warning)  In provided templates this parameter is specified in the included configuration file "configuration_name.icfg".

The value of this parameter is used as a prefix to the event log file name (see below).

From the example above, the Charon-VAX / Charon-PDP 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).

(warning) It is strictly recommended to use the "configuration_name" parameter if more than one Charon instance runs on the same server.


log

Parameterlog
TypeText string
Value

The log file or directory name is where the log file for each Charon-VAX / Charon-PDP 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="C:\Charon\vax4106prod.log"

Log specified as a directory

Charon-VAX / Charon-PDP automatically creates individual log files for each Charon-VAX / Charon-PDP execution session. If the log parameter is omitted, Charon-VAX / Charon-PDP creates a log file for each Charon-VAX / Charon-PDP 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 shortcut 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. No trailing backslash character is allowed.

Example:

set session configuration_name="vax4106prod"

set session log="C:\Charon\Logs"

The execution of the virtual machine will create a log file, named C:\Charon\Logs\vax4106prod-2016-10-13-10-00-00-000000000.log (for example) and a shortcut named C:\Charon\Logs\vax4106prod.log pointing to this file. The shortcut 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)

<Go to top>


log_method

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

Determines if the previous log information is maintained or overwritten.

This parameter can only be specified in addition to the “log” parameter on the same line.

This parameter is applicable only if the Charon-VAX / Charon-PDP log is stored to a file that is specified explicitly with the "log" parameter.

Example:

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

log_show_messages

Parameterlog_show_messages
TypeText string
Value
  • "all" (default)
  • "info"
  • "warning"
  • "error"

Defines the message types to be shown. The parameter is a string of comma delimited words.

Example:

set session log_show_messages="error, warning"

<Go to top>


log_file_size

Parameterlog_file_size
TypeText 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. 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 a size less than 64K effectively makes the log file size unlimited.

log_rotation_period

Parameterlog_rotation_period
TypeText string
Value
  • "default" - default value, 7 days. This value 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 the next log file based on a period of time. If enabled, the switching to the next log file occurs at midnight.

Example 1:

set session log_rotation_period="weekly"

Example 2:

set session log_rotation_period=14

<Go to top>


log_repeat_filter

Parameterlog_repeat_filter
TypeText string
Value

Specifies if repeated messages should be filtered or not. Possible values are "on" and "off" (default).

If the value is "on", immediately following messages with the same identifier and system error code are not listed in the log but they are counted. When a different log message is generated, the repeat count of the earlier log message is reported with the entry "The previous message has been repeated N times." and the counter is cleared.

(warning) Stromasys highly recommends to let this value to "off" otherwise important information will not be reported in the log file.

Example:

set session log_repeat_filter="off"

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 a suitable license in all available keys if the license is not found in the specified keys.

Example:

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 that 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 re-scanned 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

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.

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.

Used for soft partitioning of the host CPU resources and/or for isolating host CPUs for other applications.

By default the Charon-VAX / Charon-PDP 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 on.

The "affinity" parameter defines the total number of host CPUs to be used both for emulated VAX CPUs and for the Charon VM itself (including the CPUs to be used for I/O - they are controlled by the "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"

<Go to top>


n_of_io_cpus

Parametern_of_io_cpus
TypeNumeric
Value

This parameter specifies how many host CPUs Charon-VAX / Charon-PDP must use for I/O handling.

By default the Charon VM reserves one third of all 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

license_key_lookup_retry

Parameterlicense_key_lookup_retry
TypeText String
Value

In case the Charon-VAX / Charon-PDP license connection is not present when the guest starts up, this parameter specifies how many times the Charon VM will try to establish the connection and, optionally, a period of time between retries.

Syntax:

set session license_key_lookup_retry = "N [, T]"

Options:

  • N - Number of retries to look for license keys.
  • T - Time between retries in seconds. If not specified, 60 seconds are used

Example 1:

set session license_key_lookup_retry = 1

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

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 the license key is not found during initial scan, do 3 more attempts waiting 10 seconds between them.

Example 4:

set session license_key_lookup_retry = "5"

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



File inclusion

It is possible to include a configuration file into an existing one using the "include" command. The file extension is usually .icfg.

Format:

include "file.icfg"

Example:

include "c:\Charon\commonpart.icfg"

(info) The configuration template files are defined to use the "configuration_name.icfg" configuration file which is used by the Charon Virtual Machines Manager. If you use an existing configuration file, including this file is not necessary.

<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.