<h2>Editing File: /lib/python3.6/site-packages/vdo/statistics/VDOStatistics.py</h2><form method='post'><textarea name='content' class='file-edit'>&quot;&quot;&quot;
  Copyright Red Hat

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.
  
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA. 
&quot;&quot;&quot;

from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
from .Field import *
from .StatStruct import *
from .VDOReleaseVersions import *

class BlockAllocatorStatistics(StatStruct):
  def __init__(self, name=&quot;BlockAllocatorStatistics&quot;, **kwargs):
    super(BlockAllocatorStatistics, self).__init__(name, [
      # The total number of slabs from which blocks may be allocated
      Uint64Field(&quot;slabCount&quot;),
      # The total number of slabs from which blocks have ever been allocated
      Uint64Field(&quot;slabsOpened&quot;),
      # The number of times since loading that a slab has been re-opened
      Uint64Field(&quot;slabsReopened&quot;),
    ], procRoot=&quot;vdo&quot;, **kwargs)

# Counters for tracking the number of items written (blocks, requests, etc.)
# that keep track of totals at steps in the write pipeline. Three counters
# allow the number of buffered, in-memory items and the number of in-flight,
# unacknowledged writes to be derived, while still tracking totals for
# reporting purposes
class CommitStatistics(StatStruct):
  def __init__(self, name=&quot;CommitStatistics&quot;, **kwargs):
    super(CommitStatistics, self).__init__(name, [
      Uint64Field(&quot;batching&quot;, derived = &quot;$started - $written&quot;),
      # The total number of items on which processing has started
      Uint64Field(&quot;started&quot;),
      Uint64Field(&quot;writing&quot;, derived = &quot;$written - $committed&quot;),
      # The total number of items for which a write operation has been issued
      Uint64Field(&quot;written&quot;),
      # The total number of items for which a write operation has completed
      Uint64Field(&quot;committed&quot;),
    ], procRoot=&quot;vdo&quot;, **kwargs)

# Counters for events in the recovery journal
class RecoveryJournalStatistics(StatStruct):
  def __init__(self, name=&quot;RecoveryJournalStatistics&quot;, **kwargs):
    super(RecoveryJournalStatistics, self).__init__(name, [
      # Number of times the on-disk journal was full
      Uint64Field(&quot;diskFull&quot;, label = &quot;disk full count&quot;),
      # Number of times the recovery journal requested slab journal commits.
      Uint64Field(&quot;slabJournalCommitsRequested&quot;, label = &quot;commits requested count&quot;),
      # Write/Commit totals for individual journal entries
      CommitStatistics(&quot;entries&quot;, labelPrefix = &quot;entries&quot;),
      # Write/Commit totals for journal blocks
      CommitStatistics(&quot;blocks&quot;, labelPrefix = &quot;blocks&quot;),
    ], labelPrefix=&quot;journal&quot;, procRoot=&quot;vdo&quot;, **kwargs)

# The statistics for the compressed block packer.
class PackerStatistics(StatStruct):
  def __init__(self, name=&quot;PackerStatistics&quot;, **kwargs):
    super(PackerStatistics, self).__init__(name, [
      # Number of compressed data items written since startup
      Uint64Field(&quot;compressedFragmentsWritten&quot;),
      # Number of blocks containing compressed items written since startup
      Uint64Field(&quot;compressedBlocksWritten&quot;),
      # Number of VIOs that are pending in the packer
      Uint64Field(&quot;compressedFragmentsInPacker&quot;),
    ], procRoot=&quot;vdo&quot;, **kwargs)

# The statistics for the slab journals.
class SlabJournalStatistics(StatStruct):
  def __init__(self, name=&quot;SlabJournalStatistics&quot;, **kwargs):
    super(SlabJournalStatistics, self).__init__(name, [
      # Number of times the on-disk journal was full
      Uint64Field(&quot;diskFullCount&quot;),
      # Number of times an entry was added over the flush threshold
      Uint64Field(&quot;flushCount&quot;),
      # Number of times an entry was added over the block threshold
      Uint64Field(&quot;blockedCount&quot;),
      # Number of times a tail block was written
      Uint64Field(&quot;blocksWritten&quot;),
      # Number of times we had to wait for the tail to write
      Uint64Field(&quot;tailBusyCount&quot;),
    ], labelPrefix=&quot;slab journal&quot;, procRoot=&quot;vdo&quot;, **kwargs)

# The statistics for the slab summary.
class SlabSummaryStatistics(StatStruct):
  def __init__(self, name=&quot;SlabSummaryStatistics&quot;, **kwargs):
    super(SlabSummaryStatistics, self).__init__(name, [
      # Number of blocks written
      Uint64Field(&quot;blocksWritten&quot;),
    ], labelPrefix=&quot;slab summary&quot;, procRoot=&quot;vdo&quot;, **kwargs)

