-
Notifications
You must be signed in to change notification settings - Fork 6
/
query_capacity.h
776 lines (756 loc) · 51.6 KB
/
query_capacity.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
/* Copyright IBM Corp. 2013, 2019 */
/** @file */
#ifndef QUERY_CAPACITY
#define QUERY_CAPACITY
#define QC_VERSION "2.5.0"
/* Build Customization */
//#define CONFIG_DUMP_READING // Allow to read in dumps
//#define CONFIG_V1_COMPATIBILITY // Support functionality deprecated in v1.x
/** \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 '\c Src' column describes how the
* value is gained:
* - **S**: Provided by \c /proc/sysinfo, which is present in all Linux on z flavors.
* - **F**: Provided by firmware as made available through the \c sysfs filesystem.
* - **H**: Provided by hypfs, which is available through \c debugfs at
* \c /sys/kernel/debug/s390_hypfs .
* Proper file access privileges required.
* - **V**: Provided by the STHYI instruction.
* - <i>z/VM Linux guests</i>: Requires z/VM 6.3 with APAR VM65419 or higher.
* UM34746 for z/VM 6.3.0 APAR VM65716 is required for LPAR groups support
* (see layer \c #QC_LAYER_TYPE_LPAR_GROUP).
* - <i>KVM Linux guests</i>: Requires Linux kernel 4.8 or higher in the KVM host.
* - <i>Linux LPAR</i>: Requires Linux kernel 4.15 or higher in the KVM host.
* - <i>zCX</i>: Requires z/OS 2.4 or higher.
*
* 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.<br>
*
*
* ### SMT ###
* SMT was introduced starting with z13/LinuxONE.<br>
* When SMT is turned off (or not available), the terms <i>core</i> and <i>CPU</i> are
* synonymous. But when SMT is enabled, <i>CPU</i> refers to a thread running on a
* <i>core</i>.<br>
* As a general rule, CP, IFL and zIIP counts (eg. #qc_num_cp_total, #qc_num_ifl_total
* and #qc_num_ziip_total respectively)
* - refer to cores if the layer reports cores, and
* - refer to CPUs if the layer reports CPUs.
* E.g. \c #QC_LAYER_TYPE_LPAR reports cores (see e.g. #qc_num_core_total), hence
* #qc_num_ifl_shared refers to cores, too.<br>
* In layers reporting cores, use attributes #qc_num_cp_threads, #qc_num_ifl_threads and
* #qc_num_ziip_threads to derive the number of CPUs.
*
* ### Notes ###
* - zIIPs are not included in CPU and core total counts.
* - Special care needs to be taken with respect to [5] when processing #qc_num_core_total,
* #qc_num_core_dedicated and #qc_num_core_shared in layers of type \c #QC_LAYER_TYPE_LPAR.
* - With SMT enabled:
* - All layers above (if present) the first hypervisor layer will report each thread as a
* separate <i>CPU</i>.
* Otherwise, the term <i>CPU</i> is synonymous with <I>core</I>.
* - Layers of types \c #QC_LAYER_TYPE_ZVM_HYPERVISOR and \c #QC_LAYER_TYPE_KVM_HYPERVISOR
* running above one or more layers of type \c #QC_LAYER_TYPE_ZVM_HYPERVISOR or
* \c #QC_LAYER_TYPE_KVM_HYPERVISOR (i.e. within a guest of a hypervisor), will
* report <i>CPU</i>s all the time, no matter what the attribute names might imply.
* - On Linux, use '<TT>lscpu -e</TT>' to get a detailed list of the CPU/core
* topology. Likewise, use '<TT>QUERY PROCESSORS</TT>' on z/VM for similar
* information. However, beware that if the respective instance is not running
* immediately on top of a layer of type \c #QC_LAYER_TYPE_LPAR, results need to be
* interpreted according to the previous note.
* - Layers of type \c #QC_LAYER_TYPE_ZVM_GUEST report any capacity cappings (see attributes
* #qc_cp_capped_capacity, #qc_ifl_capped_capacity and #qc_ziip_capped_capacity) in units
* of cores, although CPs, IFLs and zIIPs that they refer to are reported as <i>CPU</i>s.
* - All strings (char pointers) carry the trailing zero byte.
* - See #qc_attr_id for general explanation of attributes, and the \c 'Comment' column
* for layer-specific considerations
*
* Attributes for CECs (layer 0) | Type | Src | Comment
* ------------------------------------|------|-----|-------------------------------------
* #qc_layer_type_num | int | | Hardcoded to \c #QC_LAYER_TYPE_CEC
* #qc_layer_category_num | int | | Hardcoded to \c #QC_LAYER_CAT_HOST
* #qc_layer_type |string| | Hardcoded to \c "CEC"
* #qc_layer_category |string| | Hardcoded to \c "HOST"
* #qc_layer_name |string|<CODE>F V</CODE>| CPC name of machine. Available in Linux kernel 3.0 or higher.
* #qc_manufacturer |string|<CODE>S V</CODE>| \n
* #qc_type |string|<CODE>S V</CODE>| \n
* #qc_type_name |string|<CODE>S </CODE>| \n
* #qc_type_family | int |<CODE>S </CODE>| \n
* #qc_model_capacity |string|<CODE>S </CODE>| \n
* #qc_model |string|<CODE>S </CODE>| \n
* #qc_sequence_code |string|<CODE>S V</CODE>| \n
* #qc_lic_identifier |string|<CODE>S </CODE>| <b>Note</b>: Requires Linux kernel 4.16 or higher, and IBM z14 or later
* #qc_plant |string|<CODE>S V</CODE>| \n
* #qc_num_core_total | int |<CODE>S</CODE>| Sum of #qc_num_core_configured, #qc_num_core_reserved and #qc_num_core_standby.<br><b>Note</b>: Sum of #qc_num_cp_total and #qc_num_ifl_total might be smaller or larger, since some assists and spares are missing, and only the general purpose CPU type is considered
* #qc_num_core_configured | int |<CODE>S </CODE>| General purpose cores only without IFLs and zIIPs
* #qc_num_core_standby | int |<CODE>S </CODE>| General purpose cores which are in the (very brief) process of being added to the configuration
* #qc_num_core_reserved | int |<CODE>S </CODE>| IFLs, zIIPs, spares, excluding IFPs (Internal Firmware Processors)
* #qc_num_core_dedicated | int |<CODE> V</CODE>| Sum of #qc_num_cp_dedicated and #qc_num_ifl_dedicated<br><b>Note</b>: \b [4]
* #qc_num_core_shared | int |<CODE> V</CODE>| Sum of #qc_num_cp_shared and #qc_num_ifl_shared<br><b>Note</b>: \b [4]
* #qc_num_cp_total | int |<CODE> HV</CODE>| Equals the sum of #qc_num_cp_dedicated and #qc_num_cp_shared<br>Reported in unit of cores<br><b>Note</b>: \b [4]
* #qc_num_cp_dedicated | int |<CODE> V</CODE>| Reported in unit of cores<br><b>Note</b>: \b [4]
* #qc_num_cp_shared | int |<CODE> V</CODE>| Reported in unit of cores<br><b>Note</b>: \b [4]
* #qc_num_ifl_total | int |<CODE> HV</CODE>| Equals the sum of #qc_num_ifl_dedicated and #qc_num_ifl_shared<br>Reported in unit of cores<br><b>Note</b>: \b [4]
* #qc_num_ifl_dedicated | int |<CODE> V</CODE>| Reported in unit of cores<br><b>Note</b>: \b [4]
* #qc_num_ifl_shared | int |<CODE> V</CODE>| Reported in unit of cores<br><b>Note</b>: \b [4]
* #qc_num_ziip_total | int |<CODE> HV</CODE>| Equals the sum of #qc_num_ziip_dedicated and #qc_num_ziip_shared<br>Reported in unit of cores<br><b>Note</b>: \b [4]
* #qc_num_ziip_dedicated | int |<CODE> V</CODE>| Reported in unit of cores<br><b>Note</b>: \b [4]
* #qc_num_ziip_shared | int |<CODE> V</CODE>| Reported in unit of cores<br><b>Note</b>: \b [4]
* #qc_num_cp_threads | int |<CODE>S </CODE>| Number of threads/CPUs per CP core that the CEC is capable of<br><b>Note</b>: Requires Linux kernel 4.4 or higher
* #qc_num_ifl_threads | int |<CODE>S </CODE>| Number of threads/CPUs per IFL core that the CEC is capable of<br><b>Note</b>: Requires Linux kernel 4.4 or higher
* #qc_num_ziip_threads | int |<CODE>S </CODE>| Number of threads/CPUs per zIIP core that the CEC is capable of<br><b>Note</b>: Requires Linux kernel 4.4 or higher
* #qc_capability | float|<CODE>S </CODE>| \n
* #qc_secondary_capability | float|<CODE>S </CODE>| \n
* #qc_capacity_adjustment_indication | int |<CODE>S </CODE>| \n
* #qc_capacity_change_reason | int |<CODE>S </CODE>| \n
*
* Attributes for LPAR Groups | Type | Src | Comment
* ------------------------------------|------|-----|-------------------------------------
* #qc_layer_type_num | int | | Hardcoded to \c #QC_LAYER_TYPE_LPAR_GROUP
* #qc_layer_category_num | int | | Hardcoded to \c #QC_LAYER_CAT_POOL
* #qc_layer_type |string| | Hardcoded to \c "LPAR-Group"
* #qc_layer_category |string| | Hardcoded to \c "POOL"
* #qc_layer_name |string|<CODE> V</CODE>| Name of LPAR group
* #qc_cp_absolute_capping | int |<CODE> V</CODE>| Reported in unit of cores
* #qc_ifl_absolute_capping | int |<CODE> V</CODE>| Reported in unit of cores
* #qc_ziip_absolute_capping | int |<CODE> V</CODE>| Reported in unit of cores
*
* Attributes for LPARs | Type | Src | Comment
* ------------------------------------|------|-----|-------------------------------------
* #qc_layer_type_num | int | | Hardcoded to \c #QC_LAYER_TYPE_LPAR
* #qc_layer_category_num | int | | Hardcoded to \c #QC_LAYER_CAT_GUEST
* #qc_layer_type |string| | Hardcoded to \c "LPAR"
* #qc_layer_category |string| | Hardcoded to \c "GUEST"
* #qc_layer_name |string|<CODE>S V</CODE>| Name of LPAR, limited to 8 characters
* #qc_layer_extended_name |string|<CODE>S </CODE>| Name of LPAR with up to 256 characters<br><b>Note</b>: Requires Linux kernel 4.10 or higher
* #qc_layer_uuid |string|<CODE>S </CODE>| <b>Note</b>: Requires Linux kernel 4.10 or higher
* #qc_partition_number | int |<CODE>S </CODE>| \n
* #qc_partition_char |string|<CODE>S </CODE>| \n
* #qc_partition_char_num | int |<CODE>S </CODE>| \n
* #qc_adjustment | int |<CODE>S </CODE>| \n
* #qc_has_secure | int |<CODE>F </CODE>| \n
* #qc_secure | int |<CODE>F </CODE>| \n
* #qc_num_core_total | int |<CODE>S</CODE>| Total number of CPs and IFLs configured in the LPARs activation profile
* #qc_num_core_configured | int |<CODE>S </CODE>| <b>Note</b>: \b [5]
* #qc_num_core_standby | int |<CODE>S </CODE>| Operational cores that require add'l configuration within the LPAR image to become usable<br><b>Note</b>: \b [5]
* #qc_num_core_reserved | int |<CODE>S </CODE>| Operational cores that require add'l interaction by the LPAR's administrator to become usable<br><b>Note</b>: \b [5]
* #qc_num_core_dedicated | int |<CODE>S </CODE>| Dedicated operational cores only<br><b>Note</b>: \b [5], hence sum of #qc_num_cp_dedicated, #qc_num_ifl_dedicated and #qc_num_ziip_dedicated can be larger
* #qc_num_core_shared | int |<CODE>S </CODE>| Shared operational cores only<br><b>Note</b>: \b [5], hence sum of #qc_num_cp_shared, #qc_num_ifl_shared and #qc_num_ziip_dedicated can be larger
* #qc_num_cp_total | int |<CODE> HV</CODE>| Sum of #qc_num_cp_dedicated and #qc_num_cp_shared. Considers configured CPs only.<br>Reported in unit of cores
* #qc_num_cp_dedicated | int |<CODE> V</CODE>| Reported in unit of cores
* #qc_num_cp_shared | int |<CODE> V</CODE>| Reported in unit of cores
* #qc_num_ifl_total | int |<CODE> HV</CODE>| Sum of #qc_num_ifl_dedicated and #qc_num_ifl_shared. Considers configured IFLs only.<br>Reported in unit of cores
* #qc_num_ifl_dedicated | int |<CODE> V</CODE>| Reported in unit of cores
* #qc_num_ifl_shared | int |<CODE> V</CODE>| Reported in unit of cores
* #qc_num_ziip_total | int |<CODE> HV</CODE>| Sum of #qc_num_ziip_dedicated and #qc_num_ziip_shared. Considers configured zIIPs only.<br>Reported in unit of cores
* #qc_num_ziip_dedicated | int |<CODE> V</CODE>| Reported in unit of cores
* #qc_num_ziip_shared | int |<CODE> V</CODE>| Reported in unit of cores
* #qc_num_cp_threads | int |<CODE>S </CODE>| Number of threads/CPUs per CP core configured for this LPAR<br><b>Note</b>: Requires Linux kernel 4.3 or higher
* #qc_num_ifl_threads | int |<CODE>S </CODE>| Number of threads/CPUs per IFL core configured for this LPAR<br><b>Note</b>: Requires Linux kernel 4.3 or higher
* #qc_num_ziip_threads | int |<CODE>S </CODE>| Number of threads/CPUs per zIIP core configured for this LPAR<br><b>Note</b>: Requires Linux kernel 4.3 or higher
* #qc_cp_absolute_capping | int |<CODE> V</CODE>| Reported in unit of cores
* #qc_cp_weight_capping | int |<CODE> V</CODE>| Reported in unit of cores<br><b>Note</b>: \b [4]
* #qc_ifl_absolute_capping | int |<CODE> V</CODE>| Reported in unit of cores
* #qc_ifl_weight_capping | int |<CODE> V</CODE>| Reported in unit of cores<br><b>Note</b>: \b [4]
* #qc_ziip_absolute_capping | int |<CODE> V</CODE>| Reported in unit of cores
* #qc_ziip_weight_capping | int |<CODE> V</CODE>| Reported in unit of cores<br><b>Note</b>: \b [4]
*
*
* Attributes for z/VM hypervisors | Type | Src | Comment
* ------------------------------------|------|-----|-------------------------------------
* #qc_layer_type_num | int | | Hardcoded to \c #QC_LAYER_TYPE_ZVM_HYPERVISOR
* #qc_layer_category_num | int | | Hardcoded to \c #QC_LAYER_CAT_HOST
* #qc_layer_type |string| | Hardcoded to \c "z/VM-hypervisor"
* #qc_layer_category |string| | Hardcoded to \c "HOST"
* #qc_layer_name |string|<CODE> V</CODE>| System identifier of the hypervisor
* #qc_cluster_name |string|<CODE> V</CODE>| \n
* #qc_control_program_id |string|<CODE>S </CODE>| ID of CP
* #qc_adjustment | int |<CODE>S </CODE>| Adjustment factor of z/VM
* #qc_limithard_consumption | int |<CODE> V</CODE>| \n
* #qc_prorated_core_time | int |<CODE> V</CODE>| \n
* #qc_num_core_total | int |<CODE> V</CODE>| Sum of #qc_num_core_dedicated and #qc_num_core_shared
* #qc_num_core_dedicated | int |<CODE> V</CODE>| Sum of #qc_num_cp_dedicated and #qc_num_ifl_dedicated
* #qc_num_core_shared | int |<CODE> V</CODE>| Sum of #qc_num_cp_shared and #qc_num_ifl_dedicated
* #qc_num_cp_total | int |<CODE> V</CODE>| Sum of #qc_num_cp_dedicated and #qc_num_cp_shared<br>Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_cp_dedicated | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_cp_shared | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_ifl_total | int |<CODE> V</CODE>| Sum of #qc_num_ifl_dedicated and #qc_num_ifl_shared<br>Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_ifl_dedicated | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_ifl_shared | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_ziip_total | int |<CODE> V</CODE>| Sum of #qc_num_ziip_dedicated and #qc_num_ziip_shared<br>Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_ziip_shared | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_ziip_dedicated | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_cp_threads | int |<CODE> V</CODE>| Number of threads/CPUs per CP core in use
* #qc_num_ifl_threads | int |<CODE> V</CODE>| Number of threads/CPUs per IFL core in use
* #qc_num_ziip_threads | int |<CODE> V</CODE>| Number of threads/CPUs per zIIP core in use
*
*
* Attributes for z/VM resource pools | Type | Src | Comment
* ------------------------------------|------|-----|-------------------------------------
* #qc_layer_type_num | int | | Hardcoded to \c #QC_LAYER_TYPE_ZVM_RESOURCE_POOL
* #qc_layer_category_num | int | | Hardcoded to \c #QC_LAYER_CAT_POOL
* #qc_layer_type |string| | Hardcoded to \c "z/VM-resource-pool", or \c "z/VM-CPU-pool" if compiled with CONFIG_V1_COMPATIBILITY
* #qc_layer_category |string| | Hardcoded to \c "POOL"
* #qc_layer_name |string|<CODE> V</CODE>| Name of resource pool
* #qc_cp_limithard_cap | int |<CODE> V</CODE>| \n
* #qc_cp_capacity_cap | int |<CODE> V</CODE>| \n
* #qc_cp_capped_capacity | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_ifl_limithard_cap | int |<CODE> V</CODE>| \n
* #qc_ifl_capacity_cap | int |<CODE> V</CODE>| \n
* #qc_ifl_capped_capacity | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_ziip_limithard_cap | int |<CODE> V</CODE>| \n
* #qc_ziip_capacity_cap | int |<CODE> V</CODE>| \n
* #qc_ziip_capped_capacity | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
*
*
* Attributes for z/VM guests | Type | Src | Comment
* ------------------------------------|------|-----|-------------------------------------
* #qc_layer_type_num | int | | Hardcoded to \c #QC_LAYER_TYPE_ZVM_GUEST
* #qc_layer_category_num | int | | Hardcoded to \c #QC_LAYER_CAT_GUEST
* #qc_layer_type |string| | Hardcoded to \c "z/VM-guest"
* #qc_layer_category |string| | Hardcoded to \c "GUEST"
* #qc_layer_name |string|<CODE>S V</CODE>| Userid of guest
* #qc_capping |string|<CODE> H</CODE>| \n
* #qc_capping_num | int |<CODE> H</CODE>| \n
* #qc_mobility_enabled | int |<CODE> V</CODE>| \n
* #qc_has_secure | int |<CODE>F </CODE>| \n
* #qc_secure | int |<CODE>F </CODE>| \n
* #qc_num_cpu_total | int |<CODE>S V</CODE>| 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 |<CODE>S </CODE>| \n
* #qc_num_cpu_standby | int |<CODE>S </CODE>| \n
* #qc_num_cpu_reserved | int |<CODE>S </CODE>| \n
* #qc_num_cpu_dedicated | int |<CODE> HV</CODE>| Sum of #qc_num_cp_dedicated and #qc_num_ifl_dedicated
* #qc_num_cpu_shared | int |<CODE> HV</CODE>| Sum of #qc_num_cp_shared and #qc_num_ifl_shared
* #qc_num_cp_total | int |<CODE> V</CODE>| Sum of #qc_num_cp_dedicated and #qc_num_cp_shared<br>Reported in unit of CPUs
* #qc_num_cp_dedicated | int |<CODE> V</CODE>| Reported in unit of CPUs
* #qc_num_cp_shared | int |<CODE> V</CODE>| Reported in unit of CPUs
* #qc_num_ifl_total | int |<CODE> V</CODE>| Sum of #qc_num_ifl_dedicated and #qc_num_ifl_shared<br>Reported in unit of CPUs
* #qc_num_ifl_dedicated | int |<CODE> V</CODE>| Reported in unit of CPUs
* #qc_num_ifl_shared | int |<CODE> V</CODE>| Reported in unit of CPUs
* #qc_num_ziip_total | int |<CODE> V</CODE>| Sum of #qc_num_ziip_dedicated and #qc_num_ziip_shared<br>Reported in unit of CPUs
* #qc_num_ziip_dedicated | int |<CODE> V</CODE>| Reported in unit of CPUs
* #qc_num_ziip_shared | int |<CODE> V</CODE>| Reported in unit of CPUs
* #qc_has_multiple_cpu_types | int |<CODE> V</CODE>| \n
* #qc_cp_dispatch_limithard | int |<CODE> V</CODE>| \n
* #qc_cp_dispatch_type | int |<CODE> V</CODE>| Only set in presence of CPs
* #qc_cp_capped_capacity | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_ifl_dispatch_limithard | int |<CODE> V</CODE>| \n
* #qc_ifl_dispatch_type | int |<CODE> V</CODE>| Only set in presence of IFLs
* #qc_ifl_capped_capacity | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_ziip_dispatch_limithard | int |<CODE> V</CODE>| \n
* #qc_ziip_dispatch_type | int |<CODE> V</CODE>| Only set in presence of zIIPs
* #qc_ziip_capped_capacity | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
*
*
* Attributes for z/OS hypervisors | Type | Src | Comment
* ------------------------------------|------|-----|-------------------------------------
* #qc_layer_type_num | int | | Hardcoded to \c #QC_LAYER_TYPE_ZOS_HYPERVISOR
* #qc_layer_category_num | int | | Hardcoded to \c #QC_LAYER_CAT_HOST
* #qc_layer_type |string| | Hardcoded to \c "z/OS-hypervisor"
* #qc_layer_category |string| | Hardcoded to \c "HOST"
* #qc_layer_name |string|<CODE> V</CODE>| System identifier of the hypervisor
* #qc_cluster_name |string|<CODE> V</CODE>| Name of sysplex
* #qc_control_program_id |string|<CODE>S </CODE>| ID of z/OS
* #qc_adjustment | int |<CODE>S </CODE>| Adjustment factor of z/OS
* #qc_num_core_total | int |<CODE> V</CODE>| Sum of #qc_num_core_dedicated and #qc_num_core_shared
* #qc_num_core_dedicated | int |<CODE> V</CODE>| Sum of #qc_num_cp_dedicated and #qc_num_ziip_dedicated
* #qc_num_core_shared | int |<CODE> V</CODE>| Sum of #qc_num_cp_shared and #qc_num_ziip_shared
* #qc_num_cp_total | int |<CODE> V</CODE>| Sum of #qc_num_cp_dedicated and #qc_num_cp_shared<br>Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_cp_dedicated | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_cp_shared | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_ziip_total | int |<CODE> V</CODE>| Sum of #qc_num_ziip_dedicated and #qc_num_ziip_shared<br>Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_ziip_shared | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_ziip_dedicated | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_cp_threads | int |<CODE> V</CODE>| Number of threads/CPUs per CP core in use
* #qc_num_ziip_threads | int |<CODE> V</CODE>| Number of threads/CPUs per zIIP core in use
*
*
* Attributes for z/OS resource groups | Type | Src | Comment
* ------------------------------------|------|-----|-------------------------------------
* #qc_layer_type_num | int | | Hardcoded to \c #QC_LAYER_TYPE_ZOS_TENANT_RESOURCE_GROUP
* #qc_layer_category_num | int | | Hardcoded to \c #QC_LAYER_CAT_POOL
* #qc_layer_type |string| | Hardcoded to \c "z/OS-tenant-resource-group"
* #qc_layer_category |string| | Hardcoded to \c "POOL"
* #qc_layer_name |string|<CODE> V</CODE>| Name of resource group
* #qc_cp_limithard_cap | int |<CODE> V</CODE>| \n
* #qc_cp_capacity_cap | int |<CODE> V</CODE>| \n
* #qc_cp_capped_capacity | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_ziip_limithard_cap | int |<CODE> V</CODE>| \n
* #qc_ziip_capacity_cap | int |<CODE> V</CODE>| \n
* #qc_ziip_capped_capacity | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
*
*
* Attributes for z/OS zCX Servers | Type | Src | Comment
* ------------------------------------|------|-----|-------------------------------------
* #qc_layer_type_num | int | | Hardcoded to \c #QC_LAYER_TYPE_ZOS_ZCX_SERVER
* #qc_layer_category_num | int | | Hardcoded to \c #QC_LAYER_CAT_GUEST
* #qc_layer_type |string| | Hardcoded to \c "z/OS-guest"
* #qc_layer_category |string| | Hardcoded to \c "GUEST"
* #qc_layer_name |string|<CODE>S V</CODE>| Userid of guest
* #qc_capping |string|<CODE> H</CODE>| \n
* #qc_capping_num | int |<CODE> H</CODE>| \n
* #qc_has_secure | int |<CODE>F </CODE>| \n
* #qc_secure | int |<CODE>F </CODE>| \n
* #qc_num_cpu_total | int |<CODE>S V</CODE>| 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 |<CODE>S </CODE>| \n
* #qc_num_cpu_standby | int |<CODE>S </CODE>| \n
* #qc_num_cpu_reserved | int |<CODE>S </CODE>| \n
* #qc_num_cpu_dedicated | int |<CODE> HV</CODE>| Sum of #qc_num_cp_dedicated and #qc_num_ifl_dedicated
* #qc_num_cpu_shared | int |<CODE> HV</CODE>| Sum of #qc_num_cp_shared and #qc_num_ifl_shared
* #qc_num_cp_total | int |<CODE> V</CODE>| Sum of #qc_num_cp_dedicated and #qc_num_cp_shared<br>Reported in unit of CPUs
* #qc_num_cp_dedicated | int |<CODE> V</CODE>| Reported in unit of CPUs
* #qc_num_cp_shared | int |<CODE> V</CODE>| Reported in unit of CPUs
* #qc_num_ziip_total | int |<CODE> V</CODE>| Sum of #qc_num_ziip_dedicated and #qc_num_ziip_shared<br>Reported in unit of CPUs
* #qc_num_ziip_dedicated | int |<CODE> V</CODE>| Reported in unit of CPUs
* #qc_num_ziip_shared | int |<CODE> V</CODE>| Reported in unit of CPUs
* #qc_has_multiple_cpu_types | int |<CODE> V</CODE>| \n
* #qc_cp_dispatch_limithard | int |<CODE> V</CODE>| \n
* #qc_cp_dispatch_type | int |<CODE> V</CODE>| Only set in presence of CPs
* #qc_cp_capped_capacity | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_ziip_dispatch_limithard | int |<CODE> V</CODE>| \n
* #qc_ziip_dispatch_type | int |<CODE> V</CODE>| Only set in presence of zIIPs<br><b>NOTE: I guess it would be cleaner if we would switch to IFL attributes instead of zIIPs, since that is (to my understanding), what Linux will see - and use THIS attribute to indicate that the IFLs are dispatched to zIIPs...?</b>
* #qc_ziip_capped_capacity | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
*
*
* Attributes for KVM hypervisors | Type | Src | Comment
* ------------------------------------|------|-----|-------------------------------------
* #qc_layer_type_num | int | | Hardcoded to \c #QC_LAYER_TYPE_KVM_HYPERVISOR
* #qc_layer_category_num | int | | Hardcoded to \c #QC_LAYER_CAT_HOST
* #qc_layer_type |string| | Hardcoded to \c "KVM-hypervisor"
* #qc_layer_category |string| | Hardcoded to \c "HOST"
* #qc_control_program_id |string|<CODE>S </CODE>| Host ID
* #qc_adjustment | int |<CODE>S </CODE>| \n
* #qc_num_core_total | int |<CODE>S </CODE>| Sum of #qc_num_core_dedicated and #qc_num_core_shared
* #qc_num_core_dedicated | int |<CODE>SHV</CODE>| Sum of #qc_num_cp_dedicated and #qc_num_ifl_dedicated
* #qc_num_core_shared | int |<CODE>SHV</CODE>| Sum of #qc_num_cp_shared and #qc_num_ifl_shared
* #qc_num_cp_total | int |<CODE> HV</CODE>| Sum of #qc_num_cp_dedicated and #qc_num_cp_shared<br>Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_cp_dedicated | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_cp_shared | int |<CODE> V</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_ifl_total | int |<CODE>SHV</CODE>| Sum of #qc_num_ifl_dedicated and #qc_num_ifl_shared<br>Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_ifl_dedicated | int |<CODE>ShV</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
* #qc_num_ifl_shared | int |<CODE>ShV</CODE>| Reported in unit of cores unless run as a guest of another hypervisor other than LPAR
*
*
* Attributes for KVM guests | Type | Src | Comment
* ------------------------------------|------|-----|-------------------------------------
* #qc_layer_type_num | int | | Hardcoded to \c #QC_LAYER_TYPE_KVM_GUEST
* #qc_layer_category_num | int | | Hardcoded to \c #QC_LAYER_CAT_GUEST
* #qc_layer_type |string| | Hardcoded to \c "KVM-guest"
* #qc_layer_category |string| | Hardcoded to \c "GUEST"
* #qc_layer_name |string|<CODE>S </CODE>| Guest name truncated to 8 characters<br><b>Note</b>: \b [1]
* #qc_layer_extended_name |string|<CODE>S </CODE>| Guest name with up to 256 characters<br><b>Note</b>: Requires Linux kernel 3.19 or higher, [1]
* #qc_layer_uuid |string|<CODE>S </CODE>| <b>Note</b>: Requires Linux kernel 3.19 or higher
* #qc_has_secure | int |<CODE>F </CODE>| \n
* #qc_secure | int |<CODE>F </CODE>| \n
* #qc_num_cpu_total | int |<CODE>S </CODE>| 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 |<CODE>S </CODE>| \n
* #qc_num_cpu_standby | int |<CODE>S </CODE>| \n
* #qc_num_cpu_reserved | int |<CODE>S </CODE>| \n
* #qc_num_cpu_dedicated | int |<CODE>S </CODE>| \n
* #qc_num_cpu_shared | int |<CODE>S </CODE>| \n
* #qc_num_ifl_total | int |<CODE>S </CODE>| Sum of #qc_num_ifl_dedicated and #qc_num_ifl_shared<br>Reported in unit of CPUs
* #qc_num_ifl_dedicated | int |<CODE>S </CODE>| Reported in unit of CPUs
* #qc_num_ifl_shared | int |<CODE>S </CODE>| Reported in unit of CPUs
* #qc_ifl_dispatch_type | int |<CODE>SHV</CODE>| \n
*
* \b [1] Available starting with RHEL7.2 and SLES12SP1<br>
* \b [2] <I>z/Architecture Principles of Operation</I>, SA22-7832<br>
* \b [3] <I>z/VM: CP Commands and Utilities Reference</I>, SC24-6175<br>
* \b [4] Requires global performance data (GDP) to be enabled in the LPAR's activation profile<br>
* \b [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_core_configured, #qc_num_core_standby, #qc_num_core_reserved,
* #qc_num_core_dedicated or #qc_num_core_shared
*/
enum qc_layer_types {
/** CEC */
QC_LAYER_TYPE_CEC = 1,
/** LPAR Capping Group */
QC_LAYER_TYPE_LPAR_GROUP = 8,
/** LPAR */
QC_LAYER_TYPE_LPAR = 2,
/** z/VM Hypervisor */
QC_LAYER_TYPE_ZVM_HYPERVISOR = 3,
/** z/VM CPU Pool (deprecated, use QC_LAYER_TYPE_ZVM_RESOURCE_POOL instead) */
QC_LAYER_TYPE_ZVM_CPU_POOL = 4,
/** z/VM Resource Pool */
QC_LAYER_TYPE_ZVM_RESOURCE_POOL = 4,
/** z/VM Guest */
QC_LAYER_TYPE_ZVM_GUEST = 5,
/** KVM Hypervisor */
QC_LAYER_TYPE_KVM_HYPERVISOR = 6,
/** KVM Guest */
QC_LAYER_TYPE_KVM_GUEST = 7,
/** z/OS Hypervisor */
QC_LAYER_TYPE_ZOS_HYPERVISOR = 9,
/** z/OS Tenant Resource Group */
QC_LAYER_TYPE_ZOS_TENANT_RESOURCE_GROUP = 10,
/** z/OS cCX Server */
QC_LAYER_TYPE_ZOS_ZCX_SERVER = 11,
};
/** \enum qc_layer_categories
* Layer categories. */
enum qc_layer_categories {
/** Layer category for guests, namely LPARs, z/VM and KVM guests */
QC_LAYER_CAT_GUEST = 1,
/** Layer category for hosts, namely CEC, z/VM and KVM hosts */
QC_LAYER_CAT_HOST = 2,
/** Layer category for pools (currently z/VM Pools and LPAR capping groups) */
QC_LAYER_CAT_POOL = 3,
};
/** \enum qc_part_chars
* Characteristic of an an LPAR. */
enum qc_part_chars {
/** LPAR has dedicated resources */
QC_PART_CHAR_DEDICATED = 1,
/** LPAR shares resources with other LPARs */
QC_PART_CHAR_SHARED = 2,
/** LPAR has limited resources */
QC_PART_CHAR_LIMITED = 4,
};
/** \enum qc_cappings
* Numeric representation of the capping type, see #qc_capping. */
enum qc_cappings {
/** Capping turned off */
QC_CAPPING_OFF = 0,
QC_CAPPING_SOFT = 1,
QC_CAPPING_HARD = 2,
};
/** \enum qc_model_families */
enum qc_model_families {
/** IBM Z */
QC_TYPE_FAMILY_IBMZ = 0,
/** LinuxONE */
QC_TYPE_FAMILY_LINUXONE = 1,
};
/** \enum qc_attr_id */
enum qc_attr_id {
/** 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.<br>
<b>Note</b>: This value can lead to wrong conclusions for layers that utilize more than one processor type! */
qc_adjustment = 0,
/** Capability rating, see \c STSI instruction in [2] */
qc_capability = 1,
/** Capacity adjustment value, see \c STSI instruction in [2] */
qc_capacity_adjustment_indication = 2,
/** Reason for capacity adjustment, see \c STSI instruction in [2] */
qc_capacity_change_reason = 3,
/** Capping type: \c "off", \c "soft", \c "hard" */
qc_capping = 4,
/** Numeric representation of capping type, see enum #qc_cappings */
qc_capping_num = 5,
/** SSI name if part of SSI cluster */
qc_cluster_name = 6,
/** ID of control program */
qc_control_program_id = 7,
/** CP absolute capping value. Scaled value where 0x10000 equals to one core, or 0 if no capping set */
qc_cp_absolute_capping = 8,
/** 1 if pool's CP virtual type has capped capacity<BR> 0 if not<br>See \c DEFINE \c CPUPOOL command in [3] */
qc_cp_capacity_cap = 9,
/** Guest current capped capacity for shared virtual CPs -- scaled value where 0x10000 equals to one core,
or 0 if no capping set. While this field displays the capacity, either #qc_cp_capacity_cap or
#qc_cp_limithard_cap must is set to indicate the kind of limit. */
qc_cp_capped_capacity = 10,
/** 1 if guest CP dispatch type has LIMITHARD capping,<BR> 0 if not<br>See \c SET \c SRM command in [3] */
qc_cp_dispatch_limithard = 11,
/** Dispatch type for guest CPs:<br>0=General Purpose (CP) */
qc_cp_dispatch_type = 12,
/** 1 if pool's CP virtual type has limithard capping<BR> 0 if not<br>See \c DEFINE \c CPUPOOL command in [3] */
qc_cp_limithard_cap = 13,
/** CP weight-based capping value -- scaled value where 0x10000 equals to one core, or 0 if no capping set */
qc_cp_weight_capping = 14,
/** 1 if SRM limithard setting is consumption<BR> 0 if deadline<br>See \c SET \c SRM command in [3] */
qc_limithard_consumption = 15,
#ifdef CONFIG_V1_COMPATIBILITY
/** Deprecated, see #qc_limithard_consumption */
qc_hardlimit_consumption = 15,
#endif
/** 1 if layer has multiple CPU types (e.g. CPs, IFLs, zIIPs),<BR> 0 if not */
qc_has_multiple_cpu_types = 16,
/** IFL absolute capping value -- scaled value where 0x10000 equals to one core, or 0 if no capping set */
qc_ifl_absolute_capping = 17,
/** 1 if pool's IFL virtual type has capped capacity<BR> 0 if not<br>See \c DEFINE \c CPUPOOL command in [3] */
qc_ifl_capacity_cap = 18,
/** Guest current capped capacity for shared virtual IFLs -- scaled value where 0x10000 equals to one core,
or 0 if no capping set. While this field displays the capacity, either #qc_ifl_capacity_cap or
#qc_ifl_limithard_cap must is set to indicate the kind of limit. */
qc_ifl_capped_capacity = 19,
/** 1 if guest IFL dispatch type has LIMITHARD capping,<BR> 0 if not<br>See \c SET \c SRM command in [3] */
qc_ifl_dispatch_limithard = 20,
/** Dispatch type for guest IFLs:<BR> 0=General Purpose (CP),<BR> 3=Integrated Facility for Linux (IFL) */
qc_ifl_dispatch_type = 21,
/** 1 if pool's IFL virtual type has limithard capping<BR> 0 if not<br>See \c DEFINE \c CPUPOOL command in [3] */
qc_ifl_limithard_cap = 22,
/** IFL weight-based capping value -- scaled value where 0x10000 equals to one core, or 0 if no capping set */
qc_ifl_weight_capping = 23,
/** zIIP absolute capping value -- scaled value where 0x10000 equals to one core, or 0 if no capping set */
qc_ziip_absolute_capping = 66,
/** 1 if pool's zIIP virtual type has capped capacity<BR> 0 if not<br>See \c DEFINE \c CPUPOOL command in [3] */
qc_ziip_capacity_cap = 67,
/** Guest current capped capacity for shared virtual zIIPs -- scaled value where 0x10000 equals to one core,
or 0 if no capping set. While this field displays the capacity, either #qc_ziip_capacity_cap or
#qc_ziip_limithard_cap must is set to indicate the kind of limit. */
qc_ziip_capped_capacity = 68,
/** 1 if guest zIIP dispatch type has LIMITHARD capping,<BR> 0 if not<br>See \c SET \c SRM command in [3] */
qc_ziip_dispatch_limithard = 69,
/** Dispatch type for guest zIIPs:<BR> 0=General Purpose (CP),<BR> 5=zSeries Integrated Information Processor (zIIP),<BR> ff=zIIP or CP */
qc_ziip_dispatch_type = 70,
/** 1 if pool's zIIP virtual type has limithard capping<BR> 0 if not<br>See \c DEFINE \c CPUPOOL command in [3] */
qc_ziip_limithard_cap = 71,
/** zIIP weight-based capping value -- scaled value where 0x10000 equals to one core, or 0 if no capping set */
qc_ziip_weight_capping = 72,
/** Layer category, see layer tables above for details */
qc_layer_category = 24,
/** Numeric representation of layer category, see enum #qc_layer_categories */
qc_layer_category_num = 25,
/** Guest extended name */
qc_layer_extended_name = 26,
/** Name of container, see layer tables for details */
qc_layer_name = 27,
/** Layer type, see layer tables above for details */
qc_layer_type = 28,
/** Numeric representation of layer type, see enum #qc_layer_types */
qc_layer_type_num = 29,
/** Universal unique ID */
qc_layer_uuid = 30,
/** Company that manufactured box */
qc_manufacturer = 31,
/** 1 if guest is enabled for mobility,<BR> 0 if not */
qc_mobility_enabled = 32,
#ifdef CONFIG_V1_COMPATIBILITY
/** Deprecated, see #qc_mobility_enabled */
qc_mobility_eligible = 32,
#endif
/** Indicates whether secure boot is available to the entity.
Requires Linux kernel 5.3 or later.
Note: This attribute is only ever available for the topmost layer. */
qc_has_secure = 77,
/** Indicates whether entity was booted using the secure boot feature
Requires Linux kernel 5.3 or later.
Note: This attribute is only ever available for the topmost layer. */
qc_secure = 78,
/** Model identifier, see \c STSI instruction in [2] */
qc_model = 33,
/** Model capacity of machine, see \c STSI instruction in [2] */
qc_model_capacity = 34,
/** Family of the model, enum #qc_model_families */
qc_type_family = 65,
/** Sum of dedicated CPs in layer */
qc_num_cp_dedicated = 35,
/** Sum of shared CPs in layer */
qc_num_cp_shared = 36,
/** Sum of all CPs in layer */
qc_num_cp_total = 37,
/** Sum of configured CPs and IFLs in layer */
qc_num_cpu_configured = 38,
/** Sum of dedicated CPs and IFLs in layer */
qc_num_cpu_dedicated = 39,
/** Sum of reserved CPs and IFLs in layer */
qc_num_cpu_reserved = 40,
/** Sum of shared CPs and IFLs in layer */
qc_num_cpu_shared = 41,
/** Sum of standby CPs and IFLs in layer */
qc_num_cpu_standby = 42,
/** Sum of all CPs and IFLs in layer */
qc_num_cpu_total = 43,
/** Sum of dedicated IFLs in layer */
qc_num_ifl_dedicated = 44,
/** Sum of shared IFLs in layer */
qc_num_ifl_shared = 45,
/** Sum of all IFLs (Integrated Facility for Linux) in layer */
qc_num_ifl_total = 46,
/** Sum of dedicated zIIPs in layer */
qc_num_ziip_dedicated = 73,
/** Sum of shared zIIPs in layer */
qc_num_ziip_shared = 74,
/** Sum of all zIIPs (Integrated Information Processor) in layer */
qc_num_ziip_total = 75,
/** Partition characteristics, any combination of \c "Dedicated", \c "Shared" and \c "Limited", also see \c STSI instruction in [2] */
qc_partition_char = 47,
/** Numeric representation of partition characteristics, see enum #qc_part_chars */
qc_partition_char_num = 48,
/** Partition number, see \c STSI instruction in [2] */
qc_partition_number = 49,
/** Identifier of the manufacturing plant, see \c STSI instruction in [2] */
qc_plant = 50,
/** Secondary capability rating, see \c STSI instruction in [2] */
qc_secondary_capability = 51,
/** Sequence code of machine, see \c STSI instruction in [2] */
qc_sequence_code = 52,
/** 4-digit machine type */
qc_type = 53,
/** 1 if limithard caps uses prorated core time for capping<br> 0 if raw CPU time is used<br>See \c APAR \c VM65680 */
qc_prorated_core_time = 54,
/** Threads per CP, values >1 indicate that SMT is enabled */
qc_num_cp_threads = 55,
/** Threads per IFL, values >1 indicate that SMT is enabled */
qc_num_ifl_threads = 56,
/** Threads per zIIP, values >1 indicate that SMT is enabled */
qc_num_ziip_threads = 76,
/** Sum of all CP and IFL cores in layer */
qc_num_core_total = 57,
/** Sum of configure CP and IFL cores in layer */
qc_num_core_configured = 58,
/** Sum of standby CP and IFL cores in layer */
qc_num_core_standby = 59,
/** Sum of reserved CP and IFL cores in layer */
qc_num_core_reserved = 60,
/** Sum of dedicated CP and IFL cores in layer */
qc_num_core_dedicated = 61,
/** Sum of shared CP and IFL cores in layer */
qc_num_core_shared = 62,
/** Name of IBM Z model in clear text */
qc_type_name = 63,
/** Licensed Internal Code (LIC) level */
qc_lic_identifier = 64,
};
/**
* Attaches to system information sources and prepares the extraction of
* system information. Some information may be gathered at this time
* already: under LPAR, \c /proc/sysinfo is read and interpreted; under z/VM,
* *VMINFO data is read using the \c STHYI instruction (requires z/VM 6.3 with
* \c APAR \c VM65419, or higher). Capacity queries then take place based on this
* information which could be considered cached.<BR>
* 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.<BR>
* Use the following environment variables to operate built-in service facilities:
* - \c QC_DEBUG: Set to an integer value
* - >0 to enable logging to a file \c /tmp/qclib-XXXXXX or as specified by
* \c QC_DEBUG_FILE if set.
* - >1 to have data dumped to a directory named \c \<STEM\>.dump-XXX
* on every qc_open() call (where STEM is \c /tmp/qclib-XXXXXX or as specified
* by \c QC_DEBUG_FILE if set.<br>
* To disable logging, either see qc_close(), or set \c QC_DEBUG to a value
* <=0 on the next qc_open() call.<BR>
* - \c QC_DEBUG_FILE: Stem to use for log files and dump directories (see \c
* QC_DEBUG). Defaults to \c /tmp/qclib-XXXXXX.
* - \c QC_AUTODUMP: Set to a value >0 to trigger a dump to a directory named
* \c /tmp/qclib-XXXXXX.dump-XXX if an error is encountered within qc_open().<br>
* <b>Note</b>: This will also create an empty log file for technical reasons,
* unless \c QC_DEBUG was set to a value >0<BR>
* - \c QC_USE_DUMP: To run with a previously generated dump instead of live data,
point this environment variable to a directory containing the dump data.
Requires compilation with \c CONFIG_DUMP_READING set.
* - \c QC_CHECK_CONSISTENCY: Check data for consistency. Recommended for debugging
* scenarios only.
*
* @see qc_close()
*
* @param rc Return parameter indicating the return code. Set to
* - 0 on success,
* - <0 in case of an error, and
* - >0 if the configuration could not be read completely at the moment,
* but a retry later on could provide the missing data.
* @return Returns a configuration handle which is valid for reading out
* capacity data until the configuration is closed. Returns NULL in
* case of an error.
*/
void *qc_open(int *rc);
/**
* 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
* \c QC_DEBUG and \c 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.
*
* @param hdl Handle of the configuration to close.
*/
void qc_close(void *hdl);
/**
* Get the number of layers.
*
* @param hdl Handle of the configuration to use.
* @param rc Return parameter indicating the return code. Set to
* - 0 on success,
* - <0 in case of an error.
* @return Number of layer. E.g.
* - 2 if Linux runs in an LPAR
* - 4 if a z/VM guest runs in a z/VM Hypervisor in an LPAR, or
* - 5 if a z/VM guest runs in a capping group in z/VM running in LPAR.
*/
int qc_get_num_layers(void *hdl, int *rc);
/**
* Returns the attribute of type string designated by \p id. If the attribute is
* not available at the specified layer, the attribute is not of type string,
* or another error occurred, return parameter \p valid will be set accordingly.
*
* @see qc_get_attribute_int()
* @see qc_get_attribute_float()
*
* @param hdl Handle of the configuration to use.
* @param id Attribute to retrieve.
* @param layer Specifies the layer, e.g.
* - 0: CEC layer information,
* - 1: LPAR layer information, etc.
* @param value Return parameter returning the string attribute's value or NULL
* in case of an error.
* @return Indicating validity of the queried attribute as follows:
* - >0 attribute is valid
* - 0 attribute exists but is not set
* - <0 an error occurred retrieving the attribute
*/
int qc_get_attribute_string(void *hdl, enum qc_attr_id id, int layer, const char **value);
/**
* Returns the attribute of type integer designated by \p id. If the attribute is
* not available at the specified layer, the attribute is not of type integer,
* or another error occurred, return parameter \p valid will be set accordingly.
*
* @see qc_get_attribute_string()
* @see qc_get_attribute_float()
*
* @param hdl Handle of the configuration to use.
* @param id Attribute to retrieve.
* @param layer Specifies the layer, e.g.
* - 0: CEC layer information,
* - 1: LPAR layer information, etc.
* @param value Return parameter returning the string attribute's value or undefined
* in case of an error.
* @return Indicating validity of the queried attribute as follows:
* - >0 attribute is valid
* - 0 attribute exists but is not set
* - <0 an error occurred retrieving the attribute
* @return
*/
int qc_get_attribute_int(void *hdl, enum qc_attr_id id, int layer, int *value);
/**
* Returns the attribute of type float designated by \p id. If the attribute is
* not available at the specified layer, the attribute is not of type float,
* or another error occurred, return parameter \p valid will be set accordingly.
*
* @see qc_get_attribute_string()
* @see qc_get_attribute_int()
*
* @param hdl Handle of the configuration to use.
* @param id Attribute to retrieve.
* @param layer Specifies the layer, e.g.
* - 0: CEC layer information,
* - 1: LPAR layer information, etc.
* @param value Return parameter returning the float attribute's value or undefined
* in case of an error.indicating validity as follows:
* @return Indicating validity of the queried attribute as follows:
* - >0 attribute is valid
* - 0 attribute exists but is not set
* - <0 an error occurred retrieving the attribute
*/
int qc_get_attribute_float(void *hdl, enum qc_attr_id id, int layer, float *value);
/**
* Prints the internal data in JSON format to stdout.
* @param hdl Handle of the configuration to use.
*/
void qc_export_json(void *hdl);
#endif