Product Documentation and Knowledge Base - HomeDocumentation


Charon-AXP


Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Table of Contents

Session

General settings that control the execution of CHARON-AXP belong to an object called the "session". It is a preloaded object; therefore, only "set" commands apply. 

Example:

set session <parameter>=<value>


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

hw_model

Parameterhw_model
TypeText string
Value

Virtual HP Alpha 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="AlphaServer_ES40"

Available models are:

  • AlphaServer_AS400

  • AlphaServer_AS800

  • AlphaServer_AS1000

  • AlphaServer_AS1000A

  • AlphaServer_AS1200

  • AlphaServer_AS2000

  • AlphaServer_AS2100

  • AlphaServer_AS4000

  • AlphaServer_AS4100

  • AlphaServer_DS10

  • AlphaServer_DS15

  • AlphaServer_DS20

  • AlphaServer_DS25

  • AlphaServer_ES40

  • AlphaServer_ES45

  • AlphaServer_GS80

  • AlphaServer_GS160

  • AlphaServer_GS320

(info) Refer to this section to find how to set a particular HP Alpha model supported by CHARON-AXP.

configuration_name

Parameterconfiguration_name
TypeText string
Value

Name of the CHARON-AXP instance (ir must be unique):

set session configuration_name="MSCDV1"

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

From the example above, the CHARON-AXP 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-AXP 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.

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

Example:

set session log="/charon/es40prod.log"
Log specified as a directory

CHARON-AXP automatically creates individual log files for each CHARON-AXP execution session. If the log parameter is omitted, CHARON-AXP creates a log file for each CHARON-AXP 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).

(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="es40prod"

set session log="/charon/logs"

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


log_method

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

Determines if the previous log information is maintained or overwritten.

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

This parameter is applicable only if the CHARON-AXP log is stored to a file that is specified explicitly with the "log" parameter.

Example:

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

log_file_size

Parameter

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

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

Examples:

set session log_file_size="default"
set session log_file_size=10M

(warning) Minimum LOG File size is 64K, maximum is 1G. Setting size less then 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" or "0"
  • <N> - in N days

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:

set session log_rotation_period="weekly"

set session log_rotation_period=14

license_key_id

Parameter

license_key_id[N]

N=0 or 1

TypeNumeric
Value

An integer (decimal Sentinel Key ID) that specifies the regular (N=0) and backup (N=1) license keys to be used by CHARON-AXP.

set session license_key_id[0]=1877752571
set session license_key_id[1]=354850588

It is also possible to specify both regular and backup keys in one line:

set session license_key_id[0]=1877752571 license_key_id[1]=354850588

Based on the presence of the regular and/or backup license key IDs in the configuration file, CHARON-AXP behaves as follows:
 

  1. No keys are specified
    CHARON-AXP performs an unqualified search for any suitable key. If no key is found, CHARON-AXP exits.

  2. Both keys are specified
    CHARON-AXP performs a qualified search for a regular license key. If it is not found, CHARON-AXP performs a qualified search for backup license key. If it is not found, CHARON-AXP exits.

  3. Only regular key is specified
    CHARON-AXP performs a qualified search for a regular license key. If it is not found, CHARON-AXP performs an unqualified search for any suitable key. If none are found, CHARON-AXP exits.

  4. Only backup key is specified
    CHARON-AXP performs an unqualified search for any suitable key. If no key is found, CHARON-AXP exits.

license_key_lookup_retry

Parameterlicense_key_lookup_retry
TypeText String
Value

In case the CHARON-AXP license connection is not present when the guest starts up, this parameter specifies how many times CHARON-AXP 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 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 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 license key is not found during the 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.

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

By default the CHARON-AXP 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 Alpha CPUs and for CHARON-AXP 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_cpus

Parametern_of_cpus
TypeNumeric
Value

Limits the number of emulated CPUs.

Example:

set session n_of_cpus=3

The maximum number of CPUs enabled by CHARON-AXP is specified by the license key, but cannot exceed the original hardware restrictions:

HP Alpha ModelNumber of emulated CPUs

AlphaServer_AS400

1
AlphaServer_AS8001
AlphaServer_AS10001
AlphaServer_AS1000A1
AlphaServer_AS12002
AlphaServer_AS20002
AlphaServer_AS21004
AlphaServer_AS40002
AlphaServer_AS41004
AlphaServer_DS101
AlphaServer_DS151
AlphaServer_DS202
AlphaServer_DS252
AlphaServer_ES404
AlphaServer_ES454
AlphaServer_GS808
AlphaServer_GS16016
AlphaServer_GS32032

n_of_io_cpus

Parametern_of_io_cpus
TypeNumeric
Value

This parameter specifies how many host CPUs CHARON-AXP must use for I/O handling. Use of the “affinity” parameter may limit the number of CPUs available.

By default the CHARON-AXP instance 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

Back to the Table of Contents


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 "/charon/commonpart.icfg"

Back to Table of Contents

  • No labels