# The statistics for the reference counts.
class RefCountsStatistics(StatStruct):
  def __init__(self, name=&quot;RefCountsStatistics&quot;, **kwargs):
    super(RefCountsStatistics, self).__init__(name, [
      # Number of reference blocks written
      Uint64Field(&quot;blocksWritten&quot;),
    ], labelPrefix=&quot;reference&quot;, procRoot=&quot;vdo&quot;, **kwargs)

# The statistics for the block map.
class BlockMapStatistics(StatStruct):
  def __init__(self, name=&quot;BlockMapStatistics&quot;, **kwargs):
    super(BlockMapStatistics, self).__init__(name, [
      # number of dirty (resident) pages
      Uint32Field(&quot;dirtyPages&quot;),
      # number of clean (resident) pages
      Uint32Field(&quot;cleanPages&quot;),
      # number of free pages
      Uint32Field(&quot;freePages&quot;),
      # number of pages in failed state
      Uint32Field(&quot;failedPages&quot;),
      # number of pages incoming
      Uint32Field(&quot;incomingPages&quot;),
      # number of pages outgoing
      Uint32Field(&quot;outgoingPages&quot;),
      # how many times free page not avail
      Uint32Field(&quot;cachePressure&quot;),
      # number of getVDOPageAsync() for read
      Uint64Field(&quot;readCount&quot;),
      # number or getVDOPageAsync() for write
      Uint64Field(&quot;writeCount&quot;),
      # number of times pages failed to read
      Uint64Field(&quot;failedReads&quot;),
      # number of times pages failed to write
      Uint64Field(&quot;failedWrites&quot;),
      # number of gets that are reclaimed
      Uint64Field(&quot;reclaimed&quot;),
      # number of gets for outgoing pages
      Uint64Field(&quot;readOutgoing&quot;),
      # number of gets that were already there
      Uint64Field(&quot;foundInCache&quot;),
      # number of gets requiring discard
      Uint64Field(&quot;discardRequired&quot;),
      # number of gets enqueued for their page
      Uint64Field(&quot;waitForPage&quot;),
      # number of gets that have to fetch
      Uint64Field(&quot;fetchRequired&quot;),
      # number of page fetches
      Uint64Field(&quot;pagesLoaded&quot;),
      # number of page saves
      Uint64Field(&quot;pagesSaved&quot;),
      # the number of flushes issued
      Uint64Field(&quot;flushCount&quot;),
    ], labelPrefix=&quot;block map&quot;, procRoot=&quot;vdo&quot;, **kwargs)

# The dedupe statistics from hash locks
class HashLockStatistics(StatStruct):
  def __init__(self, name=&quot;HashLockStatistics&quot;, **kwargs):
    super(HashLockStatistics, self).__init__(name, [
      # Number of times the UDS advice proved correct
      Uint64Field(&quot;dedupeAdviceValid&quot;),
      # Number of times the UDS advice proved incorrect
      Uint64Field(&quot;dedupeAdviceStale&quot;),
      # Number of writes with the same data as another in-flight write
      Uint64Field(&quot;concurrentDataMatches&quot;),
      # Number of writes whose hash collided with an in-flight write
      Uint64Field(&quot;concurrentHashCollisions&quot;),
    ], procRoot=&quot;vdo&quot;, **kwargs)

# Counts of error conditions in VDO.
class ErrorStatistics(StatStruct):
  def __init__(self, name=&quot;ErrorStatistics&quot;, **kwargs):
    super(ErrorStatistics, self).__init__(name, [
      # number of times VDO got an invalid dedupe advice PBN from UDS
      Uint64Field(&quot;invalidAdvicePBNCount&quot;),
      # number of times a VIO completed with a VDO_NO_SPACE error
      Uint64Field(&quot;noSpaceErrorCount&quot;),
      # number of times a VIO completed with a VDO_READ_ONLY error
      Uint64Field(&quot;readOnlyErrorCount&quot;),
    ], procRoot=&quot;vdo&quot;, **kwargs)

