Copyright	(c) 2022 Tim Emiola
License	BSD3
Maintainer	Tim Emiola <adetokunbo@emio.la>
Safe Haskell	Safe-Inferred
Language	Haskell2010

System.MemInfo.SysInfo

Contents

define reports
indicate calculation flaws
system kernel version

Description

This module provides data types that

define memory reports (cf ReportBud) and
provide info about the system where the report will run (cf KernelVersion, SwapFlaw and RamFlaw).

along with functions that use these types.

Synopsis

data ReportBud = ReportBud {
- rbPids :: !(NonEmpty ProcessID)
- rbKernel :: !KernelVersion
- rbHasPss :: !Bool
- rbHasSwapPss :: !Bool
- rbHasSmaps :: !Bool
- rbRamFlaws :: Maybe RamFlaw
- rbSwapFlaws :: Maybe SwapFlaw
}
mkReportBud :: NonEmpty ProcessID -> IO (Maybe ReportBud)
data RamFlaw
- = NoSharedMem
- | SomeSharedMem
- | ExactForIsolatedMem
data SwapFlaw
- = NoSwap
- | ExactForIsolatedSwap
checkForFlaws :: ReportBud -> IO ReportBud
fmtRamFlaws :: RamFlaw -> Text
fmtSwapFlaws :: SwapFlaw -> Text
type KernelVersion = (Natural, Natural, Natural)
parseKernelVersion :: Text -> Maybe KernelVersion
readKernelVersion :: IO (Maybe KernelVersion)
fickleSharing :: KernelVersion -> Bool

define reports

data ReportBud Source #

Gathers the inputs needed to generate a memory usage report

Constructors

ReportBud
Fields rbPids :: !(NonEmpty ProcessID) rbKernel :: !KernelVersion rbHasPss :: !Bool rbHasSwapPss :: !Bool rbHasSmaps :: !Bool rbRamFlaws :: Maybe RamFlaw rbSwapFlaws :: Maybe SwapFlaw

Instances

Instances details

Show ReportBud Source #
Instance details Defined in System.MemInfo.SysInfo Methods showsPrec :: Int -> ReportBud -> ShowS # show :: ReportBud -> String # showList :: [ReportBud] -> ShowS #
Eq ReportBud Source #
Instance details Defined in System.MemInfo.SysInfo Methods (==) :: ReportBud -> ReportBud -> Bool # (/=) :: ReportBud -> ReportBud -> Bool #

mkReportBud :: NonEmpty ProcessID -> IO (Maybe ReportBud) Source #

Construct a ReportBud from some ProcessIDs

Generates values for the other fields by inspecting the system

The result is Nothing only when the KernelVersion cannot be determined

indicate calculation flaws

data RamFlaw Source #

Describes inaccuracies in the RAM calculation

Constructors

NoSharedMem	no shared mem is reported
SomeSharedMem	some shared mem not reported
ExactForIsolatedMem	accurate only considering each process in isolation

Instances

Instances details

Show RamFlaw Source #
Instance details Defined in System.MemInfo.SysInfo Methods showsPrec :: Int -> RamFlaw -> ShowS # show :: RamFlaw -> String # showList :: [RamFlaw] -> ShowS #
Eq RamFlaw Source #
Instance details Defined in System.MemInfo.SysInfo Methods (==) :: RamFlaw -> RamFlaw -> Bool # (/=) :: RamFlaw -> RamFlaw -> Bool #
Ord RamFlaw Source #
Instance details Defined in System.MemInfo.SysInfo Methods compare :: RamFlaw -> RamFlaw -> Ordering # (<) :: RamFlaw -> RamFlaw -> Bool # (<=) :: RamFlaw -> RamFlaw -> Bool # (>) :: RamFlaw -> RamFlaw -> Bool # (>=) :: RamFlaw -> RamFlaw -> Bool # max :: RamFlaw -> RamFlaw -> RamFlaw # min :: RamFlaw -> RamFlaw -> RamFlaw #

data SwapFlaw Source #

Describes inaccuracies in the swap measurement

Constructors

NoSwap	not available
ExactForIsolatedSwap	accurate only considering each process in isolation

Instances

Instances details

Show SwapFlaw Source #
Instance details Defined in System.MemInfo.SysInfo Methods showsPrec :: Int -> SwapFlaw -> ShowS # show :: SwapFlaw -> String # showList :: [SwapFlaw] -> ShowS #
Eq SwapFlaw Source #
Instance details Defined in System.MemInfo.SysInfo Methods (==) :: SwapFlaw -> SwapFlaw -> Bool # (/=) :: SwapFlaw -> SwapFlaw -> Bool #
Ord SwapFlaw Source #
Instance details Defined in System.MemInfo.SysInfo Methods compare :: SwapFlaw -> SwapFlaw -> Ordering # (<) :: SwapFlaw -> SwapFlaw -> Bool # (<=) :: SwapFlaw -> SwapFlaw -> Bool # (>) :: SwapFlaw -> SwapFlaw -> Bool # (>=) :: SwapFlaw -> SwapFlaw -> Bool # max :: SwapFlaw -> SwapFlaw -> SwapFlaw # min :: SwapFlaw -> SwapFlaw -> SwapFlaw #

checkForFlaws :: ReportBud -> IO ReportBud Source #

Examine the target system for RamFlaws and SwapFlaws, and update bud reflect the findings.

fmtRamFlaws :: RamFlaw -> Text Source #

Provide Text that explains the RamFlaw

fmtSwapFlaws :: SwapFlaw -> Text Source #

Provide Text that explains the SwapFlaw

system kernel version

type KernelVersion = (Natural, Natural, Natural) Source #

Represents a version of Linux kernel

parseKernelVersion :: Text -> Maybe KernelVersion Source #

Parses Text into a KernelVersion

readKernelVersion :: IO (Maybe KernelVersion) Source #

Determines the version of the Linux kernel on the current system.

fickleSharing :: KernelVersion -> Bool Source #

On linux kernels before smaps became available, there was no reliable way to determine how much of a processes memory was shared

http://lkml.org/lkml/2005/7/6/250