Skip to main content


class %SYSTEM.CPU extends %Library.RegisteredObject, %SYSTEM.Help

This class holds information about available processors. The number of threads (virtual or logical cpus), cores and chips always reflect the situation in the current partition or processor set.

Property Inventory

Method Inventory


property Arch as %String;
Architecture, eg: x86, Itanium, SPARC, PA-RISC
Property methods: ArchDisplayToLogical(), ArchGet(), ArchIsValid(), ArchLogicalToDisplay(), ArchLogicalToOdbc(), ArchNormalize(), ArchSet()
property InsideCgroup as %Numeric;
Is IRIS running inside a cgroup
Property methods: InsideCgroupDisplayToLogical(), InsideCgroupGet(), InsideCgroupIsValid(), InsideCgroupLogicalToDisplay(), InsideCgroupNormalize(), InsideCgroupSet()
property MHz as %Numeric;
Clock in MHz
Property methods: MHzDisplayToLogical(), MHzGet(), MHzIsValid(), MHzLogicalToDisplay(), MHzNormalize(), MHzSet()
property MTEnabled as %Boolean;
Is Hardware Multi-Threading enabled? (eg: HyperThreading(Intel) or SMT(ppc))
Property methods: MTEnabledDisplayToLogical(), MTEnabledGet(), MTEnabledIsValid(), MTEnabledLogicalToDisplay(), MTEnabledNormalize(), MTEnabledSet()
property MTSupported as %Boolean;
Is Hardware Multi-Threading supported?
Property methods: MTSupportedDisplayToLogical(), MTSupportedGet(), MTSupportedIsValid(), MTSupportedLogicalToDisplay(), MTSupportedNormalize(), MTSupportedSet()
property Model as %String;
Chip model, eg: Pentium 4, POWER5
Property methods: ModelDisplayToLogical(), ModelGet(), ModelIsValid(), ModelLogicalToDisplay(), ModelLogicalToOdbc(), ModelNormalize(), ModelSet()
property PeriodUs as %Numeric;
cgroup cfs period in us
Property methods: PeriodUsDisplayToLogical(), PeriodUsGet(), PeriodUsIsValid(), PeriodUsLogicalToDisplay(), PeriodUsNormalize(), PeriodUsSet()
property QuotaUs as %Numeric;
cgroup cfs quota in us
Property methods: QuotaUsDisplayToLogical(), QuotaUsGet(), QuotaUsIsValid(), QuotaUsLogicalToDisplay(), QuotaUsNormalize(), QuotaUsSet()
property Vendor as %String;
Chip vendor, eg: Intel, Sun, IBM
Property methods: VendorDisplayToLogical(), VendorGet(), VendorIsValid(), VendorLogicalToDisplay(), VendorLogicalToOdbc(), VendorNormalize(), VendorSet()
property nChips as %Numeric;
Total number of chips
Property methods: nChipsDisplayToLogical(), nChipsGet(), nChipsIsValid(), nChipsLogicalToDisplay(), nChipsNormalize(), nChipsSet()
property nCores as %Numeric;
Total number of cores
Property methods: nCoresDisplayToLogical(), nCoresGet(), nCoresIsValid(), nCoresLogicalToDisplay(), nCoresNormalize(), nCoresSet()
property nCoresPerChip as %Numeric;
Number of cores per chip (physical property)
Property methods: nCoresPerChipDisplayToLogical(), nCoresPerChipGet(), nCoresPerChipIsValid(), nCoresPerChipLogicalToDisplay(), nCoresPerChipNormalize(), nCoresPerChipSet()
property nThreads as %Numeric;
Total number of threads (virtual or logical cpus)
Property methods: nThreadsDisplayToLogical(), nThreadsGet(), nThreadsIsValid(), nThreadsLogicalToDisplay(), nThreadsNormalize(), nThreadsSet()
property nThreadsPerCore as %Numeric;
Number of threads per core (physical property)
Property methods: nThreadsPerCoreDisplayToLogical(), nThreadsPerCoreGet(), nThreadsPerCoreIsValid(), nThreadsPerCoreLogicalToDisplay(), nThreadsPerCoreNormalize(), nThreadsPerCoreSet()


method %OnNew() as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

classmethod Dump()
Display CPU information
method Refresh() as %Status
Force update and get new properties

Inherited Members

Inherited Methods

FeedbackOpens in a new tab