qclib
|
Go to the source code of this file.
Functions | |
void * | qc_open (int *rc) |
void | qc_close (void *hdl) |
int | qc_get_num_layers (void *hdl, int *rc) |
int | qc_get_attribute_string (void *hdl, enum qc_attr_id id, int layer, const char **value) |
int | qc_get_attribute_int (void *hdl, enum qc_attr_id id, int layer, int *value) |
int | qc_get_attribute_float (void *hdl, enum qc_attr_id id, int layer, float *value) |
enum qc_attr_id |
Defines the attributes retrievable by the API. Attributes can exist for multiple layers. Also, attributes will only be valid if retrieved as the correct type.
The following tables detail which attributes of what types are available for what layers. The letter encoding in the 'Src' column describes how the value is gained:
/proc/sysinfo
, which is present in all Linux on z flavors./sys/firmware/ocf
. Available in Linux kernel 3.0 or higher.debugfs
at /sys/kernel/debug/s390_hypfs
, or s390_hypfs
(typically mounted at /sys/hypervisor/s390
). Proper file access privileges required.debugfs
exclusively.QC_LAYER_TYPE_LPAR_GROUP
).Several letters indicate the order in which the value is attempted to be acquired. If the extraction of the value in a later phase succeeds, it will overwrite the value acquired in an earlier phase. If the extraction of the value in a later phase does not succeed, it will not dismiss the existing value, if a previous phase has set it before.
'Comment'
column for layer-specific considerationsAttributes for CECs (layer 0) | Type | Src | Comment -------------------------— |
---|---|---|---|
qc_layer_type_num | int | Hardcoded to QC_LAYER_TYPE_CEC | |
qc_layer_category_num | int | Hardcoded to QC_LAYER_CAT_HOST | |
qc_layer_type | string | Hardcoded to "CEC" | |
qc_layer_category | string | Hardcoded to "HOST" | |
qc_layer_name | string | O V | CPC name of machine |
qc_manufacturer | string | S V | |
qc_type | string | S V | |
qc_model_capacity | string | S | |
qc_model | string | S | |
qc_sequence_code | string | S V | |
qc_plant | string | S V | |
qc_num_cpu_total | int | S | Sum of qc_num_cpu_configured, qc_num_cpu_reserved and qc_num_cpu_standby, or qc_num_cpu_dedicated and qc_num_cpu_shared. Note: Sum of qc_num_cp_total and qc_num_ifl_total might be smaller, since assists and spares are missing |
qc_num_cpu_configured | int | S | General purpose CPUs only without IFLs |
qc_num_cpu_standby | int | S | General purpose CPUs which are in the (very brief) process of being added to the configuration |
qc_num_cpu_reserved | int | S | IFLs, zIIPs, spares, excluding IFPs (Internal Firmware Processors) |
qc_num_cpu_dedicated | int | hV | Sum of qc_num_cp_dedicated and qc_num_ifl_dedicated Note: [4] |
qc_num_cpu_shared | int | hV | Sum of qc_num_cp_shared and qc_num_ifl_shared Note: [4] |
qc_num_cp_total | int | HV | Equals the sum of qc_num_cp_dedicated and qc_num_cp_shared Note: [4] |
qc_num_cp_dedicated | int | hV | Note: [4] |
qc_num_cp_shared | int | hV | Note: [4] |
qc_num_ifl_total | int | HV | Equals the sum of qc_num_ifl_dedicated and qc_num_ifl_shared Note: [4] |
qc_num_ifl_dedicated | int | hV | Note: [4] |
qc_num_ifl_shared | int | hV | Note: [4] |
qc_capability | float | S | |
qc_secondary_capability | float | S | |
qc_capacity_adjustment_indication | int | S | |
qc_capacity_change_reason | int | S |
Attributes for LPAR Groups | Type | Src | Comment -------------------------— |
---|---|---|---|
qc_layer_type_num | int | Hardcoded to QC_LAYER_TYPE_LPAR_GROUP | |
qc_layer_category_num | int | Hardcoded to QC_LAYER_CAT_POOL | |
qc_layer_type | string | Hardcoded to "LPAR-Group" | |
qc_layer_category | string | Hardcoded to "POOL" | |
qc_layer_name | string | hV | Name of LPAR group |
qc_cp_absolute_capping | int | hV | |
qc_ifl_absolute_capping | int | hV |
Attributes for LPARs | Type | Src | Comment -------------------------— |
---|---|---|---|
qc_layer_type_num | int | Hardcoded to QC_LAYER_TYPE_LPAR | |
qc_layer_category_num | int | Hardcoded to QC_LAYER_CAT_GUEST | |
qc_layer_type | string | Hardcoded to "LPAR" | |
qc_layer_category | string | Hardcoded to "GUEST" | |
qc_layer_name | string | S V | Name of LPAR, limited to 8 characters |
qc_layer_extended_name | string | S | Name of LPAR with up to 256 characters Note: Requires Linux kernel 4.10 or higher |
qc_layer_uuid | string | S | Note: Requires Linux kernel 4.10 or higher |
qc_partition_number | int | S | |
qc_partition_char | string | S | |
qc_partition_char_num | int | S | |
qc_adjustment | int | S | |
qc_num_cpu_total | int | S | Total number of IFLs and CPs configured in the LPARs activation profile |
qc_num_cpu_configured | int | S | Note: [5] |
qc_num_cpu_standby | int | S | Operational CPUs that require add'l configuration within the LPAR image to become usable Note: [5] |
qc_num_cpu_reserved | int | S | Operational CPUs that require add'l interaction by the LPAR's administrator to become usable Note: [5] |
qc_num_cpu_dedicated | int | S | Dedicated operational CPUs onlyNote: [5], hence sum of qc_num_cp_dedicated and qc_num_ifl_dedicated can be larger |
qc_num_cpu_shared | int | S | Shared operational CPUs onlyNote: [5], hence sum of qc_num_cp_shared and qc_num_ifl_shared can be larger |
qc_num_cp_total | int | HV | Sum of qc_num_cp_dedicated and qc_num_cp_shared. Considers configured CPs only. |
qc_num_cp_dedicated | int | hV | |
qc_num_cp_shared | int | hV | |
qc_num_ifl_total | int | HV | Sum of qc_num_ifl_dedicated and qc_num_ifl_shared. Considers configured IFLs only. |
qc_num_ifl_dedicated | int | hV | |
qc_num_ifl_shared | int | hV | |
qc_cp_absolute_capping | int | hV | |
qc_cp_weight_capping | int | hV | Note: [4] |
qc_ifl_absolute_capping | int | hV | |
qc_ifl_weight_capping | int | hV | Note: [4] |
Attributes for z/VM hypervisors | Type | Src | Comment -------------------------— |
---|---|---|---|
qc_layer_type_num | int | Hardcoded to QC_LAYER_TYPE_ZVM_HYPERVISOR | |
qc_layer_category_num | int | Hardcoded to QC_LAYER_CAT_HOST | |
qc_layer_type | string | Hardcoded to "z/VM-hypervisor" | |
qc_layer_category | string | Hardcoded to "HOST" | |
qc_layer_name | string | V | System identifier of the hypervisor |
qc_cluster_name | string | V | |
qc_control_program_id | string | S | ID of CP |
qc_adjustment | int | S | Adjustment factor of z/VM |
qc_hardlimit_consumption | int | V | |
qc_prorated_core_time | int | V | |
qc_num_cpu_total | int | V | Sum of qc_num_cpu_dedicated and qc_num_cpu_shared |
qc_num_cpu_dedicated | int | V | Sum of qc_num_cp_dedicated and qc_num_ifl_dedicated |
qc_num_cpu_shared | int | V | Sum of qc_num_cp_shared and qc_num_ifl_shared |
qc_num_cp_total | int | V | Sum of qc_num_cp_dedicated and qc_num_cp_shared |
qc_num_cp_dedicated | int | V | |
qc_num_cp_shared | int | V | |
qc_num_ifl_total | int | V | Sum of qc_num_ifl_dedicated and qc_num_ifl_shared |
qc_num_ifl_dedicated | int | V | |
qc_num_ifl_shared | int | V |
Attributes for z/VM CPU pools | Type | Src | Comment -------------------------— |
---|---|---|---|
qc_layer_type_num | int | Hardcoded to QC_LAYER_TYPE_ZVM_CPU_POOL | |
qc_layer_category_num | int | Hardcoded to QC_LAYER_CAT_POOL | |
qc_layer_type | string | Hardcoded to "z/VM-CPU-pool" | |
qc_layer_category | string | Hardcoded to "POOL" | |
qc_layer_name | string | V | Name of CPU pool |
qc_cp_limithard_cap | int | V | |
qc_cp_capacity_cap | int | V | |
qc_cp_capped_capacity | int | V | |
qc_ifl_limithard_cap | int | V | |
qc_ifl_capacity_cap | int | V | |
qc_ifl_capped_capacity | int | V |
Attributes for KVM hypervisors | Type | Src | Comment -------------------------— |
---|---|---|---|
qc_layer_type_num | int | Hardcoded to QC_LAYER_TYPE_KVM_HYPERVISOR | |
qc_layer_category_num | int | Hardcoded to QC_LAYER_CAT_HOST | |
qc_layer_type | string | Hardcoded to "KVM-hypervisor" | |
qc_layer_category | string | Hardcoded to "HOST" | |
qc_control_program_id | string | S | Host ID |
qc_adjustment | int | S | |
qc_num_cpu_total | int | S | Sum of qc_num_cpu_dedicated and qc_num_cpu_shared. |
qc_num_cpu_dedicated | int | SHV | Sum of qc_num_cp_dedicated and qc_num_ifl_dedicated. |
qc_num_cpu_shared | int | SHV | Sum of qc_num_cp_shared and qc_num_ifl_shared. |
qc_num_cp_total | int | HV | Sum of qc_num_cp_dedicated and qc_num_cp_shared |
qc_num_cp_dedicated | int | hV | |
qc_num_cp_shared | int | hV | |
qc_num_ifl_total | int | SHV | Sum of qc_num_ifl_dedicated and qc_num_ifl_shared |
qc_num_ifl_dedicated | int | ShV | |
qc_num_ifl_shared | int | ShV |
Attributes for KVM guests | Type | Src | Comment -------------------------— |
---|---|---|---|
qc_layer_type_num | int | Hardcoded to QC_LAYER_TYPE_KVM_GUEST | |
qc_layer_category_num | int | Hardcoded to QC_LAYER_CAT_GUEST | |
qc_layer_type | string | Hardcoded to "KVM-guest" | |
qc_layer_category | string | Hardcoded to "GUEST" | |
qc_layer_name | string | S | Guest name truncated to 8 characters Note: [1] |
qc_layer_extended_name | string | S | Guest name with up to 256 characters Note: Requires Linux kernel 3.19 or higher, [1] |
qc_layer_uuid | string | S | Note: Requires Linux kernel 3.19 or higher |
qc_num_cpu_total | int | S | Sum of qc_num_cpu_configured, qc_num_cpu_standby and qc_num_cpu_reserved, or qc_num_cpu_dedicated and qc_num_cpu_shared |
qc_num_cpu_configured | int | S | |
qc_num_cpu_standby | int | S | |
qc_num_cpu_reserved | int | S | |
qc_num_cpu_dedicated | int | S | |
qc_num_cpu_shared | int | S | |
qc_num_ifl_total | int | S | Sum of qc_num_ifl_dedicated and qc_num_ifl_shared |
qc_num_ifl_dedicated | int | S | |
qc_num_ifl_shared | int | S | |
qc_ifl_dispatch_type | int | SHV |
[1] Available starting with RHEL7.2 and SLES12SP1
[2] z/Architecture Principles of Operation, SA22-7832
[3] z/VM: CP Commands and Utilities Reference, SC24-6175
[4] Requires global performance data to be enabled in the LPAR's activation profile
[5] As of this writing, in LPARs with both CPs and IFLs defined in its activation profile, only CPs can become operational. Therefore, IFL counts would not appear in any of qc_num_cpu_configured, qc_num_cpu_standby, qc_num_cpu_reserved, qc_num_cpu_dedicated or qc_num_cpu_shared
Enumerator | |
---|---|
qc_adjustment | The adjustment factor indicates the maximum percentage of the machine (in parts of 1000) that could be used by the primary processor type in the worst case by the respective layer, taking cappings and other limiting factors into consideration. |
qc_capability | Capability rating, see |
qc_capacity_adjustment_indication | Capacity adjustment value, see |
qc_capacity_change_reason | Reason for capacity adjustment, see |
qc_capping | Capping type: |
qc_capping_num | Numeric representation of capping type, see enum qc_cappings |
qc_cluster_name | SSI name if part of SSI cluster |
qc_control_program_id | ID of control program |
qc_cp_absolute_capping | CP absolute capping value. Scaled value where 0x10000 equals one CPU, or 0 if no capping set |
qc_cp_capacity_cap | 1 if pool's CP virtual type has capacity capping |
qc_cp_capped_capacity | Guest current capped capacity for shared virtual CPs – scaled value where 0x10000 equals to one CPU, or 0 if no capping set |
qc_cp_dispatch_limithard | 1 if guest CP dispatch type has LIMITHARD cap., |
qc_cp_dispatch_type | Dispatch type for guest CPs: |
qc_cp_limithard_cap | 1 if pool's CP virtual type has limithard capping |
qc_cp_weight_capping | CP weight-based capping value – scaled value where 0x10000 equals one CPU, or 0 if no capping set |
qc_hardlimit_consumption | 1 if SRM hardlimit setting is consumption |
qc_has_multiple_cpu_types | 1 if layer has multiple CPU types (e.g. CPs and IFLs), |
qc_ifl_absolute_capping | IFL absolute capping value – scaled value where 0x10000 equals one CPU, or 0 if no capping set |
qc_ifl_capacity_cap | 1 if pool's IFL virtual type has capacity capping |
qc_ifl_capped_capacity | Guest current capped capacity for shared virtual IFLs – scaled value where 0x10000 equals to one CPU, or 0 if no capping set |
qc_ifl_dispatch_limithard | 1 if guest IFL dispatch type has LIMITHARD cap., |
qc_ifl_dispatch_type | Dispatch type for guest CPs: |
qc_ifl_limithard_cap | 1 if pool's IFL virtual type has limithard capping |
qc_ifl_weight_capping | IFL weight-based capping value – scaled value where 0x10000 equals one CPU, or 0 if no capping set |
qc_layer_category | Layer category, see layer tables above for details |
qc_layer_category_num | Numeric representation of layer category, see enum qc_layer_categories |
qc_layer_extended_name | Guest extended name |
qc_layer_name | Name of container, see layer tables for details |
qc_layer_type | Layer type, see layer tables above for details |
qc_layer_type_num | Numeric representation of layer type, see enum qc_layer_types |
qc_layer_uuid | Universal unique ID |
qc_manufacturer | Company that manufactured box |
qc_mobility_eligible | 1 if guest is eligible for mobility, |
qc_model | Model identifier, see |
qc_model_capacity | Model capacity of machine, see |
qc_num_cp_dedicated | Sum of dedicated CPs in layer |
qc_num_cp_shared | Sum of shared CPs in layer |
qc_num_cp_total | Sum of all CPs in layer |
qc_num_cpu_configured | Sum of configured CPs and IFLs in layer |
qc_num_cpu_dedicated | Sum of dedicated CPs and IFLs in layer |
qc_num_cpu_reserved | Sum of reserved CPs and IFLs in layer |
qc_num_cpu_shared | Sum of shared CPs and IFLs in layer |
qc_num_cpu_standby | Sum of standby CPs and IFLs in layer |
qc_num_cpu_total | Sum of all CPs and IFLs in layer |
qc_num_ifl_dedicated | Sum of dedicated IFLs in layer |
qc_num_ifl_shared | Sum of shared IFLs in layer |
qc_num_ifl_total | Sum of all IFLs (Integrated Facility for Linux) in layer |
qc_partition_char | Partition characteristics, any combination of |
qc_partition_char_num | Numeric representation of partition characteristics, see enum qc_part_chars |
qc_partition_number | Partition number, see |
qc_plant | Identifier of the manufacturing plant, see |
qc_secondary_capability | Secondary capability rating, see |
qc_sequence_code | Sequence code of machine, see |
qc_type | 4-digit machine type |
qc_prorated_core_time | 1 if limithard caps uses prorated core time for capping |
enum qc_cappings |
Numeric representation of the capping type, see qc_capping.
Enumerator | |
---|---|
QC_CAPPING_OFF | Capping turned off |
enum qc_layer_categories |
enum qc_layer_types |
enum qc_part_chars |
void qc_close | ( | void * | hdl | ) |
Closes the configuration handle and releases all memory allocated when the configuration was opened. The configuration handle is invalid after calling this function, as are any returned pointers of previous capacity function calls.
If logging or autodumping was enabled on qc_open(), environment variables QC_DEBUG
and QC_AUTODUMP
need to be set to integers <=0 on the final call to qc_close() (or whenever neither functionality is not required anymore) to correctly free up all resources.
hdl | Handle of the configuration to close. |
int qc_get_attribute_float | ( | void * | hdl, |
enum qc_attr_id | id, | ||
int | layer, | ||
float * | value | ||
) |
Returns the attribute of type float designated by id
. If the attribute is not available at the specified layer, the attribute is not of type float, or another error occurred, return parameter valid
will be set accordingly.
hdl | Handle of the configuration to use. |
id | Attribute to retrieve. |
layer | Specifies the layer, e.g.
|
value | Return parameter returning the float attribute's value or undefined in case of an error.indicating validity as follows: |
int qc_get_attribute_int | ( | void * | hdl, |
enum qc_attr_id | id, | ||
int | layer, | ||
int * | value | ||
) |
Returns the attribute of type integer designated by id
. If the attribute is not available at the specified layer, the attribute is not of type integer, or another error occurred, return parameter valid
will be set accordingly.
hdl | Handle of the configuration to use. |
id | Attribute to retrieve. |
layer | Specifies the layer, e.g.
|
value | Return parameter returning the string attribute's value or undefined in case of an error. |
int qc_get_attribute_string | ( | void * | hdl, |
enum qc_attr_id | id, | ||
int | layer, | ||
const char ** | value | ||
) |
Returns the attribute of type string designated by id
. If the attribute is not available at the specified layer, the attribute is not of type string, or another error occurred, return parameter valid
will be set accordingly.
hdl | Handle of the configuration to use. |
id | Attribute to retrieve. |
layer | Specifies the layer, e.g.
|
value | Return parameter returning the string attribute's value or NULL in case of an error. |
int qc_get_num_layers | ( | void * | hdl, |
int * | rc | ||
) |
Get the number of layers.
hdl | Handle of the configuration to use. |
rc | Return parameter indicating the return code. Set to
|
void* qc_open | ( | int * | rc | ) |
Attaches to system information sources and prepares the extraction of system information. Some information may be gathered at this time already: under LPAR, /proc/sysinfo
is read and interpreted; under z/VM, *VMINFO data is read using the STHYI
instruction (requires z/VM 6.3 with APAR
VM65419
, or higher). Capacity queries then take place based on this information which could be considered cached.
Memory will be allocated in this function, which has to be released by closing the configuration again. While a configuration is open, SSI migration in z/VM is not blocked and can occur. In case a migration occurs after a configuration has been opened, closing the configuration and re-opening it ensures capacity information is used from the migrated-to system.
Use the following environment variables to operate built-in service facilities:
QC_DEBUG:
Set to an integer value/tmp/qclib-XXXXXX
or as specified by QC_DEBUG_FILE
if set.<STEM>
.dump-XXX on every qc_open() call (where STEM is /tmp/qclib-XXXXXX
or as specified by QC_DEBUG_FILE
if set.QC_DEBUG
to a value <=0 on the next qc_open() call.QC_DEBUG_FILE:
Stem to use for log files and dump directories (see QC_DEBUG
). Defaults to /tmp/qclib-XXXXXX
.QC_AUTODUMP:
Set to a value >0 to trigger a dump to a directory named /tmp/qclib-XXXXXX
.dump-XXX if an error is encountered within qc_open().QC_DEBUG
was set to a value >0QC_USE_DUMP:
To run with a previous dump instead of live data, point this environment variable to a directory containing the dump data.QC_CHECK_CONSISTENCY:
Check data for consistency. Recommended for debugging scenarios only.rc | Return parameter indicating the return code. Set to
|