Version and Copyright

Name

SIM_register_copyright — register copyright information

Synopsis

C and DML

#include <simics/device-api.h> // in C
// always available in DML

// only supported with SIMICS_API = 6
void
SIM_register_copyright(const char *NOTNULL str);

Description

This registers specific copyright information related to an extension module or similar component of Simics. The Simics front-end command “copyright” will list, in addition to Simics copyright notices, any registered notices from libraries or plug-ins that have added a string using this function.

The string should contain only standard ASCII characters, be pre-formatted for at most 80-character width terminal, be non-indented, and have no spurious new-line characters before or after the last line (except for the new-line that marks the end of the last line).

The string will not be copied so needs to be either static or a copy generated by the callee (preferably static).

Execution Context

Global Context

Name

SIM_version, SIM_version_base, SIM_version_major, SIM_license, SIM_license_file, SIM_copyright, SIM_vmxmon_version — get Simics version and license/copyright information

Synopsis

C and DML

#include <simics/device-api.h> // in C
// always available in DML

const char *
SIM_version();

const char *
SIM_version_base();

const char *
SIM_version_major();

void
SIM_license();

char *
SIM_license_file(const char *format);

char *
SIM_copyright();

char *
SIM_vmxmon_version();

Python

import simics

simics.SIM_version(...)
simics.SIM_version_base(...)
simics.SIM_version_major(...)
simics.SIM_license(...)
simics.SIM_license_file(...)
simics.SIM_copyright(...)
simics.SIM_vmxmon_version(...)

Description

SIM_version

returns the version of all installed Simics products.

SIM_version_base

returns the version of the Simics base package only.

SIM_version_major

returns the current major version of Simics.

SIM_vmxmon_version

returns the version of the VMP kernel module loaded on the host machine. NULL is returned if the module is not loaded.

SIM_license_file

returns the filename of the currently applying License Agreement (SLA/EULA), if any is found. The format parameter can be either an empty string (text version) or “rtf” (RTF version).

SIM_copyright

returns the copyright notice for Simics.

SIM_license

doesn’t return anything but prints out a short text describing licensing conditions.

SIM_version, SIM_version_base, SIM_version_major return a string owned by Simics. These strings must not be deallocated or modified by the caller.

SIM_vmxmon_version, SIM_license_file, and SIM_copyright return a newly allocated string which is owned by the caller. This means that when the function is called from C its return value should be later freed with the use of the MM_FREE macro.

Execution Context

Global Context