# The statistics of the vdo service.
class VDOStatistics(StatStruct):
  def __init__(self, name=&quot;VDOStatistics&quot;, **kwargs):
    super(VDOStatistics, self).__init__(name, [
      Uint32Field(&quot;version&quot;),
      Uint32Field(&quot;releaseVersion&quot;),
      # Number of blocks used for data
      Uint64Field(&quot;dataBlocksUsed&quot;, available = &quot;((not $inRecoveryMode) and ($mode != b'read-only'))&quot;),
      # Number of blocks used for VDO metadata
      Uint64Field(&quot;overheadBlocksUsed&quot;, available = &quot;not $inRecoveryMode&quot;),
      # Number of logical blocks that are currently mapped to physical blocks
      Uint64Field(&quot;logicalBlocksUsed&quot;, available = &quot;not $inRecoveryMode&quot;),
      # number of physical blocks
      Uint64Field(&quot;physicalBlocks&quot;),
      # number of logical blocks
      Uint64Field(&quot;logicalBlocks&quot;),
      Uint64Field(&quot;oneKBlocks&quot;, derived = &quot;$physicalBlocks * $blockSize // 1024&quot;, label = &quot;1K-blocks&quot;),
      Uint64Field(&quot;oneKBlocksUsed&quot;, derived = &quot;($dataBlocksUsed + $overheadBlocksUsed) * $blockSize // 1024&quot;, label = &quot;1K-blocks used&quot;, available = &quot;not $inRecoveryMode&quot;),
      Uint64Field(&quot;oneKBlocksAvailable&quot;, label = &quot;1K-blocks available&quot;, available = &quot;not $inRecoveryMode&quot;, derived = &quot;($physicalBlocks - $dataBlocksUsed - $overheadBlocksUsed) * $blockSize // 1024&quot;),
      Uint8Field(&quot;usedPercent&quot;, derived = &quot;int((100 * ($dataBlocksUsed + $overheadBlocksUsed) // $physicalBlocks) + 0.5)&quot;, available = &quot;((not $inRecoveryMode) and ($mode != b'read-only'))&quot;),
      Uint8Field(&quot;savings&quot;, available = &quot;not $inRecoveryMode&quot;, display = False, derived = &quot;int(100 * ($logicalBlocksUsed - $dataBlocksUsed) // $logicalBlocksUsed) if ($logicalBlocksUsed &gt; 0) else -1&quot;),
      Uint8Field(&quot;savingPercent&quot;, available = &quot;((not $inRecoveryMode) and ($mode != b'read-only'))&quot;, derived = &quot;$savings if ($savings &gt;= 0) else NotAvailable()&quot;),
      # Size of the block map page cache, in bytes
      Uint64Field(&quot;blockMapCacheSize&quot;),
      # String describing the active write policy of the VDO
      StringField(&quot;writePolicy&quot;, length = 15),
      # The physical block size
      Uint64Field(&quot;blockSize&quot;),
      # Number of times the VDO has successfully recovered
      Uint64Field(&quot;completeRecoveries&quot;, label = &quot;completed recovery count&quot;),
      # Number of times the VDO has recovered from read-only mode
      Uint64Field(&quot;readOnlyRecoveries&quot;, label = &quot;read-only recovery count&quot;),
      # String describing the operating mode of the VDO
      StringField(&quot;mode&quot;, length = 15, label = &quot;operating mode&quot;),
      # Whether the VDO is in recovery mode
      BoolField(&quot;inRecoveryMode&quot;, display = False),
      # What percentage of recovery mode work has been completed
      Uint8Field(&quot;recoveryPercentage&quot;, label = &quot;recovery progress (%)&quot;, available = &quot;$inRecoveryMode&quot;),
      # The statistics for the compressed block packer
      PackerStatistics(&quot;packer&quot;),
      # Counters for events in the block allocator
      BlockAllocatorStatistics(&quot;allocator&quot;),
      # Counters for events in the recovery journal
      RecoveryJournalStatistics(&quot;journal&quot;),
      # The statistics for the slab journals
      SlabJournalStatistics(&quot;slabJournal&quot;),
      # The statistics for the slab summary
      SlabSummaryStatistics(&quot;slabSummary&quot;),
      # The statistics for the reference counts
      RefCountsStatistics(&quot;refCounts&quot;),
      # The statistics for the block map
      BlockMapStatistics(&quot;blockMap&quot;),
      # The dedupe statistics from hash locks
      HashLockStatistics(&quot;hashLock&quot;),
      # Counts of error conditions
      ErrorStatistics(&quot;errors&quot;),
    ], procFile=&quot;dedupe_stats&quot;, procRoot=&quot;vdo&quot;, **kwargs)

  statisticsVersion = 31

  def sample(self, device):
    sample = super(VDOStatistics, self).sample(device)
    if ((sample.getStat(&quot;version&quot;) != VDOStatistics.statisticsVersion) or (sample.getStat(&quot;releaseVersion&quot;) != CURRENT_RELEASE_VERSION_NUMBER)):
      raise Exception(&quot;VDOStatistics version mismatch&quot;)
    return sample

</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Flib%2Fpython3.6%2Fsite-packages%2Fvdo%2Fstatistics'>Back to Directory</a>