kern/v4/vendor/github.com/power-devops/perfstat/doc.go

//go:build !aix
// +build !aix

// Copyright 2020 Power-Devops.com. All rights reserved.
// Use of this source code is governed by the license
// that can be found in the LICENSE file.
/*
Package perfstat is Go interface to IBM AIX libperfstat.
To use it you need AIX with installed bos.perf.libperfstat. You can check, if is installed using the following command:

	$ lslpp -L bos.perf.perfstat

The package is written using Go 1.14.7 and AIX 7.2 TL5. It should work with earlier TLs of AIX 7.2, but I
can't guarantee that perfstat structures in the TLs have all the same fields as the structures in AIX 7.2 TL5.

For documentation of perfstat on AIX and using it in programs refer to the official IBM documentation:
https://www.ibm.com/support/knowledgecenter/ssw_aix_72/performancetools/idprftools_perfstat.html
*/
package perfstat

import (
	"fmt"
	"time"
)

// EnableLVMStat() switches on LVM (logical volumes and volume groups) performance statistics.
// With this enabled you can use fields KBReads, KBWrites, and IOCnt
// in LogicalVolume and VolumeGroup data types.
func EnableLVMStat() {}

// DisableLVMStat() switchess of LVM (logical volumes and volume groups) performance statistics.
// This is the default state. In this case LogicalVolume and VolumeGroup data types are
// populated with informations about LVM structures, but performance statistics fields
// (KBReads, KBWrites, IOCnt) are empty.
func DisableLVMStat() {}

// CpuStat() returns array of CPU structures with information about
// logical CPUs on the system.
// IBM documentation:
//   - https://www.ibm.com/support/knowledgecenter/ssw_aix_72/performancetools/idprftools_perfstat_int_cpu.html
//   - https://www.ibm.com/support/knowledgecenter/en/ssw_aix_72/p_bostechref/perfstat_cpu.html
func CpuStat() ([]CPU, error) {
	return nil, fmt.Errorf("not implemented")
}

// CpuTotalStat() returns general information about CPUs on the system.
// IBM documentation:
//   - https://www.ibm.com/support/knowledgecenter/ssw_aix_72/performancetools/idprftools_perfstat_glob_cpu.html
//   - https://www.ibm.com/support/knowledgecenter/en/ssw_aix_72/p_bostechref/perfstat_cputot.html
func CpuTotalStat() (*CPUTotal, error) {
	return nil, fmt.Errorf("not implemented")
}

// CpuUtilStat() calculates CPU utilization.
// IBM documentation:
//   - https://www.ibm.com/support/knowledgecenter/ssw_aix_72/performancetools/idprftools_perfstat_cpu_util.html
//   - https://www.ibm.com/support/knowledgecenter/en/ssw_aix_72/p_bostechref/perfstat_cpu_util.html
func CpuUtilStat(intvl time.Duration) (*CPUUtil, error) {
	return nil, fmt.Errorf("not implemented")
}

func DiskTotalStat() (*DiskTotal, error) {
	return nil, fmt.Errorf("not implemented")
}

func DiskAdapterStat() ([]DiskAdapter, error) {
	return nil, fmt.Errorf("not implemented")
}

func DiskStat() ([]Disk, error) {
	return nil, fmt.Errorf("not implemented")
}

func DiskPathStat() ([]DiskPath, error) {
	return nil, fmt.Errorf("not implemented")
}

func FCAdapterStat() ([]FCAdapter, error) {
	return nil, fmt.Errorf("not implemented")
}

func PartitionStat() (*PartitionConfig, error) {
	return nil, fmt.Errorf("not implemented")
}

func LogicalVolumeStat() ([]LogicalVolume, error) {
	return nil, fmt.Errorf("not implemented")
}

func VolumeGroupStat() ([]VolumeGroup, error) {
	return nil, fmt.Errorf("not implemented")
}

func MemoryTotalStat() (*MemoryTotal, error) {
	return nil, fmt.Errorf("not implemented")
}

func MemoryPageStat() ([]MemoryPage, error) {
	return nil, fmt.Errorf("not implemented")
}

func PagingSpaceStat() ([]PagingSpace, error) {
	return nil, fmt.Errorf("not implemented")
}

func NetIfaceTotalStat() (*NetIfaceTotal, error) {
	return nil, fmt.Errorf("not implemented")
}

func NetBufferStat() ([]NetBuffer, error) {
	return nil, fmt.Errorf("not implemented")
}

func NetIfaceStat() ([]NetIface, error) {
	return nil, fmt.Errorf("not implemented")
}

func NetAdapterStat() ([]NetAdapter, error) {
	return nil, fmt.Errorf("not implemented")
}

func ProcessStat() ([]Process, error) {
	return nil, fmt.Errorf("not implemented")
}

func ThreadStat() ([]Thread, error) {
	return nil, fmt.Errorf("not implemented")
}

func Sysconf(name int32) (int64, error) {
	return 0, fmt.Errorf("not implemented")
}

func GetCPUImplementation() string {
	return ""
}

func POWER9OrNewer() bool {
	return false
}

func POWER9() bool {
	return false
}

func POWER8OrNewer() bool {
	return false
}

func POWER8() bool {
	return false
}

func POWER7OrNewer() bool {
	return false
}

func POWER7() bool {
	return false
}

func HasTransactionalMemory() bool {
	return false
}

func Is64Bit() bool {
	return false
}

func IsSMP() bool {
	return false
}

func HasVMX() bool {
	return false
}

func HasVSX() bool {
	return false
}

func HasDFP() bool {
	return false
}

func HasNxGzip() bool {
	return false
}

func PksCapable() bool {
	return false
}

func PksEnabled() bool {
	return false
}

func CPUMode() string {
	return ""
}

func KernelBits() int {
	return 0
}

func IsLPAR() bool {
	return false
}

func CpuAddCapable() bool {
	return false
}

func CpuRemoveCapable() bool {
	return false
}

func MemoryAddCapable() bool {
	return false
}

func MemoryRemoveCapable() bool {
	return false
}

func DLparCapable() bool {
	return false
}

func IsNUMA() bool {
	return false
}

func KernelKeys() bool {
	return false
}

func RecoveryMode() bool {
	return false
}

func EnhancedAffinity() bool {
	return false
}

func VTpmEnabled() bool {
	return false
}

func IsVIOS() bool {
	return false
}

func MLSEnabled() bool {
	return false
}

func SPLparCapable() bool {
	return false
}

func SPLparEnabled() bool {
	return false
}

func DedicatedLpar() bool {
	return false
}

func SPLparCapped() bool {
	return false
}

func SPLparDonating() bool {
	return false
}

func SmtCapable() bool {
	return false
}

func SmtEnabled() bool {
	return false
}

func VrmCapable() bool {
	return false
}

func VrmEnabled() bool {
	return false
}

func AmeEnabled() bool {
	return false
}

func EcoCapable() bool {
	return false
}

func EcoEnabled() bool {
	return false
}

func BootTime() (uint64, error) {
	return 0, fmt.Errorf("Not implemented")
}

func UptimeSeconds() (uint64, error) {
	return 0, fmt.Errorf("Not implemented")
}

func FileSystemStat() ([]FileSystem, error) {
	return nil, fmt.Errorf("Not implemented")
}